SpECTRE  v2024.04.12
gh::gauges::Harmonic Class Referencefinal

Imposes the harmonic gauge condition, \(H_a=0\). More...

#include <Harmonic.hpp>

Public Types

using options = tmpl::list<>
 

Public Member Functions

 Harmonic (const Harmonic &)=default
 
Harmonicoperator= (const Harmonic &)=default
 
 Harmonic (Harmonic &&)=default
 
Harmonicoperator= (Harmonic &&)=default
 
template<size_t SpatialDim>
void gauge_and_spacetime_derivative (gsl::not_null< tnsr::a< DataVector, SpatialDim, Frame::Inertial > * > gauge_h, gsl::not_null< tnsr::ab< DataVector, SpatialDim, Frame::Inertial > * > d4_gauge_h, double time, const tnsr::I< DataVector, SpatialDim, Frame::Inertial > &inertial_coords) const
 
void pup (PUP::er &p) override
 
std::unique_ptr< GaugeConditionget_clone () const override
 
bool is_harmonic () const override
 
- Public Member Functions inherited from gh::gauges::GaugeCondition
 GaugeCondition (const GaugeCondition &)=default
 
GaugeConditionoperator= (const GaugeCondition &)=default
 
 GaugeCondition (GaugeCondition &&)=default
 
GaugeConditionoperator= (GaugeCondition &&)=default
 
 GaugeCondition (CkMigrateMessage *msg)
 
 WRAPPED_PUPable_abstract (GaugeCondition)
 
virtual std::unique_ptr< GaugeConditionget_clone () const =0
 
virtual bool is_harmonic () const
 

Static Public Attributes

static constexpr Options::String help
 

Detailed Description

Imposes the harmonic gauge condition, \(H_a=0\).

Member Function Documentation

◆ get_clone()

std::unique_ptr< GaugeCondition > gh::gauges::Harmonic::get_clone ( ) const
overridevirtual

◆ is_harmonic()

bool gh::gauges::Harmonic::is_harmonic ( ) const
overridevirtual

Reimplemented from gh::gauges::GaugeCondition.

Member Data Documentation

◆ help

constexpr Options::String gh::gauges::Harmonic::help
staticconstexpr
Initial value:
{
"Apply the Harmonic gauge condition H_a=0."}

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