Tabulated1 Class Reference

Implements a tabulated function. More...

#include <Func1.h>

Inheritance diagram for Tabulated1:

Detailed Description

Implements a tabulated function.

The functor class is based on tabulated arrays tvals and fvals, where tvals contain independent variables and fvals are corresponding function values. Depending on configuration, the function is either interpolated linearly between the tabulated points (type "tabulated-linear" ; default), or yields the last tabulated value until a new tabulated time value is reached (type "tabulated-previous" ).

Definition at line 355 of file Func1.h.

Public Member Functions
	Tabulated1 (size_t n, const double *tvals, const double *fvals, const string &method="linear")
	Constructor. More...
	Tabulated1 (const vector< double > &params)
	Constructor uses \( 2 n \) parameters in the following order: \( [t_0, t_1, \dots, t_{n-1}, f_0, f_1, \dots, f_{n-1}] \). More...
void	setMethod (const string &method)
	Set the interpolation method. More...
string	write (const string &arg) const override
	Write LaTeX string describing function. More...
string	type () const override
	Returns a string describing the type of the function. More...
double	eval (double t) const override
	Evaluate the function. More...
shared_ptr< Func1 >	derivative () const override
	Creates a derivative to the current function. More...
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)=delete
Func1 &	operator= (const Func1 &right)=delete
string	typeName () const
	Returns a string with the class name of the functor. More...
double	operator() (double t) const
	Calls method eval to evaluate the function. More...
shared_ptr< Func1 >	derivative3 () 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 double	isProportional (TimesConstant1 &other)
virtual double	isProportional (Func1 &other)
double	c () const
	Accessor function for the stored constant. More...
shared_ptr< Func1 >	func1_shared () const
	Accessor function for m_f1_shared. More...
shared_ptr< Func1 >	func2_shared () const
	Accessor function for m_f2_shared. More...
virtual int	order () const
	Return the order of the function, if it makes sense. More...

Private Attributes
vector< double >	m_tvec
	Vector of time values. More...
vector< double >	m_fvec
	Vector of function values. More...
bool	m_isLinear
	Boolean indicating interpolation method. More...

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

Constructor & Destructor Documentation

Tabulated1() [1/2]

Tabulated1	(	size_t	n,
		const double *	tvals,
		const double *	fvals,
		const string &	method = "linear"
	)

Constructor.

Parameters

n	Size of tabulated value arrays
tvals	Pointer to time value array
fvals	Pointer to function value array
method	Interpolation method ('linear' or 'previous')

Definition at line 278 of file Func1.cpp.

Tabulated1() [2/2]

Tabulated1

(

const vector< double > &

params

)

Constructor uses \( 2 n \) parameters in the following order: \( [t_0, t_1, \dots, t_{n-1}, f_0, f_1, \dots, f_{n-1}] \).

Definition at line 294 of file Func1.cpp.

Member Function Documentation

setMethod()

void setMethod

(

const string &

method

)

Set the interpolation method.

Parameters

method

Evaluation method. If "linear" (default), a linear interpolation between tabulated values is used; if "previous", the last tabulated value is held until a new tabulated time value is reached.

Since

New in Cantera 3.0

Definition at line 317 of file Func1.cpp.

write()

string write ( const string &  arg ) const

overridevirtual

Write LaTeX string describing function.

Reimplemented from Func1.

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

eval()

double eval ( double  t ) const

overridevirtual

Evaluate the function.

Reimplemented from Func1.

Definition at line 329 of file Func1.cpp.

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

Member Data Documentation

m_tvec

vector<double> m_tvec

private

Vector of time values.

Definition at line 391 of file Func1.h.

m_fvec

vector<double> m_fvec

private

Vector of function values.

Definition at line 392 of file Func1.h.

m_isLinear

bool m_isLinear

private

Boolean indicating interpolation method.

Definition at line 393 of file Func1.h.

---

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

• Func1.h
• Func1.cpp