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

#include <Tempus_StepperOperatorSplit_decl.hpp>

Inheritance diagram for Tempus::StepperOperatorSplit< Scalar >:

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

	StepperOperatorSplit (std::vector< Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > > appModels, std::vector< Teuchos::RCP< Stepper< Scalar > > > subStepperList, const Teuchos::RCP< StepperObserver< Scalar > > &obs, bool useFSAL, std::string ICConsistency, bool ICConsistencyCheck, int order, int orderMin, int orderMax)
	Constructor. More...

	StepperOperatorSplit (std::vector< Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > > appModels, std::vector< Teuchos::RCP< Stepper< Scalar > > > subStepperList, bool useFSAL, std::string ICConsistency, bool ICConsistencyCheck, int order, int orderMin, int orderMax, const Teuchos::RCP< StepperOperatorSplitAppAction< Scalar > > &stepperOSAppAction)
	Constructor. More...

Teuchos::RCP< const Teuchos::ParameterList >	getValidParameters () const

virtual bool	isValidSetup (Teuchos::FancyOStream &out) 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, bool useFSAL=false)
	Add Stepper to subStepper list. In most cases, subSteppers cannot use xDotOld (thus the default), but in some cases, the xDotOld can be used and save compute cycles. The user can set this when adding to the subStepper list. More...

virtual void	setSubStepperList (std::vector< Teuchos::RCP< Stepper< Scalar > > > subStepperList)

virtual void	clearSubStepperList ()

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

Basic stepper methods
virtual void	setModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel)

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

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 Teuchos::RCP < StepperObserver< Scalar > >	getObserver () const
	Get Observer. More...

virtual void	setAppAction (Teuchos::RCP< StepperOperatorSplitAppAction< Scalar > > appAction)

virtual Teuchos::RCP < StepperOperatorSplitAppAction < Scalar > >	getAppAction () const

virtual void	setTempState (Teuchos::RCP< Tempus::SolutionState< Scalar >> state)

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

virtual void	setInitialConditions (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
	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 void	setInitialGuess (Teuchos::RCP< const Thyra::VectorBase< Scalar > >)
	Pass initial guess to Newton solver. 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 Scalar	getInitTimeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &) const

virtual void	setOrder (Scalar o)

virtual void	setOrderMin (Scalar o)

virtual void	setOrderMax (Scalar o)

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::Stepper< Scalar >
virtual void	setNonConstModel (const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &)

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

Protected Attributes
Scalar	order_

Scalar	orderMin_

Scalar	orderMax_

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

Teuchos::RCP< SolutionHistory < Scalar > >	OpSpSolnHistory_

Teuchos::RCP< SolutionState < Scalar > >	tempState_

Teuchos::RCP < StepperOperatorSplitObserver < Scalar > >	stepperOSObserver_

Teuchos::RCP < StepperOperatorSplitAppAction < Scalar > >	stepperOSAppAction_

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

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

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.

Note that steppers in general can not use FSAL (useFSAL=true) with operator splitting as $\dot{x}_{n-1}$ will usually be modified by other operators.

Definition at line 41 of file Tempus_StepperOperatorSplit_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar >

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

Default constructor.

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

Definition at line 21 of file Tempus_StepperOperatorSplit_impl.hpp.

template<class Scalar >

Tempus::StepperOperatorSplit< Scalar >::StepperOperatorSplit	(	std::vector< Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > >	appModels,
		std::vector< Teuchos::RCP< Stepper< Scalar > > >	subStepperList,
		const Teuchos::RCP< StepperObserver< Scalar > > &	obs,
		bool	useFSAL,
		std::string	ICConsistency,
		bool	ICConsistencyCheck,
		int	order,
		int	orderMin,
		int	orderMax
	)

Constructor.

Definition at line 43 of file Tempus_StepperOperatorSplit_impl.hpp.

template<class Scalar >

Tempus::StepperOperatorSplit< Scalar >::StepperOperatorSplit	(	std::vector< Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > >	appModels,
		std::vector< Teuchos::RCP< Stepper< Scalar > > >	subStepperList,
		bool	useFSAL,
		std::string	ICConsistency,
		bool	ICConsistencyCheck,
		int	order,
		int	orderMin,
		int	orderMax,
		const Teuchos::RCP< StepperOperatorSplitAppAction< Scalar > > &	stepperOSAppAction
	)

Constructor.

Definition at line 79 of file Tempus_StepperOperatorSplit_impl.hpp.

Member Function Documentation

template<class Scalar >

void Tempus::StepperOperatorSplit< Scalar >::addStepper	(	Teuchos::RCP< Stepper< Scalar > >	stepper,
		bool	useFSAL = `false`
	)

virtual

Add Stepper to subStepper list. In most cases, subSteppers cannot use xDotOld (thus the default), but in some cases, the xDotOld can be used and save compute cycles. The user can set this when adding to the subStepper list.

Definition at line 200 of file Tempus_StepperOperatorSplit_impl.hpp.

template<class Scalar >

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

inlinevirtual

Definition at line 199 of file Tempus_StepperOperatorSplit_decl.hpp.

template<class Scalar >

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

virtual

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 410 of file Tempus_StepperOperatorSplit_impl.hpp.

template<class Scalar >

virtual Teuchos::RCP<StepperOperatorSplitAppAction<Scalar> > Tempus::StepperOperatorSplit< Scalar >::getAppAction ( ) const

inlinevirtual

Definition at line 102 of file Tempus_StepperOperatorSplit_decl.hpp.

template<class Scalar >

Teuchos::RCP< Tempus::StepperState< Scalar > > Tempus::StepperOperatorSplit< 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.

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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