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

void	createSubSteppers (std::vector< Teuchos::RCP< const Thyra::ModelEvaluator< Scalar >>> appModels, Teuchos::RCP< Teuchos::ParameterList > pl)

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)

Public Member Functions inherited from Tempus::Stepper< Scalar >
void	setStepperValues (const Teuchos::RCP< Teuchos::ParameterList > pl)
	Set Stepper member data from ParameterList. More...

Teuchos::RCP < Teuchos::ParameterList >	getValidParametersBasic () const
	Add basic parameters to Steppers ParameterList. More...

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

virtual void	setSolver (Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > solver)
	Set solver. More...

virtual bool	isInitialized ()
	True if stepper's member data is initialized. More...

virtual void	checkInitialized ()
	Check initialization, and error out on failure. More...

virtual void	setInitialConditions (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)=0
	Set initial conditions, make them consistent, and set stepper memory. More...

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

virtual void	setInitialGuess (Teuchos::RCP< const Thyra::VectorBase< Scalar > > initialGuess=Teuchos::null)=0
	Pass initial guess to Newton solver (for implicit schemes) More...

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

void	setStepperName (std::string s)
	Set the stepper name. More...

std::string	getStepperName () const
	Get the stepper name. More...

std::string	getStepperType () const
	Get the stepper type. The stepper type is used as an identifier for the stepper, and can only be set by the derived Stepper class. More...

void	setUseFSALTrueOnly (bool a)

void	setUseFSALFalseOnly (bool a)

bool	getUseFSAL () const

void	setICConsistency (std::string s)

std::string	getICConsistency () const

void	setICConsistencyCheck (bool c)

bool	getICConsistencyCheck () const

virtual Teuchos::RCP < Thyra::VectorBase< Scalar > >	getStepperX ()
	Get Stepper x. More...

virtual Teuchos::RCP < Thyra::VectorBase< Scalar > >	getStepperXDot ()
	Get Stepper xDot. More...

virtual Teuchos::RCP < Thyra::VectorBase< Scalar > >	getStepperXDotDot ()
	Get Stepper xDotDot. 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

Public Member Functions inherited from Teuchos::Describable
void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

virtual	~Describable ()

	LabeledObject ()

virtual	~LabeledObject ()

virtual void	setObjectLabel (const std::string &objectLabel)

virtual std::string	getObjectLabel () const

DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)

std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)

Public Member Functions inherited from Teuchos::VerboseObject< Stepper< Scalar > >
	VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)

virtual const VerboseObject &	setVerbLevel (const EVerbosityLevel verbLevel) const

virtual const VerboseObject &	setOverridingVerbLevel (const EVerbosityLevel verbLevel) const

virtual EVerbosityLevel	getVerbLevel () const

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< const ParameterList >	getValidVerboseObjectSublist ()

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void	setupVerboseObjectSublist (ParameterList *paramList)

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void	readVerboseObjectSublist (ParameterList paramList, RCP< FancyOStream > oStream, EVerbosityLevel *verbLevel)

void	readVerboseObjectSublist (ParameterList paramList, VerboseObject< ObjectType > verboseObject)

Public Member Functions inherited from Teuchos::VerboseObjectBase
virtual	~VerboseObjectBase ()

	VerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)

virtual const VerboseObjectBase &	setOStream (const RCP< FancyOStream > &oStream) const

virtual const VerboseObjectBase &	setOverridingOStream (const RCP< FancyOStream > &oStream) const

virtual VerboseObjectBase &	setLinePrefix (const std::string &linePrefix)

virtual RCP< FancyOStream >	getOStream () const

virtual RCP< FancyOStream >	getOverridingOStream () const

virtual std::string	getLinePrefix () const

virtual OSTab	getOSTab (const int tabs=1, const std::string &linePrefix="") const

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 < StepperOperatorSplitAppAction < Scalar > >	stepperOSAppAction_

Protected Attributes inherited from Tempus::Stepper< Scalar >
bool	useFSAL_ = false
	Use First-Same-As-Last (FSAL) principle. More...

bool	isInitialized_
	True if stepper's member data is initialized. More...

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

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

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

virtual Teuchos::RCP < Thyra::NonlinearSolverBase < Scalar > >	getSolver () const
	Get solver. 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 void	setUseFSAL (bool a)

virtual OrderODE	getOrderODE () const

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

Additional Inherited Members
Static Public Member Functions inherited from Teuchos::VerboseObject< Stepper< Scalar > >
static void	setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel)

static EVerbosityLevel	getDefaultVerbLevel ()

Static Public Member Functions inherited from Teuchos::VerboseObjectBase
static void	setDefaultOStream (const RCP< FancyOStream > &defaultOStream)

static RCP< FancyOStream >	getDefaultOStream ()

Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default

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

void	setStepperType (std::string s)
	Set the stepper type. More...

Protected Member Functions inherited from Teuchos::VerboseObject< Stepper< Scalar > >
void	initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)

Protected Member Functions inherited from Teuchos::VerboseObjectBase
void	initializeVerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)

virtual void	informUpdatedVerbosityState () const

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.

Algorithm The algorithm for operator-split stepper is

$\begin{center} \parbox{5in}{ \rule{5in}{0.4pt} \\ {\bf Algorithm} Operator Split \\ \rule{5in}{0.4pt} \vspace{-15pt} \begin{enumerate} \setlength{\itemsep}{0pt} \setlength{\parskip}{0pt} \setlength{\parsep}{0pt} \item {\it appAction.execute(solutionHistory, stepper, BEGIN\_STEP)} \item $x^\ast = x^n$ \hfill {\it * Initialize operator-split solution.} \item {\bf for (each subStepper)} \item \quad {\it appAction.execute(solutionHistory, stepper, BEFORE\_STEPPER)} \item \quad {\bf subStepper take time step.} \hfill {\it * Evolve solution, $x^\ast \rightarrow x^{\ast\ast}$.} \item \quad {\it appAction.execute(solutionHistory, stepper, AFTER\_STEPPER)} \item \quad {\bf if (subStep failed) then break.} \item \quad {\bf Promote solution, $ x^\ast \leftarrow x^{\ast\ast}$} \item {\bf end for} \item {\it appAction.execute(solutionHistory, stepper, END\_STEP)} \end{enumerate} \vspace{-10pt} \rule{5in}{0.4pt} } \end{center}$

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

Member Function Documentation

template<class Scalar >

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

virtual

Definition at line 69 of file Tempus_StepperOperatorSplit_impl.hpp.

template<class Scalar >

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

virtual

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 83 of file Tempus_StepperOperatorSplit_impl.hpp.

template<class Scalar >

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

virtual

Definition at line 103 of file Tempus_StepperOperatorSplit_impl.hpp.

template<class Scalar >

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

inlinevirtual

Get solver.

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 91 of file Tempus_StepperOperatorSplit_decl.hpp.

template<class Scalar >

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

virtual

Definition at line 116 of file Tempus_StepperOperatorSplit_impl.hpp.

template<class Scalar >

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

inlinevirtual

Definition at line 99 of file Tempus_StepperOperatorSplit_decl.hpp.

template<class Scalar >

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

inlinevirtual

Definition at line 105 of file Tempus_StepperOperatorSplit_decl.hpp.

template<class Scalar >

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

virtual

Initialize during construction and after changing input parameters.

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 203 of file Tempus_StepperOperatorSplit_impl.hpp.

template<class Scalar >

void Tempus::StepperOperatorSplit< Scalar >::setInitialConditions ( const Teuchos::RCP< SolutionHistory< Scalar >> & solutionHistory )

virtual

Set the initial conditions and make them consistent.

Definition at line 239 of file Tempus_StepperOperatorSplit_impl.hpp.

template<class Scalar >

void Tempus::StepperOperatorSplit< Scalar >::takeStep ( const Teuchos::RCP< SolutionHistory< Scalar >> & solutionHistory )

virtual

Take the specified timestep, dt, and return true if successful.

Definition at line 257 of file Tempus_StepperOperatorSplit_impl.hpp.

template<class Scalar >

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

inlinevirtual

Pass initial guess to Newton solver.

Definition at line 122 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.

Implements Tempus::Stepper< Scalar >.

Definition at line 346 of file Tempus_StepperOperatorSplit_impl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 129 of file Tempus_StepperOperatorSplit_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 130 of file Tempus_StepperOperatorSplit_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 131 of file Tempus_StepperOperatorSplit_decl.hpp.

template<class Scalar >

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

inlinevirtual

Definition at line 133 of file Tempus_StepperOperatorSplit_decl.hpp.

template<class Scalar >

virtual void Tempus::StepperOperatorSplit< Scalar >::setOrder ( Scalar o )

inlinevirtual

Definition at line 138 of file Tempus_StepperOperatorSplit_decl.hpp.

template<class Scalar >

virtual void Tempus::StepperOperatorSplit< Scalar >::setOrderMin ( Scalar o )

inlinevirtual

Definition at line 139 of file Tempus_StepperOperatorSplit_decl.hpp.

template<class Scalar >

virtual void Tempus::StepperOperatorSplit< Scalar >::setOrderMax ( Scalar o )

inlinevirtual

Definition at line 140 of file Tempus_StepperOperatorSplit_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 142 of file Tempus_StepperOperatorSplit_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 152 of file Tempus_StepperOperatorSplit_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 162 of file Tempus_StepperOperatorSplit_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 166 of file Tempus_StepperOperatorSplit_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 176 of file Tempus_StepperOperatorSplit_decl.hpp.

template<class Scalar >

virtual void Tempus::StepperOperatorSplit< Scalar >::setUseFSAL ( bool a )

inlinevirtual

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 177 of file Tempus_StepperOperatorSplit_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 182 of file Tempus_StepperOperatorSplit_decl.hpp.

template<class Scalar >

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

virtual

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 416 of file Tempus_StepperOperatorSplit_impl.hpp.

template<class Scalar >

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

Definition at line 446 of file Tempus_StepperOperatorSplit_impl.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 354 of file Tempus_StepperOperatorSplit_impl.hpp.

template<class Scalar >

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

virtual

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 382 of file Tempus_StepperOperatorSplit_impl.hpp.

template<class Scalar >

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

inlinevirtual

Definition at line 199 of file Tempus_StepperOperatorSplit_decl.hpp.

template<class Scalar >

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

inlinevirtual

Definition at line 203 of file Tempus_StepperOperatorSplit_decl.hpp.

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 135 of file Tempus_StepperOperatorSplit_impl.hpp.

template<class Scalar >

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