gh::gauges::DampedHarmonic Class Reference

Impose damped harmonic gauge. More...

#include <DampedHarmonic.hpp>

Classes
struct	Amplitudes
	The amplitudes for the L1, L2, and S terms, respectively, for the damped harmonic gauge. More...
struct	Exponents
	The exponents for the L1, L2, and S terms, respectively, for the damped harmonic gauge. More...
struct	SpatialDecayWidth
	The width of the Gaussian for the spatial decay of the damped harmonic gauge. More...

Public Types
using	options = tmpl::list<SpatialDecayWidth, Amplitudes, Exponents>

Public Member Functions
	DampedHarmonic (double width, const std::array< double, 3 > &amps, const std::array< int, 3 > &exps)
	DampedHarmonic (const DampedHarmonic &)=default
DampedHarmonic &	operator= (const DampedHarmonic &)=default
	DampedHarmonic (DampedHarmonic &&)=default
DampedHarmonic &	operator= (DampedHarmonic &&)=default
std::unique_ptr< GaugeCondition >	get_clone () const override
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, const Scalar< DataVector > &lapse, const tnsr::I< DataVector, SpatialDim, Frame::Inertial > &shift, const Scalar< DataVector > &sqrt_det_spatial_metric, const tnsr::II< DataVector, SpatialDim, Frame::Inertial > &inverse_spatial_metric, const tnsr::abb< DataVector, SpatialDim, Frame::Inertial > &d4_spacetime_metric, const Scalar< DataVector > &half_pi_two_normals, const tnsr::i< DataVector, SpatialDim, Frame::Inertial > &half_phi_two_normals, const tnsr::aa< DataVector, SpatialDim, Frame::Inertial > &spacetime_metric, const tnsr::iaa< DataVector, SpatialDim, Frame::Inertial > &phi, double time, const tnsr::I< DataVector, SpatialDim, Frame::Inertial > &inertial_coords) const
void	pup (PUP::er &p) override
Public Member Functions inherited from gh::gauges::GaugeCondition
	GaugeCondition (const GaugeCondition &)=default
GaugeCondition &	operator= (const GaugeCondition &)=default
	GaugeCondition (GaugeCondition &&)=default
GaugeCondition &	operator= (GaugeCondition &&)=default
	GaugeCondition (CkMigrateMessage *msg)
	WRAPPED_PUPable_abstract (GaugeCondition)
virtual bool	is_harmonic () const

Static Public Attributes
static constexpr Options::String	help

Detailed Description

Impose damped harmonic gauge.

See also

damped_harmonic()

Member Function Documentation

get_clone()

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

overridevirtual

Implements gh::gauges::GaugeCondition.

Member Data Documentation

help

Options::String gh::gauges::DampedHarmonic::help

staticconstexpr

Initial value:

{
      "Apply damped harmonic/damped wave gauge."}

---

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

• src/Evolution/Systems/GeneralizedHarmonic/GaugeSourceFunctions/DampedHarmonic.hpp