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 () override
	Virtual function store which we will be overriding. More...
virtual void	retrieve () 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	set_overwrite_previously_stored (bool val)
	Turn on overwrite_previously_stored to overwrite any already-saved data encountered during subsequent store() calls. More...

Protected Attributes
bool	overwrite_previously_stored

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 35 of file no_solution_history.h.

Constructor & Destructor Documentation

NoSolutionHistory()

libMesh::NoSolutionHistory::NoSolutionHistory ( )

inline

Constructor.

Definition at line 42 of file no_solution_history.h.

: SolutionHistory() {}

~NoSolutionHistory()

virtual libMesh::NoSolutionHistory::~NoSolutionHistory ( )

inlinevirtual

Destructor.

Definition at line 47 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 62 of file no_solution_history.h.

  {
    return libmesh_make_unique<NoSolutionHistory>();
  }

retrieve()

void libMesh::NoSolutionHistory::retrieve ( )

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 70 of file solution_history.h.

  { overwrite_previously_stored = val; }

References libMesh::SolutionHistory::overwrite_previously_stored.

store()

void libMesh::NoSolutionHistory::store ( )

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 77 of file solution_history.h.

Referenced by libMesh::SolutionHistory::set_overwrite_previously_stored(), and libMesh::MemorySolutionHistory::store().

---

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

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