Newmark time stepper in acceleration form (a-form). More...

#include <Tempus_StepperNewmarkImplicitAForm_decl.hpp>

Inheritance diagram for Tempus::StepperNewmarkImplicitAForm< Scalar >:

Public Member Functions
	StepperNewmarkImplicitAForm (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel, Teuchos::RCP< Teuchos::ParameterList > pList=Teuchos::null)
	Constructor. More...

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

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

virtual void	initialize ()
	Initialize during construction and after changing input parameters. 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 void	setInitialGuess (Teuchos::RCP< const Thyra::VectorBase< Scalar > > initial_guess)
	Pass initial guess to Newton solver More...

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	setNonConstModel (const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &appModel)

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

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. 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 bool	getEmbedded () const

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

Public Member Functions inherited from Tempus::Stepper< Scalar >
virtual void	createSubSteppers (std::vector< Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > > models)

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

Overridden from Teuchos::Describable
Thyra::ModelEvaluatorBase::InArgs< Scalar >	inArgs_

Thyra::ModelEvaluatorBase::OutArgs< Scalar >	outArgs_

Scalar	beta_

Scalar	gamma_

Teuchos::RCP< Teuchos::FancyOStream >	out_

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

virtual std::string	description () const

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

	StepperNewmarkImplicitAForm ()
	Default Constructor – not allowed. More...

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

Detailed Description

template<class Scalar>
class Tempus::StepperNewmarkImplicitAForm< Scalar >

Newmark time stepper in acceleration form (a-form).

Here, we implement the Newmark scheme in 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. Regardless of whether the method is implicit or explicit, a linear solve is required. This linear solve can be optimized, however, for the explicit case by lumping the mass matrix. This optimization can be invoked by running "Newmark Explicit d-Form" Stepper through the Piro::TempusSolver class.

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

Definition at line 41 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.

Constructor & Destructor Documentation

◆ StepperNewmarkImplicitAForm() [1/2]

template<class Scalar >

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

Constructor.

Definition at line 89 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.

◆ StepperNewmarkImplicitAForm() [2/2]

template<class Scalar >

Tempus::StepperNewmarkImplicitAForm< Scalar >::StepperNewmarkImplicitAForm ( )

private

Default Constructor – not allowed.

Member Function Documentation

◆ correctDisplacement()

template<class Scalar >

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

Definition at line 75 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.

◆ correctVelocity()

template<class Scalar >

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

Definition at line 61 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.

◆ describe()

template<class Scalar >

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

virtual

Definition at line 293 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.

◆ description()

template<class Scalar >

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

virtual

Definition at line 282 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.

◆ getDefaultParameters()

template<class Scalar >

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

virtual

Implements Tempus::Stepper< Scalar >.

Definition at line 413 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.

◆ getDefaultStepperState()

template<class Scalar >

Teuchos::RCP< Tempus::StepperState< Scalar > > Tempus::StepperNewmarkImplicitAForm< 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 270 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.

◆ getNonconstParameterList()

template<class Scalar >

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

Definition at line 436 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.

◆ getOrder()

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 69 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.

◆ getOrderMax()

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 74 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.

◆ getOrderMin()

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 73 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.

◆ getValidParameters()

template<class Scalar >

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

Definition at line 397 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.

◆ initialize()

template<class Scalar >

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

virtual

Initialize during construction and after changing input parameters.

Implements Tempus::Stepper< Scalar >.

Definition at line 125 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.

◆ isExplicit()

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 76 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.

◆ isExplicitImplicit()

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 78 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.

◆ isImplicit()

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 77 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.

◆ isMultiStepMethod()

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 81 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.

◆ isOneStepMethod()

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 80 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.

◆ predictDisplacement()

template<class Scalar >

void Tempus::StepperNewmarkImplicitAForm< 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 41 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.

◆ predictVelocity()

template<class Scalar >

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

Definition at line 27 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.

◆ setInitialGuess()

template<class Scalar >

virtual void Tempus::StepperNewmarkImplicitAForm< Scalar >::setInitialGuess ( Teuchos::RCP< const Thyra::VectorBase< Scalar > > initial_guess )

inlinevirtual

Pass initial guess to Newton solver

Reimplemented from Tempus::StepperImplicit< Scalar >.

Definition at line 85 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.

◆ setModel()

template<class Scalar >

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

virtual

Reimplemented from Tempus::StepperImplicit< Scalar >.

Definition at line 108 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.

◆ setObserver()

template<class Scalar >

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

inlinevirtual

Set Observer.

Implements Tempus::Stepper< Scalar >.

Definition at line 56 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.

◆ setParameterList()

template<class Scalar >

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

Definition at line 306 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.

◆ takeStep()

template<class Scalar >

void Tempus::StepperNewmarkImplicitAForm< 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 141 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.

◆ unsetParameterList()

template<class Scalar >

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

Definition at line 447 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.

Member Data Documentation

◆ beta_

template<class Scalar >

Scalar Tempus::StepperNewmarkImplicitAForm< Scalar >::beta_

private

Definition at line 135 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.

◆ gamma_

template<class Scalar >

Scalar Tempus::StepperNewmarkImplicitAForm< Scalar >::gamma_

private

Definition at line 136 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.

◆ inArgs_

template<class Scalar >

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

private

Definition at line 132 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.

◆ initial_guess_

template<class Scalar >

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

private

Definition at line 141 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.

◆ out_

template<class Scalar >

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

private

Definition at line 139 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.

◆ outArgs_

template<class Scalar >

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

private

Definition at line 133 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.

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

/home/abuild/rpmbuild/BUILD/Trilinos-trilinos-release-12-14-1/packages/tempus/src/Tempus_StepperNewmarkImplicitAForm_decl.hpp
/home/abuild/rpmbuild/BUILD/Trilinos-trilinos-release-12-14-1/packages/tempus/src/Tempus_StepperNewmarkImplicitAForm_impl.hpp

Public Member Functions

Overridden from Teuchos::Describable

Additional Inherited Members

Detailed Description

template<class Scalar> class Tempus::StepperNewmarkImplicitAForm< Scalar >

Constructor & Destructor Documentation

◆ StepperNewmarkImplicitAForm() [1/2]

◆ StepperNewmarkImplicitAForm() [2/2]

Member Function Documentation

◆ correctDisplacement()

◆ correctVelocity()

◆ describe()

◆ description()

◆ getDefaultParameters()

◆ getDefaultStepperState()

◆ getNonconstParameterList()

◆ getOrder()

◆ getOrderMax()

◆ getOrderMin()

◆ getValidParameters()

◆ initialize()

◆ isExplicit()

◆ isExplicitImplicit()

◆ isImplicit()

◆ isMultiStepMethod()

◆ isOneStepMethod()

◆ predictDisplacement()

◆ predictVelocity()

◆ setInitialGuess()

◆ setModel()

◆ setObserver()

◆ setParameterList()

◆ takeStep()

◆ unsetParameterList()

Member Data Documentation

◆ beta_

◆ gamma_

◆ inArgs_

◆ initial_guess_

◆ out_

◆ outArgs_

template<class Scalar>
class Tempus::StepperNewmarkImplicitAForm< Scalar >