ConstraintDamping::Constant< VolumeDim, Fr > Class Template Reference

A constant function: \(f = C\). More...

#include <Constant.hpp>

Classes
struct	Value

Public Types
using	options = tmpl::list< Value >
Public Types inherited from ConstraintDamping::DampingFunction< VolumeDim, Fr >
using	creatable_classes = tmpl::conditional_t<(VolumeDim==3 and std::is_same< Fr, Frame::Grid >::value), tmpl::list< ConstraintDamping::Constant< VolumeDim, Fr >, ConstraintDamping::GaussianPlusConstant< VolumeDim, Fr >, ConstraintDamping::TimeDependentTripleGaussian >, tmpl::list< ConstraintDamping::GaussianPlusConstant< VolumeDim, Fr >, ConstraintDamping::Constant< VolumeDim, Fr > > >
using	frame = Fr

Public Member Functions
	Constant (double value)
	Constant (const Constant &)=default
Constant &	operator= (const Constant &)=default
	Constant (Constant &&)=default
Constant &	operator= (Constant &&)=default
void	operator() (gsl::not_null< Scalar< double > * > value_at_x, const tnsr::I< double, VolumeDim, Fr > &x, double time, const std::unordered_map< std::string, std::unique_ptr<::domain::FunctionsOfTime::FunctionOfTime > > &functions_of_time) const override
void	operator() (gsl::not_null< Scalar< DataVector > * > value_at_x, const tnsr::I< DataVector, VolumeDim, Fr > &x, double time, const std::unordered_map< std::string, std::unique_ptr<::domain::FunctionsOfTime::FunctionOfTime > > &functions_of_time) const override
auto	get_clone () const -> std::unique_ptr< DampingFunction< VolumeDim, Fr > > override
void	pup (PUP::er &p) override
Public Member Functions inherited from ConstraintDamping::DampingFunction< VolumeDim, Fr >
	WRAPPED_PUPable_abstract (DampingFunction)
	DampingFunction (const DampingFunction &)=default
DampingFunction &	operator= (const DampingFunction &)=default
	DampingFunction (DampingFunction &&)=default
DampingFunction &	operator= (DampingFunction &&)=default
	DampingFunction (CkMigrateMessage *msg)
virtual auto	get_clone () const -> std::unique_ptr< DampingFunction< VolumeDim, Fr > >=0
virtual void	operator() (const gsl::not_null< Scalar< double > * > value_at_x, const tnsr::I< double, VolumeDim, Fr > &x, double time, const std::unordered_map< std::string, std::unique_ptr<::domain::FunctionsOfTime::FunctionOfTime > > &functions_of_time) const =0
	Returns the value of the function at the coordinate 'x'.
virtual void	operator() (const gsl::not_null< Scalar< DataVector > * > value_at_x, const tnsr::I< DataVector, VolumeDim, Fr > &x, double time, const std::unordered_map< std::string, std::unique_ptr<::domain::FunctionsOfTime::FunctionOfTime > > &functions_of_time) const =0
	Returns the value of the function at the coordinate 'x'.

Static Public Attributes
static constexpr Options::String	help = {"Returns a constant value"}
Static Public Attributes inherited from ConstraintDamping::DampingFunction< VolumeDim, Fr >
static constexpr size_t	volume_dim = VolumeDim

Friends
bool	operator== (const Constant &lhs, const Constant &rhs)

Detailed Description

template<size_t VolumeDim, typename Fr>
class ConstraintDamping::Constant< VolumeDim, Fr >

A constant function: \(f = C\).

Details

Input file options are: Value \(C\). The function takes input coordinates of type tnsr::I<T, VolumeDim, Fr>, where T is e.g. double or DataVector, Fr is a frame (e.g. Frame::Inertial), and VolumeDim is the dimension of the spatial volume.

Member Function Documentation

get_clone()

template<size_t VolumeDim, typename Fr >

auto ConstraintDamping::Constant< VolumeDim, Fr >::get_clone ( ) const -> std::unique_ptr< DampingFunction< VolumeDim, Fr > >

overridevirtual

Implements ConstraintDamping::DampingFunction< VolumeDim, Fr >.

---

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

• src/PointwiseFunctions/ConstraintDamping/Constant.hpp