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

\(\frac{A}{r}\) profile for the scalar field. More...

#include <Inverser.hpp>

Classes
struct	Amplitude

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

Public Member Functions
	Inverser (const Inverser &)=default
Inverser &	operator= (const Inverser &)=default
	Inverser (Inverser &&)=default
Inverser &	operator= (Inverser &&)=default
	Inverser (double amplitude)
std::unique_ptr< ScalarTensor::AnalyticData::ScalarField::AnalyticData< Dim > >	get_clone () const override
tuples::TaggedTuple<::CurvedScalarWave::Tags::Psi >	variables (const tnsr::I< DataVector, Dim > &x, tmpl::list<::CurvedScalarWave::Tags::Psi >) const
tuples::TaggedTuple<::CurvedScalarWave::Tags::Phi< Dim, Frame::Inertial > >	variables (const tnsr::I< DataVector, Dim > &x, tmpl::list<::CurvedScalarWave::Tags::Phi< Dim, Frame::Inertial > >) const
template<typename... RequestedTags>
tuples::TaggedTuple< RequestedTags... >	variables (const tnsr::I< DataVector, Dim > &x, tmpl::list< RequestedTags... >) const
void	pup (PUP::er &p) override

Static Public Attributes
static constexpr Options::String	help

Friends
template<size_t SpatialDim>
bool	operator== (const Inverser< SpatialDim > &lhs, const Inverser< SpatialDim > &rhs)

Detailed Description

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

\(\frac{A}{r}\) profile for the scalar field.

The expression of the profile as a function of the coordinates reads

\begin{equation} \Psi(x^i) = \frac{A}{|x^i - x^i_0|}, \end{equation}

where \(\Psi\) is the scalar field, \(x^i_0 = (0, 0, 0)\) is the coordinate location of the center of the profile and \(A\) is the amplitude. Note that the norm for the distance is computed using the eucledian metric.

Member Typedef Documentation

scalar_field_tags

template<size_t Dim>

using ScalarTensor::AnalyticData::ScalarField::Inverser< 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::Inverser< Dim >::get_clone ( ) const

overridevirtual

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

Member Data Documentation

help

template<size_t Dim>

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

staticconstexpr

Initial value:

{
      "A/r profile for initial guess of the scalar field."}

---

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

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