MathFunctions::Gaussian Class Reference

Gaussian $f = A \exp\left(-\frac{(x-x_0)^2}{w^2}\right)$. More...

#include <Gaussian.hpp>

## Classes

struct  Amplitude

struct  Center

struct  Width

## Public Types

using options = tmpl::list< Amplitude, Width, Center >

Public Types inherited from MathFunction< 1 >
using creatable_classes = tmpl::list< MathFunctions::Gaussian, MathFunctions::PowX, MathFunctions::Sinusoid >

## Public Member Functions

WRAPPED_PUPable_decl_template (Gaussian)

Gaussian (CkMigrateMessage *) noexcept

Gaussian (double amplitude, double width, double center) noexcept

Gaussian (const Gaussian &)=delete

Gaussianoperator= (const Gaussian &)=delete

Gaussian (Gaussian &&) noexcept=default

Gaussianoperator= (Gaussian &&) noexcept=default

double operator() (const double &x) const noexcept override
Returns the function value at the coordinate 'x'.

DataVector operator() (const DataVector &x) const noexcept override
Returns the function value at the coordinate 'x'.

double first_deriv (const double &x) const noexcept override
Returns the first derivative at 'x'.

DataVector first_deriv (const DataVector &x) const noexcept override
Returns the first derivative at 'x'.

double second_deriv (const double &x) const noexcept override
Returns the second derivative at 'x'.

DataVector second_deriv (const DataVector &x) const noexcept override
Returns the second derivative at 'x'.

double third_deriv (const double &x) const noexcept override
Returns the third derivative at 'x'.

DataVector third_deriv (const DataVector &x) const noexcept override
Returns the third derivative at 'x'.

void pup (PUP::er &p) override

Public Member Functions inherited from MathFunction< 1 >
WRAPPED_PUPable_abstract (MathFunction)

MathFunction (const MathFunction &)=delete

MathFunctionoperator= (const MathFunction &)=delete

MathFunction (MathFunction &&) noexcept=default

MathFunctionoperator= (MathFunction &&) noexcept=default

## Static Public Attributes

static constexpr OptionString help

## Friends

bool operator== (const Gaussian &lhs, const Gaussian &rhs) noexcept

## Detailed Description

Gaussian $f = A \exp\left(-\frac{(x-x_0)^2}{w^2}\right)$.

### Details

Input file options are: Amplitude, Width, and Center

## ◆ help

 constexpr OptionString MathFunctions::Gaussian::help
static
Initial value:
= {
"Applies a Gaussian function to the input value"}

The documentation for this class was generated from the following files:
• src/PointwiseFunctions/MathFunctions/Gaussian.hpp
• src/PointwiseFunctions/MathFunctions/Gaussian.cpp