libMesh::NoSolutionHistory Class Reference

'Save nothing' subclass of Solution History, this is the default. More...

#include <no_solution_history.h>

Inheritance diagram for libMesh::NoSolutionHistory:

Public Member Functions
	NoSolutionHistory ()
	Constructor. More...
virtual	~NoSolutionHistory ()
	Destructor. More...
virtual void	store (bool is_adjoint_solve, Real time) override
	Virtual function store which we will be overriding. More...
virtual void	retrieve (bool is_adjoint_solve, Real time) override
	Virtual function retrieve which we will be overriding. More...
virtual std::unique_ptr< SolutionHistory >	clone () const override
	Definition of the clone function needed for the setter function. More...
void	erase (Real time)
	Erase stored_data entry at time. 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 Types
typedef std::map< Real, std::unique_ptr< HistoryData > >	map_type
typedef map_type::iterator	stored_data_iterator

Protected Member Functions
void	find_stored_entry (Real time, bool storing=false)

Protected Attributes
bool	overwrite_previously_stored
map_type	stored_data
stored_data_iterator	stored_datum

Detailed Description

'Save nothing' subclass of Solution History, this is the default.

Author

Vikram Garg

Date

2012 For storing and retrieving timestep data.

Definition at line 37 of file no_solution_history.h.

Member Typedef Documentation

map_type

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

protectedinherited

Definition at line 93 of file solution_history.h.

stored_data_iterator

typedef map_type::iterator libMesh::SolutionHistory::stored_data_iterator

protectedinherited

Definition at line 95 of file solution_history.h.

Constructor & Destructor Documentation

NoSolutionHistory()

libMesh::NoSolutionHistory::NoSolutionHistory ( )

inline

Constructor.

Definition at line 44 of file no_solution_history.h.

: SolutionHistory() {}

~NoSolutionHistory()

virtual libMesh::NoSolutionHistory::~NoSolutionHistory ( )

inlinevirtual

Destructor.

Definition at line 49 of file no_solution_history.h.

{}

Member Function Documentation

clone()

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

inlineoverridevirtual

Definition of the clone function needed for the setter function.

Implements libMesh::SolutionHistory.

Definition at line 64 of file no_solution_history.h.

  {
    return std::make_unique<NoSolutionHistory>();
  }

erase()

void libMesh::SolutionHistory::erase ( Real  time )

inherited

Erase stored_data entry at time.

Definition at line 95 of file solution_history.C.

References libMesh::SolutionHistory::find_stored_entry(), libMesh::libmesh_assert(), libMesh::SolutionHistory::stored_data, and libMesh::SolutionHistory::stored_datum.

 {
  // We cant erase the stored_datum iterator which is used in other places
  // So save its current value for the future
  stored_data_iterator stored_datum_last = stored_datum;
  //std::map<Real, unsigned int>::iterator timeTotimestamp_iterator_last = timeTotimestamp_iterator;

  // This will map the stored_datum iterator to the current time
  this->find_stored_entry(time, false);

  // map::erase behaviour is undefined if the iterator is pointing
  // to a non-existent element.
  libmesh_assert(stored_datum != stored_data.end());

  // We want to keep using the stored_datum iterator, so we have to create
  // a new one to erase the concerned entry
  stored_data_iterator stored_datum_copy = stored_datum;

  // If we're asking to erase the entry at stored_datum, then move stored_datum somewhere safer first
  if(stored_datum == stored_datum_last)
    stored_datum--;

  stored_data.erase(stored_datum_copy);
 }

find_stored_entry()

void libMesh::SolutionHistory::find_stored_entry ( Real  time, bool  storing = false  )

protectedinherited

Definition at line 27 of file solution_history.C.

References libMesh::MeshTools::Subdivision::prev, libMesh::SolutionHistory::stored_data, libMesh::SolutionHistory::stored_datum, and libMesh::TOLERANCE.

