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

A	peak value
t0	offset
fwhm	full width at half max

Since: New in Cantera 3.0.

Definition at line 765 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}] \). More...

string	type () const override
	Returns a string describing the type of the function. More...

double	eval (double t) const override
	Evaluate the function. More...

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)=delete

Func1 &	operator= (const Func1 &right)=delete

string	typeName () const
	Returns a string with the class name of the functor. More...

double	operator() (double t) const
	Calls method eval to evaluate the function. More...

virtual shared_ptr< Func1 >	derivative () const
	Creates a derivative to the current function. More...

shared_ptr< Func1 >	derivative3 () const
	Creates a derivative to the current function. More...

bool	isIdentical (Func1 &other) const
	Routine to determine if two functions are the same. More...

virtual double	isProportional (TimesConstant1 &other)

virtual double	isProportional (Func1 &other)

virtual string	write (const string &arg) const
	Write LaTeX string describing function. More...

double	c () const
	Accessor function for the stored constant. More...

shared_ptr< Func1 >	func1_shared () const
	Accessor function for m_f1_shared. More...

shared_ptr< Func1 >	func2_shared () const
	Accessor function for m_f2_shared. More...

virtual int	order () const
	Return the order of the function, if it makes sense. More...

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

shared_ptr< Func1 >	m_f1_shared

shared_ptr< Func1 >	m_f2_shared

Constructor & Destructor Documentation

◆ Gaussian1()

Gaussian1 ( const vector< double > & params )

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

Definition at line 245 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 778 of file Func1.h.

◆ eval()

double eval ( double t ) const

inlineoverridevirtual

Evaluate the function.

Reimplemented from Func1.

Definition at line 782 of file Func1.h.

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