libMesh::HistoryData Class Reference

The History Data classes are companion classes to SolutionHistory and MeshHistory classes. More...

#include <history_data.h>

Inheritance diagram for libMesh::HistoryData:

Public Types
typedef std::map< Real, std::unique_ptr< HistoryData > >	map_type
typedef map_type::iterator	stored_data_iterator

Public Member Functions
	HistoryData ()
virtual	~HistoryData ()
unsigned int	get_time_stamp ()
Real	get_deltat_at ()
bool	get_previously_stored ()
void	set_time_stamp (unsigned int time_stamp_val)
void	set_deltat_at (Real deltat_at_val)
void	set_previously_stored (bool previously_stored_val)
virtual void	store_initial_solution ()=0
virtual void	store_primal_solution (stored_data_iterator stored_datum)=0
virtual void	store_adjoint_solution ()=0
virtual void	rewrite_stored_solution ()=0
virtual void	retrieve_primal_solution ()=0
virtual void	retrieve_adjoint_solution ()=0

Protected Attributes
unsigned int	time_stamp
Real	deltat_at
bool	previously_stored

Detailed Description

The History Data classes are companion classes to SolutionHistory and MeshHistory classes.

These provide data structures to store different types of history data (timestamps, pointers, filenames) depending on the type of History being used.

Author

Vikram Garg

Date

2021 Provides history data structures and I/O, memory operation functions.

Definition at line 21 of file history_data.h.

Member Typedef Documentation

map_type

typedef std::map<Real, std::unique_ptr<HistoryData> > libMesh::HistoryData::map_type

Definition at line 54 of file history_data.h.

stored_data_iterator

typedef map_type::iterator libMesh::HistoryData::stored_data_iterator

Definition at line 55 of file history_data.h.

Constructor & Destructor Documentation

HistoryData()

libMesh::HistoryData::HistoryData ( )

inline

Definition at line 26 of file history_data.h.

                      : time_stamp(std::numeric_limits<unsigned int>::signaling_NaN()),
        deltat_at(std::numeric_limits<double>::signaling_NaN()), previously_stored(false) {};

~HistoryData()

virtual libMesh::HistoryData::~HistoryData ( )

inlinevirtual

Definition at line 30 of file history_data.h.

{};

Member Function Documentation

get_deltat_at()

Real libMesh::HistoryData::get_deltat_at ( )

inline

Definition at line 36 of file history_data.h.

References deltat_at.

        { return deltat_at; }

get_previously_stored()

bool libMesh::HistoryData::get_previously_stored ( )

inline

Definition at line 39 of file history_data.h.

References previously_stored.

        { return previously_stored; }

get_time_stamp()

unsigned int libMesh::HistoryData::get_time_stamp ( )

inline

Definition at line 33 of file history_data.h.

References time_stamp.

Referenced by libMesh::MemoryHistoryData::store_primal_solution(), and libMesh::FileHistoryData::store_primal_solution().

        { return time_stamp; }

retrieve_adjoint_solution()

virtual void libMesh::HistoryData::retrieve_adjoint_solution ( )

pure virtual

Implemented in libMesh::FileHistoryData, and libMesh::MemoryHistoryData.

retrieve_primal_solution()

virtual void libMesh::HistoryData::retrieve_primal_solution ( )

pure virtual

Implemented in libMesh::FileHistoryData, and libMesh::MemoryHistoryData.

rewrite_stored_solution()

virtual void libMesh::HistoryData::rewrite_stored_solution ( )

pure virtual

Implemented in libMesh::FileHistoryData, and libMesh::MemoryHistoryData.

set_deltat_at()

void libMesh::HistoryData::set_deltat_at ( Real  deltat_at_val )

inline

Definition at line 46 of file history_data.h.

References deltat_at.

Referenced by libMesh::MemoryHistoryData::store_primal_solution(), and libMesh::FileHistoryData::store_primal_solution().

        { deltat_at = deltat_at_val; }

set_previously_stored()

void libMesh::HistoryData::set_previously_stored ( bool  previously_stored_val )

inline

Definition at line 49 of file history_data.h.

References previously_stored.

        { previously_stored = previously_stored_val; }

set_time_stamp()

void libMesh::HistoryData::set_time_stamp ( unsigned int  time_stamp_val )

inline

Definition at line 43 of file history_data.h.

References time_stamp.

        { time_stamp = time_stamp_val; }

store_adjoint_solution()

virtual void libMesh::HistoryData::store_adjoint_solution ( )

pure virtual

Implemented in libMesh::FileHistoryData, and libMesh::MemoryHistoryData.

store_initial_solution()

virtual void libMesh::HistoryData::store_initial_solution ( )

pure virtual

Implemented in libMesh::FileHistoryData, and libMesh::MemoryHistoryData.

store_primal_solution()

virtual void libMesh::HistoryData::store_primal_solution ( stored_data_iterator  stored_datum )

pure virtual

Implemented in libMesh::FileHistoryData, and libMesh::MemoryHistoryData.

Member Data Documentation

deltat_at

Real libMesh::HistoryData::deltat_at

protected

Definition at line 76 of file history_data.h.

Referenced by get_deltat_at(), set_deltat_at(), libMesh::MemoryHistoryData::store_initial_solution(), libMesh::FileHistoryData::store_initial_solution(), libMesh::MemoryHistoryData::store_primal_solution(), and libMesh::FileHistoryData::store_primal_solution().

previously_stored

bool libMesh::HistoryData::previously_stored

protected

Definition at line 79 of file history_data.h.

Referenced by get_previously_stored(), libMesh::MemoryHistoryData::retrieve_vectors(), libMesh::MemoryHistoryData::rewrite_stored_solution(), libMesh::FileHistoryData::rewrite_stored_solution(), set_previously_stored(), libMesh::MemoryHistoryData::store_initial_solution(), libMesh::FileHistoryData::store_initial_solution(), libMesh::MemoryHistoryData::store_primal_solution(), and libMesh::FileHistoryData::store_primal_solution().

time_stamp

unsigned int libMesh::HistoryData::time_stamp

protected

Definition at line 73 of file history_data.h.

Referenced by get_time_stamp(), set_time_stamp(), libMesh::FileHistoryData::store_adjoint_solution(), libMesh::MemoryHistoryData::store_initial_solution(), libMesh::FileHistoryData::store_initial_solution(), libMesh::MemoryHistoryData::store_primal_solution(), and libMesh::FileHistoryData::store_primal_solution().

---

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

• include/solvers/history_data.h