Tempus::StepperNewmarkExplicitAForm< Scalar > Class Template Reference

Newmark Explicit time stepper. This is the specific case of the more general Newmark time stepper in the case this stepper is explicit (beta = 0). Newmark Explicit is hence an explicit time stepper (i.e., no solver used). More...

#include <Tempus_StepperNewmarkExplicitAForm_decl.hpp>

Inheritance diagram for Tempus::StepperNewmarkExplicitAForm< Scalar >:

Public Member Functions
	StepperNewmarkExplicitAForm (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	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 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 std::string	getStepperType () const
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 Scalar	getInitTimeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) 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::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
Teuchos::RCP< Teuchos::ParameterList >	stepperPL_
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > >	appModel_
	Explicit ODE ModelEvaluator. More...
Thyra::ModelEvaluatorBase::InArgs< Scalar >	inArgs_
Thyra::ModelEvaluatorBase::OutArgs< Scalar >	outArgs_
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
	StepperNewmarkExplicitAForm ()
	Default Constructor – not allowed. More...

Detailed Description

template<class Scalar>
class Tempus::StepperNewmarkExplicitAForm< Scalar >

Newmark Explicit time stepper. This is the specific case of the more general Newmark time stepper in the case this stepper is explicit (beta = 0). Newmark Explicit is hence an explicit time stepper (i.e., no solver used).

Definition at line 23 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

Constructor & Destructor Documentation

StepperNewmarkExplicitAForm() [1/2]

template<class Scalar >

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

Constructor.

Definition at line 61 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

StepperNewmarkExplicitAForm() [2/2]

template<class Scalar >

Tempus::StepperNewmarkExplicitAForm< Scalar >::StepperNewmarkExplicitAForm ( )

private

Default Constructor – not allowed.

Default Constructor – not allowed

Member Function Documentation

correctVelocity()

template<class Scalar >

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

Definition at line 50 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

describe()

template<class Scalar >

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

virtual

Definition at line 275 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

description()

template<class Scalar >

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

virtual

Definition at line 267 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

getDefaultParameters()

template<class Scalar >

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

virtual

Implements Tempus::Stepper< Scalar >.

Definition at line 333 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

getDefaultStepperState()

template<class Scalar >

Teuchos::RCP< Tempus::StepperState< Scalar > > Tempus::StepperNewmarkExplicitAForm< 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 258 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

getInitTimeStep()

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 74 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

getModel()

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 39 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

getNonconstParameterList()

template<class Scalar >

Teuchos::RCP< Teuchos::ParameterList > Tempus::StepperNewmarkExplicitAForm< Scalar >::getNonconstParameterList

(

)

Definition at line 343 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

getOrder()

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 68 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

getOrderMax()

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 73 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

getOrderMin()

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 72 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

getSolver()

template<class Scalar >

virtual Teuchos::RCP<Thyra::NonlinearSolverBase<Scalar> > Tempus::StepperNewmarkExplicitAForm< Scalar >::getSolver ( ) const

inlinevirtual

Get solver.

Implements Tempus::Stepper< Scalar >.

Definition at line 46 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

getStepperType()

template<class Scalar >

virtual std::string Tempus::StepperNewmarkExplicitAForm< Scalar >::getStepperType ( ) const

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 63 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

getValidParameters()

template<class Scalar >

Teuchos::RCP< const Teuchos::ParameterList > Tempus::StepperNewmarkExplicitAForm< Scalar >::getValidParameters

(

)

const

Definition at line 317 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

initialize()

template<class Scalar >

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

virtual

Initialize during construction and after changing input parameters.

Implements Tempus::Stepper< Scalar >.

Definition at line 124 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

isExplicit()

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 78 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

isExplicitImplicit()

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 80 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

isImplicit()

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 79 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

isMultiStepMethod()

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 83 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

isOneStepMethod()

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 82 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

predictDisplacement()

template<class Scalar >

void Tempus::StepperNewmarkExplicitAForm< 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 33 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

predictVelocity()

template<class Scalar >

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

Definition at line 22 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

setInitialGuess()

template<class Scalar >

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

inlinevirtual

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

Implements Tempus::Stepper< Scalar >.

Definition at line 60 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

setModel()

template<class Scalar >

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

virtual

Implements Tempus::Stepper< Scalar >.

Definition at line 73 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

setNonConstModel()

template<class Scalar >

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

virtual

Implements Tempus::Stepper< Scalar >.

Definition at line 85 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

setObserver()

template<class Scalar >

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

inlinevirtual

Set Observer.

Implements Tempus::Stepper< Scalar >.

Definition at line 49 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

setParameterList()

template<class Scalar >

void Tempus::StepperNewmarkExplicitAForm< Scalar >::setParameterList

(

const Teuchos::RCP< Teuchos::ParameterList > &

pl

)

Definition at line 285 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

setSolver() [1/3]

template<class Scalar >

void Tempus::StepperNewmarkExplicitAForm< Scalar >::setSolver ( std::string  solverName )

virtual

Set solver via ParameterList solver name.

Implements Tempus::Stepper< Scalar >.

Definition at line 92 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

setSolver() [2/3]

template<class Scalar >

void Tempus::StepperNewmarkExplicitAForm< Scalar >::setSolver ( Teuchos::RCP< Teuchos::ParameterList >  solverPL = Teuchos::null )

virtual

Set solver via solver ParameterList.

Implements Tempus::Stepper< Scalar >.

Definition at line 102 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

setSolver() [3/3]

template<class Scalar >

void Tempus::StepperNewmarkExplicitAForm< Scalar >::setSolver ( Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > >  solver )

virtual

Set solver.

Implements Tempus::Stepper< Scalar >.

Definition at line 113 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

takeStep()

template<class Scalar >

void Tempus::StepperNewmarkExplicitAForm< 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 135 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

unsetParameterList()

template<class Scalar >

Teuchos::RCP< Teuchos::ParameterList > Tempus::StepperNewmarkExplicitAForm< Scalar >::unsetParameterList

(

)

Definition at line 351 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.

Member Data Documentation

appModel_

template<class Scalar >

Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > Tempus::StepperNewmarkExplicitAForm< Scalar >::appModel_

protected

Explicit ODE ModelEvaluator.

Definition at line 132 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

gamma_

template<class Scalar >

Scalar Tempus::StepperNewmarkExplicitAForm< Scalar >::gamma_

protected

Definition at line 137 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

inArgs_

template<class Scalar >

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

protected

Definition at line 134 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

initial_guess_

template<class Scalar >

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

protected

Definition at line 141 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

out_

template<class Scalar >

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

protected

Definition at line 139 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

outArgs_

template<class Scalar >

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

protected

Definition at line 135 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.

stepperPL_

template<class Scalar >

Teuchos::RCP<Teuchos::ParameterList> Tempus::StepperNewmarkExplicitAForm< Scalar >::stepperPL_

protected

Definition at line 130 of file Tempus_StepperNewmarkExplicitAForm_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_StepperNewmarkExplicitAForm_decl.hpp
• /home/abuild/rpmbuild/BUILD/Trilinos-trilinos-release-12-14-1/packages/tempus/src/Tempus_StepperNewmarkExplicitAForm_impl.hpp