Serac  0.1
Serac is an implicit thermal strucural mechanics simulation code.
Public Member Functions | Public Attributes | List of all members
serac::BasePhysics::ParameterInfo Struct Reference

The information needed for the physics parameters stored as Finite Element State fields. More...

#include <base_physics.hpp>

Public Member Functions

template<typename FunctionSpace >
 ParameterInfo (mfem::ParMesh &mesh, FunctionSpace space, const std::string &name="")
 Construct a new Parameter Info object. More...
 

Public Attributes

std::unique_ptr< serac::FiniteElementStatestate
 The finite element states representing user-defined and owned parameter fields.
 
std::unique_ptr< serac::FiniteElementStateprevious_state
 The finite element state representing the parameter at the previous evaluation.
 
std::unique_ptr< serac::FiniteElementDualsensitivity
 The sensitivities (dual vectors) of the QOI encoded in the adjoint load with respect to each of the input parameter fields. More...
 

Detailed Description

The information needed for the physics parameters stored as Finite Element State fields.

Definition at line 450 of file base_physics.hpp.

Constructor & Destructor Documentation

◆ ParameterInfo()

template<typename FunctionSpace >
serac::BasePhysics::ParameterInfo::ParameterInfo ( mfem::ParMesh &  mesh,
FunctionSpace  space,
const std::string &  name = "" 
)
inline

Construct a new Parameter Info object.

Template Parameters
FunctionSpaceThe templated finite element function space used to construct the parameter field
Parameters
meshThe mesh to build the new parameter on
spaceThe templated finite element function space used to construct the parameter field
nameThe name of the new parameter field

Definition at line 460 of file base_physics.hpp.

Member Data Documentation

◆ sensitivity

std::unique_ptr<serac::FiniteElementDual> serac::BasePhysics::ParameterInfo::sensitivity

The sensitivities (dual vectors) of the QOI encoded in the adjoint load with respect to each of the input parameter fields.

Note
This quantity is also called the vector-Jacobian product during back propagation in data science.

Definition at line 480 of file base_physics.hpp.


The documentation for this struct was generated from the following file: