Thyra Version of the Day
Public Types | Public Member Functions | Protected Member Functions
Thyra::ModelEvaluatorBase::InArgs< Scalar > Class Template Reference

Concrete aggregate class for all output arguments computable by a ModelEvaluator subclass object. More...

#include <Thyra_ModelEvaluatorBase_decl.hpp>

Inheritance diagram for Thyra::ModelEvaluatorBase::InArgs< Scalar >:
Inheritance graph
[legend]

List of all members.

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).
bool supports (EInArgsMembers arg) const
 Determines if an input argument is supported or not.
void set_x_dot (const RCP< const VectorBase< Scalar > > &x_dot)
 Precondition: supports(IN_ARG_x_dot)==true.
RCP< const VectorBase< Scalar > > get_x_dot () const
 Precondition: supports(IN_ARG_x_dot)==true.
void set_x (const RCP< const VectorBase< Scalar > > &x)
 Precondition: supports(IN_ARG_x)==true.
RCP< const VectorBase< Scalar > > get_x () const
 Precondition: supports(IN_ARG_x)==true.
void set_p (int l, const RCP< const VectorBase< Scalar > > &p_l)
 Set p(l) where 0 <= l && l < this->Np().
RCP< const VectorBase< Scalar > > get_p (int l) const
 Get p(l) where 0 <= l && l < this->Np().
void set_t (ScalarMag t)
 Precondition: supports(IN_ARG_t)==true.
ScalarMag get_t () const
 .Precondition: supports(IN_ARG_t)==true
void set_alpha (Scalar alpha)
 Precondition: supports(IN_ARG_alpha)==true.
Scalar get_alpha () const
 Precondition: supports(IN_ARG_alph)==true.
void set_beta (Scalar beta)
 Precondition: supports(IN_ARG_beta)==true.
Scalar get_beta () const
 Precondition: supports(IN_ARG_beta)==true.
void setArgs (const InArgs< Scalar > &inArgs, bool ignoreUnsupported=false, bool cloneObjects=false)
 Set non-null arguments (does not overwrite non-NULLs with NULLs) .
void assertSameSupport (const InArgs< Scalar > &inArgs) const
 Assert that two InArgs objects have the same support.
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.

Protected Member Functions

void _setModelEvalDescription (const std::string &modelEvalDescription)
 
void _set_Np (int Np)
 
void _setSupports (EInArgsMembers arg, bool supports)
 
void _setSupports (const InArgs< Scalar > &inputInArgs, const int Np)
 
void _setUnsupportsAndRelated (EInArgsMembers arg)
 

Detailed Description

template<class Scalar>
class Thyra::ModelEvaluatorBase::InArgs< Scalar >

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 110 of file Thyra_ModelEvaluatorBase_decl.hpp.


Member Typedef Documentation

template<class Scalar>
typedef Teuchos::ScalarTraits<Scalar>::magnitudeType Thyra::ModelEvaluatorBase::InArgs< Scalar >::ScalarMag

Definition at line 113 of file Thyra_ModelEvaluatorBase_decl.hpp.


Constructor & Destructor Documentation

template<class Scalar >
Thyra::ModelEvaluatorBase::InArgs< Scalar >::InArgs ( )

Definition at line 82 of file Thyra_ModelEvaluatorBase_def.hpp.


Member Function Documentation

template<class Scalar >
int Thyra::ModelEvaluatorBase::InArgs< Scalar >::Np ( ) const

Return the number of parameter subvectors p(l) supported (Np >= 0).

Definition at line 95 of file Thyra_ModelEvaluatorBase_def.hpp.

template<class Scalar >
bool Thyra::ModelEvaluatorBase::InArgs< Scalar >::supports ( EInArgsMembers  arg) const

Determines if an input argument is supported or not.

Definition at line 99 of file Thyra_ModelEvaluatorBase_def.hpp.

template<class Scalar>
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 111 of file Thyra_ModelEvaluatorBase_def.hpp.

template<class Scalar >
RCP< const VectorBase< Scalar > > Thyra::ModelEvaluatorBase::InArgs< Scalar >::get_x_dot ( ) const

Precondition: supports(IN_ARG_x_dot)==true.

Definition at line 119 of file Thyra_ModelEvaluatorBase_def.hpp.

template<class Scalar>
void Thyra::ModelEvaluatorBase::InArgs< Scalar >::set_x ( const RCP< const VectorBase< Scalar > > &  x)

Precondition: supports(IN_ARG_x)==true.

Definition at line 124 of file Thyra_ModelEvaluatorBase_def.hpp.

template<class Scalar >
RCP< const VectorBase< Scalar > > Thyra::ModelEvaluatorBase::InArgs< Scalar >::get_x ( ) const

