Tempus Version of the Day
Time Integration
|
SolutionHistory is basically a container of SolutionStates. SolutionHistory maintains a collection of SolutionStates for later retrival and reuse, such as checkpointing, restart, and undo operations. More...
#include <Tempus_SolutionHistory_decl.hpp>
Public Member Functions | |
SolutionHistory () | |
Default Contructor. | |
SolutionHistory (std::string name, Teuchos::RCP< std::vector< Teuchos::RCP< SolutionState< Scalar > > > > history, Teuchos::RCP< Interpolator< Scalar > > interpolator, StorageType storageType, int storageLimit) | |
Contructor. | |
~SolutionHistory () | |
Destructor. | |
Interpolation Methods | |
std::string | name_ |
Teuchos::RCP< std::vector< Teuchos::RCP< SolutionState< Scalar > > > > | history_ |
Teuchos::RCP< Interpolator< Scalar > > | interpolator_ |
StorageType | storageType_ |
int | storageLimit_ |
Teuchos::RCP< SolutionState< Scalar > > | workingState_ |
The state being worked on. | |
bool | isInitialized_ |
Bool if SolutionHistory is initialized. | |
void | setInterpolator (const Teuchos::RCP< Interpolator< Scalar > > &interpolator) |
Set the interpolator for this history. | |
Teuchos::RCP< Interpolator< Scalar > > | getNonconstInterpolator () |
Teuchos::RCP< const Interpolator< Scalar > > | getInterpolator () const |
Teuchos::RCP< Interpolator< Scalar > > | unSetInterpolator () |
Unset the interpolator for this history. | |
void | printHistory (std::string verb="low") const |
Print information on States in the SolutionHistory. | |
void | initialize () const |
Initialize SolutionHistory. | |
bool | isInitialized () |
Return if SolutionHistory is initialized. | |
Basic SolutionHistory Methods | |
void | addState (const Teuchos::RCP< SolutionState< Scalar > > &state, bool doChecks=true) |
Add solution state to history. | |
void | addWorkingState (const Teuchos::RCP< SolutionState< Scalar > > &state, const bool updateTime=true) |
Add a working solution state to history. | |
void | removeState (const Teuchos::RCP< SolutionState< Scalar > > &state) |
Remove solution state. | |
void | removeState (const Scalar time) |
Remove solution state based on time. | |
Teuchos::RCP< SolutionState< Scalar > > | findState (const Scalar time) const |
Find solution state at requested time (no interpolation) | |
Teuchos::RCP< SolutionState< Scalar > > | interpolateState (const Scalar time) const |
Generate and interpolate a new solution state at requested time. | |
void | interpolateState (const Scalar time, SolutionState< Scalar > *state_out) const |
Interpolate solution state at requested time and store in supplied state. | |
void | initWorkingState () |
Initialize the working state. | |
void | promoteWorkingState () |
Promote the working state to current state. | |
void | clear () |
Clear the history. | |
void | copy (Teuchos::RCP< const SolutionHistory< Scalar > > sh) |
Accessor methods | |
std::string | getName () const |
Get this SolutionHistory's name. | |
void | setName (std::string name) |
Set this SolutionHistory's name. | |
Teuchos::RCP< std::vector< Teuchos::RCP< SolutionState< Scalar > > > > | getHistory () const |
Get underlining history. | |
void | setHistory (Teuchos::RCP< std::vector< Teuchos::RCP< SolutionState< Scalar > > > > h) |
Set underlining history. | |
Teuchos::RCP< SolutionState< Scalar > > | operator[] (const int i) |
Subscript operator. | |
Teuchos::RCP< const SolutionState< Scalar > > | operator[] (const int i) const |
Subscript operator (const version) | |
Teuchos::RCP< SolutionState< Scalar > > | getCurrentState () const |
Return the current state, i.e., the last accepted state. | |
Teuchos::RCP< SolutionState< Scalar > > | getWorkingState (bool warn=true) const |
Return the working state. | |
int | getNumStates () const |
Get the number of states. | |
Scalar | getCurrentTime () const |
Get the current time. | |
int | getCurrentIndex () const |
Get the current timestep index. | |
void | setStorageLimit (int storage_limit) |
Set the maximum storage of this history. | |
int | getStorageLimit () const |
Get the maximum storage of this history. | |
void | setStorageType (StorageType st) |
Set the storage type via enum. | |
StorageType | getStorageType () const |
Get the enum storage type. | |
void | setStorageTypeString (std::string st) |
Set the storage type via string. | |
std::string | getStorageTypeString () const |
Set the string storage type. | |
Scalar | minTime () const |
Return the current minimum time of the SolutionStates. | |
Scalar | maxTime () const |
Return the current maximum time of the SolutionStates. | |
Teuchos::RCP< SolutionState< Scalar > > | getStateTimeIndexN (bool warn=true) const |
Get the state with timestep index equal to n. | |
Teuchos::RCP< SolutionState< Scalar > > | getStateTimeIndexNM1 (bool warn=true) const |
Get the state with timestep index equal to n-1. | |
Teuchos::RCP< SolutionState< Scalar > > | getStateTimeIndexNM2 (bool warn=true) const |
Get the state with timestep index equal to n-2. | |
Teuchos::RCP< SolutionState< Scalar > > | getStateTimeIndex (int index, bool warn=true) const |
Get the state with timestep index equal to "index". | |
Teuchos::RCP< const Teuchos::ParameterList > | getValidParameters () const |
Return a valid ParameterList with current settings. | |
Teuchos::RCP< Teuchos::ParameterList > | getNonconstParameterList () |
Return a valid non-const ParameterList with current settings. | |
Overridden from Teuchos::Describable | |
virtual std::string | description () const |
virtual void | describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const |
SolutionHistory is basically a container of SolutionStates. SolutionHistory maintains a collection of SolutionStates for later retrival and reuse, such as checkpointing, restart, and undo operations.
The actual storage of the SolutionStates may take several forms:
SolutionHistory can fill in SolutionStates between other SolutionStates by either
There are two sets of indices associated with SolutionHistory: timestep index and the SolutionHistory index. Users are interested in the timestep index as it indicates the solution increment, e.g.,
SolutionHistory will hold upto the StorageLimit_ number of states. Rules of thumb for the minimum storage limit:
The states contained in the SolutionHistory will often be the last
The SolutionHistory is kept in chronological order, starting with the oldest state and ending with the latest.
The "current" state is the latest solution that has been successfully solved. The solution from the last successful time step or the initial conditions.
The "working" state is the state which is being worked on. It is valid from initialization (e.g., copied from the "current" state), during the the timestep, and until it is accepted and promoted to the new "current" state. Between the promotion and the initialization, the workingState_ is invalid (i.e., Teuchos::null). If the timestep fails, the workingState_ is maintained, and the timestep is retried until the Integrator declares a successful timestep or the time integration is a failure. The SolutionHistory indices associated with the currentState_ and the workingState_ vary during the time step loop, and are
Loop Portion | currentState_ | workingState_ |
---|---|---|
Before initializing working state | PASS -> ![]() FAIL -> ![]() | PASS -> Invalid FAIL -> ![]() |
After initializing working state During timestep Before accepting timestep | ![]() | ![]() |
After accepting timestep | PASS -> ![]() FAIL -> ![]() | PASS -> Invalid FAIL -> ![]() |
Initial conditions are considered PASSing, which sets up the loop. The difference between the currentState_ timestep index and the workingState_ timestep index is guaranteed to be one (except for when StorageLimit_ = 1, i.e., explicit one-step methods that can update the solution in-place).
Definition at line 117 of file Tempus_SolutionHistory_decl.hpp.
Tempus::SolutionHistory< Scalar >::SolutionHistory | ( | ) |
Default Contructor.
Definition at line 24 of file Tempus_SolutionHistory_impl.hpp.
Tempus::SolutionHistory< Scalar >::SolutionHistory | ( | std::string | name, |
Teuchos::RCP< std::vector< Teuchos::RCP< SolutionState< Scalar > > > > | history, | ||
Teuchos::RCP< Interpolator< Scalar > > | interpolator, | ||
StorageType | storageType, | ||
int | storageLimit | ||
) |
Contructor.
Definition at line 35 of file Tempus_SolutionHistory_impl.hpp.
|
inline |
Destructor.
Definition at line 132 of file Tempus_SolutionHistory_decl.hpp.
void Tempus::SolutionHistory< Scalar >::addState | ( | const Teuchos::RCP< SolutionState< Scalar > > & | state, |
bool | doChecks = true |
||
) |
Add solution state to history.
Definition at line 52 of file Tempus_SolutionHistory_impl.hpp.
void Tempus::SolutionHistory< Scalar >::addWorkingState | ( | const Teuchos::RCP< SolutionState< Scalar > > & | state, |
const bool | updateTime = true |
||
) |
Add a working solution state to history.
Definition at line 132 of file Tempus_SolutionHistory_impl.hpp.
void Tempus::SolutionHistory< Scalar >::removeState | ( | const Teuchos::RCP< SolutionState< Scalar > > & | state | ) |
Remove solution state.
Definition at line 150 of file Tempus_SolutionHistory_impl.hpp.
void Tempus::SolutionHistory< Scalar >::removeState | ( | const Scalar | time | ) |
Remove solution state based on time.
Definition at line 170 of file Tempus_SolutionHistory_impl.hpp.
Teuchos::RCP< SolutionState< Scalar > > Tempus::SolutionHistory< Scalar >::findState | ( | const Scalar | time | ) | const |
Find solution state at requested time (no interpolation)
Definition at line 177 of file Tempus_SolutionHistory_impl.hpp.
Teuchos::RCP< SolutionState< Scalar > > Tempus::SolutionHistory< Scalar >::interpolateState | ( | const Scalar | time | ) | const |
Generate and interpolate a new solution state at requested time.
Definition at line 211 of file Tempus_SolutionHistory_impl.hpp.
void Tempus::SolutionHistory< Scalar >::interpolateState | ( | const Scalar | time, |
SolutionState< Scalar > * | state_out | ||
) | const |
Interpolate solution state at requested time and store in supplied state.
Definition at line 220 of file Tempus_SolutionHistory_impl.hpp.
void Tempus::SolutionHistory< Scalar >::initWorkingState | ( | ) |
Initialize the working state.
Initialize the working state
Definition at line 228 of file Tempus_SolutionHistory_impl.hpp.
void Tempus::SolutionHistory< Scalar >::promoteWorkingState | ( | ) |
Promote the working state to current state.
Definition at line 269 of file Tempus_SolutionHistory_impl.hpp.
|
inline |
Clear the history.
Definition at line 168 of file Tempus_SolutionHistory_decl.hpp.
void Tempus::SolutionHistory< Scalar >::copy | ( | Teuchos::RCP< const SolutionHistory< Scalar > > | sh | ) |
Make a shallow copy of SolutionHistory (i.e., only RCPs to states and interpolator).
Definition at line 290 of file Tempus_SolutionHistory_impl.hpp.
|
inline |
Get this SolutionHistory's name.
Definition at line 182 of file Tempus_SolutionHistory_decl.hpp.
|
inline |
Set this SolutionHistory's name.
Definition at line 185 of file Tempus_SolutionHistory_decl.hpp.
|
inline |
Get underlining history.
Definition at line 188 of file Tempus_SolutionHistory_decl.hpp.
|
inline |
Set underlining history.
Definition at line 195 of file Tempus_SolutionHistory_decl.hpp.
|
inline |
Subscript operator.
Definition at line 203 of file Tempus_SolutionHistory_decl.hpp.
|
inline |
Subscript operator (const version)
Definition at line 214 of file Tempus_SolutionHistory_decl.hpp.
|
inline |
Return the current state, i.e., the last accepted state.
Definition at line 225 of file Tempus_SolutionHistory_decl.hpp.
|
inline |
Return the working state.
Definition at line 239 of file Tempus_SolutionHistory_decl.hpp.
|
inline |
Get the number of states.
Definition at line 252 of file Tempus_SolutionHistory_decl.hpp.
|
inline |
Get the current time.
Definition at line 255 of file Tempus_SolutionHistory_decl.hpp.
|
inline |
Get the current timestep index.
Definition at line 258 of file Tempus_SolutionHistory_decl.hpp.
void Tempus::SolutionHistory< Scalar >::setStorageLimit | ( | int | storage_limit | ) |
Set the maximum storage of this history.
Definition at line 310 of file Tempus_SolutionHistory_impl.hpp.
|
inline |
Get the maximum storage of this history.
Definition at line 264 of file Tempus_SolutionHistory_decl.hpp.
void Tempus::SolutionHistory< Scalar >::setStorageType | ( | StorageType | st | ) |
Set the storage type via enum.
Definition at line 353 of file Tempus_SolutionHistory_impl.hpp.
|
inline |
Get the enum storage type.
Definition at line 270 of file Tempus_SolutionHistory_decl.hpp.
void Tempus::SolutionHistory< Scalar >::setStorageTypeString | ( | std::string | st | ) |
Set the storage type via string.
Definition at line 366 of file Tempus_SolutionHistory_impl.hpp.
std::string Tempus::SolutionHistory< Scalar >::getStorageTypeString | ( | ) | const |
Set the string storage type.
Definition at line 391 of file Tempus_SolutionHistory_impl.hpp.
|
inline |
Return the current minimum time of the SolutionStates.
Definition at line 279 of file Tempus_SolutionHistory_decl.hpp.
|
inline |
Return the current maximum time of the SolutionStates.
Definition at line 282 of file Tempus_SolutionHistory_decl.hpp.
Teuchos::RCP< SolutionState< Scalar > > Tempus::SolutionHistory< Scalar >::getStateTimeIndexN | ( | bool | warn = true | ) | const |
Get the state with timestep index equal to n.
If not available return Teuchos::null;
Definition at line 407 of file Tempus_SolutionHistory_impl.hpp.
Teuchos::RCP< SolutionState< Scalar > > Tempus::SolutionHistory< Scalar >::getStateTimeIndexNM1 | ( | bool | warn = true | ) | const |
Get the state with timestep index equal to n-1.
If not available return Teuchos::null;
Definition at line 427 of file Tempus_SolutionHistory_impl.hpp.
Teuchos::RCP< SolutionState< Scalar > > Tempus::SolutionHistory< Scalar >::getStateTimeIndexNM2 | ( | bool | warn = true | ) | const |
Get the state with timestep index equal to n-2.
If not available return Teuchos::null;
Definition at line 466 of file Tempus_SolutionHistory_impl.hpp.
Teuchos::RCP< SolutionState< Scalar > > Tempus::SolutionHistory< Scalar >::getStateTimeIndex | ( | int | index, |
bool | warn = true |
||
) | const |
Get the state with timestep index equal to "index".
If not available return Teuchos::null;
Definition at line 508 of file Tempus_SolutionHistory_impl.hpp.
Teuchos::RCP< const Teuchos::ParameterList > Tempus::SolutionHistory< Scalar >::getValidParameters | ( | ) | const |
Return a valid ParameterList with current settings.
Definition at line 572 of file Tempus_SolutionHistory_impl.hpp.
Teuchos::RCP< Teuchos::ParameterList > Tempus::SolutionHistory< Scalar >::getNonconstParameterList | ( | ) |
Return a valid non-const ParameterList with current settings.
Definition at line 598 of file Tempus_SolutionHistory_impl.hpp.
|
virtual |
Definition at line 534 of file Tempus_SolutionHistory_impl.hpp.
|
virtual |
Definition at line 540 of file Tempus_SolutionHistory_impl.hpp.
void Tempus::SolutionHistory< Scalar >::setInterpolator | ( | const Teuchos::RCP< Interpolator< Scalar > > & | interpolator | ) |
Set the interpolator for this history.
Definition at line 604 of file Tempus_SolutionHistory_impl.hpp.
Teuchos::RCP< Interpolator< Scalar > > Tempus::SolutionHistory< Scalar >::getNonconstInterpolator | ( | ) |
Definition at line 618 of file Tempus_SolutionHistory_impl.hpp.
Teuchos::RCP< const Interpolator< Scalar > > Tempus::SolutionHistory< Scalar >::getInterpolator | ( | ) | const |
Definition at line 625 of file Tempus_SolutionHistory_impl.hpp.
Teuchos::RCP< Interpolator< Scalar > > Tempus::SolutionHistory< Scalar >::unSetInterpolator | ( | ) |
Unset the interpolator for this history.
Definition at line 631 of file Tempus_SolutionHistory_impl.hpp.
void Tempus::SolutionHistory< Scalar >::printHistory | ( | std::string | verb = "low" | ) | const |
Print information on States in the SolutionHistory.
Definition at line 639 of file Tempus_SolutionHistory_impl.hpp.
void Tempus::SolutionHistory< Scalar >::initialize | ( | ) | const |
Initialize SolutionHistory.
This function will check if all member data is initialized and is consistent. This function does not make member data consistent, but just checks it. This ensures it is inexpensive.
Definition at line 671 of file Tempus_SolutionHistory_impl.hpp.
|
inline |
Return if SolutionHistory is initialized.
Definition at line 348 of file Tempus_SolutionHistory_decl.hpp.
|
protected |
Definition at line 351 of file Tempus_SolutionHistory_decl.hpp.
|
protected |
Definition at line 352 of file Tempus_SolutionHistory_decl.hpp.
|
protected |
Definition at line 353 of file Tempus_SolutionHistory_decl.hpp.
|
protected |
Definition at line 354 of file Tempus_SolutionHistory_decl.hpp.
|
protected |
Definition at line 355 of file Tempus_SolutionHistory_decl.hpp.
|
protected |
The state being worked on.
Definition at line 358 of file Tempus_SolutionHistory_decl.hpp.
|
mutableprotected |
Bool if SolutionHistory is initialized.
Definition at line 360 of file Tempus_SolutionHistory_decl.hpp.