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 >:

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)

Private Types
typedef Teuchos::Array< RCP < const VectorBase< Scalar > > >	p_t
Private Member Functions
void	assert_supports (EInArgsMembers arg) const
void	assert_l (int l) const
Private Attributes
std::string	modelEvalDescription_
RCP< const VectorBase< Scalar > >	x_dot_
RCP< const VectorBase< Scalar > >	x_
p_t	p_
ScalarMag	t_
Scalar	alpha_
Scalar	beta_
bool	supports_ [NUM_E_IN_ARGS_MEMBERS]

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

template<class Scalar>

typedef Teuchos::Array<RCP<const VectorBase<Scalar> > > Thyra::ModelEvaluatorBase::InArgs< Scalar >::p_t [private]

Definition at line 174 of file Thyra_ModelEvaluatorBase_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar >

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

Definition at line 69 of file Thyra_ModelEvaluatorBase_def.hpp.

References Thyra::ModelEvaluatorBase::InArgs< Scalar >::alpha_, Thyra::ModelEvaluatorBase::InArgs< Scalar >::beta_, Thyra::ModelEvaluatorBase::NUM_E_IN_ARGS_MEMBERS, Thyra::ModelEvaluatorBase::InArgs< Scalar >::supports_, and Thyra::ModelEvaluatorBase::InArgs< Scalar >::t_.

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 82 of file Thyra_ModelEvaluatorBase_def.hpp.

Referenced by Thyra::ModelEvaluatorBase::InArgs< Scalar >::_setSupports(), Thyra::ModelEvaluatorBase::InArgs< Scalar >::assertSameSupport(), Thyra::DirectionalFiniteDiffCalculator< Scalar >::calcDerivatives(), Thyra::EpetraModelEvaluator::convertInArgsFromEpetraToThyra(), Thyra::EpetraModelEvaluator::convertInArgsFromThyraToEpetra(), Thyra::DefaultInverseModelEvaluator< Scalar >::evalModelImpl(), and Thyra::ModelEvaluatorBase::InArgs< Scalar >::setArgs().

template<class Scalar >

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

Determines if an input argument is supported or not.

Definition at line 86 of file Thyra_ModelEvaluatorBase_def.hpp.

References Thyra::ModelEvaluatorBase::NUM_E_IN_ARGS_MEMBERS, and Thyra::ModelEvaluatorBase::toString().

Referenced by Thyra::ModelEvaluatorBase::InArgs< Scalar >::assertSameSupport(), Thyra::DirectionalFiniteDiffCalculator< Scalar >::calcVariations(), Thyra::EpetraModelEvaluator::convertInArgsFromEpetraToThyra(), Thyra::EpetraModelEvaluator::convertInArgsFromThyraToEpetra(), Thyra::DefaultMultiPeriodModelEvaluator< Scalar >::evalModelImpl(), Thyra::ModelEvaluatorBase::InArgs< Scalar >::setArgs(), and Thyra::EpetraModelEvaluator::updateInArgsOutArgs().

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 98 of file Thyra_ModelEvaluatorBase_def.hpp.

References Thyra::ModelEvaluatorBase::IN_ARG_x_dot.

Referenced by Thyra::EpetraModelEvaluator::convertInArgsFromEpetraToThyra(), and main().

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 106 of file Thyra_ModelEvaluatorBase_def.hpp.

References Thyra::ModelEvaluatorBase::IN_ARG_x_dot.

Referenced by Thyra::DirectionalFiniteDiffCalculator< Scalar >::calcVariations(), Thyra::EpetraModelEvaluator::convertInArgsFromThyraToEpetra(), and Thyra::ModelEvaluatorBase::InArgs< Scalar >::setArgs().

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

References Thyra::ModelEvaluatorBase::IN_ARG_x.

Referenced by Thyra::EpetraModelEvaluator::convertInArgsFromEpetraToThyra().

template<class Scalar >

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

Precondition: supports(IN_ARG_x)==true.

Definition at line 119 of file Thyra_ModelEvaluatorBase_def.hpp.

