Thyra
Version of the Day
|
Protected subclass of InArgs
that only ModelEvaluator
subclasses can access to set up the selection of supported input arguments.
More...
#include <Thyra_ModelEvaluatorBase_decl.hpp>
Public Member Functions | |
InArgsSetup () | |
InArgsSetup (const InArgs< Scalar > &) | |
void | setModelEvalDescription (const std::string &modelEvalDescription) |
void | set_Np (int Np) |
void | setSupports (EInArgsMembers arg, bool supports=true) |
void | setSupports (const InArgs< Scalar > &inputInArgs, const int Np=-1) |
void | setUnsupportsAndRelated (EInArgsMembers arg) |
![]() | |
InArgs () | |
int | Np () const |
Return the number of parameter subvectors p(l) supported (Np >= 0 ). More... | |
bool | supports (EInArgsMembers arg) const |
Determines if an input argument is supported or not. More... | |
void | set_x_dot (const RCP< const VectorBase< Scalar > > &x_dot) |
Precondition: supports(IN_ARG_x_dot)==true . More... | |
RCP< const VectorBase< Scalar > > | get_x_dot () const |
Precondition: supports(IN_ARG_x_dot)==true . More... | |
void | set_x (const RCP< const VectorBase< Scalar > > &x) |
Precondition: supports(IN_ARG_x)==true . More... | |
RCP< const VectorBase< Scalar > > | get_x () const |
Precondition: supports(IN_ARG_x)==true . More... | |
void | set_p (int l, const RCP< const VectorBase< Scalar > > &p_l) |
Set p(l) where 0 <= l && l < this->Np() . More... | |
RCP< const VectorBase< Scalar > > | get_p (int l) const |
Get p(l) where 0 <= l && l < this->Np() . More... | |
void | set_x_dot_mp (const RCP< const Stokhos::ProductEpetraVector > &x_dot_mp) |
Precondition: supports(IN_ARG_x_dot_mp)==true . More... | |
RCP< const Stokhos::ProductEpetraVector > | get_x_dot_mp () const |
Precondition: supports(IN_ARG_x_dotmp)==true . More... | |
void | set_x_mp (const RCP< const Stokhos::ProductEpetraVector > &x_mp) |
Precondition: supports(IN_ARG_x_mp)==true . More... | |
RCP< const Stokhos::ProductEpetraVector > | get_x_mp () const |
Precondition: supports(IN_ARG_x_mp)==true . More... | |
bool | supports (EInArgs_p_mp arg, int l) const |
void | set_t (ScalarMag t) |
Precondition: supports(IN_ARG_t)==true . More... | |
ScalarMag | get_t () const |
.Precondition: supports(IN_ARG_t)==true More... | |
void | set_alpha (Scalar alpha) |
Precondition: supports(IN_ARG_alpha)==true . More... | |
Scalar | get_alpha () const |
Precondition: supports(IN_ARG_alph)==true . More... | |
void | set_beta (Scalar beta) |
Precondition: supports(IN_ARG_beta)==true . More... | |
Scalar | get_beta () const |
Precondition: supports(IN_ARG_beta)==true . More... | |
void | set_step_size (Scalar step_size) |
Precondition: supports(IN_ARG_step_size)==true . More... | |
Scalar | get_step_size () const |
Precondition: supports(IN_ARG_step_size)==true . More... | |
void | set_stage_number (Scalar stage_number) |
Precondition: supports(IN_ARG_stage_number)==true . More... | |
Scalar | get_stage_number () const |
Precondition: supports(IN_ARG_stage_number)==true . More... | |
void | setArgs (const InArgs< Scalar > &inArgs, bool ignoreUnsupported=false, bool cloneObjects=false) |
Set non-null arguments (does not overwrite non-NULLs with NULLs) . More... | |
void | assertSameSupport (const InArgs< Scalar > &inArgs) const |
Assert that two InArgs 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... | |
Additional Inherited Members | |
![]() | |
typedef Teuchos::ScalarTraits< Scalar >::magnitudeType | ScalarMag |
![]() | |
void | _setModelEvalDescription (const std::string &modelEvalDescription) |
void | _set_Np (int Np) |
void | _setSupports (EInArgsMembers arg, bool supports) |
void | _setSupports (EInArgs_p_mp arg, int l, bool supports) |
void | _setSupports (const InArgs< Scalar > &inputInArgs, const int Np) |
void | _setUnsupportsAndRelated (EInArgsMembers arg) |
Protected subclass of InArgs
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::createInArgs()
.
Definition at line 998 of file Thyra_ModelEvaluatorBase_decl.hpp.
Thyra::ModelEvaluatorBase::InArgsSetup< Scalar >::InArgsSetup | ( | ) |
Definition at line 2222 of file Thyra_ModelEvaluatorBase_def.hpp.
Thyra::ModelEvaluatorBase::InArgsSetup< Scalar >::InArgsSetup | ( | const InArgs< Scalar > & | inArgs | ) |
Definition at line 2227 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::InArgsSetup< Scalar >::setModelEvalDescription | ( | const std::string & | modelEvalDescription | ) |
Definition at line 2233 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::InArgsSetup< Scalar >::set_Np | ( | int | Np | ) |
Definition at line 2241 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::InArgsSetup< Scalar >::setSupports | ( | EInArgsMembers | arg, |
bool | supports = true |
||
) |
Definition at line 2246 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::InArgsSetup< Scalar >::setSupports | ( | const InArgs< Scalar > & | inputInArgs, |
const int | Np = -1 |
||
) |
Definition at line 2256 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::InArgsSetup< Scalar >::setUnsupportsAndRelated | ( | EInArgsMembers | arg | ) |
Definition at line 2265 of file Thyra_ModelEvaluatorBase_def.hpp.