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

A ModelEvaluator for residual evaluations given a state. This ModelEvaluator takes a state, x, and determines its residual, $ g(x) $, which is suitable for a nonlinear solve. This is accomplished by computing the time derivative of the state, x_dot, (through Lambda functions), supplying the current time, and calling the application application ModelEvaluator, $ f(\dot{x},x,t) $. More...

#include <Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp>

Inheritance diagram for Tempus::WrapperModelEvaluatorSecondOrder< Scalar >:
Tempus::WrapperModelEvaluator< Scalar > Thyra::StateFuncModelEvaluatorBase< Scalar > Thyra::ModelEvaluatorDefaultBase< Scalar > Thyra::ModelEvaluator< class > Thyra::ModelEvaluatorBase Teuchos::Describable Teuchos::LabeledObject

Public Types

enum  SCHEME_TYPE { NEWMARK_IMPLICIT_AFORM, NEWMARK_IMPLICIT_DFORM }
 
typedef Thyra::VectorBase< Scalar > Vector
 
- 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
 

Public Member Functions

 WrapperModelEvaluatorSecondOrder (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel, const std::string schemeName)
 Constructor. More...
 
void setAppModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &me)
 Set the underlying application ModelEvaluator. More...
 
Teuchos::RCP< const
Thyra::ModelEvaluator< Scalar > > 
getAppModel () const
 Get the underlying application model 'f'. More...
 
void initializeNewmark (Teuchos::RCP< const Vector > v_pred, Teuchos::RCP< const Vector > d_pred, Scalar delta_t, Scalar t, Scalar beta, Scalar gamma)
 Set values needed in evalModelImpl. More...
 
- Public Member Functions inherited from Tempus::WrapperModelEvaluator< Scalar >
- 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
< LinearOpWithSolveBase
< Scalar > > 
create_W () 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)
 

Private Member Functions

 WrapperModelEvaluatorSecondOrder ()
 Default constructor - not allowed. More...
 

Private Attributes

Teuchos::RCP< const
Thyra::ModelEvaluator< Scalar > > 
appModel_
 
Scalar t_
 
Scalar gamma_
 
Scalar beta_
 
Scalar delta_t_
 
Teuchos::RCP< const Vectord_pred_
 
Teuchos::RCP< const Vectorv_pred_
 
Teuchos::RCP
< Teuchos::FancyOStream
out_
 
SCHEME_TYPE schemeType_
 
Teuchos::RCP< TimeDerivative
< Scalar > > 
timeDer_
 
Thyra::ModelEvaluatorBase::InArgs
< Scalar > 
wrapperInArgs_
 
Thyra::ModelEvaluatorBase::OutArgs
< Scalar > 
wrapperOutArgs_
 

Overridden from Thyra::StateFuncModelEvaluatorBase

Teuchos::RCP
< Thyra::LinearOpBase< Scalar > > 
create_W_op () const
 
Teuchos::RCP< const
Thyra::LinearOpWithSolveFactoryBase
< Scalar > > 
get_W_factory () const
 
Teuchos::RCP< const
Thyra::VectorSpaceBase< Scalar > > 
get_f_space () const
 
Teuchos::RCP< const
Thyra::VectorSpaceBase< Scalar > > 
get_p_space (int p) const
 Get the p space. More...
 
Teuchos::RCP< const
Teuchos::Array< std::string > > 
get_p_names (int p) const
 
Teuchos::RCP< const
Thyra::VectorSpaceBase< Scalar > > 
get_x_space () const
 Get the x-solution space. More...
 
Teuchos::RCP< const
Thyra::VectorSpaceBase< Scalar > > 
get_g_space (int i) const
 Get the g space. More...
 
Thyra::ModelEvaluatorBase::InArgs
< Scalar > 
getNominalValues () const
 
virtual
Thyra::ModelEvaluatorBase::InArgs
< Scalar > 
getInArgs ()
 Get InArgs the wrapper ModelEvalutor. More...
 
virtual
Thyra::ModelEvaluatorBase::OutArgs
< Scalar > 
getOutArgs ()
 Get OutArgs the wrapper ModelEvalutor. More...
 
virtual void setForSolve (const Teuchos::RCP< Thyra::VectorBase< Scalar > > &x, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &xDot, const Scalar time, const Teuchos::RCP< ImplicitODEParameters< Scalar > > &p, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &y=Teuchos::null, const int index=-1)
 Set parameters for application implicit ModelEvaluator solve. More...
 
Thyra::ModelEvaluatorBase::InArgs
< Scalar > 
createInArgs () const
 
Thyra::ModelEvaluatorBase::OutArgs
< Scalar > 
createOutArgsImpl () const
 
void evalModelImpl (const Thyra::ModelEvaluatorBase::InArgs< Scalar > &inArgs, const Thyra::ModelEvaluatorBase::OutArgs< Scalar > &outArgs) const
 

Additional Inherited Members

- 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
 

Detailed Description

template<typename Scalar>
class Tempus::WrapperModelEvaluatorSecondOrder< Scalar >

A ModelEvaluator for residual evaluations given a state. This ModelEvaluator takes a state, x, and determines its residual, $ g(x) $, which is suitable for a nonlinear solve. This is accomplished by computing the time derivative of the state, x_dot, (through Lambda functions), supplying the current time, and calling the application application ModelEvaluator, $ f(\dot{x},x,t) $.

