result type for ODE solvers Mehr ...
#include <odesolver.hh>
Öffentliche Typen | |
| typedef DataOutputImp | DataOutputType |
| Type of the class used for data output. This type needs to be derived from DataOutputInterface. | |
|
typedef std::pair< double, DofVectorType > | SnapshotType |
| Snapshot type: a pair of a time instance and a DofVectorType. | |
| typedef std::vector< SnapshotType > | TrajectoryType |
| Trajectory type: a vector of SnapshotType instances. | |
Öffentliche Methoden | |
| DestinationOutput (const DataOutputType &dataOut, StorageParams params=StorageParams()) | |
| Constructor storing a reference to the actual DataOutputInterface implementation. | |
| void | firstOutput (const DofVectorType &df, double time) |
| Function storing the initial data function. | |
| void | output (const DofVectorType &df, unsigned int timeStep, double time) |
| Function storing the intermediate data functions. | |
| void | lastOutput (const DofVectorType &df, unsigned int timeStep, double time) |
| Function storing the final data function. | |
| unsigned int | size () const |
| Returns the size of the stored data functions. | |
| SnapshotType & | operator[] (unsigned int index) |
| Returns a snapshot from the stored trajectory. | |
| const SnapshotType & | operator[] (unsigned int index) const |
| Returns a snapshot from the stored trajectory. | |
Ausführliche Beschreibung
template<class DataOutputImp, class DofVectorType>
class ODESolver::DestinationOutput< DataOutputImp, DofVectorType >
result type for ODE solvers
This class can be used as the output argument for the ODESolverInterface::solve() method. Usually it writes out trajectory data for visualization and optionally stores Dof vectors of intermediate solutions in memory.
One can think of this class handling as two trajectories
\[ \mbox{Traj}_{o/s} := \{ u_h(t^{\kappa_{o/s}}) \}_{\kappa_{o/s} \in {\cal S}_{o/s}} \]
composed of snapshots \( u_h(t^k) \in { \cal W}_h \) defined for time instances \( 0\leq t^0 \leq \ldots \leq t^K \) with selected time steps \( {\cal S}_{o/s} \subset \{0,\ldots,K\}\).
The trajectory
- \( \mbox{Traj}_o \) is written to the harddrive with help of a DataOutputImp and
- \( \mbox{Traj}_s \) is stored in memory and can be accessed with the operator[]().
- Siehe auch:
- StorageParams for the definition of the sets \( {\cal S}_{o/s} \)
- Template Parameters:
-
DataOutputType type of the class used for data output. This type needs to be derived from DataOutputInterface. DofVectorType type of the Dof vectors. This type needs to be derived from DofVectorInterface.
Beschreibung der Konstruktoren und Destruktoren
| ODESolver::DestinationOutput< DataOutputImp, DofVectorType >::DestinationOutput | ( | const DataOutputType & | dataOut, |
| StorageParams | params = StorageParams() |
||
| ) | [inline] |
Constructor storing a reference to the actual DataOutputInterface implementation.
- Parameter:
-
dataOut The DataOutputInterface implementation params This a prameter object defining the behaviour of the DestinationOutput objects.
Dokumentation der Elementfunktionen
| void ODESolver::DestinationOutput< DataOutputImp, DofVectorType >::firstOutput | ( | const DofVectorType & | df, |
| double | time | ||
| ) | [inline] |
Function storing the initial data function.
This function is called at the beginning of an ODESolver loop and outputs/stores the initial data according to the given StorageParams parameters.
- Parameter:
-
df Dof vector of initial data (possibly) to be stored. time time instance.
| void ODESolver::DestinationOutput< DataOutputImp, DofVectorType >::lastOutput | ( | const DofVectorType & | df, |
| unsigned int | timeStep, | ||
| double | time | ||
| ) | [inline] |
Function storing the final data function.
This function is called at the end of an ODESolver loop and outputs/stores the final data according to the given StorageParams parameters.
- Parameter:
-
df Dof vector of final result. timeStep the current time step number. time time instance.
| SnapshotType& ODESolver::DestinationOutput< DataOutputImp, DofVectorType >::operator[] | ( | unsigned int | index | ) | [inline] |
Returns a snapshot from the stored trajectory.
- Parameter:
-
index index of the snapshot in the trajectory to be returned.
| const SnapshotType& ODESolver::DestinationOutput< DataOutputImp, DofVectorType >::operator[] | ( | unsigned int | index | ) | const [inline] |
Returns a snapshot from the stored trajectory.
- Parameter:
-
index index of the snapshot in the trajectory to be returned.
| void ODESolver::DestinationOutput< DataOutputImp, DofVectorType >::output | ( | const DofVectorType & | df, |
| unsigned int | timeStep, | ||
| double | time | ||
| ) | [inline] |
Function storing the intermediate data functions.
This function is called after each ODESolver step and outputs/stores the intermediately computed data according to the given StorageParams parameters.
- Parameter:
-
df Dof vector of intermediate result (possibly) to be stored. timeStep the current time step number. time time instance.
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:
- odesolver.hh
