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>

Inheritance diagram for Thyra::ModelEvaluatorBase::InArgsSetup< Scalar >:

[legend]

Public Member Functions
	InArgsSetup ()

	InArgsSetup (const InArgs< Scalar > &)

void	setModelEvalDescription (const std::string &modelEvalDescription)

void	set_Np (int Np)

void	set_Np_Ng (int Np, int Ng)

void	setSupports (EInArgsMembers arg, bool supports=true)

void	setSupports (const InArgs< Scalar > &inputInArgs, const int Np=-1)

template<typename ObjectType >
void	setSupports (const bool supports=true)
	Set support for specific extended data types. More...

void	setUnsupportsAndRelated (EInArgsMembers arg)

Public Member Functions inherited from Thyra::ModelEvaluatorBase::InArgs< Scalar >
	InArgs ()

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 (EInArgsMembers arg) const
	Determines if an input argument is supported or not. More...

void	set_x_dot_dot (const RCP< const VectorBase< Scalar > > &x_dot_dot)
	Precondition: `supports(IN_ARG_x_dot_dot)==true`. More...

RCP< const VectorBase< Scalar > >	get_x_dot_dot () const
	Precondition: `supports(IN_ARG_x_dot_dot)==true`. 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_x_direction (const RCP< const MultiVectorBase< Scalar > > &x_direction)
	Precondition: `supports(IN_ARG_x)==true`. More...

void	set_p_direction (int l, const RCP< const MultiVectorBase< Scalar > > &p_direction_l)
	Precondition: `supports(IN_ARG_x)==true`. More...

RCP< const MultiVectorBase < Scalar > >	get_x_direction () const
	Precondition: `supports(IN_ARG_x)==true`. More...

RCP< const MultiVectorBase < Scalar > >	get_p_direction (int l) const
	Get `p(l)` where `0 <= l && l < this->Np()`. More...

void	set_f_multiplier (const RCP< const VectorBase< Scalar > > &f_multiplier)
	Precondition: `supports(IN_ARG_x)==true`. More...

RCP< const VectorBase< Scalar > >	get_f_multiplier () const
	Precondition: `supports(IN_ARG_x)==true`. More...

void	set_g_multiplier (int j, const RCP< const VectorBase< Scalar > > &g_multiplier)
	Precondition: `supports(IN_ARG_x)==true`. More...

RCP< const VectorBase< Scalar > >	get_g_multiplier (int j) const
	Precondition: `supports(IN_ARG_x)==true`. More...

template<typename ObjectType >
bool	supports () const
	Determines if an extended input argument of type `ObjectType` is supported. More...

template<typename ObjectType >
void	set (const RCP< const ObjectType > &uo)
	Set an extended input object of type `ObjectType` in the InArgs. Precondition: `supports()==true`. More...

template<typename ObjectType >
RCP< const ObjectType >	get () const
	Get an extended input object of type `ObjectType>/tt> from the InArgs. Precondition: supports()==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_alpha)==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_W_x_dot_dot_coeff (Scalar W_x_dot_dot_coeff)
	Precondition: `supports(IN_ARG_W_x_dot_dot_coeff)==true`. More...

Scalar	get_W_x_dot_dot_coeff () const
	Precondition: `supports(IN_ARG_W_x_dot_dot_coeff)==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
Public Types inherited from Thyra::ModelEvaluatorBase::InArgs< Scalar >
typedef Teuchos::ScalarTraits < Scalar >::magnitudeType	ScalarMag

Protected Member Functions inherited from Thyra::ModelEvaluatorBase::InArgs< Scalar >
void	_setModelEvalDescription (const std::string &modelEvalDescription)

void	_set_Np_Ng (int Np, int Ng)

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)

template<typename ObjectType >
void	_setSupports (const bool supports)

void	_setUnsupportsAndRelated (EInArgsMembers arg)

Detailed Description

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

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

Constructor & Destructor Documentation

template<class Scalar >

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

Definition at line 3461 of file Thyra_ModelEvaluatorBase_def.hpp.

template<class Scalar >

Thyra::ModelEvaluatorBase::InArgsSetup< Scalar >::InArgsSetup ( const InArgs< Scalar > & inArgs )

Definition at line 3466 of file Thyra_ModelEvaluatorBase_def.hpp.

Member Function Documentation

template<class Scalar >

void Thyra::ModelEvaluatorBase::InArgsSetup< Scalar >::setModelEvalDescription ( const std::string & modelEvalDescription )

Definition at line 3472 of file Thyra_ModelEvaluatorBase_def.hpp.

template<class Scalar >

void Thyra::ModelEvaluatorBase::InArgsSetup< Scalar >::set_Np ( int Np )

Definition at line 3480 of file Thyra_ModelEvaluatorBase_def.hpp.

template<class Scalar >

void Thyra::ModelEvaluatorBase::InArgsSetup< Scalar >::set_Np_Ng	(	int	Np,
		int	Ng
	)

Definition at line 3484 of file Thyra_ModelEvaluatorBase_def.hpp.

template<class Scalar >

void Thyra::ModelEvaluatorBase::InArgsSetup< Scalar >::setSupports	(	EInArgsMembers	arg,
		bool	supports = `true`
	)

Definition at line 3488 of file Thyra_ModelEvaluatorBase_def.hpp.

template<class Scalar >

void Thyra::ModelEvaluatorBase::InArgsSetup< Scalar >::setSupports	(	const InArgs< Scalar > &	inputInArgs,
		const int	Np = `-1`
	)

Definition at line 3498 of file Thyra_ModelEvaluatorBase_def.hpp.

template<class Scalar >

template<class ObjectType >

void Thyra::ModelEvaluatorBase::InArgsSetup< Scalar >::setSupports ( const bool supports = true )

Set support for specific extended data types.

Definition at line 1686 of file Thyra_ModelEvaluatorBase_decl.hpp.

template<class Scalar >

void Thyra::ModelEvaluatorBase::InArgsSetup< Scalar >::setUnsupportsAndRelated ( EInArgsMembers arg )

Definition at line 3507 of file Thyra_ModelEvaluatorBase_def.hpp.

The documentation for this class was generated from the following files:

Public Member Functions

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

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