Thyra
Version of the Day
|
Protected subclass of OutArgs
that only ModelEvaluator
subclasses can access to set up the selection of supported input arguments.
More...
#include <Thyra_ModelEvaluatorBase_decl.hpp>
Public Member Functions | |
OutArgsSetup () | |
OutArgsSetup (const OutArgs< Scalar > &) | |
void | setModelEvalDescription (const std::string &modelEvalDescription) |
void | set_Np_Ng (int Np, int Ng) |
void | setSupports (EOutArgsMembers arg, bool supports=true) |
void | setSupports (EOutArgsDfDp arg, int l, const DerivativeSupport &) |
void | setSupports (EOutArgsDgDx_dot arg, int j, const DerivativeSupport &) |
void | setSupports (EOutArgsDgDx arg, int j, const DerivativeSupport &) |
void | setSupports (EOutArgsDgDp arg, int j, int l, const DerivativeSupport &) |
template<typename ObjectType > | |
void | setSupports (const bool supports=true) |
Set support for specific extended data types. More... | |
void | set_W_properties (const DerivativeProperties &properties) |
void | set_DfDp_properties (int l, const DerivativeProperties &properties) |
void | set_DgDx_dot_properties (int j, const DerivativeProperties &properties) |
void | set_DgDx_properties (int j, const DerivativeProperties &properties) |
void | set_DgDp_properties (int j, int l, const DerivativeProperties &properties) |
void | setSupports (const OutArgs< Scalar > &inputOutArgs) |
void | setUnsupportsAndRelated (EInArgsMembers arg) |
void | setUnsupportsAndRelated (EOutArgsMembers arg) |
Must be called after the above function. More... | |
Public Member Functions inherited from Thyra::ModelEvaluatorBase::OutArgs< Scalar > | |
OutArgs () | |
int | Np () const |
Return the number of parameter subvectors p(l) supported (Np >= 0 ). More... | |
int | Ng () const |
Return the number of axillary response functions g(j)(...) supported (Ng >= 0 ). More... | |
bool | supports (EOutArgsMembers arg) const |
Determine if an input argument is supported or not. More... | |
const DerivativeSupport & | supports (EOutArgsDfDp arg, int l) const |
Determine if DfDp(l) is supported or not, where 0 <= l && l < Np() . More... | |
const DerivativeSupport & | supports (EOutArgsDgDx_dot arg, int j) const |
Determine if DgDx_dot(j) is supported or not, 0 <= j && j < Ng() . More... | |
const DerivativeSupport & | supports (EOutArgsDgDx arg, int j) const |
Determine if DgDx(j) is supported or not, 0 <= j && j < Ng() . More... | |
const DerivativeSupport & | supports (EOutArgsDgDp arg, int j, int l) const |
Determine if DgDp(j,l) is supported or not, 0 <= j && j < Ng() and 0 <= l && l < Np() . More... | |
void | set_f (const Evaluation< VectorBase< Scalar > > &f) |
Precondition: supports(OUT_ARG_f)==true . More... | |
Evaluation< VectorBase< Scalar > > | get_f () const |
Precondition: supports(OUT_ARG_f)==true . More... | |
void | set_g (int j, const Evaluation< VectorBase< Scalar > > &g_j) |
Precondition: supports(OUT_ARG_g)==true . More... | |
Evaluation< VectorBase< Scalar > > | get_g (int j) const |
Precondition: supports(OUT_ARG_g)==true .. More... | |
void | set_W (const RCP< LinearOpWithSolveBase< Scalar > > &W) |
Precondition: supports(OUT_ARG_W)==true . More... | |
RCP< LinearOpWithSolveBase < Scalar > > | get_W () const |
Precondition: supports(OUT_ARG_W)==true . More... | |
template<typename ObjectType > | |
bool | supports () const |
Determines if an extended output argument of type ObjectType is supported. More... | |
template<typename ObjectType > | |
void | set (const RCP< const ObjectType > &uo) |
Set an extended output argument of type ObjectType in OutArgs. Precondition: supports()==true . More... | |
template<typename ObjectType > | |
RCP< const ObjectType > | get () const |
Get an extended output argument of type ObjectType from OutArgs. Precondition: supports()==true . More... | |
void | set_f_mp (const RCP< Stokhos::ProductEpetraVector > &f_mp) |
Precondition: supports(OUT_ARG_f_mp)==true . More... | |
RCP< Stokhos::ProductEpetraVector > | get_f_mp () const |
Precondition: supports(OUT_ARG_f_mp)==true . More... | |
void | set_g_mp (int j, const RCP< Stokhos::ProductEpetraVector > &g_mp_j) |
Precondition: supports(OUT_ARG_g_mp)==true . More... | |
RCP< Stokhos::ProductEpetraVector > | get_g_mp (int j) const |
Precondition: supports(OUT_ARG_g_mp)==true .. More... | |
void | set_W_mp (const RCP< Stokhos::ProductEpetraOperator > &W_mp) |
Precondition: supports(OUT_ARG_W_mp)==true . More... | |
RCP < Stokhos::ProductEpetraOperator > | get_W_mp () const |
Precondition: supports(OUT_ARG_W_mp)==true . More... | |
void | set_W_op (const RCP< LinearOpBase< Scalar > > &W_op) |
Precondition: supports(OUT_ARG_W_op)==true . More... | |
RCP< LinearOpBase< Scalar > > | get_W_op () const |
Precondition: supports(OUT_ARG_W_op)==true . More... | |
void | set_W_prec (const RCP< PreconditionerBase< Scalar > > &W_prec) |
Precondition: supports(OUT_ARG_W_op)==true . More... | |
RCP< PreconditionerBase< Scalar > > | get_W_prec () const |
Precondition: supports(OUT_ARG_W_op)==true . More... | |
DerivativeProperties | get_W_properties () const |
Return the known properties of W (precondition: supports(OUT_ARG_f)==true ). More... | |
void | set_DfDp (int l, const Derivative< Scalar > &DfDp_l) |
Precondition: supports(OUT_ARG_DfDp,l)==true . More... | |
Derivative< Scalar > | get_DfDp (int l) const |
Precondition: supports(OUT_ARG_DfDp,l)==true . More... | |
DerivativeProperties | get_DfDp_properties (int l) const |
Return the know properties of DfDp(l) (precondition: supports(OUT_ARG_DfDp,l)==true ). More... | |
void | set_DgDx_dot (int j, const Derivative< Scalar > &DgDx_dot_j) |
Precondition: supports(OUT_ARG_DgDx_dot,j)==true . More... | |
Derivative< Scalar > | get_DgDx_dot (int j) const |
Precondition: supports(OUT_ARG_DgDx_dot,j)==true . More... | |
DerivativeProperties | get_DgDx_dot_properties (int j) const |
Return the know properties of DgDx_dot(j) (precondition: supports(OUT_ARG_DgDx_dot,j)==true ). More... | |
void | set_DgDx (int j, const Derivative< Scalar > &DgDx_j) |
Precondition: supports(OUT_ARG_DgDx,j)==true . More... | |
Derivative< Scalar > | get_DgDx (int j) const |
Precondition: supports(OUT_ARG_DgDx,j)==true . More... | |
DerivativeProperties | get_DgDx_properties (int j) const |
Return the know properties of DgDx(j) (precondition: supports(OUT_ARG_DgDx,j)==true ). More... | |
void | set_DgDp (int j, int l, const Derivative< Scalar > &DgDp_j_l) |
Precondition: supports(OUT_ARG_DgDp,j,l)==true . More... | |
Derivative< Scalar > | get_DgDp (int j, int l) const |
Precondition: supports(OUT_ARG_DgDp,j,l)==true . More... | |
DerivativeProperties | get_DgDp_properties (int j, int l) const |
Return the know properties of DgDp(j,l) (precondition: supports(OUT_ARG_DgDp,j,l)==true ). More... | |
void | setArgs (const OutArgs< Scalar > &outArgs, bool ignoreUnsupported=false) |
Set all arguments fron outArgs into *this . More... | |
void | setFailed () const |
Set that the evaluation as a whole failed. More... | |
bool | isFailed () const |
Return if the evaluation failed or not. More... | |
bool | isEmpty () const |
void | assertSameSupport (const OutArgs< Scalar > &outArgs) const |
Assert that two OutArgs objects have the same support. More... | |
std::string | modelEvalDescription () const |
std::string | description () const |
void | describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const |
Create a more detailed description along about this object and the ModelEvaluator that created it. More... | |
Protected subclass of OutArgs
that only ModelEvaluator
subclasses can access to set up the selection of supported input arguments.
Objects of this type must be created in overrides of ModelEvaluator::createOutArgs()
.
Definition at line 1137 of file Thyra_ModelEvaluatorBase_decl.hpp.
Thyra::ModelEvaluatorBase::OutArgsSetup< Scalar >::OutArgsSetup | ( | ) |
Definition at line 2327 of file Thyra_ModelEvaluatorBase_def.hpp.
Thyra::ModelEvaluatorBase::OutArgsSetup< Scalar >::OutArgsSetup | ( | const OutArgs< Scalar > & | inputOutArgs | ) |
Definition at line 2332 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::OutArgsSetup< Scalar >::setModelEvalDescription | ( | const std::string & | modelEvalDescription | ) |
Definition at line 2340 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::OutArgsSetup< Scalar >::set_Np_Ng | ( | int | Np, |
int | Ng | ||
) |
Definition at line 2347 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::OutArgsSetup< Scalar >::setSupports | ( | EOutArgsMembers | arg, |
bool | supports = true |
||
) |
Definition at line 2352 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::OutArgsSetup< Scalar >::setSupports | ( | EOutArgsDfDp | arg, |
int | l, | ||
const DerivativeSupport & | supports_in | ||
) |
Definition at line 2359 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::OutArgsSetup< Scalar >::setSupports | ( | EOutArgsDgDx_dot | arg, |
int | j, | ||
const DerivativeSupport & | supports_in | ||
) |
Definition at line 2366 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::OutArgsSetup< Scalar >::setSupports | ( | EOutArgsDgDx | arg, |
int | j, | ||
const DerivativeSupport & | supports_in | ||
) |
Definition at line 2373 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::OutArgsSetup< Scalar >::setSupports | ( | EOutArgsDgDp | arg, |
int | j, | ||
int | l, | ||
const DerivativeSupport & | supports_in | ||
) |
Definition at line 2380 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::OutArgsSetup< Scalar >::setSupports | ( | const bool | supports = true | ) |
Set support for specific extended data types.
Definition at line 1350 of file Thyra_ModelEvaluatorBase_decl.hpp.
void Thyra::ModelEvaluatorBase::OutArgsSetup< Scalar >::set_W_properties | ( | const DerivativeProperties & | properties | ) |
Definition at line 2422 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::OutArgsSetup< Scalar >::set_DfDp_properties | ( | int | l, |
const DerivativeProperties & | properties | ||
) |
Definition at line 2429 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::OutArgsSetup< Scalar >::set_DgDx_dot_properties | ( | int | j, |
const DerivativeProperties & | properties | ||
) |
Definition at line 2436 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::OutArgsSetup< Scalar >::set_DgDx_properties | ( | int | j, |
const DerivativeProperties & | properties | ||
) |
Definition at line 2443 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::OutArgsSetup< Scalar >::set_DgDp_properties | ( | int | j, |
int | l, | ||
const DerivativeProperties & | properties | ||
) |
Definition at line 2450 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::OutArgsSetup< Scalar >::setSupports | ( | const OutArgs< Scalar > & | inputOutArgs | ) |
Definition at line 2485 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::OutArgsSetup< Scalar >::setUnsupportsAndRelated | ( | EInArgsMembers | arg | ) |
Definition at line 2492 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::OutArgsSetup< Scalar >::setUnsupportsAndRelated | ( | EOutArgsMembers | arg | ) |
Must be called after the above function.
Definition at line 2499 of file Thyra_ModelEvaluatorBase_def.hpp.