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

This is a Forward Euler time stepper to test the PhysicsState. More...

#include <Tempus_PhysicsStateTest_StepperForwardEuler.hpp>

Inheritance diagram for Tempus_Test::StepperPhysicsStateTest< Scalar >:
Inheritance graph
[legend]

Public Member Functions

 StepperPhysicsStateTest (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel)
 Constructor. More...
 
void initialize ()
 Initialize after construction and changing input parameters. More...
 
Teuchos::RCP
< Tempus::StepperState< Scalar > > 
getDefaultStepperState ()
 
Scalar getOrder () const
 
Scalar getOrderMin () const
 
Scalar getOrderMax () const
 
Tempus::OrderODE getOrderODE () const
 
virtual void takeStep (const Teuchos::RCP< Tempus::SolutionHistory< Scalar > > &solutionHistory)
 Take the specified timestep, dt, and return true if successful. More...
 
Teuchos::RCP< const
Teuchos::ParameterList
getValidParameters () const
 
- Public Member Functions inherited from Tempus::StepperExplicit< Scalar >
virtual bool isValidSetup (Teuchos::FancyOStream &out) const
 
void setStepperExplicitValues (Teuchos::RCP< Teuchos::ParameterList > pl)
 Set StepperExplicit member data from the ParameterList. More...
 
virtual void setModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel)
 
virtual Teuchos::RCP< const
Thyra::ModelEvaluator< Scalar > > 
getModel ()
 
virtual Scalar getInitTimeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &) const
 
virtual void setInitialConditions (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
 Set the initial conditions, make them consistent, and set needed memory. More...
 
virtual void setSolver (Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > solver)
 Set solver. More...
 
virtual Teuchos::RCP
< Thyra::NonlinearSolverBase
< Scalar > > 
getSolver () const
 Get solver. More...
 
virtual void setInitialGuess (Teuchos::RCP< const Thyra::VectorBase< Scalar > >)
 Pass initial guess to Newton solver (only relevant for implicit solvers) More...
 
virtual bool isExplicit () const
 
virtual bool isImplicit () const
 
virtual bool isExplicitImplicit () const
 
virtual bool isOneStepMethod () const
 
virtual bool isMultiStepMethod () const
 
virtual void evaluateExplicitODE (Teuchos::RCP< Thyra::VectorBase< Scalar > > xDot, Teuchos::RCP< const Thyra::VectorBase< Scalar > > x, const Scalar time, const Teuchos::RCP< ExplicitODEParameters< Scalar > > &p)
 Evaluate xDot = f(x,t). More...
 
virtual void evaluateExplicitODE (Teuchos::RCP< Thyra::VectorBase< Scalar > > xDotDot, Teuchos::RCP< const Thyra::VectorBase< Scalar > > x, Teuchos::RCP< const Thyra::VectorBase< Scalar > > xDot, const Scalar time, const Teuchos::RCP< ExplicitODEParameters< Scalar > > &p)
 Evaluate xDotDot = f(x, xDot, t). More...
 
virtual void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
 
- Public Member Functions inherited from Tempus::Stepper< Scalar >
void setStepperValues (const Teuchos::RCP< Teuchos::ParameterList > pl)
 Set Stepper member data from ParameterList. More...
 
Teuchos::RCP
< Teuchos::ParameterList
getValidParametersBasic () const
 Add basic parameters to Steppers ParameterList. More...
 
virtual void setNonConstModel (const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &)
 
virtual bool isInitialized ()
 True if stepper's member data is initialized. More...
 
virtual void checkInitialized ()
 Check initialization, and error out on failure. More...
 
void setStepperName (std::string s)
 Set the stepper name. More...
 
std::string getStepperName () const
 Get the stepper name. More...
 
std::string getStepperType () const
 Get the stepper type. The stepper type is used as an identifier for the stepper, and can only be set by the derived Stepper class. More...
 
virtual void setUseFSAL (bool a)
 
void setUseFSALTrueOnly (bool a)
 
void setUseFSALFalseOnly (bool a)
 
bool getUseFSAL () const
 
void setICConsistency (std::string s)
 
std::string getICConsistency () const
 
void setICConsistencyCheck (bool c)
 
bool getICConsistencyCheck () const
 
virtual Teuchos::RCP
< Thyra::VectorBase< Scalar > > 
getStepperX ()
 Get Stepper x. More...
 
virtual Teuchos::RCP
< Thyra::VectorBase< Scalar > > 
getStepperXDot ()
 Get Stepper xDot. More...
 
virtual Teuchos::RCP
< Thyra::VectorBase< Scalar > > 
getStepperXDotDot ()
 Get Stepper xDotDot. More...
 
virtual Teuchos::RCP
< Thyra::VectorBase< Scalar > > 
getStepperXDotDot (Teuchos::RCP< SolutionState< Scalar > > state)
 Get xDotDot from SolutionState or Stepper storage. More...
 
virtual std::string description () const
 
- Public Member Functions inherited from Teuchos::Describable
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::VerboseObject< Stepper< Scalar > >
 VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual const VerboseObjectsetVerbLevel (const EVerbosityLevel verbLevel) const
 
virtual const VerboseObjectsetOverridingVerbLevel (const EVerbosityLevel verbLevel) const
 
virtual EVerbosityLevel getVerbLevel () const
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
RCP< const ParameterList
getValidVerboseObjectSublist ()
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
void 
setupVerboseObjectSublist (ParameterList *paramList)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
void 
readVerboseObjectSublist (ParameterList *paramList, RCP< FancyOStream > *oStream, EVerbosityLevel *verbLevel)
 
void readVerboseObjectSublist (ParameterList *paramList, VerboseObject< ObjectType > *verboseObject)
 
- Public Member Functions inherited from Teuchos::VerboseObjectBase
virtual ~VerboseObjectBase ()
 
 VerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual const VerboseObjectBasesetOStream (const RCP< FancyOStream > &oStream) const
 
virtual const VerboseObjectBasesetOverridingOStream (const RCP< FancyOStream > &oStream) const
 
virtual VerboseObjectBasesetLinePrefix (const std::string &linePrefix)
 
virtual RCP< FancyOStreamgetOStream () const
 
virtual RCP< FancyOStreamgetOverridingOStream () const
 
virtual std::string getLinePrefix () const
 
virtual OSTab getOSTab (const int tabs=1, const std::string &linePrefix="") const
 

Additional Inherited Members

- Static Public Member Functions inherited from Teuchos::VerboseObject< Stepper< Scalar > >
static void setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel)
 
