Periodic1 Class Reference

Implements a periodic function. More...

#include <Func1.h>

Inheritance diagram for Periodic1:

Detailed Description

Implements a periodic function.

Takes any function and makes it periodic with period \( T \).

Parameters

f	Functor to be made periodic
T	Period

Definition at line 1351 of file Func1.h.

Public Member Functions
	Periodic1 (Func1 &f, double T)
	Periodic1 (const Periodic1 &b)
	Periodic1 (shared_ptr< Func1 > f, double A)
Periodic1 &	operator= (const Periodic1 &right)
string	type () const override
	Returns a string describing the type of the function.
Func1 &	duplicate () const override
	Duplicate the current function.
double	eval (double t) const override
	Evaluate the 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)
Func1 &	operator= (const Func1 &right)
virtual Func1 &	duplicate () const
	Duplicate the current function.
virtual int	ID () const
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 Func1 &	derivative () const
	Creates a derivative to the current function.
virtual shared_ptr< Func1 >	derivative3 () 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.
void	setC (double c)
	Function to set the stored constant.
Func1 &	func1 () const
	accessor function for m_f1
shared_ptr< Func1 >	func1_shared () const
	Accessor function for m_f1_shared.
Func1 &	func2 () const
	accessor function for m_f2
shared_ptr< Func1 >	func2_shared () const
	Accessor function for m_f2_shared.
virtual int	order () const
	Return the order of the function, if it makes sense.
Func1 &	func1_dup () const
Func1 &	func2_dup () const
Func1 *	parent () const
void	setParent (Func1 *p)

Additional Inherited Members
Protected Attributes inherited from Func1
double	m_c = 0.0
Func1 *	m_f1 = nullptr
Func1 *	m_f2 = nullptr
Func1 *	m_parent = nullptr
shared_ptr< Func1 >	m_f1_shared
shared_ptr< Func1 >	m_f2_shared

Constructor & Destructor Documentation

Periodic1() [1/3]

Periodic1 ( Func1 &  f, double  T  )

inline

Definition at line 1354 of file Func1.h.

Periodic1() [2/3]

Periodic1 ( const Periodic1 &  b )

inline

Definition at line 1359 of file Func1.h.

Periodic1() [3/3]

Periodic1 ( shared_ptr< Func1 >  f, double  A  )

inline

Definition at line 1363 of file Func1.h.

~Periodic1()

~Periodic1 ( )

inlineoverride

Definition at line 1380 of file Func1.h.

Member Function Documentation

operator=()

Periodic1 & operator= ( const Periodic1 &  right )

inline

Definition at line 1365 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 1374 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 611 of file Func1.cpp.

eval()

double eval ( double  t ) const

inlineoverridevirtual

Evaluate the function.

Reimplemented from Func1.

Definition at line 1386 of file Func1.h.

---

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

• Func1.h
• Func1.cpp