SpECTRE  v2026.06.09.01
Loading...
Searching...
No Matches
CurvedScalarWave::Worldtube::OptionTags::SelfForceOptions Struct Reference

Options for the scalar self-force. Select None for a purely geodesic evolution. More...

#include <Tags.hpp>

Classes

struct  Iterations
struct  Mass
struct  TurnOnInterval
struct  TurnOnTime

Public Types

using group = Worldtube
using type = Options::Auto<SelfForceOptions, Options::AutoLabel::None>
using options = tmpl::list<Mass, Iterations, TurnOnTime, TurnOnInterval>

Public Member Functions

 SelfForceOptions (double mass_in, size_t iterations_in, double turn_on_time_in, double turn_on_interval_in)
void pup (PUP::er &p)

Public Attributes

double mass {}
size_t iterations {}
double turn_on_time {}
double turn_on_interval {}

Static Public Attributes

static constexpr Options::String help

Detailed Description

Options for the scalar self-force. Select None for a purely geodesic evolution.

Details

The self force is turned on using the smooth transition function

\begin{equation} w(t) = 1 - \exp{ \left(- \left(\frac{t - t_1}{\sigma} \right)^4 \right)}. \end{equation}

The turn on time is given by \(t_1\) and the turn on interval is given by \(sigma\).

Member Data Documentation

◆ help

Options::String CurvedScalarWave::Worldtube::OptionTags::SelfForceOptions::help
staticconstexpr
Initial value:
= {
"Options for the scalar self-force. Select `None` for a purely geodesic "
"evolution"}

The documentation for this struct was generated from the following file:
  • src/Evolution/Systems/CurvedScalarWave/Worldtube/Tags.hpp