static EVerbosityLevel getDefaultVerbLevel ()
 
- Static Public Member Functions inherited from Teuchos::VerboseObjectBase
static void setDefaultOStream (const RCP< FancyOStream > &defaultOStream)
 
static RCP< FancyOStreamgetDefaultOStream ()
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default
 
- Protected Member Functions inherited from Tempus::Stepper< Scalar >
virtual void setStepperX (Teuchos::RCP< Thyra::VectorBase< Scalar > > x)
 Set x for Stepper storage. More...
 
virtual void setStepperXDot (Teuchos::RCP< Thyra::VectorBase< Scalar > > xDot)
 Set xDot for Stepper storage. More...
 
virtual void setStepperXDotDot (Teuchos::RCP< Thyra::VectorBase< Scalar > > xDotDot)
 Set x for Stepper storage. More...
 
void setStepperType (std::string s)
 Set the stepper type. More...
 
- Protected Member Functions inherited from Teuchos::VerboseObject< Stepper< Scalar > >
void initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)
 
- Protected Member Functions inherited from Teuchos::VerboseObjectBase
void initializeVerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual void informUpdatedVerbosityState () const
 
- Protected Attributes inherited from Tempus::StepperExplicit< Scalar >
Teuchos::RCP< const
Thyra::ModelEvaluator< Scalar > > 
appModel_
 Explicit ODE ModelEvaluator. More...
 
Thyra::ModelEvaluatorBase::InArgs
< Scalar > 
inArgs_
 
Thyra::ModelEvaluatorBase::OutArgs
< Scalar > 
outArgs_
 
- Protected Attributes inherited from Tempus::Stepper< Scalar >
bool useFSAL_ = false
 Use First-Same-As-Last (FSAL) principle. More...
 
bool isInitialized_ = false
 True if stepper's member data is initialized. More...
 

Detailed Description

template<class Scalar>
class Tempus_Test::StepperPhysicsStateTest< Scalar >

This is a Forward Euler time stepper to test the PhysicsState.

It is derived from StepperForwardEuler, and simply increments a physics counter.

Definition at line 25 of file Tempus_PhysicsStateTest_StepperForwardEuler.hpp.

Constructor & Destructor Documentation

template<class Scalar >
Tempus_Test::StepperPhysicsStateTest< Scalar >::StepperPhysicsStateTest ( const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &  appModel)
inline

Constructor.

Definition at line 31 of file Tempus_PhysicsStateTest_StepperForwardEuler.hpp.

Member Function Documentation

template<class Scalar >
void Tempus_Test::StepperPhysicsStateTest< Scalar >::initialize ( )
inlinevirtual

Initialize after construction and changing input parameters.

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 42 of file Tempus_PhysicsStateTest_StepperForwardEuler.hpp.

template<class Scalar >
Teuchos::RCP<Tempus::StepperState<Scalar> > Tempus_Test::StepperPhysicsStateTest< Scalar >::getDefaultStepperState ( )
inlinevirtual
template<class Scalar >
Scalar Tempus_Test::StepperPhysicsStateTest< Scalar >::getOrder ( ) const
inlinevirtual
template<class Scalar >
Scalar Tempus_Test::StepperPhysicsStateTest< Scalar >::getOrderMin ( ) const
inlinevirtual
template<class Scalar >
Scalar Tempus_Test::StepperPhysicsStateTest< Scalar >::getOrderMax ( ) const
inlinevirtual
template<class Scalar >
Tempus::OrderODE Tempus_Test::StepperPhysicsStateTest< Scalar >::getOrderODE ( ) const
inlinevirtual
template<class Scalar >
virtual void Tempus_Test::StepperPhysicsStateTest< Scalar >::takeStep ( const Teuchos::RCP< Tempus::SolutionHistory< Scalar > > &  solutionHistory)
inlinevirtual

Take the specified timestep, dt, and return true if successful.

Implements Tempus::Stepper< Scalar >.

Definition at line 51 of file Tempus_PhysicsStateTest_StepperForwardEuler.hpp.

template<class Scalar >
Teuchos::RCP<const Teuchos::ParameterList> Tempus_Test::StepperPhysicsStateTest< Scalar >::getValidParameters ( ) const
inlinevirtual

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 97 of file Tempus_PhysicsStateTest_StepperForwardEuler.hpp.


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