memory_solution_history.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2019 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner
 
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
 
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
 
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
 
#ifndef LIBMESH_MEMORY_SOLUTION_HISTORY_H
#define LIBMESH_MEMORY_SOLUTION_HISTORY_H
 
// Local includes
#include "libmesh/numeric_vector.h"
#include "libmesh/solution_history.h"
#include "libmesh/auto_ptr.h" // libmesh_make_unique
 
// C++ includes
#include <list>
 
namespace libMesh
{
 
class MemorySolutionHistory : public SolutionHistory
{
public:
 
  MemorySolutionHistory(System & system_) : stored_sols(stored_solutions.end()), _system(system_)
  { libmesh_experimental(); }
 
  ~MemorySolutionHistory();
 
  virtual void store() override;
 
  virtual void retrieve() override;
 
  typedef std::map<std::string, std::unique_ptr<NumericVector<Number>>> map_type;
  typedef std::list<std::pair<Real, map_type>> list_type;
  typedef list_type::iterator stored_solutions_iterator;
 
  virtual std::unique_ptr<SolutionHistory > clone() const override
  {
    return libmesh_make_unique<MemorySolutionHistory>(_system);
  }
 
private:
 
  // This list of pairs will hold the current time and stored vectors
  // from each timestep
  list_type stored_solutions;
 
  // The stored solutions iterator
  stored_solutions_iterator stored_sols;
 
  // A helper function to locate entries at a given time
  void find_stored_entry();
 
  // A system reference
  System & _system ;
};
 
} // end namespace libMesh
 
#endif // LIBMESH_MEMORY_SOLUTION_HISTORY_H