libMesh::SolutionHistory Class Referenceabstract

For storing and retrieiving timestep data. More...

#include <solution_history.h>

Inheritance diagram for libMesh::SolutionHistory:

Public Member Functions

 SolutionHistory ()
 
virtual ~SolutionHistory ()
 
virtual void store ()=0
 
virtual void retrieve ()=0
 
virtual UniquePtr< SolutionHistoryclone () const =0
 
void set_overwrite_previously_stored (bool val)
 

Protected Attributes

bool overwrite_previously_stored
 

Detailed Description

For storing and retrieiving timestep data.

A SolutionHistory class that enables the storage and retrieval of timesteps and (in the future) adaptive steps.

Author
Vikram Garg
Date
2012

Definition at line 35 of file solution_history.h.

Constructor & Destructor Documentation

libMesh::SolutionHistory::SolutionHistory ( )
inline

Constructor

Definition at line 42 of file solution_history.h.

42  :
virtual libMesh::SolutionHistory::~SolutionHistory ( )
inlinevirtual

Destructor

Definition at line 48 of file solution_history.h.

References clone(), retrieve(), and store().

48 {}

Member Function Documentation

virtual UniquePtr<SolutionHistory > libMesh::SolutionHistory::clone ( ) const
pure virtual

Cloning function for a UniquePtr, pure virtual, used in the setter function in time_solver.C

Implemented in libMesh::MemorySolutionHistory, and libMesh::NoSolutionHistory.

Referenced by libMesh::TimeSolver::set_solution_history(), and ~SolutionHistory().

virtual void libMesh::SolutionHistory::retrieve ( )
pure virtual

Function to retrieve a solution, pure virtual

Implemented in libMesh::MemorySolutionHistory, and libMesh::NoSolutionHistory.

Referenced by ~SolutionHistory().

void libMesh::SolutionHistory::set_overwrite_previously_stored ( bool  val)
inline

Turn on overwrite_previously_stored to overwrite any already-saved data encountered during subsequent store() calls

Definition at line 70 of file solution_history.h.

References overwrite_previously_stored.

virtual void libMesh::SolutionHistory::store ( )
pure virtual

Function to store a solution, pure virtual

Implemented in libMesh::MemorySolutionHistory, and libMesh::NoSolutionHistory.

Referenced by ~SolutionHistory().

Member Data Documentation

bool libMesh::SolutionHistory::overwrite_previously_stored
protected

The documentation for this class was generated from the following file: