HHT-Alpha time stepper. More...

#include <Tempus_StepperHHTAlpha_decl.hpp>

Inheritance diagram for Tempus::StepperHHTAlpha< Scalar >:

Public Member Functions
	StepperHHTAlpha (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 void	setInitialGuess (Teuchos::RCP< const Thyra::VectorBase< Scalar > > initial_guess)
	Pass initial guess to Newton solver (only relevant for implicit solvers) 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

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

Scalar	gamma_

Scalar	alpha_f_

Scalar	alpha_m_

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	predictVelocity_alpha_f (Thyra::VectorBase< Scalar > &vPred, const Thyra::VectorBase< Scalar > &v) const

void	predictDisplacement_alpha_f (Thyra::VectorBase< Scalar > &dPred, const Thyra::VectorBase< Scalar > &d) const

void	correctAcceleration (Thyra::VectorBase< Scalar > &a_n_plus1, const Thyra::VectorBase< Scalar > &a_n) 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

	StepperHHTAlpha ()
	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::StepperHHTAlpha< Scalar >

HHT-Alpha time stepper.

Here, we implement the HHT-Alpha scheme in predictor/corrector form; see equations (10) and (13)-(19) in: G.M. Hulbert, J. Chung, "Explicit time integration algorithms for structural dynamics with optimal numerical dissipation", Comput. Methods Appl. Mech. Engrg. 137 175-188 (1996).

There are four parameters in the scheme: $\alpha_m$ , $\alpha_f$ , $\beta$ and $\gamma$ , all of which must be in the range $[0,1]$ . When $\alpha_m=\alpha_f = 0$ , the scheme reduces to the Newmark Beta scheme (see Tempus::StepperNewmark for details). Like the Newmark Beta scheme, the HHT-Alpha scheme can be either first or second order accurate, and either explicit or implicit.

Although the general form of the scheme has been implemented in Tempus, it has only been verified for the case when $\alpha_m=\alpha_f = 0$ (corresponding to the Newmark Beta) scheme, so other values for these parameters are not allowed at the present time. Also, note that, like the Newmark Beta stepper, the linear solve for the explicit version of this scheme has not been optimized (the mass matrix is not lumped).

Definition at line 41 of file Tempus_StepperHHTAlpha_decl.hpp.

Constructor & Destructor Documentation

◆ StepperHHTAlpha() [1/2]

template<class Scalar >

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

Constructor.

Definition at line 130 of file Tempus_StepperHHTAlpha_impl.hpp.

◆ StepperHHTAlpha() [2/2]

template<class Scalar >

Tempus::StepperHHTAlpha< Scalar >::StepperHHTAlpha ( )

private

Default Constructor – not allowed.

Member Function Documentation

◆ correctAcceleration()

template<class Scalar >

void Tempus::StepperHHTAlpha< Scalar >::correctAcceleration	(	Thyra::VectorBase< Scalar > &	a_n_plus1,
		const Thyra::VectorBase< Scalar > &	a_n
	)		const

Definition at line 87 of file Tempus_StepperHHTAlpha_impl.hpp.

◆ correctDisplacement()

template<class Scalar >

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

Definition at line 116 of file Tempus_StepperHHTAlpha_impl.hpp.

◆ correctVelocity()

template<class Scalar >

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

Definition at line 102 of file Tempus_StepperHHTAlpha_impl.hpp.

◆ describe()

template<class Scalar >

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

virtual

Definition at line 332 of file Tempus_StepperHHTAlpha_impl.hpp.

◆ description()

template<class Scalar >

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

virtual

Definition at line 321 of file Tempus_StepperHHTAlpha_impl.hpp.

◆ getDefaultParameters()

template<class Scalar >

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

virtual

Implements Tempus::Stepper< Scalar >.

Definition at line 472 of file Tempus_StepperHHTAlpha_impl.hpp.

◆ getDefaultStepperState()

template<class Scalar >

Teuchos::RCP< Tempus::StepperState< Scalar > > Tempus::StepperHHTAlpha< 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 309 of file Tempus_StepperHHTAlpha_impl.hpp.

◆ getNonconstParameterList()

template<class Scalar >

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

Definition at line 495 of file Tempus_StepperHHTAlpha_impl.hpp.

◆ getOrder()

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 71 of file Tempus_StepperHHTAlpha_decl.hpp.

◆ getOrderMax()

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 76 of file Tempus_StepperHHTAlpha_decl.hpp.

◆ getOrderMin()

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 75 of file Tempus_StepperHHTAlpha_decl.hpp.

◆ getValidParameters()

template<class Scalar >

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

Definition at line 456 of file Tempus_StepperHHTAlpha_impl.hpp.

◆ initialize()

template<class Scalar >

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

virtual

Initialize during construction and after changing input parameters.

Implements Tempus::Stepper< Scalar >.

Definition at line 164 of file Tempus_StepperHHTAlpha_impl.hpp.

◆ isExplicit()

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 78 of file Tempus_StepperHHTAlpha_decl.hpp.

◆ isExplicitImplicit()

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 80 of file Tempus_StepperHHTAlpha_decl.hpp.

◆ isImplicit()

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 79 of file Tempus_StepperHHTAlpha_decl.hpp.

◆ isMultiStepMethod()

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 83 of file Tempus_StepperHHTAlpha_decl.hpp.

◆ isOneStepMethod()

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 82 of file Tempus_StepperHHTAlpha_decl.hpp.

◆ predictDisplacement()

template<class Scalar >

void Tempus::StepperHHTAlpha< 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_StepperHHTAlpha_impl.hpp.

◆ predictDisplacement_alpha_f()

template<class Scalar >

void Tempus::StepperHHTAlpha< Scalar >::predictDisplacement_alpha_f	(	Thyra::VectorBase< Scalar > &	dPred,
		const Thyra::VectorBase< Scalar > &	d
	)		const

Definition at line 75 of file Tempus_StepperHHTAlpha_impl.hpp.

◆ predictVelocity()

template<class Scalar >

void Tempus::StepperHHTAlpha< 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_StepperHHTAlpha_impl.hpp.

◆ predictVelocity_alpha_f()

template<class Scalar >

void Tempus::StepperHHTAlpha< Scalar >::predictVelocity_alpha_f	(	Thyra::VectorBase< Scalar > &	vPred,
		const Thyra::VectorBase< Scalar > &	v
	)		const

Definition at line 62 of file Tempus_StepperHHTAlpha_impl.hpp.

◆ setInitialGuess()

template<class Scalar >

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

inlinevirtual

Pass initial guess to Newton solver (only relevant for implicit solvers)

Reimplemented from Tempus::StepperImplicit< Scalar >.

Definition at line 66 of file Tempus_StepperHHTAlpha_decl.hpp.

◆ setModel()

template<class Scalar >

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

virtual

Reimplemented from Tempus::StepperImplicit< Scalar >.

Definition at line 149 of file Tempus_StepperHHTAlpha_impl.hpp.

◆ setObserver()

template<class Scalar >

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

inlinevirtual

Set Observer.

Implements Tempus::Stepper< Scalar >.

Definition at line 55 of file Tempus_StepperHHTAlpha_decl.hpp.

◆ setParameterList()

template<class Scalar >

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

Definition at line 345 of file Tempus_StepperHHTAlpha_impl.hpp.

◆ takeStep()

template<class Scalar >

void Tempus::StepperHHTAlpha< 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 180 of file Tempus_StepperHHTAlpha_impl.hpp.

◆ unsetParameterList()

template<class Scalar >

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

Definition at line 506 of file Tempus_StepperHHTAlpha_impl.hpp.

Member Data Documentation

◆ alpha_f_

template<class Scalar >

Scalar Tempus::StepperHHTAlpha< Scalar >::alpha_f_

private

Definition at line 141 of file Tempus_StepperHHTAlpha_decl.hpp.

◆ alpha_m_

template<class Scalar >

Scalar Tempus::StepperHHTAlpha< Scalar >::alpha_m_

private

Definition at line 142 of file Tempus_StepperHHTAlpha_decl.hpp.

◆ beta_

template<class Scalar >

Scalar Tempus::StepperHHTAlpha< Scalar >::beta_

private

Definition at line 139 of file Tempus_StepperHHTAlpha_decl.hpp.

◆ gamma_

template<class Scalar >

Scalar Tempus::StepperHHTAlpha< Scalar >::gamma_

private

Definition at line 140 of file Tempus_StepperHHTAlpha_decl.hpp.

◆ initial_guess_

template<class Scalar >

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

private

Definition at line 146 of file Tempus_StepperHHTAlpha_decl.hpp.

◆ out_

template<class Scalar >

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

private

Definition at line 144 of file Tempus_StepperHHTAlpha_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_StepperHHTAlpha_decl.hpp
/home/abuild/rpmbuild/BUILD/Trilinos-trilinos-release-12-14-1/packages/tempus/src/Tempus_StepperHHTAlpha_impl.hpp

Public Member Functions

Overridden from Teuchos::Describable

Additional Inherited Members

Detailed Description

template<class Scalar> class Tempus::StepperHHTAlpha< Scalar >

Constructor & Destructor Documentation

◆ StepperHHTAlpha() [1/2]

◆ StepperHHTAlpha() [2/2]

Member Function Documentation

◆ correctAcceleration()

◆ correctDisplacement()

◆ correctVelocity()

◆ describe()

◆ description()

◆ getDefaultParameters()

◆ getDefaultStepperState()

◆ getNonconstParameterList()

◆ getOrder()

◆ getOrderMax()

◆ getOrderMin()

◆ getValidParameters()

◆ initialize()

◆ isExplicit()

◆ isExplicitImplicit()

◆ isImplicit()

◆ isMultiStepMethod()

◆ isOneStepMethod()

◆ predictDisplacement()

◆ predictDisplacement_alpha_f()

◆ predictVelocity()

◆ predictVelocity_alpha_f()

◆ setInitialGuess()

◆ setModel()

◆ setObserver()

◆ setParameterList()

◆ takeStep()

◆ unsetParameterList()

Member Data Documentation

◆ alpha_f_

◆ alpha_m_

◆ beta_

◆ gamma_

◆ initial_guess_

◆ out_

template<class Scalar>
class Tempus::StepperHHTAlpha< Scalar >