This class breaks the primary design principle for ModelEvaluators; it is not stateless!

Definition at line 33 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

Member Typedef Documentation

template<typename Scalar >
typedef Thyra::VectorBase<Scalar> Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::Vector

Member Enumeration Documentation

Enumerator
NEWMARK_IMPLICIT_AFORM 
NEWMARK_IMPLICIT_DFORM 

Definition at line 192 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

Constructor & Destructor Documentation

template<typename Scalar >
Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::WrapperModelEvaluatorSecondOrder ( const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &  appModel,
const std::string  schemeName 
)
inline

Constructor.

Definition at line 39 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

template<typename Scalar >
Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::WrapperModelEvaluatorSecondOrder ( )
private

Default constructor - not allowed.

Member Function Documentation

template<typename Scalar >
void Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::setAppModel ( const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &  me)
inlinevirtual

Set the underlying application ModelEvaluator.

Implements Tempus::WrapperModelEvaluator< Scalar >.

Definition at line 65 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

template<typename Scalar >
Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::getAppModel ( ) const
inlinevirtual

Get the underlying application model 'f'.

Implements Tempus::WrapperModelEvaluator< Scalar >.

Definition at line 74 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

template<typename Scalar >
void Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::initializeNewmark ( Teuchos::RCP< const Vector v_pred,
Teuchos::RCP< const Vector d_pred,
Scalar  delta_t,
Scalar  t,
Scalar  beta,
Scalar  gamma 
)
inline

Set values needed in evalModelImpl.

Definition at line 83 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

template<typename Scalar >
Teuchos::RCP<Thyra::LinearOpBase<Scalar> > Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::create_W_op ( ) const
inlinevirtual
template<typename Scalar >
Teuchos::RCP<const Thyra::LinearOpWithSolveFactoryBase<Scalar> > Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::get_W_factory ( ) const
inlinevirtual
template<typename Scalar >
Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::get_f_space ( ) const
inlinevirtual
template<typename Scalar >
Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::get_p_space ( int  i) const
inlinevirtual

Get the p space.

Implements Tempus::WrapperModelEvaluator< Scalar >.

Definition at line 125 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

template<typename Scalar >
Teuchos::RCP<const Teuchos::Array<std::string> > Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::get_p_names ( int  p) const
inlinevirtual
template<typename Scalar >
Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::get_x_space ( ) const
inlinevirtual

Get the x-solution space.

Implements Tempus::WrapperModelEvaluator< Scalar >.

Definition at line 141 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

template<typename Scalar >
Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::get_g_space ( int  i) const
inlinevirtual

Get the g space.

Implements Tempus::WrapperModelEvaluator< Scalar >.

Definition at line 149 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

template<typename Scalar >
Thyra::ModelEvaluatorBase::InArgs<Scalar> Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::getNominalValues ( ) const
inlinevirtual
template<typename Scalar >
virtual Thyra::ModelEvaluatorBase::InArgs<Scalar> Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::getInArgs ( )
inlinevirtual

Get InArgs the wrapper ModelEvalutor.

Definition at line 163 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

template<typename Scalar >
virtual Thyra::ModelEvaluatorBase::OutArgs<Scalar> Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::getOutArgs ( )
inlinevirtual

Get OutArgs the wrapper ModelEvalutor.

Definition at line 169 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

template<typename Scalar >
virtual void Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::setForSolve ( const Teuchos::RCP< Thyra::VectorBase< Scalar > > &  x,
const Teuchos::RCP< Thyra::VectorBase< Scalar > > &  xDot,
const Scalar  time,
const Teuchos::RCP< ImplicitODEParameters< Scalar > > &  p,
const Teuchos::RCP< Thyra::VectorBase< Scalar > > &  y = Teuchos::null,
const int  index = -1 
)
inlinevirtual

Set parameters for application implicit ModelEvaluator solve.

Implements Tempus::WrapperModelEvaluator< Scalar >.

Definition at line 175 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

template<typename Scalar >
Thyra::ModelEvaluatorBase::InArgs< Scalar > Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::createInArgs ( ) const
virtual
template<typename Scalar >
Thyra::ModelEvaluatorBase::OutArgs< Scalar > Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::createOutArgsImpl ( ) const
template<typename Scalar >
void Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::evalModelImpl ( const Thyra::ModelEvaluatorBase::InArgs< Scalar > &  inArgs,
const Thyra::ModelEvaluatorBase::OutArgs< Scalar > &  outArgs 
) const

Member Data Documentation

template<typename Scalar >
Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::appModel_
private
template<typename Scalar >
Scalar Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::t_
private
template<typename Scalar >
Scalar Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::gamma_
private
template<typename Scalar >
Scalar Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::beta_
private
template<typename Scalar >
Scalar Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::delta_t_
private
template<typename Scalar >
Teuchos::RCP<const Vector> Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::d_pred_
private
template<typename Scalar >
Teuchos::RCP<const Vector> Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::v_pred_
private
template<typename Scalar >
Teuchos::RCP<Teuchos::FancyOStream> Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::out_
private
template<typename Scalar >
SCHEME_TYPE Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::schemeType_
private
template<typename Scalar >
Teuchos::RCP<TimeDerivative<Scalar> > Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::timeDer_
private
template<typename Scalar >
Thyra::ModelEvaluatorBase::InArgs<Scalar> Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::wrapperInArgs_
private
template<typename Scalar >
Thyra::ModelEvaluatorBase::OutArgs<Scalar> Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::wrapperOutArgs_
private

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