Loading [MathJax]/extensions/tex2jax.js
Cantera  3.1.0
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages

Helper functions detect simplifications that can be made to compound expressions. More...

Collaboration diagram for Helper Functions:

Detailed Description

Helper functions detect simplifications that can be made to compound expressions.

Functions

shared_ptr< Func1newSumFunction (shared_ptr< Func1 > f1, shared_ptr< Func1 > f2)
 Sum of two functions.
 
shared_ptr< Func1newDiffFunction (shared_ptr< Func1 > f1, shared_ptr< Func1 > f2)
 Difference of two functions.
 
shared_ptr< Func1newProdFunction (shared_ptr< Func1 > f1, shared_ptr< Func1 > f2)
 Product of two functions.
 
shared_ptr< Func1newRatioFunction (shared_ptr< Func1 > f1, shared_ptr< Func1 > f2)
 Ratio of two functions.
 
shared_ptr< Func1newCompositeFunction (shared_ptr< Func1 > f1, shared_ptr< Func1 > f2)
 Composite of two functions.
 
shared_ptr< Func1newTimesConstFunction (shared_ptr< Func1 > f1, double c)
 Product of function and constant.
 
shared_ptr< Func1newPlusConstFunction (shared_ptr< Func1 > f1, double c)
 Sum of function and constant.
 
string checkFunc1 (const string &func1Type)
 Check definition of functor object.
 

Function Documentation

◆ newSumFunction()

shared_ptr< Func1 > newSumFunction ( shared_ptr< Func1 f1,
shared_ptr< Func1 f2 
)

Sum of two functions.

Definition at line 633 of file Func1.cpp.

◆ newDiffFunction()

shared_ptr< Func1 > newDiffFunction ( shared_ptr< Func1 f1,
shared_ptr< Func1 f2 
)

Difference of two functions.

Definition at line 660 of file Func1.cpp.

◆ newProdFunction()

shared_ptr< Func1 > newProdFunction ( shared_ptr< Func1 f1,
shared_ptr< Func1 f2 
)

Product of two functions.

Definition at line 684 of file Func1.cpp.

◆ newRatioFunction()

shared_ptr< Func1 > newRatioFunction ( shared_ptr< Func1 f1,
shared_ptr< Func1 f2 
)

Ratio of two functions.

Definition at line 737 of file Func1.cpp.

◆ newCompositeFunction()

shared_ptr< Func1 > newCompositeFunction ( shared_ptr< Func1 f1,
shared_ptr< Func1 f2 
)

Composite of two functions.

Definition at line 763 of file Func1.cpp.

◆ newTimesConstFunction()

shared_ptr< Func1 > newTimesConstFunction ( shared_ptr< Func1 f,
double  c 
)

Product of function and constant.

Definition at line 783 of file Func1.cpp.

◆ newPlusConstFunction()

shared_ptr< Func1 > newPlusConstFunction ( shared_ptr< Func1 f,
double  c 
)

Sum of function and constant.

Definition at line 797 of file Func1.cpp.

◆ checkFunc1()

string checkFunc1 ( const string &  func1Type)

Check definition of functor object.

Parameters
func1TypeString identifying functor type.
Returns
string indicating functor type: "undefined" if not defined; "standard" if Basic Functors or Advanced Functors (defined in Func1Factory); "compound" if Compound Functors (defined in Math1FactoryA); or "modified" if Modified Functors (defined in Math1FactoryB).

Not intended for use in external API's (Python, MATLAB, etc.).

Since
New in Cantera 3.1

Definition at line 171 of file Func1Factory.cpp.