Tempus
Version of the Day
Time Integration
|
Subcycling time stepper. More...
#include <Tempus_StepperSubcycling_decl.hpp>
Public Member Functions | |
StepperSubcycling () | |
Default constructor. More... | |
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. More... | |
Teuchos::RCP< const Teuchos::ParameterList > | getValidParameters () const |
Public Member Functions inherited from Tempus::Stepper< Scalar > | |
virtual bool | isValidSetup (Teuchos::FancyOStream &out) const |
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 bool | isInitialized () |
True if stepper's member data is initialized. More... | |
virtual void | checkInitialized () |
Check initialization, and error out on failure. More... | |
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... | |
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. 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 | |
Teuchos::RCP < StepperSubcyclingAppAction < Scalar > > | stepperSCAppAction_ |
Teuchos::RCP< IntegratorBasic < Scalar > > | scIntegrator_ |
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 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. More... | |
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. More... | |
virtual void | setInitialGuess (Teuchos::RCP< const Thyra::VectorBase< Scalar > > initial_guess) |
Pass initial guess to Newton solver (only relevant for implicit solvers) More... | |
virtual void | setSolver (Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > solver=Teuchos::null) |
Set solver. More... | |
virtual Teuchos::RCP < Thyra::NonlinearSolverBase < Scalar > > | getSolver () const |
Get solver. More... | |
virtual void | takeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) |
Take the specified timestep, dt, and return true if successful. More... | |
virtual Teuchos::RCP < Tempus::StepperState< Scalar > > | getDefaultStepperState () |
Get a default (initial) StepperState. More... | |
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 |
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) |
Functions to get the subcycling stepper values. | |
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 |
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 |
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 52 of file Tempus_StepperSubcycling_decl.hpp.
Tempus::StepperSubcycling< Scalar >::StepperSubcycling | ( | ) |
Default constructor.
Definition at line 24 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 78 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 260 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 268 of file Tempus_StepperSubcycling_impl.hpp.
|
inlinevirtual |
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 77 of file Tempus_StepperSubcycling_decl.hpp.
|
virtual |
Definition at line 276 of file Tempus_StepperSubcycling_impl.hpp.
|
inlinevirtual |
Definition at line 85 of file Tempus_StepperSubcycling_decl.hpp.
|
virtual |
Initialize during construction and after changing input parameters.
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 291 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 373 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 388 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 380 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Set solver.
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 396 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Get solver.
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 405 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Take the specified timestep, dt, and return true if successful.
Implements Tempus::Stepper< Scalar >.
Definition at line 411 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 508 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 319 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 331 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 337 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 343 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 349 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 361 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 367 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 532 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 516 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 100 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 108 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 115 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 122 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 129 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 136 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 145 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 152 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 160 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 168 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 176 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 185 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 191 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 197 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 203 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 209 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 215 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 221 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 227 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 233 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 241 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 248 of file Tempus_StepperSubcycling_impl.hpp.
|
virtual |
Definition at line 254 of file Tempus_StepperSubcycling_impl.hpp.
|
protected |
Definition at line 173 of file Tempus_StepperSubcycling_decl.hpp.
|
protected |
Definition at line 174 of file Tempus_StepperSubcycling_decl.hpp.