Cantera 2.6.0
Public Member Functions | List of all members
Ratio1 Class Reference

Ratio of two functions. More...

#include <Func1.h>

Inheritance diagram for Ratio1:
[legend]
Collaboration diagram for Ratio1:
[legend]

Public Member Functions

 Ratio1 (Func1 &f1, Func1 &f2)
 
 Ratio1 (const Ratio1 &b)
 
Ratio1operator= (const Ratio1 &right)
 
virtual int ID () const
 
virtual doublereal eval (doublereal t) const
 Evaluate the function. More...
 
virtual Func1duplicate () const
 Duplicate the current function. More...
 
virtual Func1derivative () const
 Creates a derivative to the current function. More...
 
virtual std::string write (const std::string &arg) const
 
virtual int order () const
 Return the order of the function, if it makes sense. More...
 
- Public Member Functions inherited from Func1
 Func1 (const Func1 &right)
 
Func1operator= (const Func1 &right)
 
doublereal operator() (doublereal t) const
 Calls method eval to evaluate the function. More...
 
bool isIdentical (Func1 &other) const
 Routine to determine if two functions are the same. More...
 
virtual doublereal isProportional (TimesConstant1 &other)
 
virtual doublereal isProportional (Func1 &other)
 
doublereal c () const
 accessor function for the stored constant More...
 
void setC (doublereal c)
 Function to set the stored constant. More...
 
Func1func1 () const
 accessor function for m_f1 More...
 
Func1func2 () const
 accessor function for m_f2 More...
 
Func1func1_dup () const
 
Func1func2_dup () const
 
Func1parent () const
 
void setParent (Func1 *p)
 

Additional Inherited Members

- Protected Attributes inherited from Func1
doublereal m_c
 
Func1m_f1
 
Func1m_f2
 
Func1m_parent
 

Detailed Description

Ratio of two functions.

Definition at line 680 of file Func1.h.

Constructor & Destructor Documentation

◆ Ratio1() [1/2]

Ratio1 ( Func1 f1,
Func1 f2 
)
inline

Definition at line 683 of file Func1.h.

◆ ~Ratio1()

virtual ~Ratio1 ( )
inlinevirtual

Definition at line 691 of file Func1.h.

◆ Ratio1() [2/2]

Ratio1 ( const Ratio1 b)
inline

Definition at line 696 of file Func1.h.

Member Function Documentation

◆ operator=()

Ratio1 & operator= ( const Ratio1 right)
inline

Definition at line 701 of file Func1.h.

◆ ID()

virtual int ID ( ) const
inlinevirtual

Reimplemented from Func1.

Definition at line 714 of file Func1.h.

◆ eval()

virtual doublereal eval ( doublereal  t) const
inlinevirtual

Evaluate the function.

Reimplemented from Func1.

Definition at line 718 of file Func1.h.

References Func1::eval().

◆ duplicate()

virtual Func1 & duplicate ( ) const
inlinevirtual

Duplicate the current function.

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

Reimplemented from Func1.

Definition at line 722 of file Func1.h.

References Func1::duplicate().

◆ derivative()

virtual Func1 & derivative ( ) const
inlinevirtual

Creates a derivative to the current function.

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

Reimplemented from Func1.

Definition at line 728 of file Func1.h.

References Func1::derivative(), and Func1::duplicate().

◆ write()

string write ( const std::string &  arg) const
virtual

Reimplemented from Func1.

Definition at line 323 of file Func1.cpp.

◆ order()

virtual int order ( ) const
inlinevirtual

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

Reimplemented from Func1.

Definition at line 738 of file Func1.h.


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