HHT-Alpha time stepper. More...

#include <Tempus_StepperHHTAlpha_decl.hpp>

Inheritance diagram for Tempus::StepperHHTAlpha< Scalar >:

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

	StepperHHTAlpha (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, Scalar alpha_f_, Scalar alpha_m_)
	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

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

void	setSchemeName (std::string schemeName)

void	setBeta (Scalar beta)

void	setGamma (Scalar gamma)

void	setAlphaF (Scalar alpha_f)

void	setAlphaM (Scalar alpha_m)

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

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

virtual void	setDefaultSolver ()

virtual void	setSolver (Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > solver)
	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 > > initialGuess)
	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

Public Member Functions inherited from Tempus::Stepper< Scalar >
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	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 Teuchos::RCP < Thyra::VectorBase< Scalar > >	getStepperX (Teuchos::RCP< SolutionState< Scalar > > state)
	Get x from SolutionState or 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...

virtual std::string	description () const

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

Private Attributes
std::string	schemeName_

Scalar	beta_

Scalar	gamma_

Scalar	alpha_f_

Scalar	alpha_m_

Teuchos::RCP < Teuchos::FancyOStream >	out_

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

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

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

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

bool	zeroInitialGuess_

Teuchos::RCP< StepperObserver < Scalar > >	stepperObserver_

Protected Attributes inherited from Tempus::Stepper< Scalar >
bool	isInitialized_ = false
	True if stepper's member data is initialized. More...

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

The First-Step-As-Last (FSAL) principle is not used with the HHT-Alpha method.

Definition at line 44 of file Tempus_StepperHHTAlpha_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar >

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

Default constructor.

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

Definition at line 243 of file Tempus_StepperHHTAlpha_impl.hpp.

template<class Scalar >

Tempus::StepperHHTAlpha< Scalar >::StepperHHTAlpha	(	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,
		Scalar	alpha_f_,
		Scalar	alpha_m_
	)

Constructor.

Definition at line 265 of file Tempus_StepperHHTAlpha_impl.hpp.

Member Function Documentation

template<class Scalar >

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

Definition at line 86 of file Tempus_StepperHHTAlpha_impl.hpp.

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 115 of file Tempus_StepperHHTAlpha_impl.hpp.

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 101 of file Tempus_StepperHHTAlpha_impl.hpp.

template<class Scalar >

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

virtual

Reimplemented from Tempus::StepperImplicit< Scalar >.

Definition at line 464 of file Tempus_StepperHHTAlpha_impl.hpp.

template<class Scalar >

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

inlinevirtual

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

Implements Tempus::StepperImplicit< Scalar >.

Definition at line 112 of file Tempus_StepperHHTAlpha_decl.hpp.

template<class Scalar >

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

inlinevirtual

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

Implements Tempus::StepperImplicit< Scalar >.

Definition at line 114 of file Tempus_StepperHHTAlpha_decl.hpp.

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 452 of file Tempus_StepperHHTAlpha_impl.hpp.

template<class Scalar >

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

inlinevirtual

Get Observer.

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 78 of file Tempus_StepperHHTAlpha_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 91 of file Tempus_StepperHHTAlpha_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 96 of file Tempus_StepperHHTAlpha_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 95 of file Tempus_StepperHHTAlpha_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 105 of file Tempus_StepperHHTAlpha_decl.hpp.

template<class Scalar >

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

virtual

Implements Tempus::Stepper< Scalar >.

Definition at line 515 of file Tempus_StepperHHTAlpha_impl.hpp.

template<class Scalar >

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

inlinevirtual

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

Definition at line 109 of file Tempus_StepperHHTAlpha_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 98 of file Tempus_StepperHHTAlpha_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 100 of file Tempus_StepperHHTAlpha_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 99 of file Tempus_StepperHHTAlpha_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 103 of file Tempus_StepperHHTAlpha_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 102 of file Tempus_StepperHHTAlpha_decl.hpp.

template<class Scalar >

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

virtual

Reimplemented from Tempus::StepperImplicit< Scalar >.

Definition at line 487 of file Tempus_StepperHHTAlpha_impl.hpp.

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 42 of file Tempus_StepperHHTAlpha_impl.hpp.

template<class Scalar >

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

Definition at line 74 of file Tempus_StepperHHTAlpha_impl.hpp.

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 28 of file Tempus_StepperHHTAlpha_impl.hpp.

template<class Scalar >

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

Definition at line 61 of file Tempus_StepperHHTAlpha_impl.hpp.

template<class Scalar >

void Tempus::StepperHHTAlpha< Scalar >::setAlphaF ( Scalar alpha_f )

Definition at line 183 of file Tempus_StepperHHTAlpha_impl.hpp.

template<class Scalar >

void Tempus::StepperHHTAlpha< Scalar >::setAlphaM ( Scalar alpha_m )

Definition at line 197 of file Tempus_StepperHHTAlpha_impl.hpp.

template<class Scalar >

void Tempus::StepperHHTAlpha< Scalar >::setBeta ( Scalar beta )

Definition at line 130 of file Tempus_StepperHHTAlpha_impl.hpp.

template<class Scalar >

void Tempus::StepperHHTAlpha< Scalar >::setGamma ( Scalar gamma )

Definition at line 162 of file Tempus_StepperHHTAlpha_impl.hpp.

template<class Scalar >

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

inlinevirtual

Set the initial conditions and make them consistent.

Reimplemented from Tempus::StepperImplicit< Scalar >.

Definition at line 82 of file Tempus_StepperHHTAlpha_decl.hpp.

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 304 of file Tempus_StepperHHTAlpha_impl.hpp.

template<class Scalar >

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

inlinevirtual

Set Observer.

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 75 of file Tempus_StepperHHTAlpha_decl.hpp.

template<class Scalar >

void Tempus::StepperHHTAlpha< Scalar >::setSchemeName ( std::string schemeName )

Definition at line 211 of file Tempus_StepperHHTAlpha_impl.hpp.

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 326 of file Tempus_StepperHHTAlpha_impl.hpp.

Member Data Documentation

template<class Scalar >

Scalar Tempus::StepperHHTAlpha< Scalar >::alpha_f_

private

Definition at line 167 of file Tempus_StepperHHTAlpha_decl.hpp.

template<class Scalar >

Scalar Tempus::StepperHHTAlpha< Scalar >::alpha_m_

private

Definition at line 168 of file Tempus_StepperHHTAlpha_decl.hpp.

template<class Scalar >

Scalar Tempus::StepperHHTAlpha< Scalar >::beta_

private

Definition at line 165 of file Tempus_StepperHHTAlpha_decl.hpp.

template<class Scalar >

Scalar Tempus::StepperHHTAlpha< Scalar >::gamma_

private

Definition at line 166 of file Tempus_StepperHHTAlpha_decl.hpp.

template<class Scalar >

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

private

Definition at line 170 of file Tempus_StepperHHTAlpha_decl.hpp.

template<class Scalar >

std::string Tempus::StepperHHTAlpha< Scalar >::schemeName_

private

Definition at line 164 of file Tempus_StepperHHTAlpha_decl.hpp.

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

http://docs.trilinos.org/r13.0/packages/tempus/src/Tempus_StepperHHTAlpha_decl.hpp
http://docs.trilinos.org/r13.0/packages/tempus/src/Tempus_StepperHHTAlpha_impl.hpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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