libMesh
solution_history.h
Go to the documentation of this file.
1 // The libMesh Finite Element Library.
2 // Copyright (C) 2002-2017 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner
3 
4 // This library is free software; you can redistribute it and/or
5 // modify it under the terms of the GNU Lesser General Public
6 // License as published by the Free Software Foundation; either
7 // version 2.1 of the License, or (at your option) any later version.
8 
9 // This library is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 // Lesser General Public License for more details.
13 
14 // You should have received a copy of the GNU Lesser General Public
15 // License along with this library; if not, write to the Free Software
16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 
18 #ifndef LIBMESH_SOLUTION_HISTORY_H
19 #define LIBMESH_SOLUTION_HISTORY_H
20 
21 // Local Includes
22 #include "libmesh/system.h"
23 
24 namespace libMesh
25 {
26 
36 {
37 public:
38 
44 
48  virtual ~SolutionHistory () {}
49 
53  virtual void store() = 0;
54 
58  virtual void retrieve() = 0;
59 
64  virtual UniquePtr<SolutionHistory > clone() const = 0;
65 
72 
73 protected:
74 
75  // Flag to specify whether we want to overwrite previously stored
76  // vectors at a given time or not
78 };
79 
80 } // end namespace libMesh
81 
82 #endif // LIBMESH_SOLUTION_HISTORY_H
virtual UniquePtr< SolutionHistory > clone() const =0
Cloning function for a UniquePtr, pure virtual, used in the setter function in time_solver.C.
void set_overwrite_previously_stored(bool val)
Turn on overwrite_previously_stored to overwrite any already-saved data encountered during subsequent...
SolutionHistory()
Constructor.
virtual ~SolutionHistory()
Destructor.
The libMesh namespace provides an interface to certain functionality in the library.
A SolutionHistory class that enables the storage and retrieval of timesteps and (in the future) adapt...
std::unique_ptr< T > UniquePtr
Definition: auto_ptr.h:46
virtual void store()=0
Function to store a solution, pure virtual.
virtual void retrieve()=0
Function to retrieve a solution, pure virtual.