libMesh::FileHistoryData Class Reference

HistoryData subclass that provides a struct to store history data such as timestamps, mesh, primal and adjoint filenames and timestep sizes. More...

#include <file_history_data.h>

Inheritance diagram for libMesh::FileHistoryData:

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

Public Member Functions
	FileHistoryData (DifferentiableSystem &system)
	~FileHistoryData ()
std::string &	get_mesh_filename ()
std::string &	get_primal_filename ()
std::string &	get_adjoint_filename ()
void	set_mesh_filename (std::string &mesh_name)
void	set_primal_filename (std::string &primal_sol_name)
void	set_adjoint_filename (std::string &adjoint_sol_name)
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
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 Attributes
DifferentiableSystem &	_system
std::string	mesh_filename
std::string	primal_filename
std::string	adjoint_filename

Detailed Description

HistoryData subclass that provides a struct to store history data such as timestamps, mesh, primal and adjoint filenames and timestep sizes.

Author

Vikram Garg

Date

2021

Definition at line 18 of file file_history_data.h.

Member Typedef Documentation

map_type

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

inherited

Definition at line 54 of file 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.

Constructor & Destructor Documentation

FileHistoryData()

libMesh::FileHistoryData::FileHistoryData ( DifferentiableSystem &  system )

inline

Definition at line 22 of file file_history_data.h.

: HistoryData(), _system(system),mesh_filename(""), primal_filename(""), adjoint_filename("") {};

~FileHistoryData()

libMesh::FileHistoryData::~FileHistoryData ( )

inline

Definition at line 24 of file file_history_data.h.

{};

Member Function Documentation

get_adjoint_filename()

std::string& libMesh::FileHistoryData::get_adjoint_filename ( )

inline

Definition at line 33 of file file_history_data.h.

References adjoint_filename.

        { return adjoint_filename; }

get_deltat_at()

Real libMesh::HistoryData::get_deltat_at ( )

inlineinherited

Definition at line 36 of file history_data.h.

References libMesh::HistoryData::deltat_at.

        { return deltat_at; }

get_mesh_filename()

std::string& libMesh::FileHistoryData::get_mesh_filename ( )

inline

Definition at line 27 of file file_history_data.h.

References mesh_filename.

        { return mesh_filename; }

get_previously_stored()

bool libMesh::HistoryData::get_previously_stored ( )

inlineinherited

Definition at line 39 of file history_data.h.

References libMesh::HistoryData::previously_stored.

        { return previously_stored; }

get_primal_filename()

std::string& libMesh::FileHistoryData::get_primal_filename ( )

inline

Definition at line 30 of file file_history_data.h.

References primal_filename.

        { return primal_filename; }

get_time_stamp()

unsigned int libMesh::HistoryData::get_time_stamp ( )

inlineinherited

Definition at line 33 of file history_data.h.

References libMesh::HistoryData::time_stamp.

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

        { return time_stamp; }

retrieve_adjoint_solution()

void libMesh::FileHistoryData::retrieve_adjoint_solution ( )

overridevirtual

Implements libMesh::HistoryData.

Definition at line 93 of file file_history_data.C.

References _system, adjoint_filename, libMesh::System::get_equation_systems(), libMesh::READ, libMesh::EquationSystems::read(), libMesh::EquationSystems::READ_ADDITIONAL_DATA, and libMesh::EquationSystems::READ_DATA.

    {
     // Read in the adjoint solution stored at the current recovery time from the disk
     _system.get_equation_systems().read(adjoint_filename, READ, EquationSystems::READ_DATA | EquationSystems::READ_ADDITIONAL_DATA);
    }

retrieve_primal_solution()

void libMesh::FileHistoryData::retrieve_primal_solution ( )

overridevirtual

Implements libMesh::HistoryData.

Definition at line 87 of file file_history_data.C.

References _system, libMesh::System::get_equation_systems(), primal_filename, libMesh::READ, libMesh::EquationSystems::read(), libMesh::EquationSystems::READ_ADDITIONAL_DATA, and libMesh::EquationSystems::READ_DATA.

    {
     // Read in the primal solution stored at the current recovery time from the disk
     _system.get_equation_systems().read(primal_filename, READ, EquationSystems::READ_DATA | EquationSystems::READ_ADDITIONAL_DATA);
    }

rewrite_stored_solution()

void libMesh::FileHistoryData::rewrite_stored_solution ( )

overridevirtual

Implements libMesh::HistoryData.

Definition at line 79 of file file_history_data.C.

References _system, libMesh::System::get_equation_systems(), libMesh::libmesh_assert(), libMesh::HistoryData::previously_stored, primal_filename, libMesh::WRITE, libMesh::EquationSystems::write(), libMesh::EquationSystems::WRITE_ADDITIONAL_DATA, and libMesh::EquationSystems::WRITE_DATA.

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

     _system.get_equation_systems().write(primal_filename, WRITE, EquationSystems::WRITE_DATA | EquationSystems::WRITE_ADDITIONAL_DATA);
    }

set_adjoint_filename()

void libMesh::FileHistoryData::set_adjoint_filename ( std::string &  adjoint_sol_name )

inline

Definition at line 42 of file file_history_data.h.

References adjoint_filename.

        { adjoint_filename = adjoint_sol_name; }

set_deltat_at()

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

inlineinherited

Definition at line 46 of file history_data.h.

References libMesh::HistoryData::deltat_at.

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

        { deltat_at = deltat_at_val; }

set_mesh_filename()

void libMesh::FileHistoryData::set_mesh_filename ( std::string &  mesh_name )

inline

Definition at line 36 of file file_history_data.h.

References mesh_filename.

        { mesh_filename = mesh_name; }

set_previously_stored()

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

