Cantera  3.1.0a1
Loading...
Searching...
No Matches

Implements the cos() function. More...

#include <Func1.h>

Inheritance diagram for Cos1:
[legend]

Detailed Description

Implements the cos() function.

The functor class with type "cos" returns \( f(x) = \cos(\omega x) \), where the argument \( x \) is in radians.

Parameters
omegaFrequency \( \omega \) (default=1.0)

Definition at line 234 of file Func1.h.

Public Member Functions

 Cos1 (double omega=1.0)
 
 Cos1 (const vector< double > &params)
 Constructor uses single parameter (frequency)
 
string write (const string &arg) const override
 Write LaTeX string describing function.
 
string type () const override
 Returns a string describing the type of the function.
 
double eval (double t) const override
 Evaluate the function.
 
shared_ptr< Func1derivative () const override
 Creates a derivative to the current 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)=delete
 
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.
 
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.
 
shared_ptr< Func1func1_shared () const
 Accessor function for m_f1_shared.
 
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.
 

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ Cos1() [1/2]

Cos1 ( double  omega = 1.0)
inline

Definition at line 237 of file Func1.h.

◆ Cos1() [2/2]

Cos1 ( const vector< double > &  params)

Constructor uses single parameter (frequency)

Definition at line 102 of file Func1.cpp.

Member Function Documentation

◆ write()

string write ( const string &  arg) const
overridevirtual

Write LaTeX string describing function.

Reimplemented from Func1.

Definition at line 117 of file Func1.cpp.

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

◆ eval()

double eval ( double  t) const
inlineoverridevirtual

Evaluate the function.

Reimplemented from Func1.

Definition at line 250 of file Func1.h.

◆ derivative()

shared_ptr< Func1 > derivative ( ) const
overridevirtual

Creates a derivative to the current function.

Returns
shared pointer to new derivative function.
Since
Starting in Cantera 3.1, the return type is a shared_ptr.

Reimplemented from Func1.

Definition at line 111 of file Func1.cpp.


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