Cantera  3.1.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 677 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}] \).
 
string type () const override
 Returns a string describing the type of the function.
 
bool isIdentical (shared_ptr< Func1 > other) const override
 Routine to determine if two functions are the same.
 
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)
 
Func1operator= (const Func1 &right)=delete
 
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 shared_ptr< Func1derivative () const
 Creates a derivative to the current function.
 
virtual bool isIdentical (shared_ptr< Func1 > other) const
 Routine to determine if two functions are the same.
 
virtual 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 m_c.
 
shared_ptr< Func1func1_shared () const
 Accessor function for m_f1.
 
shared_ptr< Func1func2_shared () const
 Accessor function for m_f2.
 
virtual int order () const
 Return the order of the function, if it makes sense.
 

Protected Attributes

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

Constructor & Destructor Documentation

◆ Gaussian1() [1/2]

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

Definition at line 680 of file Func1.h.

◆ Gaussian1() [2/2]

Gaussian1 ( const vector< double > &  params)

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

Definition at line 288 of file Func1.cpp.

Member Function Documentation

◆ 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 690 of file Func1.h.

◆ isIdentical()

bool isIdentical ( shared_ptr< Func1 other) const
inlineoverridevirtual

Routine to determine if two functions are the same.

Two functions are the same if they are the same function. For example, either ID and stored constant are the same, or the m_f1 and m_f2 are identical if they are non-null. Functors of the base class Func1 are by default not identical, as they are used by callback functions that cannot be differentiated. In instances where exact comparisons are not implemented, false is returned to prevent false positives that could lead to incorrect simplifications of compound functors.

Reimplemented from Func1.

Definition at line 694 of file Func1.h.

◆ eval()

double eval ( double  t) const
inlineoverridevirtual

Evaluate the function.

Reimplemented from Func1.

Definition at line 698 of file Func1.h.

Member Data Documentation

◆ m_A

double m_A
protected

Definition at line 704 of file Func1.h.

◆ m_t0

double m_t0
protected

Definition at line 704 of file Func1.h.

◆ m_tau

double m_tau
protected

Definition at line 704 of file Func1.h.


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