libMesh::MemoryHistoryData Class Reference

MemoryHistoryData provides a data structure to store memory history data. More...

#include <memory_history_data.h>

Inheritance diagram for libMesh::MemoryHistoryData:

Public Types
typedef map_type::iterator	stored_data_iterator

Public Member Functions
	MemoryHistoryData (DifferentiableSystem &system)
	~MemoryHistoryData ()
virtual void	store_initial_solution () override
virtual void	store_primal_solution (stored_data_iterator stored_datum) override
virtual void	store_adjoint_solution () override
virtual void	rewrite_stored_solution () override
virtual void	retrieve_primal_solution () override
virtual void	retrieve_adjoint_solution () override
void	store_vectors ()
void	retrieve_vectors ()
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)

Protected Attributes
unsigned int	time_stamp
Real	deltat_at
bool	previously_stored

Private Types
typedef std::map< std::string, std::unique_ptr< NumericVector< Number > > >	map_type
typedef map_type::iterator	stored_vecs_iterator

Private Attributes
DifferentiableSystem &	_system
map_type	stored_vecs
stored_vecs_iterator	stored_vec

Detailed Description

MemoryHistoryData provides a data structure to store memory history data.

This is a companion class to MemorySolutionHistory.

Definition at line 16 of file memory_history_data.h.

Member Typedef Documentation

map_type

typedef std::map<std::string, std::unique_ptr<NumericVector<Number> > > libMesh::MemoryHistoryData::map_type

private

Definition at line 41 of file memory_history_data.h.

stored_data_iterator

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

inherited

Definition at line 55 of file history_data.h.

stored_vecs_iterator

typedef map_type::iterator libMesh::MemoryHistoryData::stored_vecs_iterator

private

Definition at line 42 of file memory_history_data.h.

Constructor & Destructor Documentation

MemoryHistoryData()

libMesh::MemoryHistoryData::MemoryHistoryData ( DifferentiableSystem &  system )

inline

Definition at line 21 of file memory_history_data.h.

: HistoryData(), _system(system), stored_vecs{}, stored_vec(stored_vecs.end()) {};

~MemoryHistoryData()

libMesh::MemoryHistoryData::~MemoryHistoryData ( )

inline

Definition at line 24 of file memory_history_data.h.

{};

Member Function Documentation

get_deltat_at()

Real libMesh::HistoryData::get_deltat_at ( )

inlineinherited

Definition at line 36 of file history_data.h.

        { return deltat_at; }

References libMesh::HistoryData::deltat_at.

get_previously_stored()

bool libMesh::HistoryData::get_previously_stored ( )

inlineinherited

Definition at line 39 of file history_data.h.

        { return previously_stored; }

References libMesh::HistoryData::previously_stored.

get_time_stamp()

unsigned int libMesh::HistoryData::get_time_stamp ( )

inlineinherited

Definition at line 33 of file history_data.h.

        { return time_stamp; }

References libMesh::HistoryData::time_stamp.

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

retrieve_adjoint_solution()

void libMesh::MemoryHistoryData::retrieve_adjoint_solution ( )

overridevirtual

Implements libMesh::HistoryData.

Definition at line 71 of file memory_history_data.C.

    {
     retrieve_vectors();
    }

References retrieve_vectors().

retrieve_primal_solution()

void libMesh::MemoryHistoryData::retrieve_primal_solution ( )

overridevirtual

Implements libMesh::HistoryData.

Definition at line 66 of file memory_history_data.C.

    {
     retrieve_vectors();
    }

References retrieve_vectors().

retrieve_vectors()

void libMesh::MemoryHistoryData::retrieve_vectors

(

)

Definition at line 101 of file memory_history_data.C.

    {
      // We are reading, hopefully something has been written before
      libmesh_assert(previously_stored == true);
 
      map_type::iterator vec = stored_vecs.begin();
      map_type::iterator vec_end = stored_vecs.end();
 
      // Loop over all the saved vectors
      for (; vec != vec_end; ++vec)
      {
       // The name of this vector
       const std::string & vec_name = vec->first;
 
       // Get the vec_name entry in the saved vectors map and set the
       // current system vec[vec_name] entry to it
       if (vec_name != "_solution")
         _system.get_vector(vec_name) = *(vec->second);
      }
 
      std::string _solution("_solution");
      *(_system.solution) = *(stored_vecs[_solution]);
 
    }

References _system, libMesh::System::get_vector(), libMesh::libmesh_assert(), libMesh::HistoryData::previously_stored, libMesh::System::solution, and stored_vecs.

Referenced by retrieve_adjoint_solution(), and retrieve_primal_solution().

rewrite_stored_solution()

void libMesh::MemoryHistoryData::rewrite_stored_solution ( )

overridevirtual

Implements libMesh::HistoryData.

Definition at line 58 of file memory_history_data.C.

    {
      // We are rewriting.
      libmesh_assert(previously_stored == true);
 
      store_vectors();
    }

