Classes | Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
MathFunctions::Sinusoid Class Reference

Sinusoid \(f = A \sin\left(k x + \delta \right)\). More...

#include <Sinusoid.hpp>

Classes

struct  Amplitude
 
struct  Phase
 
struct  Wavenumber
 

Public Types

using options = tmpl::list< Amplitude, Wavenumber, Phase >
 
- Public Types inherited from MathFunction< 1 >
using creatable_classes = tmpl::list< MathFunctions::Gaussian, MathFunctions::PowX, MathFunctions::Sinusoid >
 

Public Member Functions

 Sinusoid (double amplitude, double wavenumber, double phase) noexcept
 
 Sinusoid (const Sinusoid &)=delete
 
Sinusoidoperator= (const Sinusoid &)=delete
 
 Sinusoid (Sinusoid &&) noexcept=default
 
Sinusoidoperator= (Sinusoid &&) noexcept=default
 
 WRAPPED_PUPable_decl_template (Sinusoid)
 
 Sinusoid (CkMigrateMessage *) noexcept
 
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 Sinusoid &lhs, const Sinusoid &rhs) noexcept
 

Detailed Description

Sinusoid \(f = A \sin\left(k x + \delta \right)\).

Details

Input file options are: Amplitude, Phase, and Wavenumber

Member Data Documentation

◆ help

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

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