Thyra Base interface for implicit time steppers. More...

#include <Tempus_StepperImplicit_decl.hpp>

Inheritance diagram for Tempus::StepperImplicit< Scalar >:

Basic implicit stepper methods
Teuchos::RCP< Teuchos::ParameterList >	stepperPL_

Teuchos::RCP< WrapperModelEvaluator< Scalar > >	wrapperModel_

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

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

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

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

Additional Inherited Members
Public Member Functions inherited from Tempus::Stepper< Scalar >
virtual void	setObserver (Teuchos::RCP< StepperObserver< Scalar > > obs=Teuchos::null)=0
	Set Observer. More...

virtual void	initialize ()=0
	Initialize during construction and after changing input parameters. More...

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

virtual Teuchos::RCP< Tempus::StepperState< Scalar > >	getDefaultStepperState ()=0

virtual Scalar	getOrder () const =0

virtual Scalar	getOrderMin () const =0

virtual Scalar	getOrderMax () const =0

virtual Teuchos::RCP< Teuchos::ParameterList >	getDefaultParameters () const =0

virtual bool	isExplicit () const =0

virtual bool	isImplicit () const =0

virtual bool	isExplicitImplicit () const =0

virtual bool	isOneStepMethod () const =0

virtual bool	isMultiStepMethod () const =0

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

Detailed Description

template<class Scalar>
class Tempus::StepperImplicit< Scalar >

Thyra Base interface for implicit time steppers.

Definition at line 24 of file Tempus_StepperImplicit_decl.hpp.

Member Function Documentation

◆ getEmbedded()

template<class Scalar >

virtual bool Tempus::StepperImplicit< Scalar >::getEmbedded ( ) const

inlinevirtual

Definition at line 64 of file Tempus_StepperImplicit_decl.hpp.

◆ getInitTimeStep()

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 66 of file Tempus_StepperImplicit_decl.hpp.

◆ getModel()

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Reimplemented in Tempus::StepperIMEX_RK< Scalar >, and Tempus::StepperIMEX_RK_Partition< Scalar >.

Definition at line 35 of file Tempus_StepperImplicit_decl.hpp.

◆ getSolver()

template<class Scalar >

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

inlinevirtual

Get solver.

Implements Tempus::Stepper< Scalar >.

Definition at line 45 of file Tempus_StepperImplicit_decl.hpp.

◆ getStepperType()

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 48 of file Tempus_StepperImplicit_decl.hpp.

◆ getZeroInitialGuess()

template<class Scalar >

virtual bool Tempus::StepperImplicit< Scalar >::getZeroInitialGuess ( ) const

inlinevirtual

Definition at line 62 of file Tempus_StepperImplicit_decl.hpp.

◆ setInitialGuess()

template<class Scalar >

virtual void Tempus::StepperImplicit< 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 >.

Reimplemented in Tempus::StepperIMEX_RK_Partition< Scalar >, Tempus::StepperIMEX_RK< Scalar >, Tempus::StepperDIRK< Scalar >, Tempus::StepperBDF2< Scalar >, Tempus::StepperNewmarkImplicitAForm< Scalar >, Tempus::StepperTrapezoidal< Scalar >, Tempus::StepperHHTAlpha< Scalar >, Tempus::StepperNewmarkImplicitDForm< Scalar >, and Tempus::StepperBackwardEuler< Scalar >.

Definition at line 56 of file Tempus_StepperImplicit_decl.hpp.

◆ setModel()

template<class Scalar >

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

virtual

Implements Tempus::Stepper< Scalar >.

Reimplemented in Tempus::StepperIMEX_RK< Scalar >, Tempus::StepperIMEX_RK_Partition< Scalar >, Tempus::StepperNewmarkImplicitAForm< Scalar >, and Tempus::StepperHHTAlpha< Scalar >.

Definition at line 26 of file Tempus_StepperImplicit_impl.hpp.

◆ setNonConstModel()

template<class Scalar >

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

virtual

Implements Tempus::Stepper< Scalar >.

Definition at line 36 of file Tempus_StepperImplicit_impl.hpp.

◆ setSolver() [1/3]

template<class Scalar >

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

virtual

Set solver via ParameterList solver name.

Set the solver to a pre-defined solver in the ParameterList.

The solver is set to solverName sublist in the Stepper's ParameterList. The solverName sublist should already be defined in the Stepper's ParameterList. Otherwise it will fail.

Implements Tempus::Stepper< Scalar >.

Definition at line 50 of file Tempus_StepperImplicit_impl.hpp.

◆ setSolver() [2/3]

template<class Scalar >

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

virtual

Set solver via solver ParameterList.

Set the solver to the supplied Parameter sublist.

This adds a new solver Parameter sublist to the Stepper's ParameterList. If the solver sublist is null, the solver is set to the solver name in the Stepper's ParameterList.

Implements Tempus::Stepper< Scalar >.

Definition at line 65 of file Tempus_StepperImplicit_impl.hpp.

◆ setSolver() [3/3]

template<class Scalar >

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

virtual

Set solver.

Set the solver.

This sets the solver to supplied solver and adds solver's ParameterList to the Stepper ParameterList.

Implements Tempus::Stepper< Scalar >.

Definition at line 109 of file Tempus_StepperImplicit_impl.hpp.

◆ setZeroInitialGuess()

template<class Scalar >

virtual void Tempus::StepperImplicit< Scalar >::setZeroInitialGuess ( bool zIG )

inlinevirtual

Set parameter so that the initial guess is set to zero (=True) or use last timestep (=False).

Definition at line 60 of file Tempus_StepperImplicit_decl.hpp.

◆ solveImplicitODE()

template<class Scalar >

const Thyra::SolveStatus< Scalar > Tempus::StepperImplicit< Scalar >::solveImplicitODE ( const Teuchos::RCP< Thyra::VectorBase< Scalar > > & x )

Solve problem using x in-place.

Definition at line 120 of file Tempus_StepperImplicit_impl.hpp.

Member Data Documentation

◆ initial_guess_

template<class Scalar >

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

protected

Definition at line 76 of file Tempus_StepperImplicit_decl.hpp.

◆ solver_

template<class Scalar >

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

protected

Definition at line 75 of file Tempus_StepperImplicit_decl.hpp.

◆ stepperPL_

template<class Scalar >

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

protected

Definition at line 73 of file Tempus_StepperImplicit_decl.hpp.

◆ wrapperModel_

template<class Scalar >

Teuchos::RCP<WrapperModelEvaluator<Scalar> > Tempus::StepperImplicit< Scalar >::wrapperModel_

protected

Definition at line 74 of file Tempus_StepperImplicit_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_StepperImplicit_decl.hpp
/home/abuild/rpmbuild/BUILD/Trilinos-trilinos-release-12-14-1/packages/tempus/src/Tempus_StepperImplicit_impl.hpp

Basic implicit stepper methods

Additional Inherited Members

Detailed Description

template<class Scalar> class Tempus::StepperImplicit< Scalar >

Member Function Documentation

◆ getEmbedded()

◆ getInitTimeStep()

◆ getModel()

◆ getSolver()

◆ getStepperType()

◆ getZeroInitialGuess()

◆ setInitialGuess()

◆ setModel()

◆ setNonConstModel()

◆ setSolver() [1/3]

◆ setSolver() [2/3]

◆ setSolver() [3/3]

◆ setZeroInitialGuess()

◆ solveImplicitODE()

Member Data Documentation

◆ initial_guess_

◆ solver_

◆ stepperPL_

◆ wrapperModel_

template<class Scalar>
class Tempus::StepperImplicit< Scalar >