Tempus Version of the Day
Time Integration
|
ModelEvaluator for forming adjoint sensitivity equations. More...
#include <Tempus_AdjointSensitivityModelEvaluator_decl.hpp>
Public Types | |
typedef Thyra::VectorBase< Scalar > | Vector |
typedef Thyra::MultiVectorBase< Scalar > | MultiVector |
Public Member Functions | |
AdjointSensitivityModelEvaluator (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model, const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &adjoint_residual_model, const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &adjoint_solve_model, const Scalar &t_init, const Scalar &t_final, const bool is_pseudotransient, const Teuchos::RCP< const Teuchos::ParameterList > &pList=Teuchos::null) | |
Constructor. | |
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > | getModel () const |
Get the underlying model 'f'. | |
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > | getAdjointResidualModel () const |
Get the underlying adjoint residual model. | |
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > | getAdjointSolveModel () const |
Get the underlying adjoint solve model. | |
void | setFinalTime (const Scalar t_final) |
Set the final time from the forward evaluation. | |
void | setForwardSolutionHistory (const Teuchos::RCP< const Tempus::SolutionHistory< Scalar > > &sh) |
Set solution history from forward evaluation. | |
Public functions overridden from ModelEvaulator. | |
typedef Thyra::DefaultMultiVectorProductVectorSpace< Scalar > | DMVPVS |
typedef Thyra::DefaultMultiVectorProductVector< Scalar > | DMVPV |
Thyra::ModelEvaluatorBase::InArgs< Scalar > | prototypeInArgs_ |
Thyra::ModelEvaluatorBase::OutArgs< Scalar > | prototypeOutArgs_ |
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > | model_ |
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > | adjoint_residual_model_ |
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > | adjoint_solve_model_ |
Teuchos::RCP< const DMVPVS > | adjoint_space_ |
Teuchos::RCP< const DMVPVS > | residual_space_ |
Teuchos::RCP< const DMVPVS > | response_space_ |
Teuchos::RCP< const Tempus::SolutionHistory< Scalar > > | sh_ |
Scalar | t_init_ |
Scalar | t_final_ |
bool | is_pseudotransient_ |
bool | mass_matrix_is_constant_ |
bool | mass_matrix_is_identity_ |
int | p_index_ |
int | g_index_ |
int | num_adjoint_ |
bool | mass_matrix_is_computed_ |
bool | jacobian_matrix_is_computed_ |
bool | response_gradient_is_computed_ |
Teuchos::RCP< Thyra::VectorBase< Scalar > > | my_x_dot_ |
Teuchos::RCP< Thyra::LinearOpBase< Scalar > > | my_dfdx_ |
Teuchos::RCP< Thyra::LinearOpBase< Scalar > > | my_dfdxdot_ |
Teuchos::RCP< Thyra::LinearOpBase< Scalar > > | my_dfdp_op_ |
Teuchos::RCP< Thyra::MultiVectorBase< Scalar > > | my_dfdp_mv_ |
Teuchos::RCP< Thyra::MultiVectorBase< Scalar > > | my_dgdx_mv_ |
Teuchos::RCP< Tempus::SolutionState< Scalar > > | forward_state_ |
Scalar | t_interp_ |
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > | get_p_space (int p) const |
Teuchos::RCP< const Teuchos::Array< std::string > > | get_p_names (int p) const |
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > | get_x_space () const |
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > | get_f_space () const |
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > | get_g_space (int j) const |
Teuchos::RCP< Thyra::LinearOpBase< Scalar > > | create_W_op () const |
Teuchos::RCP< const Thyra::LinearOpWithSolveFactoryBase< Scalar > > | get_W_factory () const |
Thyra::ModelEvaluatorBase::InArgs< Scalar > | createInArgs () const |
Thyra::ModelEvaluatorBase::InArgs< Scalar > | getNominalValues () const |
static Teuchos::RCP< const Teuchos::ParameterList > | getValidParameters () |
Thyra::ModelEvaluatorBase::OutArgs< Scalar > | createOutArgsImpl () const |
void | evalModelImpl (const Thyra::ModelEvaluatorBase::InArgs< Scalar > &inArgs, const Thyra::ModelEvaluatorBase::OutArgs< Scalar > &outArgs) const |
ModelEvaluator for forming adjoint sensitivity equations.
This class wraps a given ModelEvalutor encapsulating f(x_dot,x,p) and creates a new "residual" for the adjoint sensitivity equations: F(y) = d/dt( df/dx_dot^T*y ) - df/dx^T*y + dg/dx^T = 0 where y is the adjoint variable. Nominally y is a multi-vector belonging to the vector space of the residual f with number of columns equal to the dimension of g. To satisfy the model evaluator interface, y is converted to a product vector formed by its columns. This is the form of the adjoint equations suitable for computing pseudotransientsensitivities of a response function g(x(T),p) or adjoint sensitivities for a time-integrated response function int_0^T g(x(t),p).
To compute adjoint sensitivities, the equations f(x_dot,x,p) = 0 are integrated forward in time to some final time T, with the adjoint equations above integrated backward in time starting at T. Since the tempus integrator can only integrate forward in time, we define tau = T - t and transform the adjoint equations to: F(y) = d/dtau( df/dx_dot^T*y ) + df/dx^T*y - dg/dx^T = 0. The initial conditions for y are y(T) = 0. The sensitivity of g(T) is then int_0^T(dg/dp(T) - df/dp^T*y)dt + dx/dp(0)^T*df/dx_dot(0)^T*y(0) for transient adjoint sensitivites and is dg/dp(T) - df/dp^T*y for pseudotransient.
This model evaluator supports both implicit and explict forms of the governing equations. However it assumes df/dx_dot is constant with respect to x_dot, x, and t so that the adjoint equations become F(y) = df/dxdot^T*y_dot + df/dx^T*y - dg/dx^T = 0. Moving beyond this assumption will require modifications to the steppers in how they generate time-derivative terms.
Definition at line 54 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
typedef Thyra::VectorBase<Scalar> Tempus::AdjointSensitivityModelEvaluator< Scalar >::Vector |
Definition at line 57 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
typedef Thyra::MultiVectorBase<Scalar> Tempus::AdjointSensitivityModelEvaluator< Scalar >::MultiVector |
Definition at line 58 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
private |
Definition at line 135 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
private |
Definition at line 136 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
Tempus::AdjointSensitivityModelEvaluator< Scalar >::AdjointSensitivityModelEvaluator | ( | const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > & | model, |
const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > & | adjoint_residual_model, | ||
const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > & | adjoint_solve_model, | ||
const Scalar & | t_init, | ||
const Scalar & | t_final, | ||
const bool | is_pseudotransient, | ||
const Teuchos::RCP< const Teuchos::ParameterList > & | pList = Teuchos::null |
||
) |
Constructor.
t_final is the final integration time used to implement the time transformation described above. num_adjoint is the number of adjoint variables defining the number of columns in y, which is determined by the number of elements in the vector space for the response g. The optionally supplied parameter list supports the following options:
Definition at line 28 of file Tempus_AdjointSensitivityModelEvaluator_impl.hpp.
|
inline |
Get the underlying model 'f'.
Definition at line 89 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
inline |
Get the underlying adjoint residual model.
Definition at line 93 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
inline |
Get the underlying adjoint solve model.
Definition at line 97 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
void Tempus::AdjointSensitivityModelEvaluator< Scalar >::setFinalTime | ( | const Scalar | t_final | ) |
Set the final time from the forward evaluation.
Definition at line 125 of file Tempus_AdjointSensitivityModelEvaluator_impl.hpp.
void Tempus::AdjointSensitivityModelEvaluator< Scalar >::setForwardSolutionHistory | ( | const Teuchos::RCP< const Tempus::SolutionHistory< Scalar > > & | sh | ) |
Set solution history from forward evaluation.
Definition at line 133 of file Tempus_AdjointSensitivityModelEvaluator_impl.hpp.
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > Tempus::AdjointSensitivityModelEvaluator< Scalar >::get_p_space | ( | int | p | ) | const |
Definition at line 153 of file Tempus_AdjointSensitivityModelEvaluator_impl.hpp.
Teuchos::RCP< const Teuchos::Array< std::string > > Tempus::AdjointSensitivityModelEvaluator< Scalar >::get_p_names | ( | int | p | ) | const |
Definition at line 162 of file Tempus_AdjointSensitivityModelEvaluator_impl.hpp.
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > Tempus::AdjointSensitivityModelEvaluator< Scalar >::get_x_space |
Definition at line 171 of file Tempus_AdjointSensitivityModelEvaluator_impl.hpp.
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > Tempus::AdjointSensitivityModelEvaluator< Scalar >::get_f_space |
Definition at line 179 of file Tempus_AdjointSensitivityModelEvaluator_impl.hpp.
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > Tempus::AdjointSensitivityModelEvaluator< Scalar >::get_g_space | ( | int | j | ) | const |
Definition at line 187 of file Tempus_AdjointSensitivityModelEvaluator_impl.hpp.
Teuchos::RCP< Thyra::LinearOpBase< Scalar > > Tempus::AdjointSensitivityModelEvaluator< Scalar >::create_W_op |
Definition at line 198 of file Tempus_AdjointSensitivityModelEvaluator_impl.hpp.
Teuchos::RCP< const Thyra::LinearOpWithSolveFactoryBase< Scalar > > Tempus::AdjointSensitivityModelEvaluator< Scalar >::get_W_factory |
Definition at line 211 of file Tempus_AdjointSensitivityModelEvaluator_impl.hpp.
Thyra::ModelEvaluatorBase::InArgs< Scalar > Tempus::AdjointSensitivityModelEvaluator< Scalar >::createInArgs |
Definition at line 228 of file Tempus_AdjointSensitivityModelEvaluator_impl.hpp.
Thyra::ModelEvaluatorBase::InArgs< Scalar > Tempus::AdjointSensitivityModelEvaluator< Scalar >::getNominalValues |
Definition at line 236 of file Tempus_AdjointSensitivityModelEvaluator_impl.hpp.
|
static |
Definition at line 554 of file Tempus_AdjointSensitivityModelEvaluator_impl.hpp.
|
private |
Definition at line 269 of file Tempus_AdjointSensitivityModelEvaluator_impl.hpp.
|
private |
Definition at line 277 of file Tempus_AdjointSensitivityModelEvaluator_impl.hpp.
|
private |
Definition at line 145 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
private |
Definition at line 146 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
private |
Definition at line 148 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
private |
Definition at line 149 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
private |
Definition at line 150 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
private |
Definition at line 152 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
private |
Definition at line 153 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
private |
Definition at line 154 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
private |
Definition at line 155 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
private |
Definition at line 156 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
private |
Definition at line 157 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
private |
Definition at line 158 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
private |
Definition at line 159 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
private |
Definition at line 160 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
private |
Definition at line 161 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
private |
Definition at line 162 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
private |
Definition at line 163 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
mutableprivate |
Definition at line 165 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
mutableprivate |
Definition at line 166 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
mutableprivate |
Definition at line 167 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
mutableprivate |
Definition at line 168 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
mutableprivate |
Definition at line 169 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
mutableprivate |
Definition at line 170 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
mutableprivate |
Definition at line 171 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
mutableprivate |
Definition at line 172 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
mutableprivate |
Definition at line 173 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
mutableprivate |
Definition at line 174 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.
|
mutableprivate |
Definition at line 175 of file Tempus_AdjointSensitivityModelEvaluator_decl.hpp.