Cantera  3.0.0
Loading...
Searching...
No Matches

Implements the sum of two functions. More...

#include <Func1.h>

Inheritance diagram for Sum1:
[legend]

Detailed Description

Implements the sum of two functions.

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

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

Definition at line 588 of file Func1.h.

Public Member Functions

 Sum1 (Func1 &f1, Func1 &f2)
 
 Sum1 (shared_ptr< Func1 > f1, shared_ptr< Func1 > f2)
 
 Sum1 (const Sum1 &b)
 
Sum1operator= (const Sum1 &right)
 
int ID () const override
 
string type () const override
 Returns a string describing the type of the function.
 
double eval (double t) const override
 Evaluate the function.
 
Func1duplicate () const override
 Duplicate the current function.
 
Func1derivative () const override
 Creates a derivative to the current function.
 
shared_ptr< Func1derivative3 () const override
 Creates a derivative to the current function.
 
int order () const override
 Return the order of the function, if it makes sense.
 
string write (const string &arg) const override
 Write LaTeX string describing function.
 
- 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)
 
Func1operator= (const Func1 &right)
 
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.
 
bool isIdentical (Func1 &other) const
 Routine to determine if two functions are the same.
 
virtual double isProportional (TimesConstant1 &other)
 
virtual double isProportional (Func1 &other)
 
double c () const
 Accessor function for the stored constant.
 
void setC (double c)
 Function to set the stored constant.
 
Func1func1 () const
 accessor function for m_f1
 
shared_ptr< Func1func1_shared () const
 Accessor function for m_f1_shared.
 
Func1func2 () const
 accessor function for m_f2
 
shared_ptr< Func1func2_shared () const
 Accessor function for m_f2_shared.
 
Func1func1_dup () const
 
Func1func2_dup () const
 
Func1parent () const
 
void setParent (Func1 *p)
 

Additional Inherited Members

- Protected Attributes inherited from Func1
double m_c = 0.0
 
Func1m_f1 = nullptr
 
Func1m_f2 = nullptr
 
Func1m_parent = nullptr
 
shared_ptr< Func1m_f1_shared
 
shared_ptr< Func1m_f2_shared
 

Constructor & Destructor Documentation

◆ Sum1() [1/3]

Sum1 ( Func1 f1,
Func1 f2 
)
inline

Definition at line 591 of file Func1.h.

◆ Sum1() [2/3]

Sum1 ( shared_ptr< Func1 f1,
shared_ptr< Func1 f2 
)
inline

Definition at line 598 of file Func1.h.

◆ ~Sum1()

~Sum1 ( )
inlineoverride

Definition at line 600 of file Func1.h.

◆ Sum1() [3/3]

Sum1 ( const Sum1 b)
inline

Definition at line 609 of file Func1.h.

Member Function Documentation

◆ operator=()

Sum1 & operator= ( const Sum1 right)
inline

Definition at line 614 of file Func1.h.

◆ ID()

int ID ( ) const
inlineoverridevirtual
Deprecated:
To be removed after Cantera 3.0. Replaced by type.

Reimplemented from Func1.

Definition at line 627 of file Func1.h.

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

◆ eval()

double eval ( double  t) const
inlineoverridevirtual

Evaluate the function.

Reimplemented from Func1.

Definition at line 634 of file Func1.h.

◆ duplicate()

Func1 & duplicate ( ) const
overridevirtual

Duplicate the current function.

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

Deprecated:
To be removed after Cantera 3.0. Only used by deprecated methods.

Reimplemented from Func1.

Definition at line 739 of file Func1.cpp.

◆ derivative()

Func1 & derivative ( ) const
overridevirtual

Creates a derivative to the current function.

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

Deprecated:
To be changed after Cantera 3.0; for new behavior, see derivative3.

Reimplemented from Func1.

Definition at line 747 of file Func1.cpp.

◆ derivative3()

shared_ptr< Func1 > derivative3 ( ) const
inlineoverridevirtual

Creates a derivative to the current function.

This will create a new derivative function

Returns
shared pointer to new derivative function.
Since
New in Cantera 3.0.

Reimplemented from Func1.

Definition at line 641 of file Func1.h.

◆ order()

int order ( ) const
inlineoverridevirtual

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

Reimplemented from Func1.

Definition at line 645 of file Func1.h.

◆ write()

string write ( const string &  arg) const
overridevirtual

Write LaTeX string describing function.

Reimplemented from Func1.

Definition at line 728 of file Func1.cpp.


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