Referenced by libMesh::SolutionHistory::erase(), libMesh::MemorySolutionHistory::retrieve(), libMesh::FileSolutionHistory::retrieve(), libMesh::MemorySolutionHistory::store(), and libMesh::FileSolutionHistory::store().

 {
  if (stored_data.begin() == stored_data.end())
    return;

  // We will use the map::lower_bound operation to find the key which
  // is the least upper bound among all existing keys for time.
  // (key before map::lower_bound) < time < map::lower_bound, one of these
  // should be within TOLERANCE of time (unless we are creating a new map entry)
  // If the lower bound iterator points to:
  // begin -> we are looking for the solution at the initial time
  // end -> we are creating a new entry
  // anything else, we are looking for an existing entry
  stored_data_iterator lower_bound_it = stored_data.lower_bound(time);

  // For the key right before the lower bound
  stored_data_iterator lower_bound_it_decremented;

  // If we are at end, we could be creating a new entry (depends on the storing bool), return
  // Otherwise, get a decremented iterator for the sandwich test
  if(lower_bound_it == stored_data.end())
  {
    // If we are storing and lower_bound_it points to stored_data.end(), we assume
    // that this is a brand new entry in the map. We leave stored_datum unchanged.
    if(storing)
    {
      return;
    }
    else
    {
      // We are trying to retrieve and none of the keys was an upper bound.
      // We could have a situation in which the time is greatest key + FPE.
      // So we can check the key before the end and see if it matches time, else we have an error.
      lower_bound_it = std::prev(lower_bound_it);
    }
  }
  else if(lower_bound_it == stored_data.begin()) // At the beginning, so we cant go back any further
  {
    stored_datum = stored_data.begin();
    return;
  }
  else // A decremented iterator, to perform the sandwich test for the key closest to time
  {
    lower_bound_it_decremented = std::prev(lower_bound_it);
  }

  // Set the stored sols iterator as per the key which is within TOLERANCE of time
  if(std::abs(lower_bound_it->first - time) < TOLERANCE)
  {
    stored_datum = lower_bound_it;
  }
  else if(std::abs(lower_bound_it_decremented->first - time) < TOLERANCE)
  {
    stored_datum = lower_bound_it_decremented;
  }
  else // Neither of the two candidate keys matched our time
  {
    if(storing) // If we are storing, this is fine, we need to create a new entry, so just return
    {
      return;
    }
    else // If we are not storing, then we expected to find something but didn't, so we have a problem
    {
      libmesh_error_msg("Failed to set stored solutions iterator to a valid value.");
    }
  }
 }

retrieve()

void libMesh::NoSolutionHistory::retrieve ( bool  is_adjoint_solve, Real  time  )

overridevirtual

Virtual function retrieve which we will be overriding.

Implements libMesh::SolutionHistory.

Definition at line 29 of file no_solution_history.C.

{
  // Nothing was stored, so nothing can be retrieved
  libmesh_not_implemented();
}

set_overwrite_previously_stored()

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

inlineinherited

Turn on overwrite_previously_stored to overwrite any already-saved data encountered during subsequent store() calls.

Definition at line 80 of file solution_history.h.

References libMesh::SolutionHistory::overwrite_previously_stored.

  { overwrite_previously_stored = val; }

store()

void libMesh::NoSolutionHistory::store ( bool  is_adjoint_solve, Real  time  )

overridevirtual

Virtual function store which we will be overriding.

Implements libMesh::SolutionHistory.

Definition at line 24 of file no_solution_history.C.

{
  // Do nothing
}

Member Data Documentation

overwrite_previously_stored

bool libMesh::SolutionHistory::overwrite_previously_stored

protectedinherited

Definition at line 87 of file solution_history.h.

Referenced by libMesh::SolutionHistory::set_overwrite_previously_stored().

stored_data

map_type libMesh::SolutionHistory::stored_data

protectedinherited

Definition at line 94 of file solution_history.h.

Referenced by libMesh::SolutionHistory::erase(), libMesh::SolutionHistory::find_stored_entry(), libMesh::MemorySolutionHistory::retrieve(), libMesh::FileSolutionHistory::retrieve(), libMesh::MemorySolutionHistory::store(), and libMesh::FileSolutionHistory::store().

stored_datum

stored_data_iterator libMesh::SolutionHistory::stored_datum

protectedinherited

Definition at line 96 of file solution_history.h.

Referenced by libMesh::SolutionHistory::erase(), libMesh::SolutionHistory::find_stored_entry(), libMesh::MemorySolutionHistory::retrieve(), libMesh::FileSolutionHistory::retrieve(), libMesh::MemorySolutionHistory::store(), and libMesh::FileSolutionHistory::store().

---

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

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