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, bool useFSAL, std::string ICConsistency, bool ICConsistencyCheck, Scalar gamma, const Teuchos::RCP< StepperNewmarkExplicitAFormAppAction< Scalar > > &stepperAppAction)
	Constructor. More...

virtual Teuchos::RCP < StepperNewmarkExplicitAFormAppAction < Scalar > >	getAppAction () const

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 void	setUseFSAL (bool a)

virtual OrderODE	getOrderODE () const

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)

virtual void	setAppAction (Teuchos::RCP< StepperNewmarkExplicitAFormAppAction< Scalar > > appAction)

Public Member Functions inherited from Tempus::StepperExplicit< Scalar >
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 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 >
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 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	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...

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 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
Scalar	gammaDefault_

Scalar	gamma_

Teuchos::RCP < StepperNewmarkExplicitAFormAppAction < Scalar > >	stepperNewmarkExpAppAction_

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

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

$\begin{center} \parbox{5in}{ \rule{5in}{0.4pt} \\ {\bf Algorithm} Newmark Explicit A-form \\ \rule{5in}{0.4pt} \vspace{-15pt} \begin{enumerate} \setlength{\itemsep}{0pt} \setlength{\parskip}{0pt} \setlength{\parsep}{0pt} \item {\it appAction.execute(solutionHistory, stepper, BEGIN\_STEP)} \item {\bf if (Not ``Use FSAL'' or (previous step failed)) then} \item \quad {\it appAction.execute(solutionHistory, stepper, BEFORE\_EXPLICIT\_EVAL)} \item \quad $\mathbf{a}^{n-1} = \bar{\mathbf{f}}(\mathbf{d}^{n-1}, \mathbf{v}^{n-1}, t^{n-1})$ \item {\bf endif} \item $\mathbf{d}^{\ast} = \mathbf{d}^{n-1} + \Delta t \mathbf{v}^{n-1} + \Delta t^2 \mathbf{a}^{n-1} / 2$ \item $\mathbf{v}^{\ast} = \mathbf{v}^{n-1} + \Delta t (1-\gamma) \mathbf{a}^{n-1}$ \item $\mathbf{a}^{\ast} = \bar{\mathbf{f}}(\mathbf{d}^{\ast}, \mathbf{v}^{\ast}, t^{n-1})$ \item $\mathbf{d}^n = \mathbf{d}^{\ast}$ \item $\mathbf{v}^n = \mathbf{v}^{\ast} + \Delta t \gamma \mathbf{a}^{\ast}$ \item {\bf if (``Use FSAL'') then} \item \quad {\it appAction.execute(solutionHistory, stepper, BEFORE\_EXPLICIT\_EVAL)} \item \quad $\mathbf{a}^n = \bar{\mathbf{f}}(\mathbf{d}^n, \mathbf{v}^n, t^n)$ \item {\bf endif} \item {\it appAction.execute(solutionHistory, stepper, END\_STEP)} \end{enumerate} \vspace{-10pt} \rule{5in}{0.4pt} } \end{center}$

Note that with useFSAL=false $x_n$ and $\dot{x}_{n-1}$ are not at the same time level at the end of the time step (i.e., they are not sync'ed).

To have them at the same time level, we can use the First-Same-As-Last (FSAL) principle where the function evaulation from the last time step can be used as the first function evalulation of the current step.

The default is to use FSAL (useFSAL=true), but will also work with useFSAL=false. Using useFSAL=true does assume that the solution, $x$ , its time derivative, $\dot{x}$ , and its second time derivative, $\ddot{x}$ , are consistent at the initial conditions (ICs), i.e., $\ddot{x}_{0} = \bar{f}(x_{0},\dot{x}_{0},t_{0})$ . This can be ensured by setting setICConsistency("Consistent"), and checked with setICConsistencyCheck(true).

Definition at line 93 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 62 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

template<class Scalar >

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

Constructor.

Definition at line 74 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

Member Function Documentation

template<class Scalar >

virtual Teuchos::RCP<StepperNewmarkExplicitAFormAppAction<Scalar> > Tempus::StepperNewmarkExplicitAForm< Scalar >::getAppAction ( ) const

inlinevirtual

Definition at line 115 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

template<class Scalar >

void Tempus::StepperNewmarkExplicitAForm< Scalar >::setInitialConditions ( const Teuchos::RCP< SolutionHistory< Scalar > > & solutionHistory )

virtual

Set the initial conditions and make them consistent.

Reimplemented from Tempus::StepperExplicit< Scalar >.

Definition at line 100 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

template<class Scalar >

void Tempus::StepperNewmarkExplicitAForm< Scalar >::takeStep ( const Teuchos::RCP< SolutionHistory< Scalar > > & solutionHistory )

virtual

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

Implements Tempus::Stepper< Scalar >.

Definition at line 237 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 333 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 128 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 132 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 133 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 134 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

template<class Scalar >

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

inlinevirtual

Reimplemented from Tempus::StepperExplicit< Scalar >.

Definition at line 138 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 139 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 140 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 142 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 143 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

template<class Scalar >

virtual void Tempus::StepperNewmarkExplicitAForm< Scalar >::setUseFSAL ( bool a )

inlinevirtual

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 144 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 145 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

template<class Scalar >

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

virtual

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 370 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 342 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

template<class Scalar >

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

virtual

Reimplemented from Tempus::StepperExplicit< Scalar >.

Definition at line 357 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

Definition at line 24 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 35 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

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