Thyra::DefaultStateEliminationModelEvaluator< Scalar > Class Template Reference

This class wraps any ModelEvaluator object along with a NonlinearSolverBase object and eliminates the steady-state equations f(x,...)=0. More...

#include <Thyra_DefaultStateEliminationModelEvaluator.hpp>

Inheritance diagram for Thyra::DefaultStateEliminationModelEvaluator< Scalar >:

List of all members.

Private Attributes
Teuchos::RCP< ModelEvaluator < Scalar > >	thyraModel_
Teuchos::RCP < NonlinearSolverBase< Scalar > >	stateSolver_
Teuchos::RCP < DefaultNominalBoundsOverrideModelEvaluator < Scalar > >	wrappedThyraModel_
Teuchos::RCP< VectorBase < Scalar > >	x_guess_solu_
Constructors/initializers/accessors/utilities.
	DefaultStateEliminationModelEvaluator ()
	DefaultStateEliminationModelEvaluator (const Teuchos::RCP< ModelEvaluator< Scalar > > &thyraModel, const Teuchos::RCP< NonlinearSolverBase< Scalar > > &stateSolver)
void	initialize (const Teuchos::RCP< ModelEvaluator< Scalar > > &thyraModel, const Teuchos::RCP< NonlinearSolverBase< Scalar > > &stateSolver)
void	uninitialize (Teuchos::RCP< ModelEvaluator< Scalar > > *thyraModel=NULL, Teuchos::RCP< NonlinearSolverBase< Scalar > > *stateSolver=NULL)
Public functions overridden from Teuchos::Describable.
std::string	description () const
Public functions overridden from ModelEvaulator.
Teuchos::RCP< const VectorSpaceBase< Scalar > >	get_x_space () const
Teuchos::RCP< const VectorSpaceBase< Scalar > >	get_f_space () const
ModelEvaluatorBase::InArgs < Scalar >	getNominalValues () const
ModelEvaluatorBase::InArgs < Scalar >	getLowerBounds () const
ModelEvaluatorBase::InArgs < Scalar >	getUpperBounds () const
Teuchos::RCP < LinearOpWithSolveBase < Scalar > >	create_W () const
Teuchos::RCP< LinearOpBase < Scalar > >	create_W_op () const
ModelEvaluatorBase::InArgs < Scalar >	createInArgs () const
Private functions overridden from ModelEvaulatorDefaultBase.
ModelEvaluatorBase::OutArgs < Scalar >	createOutArgsImpl () const
void	evalModelImpl (const ModelEvaluatorBase::InArgs< Scalar > &inArgs, const ModelEvaluatorBase::OutArgs< Scalar > &outArgs) const

---

Detailed Description

template<class Scalar>
class Thyra::DefaultStateEliminationModelEvaluator< Scalar >

This class wraps any ModelEvaluator object along with a NonlinearSolverBase object and eliminates the steady-state equations f(x,...)=0.

ToDo: Finish documentation!

Definition at line 49 of file Thyra_DefaultStateEliminationModelEvaluator.hpp.

---

Constructor & Destructor Documentation

template<class Scalar >

Thyra::DefaultStateEliminationModelEvaluator< Scalar >::DefaultStateEliminationModelEvaluator

(

)

Definition at line 143 of file Thyra_DefaultStateEliminationModelEvaluator.hpp.

template<class Scalar >

Thyra::DefaultStateEliminationModelEvaluator< Scalar >::DefaultStateEliminationModelEvaluator	(	const Teuchos::RCP< ModelEvaluator< Scalar > > &	thyraModel,
		const Teuchos::RCP< NonlinearSolverBase< Scalar > > &	stateSolver
	)

Definition at line 147 of file Thyra_DefaultStateEliminationModelEvaluator.hpp.

---

Member Function Documentation

template<class Scalar >

void Thyra::DefaultStateEliminationModelEvaluator< Scalar >::initialize	(	const Teuchos::RCP< ModelEvaluator< Scalar > > &	thyraModel,
		const Teuchos::RCP< NonlinearSolverBase< Scalar > > &	stateSolver
	)

Definition at line 156 of file Thyra_DefaultStateEliminationModelEvaluator.hpp.

References Thyra::ModelEvaluatorDelegatorBase< Scalar >::initialize().

template<class Scalar >

void Thyra::DefaultStateEliminationModelEvaluator< Scalar >::uninitialize	(	Teuchos::RCP< ModelEvaluator< Scalar > > *	thyraModel = NULL,
		Teuchos::RCP< NonlinearSolverBase< Scalar > > *	stateSolver = NULL
	)

Definition at line 175 of file Thyra_DefaultStateEliminationModelEvaluator.hpp.

References Thyra::ModelEvaluatorDelegatorBase< Scalar >::uninitialize().

template<class Scalar >

std::string Thyra::DefaultStateEliminationModelEvaluator< Scalar >::description

(

)

const

Definition at line 192 of file Thyra_DefaultStateEliminationModelEvaluator.hpp.

template<class Scalar >

Teuchos::RCP< const VectorSpaceBase< Scalar > > Thyra::DefaultStateEliminationModelEvaluator< Scalar >::get_x_space

(

)

const [virtual]

Reimplemented from Thyra::ModelEvaluatorDelegatorBase< Scalar >.

Definition at line 216 of file Thyra_DefaultStateEliminationModelEvaluator.hpp.

template<class Scalar >

