Cantera 2.6.0
Public Member Functions | List of all members
Const1 Class Reference

The Const1 class implements a constant. More...

#include <Func1.h>

Inheritance diagram for Const1:
[legend]
Collaboration diagram for Const1:
[legend]

Public Member Functions

 Const1 (double A)
 Constructor. More...
 
 Const1 (const Const1 &b)
 
Const1operator= (const Const1 &right)
 
virtual std::string write (const std::string &arg) const
 
virtual int ID () const
 
virtual doublereal eval (doublereal t) const
 Evaluate the function. More...
 
virtual Func1duplicate () const
 Duplicate the current function. More...
 
virtual Func1derivative () const
 Creates a derivative to the current function. More...
 
- Public Member Functions inherited from Func1
 Func1 (const Func1 &right)
 
Func1operator= (const Func1 &right)
 
doublereal operator() (doublereal t) const
 Calls method eval to evaluate the function. More...
 
bool isIdentical (Func1 &other) const
 Routine to determine if two functions are the same. More...
 
virtual doublereal isProportional (TimesConstant1 &other)
 
virtual doublereal isProportional (Func1 &other)
 
doublereal c () const
 accessor function for the stored constant More...
 
void setC (doublereal c)
 Function to set the stored constant. More...
 
Func1func1 () const
 accessor function for m_f1 More...
 
Func1func2 () const
 accessor function for m_f2 More...
 
virtual int order () const
 Return the order of the function, if it makes sense. More...
 
Func1func1_dup () const
 
Func1func2_dup () const
 
Func1parent () const
 
void setParent (Func1 *p)
 

Additional Inherited Members

- Protected Attributes inherited from Func1
doublereal m_c
 
Func1m_f1
 
Func1m_f2
 
Func1m_parent
 

Detailed Description

The Const1 class implements a constant.

Definition at line 316 of file Func1.h.

Constructor & Destructor Documentation

◆ Const1() [1/2]

Const1 ( double  A)
inline

Constructor.

Parameters
AConstant

Definition at line 323 of file Func1.h.

Referenced by Const1::derivative(), and Const1::duplicate().

◆ Const1() [2/2]

Const1 ( const Const1 b)
inline

Definition at line 328 of file Func1.h.

Member Function Documentation

◆ operator=()

Const1 & operator= ( const Const1 right)
inline

Definition at line 332 of file Func1.h.

◆ write()

string write ( const std::string &  arg) const
virtual

Reimplemented from Func1.

Definition at line 318 of file Func1.cpp.

◆ ID()

virtual int ID ( ) const
inlinevirtual

Reimplemented from Func1.

Definition at line 341 of file Func1.h.

◆ eval()

virtual doublereal eval ( doublereal  t) const
inlinevirtual

Evaluate the function.

Reimplemented from Func1.

Definition at line 344 of file Func1.h.

◆ duplicate()

virtual Func1 & duplicate ( ) const
inlinevirtual

Duplicate the current function.

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

Reimplemented from Func1.

Definition at line 347 of file Func1.h.

References Const1::Const1().

◆ derivative()

virtual Func1 & derivative ( ) const
inlinevirtual

Creates a derivative to the current function.

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

Reimplemented from Func1.

Definition at line 351 of file Func1.h.

References Const1::Const1().


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