Newmark time stepper. More...

#include <Tempus_StepperNewmarkImplicitDForm_decl.hpp>

Inheritance diagram for Tempus::StepperNewmarkImplicitDForm< Scalar >:

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

	StepperNewmarkImplicitDForm (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar >> &appModel, const Teuchos::RCP< StepperObserver< Scalar > > &obs, const Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > &solver, bool useFSAL, std::string ICConsistency, bool ICConsistencyCheck, bool zeroInitialGuess, std::string schemeName, Scalar beta, Scalar gamma)
	Constructor. More...

virtual Scalar	getW_xDotDot_coeff (const Scalar dt) const
	Return W_xDotxDot_coeff = d(xDotDot)/d(x). More...

virtual Scalar	getAlpha (const Scalar dt) const
	Return alpha = d(xDot)/d(x). More...

virtual Scalar	getBeta (const Scalar) const
	Return beta = d(x)/d(x). More...

Teuchos::RCP< const Teuchos::ParameterList >	getValidParameters () 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	correctDisplacement (Thyra::VectorBase< Scalar > &d, const Thyra::VectorBase< Scalar > &dPred, const Thyra::VectorBase< Scalar > &a, const Scalar dt) const

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

void	setSchemeName (std::string schemeName)

void	setBeta (Scalar beta)

void	setGamma (Scalar gamma)

Basic stepper methods
virtual void	setModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar >> &appModel)

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

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

virtual void	initialize ()
	Initialize during construction and after changing input parameters. More...

virtual void	setInitialConditions (const Teuchos::RCP< SolutionHistory< Scalar > > &)
	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 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::StepperImplicit< Scalar >
virtual void	setModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel)

virtual void	setNonConstModel (const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &appModel)

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

virtual Teuchos::RCP< const WrapperModelEvaluator< Scalar > >	getWrapperModel ()

virtual void	setSolver (Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > solver=Teuchos::null)
	Set solver. More...

virtual Teuchos::RCP < Thyra::NonlinearSolverBase < Scalar > >	getSolver () const
	Get solver. More...

const Thyra::SolveStatus< Scalar >	solveImplicitODE (const Teuchos::RCP< Thyra::VectorBase< Scalar > > &x)
	Solve problem using x in-place. (Needs to be deprecated!) More...

const Thyra::SolveStatus< Scalar >	solveImplicitODE (const Teuchos::RCP< Thyra::VectorBase< Scalar > > &x, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &xDot, const Scalar time, const Teuchos::RCP< ImplicitODEParameters< Scalar > > &p)
	Solve implicit ODE, f(x, xDot, t, p) = 0. More...

void	evaluateImplicitODE (Teuchos::RCP< Thyra::VectorBase< Scalar > > &f, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &x, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &xDot, const Scalar time, const Teuchos::RCP< ImplicitODEParameters< Scalar > > &p)
	Evaluate implicit ODE residual, f(x, xDot, t, p). More...

virtual void	setInitialGuess (Teuchos::RCP< const Thyra::VectorBase< Scalar > > initial_guess)
	Pass initial guess to Newton solver (only relevant for implicit solvers) More...

virtual void	setZeroInitialGuess (bool zIG)
	Set parameter so that the initial guess is set to zero (=True) or use last timestep (=False). More...

virtual bool	getZeroInitialGuess () const

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

virtual void	setStepperXDot (Teuchos::RCP< Thyra::VectorBase< Scalar > > xDot)
	Set xDot for 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...

Public Member Functions inherited from Tempus::Stepper< Scalar >
virtual void	takeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)=0
	Take the specified timestep, dt, and return true if successful. More...

void	setStepperType (std::string s)

std::string	getStepperType () const

void	setUseFSAL (bool a)

bool	getUseFSAL () const

virtual bool	getUseFSALDefault () const

void	setICConsistency (std::string s)

std::string	getICConsistency () const

virtual std::string	getICConsistencyDefault () const

void	setICConsistencyCheck (bool c)

bool	getICConsistencyCheck () const

virtual bool	getICConsistencyCheckDefault () const

virtual std::string	description () const

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

Protected Attributes
Thyra::ModelEvaluatorBase::InArgs < Scalar >	inArgs_

Thyra::ModelEvaluatorBase::OutArgs < Scalar >	outArgs_

std::string	schemeName_

Scalar	beta_

Scalar	gamma_

Teuchos::RCP < Teuchos::FancyOStream >	out_

Protected Attributes inherited from Tempus::StepperImplicit< Scalar >
Teuchos::RCP < WrapperModelEvaluator < Scalar > >	wrapperModel_

Teuchos::RCP < Thyra::NonlinearSolverBase < Scalar > >	solver_

Teuchos::RCP< const Thyra::VectorBase< Scalar > >	initial_guess_

bool	zeroInitialGuess_

Teuchos::RCP< StepperObserver < Scalar > >	stepperObserver_

Teuchos::RCP < Thyra::VectorBase< Scalar > >	stepperXDot_

Teuchos::RCP < Thyra::VectorBase< Scalar > >	stepperXDotDot_

Detailed Description

template<class Scalar>
class Tempus::StepperNewmarkImplicitDForm< Scalar >

Newmark time stepper.

Here, we implement the Newmark scheme in displacement predictor/corrector form; see equations (34)-(35) in: A. Mota, W. Klug, M. Ortiz, "Finite element simulation of firearm injury to the human cranium", Computational Mechanics 31(1) 115-121 (2003).

Newmark has two parameters: $\beta$ and $\gamma$ , both of which need to be in the range $[0,1]$ . Newmark can be an explicit or implicit method, depending on the value of the $\beta$ parameter. If $\beta = 0$ , the method is explicit; but note that the d-form of the Newmark scheme is not defined for the explicit case.

Newmark is second order accurate if $\gamma = 0.5$ ; otherwise it is first order accurate. Some additional properties about the Newmark Beta scheme can be found here.

The First-Step-As-Last (FSAL) principle is not used with the Newmark implicit D-Form method.

Definition at line 40 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar >

Tempus::StepperNewmarkImplicitDForm< Scalar >::StepperNewmarkImplicitDForm ( )

Default constructor.

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

Definition at line 171 of file Tempus_StepperNewmarkImplicitDForm_impl.hpp.

template<class Scalar >

Tempus::StepperNewmarkImplicitDForm< Scalar >::StepperNewmarkImplicitDForm	(	const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar >> &	appModel,
		const Teuchos::RCP< StepperObserver< Scalar > > &	obs,
		const Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > &	solver,
		bool	useFSAL,
		std::string	ICConsistency,
		bool	ICConsistencyCheck,
		bool	zeroInitialGuess,
		std::string	schemeName,
		Scalar	beta,
		Scalar	gamma
	)

Constructor.

Definition at line 188 of file Tempus_StepperNewmarkImplicitDForm_impl.hpp.

Member Function Documentation

template<class Scalar >

void Tempus::StepperNewmarkImplicitDForm< Scalar >::correctAcceleration	(	Thyra::VectorBase< Scalar > &	a,
		const Thyra::VectorBase< Scalar > &	dPred,
		const Thyra::VectorBase< Scalar > &	d,
		const Scalar	dt
	)		const

Definition at line 82 of file Tempus_StepperNewmarkImplicitDForm_impl.hpp.

template<class Scalar >

void Tempus::StepperNewmarkImplicitDForm< Scalar >::correctDisplacement	(	Thyra::VectorBase< Scalar > &	d,
		const Thyra::VectorBase< Scalar > &	dPred,
		const Thyra::VectorBase< Scalar > &	a,
		const Scalar	dt
	)		const

Definition at line 70 of file Tempus_StepperNewmarkImplicitDForm_impl.hpp.

template<class Scalar >

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

Definition at line 58 of file Tempus_StepperNewmarkImplicitDForm_impl.hpp.

template<class Scalar >

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

virtual

Definition at line 425 of file Tempus_StepperNewmarkImplicitDForm_impl.hpp.

template<class Scalar >

virtual Scalar Tempus::StepperNewmarkImplicitDForm< Scalar >::getAlpha ( const Scalar dt ) const

inlinevirtual

Return alpha = d(xDot)/d(x).

Implements Tempus::StepperImplicit< Scalar >.

Definition at line 118 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

template<class Scalar >

virtual Scalar Tempus::StepperNewmarkImplicitDForm< Scalar >::getBeta ( const Scalar ) const

inlinevirtual

Return beta = d(x)/d(x).

Implements Tempus::StepperImplicit< Scalar >.

Definition at line 120 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

template<class Scalar >

Teuchos::RCP< Tempus::StepperState< Scalar > > Tempus::StepperNewmarkImplicitDForm< 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 414 of file Tempus_StepperNewmarkImplicitDForm_impl.hpp.

template<class Scalar >

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

inlinevirtual

Get Observer.

Implements Tempus::Stepper< Scalar >.

Definition at line 71 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 90 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 101 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 97 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 111 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

template<class Scalar >

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

virtual

Implements Tempus::Stepper< Scalar >.

Definition at line 437 of file Tempus_StepperNewmarkImplicitDForm_impl.hpp.

template<class Scalar >

virtual Scalar Tempus::StepperNewmarkImplicitDForm< Scalar >::getW_xDotDot_coeff ( const Scalar dt ) const

inlinevirtual

Return W_xDotxDot_coeff = d(xDotDot)/d(x).

Definition at line 115 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

template<class Scalar >

void Tempus::StepperNewmarkImplicitDForm< Scalar >::initialize ( )

virtual

Initialize during construction and after changing input parameters.

Implements Tempus::Stepper< Scalar >.

Definition at line 239 of file Tempus_StepperNewmarkImplicitDForm_impl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 104 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 106 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 105 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 109 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 108 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

template<class Scalar >

void Tempus::StepperNewmarkImplicitDForm< 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 40 of file Tempus_StepperNewmarkImplicitDForm_impl.hpp.

template<class Scalar >

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