Tempus Version of the Day
Time Integration
|
Basic time integrator. More...
#include <Tempus_IntegratorBasic_decl.hpp>
Public Member Functions | |
IntegratorBasic () | |
Default constructor (requires calls to setModel and setSolutionHistory for initial conditions before calling initialize() to be fully constructed). | |
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. | |
virtual void | copy (Teuchos::RCP< IntegratorBasic< Scalar > > iB) |
Copy (a shallow copy) | |
virtual | ~IntegratorBasic () |
Destructor. | |
![]() |
Overridden from Teuchos::Describable | |
std::string | integratorName_ |
integrator name used for I/O. | |
std::string | integratorType_ |
the integrator type. | |
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. | |
int | outputScreenInterval_ |
screen output interval. | |
Status | integratorStatus_ |
bool | isInitialized_ |
Teuchos::RCP< Teuchos::Time > | integratorTimer_ |
Teuchos::RCP< Teuchos::Time > | stepperTimer_ |
std::string | description () const override |
void | describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const override |
void | setIntegratorName (std::string i) |
Set the Integrator Name. | |
std::string | getIntegratorName () const |
Get the Integrator Name. | |
std::string | getIntegratorType () const |
Get the Integrator Type. | |
void | setIntegratorType (std::string i) |
Set the Integrator Type. | |
Basic integrator methods | |
virtual bool | advanceTime () |
Advance the solution to timeMax, and return true if successful. | |
virtual bool | advanceTime (const Scalar timeFinal) override |
Advance the solution to timeFinal, and return true if successful. | |
virtual void | startIntegrator () |
Perform tasks before start of integrator. | |
virtual void | startTimeStep () |
Start time step. | |
virtual void | checkTimeStep () |
Check if time step has passed or failed. | |
virtual void | endIntegrator () |
Perform tasks after end of integrator. | |
Accessor methods | |
virtual Scalar | getTime () const override |
Get current time. | |
virtual int | getIndex () const override |
Get current index. | |
virtual Status | getStatus () const override |
Get Status. | |
virtual void | setStatus (const Status st) override |
Set Status. | |
virtual Teuchos::RCP< Stepper< Scalar > > | getStepper () const override |
Get the Stepper. | |
virtual void | setModel (Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > model) |
Set the model on the stepper. | |
virtual void | setStepper (Teuchos::RCP< Stepper< Scalar > > stepper) |
Set the Stepper. | |
virtual void | initializeSolutionHistory (Teuchos::RCP< SolutionState< Scalar > > state=Teuchos::null) |
Set the initial state which has the initial conditions. | |
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) | |
virtual Teuchos::RCP< const SolutionHistory< Scalar > > | getSolutionHistory () const override |
Get the SolutionHistory. | |
virtual Teuchos::RCP< SolutionHistory< Scalar > > | getNonConstSolutionHistory () override |
Get the SolutionHistory. | |
virtual void | setSolutionHistory (Teuchos::RCP< SolutionHistory< Scalar > > sh=Teuchos::null) |
Set the SolutionHistory. | |
virtual Teuchos::RCP< const TimeStepControl< Scalar > > | getTimeStepControl () const override |
Get the TimeStepControl. | |
virtual Teuchos::RCP< TimeStepControl< Scalar > > | getNonConstTimeStepControl () override |
virtual void | setTimeStepControl (Teuchos::RCP< TimeStepControl< Scalar > > tsc=Teuchos::null) |
Set the TimeStepControl. | |
virtual Teuchos::RCP< IntegratorObserver< Scalar > > | getObserver () |
Get the Observer. | |
virtual void | setObserver (Teuchos::RCP< IntegratorObserver< Scalar > > obs=Teuchos::null) |
Set the Observer. | |
virtual void | initialize () |
Initializes the Integrator after set* function calls. | |
bool | isInitialized () |
Return true if IntegratorBasic is initialized. | |
virtual Teuchos::RCP< Teuchos::Time > | getIntegratorTimer () const override |
Returns the IntegratorTimer_ for this Integrator. | |
virtual Teuchos::RCP< Teuchos::Time > | getStepperTimer () const override |
virtual Teuchos::RCP< Thyra::VectorBase< Scalar > > | getX () const |
Get current the solution, x. | |
virtual Teuchos::RCP< Thyra::VectorBase< Scalar > > | getXDot () const |
Get current the time derivative of the solution, xdot. | |
virtual Teuchos::RCP< Thyra::VectorBase< Scalar > > | getXDotDot () const |
Get current the second time derivative of the solution, xdotdot. | |
virtual Teuchos::RCP< SolutionState< Scalar > > | getCurrentState () |
Get current state. | |
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. | |
virtual std::vector< int > | getScreenOutputIndexList () const |
virtual std::string | getScreenOutputIndexListString () const |
void | parseScreenOutput () |
Teuchos::RCP< const Teuchos::ParameterList > | getValidParameters () const |
Create valid IntegratorBasic ParameterList. | |
Basic time integrator.
Definition at line 30 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 45 of file Tempus_IntegratorBasic_impl.hpp.
|
inlinevirtual |
Destructor.
Definition at line 50 of file Tempus_IntegratorBasic_decl.hpp.
|
virtual |
Copy (a shallow copy)
Definition at line 72 of file Tempus_IntegratorBasic_impl.hpp.
|
virtual |
Advance the solution to timeMax, and return true if successful.
Definition at line 345 of file Tempus_IntegratorBasic_impl.hpp.
|
overridevirtual |
Advance the solution to timeFinal, and return true if successful.
Implements Tempus::Integrator< Scalar >.
Definition at line 306 of file Tempus_IntegratorBasic_impl.hpp.
|
virtual |
Perform tasks before start of integrator.
Definition at line 316 of file Tempus_IntegratorBasic_impl.hpp.
|
virtual |
Start time step.
Definition at line 392 of file Tempus_IntegratorBasic_impl.hpp.
|
virtual |
Check if time step has passed or failed.
Definition at line 417 of file Tempus_IntegratorBasic_impl.hpp.
|
virtual |
Perform tasks after end of integrator.
Definition at line 504 of file Tempus_IntegratorBasic_impl.hpp.
|
inlineoverridevirtual |
Get current time.
Implements Tempus::Integrator< Scalar >.
Definition at line 71 of file Tempus_IntegratorBasic_decl.hpp.
|
inlineoverridevirtual |
Get current index.
Implements Tempus::Integrator< Scalar >.
Definition at line 74 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 80 of file Tempus_IntegratorBasic_decl.hpp.
|
inlineoverridevirtual |
Get the Stepper.
Implements Tempus::Integrator< Scalar >.
Definition at line 82 of file Tempus_IntegratorBasic_decl.hpp.
|
virtual |
Set the model on the stepper.
Definition at line 99 of file Tempus_IntegratorBasic_impl.hpp.
|
virtual |
Set the Stepper.
Definition at line 110 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 121 of file Tempus_IntegratorBasic_impl.hpp.
|
virtual |
Set the initial state from Thyra::VectorBase(s)
Definition at line 162 of file Tempus_IntegratorBasic_impl.hpp.
|
inlineoverridevirtual |
Get the SolutionHistory.
Implements Tempus::Integrator< Scalar >.
Definition at line 97 of file Tempus_IntegratorBasic_decl.hpp.
|
inlineoverridevirtual |
Get the SolutionHistory.
Implements Tempus::Integrator< Scalar >.
Definition at line 100 of file Tempus_IntegratorBasic_decl.hpp.
|
virtual |
Set the SolutionHistory.
Definition at line 204 of file Tempus_IntegratorBasic_impl.hpp.
|
inlineoverridevirtual |
Get the TimeStepControl.
Implements Tempus::Integrator< Scalar >.
Definition at line 106 of file Tempus_IntegratorBasic_decl.hpp.
|
inlineoverridevirtual |
Implements Tempus::Integrator< Scalar >.
Definition at line 108 of file Tempus_IntegratorBasic_decl.hpp.
|
virtual |
Set the TimeStepControl.
Definition at line 218 of file Tempus_IntegratorBasic_impl.hpp.
|
inlinevirtual |
Get the Observer.
Definition at line 114 of file Tempus_IntegratorBasic_decl.hpp.
|
virtual |
Set the Observer.
Definition at line 234 of file Tempus_IntegratorBasic_impl.hpp.
|
virtual |
Initializes the Integrator after set* function calls.
Definition at line 245 of file Tempus_IntegratorBasic_impl.hpp.
|
inline |
Return true if IntegratorBasic is initialized.
Definition at line 122 of file Tempus_IntegratorBasic_decl.hpp.
|
inlineoverridevirtual |
Returns the IntegratorTimer_ for this Integrator.
Implements Tempus::Integrator< Scalar >.
Definition at line 126 of file Tempus_IntegratorBasic_decl.hpp.
|
inlineoverridevirtual |
Implements Tempus::Integrator< Scalar >.
Definition at line 128 of file Tempus_IntegratorBasic_decl.hpp.
|
inlinevirtual |
Get current the solution, x.
Definition at line 132 of file Tempus_IntegratorBasic_decl.hpp.
|
inlinevirtual |
Get current the time derivative of the solution, xdot.
Definition at line 135 of file Tempus_IntegratorBasic_decl.hpp.
|
inlinevirtual |
Get current the second time derivative of the solution, xdotdot.
Definition at line 138 of file Tempus_IntegratorBasic_decl.hpp.
|
inlinevirtual |
Get current state.
Definition at line 142 of file Tempus_IntegratorBasic_decl.hpp.
|
inlinevirtual |
Definition at line 145 of file Tempus_IntegratorBasic_decl.hpp.
|
inlinevirtual |
Definition at line 148 of file Tempus_IntegratorBasic_decl.hpp.
|
inlinevirtual |
Definition at line 151 of file Tempus_IntegratorBasic_decl.hpp.
|
virtual |
Parse when screen output should be executed.
Definition at line 520 of file Tempus_IntegratorBasic_impl.hpp.
|
inlinevirtual |
Definition at line 157 of file Tempus_IntegratorBasic_decl.hpp.
|
virtual |
Definition at line 546 of file Tempus_IntegratorBasic_impl.hpp.
|
inline |
Definition at line 163 of file Tempus_IntegratorBasic_decl.hpp.
Teuchos::RCP< const Teuchos::ParameterList > Tempus::IntegratorBasic< Scalar >::getValidParameters | ( | ) | const |
Create valid IntegratorBasic ParameterList.
Definition at line 561 of file Tempus_IntegratorBasic_impl.hpp.
|
override |
Definition at line 266 of file Tempus_IntegratorBasic_impl.hpp.
|
override |
Definition at line 274 of file Tempus_IntegratorBasic_impl.hpp.
|
inline |
Set the Integrator Name.
Definition at line 178 of file Tempus_IntegratorBasic_decl.hpp.
|
inline |
Get the Integrator Name.
Definition at line 180 of file Tempus_IntegratorBasic_decl.hpp.
|
inline |
Get the Integrator Type.
Definition at line 183 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
Set the Integrator Type.
Definition at line 89 of file Tempus_IntegratorBasic_impl.hpp.
|
protected |
integrator name used for I/O.
Definition at line 189 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
the integrator type.
Definition at line 190 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
Definition at line 192 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
Definition at line 193 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
Definition at line 194 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
Definition at line 195 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
Vector of screen output indices.
Definition at line 197 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
screen output interval.
Definition at line 198 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 204 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
Definition at line 205 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
Definition at line 207 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
Definition at line 208 of file Tempus_IntegratorBasic_decl.hpp.