Newmark Explicit time stepper. More...

#include <Tempus_StepperNewmarkExplicitAForm_decl.hpp>

Inheritance diagram for Tempus::StepperNewmarkExplicitAForm< Scalar >:

Public Member Functions
	StepperNewmarkExplicitAForm ()
	Default constructor. More...

	StepperNewmarkExplicitAForm (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel, const Teuchos::RCP< StepperObserver< Scalar > > &obs, bool useFSAL, std::string ICConsistency, bool ICConsistencyCheck, Scalar gamma)
	Constructor. More...

Teuchos::RCP< const Teuchos::ParameterList >	getValidParameters () const

virtual bool	isValidSetup (Teuchos::FancyOStream &out) const

void	predictVelocity (Thyra::VectorBase< Scalar > &vPred, const Thyra::VectorBase< Scalar > &v, const Thyra::VectorBase< Scalar > &a, const Scalar dt) const

void	predictDisplacement (Thyra::VectorBase< Scalar > &dPred, const Thyra::VectorBase< Scalar > &d, const Thyra::VectorBase< Scalar > &v, const Thyra::VectorBase< Scalar > &a, const Scalar dt) const

void	correctVelocity (Thyra::VectorBase< Scalar > &v, const Thyra::VectorBase< Scalar > &vPred, const Thyra::VectorBase< Scalar > &a, const Scalar dt) const

void	setGamma (Scalar gamma)

bool	getUseFSALDefault () const

std::string	getICConsistencyDefault () const

Basic stepper methods
virtual void	setObserver (Teuchos::RCP< StepperObserver< Scalar > >=Teuchos::null)
	Set Observer. More...

virtual Teuchos::RCP < StepperObserver< Scalar > >	getObserver () const
	Get Observer. More...

virtual void	setInitialConditions (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
	Set the initial conditions and make them consistent. More...

virtual void	takeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
	Take the specified timestep, dt, and return true if successful. More...

virtual Teuchos::RCP < Tempus::StepperState< Scalar > >	getDefaultStepperState ()
	Get a default (initial) StepperState. More...

virtual Scalar	getOrder () const

virtual Scalar	getOrderMin () const

virtual Scalar	getOrderMax () const

virtual Scalar	getInitTimeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &) const

virtual bool	isExplicit () const

virtual bool	isImplicit () const

virtual bool	isExplicitImplicit () const

virtual bool	isOneStepMethod () const

virtual bool	isMultiStepMethod () const

virtual OrderODE	getOrderODE () const

Overridden from Teuchos::Describable
virtual void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const

Public Member Functions inherited from Tempus::StepperExplicit< Scalar >
virtual void	setModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel)

virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > >	getModel ()

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 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...

Public Member Functions inherited from Tempus::Stepper< Scalar >
virtual void	setNonConstModel (const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &)

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...

void	setStepperType (std::string s)

std::string	getStepperType () const

void	setUseFSAL (bool a)

bool	getUseFSAL () const

void	setICConsistency (std::string s)

std::string	getICConsistency () const

void	setICConsistencyCheck (bool c)

bool	getICConsistencyCheck () const

virtual bool	getICConsistencyCheckDefault () const

virtual Teuchos::RCP < Thyra::VectorBase< Scalar > >	getStepperX (Teuchos::RCP< SolutionState< Scalar > > state)
	Get x from SolutionState or Stepper storage. More...

virtual Teuchos::RCP < Thyra::VectorBase< Scalar > >	getStepperXDot (Teuchos::RCP< SolutionState< Scalar > > state)
	Get xDot from SolutionState or Stepper storage. 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

virtual void	createSubSteppers (std::vector< Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > >)

Protected Attributes
Scalar	gammaDefault_

Scalar	gamma_

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_

Teuchos::RCP< StepperObserver < Scalar > >	stepperObserver_

Protected Attributes inherited from Tempus::Stepper< Scalar >
bool	isInitialized_ = false
	True if stepper's member data is initialized. More...

Additional Inherited Members
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...

Detailed Description

template<class Scalar>
class Tempus::StepperNewmarkExplicitAForm< Scalar >

