|
Tempus
Version of the Day
Time Integration
|
Basic time integrator. More...
#include <Tempus_IntegratorBasic_decl.hpp>

Public Member Functions | |
| IntegratorBasic () | |
| Default constructor that requires a subsequent, ??? , setStepper, and initialize calls. More... | |
| 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 | ~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 > | |
Protected Member Functions | |
| void | setIntegratorType (std::string i) |
| Set the Integrator Type. More... | |
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... | |
| virtual Teuchos::RCP< Teuchos::ParameterList > | getTempusParameterList () override |
| Return a copy of the Tempus ParameterList DEPRECATED! More... | |
| virtual void | setTempusParameterList (Teuchos::RCP< Teuchos::ParameterList > pl) override |
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... | |
| 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 |
Basic time integrator.
Definition at line 30 of file Tempus_IntegratorBasic_decl.hpp.
| Tempus::IntegratorBasic< Scalar >::IntegratorBasic | ( | ) |
Default constructor that requires a subsequent, ??? , setStepper, and initialize calls.
Definition at line 21 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 41 of file Tempus_IntegratorBasic_impl.hpp.
|
inlinevirtual |
Destructor.
Definition at line 47 of file Tempus_IntegratorBasic_decl.hpp.
|
virtual |
Advance the solution to timeMax, and return true if successful.
Definition at line 323 of file Tempus_IntegratorBasic_impl.hpp.
|
overridevirtual |
Advance the solution to timeFinal, and return true if successful.
Implements Tempus::Integrator< Scalar >.
Definition at line 284 of file Tempus_IntegratorBasic_impl.hpp.
|
virtual |
Perform tasks before start of integrator.
Definition at line 294 of file Tempus_IntegratorBasic_impl.hpp.
|
virtual |
Start time step.
Definition at line 370 of file Tempus_IntegratorBasic_impl.hpp.
|
virtual |
Check if time step has passed or failed.
Definition at line 395 of file Tempus_IntegratorBasic_impl.hpp.
|
virtual |
Perform tasks after end of integrator.
Definition at line 467 of file Tempus_IntegratorBasic_impl.hpp.
|
inlineoverridevirtual |
Return a copy of the Tempus ParameterList DEPRECATED!
Implements Tempus::Integrator< Scalar >.
Definition at line 64 of file Tempus_IntegratorBasic_decl.hpp.
|
inlineoverridevirtual |
Implements Tempus::Integrator< Scalar >.
Definition at line 66 of file Tempus_IntegratorBasic_decl.hpp.
|
inlineoverridevirtual |
Get current time.
Implements Tempus::Integrator< Scalar >.
Definition at line 77 of file Tempus_IntegratorBasic_decl.hpp.
|
inlineoverridevirtual |
Get current index.
Implements Tempus::Integrator< Scalar >.
Definition at line 80 of file Tempus_IntegratorBasic_decl.hpp.
|
inlineoverridevirtual |
Get Status.
Implements Tempus::Integrator< Scalar >.
Definition at line 83 of file Tempus_IntegratorBasic_decl.hpp.
|
inlineoverridevirtual |
Set Status.
Implements Tempus::Integrator< Scalar >.
Definition at line 86 of file Tempus_IntegratorBasic_decl.hpp.
|
inlineoverridevirtual |
Get the Stepper.
Implements Tempus::Integrator< Scalar >.
Definition at line 88 of file Tempus_IntegratorBasic_decl.hpp.
|
virtual |
Set the model on the stepper.
Definition at line 77 of file Tempus_IntegratorBasic_impl.hpp.
|
virtual |
Set the Stepper.
Definition at line 88 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 100 of file Tempus_IntegratorBasic_impl.hpp.
|
virtual |
Set the initial state from Thyra::VectorBase(s)
Definition at line 141 of file Tempus_IntegratorBasic_impl.hpp.
|
inlineoverridevirtual |
Get the SolutionHistory.
Implements Tempus::Integrator< Scalar >.
Definition at line 103 of file Tempus_IntegratorBasic_decl.hpp.
|
inlineoverridevirtual |
Get the SolutionHistory.
Implements Tempus::Integrator< Scalar >.
Definition at line 106 of file Tempus_IntegratorBasic_decl.hpp.
|
virtual |
Set the SolutionHistory.
Definition at line 182 of file Tempus_IntegratorBasic_impl.hpp.
|
inlineoverridevirtual |
Get the TimeStepControl.
Implements Tempus::Integrator< Scalar >.
Definition at line 112 of file Tempus_IntegratorBasic_decl.hpp.
|
inlineoverridevirtual |
Implements Tempus::Integrator< Scalar >.
Definition at line 114 of file Tempus_IntegratorBasic_decl.hpp.
|
virtual |
Set the TimeStepControl.
Definition at line 196 of file Tempus_IntegratorBasic_impl.hpp.
|
inlinevirtual |
Get the Observer.
Definition at line 120 of file Tempus_IntegratorBasic_decl.hpp.
|
virtual |
Set the Observer.
Definition at line 212 of file Tempus_IntegratorBasic_impl.hpp.
|
virtual |
Initializes the Integrator after set* function calls.
Definition at line 223 of file Tempus_IntegratorBasic_impl.hpp.
|
inlineoverridevirtual |
Returns the IntegratorTimer_ for this Integrator.
Implements Tempus::Integrator< Scalar >.
Definition at line 129 of file Tempus_IntegratorBasic_decl.hpp.
|
inlineoverridevirtual |
Implements Tempus::Integrator< Scalar >.
Definition at line 131 of file Tempus_IntegratorBasic_decl.hpp.
|
inlinevirtual |
Get current the solution, x.
Definition at line 135 of file Tempus_IntegratorBasic_decl.hpp.
|
inlinevirtual |
Get current the time derivative of the solution, xdot.
Definition at line 138 of file Tempus_IntegratorBasic_decl.hpp.
|
inlinevirtual |
Get current the second time derivative of the solution, xdotdot.
Definition at line 141 of file Tempus_IntegratorBasic_decl.hpp.
|
inlinevirtual |
Get current state.
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.
|
inlinevirtual |
Definition at line 154 of file Tempus_IntegratorBasic_decl.hpp.
|
virtual |
Parse when screen output should be executed.
Definition at line 483 of file Tempus_IntegratorBasic_impl.hpp.
|
inlinevirtual |
Definition at line 160 of file Tempus_IntegratorBasic_decl.hpp.
|
virtual |
Definition at line 509 of file Tempus_IntegratorBasic_impl.hpp.
|
inline |
Definition at line 166 of file Tempus_IntegratorBasic_decl.hpp.
| Teuchos::RCP< const Teuchos::ParameterList > Tempus::IntegratorBasic< Scalar >::getValidParameters | ( | ) | const |
Create valid IntegratorBasic ParameterList.
Definition at line 524 of file Tempus_IntegratorBasic_impl.hpp.
|
override |
Definition at line 244 of file Tempus_IntegratorBasic_impl.hpp.
|
override |
Definition at line 252 of file Tempus_IntegratorBasic_impl.hpp.
|
inline |
Set the Integrator Name.
Definition at line 181 of file Tempus_IntegratorBasic_decl.hpp.
|
inline |
Get the Integrator Name.
Definition at line 183 of file Tempus_IntegratorBasic_decl.hpp.
|
inline |
Get the Integrator Type.
Definition at line 186 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
Set the Integrator Type.
Definition at line 67 of file Tempus_IntegratorBasic_impl.hpp.
|
protected |
integrator name used for I/O.
Definition at line 192 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
the integrator type.
Definition at line 193 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
Definition at line 195 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
Definition at line 196 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
Definition at line 197 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
Definition at line 198 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
Vector of screen output indices.
Definition at line 200 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
screen output interval.
Definition at line 201 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 207 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
Definition at line 208 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
Definition at line 210 of file Tempus_IntegratorBasic_decl.hpp.
|
protected |
Definition at line 211 of file Tempus_IntegratorBasic_decl.hpp.
1.8.14