Tempus Version of the Day
Time Integration
|
Subcycling time stepper. More...
#include <Tempus_StepperSubcycling_decl.hpp>
Public Member Functions | |
StepperSubcycling () | |
Default constructor. | |
StepperSubcycling (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel, const Teuchos::RCP< IntegratorBasic< Scalar > > &integrator, bool useFSAL, std::string ICConsistency, bool ICConsistencyCheck, const Teuchos::RCP< StepperSubcyclingAppAction< Scalar > > &stepperSCAppAction) | |
Constructor. | |
![]() | |
virtual std::string | description () const |
virtual bool | isValidSetup (Teuchos::FancyOStream &out) 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. | |
virtual void | setUseFSAL (bool a) |
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. | |
Functions to get the subcycling stepper values. | |
Teuchos::RCP< StepperSubcyclingAppAction< Scalar > > | stepperSCAppAction_ |
Teuchos::RCP< IntegratorBasic< Scalar > > | scIntegrator_ |
virtual Teuchos::RCP< const Stepper< Scalar > > | getSubcyclingStepper () const |
virtual Scalar | getSubcyclingMinTimeStep () const |
virtual Scalar | getSubcyclingInitTimeStep () const |
virtual Scalar | getSubcyclingMaxTimeStep () const |
virtual std::string | getSubcyclingStepType () const |
virtual int | getSubcyclingMaxFailures () const |
virtual int | getSubcyclingMaxConsecFailures () const |
virtual int | getSubcyclingScreenOutputIndexInterval () const |
virtual std::string | getSubcyclingScreenOutputIndexList () const |
virtual Teuchos::RCP< TimeStepControlStrategy< Scalar > > | getSubcyclingTimeStepControlStrategy () const |
virtual Teuchos::RCP< IntegratorObserver< Scalar > > | getSubcyclingIntegratorObserver () const |
virtual bool | getSubcyclingPrintDtChanges () const |
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 () const |
virtual void | setAppAction (Teuchos::RCP< StepperSubcyclingAppAction< Scalar > > appAction=Teuchos::null) |
virtual Teuchos::RCP< StepperSubcyclingAppAction< Scalar > > | getAppAction () const |
virtual void | initialize () |
Initialize during construction and after changing input parameters. | |
virtual Scalar | getInitTimeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) const |
virtual void | setInitialConditions (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) |
Set the initial conditions, make them consistent, and set needed memory. | |
virtual void | setInitialGuess (Teuchos::RCP< const Thyra::VectorBase< Scalar > > initial_guess) |
Pass initial guess to Newton solver (only relevant for implicit solvers) | |
virtual void | setSolver (Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > solver=Teuchos::null) |
Set solver. | |
virtual Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > | getSolver () const |
Get solver. | |
virtual void | takeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) |
Take the specified timestep, dt, and return true if successful. | |
virtual Teuchos::RCP< Tempus::StepperState< Scalar > > | getDefaultStepperState () |
Get a default (initial) StepperState. | |
virtual bool | isExplicit () const |
virtual bool | isImplicit () const |
virtual bool | isExplicitImplicit () const |
virtual bool | isOneStepMethod () const |
virtual bool | isMultiStepMethod () const |
virtual Scalar | getOrder () const |
virtual Scalar | getOrderMin () const |
virtual Scalar | getOrderMax () const |
virtual OrderODE | getOrderODE () const |
Teuchos::RCP< const Teuchos::ParameterList > | getValidParameters () const |
Overridden from Teuchos::Describable | |
virtual void | describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const |
Functions to set the subcycling stepper values. | |
virtual void | setSubcyclingStepper (Teuchos::RCP< Stepper< Scalar > > stepper) |
virtual void | setSubcyclingMinTimeStep (Scalar MinTimeStep) |
virtual void | setSubcyclingInitTimeStep (Scalar InitTimeStep) |
virtual void | setSubcyclingMaxTimeStep (Scalar MaxTimeStep) |
virtual void | setSubcyclingMaxFailures (int MaxFailures) |
virtual void | setSubcyclingMaxConsecFailures (int MaxConsecFailures) |
virtual void | setSubcyclingScreenOutputIndexInterval (int i) |
virtual void | setSubcyclingScreenOutputIndexList (std::string s) |
virtual void | setSubcyclingTimeStepControlStrategy (Teuchos::RCP< TimeStepControlStrategy< Scalar > > tscs) |
virtual void | setSubcyclingIntegratorObserver (Teuchos::RCP< IntegratorObserver< Scalar > > obs) |
virtual void | setSubcyclingPrintDtChanges (bool printDtChanges) |
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. | |
Subcycling time stepper.
This stepper wraps an IntegratorBasic object to perform the subcycling, thus it has all the capbilities of an IntegratorBasic with the following specializations and defaults:
Algorithm The algorithm for Subcycling stepper is
Definition at line 54 of file Tempus_StepperSubcycling_decl.hpp.
Tempus::StepperSubcycling< Scalar >::StepperSubcycling |
Default constructor.
Definition at line 26 of file Tempus_StepperSubcycling_impl.hpp.
Tempus::StepperSubcycling< Scalar >::StepperSubcycling | ( | const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > & | appModel, |
const Teuchos::RCP< IntegratorBasic< Scalar > > & | integrator, | ||
bool | useFSAL, | ||
std::string | ICConsistency, | ||
bool | ICConsistencyCheck, | ||
const Teuchos::RCP< StepperSubcyclingAppAction< Scalar > > & | stepperSCAppAction | ||
) |
Constructor.
Definition at line 83 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 264 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 273 of file Tempus_StepperSubcycling_impl.hpp.
|
inlinevirtual |
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 83 of file Tempus_StepperSubcycling_decl.hpp.
|
virtual |
Definition at line 282 of file Tempus_StepperSubcycling_impl.hpp.
|
inlinevirtual |
Definition at line 88 of file Tempus_StepperSubcycling_decl.hpp.
|
virtual |
Initialize during construction and after changing input parameters.
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 296 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 370 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Set the initial conditions, make them consistent, and set needed memory.
Implements Tempus::Stepper< Scalar >.
Definition at line 385 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Pass initial guess to Newton solver (only relevant for implicit solvers)
Implements Tempus::Stepper< Scalar >.
Definition at line 376 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Set solver.
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 394 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Get solver.
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 404 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Take the specified timestep, dt, and return true if successful.
Implements Tempus::Stepper< Scalar >.
Definition at line 409 of file Tempus_StepperSubcycling_impl.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 497 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 325 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 330 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 335 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 340 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 345 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 350 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 355 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 360 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 365 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 525 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 507 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 107 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 116 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 124 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 132 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 140 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 148 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 157 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 166 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 175 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 185 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 194 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 204 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 209 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 214 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 219 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 224 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 229 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 234 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 239 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 244 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 250 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 255 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 259 of file Tempus_StepperSubcycling_impl.hpp.
|
protected |
Definition at line 175 of file Tempus_StepperSubcycling_decl.hpp.
|
protected |
Definition at line 176 of file Tempus_StepperSubcycling_decl.hpp.