libMesh::SolutionHistory Class Reference

For storing and retrieving 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 std::unique_ptr< SolutionHistory >	clone () const =0
void	set_overwrite_previously_stored (bool val)

Protected Attributes
bool	overwrite_previously_stored

Detailed Description

For storing and retrieving 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

SolutionHistory()

libMesh::SolutionHistory::SolutionHistory ( )

inline

Constructor

Definition at line 42 of file solution_history.h.

                    :
    overwrite_previously_stored(false) {}

~SolutionHistory()

virtual libMesh::SolutionHistory::~SolutionHistory ( )

inlinevirtual

Destructor

Definition at line 48 of file solution_history.h.

{}

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.

Referenced by libMesh::TimeSolver::set_solution_history().

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 )

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.

  { overwrite_previously_stored = val; }

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(), and libMesh::MemorySolutionHistory::store().

---

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

• solution_history.h