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

Thyra Base interface for implicit time steppers. More...

#include <Tempus_StepperExplicit_decl.hpp>

Inheritance diagram for Tempus::StepperExplicit< Scalar >:
Tempus::Stepper< Scalar > Teuchos::Describable Teuchos::VerboseObject< Stepper< Scalar > > Teuchos::LabeledObject Teuchos::VerboseObjectBase Tempus::StepperExplicitRK< Scalar > Tempus::StepperForwardEuler< Scalar > Tempus::StepperLeapfrog< Scalar > Tempus::StepperNewmarkExplicitAForm< Scalar > Tempus_Test::StepperPhysicsStateTest< Scalar > Tempus::StepperERK_3_8Rule< Scalar > Tempus::StepperERK_3Stage3rdOrder< Scalar > Tempus::StepperERK_3Stage3rdOrderHeun< Scalar > Tempus::StepperERK_3Stage3rdOrderTVD< Scalar > Tempus::StepperERK_4Stage3rdOrderRunge< Scalar > Tempus::StepperERK_4Stage4thOrder< Scalar > Tempus::StepperERK_5Stage3rdOrderKandG< Scalar > Tempus::StepperERK_BogackiShampine32< Scalar > Tempus::StepperERK_ForwardEuler< Scalar > Tempus::StepperERK_General< Scalar > Tempus::StepperERK_Merson45< Scalar > Tempus::StepperERK_Midpoint< Scalar > Tempus::StepperERK_Ralston< Scalar > Tempus::StepperERK_SSPERK54< Scalar > Tempus::StepperERK_Trapezoidal< Scalar >

Public Member Functions

virtual bool isValidSetup (Teuchos::FancyOStream &out) const
 
void setStepperExplicitValues (Teuchos::RCP< Teuchos::ParameterList > pl)
 Set StepperExplicit member data from the ParameterList. More...
 
- Public Member Functions inherited from Tempus::Stepper< Scalar >
void setStepperValues (const Teuchos::RCP< Teuchos::ParameterList > pl)
 Set Stepper member data from ParameterList. More...
 
virtual Teuchos::RCP< const
Teuchos::ParameterList > 		getValidParameters () const
 
Teuchos::RCP
< Teuchos::ParameterList > 		getValidParametersBasic () const
 Add basic parameters to Steppers ParameterList. More...
 
virtual void initialize ()
 Initialize after construction and changing input parameters. More...
 
virtual bool isInitialized ()
 True if stepper's member data is initialized. More...
 
virtual void checkInitialized ()
 Check initialization, and error out on failure. More...
 
virtual void takeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)=0
 Take the specified timestep, dt, and return true if successful. More...
 
virtual Teuchos::RCP
< Tempus::StepperState< Scalar > > 		getDefaultStepperState ()=0
 
virtual Scalar getOrder () const =0
 
virtual Scalar getOrderMin () const =0
 
virtual Scalar getOrderMax () const =0
 
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 OrderODE getOrderODE () const =0
 
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 VerboseObject & setVerbLevel (const EVerbosityLevel verbLevel) const
 
virtual const VerboseObject & setOverridingVerbLevel (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 VerboseObjectBase & setOStream (const RCP< FancyOStream > &oStream) const
 
virtual const VerboseObjectBase & setOverridingOStream (const RCP< FancyOStream > &oStream) const
 
virtual VerboseObjectBase & setLinePrefix (const std::string &linePrefix)
 
virtual RCP< FancyOStream > getOStream () const
 
virtual RCP< FancyOStream > getOverridingOStream () const
 
virtual std::string getLinePrefix () const
 
virtual OSTab getOSTab (const int tabs=1, const std::string &linePrefix="") const
 

Protected Attributes

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_
 True if stepper's member data is initialized. More...
 

Basic explicit stepper methods

virtual void setModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel)
 Set model. More...
 
virtual Teuchos::RCP< const
Thyra::ModelEvaluator< Scalar > > 		getModel () const
 Return the application ModelEvaluator. More...
 
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...
 

Overridden from Teuchos::Describable

virtual void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) 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< FancyOStream > getDefaultOStream ()
 
