Cantera  3.1.0a1
TimesConstant1 Class Reference

Implements the product of a function and a constant. More...

#include <Func1.h>

Inheritance diagram for TimesConstant1:
[legend]

Detailed Description

Implements the product of a function and a constant.

The functor class with type "times-constant" returns \( f(x) = a f_1(x) \).

Parameters
f1Functor \( f_1(x) \)
aConstant \( a \)

Definition at line 569 of file Func1.h.

Public Member Functions

 TimesConstant1 (Func1 &f1, double a)
 
 TimesConstant1 (shared_ptr< Func1 > f1, double a)
 
string type () const override
 Returns a string describing the type of the function. More...
 
double isProportional (TimesConstant1 &other) override
 
double isProportional (Func1 &other) override
 
double eval (double t) const override
 Evaluate the function. More...
 
shared_ptr< Func1derivative () const override
 Creates a derivative to the current function. More...
 
string write (const string &arg) const override
 Write LaTeX string describing function. More...
 
int order () const override
 Return the order of the function, if it makes sense. More...
 
- 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
 
string typeName () const
 Returns a string with the class name of the functor. More...
 
double operator() (double t) const
 Calls method eval to evaluate the function. More...
 
shared_ptr< Func1derivative3 () const
 Creates a derivative to the current function. More...
 
bool isIdentical (Func1 &other) const
 Routine to determine if two functions are the same. More...
 
double c () const
 Accessor function for the stored constant. More...
 
shared_ptr< Func1func1_shared () const
 Accessor function for m_f1_shared. More...
 
shared_ptr< Func1func2_shared () const
 Accessor function for m_f2_shared. More...
 

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
 

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

◆ eval()

double eval ( double  t) const
inlineoverridevirtual

Evaluate the function.

Reimplemented from Func1.

Definition at line 605 of file Func1.h.

◆ derivative()

shared_ptr<Func1> derivative ( ) const
inlineoverridevirtual

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

◆ write()

string write ( const string &  arg) const
overridevirtual

Write LaTeX string describing function.

Reimplemented from Func1.

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


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