Thyra
Version of the Day
|
Concrete aggregate class for all output arguments computable by a ModelEvaluator
subclass object.
More...
#include <Thyra_ModelEvaluatorBase_decl.hpp>
Public Types | |
typedef Teuchos::ScalarTraits< Scalar >::magnitudeType | ScalarMag |
Public Member Functions | |
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... | |
Protected Member Functions | |
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) |
Concrete aggregate class for all output arguments computable by a ModelEvaluator
subclass object.
The set of supported objects is returned from the supports()
function.
A client can not directly set what input arguments are supported or not supported. Only a subclass of ModelEvaluator
can do that (through the InArgsSetup
subclass).
Definition at line 124 of file Thyra_ModelEvaluatorBase_decl.hpp.
typedef Teuchos::ScalarTraits<Scalar>::magnitudeType Thyra::ModelEvaluatorBase::InArgs< Scalar >::ScalarMag |
Definition at line 127 of file Thyra_ModelEvaluatorBase_decl.hpp.
Thyra::ModelEvaluatorBase::InArgs< Scalar >::InArgs | ( | ) |
Definition at line 96 of file Thyra_ModelEvaluatorBase_def.hpp.
int Thyra::ModelEvaluatorBase::InArgs< Scalar >::Np | ( | ) | const |
Return the number of parameter subvectors p(l)
supported (Np >= 0
).
Definition at line 111 of file Thyra_ModelEvaluatorBase_def.hpp.
bool Thyra::ModelEvaluatorBase::InArgs< Scalar >::supports | ( | EInArgsMembers | arg | ) | const |
Determines if an input argument is supported or not.
Definition at line 115 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::InArgs< Scalar >::set_x_dot | ( | const RCP< const VectorBase< Scalar > > & | x_dot | ) |
Precondition: supports(IN_ARG_x_dot)==true
.
Definition at line 133 of file Thyra_ModelEvaluatorBase_def.hpp.
RCP< const VectorBase< Scalar > > Thyra::ModelEvaluatorBase::InArgs< Scalar >::get_x_dot | ( | ) | const |
Precondition: supports(IN_ARG_x_dot)==true
.
Definition at line 141 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::InArgs< Scalar >::set_x | ( | const RCP< const VectorBase< Scalar > > & | x | ) |
Precondition: supports(IN_ARG_x)==true
.
Definition at line 146 of file Thyra_ModelEvaluatorBase_def.hpp.
RCP< const VectorBase< Scalar > > Thyra::ModelEvaluatorBase::InArgs< Scalar >::get_x | ( | ) | const |
Precondition: supports(IN_ARG_x)==true
.
Definition at line 154 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::InArgs< Scalar >::set_p | ( | int | l, |
const RCP< const VectorBase< Scalar > > & | p_l | ||
) |
Set p(l)
where 0 <= l && l < this->Np()
.
Definition at line 215 of file Thyra_ModelEvaluatorBase_def.hpp.
RCP< const VectorBase< Scalar > > Thyra::ModelEvaluatorBase::InArgs< Scalar >::get_p | ( | int | l | ) | const |
Get p(l)
where 0 <= l && l < this->Np()
.
Definition at line 223 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::InArgs< Scalar >::set_x_dot_mp | ( | const RCP< const Stokhos::ProductEpetraVector > & | x_dot_mp | ) |
Precondition: supports(IN_ARG_x_dot_mp)==true
.
Definition at line 159 of file Thyra_ModelEvaluatorBase_def.hpp.
RCP< const Stokhos::ProductEpetraVector > Thyra::ModelEvaluatorBase::InArgs< Scalar >::get_x_dot_mp | ( | ) | const |
Precondition: supports(IN_ARG_x_dotmp)==true
.
Definition at line 167 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::InArgs< Scalar >::set_x_mp | ( | const RCP< const Stokhos::ProductEpetraVector > & | x_mp | ) |
Precondition: supports(IN_ARG_x_mp)==true
.
Definition at line 172 of file Thyra_ModelEvaluatorBase_def.hpp.
RCP< const Stokhos::ProductEpetraVector > Thyra::ModelEvaluatorBase::InArgs< Scalar >::get_x_mp | ( | ) | const |
Precondition: supports(IN_ARG_x_mp)==true
.
Definition at line 180 of file Thyra_ModelEvaluatorBase_def.hpp.
bool Thyra::ModelEvaluatorBase::InArgs< Scalar >::supports | ( | EInArgs_p_mp | arg, |
int | l | ||
) | const |
Whether p_mp is supported for parameter vector l
Definition at line 126 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::InArgs< Scalar >::set_t | ( | ScalarMag | t | ) |
Precondition: supports(IN_ARG_t)==true
.
Definition at line 240 of file Thyra_ModelEvaluatorBase_def.hpp.
ModelEvaluatorBase::InArgs< Scalar >::ScalarMag Thyra::ModelEvaluatorBase::InArgs< Scalar >::get_t | ( | ) | const |
.Precondition: supports(IN_ARG_t)==true
Definition at line 246 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::InArgs< Scalar >::set_alpha | ( | Scalar | alpha | ) |
Precondition: supports(IN_ARG_alpha)==true
.
Definition at line 251 of file Thyra_ModelEvaluatorBase_def.hpp.
Scalar Thyra::ModelEvaluatorBase::InArgs< Scalar >::get_alpha | ( | ) | const |
Precondition: supports(IN_ARG_alph)==true
.
Definition at line 256 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::InArgs< Scalar >::set_beta | ( | Scalar | beta | ) |
Precondition: supports(IN_ARG_beta)==true
.
Definition at line 261 of file Thyra_ModelEvaluatorBase_def.hpp.
Scalar Thyra::ModelEvaluatorBase::InArgs< Scalar >::get_beta | ( | ) | const |
Precondition: supports(IN_ARG_beta)==true
.
Definition at line 266 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::InArgs< Scalar >::set_step_size | ( | Scalar | step_size | ) |
Precondition: supports(IN_ARG_step_size)==true
.
Definition at line 270 of file Thyra_ModelEvaluatorBase_def.hpp.
Scalar Thyra::ModelEvaluatorBase::InArgs< Scalar >::get_step_size | ( | ) | const |
Precondition: supports(IN_ARG_step_size)==true
.
Definition at line 274 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::InArgs< Scalar >::set_stage_number | ( | Scalar | stage_number | ) |
Precondition: supports(IN_ARG_stage_number)==true
.
Definition at line 283 of file Thyra_ModelEvaluatorBase_def.hpp.
Scalar Thyra::ModelEvaluatorBase::InArgs< Scalar >::get_stage_number | ( | ) | const |
Precondition: supports(IN_ARG_stage_number)==true
.
Definition at line 278 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::InArgs< Scalar >::setArgs | ( | const InArgs< Scalar > & | inArgs, |
bool | ignoreUnsupported = false , |
||
bool | cloneObjects = false |
||
) |
Set non-null arguments (does not overwrite non-NULLs with NULLs) .
Definition at line 288 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::InArgs< Scalar >::assertSameSupport | ( | const InArgs< Scalar > & | inArgs | ) | const |
Assert that two InArgs objects have the same support.
Definition at line 361 of file Thyra_ModelEvaluatorBase_def.hpp.
std::string Thyra::ModelEvaluatorBase::InArgs< Scalar >::modelEvalDescription | ( | ) | const |
Definition at line 384 of file Thyra_ModelEvaluatorBase_def.hpp.
std::string Thyra::ModelEvaluatorBase::InArgs< Scalar >::description | ( | ) | const |
Definition at line 391 of file Thyra_ModelEvaluatorBase_def.hpp.
void Thyra::ModelEvaluatorBase::InArgs< Scalar >::describe | ( | Teuchos::FancyOStream & | out, |
const Teuchos::EVerbosityLevel | verbLevel | ||
) | const |
Create a more detailed description along about this object and the ModelEvaluator that created it.
Definition at line 406 of file Thyra_ModelEvaluatorBase_def.hpp.
|
protected |
Definition at line 485 of file Thyra_ModelEvaluatorBase_def.hpp.
|
protected |
Definition at line 494 of file Thyra_ModelEvaluatorBase_def.hpp.
|
protected |
Definition at line 503 of file Thyra_ModelEvaluatorBase_def.hpp.
|
protected |
Definition at line 515 of file Thyra_ModelEvaluatorBase_def.hpp.
|
protected |
Definition at line 525 of file Thyra_ModelEvaluatorBase_def.hpp.
|
protected |
Definition at line 537 of file Thyra_ModelEvaluatorBase_def.hpp.