Sin1 Class Reference

Implements the sin() function. More...

#include <Func1.h>

Inheritance diagram for Sin1:

Detailed Description

Implements the sin() function.

The functor class with type "sin" returns \( f(x) = \sin(\omega x) \), where the argument \( x \) is in radians.

Parameters

omega

Frequency \( \omega \) (default=1.0)

Definition at line 203 of file Func1.h.

Public Member Functions
	Sin1 (double omega=1.0)
	Sin1 (const vector< double > &params)
	Constructor uses single parameter (frequency)
string	write (const string &arg) const override
	Write LaTeX string describing function.
string	type () const override
	Returns a string describing the type of the function.
double	eval (double t) const override
	Evaluate the function.
shared_ptr< Func1 >	derivative () const override
	Creates a derivative to the current function.
Public Member Functions inherited from Func1
	Func1 (shared_ptr< Func1 > f1, shared_ptr< Func1 > f2)
	Func1 (shared_ptr< Func1 > f1, double A)
Func1 &	operator= (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< Func1 >	derivative () const
	Creates a derivative to the current function.
virtual bool	isIdentical (shared_ptr< Func1 > other) const
	Routine to determine if two functions are the same.
virtual 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 m_c.
shared_ptr< Func1 >	func1_shared () const
	Accessor function for m_f1.
shared_ptr< Func1 >	func2_shared () const
	Accessor function for m_f2.
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
shared_ptr< Func1 >	m_f1
shared_ptr< Func1 >	m_f2

Constructor & Destructor Documentation

Sin1() [1/2]

Sin1 ( double  omega = 1.0 )

inline

Definition at line 206 of file Func1.h.

Sin1() [2/2]

Sin1

(

const vector< double > &

params

)

Constructor uses single parameter (frequency)

Definition at line 84 of file Func1.cpp.

Member Function Documentation

write()

string write ( const string &  arg ) const

overridevirtual

Write LaTeX string describing function.

Reimplemented from Func1.

Definition at line 93 of file Func1.cpp.

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

eval()

double eval ( double  t ) const

inlineoverridevirtual

Evaluate the function.

Reimplemented from Func1.

Definition at line 219 of file Func1.h.

derivative()

shared_ptr< Func1 > derivative ( ) const

overridevirtual

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

---

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

• Func1.h
• Func1.cpp