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

implements the cos() function More...

#include <Func1.h>

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

Public Member Functions

 Cos1 (doublereal omega=1.0)
 
 Cos1 (const Cos1 &b)
 
Cos1operator= (const Cos1 &right)
 
virtual Func1duplicate () const
 Duplicate the current function. More...
 
virtual std::string write (const std::string &arg) const
 
virtual int ID () const
 
virtual doublereal eval (doublereal t) const
 Evaluate the 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)
 
virtual Func1duplicate () const
 Duplicate the current function. More...
 
virtual int ID () const
 
doublereal operator() (doublereal t) const
 Calls method eval to evaluate the function. More...
 
virtual doublereal eval (doublereal t) const
 Evaluate the function. More...
 
virtual Func1derivative () const
 Creates a derivative to the current 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)
 
virtual std::string write (const std::string &arg) const
 
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

implements the cos() function

The argument to cos() is in radians

Definition at line 176 of file Func1.h.

Constructor & Destructor Documentation

◆ Cos1() [1/2]

Cos1 ( doublereal  omega = 1.0)
inline

Definition at line 179 of file Func1.h.

◆ Cos1() [2/2]

Cos1 ( const Cos1 b)
inline

Definition at line 184 of file Func1.h.

Member Function Documentation

◆ operator=()

Cos1 & operator= ( const Cos1 right)
inline

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

◆ write()

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

Reimplemented from Func1.

Definition at line 170 of file Func1.cpp.

◆ ID()

virtual int ID ( ) const
inlinevirtual

Reimplemented from Func1.

Definition at line 201 of file Func1.h.

◆ eval()

virtual doublereal eval ( doublereal  t) const
inlinevirtual

Evaluate the function.

Reimplemented from Func1.

Definition at line 204 of file Func1.h.

◆ derivative()

Func1 & derivative ( ) const
virtual

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 163 of file Func1.cpp.


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