inlineinherited

Definition at line 49 of file history_data.h.

References libMesh::HistoryData::previously_stored.

        { previously_stored = previously_stored_val; }

set_primal_filename()

void libMesh::FileHistoryData::set_primal_filename ( std::string &  primal_sol_name )

inline

Definition at line 39 of file file_history_data.h.

References primal_filename.

        { primal_filename = primal_sol_name; }

set_time_stamp()

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

inlineinherited

Definition at line 43 of file history_data.h.

References libMesh::HistoryData::time_stamp.

        { time_stamp = time_stamp_val; }

store_adjoint_solution()

void libMesh::FileHistoryData::store_adjoint_solution ( )

overridevirtual

Implements libMesh::HistoryData.

Definition at line 70 of file file_history_data.C.

References _system, adjoint_filename, libMesh::System::get_equation_systems(), libMesh::HistoryData::time_stamp, libMesh::WRITE, libMesh::EquationSystems::write(), libMesh::EquationSystems::WRITE_ADDITIONAL_DATA, and libMesh::EquationSystems::WRITE_DATA.

    {
     adjoint_filename = "adjoint.out.xda.";

     adjoint_filename += std::to_string(time_stamp);

     _system.get_equation_systems().write(adjoint_filename, WRITE, EquationSystems::WRITE_DATA | EquationSystems::WRITE_ADDITIONAL_DATA);
    }

store_initial_solution()

void libMesh::FileHistoryData::store_initial_solution ( )

overridevirtual

Implements libMesh::HistoryData.

Definition at line 26 of file file_history_data.C.

References _system, libMesh::HistoryData::deltat_at, libMesh::System::get_equation_systems(), libMesh::libmesh_assert(), libMesh::HistoryData::previously_stored, primal_filename, libMesh::HistoryData::time_stamp, libMesh::WRITE, libMesh::EquationSystems::write(), libMesh::EquationSystems::WRITE_ADDITIONAL_DATA, and libMesh::EquationSystems::WRITE_DATA.

  {
    // The initial data should only be stored once.
    libmesh_assert(previously_stored == false);

    time_stamp = 0;

    primal_filename = "primal.out.xda.";

    primal_filename += std::to_string(time_stamp);

    _system.get_equation_systems().write (primal_filename, WRITE, EquationSystems::WRITE_DATA | EquationSystems::WRITE_ADDITIONAL_DATA);

    // We wont know the deltat taken at this timestep until the solve is completed, which is done after the store operation.
    deltat_at = std::numeric_limits<double>::signaling_NaN();

    previously_stored = true;
  }

store_primal_solution()

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

overridevirtual

Implements libMesh::HistoryData.

Definition at line 45 of file file_history_data.C.

References _system, libMesh::HistoryData::deltat_at, libMesh::System::get_equation_systems(), libMesh::HistoryData::get_time_stamp(), libMesh::HistoryData::previously_stored, primal_filename, libMesh::HistoryData::set_deltat_at(), libMesh::DifferentiableSystem::time_solver, libMesh::HistoryData::time_stamp, libMesh::WRITE, libMesh::EquationSystems::write(), libMesh::EquationSystems::WRITE_ADDITIONAL_DATA, and libMesh::EquationSystems::WRITE_DATA.

  {
    // An iterator to the datum being stored has been passed. This is taken to imply
    // that we are in a sequential time stepping sequence.

    stored_data_iterator stored_datum_last = stored_datum;
    stored_datum_last--;

    time_stamp = (stored_datum_last->second)->get_time_stamp() + 1;

    primal_filename = "primal.out.xda.";

    primal_filename += std::to_string(time_stamp);

    _system.get_equation_systems().write (primal_filename, WRITE, EquationSystems::WRITE_DATA | EquationSystems::WRITE_ADDITIONAL_DATA);

    // We dont know the deltat that will be taken at the current timestep.
    deltat_at = std::numeric_limits<double>::signaling_NaN();

    // But we know what deltat got us to the current time.
    (stored_datum_last->second)->set_deltat_at(_system.time_solver->TimeSolver::last_completed_timestep_size());

    previously_stored = true;
  }

Member Data Documentation

_system

DifferentiableSystem& libMesh::FileHistoryData::_system

private

Definition at line 56 of file file_history_data.h.

Referenced by retrieve_adjoint_solution(), retrieve_primal_solution(), rewrite_stored_solution(), store_adjoint_solution(), store_initial_solution(), and store_primal_solution().

adjoint_filename

std::string libMesh::FileHistoryData::adjoint_filename

private

Definition at line 61 of file file_history_data.h.

Referenced by get_adjoint_filename(), retrieve_adjoint_solution(), set_adjoint_filename(), and store_adjoint_solution().

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::MemoryHistoryData::store_initial_solution(), store_initial_solution(), libMesh::MemoryHistoryData::store_primal_solution(), and store_primal_solution().

mesh_filename

std::string libMesh::FileHistoryData::mesh_filename

private

Definition at line 59 of file file_history_data.h.

Referenced by get_mesh_filename(), and set_mesh_filename().

previously_stored

bool libMesh::HistoryData::previously_stored

protectedinherited

Definition at line 79 of file history_data.h.

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

primal_filename

std::string libMesh::FileHistoryData::primal_filename

private

Definition at line 60 of file file_history_data.h.

Referenced by get_primal_filename(), retrieve_primal_solution(), rewrite_stored_solution(), set_primal_filename(), store_initial_solution(), and store_primal_solution().

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(), store_adjoint_solution(), libMesh::MemoryHistoryData::store_initial_solution(), store_initial_solution(), libMesh::MemoryHistoryData::store_primal_solution(), and store_primal_solution().

---

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

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