Cantera  3.0.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
Fourier1 Class Reference
Numerical Utilities » Functor Objects » Advanced Functors

Implements a Fourier cosine/sine series. More...

#include <Func1.h>

Inheritance diagram for Fourier1:
[legend]

Detailed Description

Implements a Fourier cosine/sine series.

The functor class with type "Fourier" returns

\[ f(t) = \frac{A_0}{2} + \sum_{n=1}^N A_n \cos (n \omega t) + B_n \sin (n \omega t) \]

Definition at line 1225 of file Func1.h.

Public Member Functions

 Fourier1 (size_t n, double omega, double a0, const double *a, const double *b)
 
 Fourier1 (const vector< double > &params)
 Constructor uses \( 2 n + 2 \) parameters in the following order: \( [a_0, a_1, \dots, a_n, \omega, b_1, \dots, b_n] \).
 
 Fourier1 (const Fourier1 &b)
 
Fourier1 & operator= (const Fourier1 &right)
 
string type () const override
 Returns a string describing the type of the function.
 
Func1 & duplicate () const override
 Duplicate the current 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
 
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 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_omega
 
double m_a0_2
 
vector< double > m_ccos
 
vector< double > m_csin
 
- 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
 

Constructor & Destructor Documentation

◆ Fourier1() [1/3]

Fourier1 ( size_t  n,
double  omega,
double  a0,
const double *  a,
const double *  b 
)
inline

Definition at line 1228 of file Func1.h.

◆ Fourier1() [2/3]

Fourier1 ( const vector< double > &  params)

Constructor uses \( 2 n + 2 \) parameters in the following order: \( [a_0, a_1, \dots, a_n, \omega, b_1, \dots, b_n] \).

Definition at line 377 of file Func1.cpp.

◆ Fourier1() [3/3]

Fourier1 ( const Fourier1 &  b)
inline

Definition at line 1241 of file Func1.h.

Member Function Documentation

◆ operator=()

Fourier1 & operator= ( const Fourier1 &  right)
inline

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

◆ duplicate()

Func1 & duplicate ( ) const
overridevirtual

Duplicate the current function.

This duplicates the current function, returning a reference to the newly created function.

Deprecated:
To be removed after Cantera 3.0. Only used by deprecated methods.

Reimplemented from Func1.

Definition at line 597 of file Func1.cpp.

◆ eval()

double eval ( double  t) const
inlineoverridevirtual

Evaluate the function.

Reimplemented from Func1.

Definition at line 1265 of file Func1.h.

Member Data Documentation

◆ m_omega

double m_omega
protected

Definition at line 1277 of file Func1.h.

◆ m_a0_2

double m_a0_2
protected

Definition at line 1277 of file Func1.h.

◆ m_ccos

vector<double> m_ccos
protected

Definition at line 1278 of file Func1.h.

◆ m_csin

vector<double> m_csin
protected

Definition at line 1278 of file Func1.h.

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