References libMesh::libmesh_assert(), libMesh::HistoryData::previously_stored, and store_vectors().

set_deltat_at()

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

inlineinherited

Definition at line 46 of file history_data.h.

        { deltat_at = deltat_at_val; }

References libMesh::HistoryData::deltat_at.

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

set_previously_stored()

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

inlineinherited

Definition at line 49 of file history_data.h.

        { previously_stored = previously_stored_val; }

References libMesh::HistoryData::previously_stored.

set_time_stamp()

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

inlineinherited

Definition at line 43 of file history_data.h.

        { time_stamp = time_stamp_val; }

References libMesh::HistoryData::time_stamp.

store_adjoint_solution()

void libMesh::MemoryHistoryData::store_adjoint_solution ( )

overridevirtual

Implements libMesh::HistoryData.

Definition at line 53 of file memory_history_data.C.

    {
     libmesh_error_msg("For MemorySolutionHistory, primal and adjoints are stored in the same container.");
    }

store_initial_solution()

void libMesh::MemoryHistoryData::store_initial_solution ( )

overridevirtual

Implements libMesh::HistoryData.

Definition at line 22 of file memory_history_data.C.

    {
     // The initial data should only be stored once.
     libmesh_assert(previously_stored == false);
 
     time_stamp = 0;
 
     deltat_at = std::numeric_limits<double>::signaling_NaN();
 
     store_vectors();
 
     previously_stored = true;
    }

References libMesh::HistoryData::deltat_at, libMesh::libmesh_assert(), libMesh::HistoryData::previously_stored, store_vectors(), and libMesh::HistoryData::time_stamp.

store_primal_solution()

void libMesh::MemoryHistoryData::store_primal_solution ( stored_data_iterator  stored_datum )

overridevirtual

Implements libMesh::HistoryData.

Definition at line 36 of file memory_history_data.C.

    {
     stored_data_iterator stored_datum_last = stored_datum;
     stored_datum_last--;
 
     time_stamp = (stored_datum_last->second)->get_time_stamp() + 1;
 
     // For the current time instant, we dont know yet what timestep the solver might decide, so a placeholder NaN for now.
     deltat_at = std::numeric_limits<double>::signaling_NaN();
 
     (stored_datum_last->second)->set_deltat_at(_system.time_solver->TimeSolver::last_completed_timestep_size());
 
     store_vectors();
 
     previously_stored = true;
    }

References _system, libMesh::HistoryData::deltat_at, libMesh::HistoryData::get_time_stamp(), libMesh::HistoryData::previously_stored, libMesh::HistoryData::set_deltat_at(), store_vectors(), libMesh::DifferentiableSystem::time_solver, and libMesh::HistoryData::time_stamp.

store_vectors()

void libMesh::MemoryHistoryData::store_vectors

(

)

Definition at line 76 of file memory_history_data.C.

    {
     // Now save all the preserved vectors in stored_datum
     // Loop over all the system vectors
     for (System::vectors_iterator vec = _system.vectors_begin(),
          vec_end = _system.vectors_end(); vec != vec_end; ++vec)
     {
      // The name of this vector
      const std::string & vec_name = vec->first;
 
      // Store the vector if it is to be preserved
      if (_system.vector_preservation(vec_name))
        {
         stored_vecs[vec_name] = vec->second->clone();
        }
     }
 
     // Of course, we will usually save the actual solution
     std::string _solution("_solution");
     if (_system.project_solution_on_reinit())
     {
      stored_vecs[_solution] = _system.solution->clone();
     }
    }

References _system, libMesh::System::project_solution_on_reinit(), libMesh::System::solution, stored_vecs, libMesh::System::vector_preservation(), libMesh::System::vectors_begin(), and libMesh::System::vectors_end().

Referenced by rewrite_stored_solution(), store_initial_solution(), and store_primal_solution().

Member Data Documentation

_system

DifferentiableSystem& libMesh::MemoryHistoryData::_system

private

Definition at line 39 of file memory_history_data.h.

Referenced by retrieve_vectors(), store_primal_solution(), and store_vectors().

deltat_at

Real libMesh::HistoryData::deltat_at

protectedinherited

Definition at line 76 of file history_data.h.

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

previously_stored

bool libMesh::HistoryData::previously_stored

protectedinherited

Definition at line 79 of file history_data.h.

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

stored_vec

stored_vecs_iterator libMesh::MemoryHistoryData::stored_vec

private

Definition at line 47 of file memory_history_data.h.

stored_vecs

map_type libMesh::MemoryHistoryData::stored_vecs

private

Definition at line 46 of file memory_history_data.h.

Referenced by retrieve_vectors(), and store_vectors().

time_stamp

unsigned int libMesh::HistoryData::time_stamp

protectedinherited

Definition at line 73 of file history_data.h.

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

---

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

• include/solvers/memory_history_data.h
• src/solvers/memory_history_data.C