Newmark Explicit time stepper.

This is the specific case of the more general Newmark time stepper where this stepper is explicit ( $\beta = 0$ ) (i.e., no solver used).

The governing equation is solved by this stepper is

$\mathbf{M}\, \ddot{\mathbf{x}} + \mathbf{C}\, \dot{\mathbf{x}} + \mathbf{K}\, \mathbf{x} = \mathbf{F}(t)$

For the A-form (i.e., solving for the acceleration, $\mathbf{a} = \ddot{\mathbf{x}}$ ), we have the following explicit ODE

$\mathbf{a} = -\mathbf{M}^{-1}\left[ \mathbf{C}\, \mathbf{v} + \mathbf{K}\, \mathbf{d} - \mathbf{F}(t) \right] = \bar{\mathbf{f}}(\mathbf{d}, \mathbf{v}, t)$

where $\mathbf{v} = \dot{\mathbf{x}}$ and $\mathbf{d} = \mathbf{x}$ .

Algorithm The algorithm for the Newmark explicit A-form is

if ( !useFSAL )
- $\mathbf{a}^{n-1} = \bar{\mathbf{f}}(\mathbf{d}^{n-1}, \mathbf{v}^{n-1}, t^{n-1})$
$\mathbf{d}^{\ast} = \mathbf{d}^{n-1} + \Delta t \mathbf{v}^{n-1} + \Delta t^2 \mathbf{a}^{n-1} / 2$
$\mathbf{v}^{\ast} = \mathbf{v}^{n-1} + \Delta t (1-\gamma) \mathbf{a}^{n-1}$
$\mathbf{a}^{\ast} = \bar{\mathbf{f}}(\mathbf{d}^{\ast}, \mathbf{v}^{\ast}, t^{n-1})$
$\mathbf{d}^n = \mathbf{d}^{\ast}$
$\mathbf{v}^n = \mathbf{v}^{\ast} + \Delta t \gamma \mathbf{a}^{\ast}$
if ( useFSAL )
- $\mathbf{a}^n = \bar{\mathbf{f}}(\mathbf{d}^n, \mathbf{v}^n, t^n)$

The default for Forward Euler is to use FSAL (useFSAL=true).

Definition at line 58 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar >

Tempus::StepperNewmarkExplicitAForm< Scalar >::StepperNewmarkExplicitAForm ( )

Default constructor.

Requires subsequent setModel() and initialize() calls before calling takeStep().

Definition at line 61 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

template<class Scalar >

Tempus::StepperNewmarkExplicitAForm< Scalar >::StepperNewmarkExplicitAForm	(	const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &	appModel,
		const Teuchos::RCP< StepperObserver< Scalar > > &	obs,
		bool	useFSAL,
		std::string	ICConsistency,
		bool	ICConsistencyCheck,
		Scalar	gamma
	)

Constructor.

Definition at line 74 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

Member Function Documentation

template<class Scalar >

void Tempus::StepperNewmarkExplicitAForm< Scalar >::correctVelocity	(	Thyra::VectorBase< Scalar > &	v,
		const Thyra::VectorBase< Scalar > &	vPred,
		const Thyra::VectorBase< Scalar > &	a,
		const Scalar	dt
	)		const

Definition at line 50 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

template<class Scalar >

void Tempus::StepperNewmarkExplicitAForm< Scalar >::describe	(	Teuchos::FancyOStream &	out,
		const Teuchos::EVerbosityLevel	verbLevel
	)		const

virtual

Reimplemented from Tempus::StepperExplicit< Scalar >.

Definition at line 321 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

template<class Scalar >

Teuchos::RCP< Tempus::StepperState< Scalar > > Tempus::StepperNewmarkExplicitAForm< Scalar >::getDefaultStepperState ( )

virtual

Get a default (initial) StepperState.

Provide a StepperState to the SolutionState. This Stepper does not have any special state data, so just provide the base class StepperState with the Stepper description. This can be checked to ensure that the input StepperState can be used by this Stepper.

Implements Tempus::Stepper< Scalar >.

