evolution::initial_data::InitialData Class Reference

The abstract base class for initial data of evolution systems. All analytic solutions and analytic data must virtually inherit from this class. More...

#include <InitialData.hpp>

Public Member Functions
virtual auto	get_clone () const -> std::unique_ptr< InitialData >=0
virtual const InitialData &	unwrap () const
	Unwrap wrapper types (e.g. WithNoise, which wraps analytic initial data and adds random noise) to reach the underlying analytic solution or data.

Detailed Description

The abstract base class for initial data of evolution systems. All analytic solutions and analytic data must virtually inherit from this class.

Member Function Documentation

unwrap()

virtual const InitialData & evolution::initial_data::InitialData::unwrap ( ) const

inlinevirtual

Unwrap wrapper types (e.g. WithNoise, which wraps analytic initial data and adds random noise) to reach the underlying analytic solution or data.

Most classes return *this. WithNoise overrides this to return its inner solution, allowing dispatch sites to transparently look through the wrapper without knowing about it explicitly.

Reimplemented in evolution::initial_data::WithNoise.

---

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

• src/PointwiseFunctions/InitialDataUtilities/InitialData.hpp