OperatorSplit stepper loops through the Stepper list. More...

#include <Tempus_StepperOperatorSplit_decl.hpp>

Inheritance diagram for Tempus::StepperOperatorSplit< Scalar >:

Public Member Functions
	StepperOperatorSplit (std::vector< Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > > appModels, Teuchos::RCP< Teuchos::ParameterList > pList)
	Constructor. More...

	StepperOperatorSplit ()
	Constructor which is setup except for models and steppers (i.e., addStepper()), and an initialize() before being used. 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	setTempState (Teuchos::RCP< Tempus::SolutionState< Scalar >> state)

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 explicit schemes) 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 void	setOrder (Scalar ord)

virtual void	setOrderMin (Scalar ord)

virtual void	setOrderMax (Scalar ord)

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

std::vector< Teuchos::RCP< Stepper< Scalar > > >	subStepperList_

Teuchos::RCP< SolutionHistory< Scalar > >	OpSpSolnHistory_

Teuchos::RCP< SolutionState< Scalar > >	tempState_

Teuchos::RCP< StepperOperatorSplitObserver< Scalar > >	stepperOSObserver_

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

virtual std::string	description () const

virtual void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const

virtual std::vector< Teuchos::RCP< Stepper< Scalar > > >	getStepperList () const

virtual void	setStepperList (std::vector< Teuchos::RCP< Stepper< Scalar > > > sl)

virtual void	addStepper (Teuchos::RCP< Stepper< Scalar > > stepper)

virtual void	clearStepperList ()

virtual void	createSubSteppers (std::vector< Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > > appModels)
	Take models and ParameterList and create subSteppers. More...

Detailed Description

template<class Scalar>
class Tempus::StepperOperatorSplit< Scalar >

OperatorSplit stepper loops through the Stepper list.

OperatorSplit stepper loops through the provided list of SubSteppers, and passes the SolutionHistory sequentially between them. This is simply a first-order splitting. It should be noted that specially constructed sequence of SubSteppers could obtain higher orders.

The OperatorSplit Stepper does not have any model, but the SubSteppers do. The OperatorSplit Stepper does not have a solver either, but the SubSteppers may or may not have a solver depending if they are implicit or explicit.

Operator Split is only defined for one-step methods, so multi-step methods (e.g., BDF) should not be used with StepperOperatorSplit.

Definition at line 35 of file Tempus_StepperOperatorSplit_decl.hpp.

Constructor & Destructor Documentation

◆ StepperOperatorSplit() [1/2]

template<class Scalar >

Tempus::StepperOperatorSplit< Scalar >::StepperOperatorSplit	(	std::vector< Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > >	appModels,
		Teuchos::RCP< Teuchos::ParameterList >	pList
	)

Constructor.

Definition at line 20 of file Tempus_StepperOperatorSplit_impl.hpp.

◆ StepperOperatorSplit() [2/2]

template<class Scalar >

Tempus::StepperOperatorSplit< Scalar >::StepperOperatorSplit ( )

Constructor which is setup except for models and steppers (i.e., addStepper()), and an initialize() before being used.

Definition at line 32 of file Tempus_StepperOperatorSplit_impl.hpp.

Member Function Documentation

◆ addStepper()

template<class Scalar>

virtual void Tempus::StepperOperatorSplit< Scalar >::addStepper ( Teuchos::RCP< Stepper< Scalar > > stepper )

inlinevirtual

Definition at line 156 of file Tempus_StepperOperatorSplit_decl.hpp.

◆ clearStepperList()

template<class Scalar>

virtual void Tempus::StepperOperatorSplit< Scalar >::clearStepperList ( )

inlinevirtual

Definition at line 158 of file Tempus_StepperOperatorSplit_decl.hpp.

◆ createSubSteppers()

template<class Scalar >

void Tempus::StepperOperatorSplit< Scalar >::createSubSteppers ( std::vector< Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > > appModels )

virtual

Take models and ParameterList and create subSteppers.

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 138 of file Tempus_StepperOperatorSplit_impl.hpp.

◆ describe()

template<class Scalar >

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

virtual

Definition at line 311 of file Tempus_StepperOperatorSplit_impl.hpp.

◆ description()

template<class Scalar >

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

virtual

Definition at line 303 of file Tempus_StepperOperatorSplit_impl.hpp.

◆ getDefaultParameters()

template<class Scalar >

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

virtual

Public Member Functions

Overridden from Teuchos::Describable

Detailed Description

template<class Scalar> class Tempus::StepperOperatorSplit< Scalar >

Constructor & Destructor Documentation

◆ StepperOperatorSplit() [1/2]

◆ StepperOperatorSplit() [2/2]

Member Function Documentation

◆ addStepper()

◆ clearStepperList()

◆ createSubSteppers()

◆ describe()

◆ description()

◆ getDefaultParameters()

◆ getDefaultStepperState()

◆ getInitTimeStep()

◆ getModel()

◆ getNonconstParameterList()

◆ getOrder()

◆ getOrderMax()

◆ getOrderMin()

◆ getSolver()

◆ getStepperList()

◆ getStepperType()

◆ getValidParameters()

◆ initialize()

◆ isExplicit()

◆ isExplicitImplicit()

◆ isImplicit()

◆ isMultiStepMethod()

◆ isOneStepMethod()

◆ setInitialGuess()

◆ setModel()

◆ setNonConstModel()

◆ setObserver()

◆ setOrder()

◆ setOrderMax()

◆ setOrderMin()

◆ setParameterList()

◆ setSolver() [1/3]

◆ setSolver() [2/3]

◆ setSolver() [3/3]

◆ setStepperList()

◆ setTempState()

◆ takeStep()

◆ unsetParameterList()

Member Data Documentation

◆ initial_guess_

◆ OpSpSolnHistory_

◆ stepperOSObserver_

◆ stepperPL_

◆ subStepperList_

◆ tempState_

template<class Scalar>
class Tempus::StepperOperatorSplit< Scalar >