Teuchos::RCP< const VectorSpaceBase< Scalar > > Thyra::DefaultStateEliminationModelEvaluator< Scalar >::get_f_space

(

)

const [virtual]

Reimplemented from Thyra::ModelEvaluatorDelegatorBase< Scalar >.

Definition at line 223 of file Thyra_DefaultStateEliminationModelEvaluator.hpp.

template<class Scalar >

ModelEvaluatorBase::InArgs< Scalar > Thyra::DefaultStateEliminationModelEvaluator< Scalar >::getNominalValues

(

)

const [virtual]

Reimplemented from Thyra::ModelEvaluatorDelegatorBase< Scalar >.

Definition at line 230 of file Thyra_DefaultStateEliminationModelEvaluator.hpp.

template<class Scalar >

ModelEvaluatorBase::InArgs< Scalar > Thyra::DefaultStateEliminationModelEvaluator< Scalar >::getLowerBounds

(

)

const [virtual]

Reimplemented from Thyra::ModelEvaluatorDelegatorBase< Scalar >.

Definition at line 243 of file Thyra_DefaultStateEliminationModelEvaluator.hpp.

template<class Scalar >

ModelEvaluatorBase::InArgs< Scalar > Thyra::DefaultStateEliminationModelEvaluator< Scalar >::getUpperBounds

(

)

const [virtual]

Reimplemented from Thyra::ModelEvaluatorDelegatorBase< Scalar >.

Definition at line 256 of file Thyra_DefaultStateEliminationModelEvaluator.hpp.

template<class Scalar >

Teuchos::RCP< LinearOpWithSolveBase< Scalar > > Thyra::DefaultStateEliminationModelEvaluator< Scalar >::create_W

(

)

const [virtual]

Reimplemented from Thyra::ModelEvaluatorDelegatorBase< Scalar >.

Definition at line 269 of file Thyra_DefaultStateEliminationModelEvaluator.hpp.

template<class Scalar >

Teuchos::RCP< LinearOpBase< Scalar > > Thyra::DefaultStateEliminationModelEvaluator< Scalar >::create_W_op

(

)

const [virtual]

Reimplemented from Thyra::ModelEvaluatorDelegatorBase< Scalar >.

Definition at line 276 of file Thyra_DefaultStateEliminationModelEvaluator.hpp.

template<class Scalar >

ModelEvaluatorBase::InArgs< Scalar > Thyra::DefaultStateEliminationModelEvaluator< Scalar >::createInArgs

(

)

const [virtual]

Reimplemented from Thyra::ModelEvaluatorDelegatorBase< Scalar >.

Definition at line 284 of file Thyra_DefaultStateEliminationModelEvaluator.hpp.

template<class Scalar >

ModelEvaluatorBase::OutArgs< Scalar > Thyra::DefaultStateEliminationModelEvaluator< Scalar >::createOutArgsImpl

(

)

const [private, virtual]

Reimplemented from Thyra::ModelEvaluatorDelegatorBase< Scalar >.

Definition at line 304 of file Thyra_DefaultStateEliminationModelEvaluator.hpp.

template<class Scalar >

void Thyra::DefaultStateEliminationModelEvaluator< Scalar >::evalModelImpl	(	const ModelEvaluatorBase::InArgs< Scalar > &	inArgs,
		const ModelEvaluatorBase::OutArgs< Scalar > &	outArgs
	)		const [private, virtual]

Implements Thyra::ModelEvaluatorDefaultBase< Scalar >.

Definition at line 321 of file Thyra_DefaultStateEliminationModelEvaluator.hpp.

References Thyra::assign(), Thyra::ModelEvaluatorBase::OutArgs< Scalar >::get_DgDp(), Thyra::ModelEvaluatorBase::InArgs< Scalar >::get_x(), Thyra::ModelEvaluatorBase::OutArgs< Scalar >::Ng(), Thyra::ModelEvaluatorBase::OutArgs< Scalar >::Np(), Thyra::ModelEvaluatorBase::OutArgs< Scalar >::setFailed(), Thyra::SOLVE_STATUS_CONVERGED, Thyra::SolveStatus< Scalar >::solveStatus, and Thyra::ModelEvaluatorBase::OutArgs< Scalar >::supports().

---

Member Data Documentation

template<class Scalar >

Teuchos::RCP<ModelEvaluator<Scalar> > Thyra::DefaultStateEliminationModelEvaluator< Scalar >::thyraModel_ [private]

Definition at line 128 of file Thyra_DefaultStateEliminationModelEvaluator.hpp.

template<class Scalar >

Teuchos::RCP<NonlinearSolverBase<Scalar> > Thyra::DefaultStateEliminationModelEvaluator< Scalar >::stateSolver_ [private]

Definition at line 129 of file Thyra_DefaultStateEliminationModelEvaluator.hpp.

template<class Scalar >

Teuchos::RCP<DefaultNominalBoundsOverrideModelEvaluator<Scalar> > Thyra::DefaultStateEliminationModelEvaluator< Scalar >::wrappedThyraModel_ [private]

Definition at line 131 of file Thyra_DefaultStateEliminationModelEvaluator.hpp.

template<class Scalar >

Teuchos::RCP<VectorBase<Scalar> > Thyra::DefaultStateEliminationModelEvaluator< Scalar >::x_guess_solu_ [mutable, private]

Definition at line 133 of file Thyra_DefaultStateEliminationModelEvaluator.hpp.

---

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

• Thyra_DefaultStateEliminationModelEvaluator.hpp