SpECTRE  v2026.06.30
Loading...
Searching...
No Matches
ScalarTensor::AnalyticData::ScalarField::SuperposedInverser< Dim > Class Template Reference

Analytic profile for the scalar field composed by two superimposed \(\frac{A}{r}\) profiles. More...

#include <SuperposedInverser.hpp>

Classes

struct  AmplitudeA
struct  AmplitudeB
struct  LocationA
struct  LocationB

Public Types

using options = tmpl::list<AmplitudeA, AmplitudeB, LocationA, LocationB>
using scalar_field_tags
Public Types inherited from ScalarTensor::AnalyticData::ScalarField::AnalyticData< Dim >
using scalar_field_tags

Public Member Functions

 SuperposedInverser (const SuperposedInverser &)=default
SuperposedInverseroperator= (const SuperposedInverser &)=default
 SuperposedInverser (SuperposedInverser &&)=default
SuperposedInverseroperator= (SuperposedInverser &&)=default
 SuperposedInverser (double amplitude_a, double amplitude_b, std::array< double, Dim > location_a, std::array< double, Dim > location_b)
std::unique_ptr< ScalarTensor::AnalyticData::ScalarField::AnalyticData< Dim > > get_clone () const override
tuples::TaggedTuple<::CurvedScalarWave::Tags::Psivariables (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 SuperposedInverser< SpatialDim > &lhs, const SuperposedInverser< SpatialDim > &rhs)

Detailed Description

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

Analytic profile for the scalar field composed by two superimposed \(\frac{A}{r}\) profiles.

This profile is inteded to be used in binary black hole configurations, and describes the superposition of two \(\frac{A}{r}\) profiles, centered on the two black holes. The expression of the profile then reads

\begin{equation} \Psi(x^i) = \frac{A_a}{|x^i - x^i_a|} + \frac{A_b}{|x^i - x^i_b|}, \end{equation}

where \(\Psi\) is the scalar field, \(x_{a,b}\) are the coordinate locations of the centers of the two profiles and \(A_{a,b}\) are the amplitudes. 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::SuperposedInverser< Dim >::scalar_field_tags
Initial value:
Dim>::scalar_field_tags
Base struct representing the analytic profile for the scalar field in scalar-tensor theories.
Definition AnalyticData.hpp:26

Member Function Documentation

◆ get_clone()

Member Data Documentation

◆ help

template<size_t Dim>
Options::String ScalarTensor::AnalyticData::ScalarField::SuperposedInverser< Dim >::help
staticconstexpr
Initial value:
{
"Superposed 1/r intitial guesses for the scalar field in a black hole "
"binary system."}

The documentation for this class was generated from the following file:
  • src/PointwiseFunctions/AnalyticData/ScalarTensor/ScalarField/SuperposedInverser.hpp