Definition at line 312 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

template<class Scalar >

std::string Tempus::StepperNewmarkExplicitAForm< Scalar >::getICConsistencyDefault ( ) const

inlinevirtual

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 156 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

template<class Scalar >

virtual Scalar Tempus::StepperNewmarkExplicitAForm< Scalar >::getInitTimeStep ( const Teuchos::RCP< SolutionHistory< Scalar > > & ) const

inlinevirtual

Reimplemented from Tempus::StepperExplicit< Scalar >.

Definition at line 103 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

template<class Scalar >

virtual Teuchos::RCP<StepperObserver<Scalar> > Tempus::StepperNewmarkExplicitAForm< Scalar >::getObserver ( ) const

inlinevirtual

Get Observer.

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 84 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

template<class Scalar >

virtual Scalar Tempus::StepperNewmarkExplicitAForm< Scalar >::getOrder ( ) const

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 97 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

template<class Scalar >

virtual Scalar Tempus::StepperNewmarkExplicitAForm< Scalar >::getOrderMax ( ) const

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 102 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

template<class Scalar >

virtual Scalar Tempus::StepperNewmarkExplicitAForm< Scalar >::getOrderMin ( ) const

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 101 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

template<class Scalar >

virtual OrderODE Tempus::StepperNewmarkExplicitAForm< Scalar >::getOrderODE ( ) const

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 114 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

template<class Scalar >

bool Tempus::StepperNewmarkExplicitAForm< Scalar >::getUseFSALDefault ( ) const

inlinevirtual

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 155 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

template<class Scalar >

Teuchos::RCP< const Teuchos::ParameterList > Tempus::StepperNewmarkExplicitAForm< Scalar >::getValidParameters ( ) const

virtual

Implements Tempus::Stepper< Scalar >.

Definition at line 349 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

template<class Scalar >

virtual bool Tempus::StepperNewmarkExplicitAForm< Scalar >::isExplicit ( ) const

inlinevirtual

Reimplemented from Tempus::StepperExplicit< Scalar >.

Definition at line 107 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

template<class Scalar >

virtual bool Tempus::StepperNewmarkExplicitAForm< Scalar >::isExplicitImplicit ( ) const

inlinevirtual

Reimplemented from Tempus::StepperExplicit< Scalar >.

Definition at line 109 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

template<class Scalar >

virtual bool Tempus::StepperNewmarkExplicitAForm< Scalar >::isImplicit ( ) const

inlinevirtual

Reimplemented from Tempus::StepperExplicit< Scalar >.

Definition at line 108 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

template<class Scalar >

virtual bool Tempus::StepperNewmarkExplicitAForm< Scalar >::isMultiStepMethod ( ) const

inlinevirtual

Reimplemented from Tempus::StepperExplicit< Scalar >.

Definition at line 112 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

template<class Scalar >

virtual bool Tempus::StepperNewmarkExplicitAForm< Scalar >::isOneStepMethod ( ) const

inlinevirtual

Reimplemented from Tempus::StepperExplicit< Scalar >.

Definition at line 111 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

template<class Scalar >

bool Tempus::StepperNewmarkExplicitAForm< Scalar >::isValidSetup ( Teuchos::FancyOStream & out ) const

virtual

Reimplemented from Tempus::StepperExplicit< Scalar >.

Definition at line 336 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

template<class Scalar >

void Tempus::StepperNewmarkExplicitAForm< Scalar >::predictDisplacement	(	Thyra::VectorBase< Scalar > &	dPred,
		const Thyra::VectorBase< Scalar > &	d,
		const Thyra::VectorBase< Scalar > &	v,
		const Thyra::VectorBase< Scalar > &	a,
		const Scalar	dt
	)		const

Definition at line 33 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

template<class Scalar >

void Tempus::StepperNewmarkExplicitAForm< Scalar >::predictVelocity	(	Thyra::VectorBase< Scalar > &	vPred,
		const Thyra::VectorBase< Scalar > &	v,
		const Thyra::VectorBase< Scalar > &	a,
		const Scalar	dt
	)		const