ScalarTensor::AnalyticData::ScalarField::Zero< Dim > Class Template Reference

Vanishing profile for the scalar field. More...

#include <Zero.hpp>

Public Types
using	options = tmpl::list<>
using	scalar_field_tags
Public Types inherited from ScalarTensor::AnalyticData::ScalarField::AnalyticData< Dim >
using	scalar_field_tags

Public Member Functions
	Zero (const Zero &)=default
Zero &	operator= (const Zero &)=default
	Zero (Zero &&)=default
Zero &	operator= (Zero &&)=default
std::unique_ptr< ScalarTensor::AnalyticData::ScalarField::AnalyticData< Dim > >	get_clone () const override
template<typename... RequestedTags>
tuples::TaggedTuple< RequestedTags... >	variables (const tnsr::I< DataVector, Dim > &x, tmpl::list< RequestedTags... >) const

Static Public Attributes
static constexpr Options::String	help

Friends
template<size_t SpatialDim>
bool	operator== (const Zero< SpatialDim > &, const Zero< SpatialDim > &)

Detailed Description

template<size_t Dim>
class ScalarTensor::AnalyticData::ScalarField::Zero< Dim >

Vanishing profile for the scalar field.

Member Typedef Documentation

scalar_field_tags

template<size_t Dim>

using ScalarTensor::AnalyticData::ScalarField::Zero< Dim >::scalar_field_tags

Initial value:

 
      typename ScalarTensor::AnalyticData::ScalarField::AnalyticData<
          Dim>::scalar_field_tags

Member Function Documentation

get_clone()

template<size_t Dim>

std::unique_ptr< ScalarTensor::AnalyticData::ScalarField::AnalyticData< Dim > > ScalarTensor::AnalyticData::ScalarField::Zero< Dim >::get_clone ( ) const

overridevirtual

Implements ScalarTensor::AnalyticData::ScalarField::AnalyticData< Dim >.

Member Data Documentation

help

template<size_t Dim>

Options::String ScalarTensor::AnalyticData::ScalarField::Zero< Dim >::help

staticconstexpr

Initial value:

{
      "The trivial solution, useful as initial guess."}

---

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

• src/PointwiseFunctions/AnalyticData/ScalarTensor/ScalarField/Zero.hpp