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, Teuchos::RCP< Teuchos::ParameterList > pList=Teuchos::null)
	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...

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

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

ParameterList methods
void	setParameterList (const Teuchos::RCP< Teuchos::ParameterList > &pl)

Teuchos::RCP < Teuchos::ParameterList >	getNonconstParameterList ()

Teuchos::RCP < Teuchos::ParameterList >	unsetParameterList ()

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

Teuchos::RCP < Teuchos::ParameterList >	getDefaultParameters () 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 (std::string solverName)
	Set solver via ParameterList solver name. More...

virtual void	setSolver (Teuchos::RCP< Teuchos::ParameterList > solverPL=Teuchos::null)
	Set solver via solver ParameterList. 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 std::string	getStepperType () const

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, f(x, xDot, t, p), residual. 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 bool	getEmbedded () const

virtual void	setUseFSAL (bool a)

virtual bool	getUseFSAL () const

virtual void	setICConsistency (std::string s)

virtual std::string	getICConsistency () const

virtual void	setICConsistencyCheck (bool c)

virtual bool	getICConsistencyCheck () 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	modelWarning () const

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

void	getValidParametersBasic (Teuchos::RCP< Teuchos::ParameterList > pl) const

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

void	validExplicitODE (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model) const
	Validate that the model supports explicit ODE evaluation, f(x,t) [=xdot]. More...

void	validSecondOrderExplicitODE (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model) const
	Validate that the model supports explicit second order ODE evaluation, f(x,xdot,t) [=xdotdot]. More...

void	validImplicitODE_DAE (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model) const
	Validate ME supports implicit ODE/DAE evaluation, f(xdot,x,t) [= 0]. More...

void	validSecondOrderODE_DAE (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model) const
	Validate ME supports 2nd order implicit ODE/DAE evaluation, f(xdotdot,xdot,x,t) [= 0]. More...

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

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

Thyra::ModelEvaluatorBase::OutArgs < Scalar >	outArgs_

Scalar	beta_

Scalar	gamma_

Teuchos::RCP < Teuchos::FancyOStream >	out_

Protected Attributes inherited from Tempus::StepperImplicit< Scalar >
Teuchos::RCP < Teuchos::ParameterList >	stepperPL_

Teuchos::RCP < WrapperModelEvaluator < Scalar > >	wrapperModel_

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

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

Teuchos::RCP< StepperObserver < Scalar > >	stepperObserver_

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

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

Overridden from Teuchos::Describable
virtual void	const

virtual std::string	description () const

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.

Constructs with a default ParameterList.
Can reset ParameterList with setParameterList().
Requires subsequent setModel() and initialize() calls before calling takeStep().

Definition at line 94 of file Tempus_StepperNewmarkImplicitDForm_impl.hpp.

template<class Scalar >

Tempus::StepperNewmarkImplicitDForm< Scalar >::StepperNewmarkImplicitDForm	(	const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar >> &	appModel,
		Teuchos::RCP< Teuchos::ParameterList >	pList = `Teuchos::null`
	)

Constructor.

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

std::string Tempus::StepperNewmarkImplicitDForm< Scalar >::description ( ) const

virtual

Definition at line 330 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 109 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 111 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

template<class Scalar >

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

virtual

Implements Tempus::Stepper< Scalar >.

Definition at line 452 of file Tempus_StepperNewmarkImplicitDForm_impl.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 319 of file Tempus_StepperNewmarkImplicitDForm_impl.hpp.

template<class Scalar >

Teuchos::RCP< Teuchos::ParameterList > Tempus::StepperNewmarkImplicitDForm< Scalar >::getNonconstParameterList ( )

Definition at line 472 of file Tempus_StepperNewmarkImplicitDForm_impl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 81 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 92 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 88 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 102 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

template<class Scalar >

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

Definition at line 436 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 106 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 142 of file Tempus_StepperNewmarkImplicitDForm_impl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 95 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 97 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 96 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 100 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

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

Definition at line 28 of file Tempus_StepperNewmarkImplicitDForm_impl.hpp.

template<class Scalar >

virtual void Tempus::StepperNewmarkImplicitDForm< Scalar >::setInitialConditions ( const Teuchos::RCP< SolutionHistory< Scalar > > & )

inlinevirtual

Set the initial conditions and make them consistent.

Reimplemented from Tempus::StepperImplicit< Scalar >.

Definition at line 70 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

template<class Scalar >

void Tempus::StepperNewmarkImplicitDForm< Scalar >::setModel ( const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar >> & appModel )

virtual

Definition at line 126 of file Tempus_StepperNewmarkImplicitDForm_impl.hpp.

template<class Scalar >

virtual void Tempus::StepperNewmarkImplicitDForm< Scalar >::setObserver ( Teuchos::RCP< StepperObserver< Scalar > > obs = Teuchos::null )

inlinevirtual

Set Observer.

Implements Tempus::Stepper< Scalar >.

Definition at line 62 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

template<class Scalar >

void Tempus::StepperNewmarkImplicitDForm< Scalar >::setParameterList ( const Teuchos::RCP< Teuchos::ParameterList > & pl )

Definition at line 352 of file Tempus_StepperNewmarkImplicitDForm_impl.hpp.

template<class Scalar >

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

virtual

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

Definition at line 158 of file Tempus_StepperNewmarkImplicitDForm_impl.hpp.

template<class Scalar >

Teuchos::RCP< Teuchos::ParameterList > Tempus::StepperNewmarkImplicitDForm< Scalar >::unsetParameterList ( )

Definition at line 481 of file Tempus_StepperNewmarkImplicitDForm_impl.hpp.

Member Data Documentation

template<class Scalar >

Scalar Tempus::StepperNewmarkImplicitDForm< Scalar >::beta_

protected

Definition at line 167 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

template<class Scalar >

virtual void Tempus::StepperNewmarkImplicitDForm< Scalar >::const

Definition at line 133 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

template<class Scalar >

Scalar Tempus::StepperNewmarkImplicitDForm< Scalar >::gamma_

protected

Definition at line 168 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

template<class Scalar >

Thyra::ModelEvaluatorBase::InArgs<Scalar> Tempus::StepperNewmarkImplicitDForm< Scalar >::inArgs_

protected

Definition at line 164 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

template<class Scalar >

Teuchos::RCP<Teuchos::FancyOStream> Tempus::StepperNewmarkImplicitDForm< Scalar >::out_

protected

Definition at line 170 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

template<class Scalar >

Thyra::ModelEvaluatorBase::OutArgs<Scalar> Tempus::StepperNewmarkImplicitDForm< Scalar >::outArgs_

protected

Definition at line 165 of file Tempus_StepperNewmarkImplicitDForm_decl.hpp.

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

http://docs.trilinos.org/r12.16/packages/tempus/src/Tempus_StepperNewmarkImplicitDForm_decl.hpp
http://docs.trilinos.org/r12.16/packages/tempus/src/Tempus_StepperNewmarkImplicitDForm_impl.hpp

Public Member Functions

Protected Attributes

Overridden from Teuchos::Describable

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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