libMesh
Public Member Functions | Protected Attributes | List of all members
libMesh::SolutionHistory Class Referenceabstract

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

#include <solution_history.h>

Inheritance diagram for libMesh::SolutionHistory:
[legend]

Public Member Functions

 SolutionHistory ()
 Constructor. More...
 
virtual ~SolutionHistory ()
 Destructor. More...
 
virtual void store ()=0
 Function to store a solution, pure virtual. More...
 
virtual void retrieve ()=0
 Function to retrieve a solution, pure virtual. More...
 
virtual std::unique_ptr< SolutionHistoryclone () const =0
 Cloning function for a std::unique_ptr, pure virtual, used in the setter function in time_solver.C. More...
 
void set_overwrite_previously_stored (bool val)
 Turn on overwrite_previously_stored to overwrite any already-saved data encountered during subsequent store() calls. More...
 

Protected Attributes

bool overwrite_previously_stored
 

Detailed Description

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

Author
Vikram Garg
Date
2012 For storing and retrieving timestep data.

Definition at line 35 of file solution_history.h.

Constructor & Destructor Documentation

◆ SolutionHistory()

libMesh::SolutionHistory::SolutionHistory ( )

Constructor.

Definition at line 42 of file solution_history.h.

42  :

◆ ~SolutionHistory()

virtual libMesh::SolutionHistory::~SolutionHistory ( )
virtual

Destructor.

Definition at line 48 of file solution_history.h.

48 {}

Member Function Documentation

◆ clone()

virtual std::unique_ptr<SolutionHistory > libMesh::SolutionHistory::clone ( ) const
pure virtual

Cloning function for a std::unique_ptr, pure virtual, used in the setter function in time_solver.C.

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

◆ retrieve()

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

Function to retrieve a solution, pure virtual.

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

◆ set_overwrite_previously_stored()

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

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.

◆ store()

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

Function to store a solution, pure virtual.

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

Member Data Documentation

◆ overwrite_previously_stored

bool libMesh::SolutionHistory::overwrite_previously_stored
protected

Definition at line 77 of file solution_history.h.

Referenced by set_overwrite_previously_stored().


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