Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Tempus_Test::SteadyQuadraticModel< Scalar > Class Template Reference

Simple quadratic equation with a stable steady-state. More...

#include <SteadyQuadraticModel_decl.hpp>

Inheritance diagram for Tempus_Test::SteadyQuadraticModel< Scalar >:
Thyra::StateFuncModelEvaluatorBase< Scalar > Teuchos::ParameterListAcceptorDefaultBase Thyra::ModelEvaluatorDefaultBase< Scalar > Teuchos::ParameterListAcceptor Thyra::ModelEvaluator< class > Thyra::ModelEvaluatorBase Teuchos::Describable Teuchos::LabeledObject

Public Member Functions

 SteadyQuadraticModel (Teuchos::RCP< Teuchos::ParameterList > pList=Teuchos::null)
 
Scalar getSteadyStateSolution () const
 
Scalar getSteadyStateSolutionSensitivity () const
 
- Public Member Functions inherited from Thyra::StateFuncModelEvaluatorBase< Scalar >
RCP< const VectorSpaceBase
< Scalar > > 
get_p_space (int l) const
 
RCP< const Teuchos::Array
< std::string > > 
get_p_names (int l) const
 
RCP< const VectorSpaceBase
< Scalar > > 
get_g_space (int j) const
 
Teuchos::ArrayView< const
std::string > 
get_g_names (int j) const
 
ModelEvaluatorBase::InArgs
< Scalar > 
getNominalValues () const
 
ModelEvaluatorBase::InArgs
< Scalar > 
getLowerBounds () const
 
ModelEvaluatorBase::InArgs
< Scalar > 
getUpperBounds () const
 
RCP< LinearOpBase< Scalar > > create_W_op () const
 
RCP< PreconditionerBase< Scalar > > create_W_prec () const
 
RCP< const
LinearOpWithSolveFactoryBase
< Scalar > > 
get_W_factory () const
 
void reportFinalPoint (const ModelEvaluatorBase::InArgs< Scalar > &finalPoint, const bool wasSolved)
 
- Public Member Functions inherited from Thyra::ModelEvaluator< class >
virtual int Np () const =0
 
virtual int Ng () const =0
 
virtual RCP< const
VectorSpaceBase< Scalar > > 
get_f_multiplier_space () const =0
 
virtual RCP< const
VectorSpaceBase< Scalar > > 
get_g_multiplier_space (int j) const =0
 
virtual RCP< LinearOpBase
< Scalar > > 
create_DfDp_op (int l) const =0
 
virtual RCP< LinearOpBase
< Scalar > > 
create_DgDx_dot_op (int j) const =0
 
virtual RCP< LinearOpBase
< Scalar > > 
create_DgDx_op (int j) const =0
 
virtual RCP< LinearOpBase
< Scalar > > 
create_DgDp_op (int j, int l) const =0
 
virtual
ModelEvaluatorBase::OutArgs
< Scalar > 
createOutArgs () const =0
 
virtual void evalModel (const ModelEvaluatorBase::InArgs< Scalar > &inArgs, const ModelEvaluatorBase::OutArgs< Scalar > &outArgs) const =0
 
 ModelEvaluatorBase ()
 
std::string toString (ModelEvaluatorBase::EInArgsMembers)
 
std::string toString (ModelEvaluatorBase::EOutArgsMembers)
 
std::string toString (ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation)
 
ModelEvaluatorBase::EDerivativeMultiVectorOrientation getOtherDerivativeMultiVectorOrientation (ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation)
 
- Public Member Functions inherited from Teuchos::Describable
virtual std::string description () const
 
virtual void describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
virtual ~Describable ()
 
 LabeledObject ()
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 
virtual std::string getObjectLabel () const
 
DescribableStreamManipulatorState describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
 
std::ostream & operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
 
- Public Member Functions inherited from Teuchos::ParameterListAcceptorDefaultBase
RCP< ParameterListgetNonconstParameterList ()
 
RCP< ParameterListunsetParameterList ()
 
RCP< const ParameterListgetParameterList () const
 

Private Member Functions

void setupInOutArgs_ () const
 

Private Attributes

int dim_
 Number of state unknowns (2) More...
 
int Np_
 Number of parameter vectors (1) More...
 
int np_
 Number of parameters in this vector (2) More...
 
int Ng_
 Number of observation functions (1) More...
 
int ng_
 Number of elements in this observation function (1) More...
 
bool useDfDpAsTangent_
 Treat DfDp OutArg as tangent (df/dx*dx/dp+df/dp) More...
 
bool isInitialized_
 
Thyra::ModelEvaluatorBase::InArgs
< Scalar > 
inArgs_
 
Thyra::ModelEvaluatorBase::OutArgs
< Scalar > 
outArgs_
 
Thyra::ModelEvaluatorBase::InArgs
< Scalar > 
nominalValues_
 
Teuchos::RCP< const
Thyra::VectorSpaceBase< Scalar > > 
x_space_
 
Teuchos::RCP< const
Thyra::VectorSpaceBase< Scalar > > 
f_space_
 
Teuchos::RCP< const
Thyra::VectorSpaceBase< Scalar > > 
p_space_
 
Teuchos::RCP< const
Thyra::VectorSpaceBase< Scalar > > 
g_space_
 
Teuchos::RCP< const
Thyra::VectorSpaceBase< Scalar > > 
DxDp_space_
 
Scalar b_
 Model parameter. More...
 

Public functions overridden from ModelEvaluator.

Teuchos::RCP< const
Thyra::VectorSpaceBase< Scalar > > 
get_x_space () const
 
Teuchos::RCP< const
Thyra::VectorSpaceBase< Scalar > > 
get_f_space () const
 
Thyra::ModelEvaluatorBase::InArgs
< Scalar > 
getNominalValues () const
 
Teuchos::RCP
< Thyra::LinearOpWithSolveBase
< Scalar > > 
create_W () const
 
Teuchos::RCP
< Thyra::LinearOpBase< Scalar > > 
create_W_op () const
 
Teuchos::RCP< const
Thyra::LinearOpWithSolveFactoryBase
< Scalar > > 
get_W_factory () const
 
Thyra::ModelEvaluatorBase::InArgs
< Scalar > 
createInArgs () const
 
Teuchos::RCP< const
Thyra::VectorSpaceBase< Scalar > > 
get_p_space (int l) const
 
Teuchos::RCP< const
Teuchos::Array< std::string > > 
get_p_names (int l) const
 
Teuchos::RCP< const
Thyra::VectorSpaceBase< Scalar > > 
get_g_space (int j) const
 

Public functions overridden from ParameterListAcceptor.

void setParameterList (Teuchos::RCP< Teuchos::ParameterList > const &paramList)
 
Teuchos::RCP< const
Teuchos::ParameterList
getValidParameters () const
 

Private functions overridden from ModelEvaluatorDefaultBase.

Thyra::ModelEvaluatorBase::OutArgs
< Scalar > 
createOutArgsImpl () const
 
void evalModelImpl (const Thyra::ModelEvaluatorBase::InArgs< Scalar > &inArgs_bar, const Thyra::ModelEvaluatorBase::OutArgs< Scalar > &outArgs_bar) const
 

Additional Inherited Members

- Public Types inherited from Thyra::ModelEvaluator< class >
enum  EInArgsMembers
 
enum  EInArgs_p_mp
 
enum  EEvalType
 
enum  EDerivativeMultiVectorOrientation
 
enum  EDerivativeLinearOp
 
enum  EDerivativeLinearity
 
enum  ERankStatus
 
enum  EOutArgsMembers
 
enum  EOutArgsDfDp
 
enum  EOutArgsDgDx_dot
 
enum  EOutArgsDgDx
 
enum  EOutArgsDgDp
 
enum  EOutArgsDfDp_mp
 
enum  EOutArgs_g_mp
 
enum  EOutArgsDgDx_dot_mp
 
enum  EOutArgsDgDx_mp
 
enum  EOutArgsDgDp_mp
 
typedef Teuchos::ScalarTraits
< Scalar >::magnitudeType 
ScalarMag
 
- Static Public Attributes inherited from Thyra::ModelEvaluator< class >
static const int NUM_E_IN_ARGS_MEMBERS
 
static const int NUM_E_OUT_ARGS_MEMBERS
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default
 
- Protected Member Functions inherited from Teuchos::ParameterListAcceptorDefaultBase
void setMyParamList (const RCP< ParameterList > &paramList)
 
RCP< ParameterListgetMyNonconstParamList ()
 
RCP< const ParameterListgetMyParamList () const
 

Detailed Description

template<class Scalar>
class Tempus_Test::SteadyQuadraticModel< Scalar >

Simple quadratic equation with a stable steady-state.

This is a simple differential equation

\[ \mathbf{\dot{x}}=\mathbf{x}^2 - b^2 \]

