Cantera
Loading...
Searching...
No Matches

Implements the product of two functions. More...

#include <Func1.h>

Inheritance diagram for Product1:
[legend]

Detailed Description

Implements the product of two functions.

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

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

Definition at line 482 of file Func1.h.

Public Member Functions

 Product1 (shared_ptr< Func1 > f1, shared_ptr< Func1 > f2)
string type () const override
 Returns a string describing the type of the function.
string write (const string &arg) const override
 Write LaTeX string describing function.
double eval (double t) const override
 Evaluate the function.
shared_ptr< Func1 > derivative () const override
 Creates a derivative to the current 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)=delete
Func1 & operator= (const Func1 &right)=delete
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 bool isIdentical (shared_ptr< Func1 > other) const
 Routine to determine if two functions are the same.
double c () const
 Accessor function for the stored constant m_c.
shared_ptr< Func1 > func1_shared () const
 Accessor function for m_f1.
shared_ptr< Func1 > func2_shared () const
 Accessor function for m_f2.

Additional Inherited Members

Protected Attributes inherited from Func1
double m_c = 0.0
shared_ptr< Func1 > m_f1
shared_ptr< Func1 > m_f2

Constructor & Destructor Documentation

◆ Product1()

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

Definition at line 485 of file Func1.h.

Member Function Documentation

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

◆ write()

string write ( const string & arg) const
overridevirtual

Write LaTeX string describing function.

Reimplemented from Func1.

Definition at line 459 of file Func1.cpp.

◆ eval()

double eval ( double t) const
inlineoverridevirtual

Evaluate the function.

Reimplemented from Func1.

Definition at line 493 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 472 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 499 of file Func1.h.


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