Cantera  3.1.0a1
Loading...
Searching...
No Matches
PlusConstant1 Class Reference

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

#include <Func1.h>

Inheritance diagram for PlusConstant1:
[legend]

Detailed Description

Implements the sum of a function and a constant.

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

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

Definition at line 627 of file Func1.h.

Public Member Functions

 PlusConstant1 (Func1 &f1, double a)
 
 PlusConstant1 (shared_ptr< Func1 > f1, double a)
 
string type () const override
 Returns a string describing the type of the function.
 
double eval (double t) const override
 Evaluate the function.
 
shared_ptr< Func1derivative () 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)=delete
 
Func1operator= (const Func1 &right)=delete
 
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 shared_ptr< Func1derivative () const
 Creates a derivative to the current function.
 
shared_ptr< Func1derivative3 () 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.
 
shared_ptr< Func1func1_shared () const
 Accessor function for m_f1_shared.
 
shared_ptr< Func1func2_shared () const
 Accessor function for m_f2_shared.
 
virtual int order () const
 Return the order of the function, if it makes sense.
 

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
 

Constructor & Destructor Documentation

◆ PlusConstant1() [1/2]

PlusConstant1 ( Func1 f1,
double  a 
)
inline

Definition at line 630 of file Func1.h.

◆ PlusConstant1() [2/2]

PlusConstant1 ( shared_ptr< Func1 f1,
double  a 
)
inline

Definition at line 635 of file Func1.h.

◆ ~PlusConstant1()

~PlusConstant1 ( )
inlineoverride

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

◆ eval()

double eval ( double  t) const
inlineoverridevirtual

Evaluate the function.

Reimplemented from Func1.

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

◆ write()

string write ( const string &  arg) const
overridevirtual

Write LaTeX string describing function.

Reimplemented from Func1.

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


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