which has steady state solutions $\mathbf{x} = \pm b$. The solution $\mathbf{x} = b$ is stable if $b < 0$ and the solution $\mathbf{x} = -b$ is stable if $b > 0$. This model is used to test pseudo-transient sensitivity analysis methods.

Definition at line 32 of file SteadyQuadraticModel_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar >
Tempus_Test::SteadyQuadraticModel< Scalar >::SteadyQuadraticModel ( Teuchos::RCP< Teuchos::ParameterList pList = Teuchos::null)

Definition at line 29 of file SteadyQuadraticModel_impl.hpp.

Member Function Documentation

template<class Scalar >
Scalar Tempus_Test::SteadyQuadraticModel< Scalar >::getSteadyStateSolution ( ) const

Definition at line 55 of file SteadyQuadraticModel_impl.hpp.

template<class Scalar >
Scalar Tempus_Test::SteadyQuadraticModel< Scalar >::getSteadyStateSolutionSensitivity ( ) const

Definition at line 62 of file SteadyQuadraticModel_impl.hpp.

template<class Scalar >
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > Tempus_Test::SteadyQuadraticModel< Scalar >::get_x_space ( ) const
virtual

Implements Thyra::ModelEvaluator< class >.

Definition at line 70 of file SteadyQuadraticModel_impl.hpp.

template<class Scalar >
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > Tempus_Test::SteadyQuadraticModel< Scalar >::get_f_space ( ) const
virtual

Implements Thyra::ModelEvaluator< class >.

Definition at line 77 of file SteadyQuadraticModel_impl.hpp.

template<class Scalar >
Thyra::ModelEvaluatorBase::InArgs< Scalar > Tempus_Test::SteadyQuadraticModel< Scalar >::getNominalValues ( ) const
virtual

Implements Thyra::ModelEvaluator< class >.

Definition at line 84 of file SteadyQuadraticModel_impl.hpp.

template<class Scalar >
Teuchos::RCP< Thyra::LinearOpWithSolveBase< Scalar > > Tempus_Test::SteadyQuadraticModel< Scalar >::create_W ( ) const
virtual

Implements Thyra::ModelEvaluator< class >.

Definition at line 93 of file SteadyQuadraticModel_impl.hpp.

template<class Scalar >
Teuchos::RCP< Thyra::LinearOpBase< Scalar > > Tempus_Test::SteadyQuadraticModel< Scalar >::create_W_op ( ) const
virtual

Implements Thyra::ModelEvaluator< class >.

Definition at line 124 of file SteadyQuadraticModel_impl.hpp.

template<class Scalar >
Teuchos::RCP< const Thyra::LinearOpWithSolveFactoryBase< Scalar > > Tempus_Test::SteadyQuadraticModel< Scalar >::get_W_factory ( ) const
virtual

Implements Thyra::ModelEvaluator< class >.

Definition at line 133 of file SteadyQuadraticModel_impl.hpp.

template<class Scalar >
Thyra::ModelEvaluatorBase::InArgs< Scalar > Tempus_Test::SteadyQuadraticModel< Scalar >::createInArgs ( ) const
virtual

Implements Thyra::ModelEvaluator< class >.

Definition at line 142 of file SteadyQuadraticModel_impl.hpp.

template<class Scalar >
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > Tempus_Test::SteadyQuadraticModel< Scalar >::get_p_space ( int  l) const
virtual

Implements Thyra::ModelEvaluator< class >.

Definition at line 271 of file SteadyQuadraticModel_impl.hpp.

template<class Scalar >
Teuchos::RCP< const Teuchos::Array< std::string > > Tempus_Test::SteadyQuadraticModel< Scalar >::get_p_names ( int  l) const
virtual

Implements Thyra::ModelEvaluator< class >.

Definition at line 283 of file SteadyQuadraticModel_impl.hpp.

template<class Scalar >
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > Tempus_Test::SteadyQuadraticModel< Scalar >::get_g_space ( int  j) const
virtual

Implements Thyra::ModelEvaluator< class >.

Definition at line 300 of file SteadyQuadraticModel_impl.hpp.

template<class Scalar >
void Tempus_Test::SteadyQuadraticModel< Scalar >::setParameterList ( Teuchos::RCP< Teuchos::ParameterList > const &  paramList)
virtual

Implements Teuchos::ParameterListAcceptor.

Definition at line 372 of file SteadyQuadraticModel_impl.hpp.

template<class Scalar >
Teuchos::RCP< const Teuchos::ParameterList > Tempus_Test::SteadyQuadraticModel< Scalar >::getValidParameters ( ) const
virtual

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 391 of file SteadyQuadraticModel_impl.hpp.