- 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
 

Detailed Description

template<class Scalar>
class Tempus::StepperExplicit< Scalar >

Thyra Base interface for implicit time steppers.

Definition at line 38 of file Tempus_StepperExplicit_decl.hpp.

Member Function Documentation

template<class Scalar >
void Tempus::StepperExplicit< Scalar >::setModel ( const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &  appModel)
virtual

Set model.

Reimplemented from Tempus::Stepper< Scalar >.

Reimplemented in Tempus::StepperExplicitRK< Scalar >.

Definition at line 17 of file Tempus_StepperExplicit_impl.hpp.

template<class Scalar >
virtual Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > Tempus::StepperExplicit< Scalar >::getModel ( ) const
inlinevirtual

Return the application ModelEvaluator.

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 47 of file Tempus_StepperExplicit_decl.hpp.

template<class Scalar >
virtual Scalar Tempus::StepperExplicit< Scalar >::getInitTimeStep ( const Teuchos::RCP< SolutionHistory< Scalar > > &  ) const
inlinevirtual

Implements Tempus::Stepper< Scalar >.

Reimplemented in Tempus::StepperNewmarkExplicitAForm< Scalar >, Tempus::StepperLeapfrog< Scalar >, and Tempus::StepperExplicitRK< Scalar >.

Definition at line 52 of file Tempus_StepperExplicit_decl.hpp.

template<class Scalar >
void Tempus::StepperExplicit< Scalar >::setInitialConditions ( const Teuchos::RCP< SolutionHistory< Scalar > > &  solutionHistory)
virtual

Set the initial conditions, make them consistent, and set needed memory.

Implements Tempus::Stepper< Scalar >.

Reimplemented in Tempus::StepperLeapfrog< Scalar >, Tempus::StepperNewmarkExplicitAForm< Scalar >, Tempus::StepperExplicitRK< Scalar >, and Tempus::StepperForwardEuler< Scalar >.

Definition at line 28 of file Tempus_StepperExplicit_impl.hpp.

template<class Scalar >
void Tempus::StepperExplicit< Scalar >::setSolver ( Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > >  solver)
virtual

Set solver.

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 267 of file Tempus_StepperExplicit_impl.hpp.

template<class Scalar >
virtual Teuchos::RCP<Thyra::NonlinearSolverBase<Scalar> > Tempus::StepperExplicit< Scalar >::getSolver ( ) const
inlinevirtual

Get solver.

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 65 of file Tempus_StepperExplicit_decl.hpp.

template<class Scalar >
virtual void Tempus::StepperExplicit< Scalar >::setInitialGuess ( Teuchos::RCP< const Thyra::VectorBase< Scalar > >  )
inlinevirtual

Pass initial guess to Newton solver (only relevant for implicit solvers)

Implements Tempus::Stepper< Scalar >.

Definition at line 72 of file Tempus_StepperExplicit_decl.hpp.

template<class Scalar >
virtual bool Tempus::StepperExplicit< Scalar >::isExplicit ( ) const
inlinevirtual

Implements Tempus::Stepper< Scalar >.

Reimplemented in Tempus::StepperNewmarkExplicitAForm< Scalar >, Tempus::StepperLeapfrog< Scalar >, and Tempus::StepperExplicitRK< Scalar >.

Definition at line 77 of file Tempus_StepperExplicit_decl.hpp.

template<class Scalar >
virtual bool Tempus::StepperExplicit< Scalar >::isImplicit ( ) const
inlinevirtual

Implements Tempus::Stepper< Scalar >.

Reimplemented in Tempus::StepperNewmarkExplicitAForm< Scalar >, Tempus::StepperLeapfrog< Scalar >, and Tempus::StepperExplicitRK< Scalar >.

Definition at line 78 of file Tempus_StepperExplicit_decl.hpp.

template<class Scalar >
virtual bool Tempus::StepperExplicit< Scalar >::isExplicitImplicit ( ) const
inlinevirtual

Implements Tempus::Stepper< Scalar >.

Reimplemented in Tempus::StepperNewmarkExplicitAForm< Scalar >, Tempus::StepperLeapfrog< Scalar >, and Tempus::StepperExplicitRK< Scalar >.

Definition at line 79 of file Tempus_StepperExplicit_decl.hpp.

template<class Scalar >
virtual bool Tempus::StepperExplicit< Scalar >::isOneStepMethod ( ) const
inlinevirtual

Implements Tempus::Stepper< Scalar >.

Reimplemented in Tempus::StepperNewmarkExplicitAForm< Scalar >, Tempus::StepperLeapfrog< Scalar >, and Tempus::StepperExplicitRK< Scalar >.

Definition at line 83 of file Tempus_StepperExplicit_decl.hpp.

template<class Scalar >
virtual bool Tempus::StepperExplicit< Scalar >::isMultiStepMethod ( ) const
inlinevirtual

Implements Tempus::Stepper< Scalar >.

Reimplemented in Tempus::StepperNewmarkExplicitAForm< Scalar >, Tempus::StepperLeapfrog< Scalar >, and Tempus::StepperExplicitRK< Scalar >.

Definition at line 84 of file Tempus_StepperExplicit_decl.hpp.

template<class Scalar >
void Tempus::StepperExplicit< Scalar >::evaluateExplicitODE ( Teuchos::RCP< Thyra::VectorBase< Scalar > >  xDot,
Teuchos::RCP< const Thyra::VectorBase< Scalar > >  x,
const Scalar  time,
const Teuchos::RCP< ExplicitODEParameters< Scalar > > &  p 
)
virtual

Evaluate xDot = f(x,t).

Definition at line 278 of file Tempus_StepperExplicit_impl.hpp.

template<class Scalar >
void Tempus::StepperExplicit< Scalar >::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 
)
virtual

Evaluate xDotDot = f(x, xDot, t).

Definition at line 305 of file Tempus_StepperExplicit_impl.hpp.

template<class Scalar >
void Tempus::StepperExplicit< Scalar >::describe ( Teuchos::FancyOStream &  out,
const Teuchos::EVerbosityLevel  verbLevel 
) const
virtual

Reimplemented from Tempus::Stepper< Scalar >.

Reimplemented in Tempus::StepperNewmarkExplicitAForm< Scalar >, Tempus::StepperLeapfrog< Scalar >, Tempus::StepperExplicitRK< Scalar >, and Tempus::StepperForwardEuler< Scalar >.

Definition at line 335 of file Tempus_StepperExplicit_impl.hpp.

template<class Scalar >
bool Tempus::StepperExplicit< Scalar >::isValidSetup ( Teuchos::FancyOStream &  out) const
virtual

Reimplemented from Tempus::Stepper< Scalar >.

Reimplemented in Tempus::StepperNewmarkExplicitAForm< Scalar >, Tempus::StepperLeapfrog< Scalar >, Tempus::StepperExplicitRK< Scalar >, and Tempus::StepperForwardEuler< Scalar >.

Definition at line 349 of file Tempus_StepperExplicit_impl.hpp.

template<class Scalar >
void Tempus::StepperExplicit< Scalar >::setStepperExplicitValues ( Teuchos::RCP< Teuchos::ParameterList >  pl)

Set StepperExplicit member data from the ParameterList.

Definition at line 363 of file Tempus_StepperExplicit_impl.hpp.

Member Data Documentation

template<class Scalar >
Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > Tempus::StepperExplicit< Scalar >::appModel_
protected

Explicit ODE ModelEvaluator.

Definition at line 113 of file Tempus_StepperExplicit_decl.hpp.

template<class Scalar >
Thyra::ModelEvaluatorBase::InArgs<Scalar> Tempus::StepperExplicit< Scalar >::inArgs_
protected

Definition at line 115 of file Tempus_StepperExplicit_decl.hpp.

template<class Scalar >
Thyra::ModelEvaluatorBase::OutArgs<Scalar> Tempus::StepperExplicit< Scalar >::outArgs_
protected

Definition at line 116 of file Tempus_StepperExplicit_decl.hpp.

The documentation for this class was generated from the following files:
Generated on Fri Apr 19 2024 09:25:34 for Tempus by   doxygen 1.8.5