Precondition: supports(IN_ARG_x)==true.

Definition at line 132 of file Thyra_ModelEvaluatorBase_def.hpp.

template<class Scalar>
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 167 of file Thyra_ModelEvaluatorBase_def.hpp.

template<class Scalar >
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 175 of file Thyra_ModelEvaluatorBase_def.hpp.

template<class Scalar >
void Thyra::ModelEvaluatorBase::InArgs< Scalar >::set_t ( ScalarMag  t)

Precondition: supports(IN_ARG_t)==true.

Definition at line 180 of file Thyra_ModelEvaluatorBase_def.hpp.

template<class Scalar >
ModelEvaluatorBase::InArgs< Scalar >::ScalarMag Thyra::ModelEvaluatorBase::InArgs< Scalar >::get_t ( ) const

.Precondition: supports(IN_ARG_t)==true

Definition at line 186 of file Thyra_ModelEvaluatorBase_def.hpp.

template<class Scalar>
void Thyra::ModelEvaluatorBase::InArgs< Scalar >::set_alpha ( Scalar  alpha)

Precondition: supports(IN_ARG_alpha)==true.

Definition at line 191 of file Thyra_ModelEvaluatorBase_def.hpp.

template<class Scalar >
Scalar Thyra::ModelEvaluatorBase::InArgs< Scalar >::get_alpha ( ) const

Precondition: supports(IN_ARG_alph)==true.

Definition at line 196 of file Thyra_ModelEvaluatorBase_def.hpp.

template<class Scalar>
void Thyra::ModelEvaluatorBase::InArgs< Scalar >::set_beta ( Scalar  beta)

Precondition: supports(IN_ARG_beta)==true.

Definition at line 201 of file Thyra_ModelEvaluatorBase_def.hpp.

template<class Scalar >
Scalar Thyra::ModelEvaluatorBase::InArgs< Scalar >::get_beta ( ) const

Precondition: supports(IN_ARG_beta)==true.

Definition at line 206 of file Thyra_ModelEvaluatorBase_def.hpp.

template<class Scalar>
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 211 of file Thyra_ModelEvaluatorBase_def.hpp.

template<class Scalar>
void Thyra::ModelEvaluatorBase::InArgs< Scalar >::assertSameSupport ( const InArgs< Scalar > &  inArgs) const

Assert that two InArgs objects have the same support.

Definition at line 261 of file Thyra_ModelEvaluatorBase_def.hpp.

template<class Scalar >
std::string Thyra::ModelEvaluatorBase::InArgs< Scalar >::modelEvalDescription ( ) const

Definition at line 284 of file Thyra_ModelEvaluatorBase_def.hpp.

template<class Scalar >
std::string Thyra::ModelEvaluatorBase::InArgs< Scalar >::description ( ) const [virtual]

Reimplemented from Teuchos::Describable.

Definition at line 291 of file Thyra_ModelEvaluatorBase_def.hpp.

template<class Scalar >
void Thyra::ModelEvaluatorBase::InArgs< Scalar >::describe ( Teuchos::FancyOStream out,
const Teuchos::EVerbosityLevel  verbLevel 
) const [virtual]

Create a more detailed description along about this object and the ModelEvaluator that created it.

Reimplemented from Teuchos::Describable.

Definition at line 306 of file Thyra_ModelEvaluatorBase_def.hpp.

template<class Scalar >
void Thyra::ModelEvaluatorBase::InArgs< Scalar >::_setModelEvalDescription ( const std::string &  modelEvalDescription) [protected]

Definition at line 379 of file Thyra_ModelEvaluatorBase_def.hpp.

template<class Scalar >
void Thyra::ModelEvaluatorBase::InArgs< Scalar >::_set_Np ( int  Np) [protected]

Definition at line 388 of file Thyra_ModelEvaluatorBase_def.hpp.

template<class Scalar >
void Thyra::ModelEvaluatorBase::InArgs< Scalar >::_setSupports ( EInArgsMembers  arg,
bool  supports 
) [protected]

Definition at line 395 of file Thyra_ModelEvaluatorBase_def.hpp.

template<class Scalar>
void Thyra::ModelEvaluatorBase::InArgs< Scalar >::_setSupports ( const InArgs< Scalar > &  inputInArgs,
const int  Np 
) [protected]

Definition at line 408 of file Thyra_ModelEvaluatorBase_def.hpp.

template<class Scalar >
void Thyra::ModelEvaluatorBase::InArgs< Scalar >::_setUnsupportsAndRelated ( EInArgsMembers  arg) [protected]

Definition at line 420 of file Thyra_ModelEvaluatorBase_def.hpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines