Tempus
Version of the Day
Time Integration
|
Basic time integrator. More...
#include <Tempus_IntegratorBasic_decl.hpp>
Public Member Functions | |
IntegratorBasic () | |
IntegratorBasic (Teuchos::RCP< Stepper< Scalar > > stepper, Teuchos::RCP< SolutionHistory< Scalar > > solutionHistory, Teuchos::RCP< TimeStepControl< Scalar > > timeStepControl, Teuchos::RCP< IntegratorObserver< Scalar > > integratorObserver, std::vector< int > outputScreenIndices, int outputScreenInterval) | |
Full constructor. More... | |
virtual void | copy (Teuchos::RCP< IntegratorBasic< Scalar > > iB) |
Copy (a shallow copy) More... | |
virtual | ~IntegratorBasic () |
Destructor. More... | |
void | parseScreenOutput () |
Teuchos::RCP< const Teuchos::ParameterList > | getValidParameters () const |
Create valid IntegratorBasic ParameterList. More... | |
void | setIntegratorName (std::string i) |
Set the Integrator Name. More... | |
std::string | getIntegratorName () const |
Get the Integrator Name. More... | |
std::string | getIntegratorType () const |
Get the Integrator Type. More... | |
Public Member Functions inherited from Tempus::Integrator< Scalar > | |
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< Tempus::Integrator< 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 Member Functions | |
void | setIntegratorType (std::string i) |
Set the Integrator Type. More... | |
Protected Member Functions inherited from Teuchos::VerboseObject< Tempus::Integrator< 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 |
Protected Attributes | |
std::string | integratorName_ |
integrator name used for I/O. More... | |
std::string | integratorType_ |
the integrator type. More... | |
Teuchos::RCP< Stepper< Scalar > > | stepper_ |
Teuchos::RCP< SolutionHistory < Scalar > > | solutionHistory_ |
Teuchos::RCP< TimeStepControl < Scalar > > | timeStepControl_ |
Teuchos::RCP < IntegratorObserver< Scalar > > | integratorObserver_ |
std::vector< int > | outputScreenIndices_ |
Vector of screen output indices. More... | |
int | outputScreenInterval_ |
screen output interval. More... | |
Status | integratorStatus_ |
bool | isInitialized_ |
Teuchos::RCP< Teuchos::Time > | integratorTimer_ |
Teuchos::RCP< Teuchos::Time > | stepperTimer_ |
Basic integrator methods | |
virtual bool | advanceTime () |
Advance the solution to timeMax, and return true if successful. More... | |
virtual bool | advanceTime (const Scalar timeFinal) override |
Advance the solution to timeFinal, and return true if successful. More... | |
virtual void | startIntegrator () |
Perform tasks before start of integrator. More... | |
virtual void | startTimeStep () |
Start time step. More... | |
virtual void | checkTimeStep () |
Check if time step has passed or failed. More... | |
virtual void | endIntegrator () |
Perform tasks after end of integrator. More... | |
Accessor methods | |
virtual Scalar | getTime () const override |
Get current time. More... | |
virtual int | getIndex () const override |
Get current index. More... | |
virtual Status | getStatus () const override |
Get Status. More... | |
virtual void | setStatus (const Status st) override |
Set Status. More... | |
virtual Teuchos::RCP< Stepper < Scalar > > | getStepper () const override |
Get the Stepper. More... | |
virtual void | setModel (Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > model) |
Set the model on the stepper. More... | |
virtual void | setStepper (Teuchos::RCP< Stepper< Scalar > > stepper) |
Set the Stepper. More... | |
virtual void | initializeSolutionHistory (Teuchos::RCP< SolutionState< Scalar > > state=Teuchos::null) |
Set the initial state which has the initial conditions. More... | |
virtual void | initializeSolutionHistory (Scalar t0, Teuchos::RCP< const Thyra::VectorBase< Scalar > > x0, Teuchos::RCP< const Thyra::VectorBase< Scalar > > xdot0=Teuchos::null, Teuchos::RCP< const Thyra::VectorBase< Scalar > > xdotdot0=Teuchos::null) |
Set the initial state from Thyra::VectorBase(s) More... | |
virtual Teuchos::RCP< const SolutionHistory< Scalar > > | getSolutionHistory () const override |
Get the SolutionHistory. More... | |
virtual Teuchos::RCP < SolutionHistory< Scalar > > | getNonConstSolutionHistory () override |
Get the SolutionHistory. More... | |
virtual void | setSolutionHistory (Teuchos::RCP< SolutionHistory< Scalar > > sh=Teuchos::null) |
Set the SolutionHistory. More... | |
virtual Teuchos::RCP< const TimeStepControl< Scalar > > | getTimeStepControl () const override |
Get the TimeStepControl. More... | |
virtual Teuchos::RCP < TimeStepControl< Scalar > > | getNonConstTimeStepControl () override |
virtual void | setTimeStepControl (Teuchos::RCP< TimeStepControl< Scalar > > tsc=Teuchos::null) |
Set the TimeStepControl. More... | |
virtual Teuchos::RCP < IntegratorObserver< Scalar > > | getObserver () |
Get the Observer. More... | |
virtual void | setObserver (Teuchos::RCP< IntegratorObserver< Scalar > > obs=Teuchos::null) |
Set the Observer. More... | |
virtual void | initialize () |
Initializes the Integrator after set* function calls. More... | |
bool | isInitialized () |
Return true if IntegratorBasic is initialized. More... | |
virtual Teuchos::RCP < Teuchos::Time > | getIntegratorTimer () const override |
Returns the IntegratorTimer_ for this Integrator. More... | |
virtual Teuchos::RCP < Teuchos::Time > | getStepperTimer () const override |
virtual Teuchos::RCP < Thyra::VectorBase< Scalar > > | getX () const |
Get current the solution, x. More... | |
virtual Teuchos::RCP < Thyra::VectorBase< Scalar > > | getXDot () const |
Get current the time derivative of the solution, xdot. More... | |
virtual Teuchos::RCP < Thyra::VectorBase< Scalar > > | getXDotDot () const |
Get current the second time derivative of the solution, xdotdot. More... | |
virtual Teuchos::RCP < SolutionState< Scalar > > | getCurrentState () |
Get current state. More... | |
virtual void | setScreenOutputIndexInterval (int i) |
virtual int | getScreenOutputIndexInterval () const |
virtual void | setScreenOutputIndexList (std::vector< int > indices) |
virtual void | setScreenOutputIndexList (std::string str) |
Parse when screen output should be executed. More... | |
virtual std::vector< int > | getScreenOutputIndexList () const |
virtual std::string | getScreenOutputIndexListString () const |
Overridden from Teuchos::Describable | |
std::string | description () const override |
void | describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const override |
Additional Inherited Members | |
Static Public Member Functions inherited from Teuchos::VerboseObject< Tempus::Integrator< 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 |
Basic time integrator.
Definition at line 28 of file Tempus_IntegratorBasic_decl.hpp.
Tempus::IntegratorBasic< Scalar >::IntegratorBasic | ( | ) |
Default constructor (requires calls to setModel and setSolutionHistory for initial conditions before calling initialize() to be fully constructed).
Definition at line 22 of file Tempus_IntegratorBasic_impl.hpp.
Tempus::IntegratorBasic< Scalar >::IntegratorBasic | ( | Teuchos::RCP< Stepper< Scalar > > | stepper, |
Teuchos::RCP< SolutionHistory< Scalar > > | solutionHistory, | ||
Teuchos::RCP< TimeStepControl< Scalar > > | timeStepControl, | ||
Teuchos::RCP< IntegratorObserver< Scalar > > | integratorObserver, | ||
std::vector< int > | outputScreenIndices, | ||
int | outputScreenInterval | ||
) |
Full constructor.
Definition at line 44 of file Tempus_IntegratorBasic_impl.hpp.
|
inlinevirtual |
Destructor.
Definition at line 46 of file Tempus_IntegratorBasic_decl.hpp.
|
virtual |
Copy (a shallow copy)
Definition at line 69 of file Tempus_IntegratorBasic_impl.hpp.
|
virtual |
Advance the solution to timeMax, and return true if successful.
Definition at line 337 of file Tempus_IntegratorBasic_impl.hpp.
|
overridevirtual |
Advance the solution to timeFinal, and return true if successful.
Implements Tempus::Integrator< Scalar >.
Definition at line 301 of file Tempus_IntegratorBasic_impl.hpp.
|
virtual |
Perform tasks before start of integrator.
Definition at line 310 of file Tempus_IntegratorBasic_impl.hpp.
|
virtual |
Start time step.
Definition at line 383 of file Tempus_IntegratorBasic_impl.hpp.
|
virtual |
Check if time step has passed or failed.
Definition at line 405 of file Tempus_IntegratorBasic_impl.hpp.
|
virtual |
Perform tasks after end of integrator.
Definition at line 487 of file Tempus_IntegratorBasic_impl.hpp.
|
inlineoverridevirtual |
Get current time.
Implements Tempus::Integrator< Scalar >.
Definition at line 67 of file Tempus_IntegratorBasic_decl.hpp.
|
inlineoverridevirtual |
Get current index.
Implements Tempus::Integrator< Scalar >.
Definition at line 72 of file Tempus_IntegratorBasic_decl.hpp.
|
inlineoverridevirtual |
Get Status.
Implements Tempus::Integrator< Scalar >.
Definition at line 77 of file Tempus_IntegratorBasic_decl.hpp.
|
inlineoverridevirtual |
Set Status.
Implements Tempus::Integrator< Scalar >.
Definition at line 79 of file Tempus_IntegratorBasic_decl.hpp.
|
inlineoverridevirtual |
Get the Stepper.
Implements Tempus::Integrator< Scalar >.
Definition at line 81 of file Tempus_IntegratorBasic_decl.hpp.
|
virtual |
Set the model on the stepper.
Definition at line 95 of file Tempus_IntegratorBasic_impl.hpp.
|
virtual |
Set the Stepper.
Definition at line 106 of file Tempus_IntegratorBasic_impl.hpp.
|
virtual |
Set the initial state which has the initial conditions.
This resets the SolutionHistory and sets the first SolutionState as the IC.
Definition at line 116 of file Tempus_IntegratorBasic_impl.hpp.
|
virtual |
Set the initial state from Thyra::VectorBase(s)
Definition at line 159 of file Tempus_IntegratorBasic_impl.hpp.
|
inlineoverridevirtual |
Get the SolutionHistory.
Implements Tempus::Integrator< Scalar >.
Definition at line 99 of file Tempus_IntegratorBasic_decl.hpp.
|
inlineoverridevirtual |
Get the SolutionHistory.
Implements Tempus::Integrator< Scalar >.
Definition at line 105 of file Tempus_IntegratorBasic_decl.hpp.
|
virtual |
Set the SolutionHistory.
Definition at line 200 of file Tempus_IntegratorBasic_impl.hpp.
|
inlineoverridevirtual |
Get the TimeStepControl.
Implements Tempus::Integrator< Scalar >.
Definition at line 114 of file Tempus_IntegratorBasic_decl.hpp.
|
inlineoverridevirtual |
Implements Tempus::Integrator< Scalar >.
Definition at line 119 of file Tempus_IntegratorBasic_decl.hpp.
|
virtual |
Set the TimeStepControl.
Definition at line 214 of file Tempus_IntegratorBasic_impl.hpp.
|
inlinevirtual |
Get the Observer.
Definition at line 128 of file Tempus_IntegratorBasic_decl.hpp.
|
virtual |
Set the Observer.
Definition at line 230 of file Tempus_IntegratorBasic_impl.hpp.
|
virtual |
Initializes the Integrator after set* function calls.
Definition at line 240 of file Tempus_IntegratorBasic_impl.hpp.
|
inline |
Return true if IntegratorBasic is initialized.
Definition at line 138 of file Tempus_IntegratorBasic_decl.hpp.
|
inlineoverridevirtual |
Returns the IntegratorTimer_ for this Integrator.
Implements Tempus::Integrator< Scalar >.
Definition at line 142 of file Tempus_IntegratorBasic_decl.hpp.
|
inlineoverridevirtual |
Implements Tempus::Integrator< Scalar >.
Definition at line 146 of file Tempus_IntegratorBasic_decl.hpp.
|
inlinevirtual |
Get current the solution, x.
Definition at line 152 of file Tempus_IntegratorBasic_decl.hpp.
|
inlinevirtual |
Get current the time derivative of the solution, xdot.
Definition at line 157 of file Tempus_IntegratorBasic_decl.hpp.
|
inlinevirtual |
Get current the second time derivative of the solution, xdotdot.
Definition at line 162 of file Tempus_IntegratorBasic_decl.hpp.
|
inlinevirtual |
Get current state.
Definition at line 168 of file Tempus_IntegratorBasic_decl.hpp.
|
inlinevirtual |
Definition at line 173 of file Tempus_IntegratorBasic_decl.hpp.
|
inlinevirtual |
Definition at line 178 of file Tempus_IntegratorBasic_decl.hpp.
|
inlinevirtual |
Definition at line 183 of file Tempus_IntegratorBasic_decl.hpp.
|
virtual |
Parse when screen output should be executed.
Definition at line 504 of file Tempus_IntegratorBasic_impl.hpp.
|
inlinevirtual |
Definition at line 191 of file Tempus_IntegratorBasic_decl.hpp.
|
virtual |
Definition at line 528 of file Tempus_IntegratorBasic_impl.hpp.
|
inline |
Definition at line 199 of file Tempus_IntegratorBasic_decl.hpp.
Teuchos::RCP< const Teuchos::ParameterList > Tempus::IntegratorBasic< Scalar >::getValidParameters | ( | ) | const |
Create valid IntegratorBasic ParameterList.
Definition at line 542 of file Tempus_IntegratorBasic_impl.hpp.
|
overridevirtual |
Reimplemented from Teuchos::Describable.
Definition at line 261 of file Tempus_IntegratorBasic_impl.hpp.
|
overridevirtual |
Reimplemented from Teuchos::Describable.
Definition at line 268 of file Tempus_IntegratorBasic_impl.hpp.
|
inline |
Set the Integrator Name.
Definition at line 216 of file Tempus_IntegratorBasic_decl.hpp.
|
inline |
Get the Integrator Name.
Definition at line 218 of file Tempus_IntegratorBasic_decl.hpp.
|
inline |
Get the Integrator Type.
Definition at line 221 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
Set the Integrator Type.
Definition at line 85 of file Tempus_IntegratorBasic_impl.hpp.
|
protected |
integrator name used for I/O.
Definition at line 226 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
the integrator type.
Definition at line 227 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
Definition at line 229 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
Definition at line 230 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
Definition at line 231 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
Definition at line 232 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
Vector of screen output indices.
Definition at line 234 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
screen output interval.
Definition at line 235 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
The integratorStatus is primarily in the WORKING Status, and PASSED/FAILED are noted at the end of the run. A FAILED value is used to jump out of the time-integration loop.
Definition at line 241 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
Definition at line 242 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
Definition at line 244 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
Definition at line 245 of file Tempus_IntegratorBasic_decl.hpp.