Tempus Version of the Day
Time Integration
|
OperatorSplit stepper loops through the Stepper list. More...
#include <Tempus_StepperOperatorSplit_decl.hpp>
Public Member Functions | |
StepperOperatorSplit () | |
Default constructor. | |
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. | |
![]() | |
virtual std::string | description () const |
void | setStepperValues (const Teuchos::RCP< Teuchos::ParameterList > pl) |
Set Stepper member data from ParameterList. | |
Teuchos::RCP< Teuchos::ParameterList > | getValidParametersBasic () const |
Add basic parameters to Steppers ParameterList. | |
virtual bool | isInitialized () |
True if stepper's member data is initialized. | |
virtual void | checkInitialized () |
Check initialization, and error out on failure. | |
void | setStepperName (std::string s) |
Set the stepper name. | |
std::string | getStepperName () const |
Get the stepper name. | |
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. | |
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. | |
virtual Teuchos::RCP< Thyra::VectorBase< Scalar > > | getStepperXDot () |
Get Stepper xDot. | |
virtual Teuchos::RCP< Thyra::VectorBase< Scalar > > | getStepperXDotDot () |
Get Stepper xDotDot. | |
virtual Teuchos::RCP< Thyra::VectorBase< Scalar > > | getStepperXDotDot (Teuchos::RCP< SolutionState< Scalar > > state) |
Get xDotDot from SolutionState or Stepper storage. | |
Overridden from Teuchos::Describable | |
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_ |
virtual void | describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) 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. | |
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 () const |
virtual void | setSolver (Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > solver) |
Set solver. | |
virtual Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > | getSolver () const |
Get solver. | |
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. | |
virtual void | setInitialConditions (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) |
Set the initial conditions and make them consistent. | |
virtual void | takeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) |
Take the specified timestep, dt, and return true if successful. | |
virtual void | setInitialGuess (Teuchos::RCP< const Thyra::VectorBase< Scalar > >) |
Pass initial guess to Newton solver. | |
virtual Teuchos::RCP< Tempus::StepperState< Scalar > > | getDefaultStepperState () |
Get a default (initial) StepperState. | |
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 |
Teuchos::RCP< const Teuchos::ParameterList > | getValidParameters () const |
void | createSubSteppers (std::vector< Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > > appModels, Teuchos::RCP< Teuchos::ParameterList > pl) |
Additional Inherited Members | |
![]() | |
virtual void | setStepperX (Teuchos::RCP< Thyra::VectorBase< Scalar > > x) |
Set x for Stepper storage. | |
virtual void | setStepperXDot (Teuchos::RCP< Thyra::VectorBase< Scalar > > xDot) |
Set xDot for Stepper storage. | |
virtual void | setStepperXDotDot (Teuchos::RCP< Thyra::VectorBase< Scalar > > xDotDot) |
Set x for Stepper storage. | |
void | setStepperType (std::string s) |
Set the stepper type. | |
![]() | |
bool | useFSAL_ = false |
Use First-Same-As-Last (FSAL) principle. | |
bool | isInitialized_ = false |
True if stepper's member data is initialized. | |
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
Note that steppers in general can not use FSAL (useFSAL=true) with operator splitting as
Definition at line 65 of file Tempus_StepperOperatorSplit_decl.hpp.
Tempus::StepperOperatorSplit< Scalar >::StepperOperatorSplit |
Default constructor.
Requires subsequent setModel(), setSolver() and initialize() calls before calling takeStep().
Definition at line 20 of file Tempus_StepperOperatorSplit_impl.hpp.
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 40 of file Tempus_StepperOperatorSplit_impl.hpp.
|
virtual |
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 75 of file Tempus_StepperOperatorSplit_impl.hpp.
|
virtual |
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 88 of file Tempus_StepperOperatorSplit_impl.hpp.
|
virtual |
Set solver.
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 108 of file Tempus_StepperOperatorSplit_impl.hpp.
|
inlinevirtual |
Get solver.
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 98 of file Tempus_StepperOperatorSplit_decl.hpp.
|
virtual |
Definition at line 120 of file Tempus_StepperOperatorSplit_impl.hpp.
|
inlinevirtual |
Definition at line 103 of file Tempus_StepperOperatorSplit_decl.hpp.
|
inlinevirtual |
Definition at line 106 of file Tempus_StepperOperatorSplit_decl.hpp.
|
virtual |
Initialize during construction and after changing input parameters.
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 206 of file Tempus_StepperOperatorSplit_impl.hpp.
|
virtual |
Set the initial conditions and make them consistent.
Implements Tempus::Stepper< Scalar >.
Definition at line 240 of file Tempus_StepperOperatorSplit_impl.hpp.
|
virtual |
Take the specified timestep, dt, and return true if successful.
Implements Tempus::Stepper< Scalar >.
Definition at line 259 of file Tempus_StepperOperatorSplit_impl.hpp.
|
inlinevirtual |
Pass initial guess to Newton solver.
Implements Tempus::Stepper< Scalar >.
Definition at line 121 of file Tempus_StepperOperatorSplit_decl.hpp.
|
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 339 of file Tempus_StepperOperatorSplit_impl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 126 of file Tempus_StepperOperatorSplit_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 127 of file Tempus_StepperOperatorSplit_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 128 of file Tempus_StepperOperatorSplit_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 130 of file Tempus_StepperOperatorSplit_decl.hpp.
|
inlinevirtual |
Definition at line 133 of file Tempus_StepperOperatorSplit_decl.hpp.
|
inlinevirtual |
Definition at line 134 of file Tempus_StepperOperatorSplit_decl.hpp.
|
inlinevirtual |
Definition at line 135 of file Tempus_StepperOperatorSplit_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 137 of file Tempus_StepperOperatorSplit_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 147 of file Tempus_StepperOperatorSplit_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 157 of file Tempus_StepperOperatorSplit_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 159 of file Tempus_StepperOperatorSplit_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 169 of file Tempus_StepperOperatorSplit_decl.hpp.
|
inlinevirtual |
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 170 of file Tempus_StepperOperatorSplit_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 171 of file Tempus_StepperOperatorSplit_decl.hpp.
|
virtual |
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 411 of file Tempus_StepperOperatorSplit_impl.hpp.
void Tempus::StepperOperatorSplit< Scalar >::createSubSteppers | ( | std::vector< Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > > | appModels, |
Teuchos::RCP< Teuchos::ParameterList > | pl | ||
) |
Definition at line 439 of file Tempus_StepperOperatorSplit_impl.hpp.
|
virtual |
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 349 of file Tempus_StepperOperatorSplit_impl.hpp.
|
virtual |
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 377 of file Tempus_StepperOperatorSplit_impl.hpp.
|
inlinevirtual |
Definition at line 188 of file Tempus_StepperOperatorSplit_decl.hpp.
|
inlinevirtual |
Definition at line 190 of file Tempus_StepperOperatorSplit_decl.hpp.
|
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 138 of file Tempus_StepperOperatorSplit_impl.hpp.
|
virtual |
Definition at line 147 of file Tempus_StepperOperatorSplit_impl.hpp.
|
inlinevirtual |
Definition at line 204 of file Tempus_StepperOperatorSplit_decl.hpp.
|
virtual |
Definition at line 177 of file Tempus_StepperOperatorSplit_impl.hpp.
|
protected |
Definition at line 211 of file Tempus_StepperOperatorSplit_decl.hpp.
|
protected |
Definition at line 212 of file Tempus_StepperOperatorSplit_decl.hpp.
|
protected |
Definition at line 213 of file Tempus_StepperOperatorSplit_decl.hpp.
|
protected |
Definition at line 215 of file Tempus_StepperOperatorSplit_decl.hpp.
|
protected |
Definition at line 216 of file Tempus_StepperOperatorSplit_decl.hpp.
|
protected |
Definition at line 217 of file Tempus_StepperOperatorSplit_decl.hpp.
|
protected |
Definition at line 218 of file Tempus_StepperOperatorSplit_decl.hpp.