|
Cantera
3.0.0
|
Implements a Gaussian function. More...
#include <Func1.h>
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}) \).
| A | peak value |
| t0 | offset |
| fwhm | full width at half max |
Public Member Functions | |
| Gaussian1 (double A, double t0, double fwhm) | |
| Gaussian1 (const vector< double > ¶ms) | |
| Constructor uses 3 parameters in the following order: \( [A, t_0, \mathrm{fwhm}] \). | |
| Gaussian1 (const Gaussian1 &b) | |
| Gaussian1 & | operator= (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) | |
| Func1 & | operator= (const Func1 &right) |
| virtual Func1 & | duplicate () const |
| Duplicate the current function. | |
| virtual int | ID () const |
| 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 Func1 & | derivative () const |
| Creates a derivative to the current function. | |
| virtual shared_ptr< Func1 > | derivative3 () 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. | |
| Func1 & | func1 () const |
| accessor function for m_f1 | |
| shared_ptr< Func1 > | func1_shared () const |
| Accessor function for m_f1_shared. | |
| Func1 & | func2 () const |
| accessor function for m_f2 | |
| shared_ptr< Func1 > | func2_shared () const |
| Accessor function for m_f2_shared. | |
| virtual int | order () const |
| Return the order of the function, if it makes sense. | |
| Func1 & | func1_dup () const |
| Func1 & | func2_dup () const |
| Func1 * | parent () 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 |
| Func1 * | m_f1 = nullptr |
| Func1 * | m_f2 = nullptr |
| Func1 * | m_parent = nullptr |
| shared_ptr< Func1 > | m_f1_shared |
| shared_ptr< Func1 > | m_f2_shared |
| Gaussian1 | ( | const vector< double > & | params | ) |
|
inlineoverridevirtual |
|
inlineoverridevirtual |