Cantera  3.0.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Ratio1 Class Reference
Numerical Utilities » Functor Objects » Compound Functors

Implements the ratio of two functions. More...

#include <Func1.h>

Inheritance diagram for Ratio1:
[legend]

Detailed Description

Implements the ratio of two functions.

The functor class with type "ratio" returns \( f(x) = f_1(x) / f_2(x) \).

Parameters
f1Functor \( f_1(x) \)
f2Functor \( f_2(x) \)

Definition at line 948 of file Func1.h.

Public Member Functions

 Ratio1 (Func1 &f1, Func1 &f2)
 
 Ratio1 (shared_ptr< Func1 > f1, shared_ptr< Func1 > f2)
 
 Ratio1 (const Ratio1 &b)
 
Ratio1 & operator= (const Ratio1 &right)
 
int ID () const override
 
string type () const override
 Returns a string describing the type of the function.
 
double eval (double t) const override
 Evaluate the function.
 
Func1 & duplicate () const override
 Duplicate the current function.
 
Func1 & derivative () const override
 Creates a derivative to the current function.
 
shared_ptr< Func1 > derivative3 () const override
 Creates a derivative to the current function.
 
string write (const string &arg) const override
 Write LaTeX string describing function.
 
int order () const override
 Return the order of the function, if it makes sense.
 
- 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)
 

Additional Inherited Members

- 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

◆ Ratio1() [1/3]

Ratio1 ( Func1 &  f1,
Func1 &  f2 
)
inline

Definition at line 951 of file Func1.h.

◆ Ratio1() [2/3]

Ratio1 ( shared_ptr< Func1 >  f1,
shared_ptr< Func1 >  f2 
)
inline

Definition at line 958 of file Func1.h.

◆ ~Ratio1()

~Ratio1 ( )
inlineoverride

Definition at line 960 of file Func1.h.

◆ Ratio1() [3/3]

Ratio1 ( const Ratio1 &  b)
inline

Definition at line 969 of file Func1.h.

Member Function Documentation

◆ operator=()

Ratio1 & operator= ( const Ratio1 &  right)
inline

Definition at line 974 of file Func1.h.

◆ ID()

int ID ( ) const
inlineoverridevirtual
Deprecated:
To be removed after Cantera 3.0. Replaced by type.

Reimplemented from Func1.

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

◆ eval()

double eval ( double  t) const
inlineoverridevirtual

Evaluate the function.

Reimplemented from Func1.

Definition at line 994 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 667 of file Func1.cpp.

◆ derivative()

Func1 & derivative ( ) const
overridevirtual

Creates a derivative to the current function.

This will create a new derivative function and return a reference to the function.

Deprecated:
To be changed after Cantera 3.0; for new behavior, see derivative3.

Reimplemented from Func1.

Definition at line 675 of file Func1.cpp.

◆ derivative3()

shared_ptr< Func1 > derivative3 ( ) const
overridevirtual

Creates a derivative to the current function.

This will create a new derivative function

Returns
shared pointer to new derivative function.
Since
New in Cantera 3.0.

Reimplemented from Func1.

Definition at line 685 of file Func1.cpp.

◆ write()

string write ( const string &  arg) const
overridevirtual

Write LaTeX string describing function.

Reimplemented from Func1.

Definition at line 661 of file Func1.cpp.

◆ order()

int order ( ) const
inlineoverridevirtual

Return the order of the function, if it makes sense.

Reimplemented from Func1.

Definition at line 1005 of file Func1.h.

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