Skip to content

Class uipc::diff_sim::AdjointMethodFeature

ClassList > uipc > diff_sim > AdjointMethodFeature

Inherits the following classes: uipc::core::Feature

Public Static Attributes

Type Name
std::string_view FeatureName = = "diff_sim/adjoint_method"

Public Functions

Type Name
AdjointMethodFeature (S< AdjointMethodFeatureOverrider > overrider)
void compute_dLdP (backend::BufferView out_dLdP, backend::BufferView in_dLdX)
Computes the gradient of the loss with respect to the parameters.
void receive_dofs (backend::BufferView out_Dofs)
Receives the selected degrees of freedom for all frames.
void select_dofs (SizeT frame, backend::BufferView in_SDI)
Selects the degrees of freedom from the given indices for the given frame.

Public Functions inherited from uipc::core::IFeature

See uipc::core::IFeature

Type Name
std::string_view name () const
std::string_view type_name () const
virtual ~IFeature () = default

Protected Functions inherited from uipc::core::IFeature

See uipc::core::IFeature

Type Name
virtual std::string_view get_name () const = 0
virtual std::string_view get_type_name () const = 0

Public Static Attributes Documentation

variable FeatureName

std::string_view uipc::diff_sim::AdjointMethodFeature::FeatureName;

Public Functions Documentation

function AdjointMethodFeature

uipc::diff_sim::AdjointMethodFeature::AdjointMethodFeature (
    S< AdjointMethodFeatureOverrider > overrider
)

function compute_dLdP

Computes the gradient of the loss with respect to the parameters. 

void uipc::diff_sim::AdjointMethodFeature::compute_dLdP (
    backend::BufferView out_dLdP,
    backend::BufferView in_dLdX
)

Parameters:

  • out_dLdP:BufferView<Float> The gradient of the loss with respect to the parameters.
  • in_dLdX:BufferView<Float> The gradient of the loss with respect to the degrees of freedom.

function receive_dofs

Receives the selected degrees of freedom for all frames. 

void uipc::diff_sim::AdjointMethodFeature::receive_dofs (
    backend::BufferView out_Dofs
)

This function should be called after all frames have been processed to receive the selected degrees of freedom.

Parameters:

  • out_dofs:BufferView<Float> The selected degrees of freedom.

function select_dofs

Selects the degrees of freedom from the given indices for the given frame. 

void uipc::diff_sim::AdjointMethodFeature::select_dofs (
    SizeT frame,
    backend::BufferView in_SDI
)

in_SDI is frame-local, this function should be called for each frame to select the degrees of freedom.

Parameters:

  • in_SDI:BufferView<IndexT> The indices of the degrees of freedom to select.

The documentation for this class was generated from the following file include/uipc/diff_sim/adjoint_method_feature.h