template<class Scalar >
void Tempus_Test::SteadyQuadraticModel< Scalar >::setupInOutArgs_ ( ) const
private

Definition at line 309 of file SteadyQuadraticModel_impl.hpp.

template<class Scalar >
Thyra::ModelEvaluatorBase::OutArgs< Scalar > Tempus_Test::SteadyQuadraticModel< Scalar >::createOutArgsImpl ( ) const
private

Definition at line 152 of file SteadyQuadraticModel_impl.hpp.

template<class Scalar >
void Tempus_Test::SteadyQuadraticModel< Scalar >::evalModelImpl ( const Thyra::ModelEvaluatorBase::InArgs< Scalar > &  inArgs_bar,
const Thyra::ModelEvaluatorBase::OutArgs< Scalar > &  outArgs_bar 
) const
private

Definition at line 159 of file SteadyQuadraticModel_impl.hpp.

Member Data Documentation

template<class Scalar >
int Tempus_Test::SteadyQuadraticModel< Scalar >::dim_
private

Number of state unknowns (2)

Definition at line 81 of file SteadyQuadraticModel_decl.hpp.

template<class Scalar >
int Tempus_Test::SteadyQuadraticModel< Scalar >::Np_
private

Number of parameter vectors (1)

Definition at line 82 of file SteadyQuadraticModel_decl.hpp.

template<class Scalar >
int Tempus_Test::SteadyQuadraticModel< Scalar >::np_
private

Number of parameters in this vector (2)

Definition at line 83 of file SteadyQuadraticModel_decl.hpp.

template<class Scalar >
int Tempus_Test::SteadyQuadraticModel< Scalar >::Ng_
private

Number of observation functions (1)

Definition at line 84 of file SteadyQuadraticModel_decl.hpp.

template<class Scalar >
int Tempus_Test::SteadyQuadraticModel< Scalar >::ng_
private

Number of elements in this observation function (1)

Definition at line 85 of file SteadyQuadraticModel_decl.hpp.

template<class Scalar >
bool Tempus_Test::SteadyQuadraticModel< Scalar >::useDfDpAsTangent_
private

Treat DfDp OutArg as tangent (df/dx*dx/dp+df/dp)

Definition at line 86 of file SteadyQuadraticModel_decl.hpp.

template<class Scalar >
bool Tempus_Test::SteadyQuadraticModel< Scalar >::isInitialized_
mutableprivate

Definition at line 87 of file SteadyQuadraticModel_decl.hpp.

template<class Scalar >
Thyra::ModelEvaluatorBase::InArgs<Scalar> Tempus_Test::SteadyQuadraticModel< Scalar >::inArgs_
mutableprivate

Definition at line 88 of file SteadyQuadraticModel_decl.hpp.

template<class Scalar >
Thyra::ModelEvaluatorBase::OutArgs<Scalar> Tempus_Test::SteadyQuadraticModel< Scalar >::outArgs_
mutableprivate

Definition at line 89 of file SteadyQuadraticModel_decl.hpp.

template<class Scalar >
Thyra::ModelEvaluatorBase::InArgs<Scalar> Tempus_Test::SteadyQuadraticModel< Scalar >::nominalValues_
mutableprivate

Definition at line 90 of file SteadyQuadraticModel_decl.hpp.

template<class Scalar >
Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > Tempus_Test::SteadyQuadraticModel< Scalar >::x_space_
private

Definition at line 91 of file SteadyQuadraticModel_decl.hpp.

template<class Scalar >
Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > Tempus_Test::SteadyQuadraticModel< Scalar >::f_space_
private

Definition at line 92 of file SteadyQuadraticModel_decl.hpp.

template<class Scalar >
Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > Tempus_Test::SteadyQuadraticModel< Scalar >::p_space_
private

Definition at line 93 of file SteadyQuadraticModel_decl.hpp.

template<class Scalar >
Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > Tempus_Test::SteadyQuadraticModel< Scalar >::g_space_
private

Definition at line 94 of file SteadyQuadraticModel_decl.hpp.

template<class Scalar >
Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > Tempus_Test::SteadyQuadraticModel< Scalar >::DxDp_space_
private

Definition at line 95 of file SteadyQuadraticModel_decl.hpp.

template<class Scalar >
Scalar Tempus_Test::SteadyQuadraticModel< Scalar >::b_
private

Model parameter.

Definition at line 98 of file SteadyQuadraticModel_decl.hpp.


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