References Thyra::ModelEvaluatorBase::IN_ARG_x.

Referenced by Thyra::DirectionalFiniteDiffCalculator< Scalar >::calcVariations(), Thyra::EpetraModelEvaluator::convertInArgsFromThyraToEpetra(), Thyra::DefaultStateEliminationModelEvaluator< Scalar >::evalModelImpl(), Thyra::DefaultMultiPeriodModelEvaluator< Scalar >::evalModelImpl(), Thyra::DefaultInverseModelEvaluator< Scalar >::evalModelImpl(), Simple2DTpetraModelEvaluator< Scalar >::evalModelImpl(), and Thyra::ModelEvaluatorBase::InArgs< Scalar >::setArgs().

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 154 of file Thyra_ModelEvaluatorBase_def.hpp.

Referenced by Thyra::EpetraModelEvaluator::convertInArgsFromEpetraToThyra().

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 162 of file Thyra_ModelEvaluatorBase_def.hpp.

Referenced by Thyra::DirectionalFiniteDiffCalculator< Scalar >::calcVariations(), Thyra::EpetraModelEvaluator::convertInArgsFromThyraToEpetra(), Thyra::DiagonalQuadraticResponseOnlyModelEvaluator< Scalar >::evalModelImpl(), Thyra::DefaultMultiPeriodModelEvaluator< Scalar >::evalModelImpl(), Thyra::DefaultInverseModelEvaluator< Scalar >::evalModelImpl(), Thyra::DefaultLumpedParameterModelEvaluator< Scalar >::reportFinalPoint(), and Thyra::ModelEvaluatorBase::InArgs< Scalar >::setArgs().

template<class Scalar >

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

Precondition: supports(IN_ARG_t)==true.

Definition at line 167 of file Thyra_ModelEvaluatorBase_def.hpp.

References Thyra::ModelEvaluatorBase::IN_ARG_t.

Referenced by Thyra::EpetraModelEvaluator::convertInArgsFromEpetraToThyra().

template<class Scalar >

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

.Precondition: supports(IN_ARG_t)==true

Definition at line 173 of file Thyra_ModelEvaluatorBase_def.hpp.

References Thyra::ModelEvaluatorBase::IN_ARG_t.

Referenced by Thyra::EpetraModelEvaluator::convertInArgsFromThyraToEpetra(), and Thyra::ModelEvaluatorBase::InArgs< Scalar >::setArgs().

template<class Scalar>

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

Precondition: supports(IN_ARG_alpha)==true.

Definition at line 178 of file Thyra_ModelEvaluatorBase_def.hpp.

References Thyra::ModelEvaluatorBase::IN_ARG_alpha.

template<class Scalar >

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

Precondition: supports(IN_ARG_alph)==true.

Definition at line 183 of file Thyra_ModelEvaluatorBase_def.hpp.

References Thyra::ModelEvaluatorBase::IN_ARG_alpha.

Referenced by Thyra::EpetraModelEvaluator::convertInArgsFromThyraToEpetra(), and Thyra::ModelEvaluatorBase::InArgs< Scalar >::setArgs().

template<class Scalar>

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

Precondition: supports(IN_ARG_beta)==true.

Definition at line 188 of file Thyra_ModelEvaluatorBase_def.hpp.

References Thyra::ModelEvaluatorBase::IN_ARG_beta.

template<class Scalar >

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

Precondition: supports(IN_ARG_beta)==true.

Definition at line 193 of file Thyra_ModelEvaluatorBase_def.hpp.

References Thyra::ModelEvaluatorBase::IN_ARG_beta.

Referenced by Thyra::EpetraModelEvaluator::convertInArgsFromThyraToEpetra(), and Thyra::ModelEvaluatorBase::InArgs< Scalar >::setArgs().

template<class Scalar>

void Thyra::ModelEvaluatorBase::InArgs< Scalar >::setArgs	(	const InArgs< Scalar > &	inArgs,
		bool	ignoreUnsupported = `false`,
		bool	cloneObjects = `false`
	)