Cantera  3.0.0
Loading...
Searching...
No Matches

Implements a Gaussian function. More...

#include <Func1.h>

Inheritance diagram for Gaussian1:
[legend]

Detailed Description

Implements a Gaussian function.

The functor class with type "Gaussian" returns

\[ f(t) = A e^{-[(t - t_0)/\tau]^2} \]

where \( \tau = \mathrm{fwhm} / (2 \sqrt{\ln 2}) \).

Parameters
Apeak value
t0offset
fwhmfull width at half max
Since
New in Cantera 3.0.

Definition at line 1095 of file Func1.h.

Public Member Functions

 Gaussian1 (double A, double t0, double fwhm)
 
 Gaussian1 (const vector< double > &params)
 Constructor uses 3 parameters in the following order: \( [A, t_0, \mathrm{fwhm}] \).
 
 Gaussian1 (const Gaussian1 &b)
 
Gaussian1operator= (const Gaussian1 &right)
 
string type () const override
 Returns a string describing the type of the function.
 
double eval (double t) const override
 Evaluate the function.
 
- Public Member Functions inherited from Func1
 Func1 (shared_ptr< Func1 > f1, shared_ptr< Func1 > f2)
 
 Func1 (shared_ptr< Func1 > f1, double A)
 
 Func1 (const Func1 &right)
 
Func1operator= (const Func1 &right)
 
virtual Func1duplicate () const
 Duplicate the current function.
 
virtual int ID () const
 
virtual string type () const
 Returns a string describing the type of the function.
 
string typeName () const
 Returns a string with the class name of the functor.
 
double operator() (double t) const
 Calls method eval to evaluate the function.
 
virtual double eval (double t) const
 Evaluate the function.
 
virtual Func1derivative () const
 Creates a derivative to the current function.
 
virtual shared_ptr< Func1derivative3 () const
 Creates a derivative to the current function.
 
bool isIdentical (Func1 &other) const
 Routine to determine if two functions are the same.
 
virtual double isProportional (TimesConstant1 &other)
 
virtual double isProportional (Func1 &other)
 
virtual string write (const string &arg) const
 Write LaTeX string describing function.
 
double c () const
 Accessor function for the stored constant.
 
void setC (double c)
 Function to set the stored constant.
 
Func1func1 () const
 accessor function for m_f1
 
shared_ptr< Func1func1_shared () const
 Accessor function for m_f1_shared.
 
Func1func2 () const
 accessor function for m_f2
 
shared_ptr< Func1func2_shared () const
 Accessor function for m_f2_shared.
 
virtual int order () const
 Return the order of the function, if it makes sense.
 
Func1func1_dup () const
 
Func1func2_dup () const
 
Func1parent () const
 
void setParent (Func1 *p)
 

Protected Attributes

double m_A
 
double m_t0
 
double m_tau
 
- Protected Attributes inherited from Func1
double m_c = 0.0
 
Func1m_f1 = nullptr
 
Func1m_f2 = nullptr
 
Func1m_parent = nullptr
 
shared_ptr< Func1m_f1_shared
 
shared_ptr< Func1m_f2_shared
 

Constructor & Destructor Documentation

◆ Gaussian1() [1/3]

Gaussian1 ( double  A,
double  t0,
double  fwhm 
)
inline

Definition at line 1098 of file Func1.h.

◆ Gaussian1() [2/3]

Gaussian1 ( const vector< double > &  params)

Constructor uses 3 parameters in the following order: \( [A, t_0, \mathrm{fwhm}] \).

Definition at line 396 of file Func1.cpp.

◆ Gaussian1() [3/3]

Gaussian1 ( const Gaussian1 b)
inline

Definition at line 1108 of file Func1.h.

Member Function Documentation

◆ operator=()

Gaussian1 & operator= ( const Gaussian1 right)
inline

Definition at line 1113 of file Func1.h.

◆ type()

string type ( ) const
inlineoverridevirtual

Returns a string describing the type of the function.

Since
New in Cantera 3.0.

Reimplemented from Func1.

Definition at line 1125 of file Func1.h.

◆ eval()

double eval ( double  t) const
inlineoverridevirtual

Evaluate the function.

Reimplemented from Func1.

Definition at line 1129 of file Func1.h.

Member Data Documentation

◆ m_A

double m_A
protected

Definition at line 1135 of file Func1.h.

◆ m_t0

double m_t0
protected

Definition at line 1135 of file Func1.h.

◆ m_tau

double m_tau
protected

Definition at line 1135 of file Func1.h.


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