SpECTRE  v2026.09.05
Loading...
Searching...
No Matches
gh::Solutions::WrappedGr< SolutionType > Class Template Reference

A wrapper for general-relativity analytic solutions that loads the analytic solution and then adds a function that returns any combination of the generalized-harmonic evolution variables, specifically gr::Tags::SpacetimeMetric, gh::Tags::Pi, and gh::Tags::Phi More...

#include <WrappedGr.hpp>

Public Types

using options = typename SolutionType::options
using DerivLapse
using DerivShift
using DerivSpatialMetric
using TimeDerivLapse = ::Tags::dt<gr::Tags::Lapse<DataVector>>
using TimeDerivShift = ::Tags::dt<gr::Tags::Shift<DataVector, volume_dim>>
using TimeDerivSpatialMetric
using IntermediateVars
template<typename DataType>
using tags

Public Member Functions

 WrappedGr (const WrappedGr &)=default
WrappedGr & operator= (const WrappedGr &)=default
 WrappedGr (WrappedGr &&)=default
WrappedGr & operator= (WrappedGr &&)=default
 WrappedGr (const SolutionType &wrapped_solution)
auto get_clone () const -> std::unique_ptr< evolution::initial_data::InitialData > override
template<typename... Tags>
tuples::TaggedTuple< Tags... > variables (const tnsr::I< DataVector, volume_dim > &x, double t, tmpl::list< Tags... >) const
template<typename Tag>
tuples::TaggedTuple< Tag > variables (const tnsr::I< DataVector, volume_dim > &x, double t, tmpl::list< Tag >) const
template<typename... Tags>
tuples::TaggedTuple< Tags... > variables (const tnsr::I< DataVector, volume_dim > &x, tmpl::list< Tags... >) const
template<typename Tag>
tuples::TaggedTuple< Tag > variables (const tnsr::I< DataVector, volume_dim > &x, tmpl::list< Tag >) const
void pup (PUP::er &p) override
Public Member Functions inherited from evolution::initial_data::InitialData
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.

Static Public Member Functions

static std::string name ()

Static Public Attributes

static constexpr size_t volume_dim = SolutionType::volume_dim
static constexpr Options::String help = SolutionType::help

Detailed Description

template<typename SolutionType>
class gh::Solutions::WrappedGr< SolutionType >

A wrapper for general-relativity analytic solutions that loads the analytic solution and then adds a function that returns any combination of the generalized-harmonic evolution variables, specifically gr::Tags::SpacetimeMetric, gh::Tags::Pi, and gh::Tags::Phi

Member Typedef Documentation

◆ DerivLapse

template<typename SolutionType>
using gh::Solutions::WrappedGr< SolutionType >::DerivLapse
Initial value:
tmpl::size_t<volume_dim>, Frame::Inertial>
Definition IndexType.hpp:46
Prefix indicating spatial derivatives.
Definition Prefixes.hpp:47

◆ DerivShift

template<typename SolutionType>
using gh::Solutions::WrappedGr< SolutionType >::DerivShift
Initial value:

◆ DerivSpatialMetric

template<typename SolutionType>
using gh::Solutions::WrappedGr< SolutionType >::DerivSpatialMetric

◆ IntermediateVars

template<typename SolutionType>
using gh::Solutions::WrappedGr< SolutionType >::IntermediateVars
Initial value:
tuples::tagged_tuple_from_typelist<
typename SolutionType::template tags<DataVector>>

◆ tags

template<typename SolutionType>
template<typename DataType>
using gh::Solutions::WrappedGr< SolutionType >::tags
Initial value:
tmpl::push_back<typename SolutionType::template tags<DataType>,
Auxiliary variable which is analytically the spatial derivative of the spacetime metric.
Definition Tags.hpp:38
Conjugate momentum to the spacetime metric.
Definition Tags.hpp:27
Definition Tags.hpp:16

◆ TimeDerivSpatialMetric

template<typename SolutionType>
using gh::Solutions::WrappedGr< SolutionType >::TimeDerivSpatialMetric
Initial value:
Prefix indicating a time derivative.
Definition Prefixes.hpp:29

Member Function Documentation

◆ get_clone()

template<typename SolutionType>
auto gh::Solutions::WrappedGr< SolutionType >::get_clone ( ) const -> std::unique_ptr< evolution::initial_data::InitialData >
overridevirtual

The documentation for this class was generated from the following file:
  • src/PointwiseFunctions/AnalyticSolutions/GeneralRelativity/WrappedGr.hpp