Public Types | Public Member Functions | Static Public Attributes | List of all members
GeneralizedHarmonic::ConstraintDamping::DampingFunction< VolumeDim, Fr > Class Template Referenceabstract

Base class defining interface for constraint damping functions. More...

#include <DampingFunction.hpp>

Public Types

using creatable_classes = tmpl::list< GeneralizedHarmonic::ConstraintDamping::GaussianPlusConstant< VolumeDim, Fr > >
 
using frame = Fr
 

Public Member Functions

 WRAPPED_PUPable_abstract (DampingFunction)
 
 DampingFunction (const DampingFunction &)=default
 
DampingFunctionoperator= (const DampingFunction &)=default
 
 DampingFunction (DampingFunction &&) noexcept=default
 
DampingFunctionoperator= (DampingFunction &&) noexcept=default
 
virtual Scalar< double > operator() (const tnsr::I< double, VolumeDim, Fr > &x) const noexcept=0
 Returns the value of the function at the coordinate 'x'.
 
virtual Scalar< DataVectoroperator() (const tnsr::I< DataVector, VolumeDim, Fr > &x) const noexcept=0
 
virtual auto get_clone () const noexcept -> std::unique_ptr< DampingFunction< VolumeDim, Fr >>=0
 

Static Public Attributes

constexpr static size_t volume_dim = VolumeDim
 

Detailed Description

template<size_t VolumeDim, typename Fr>
class GeneralizedHarmonic::ConstraintDamping::DampingFunction< VolumeDim, Fr >

Base class defining interface for constraint damping functions.

Encodes a function \(R^n \to R\) where n is VolumeDim that represents a generalized-harmonic constraint-damping parameter (i.e., Gamma0, Gamma1, or Gamma2).


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