Arbitrary order polynomial Function1. More...

Inheritance diagram for Polynomial< Type >:

Collaboration diagram for Polynomial< Type >:

Public Member Functions
	TypeName ("polynomial")
	Runtime type information. More...

	Polynomial (const word &name, const unitConversions &units, const dictionary &dict)
	Construct from name and dictionary. More...

	Polynomial (const word &name, const unitConversions &units, Istream &is)
	Construct from name and Istream. More...

	Polynomial (const Polynomial &poly)
	Copy constructor. More...

virtual	~Polynomial ()
	Destructor. More...

virtual Type	value (const scalar x) const
	Return Polynomial value as a function of scalar x. More...

virtual Type	integral (const scalar x1, const scalar x2) const
	Integrate between two scalar fields. More...

virtual void	write (Ostream &os, const unitConversions &units) const
	Write in dictionary format. More...

void	operator= (const Polynomial< Type > &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from FieldFunction1< Type, Polynomial< Type > >
	FieldFunction1 (const word &name)
	Construct from name. More...

virtual tmp< Function1< Type > >	clone () const
	Construct and return a clone. More...

virtual	~FieldFunction1 ()
	Destructor. More...

virtual tmp< Field< Type > >	value (const scalarField &x) const
	Return value as a function of one scalar field. More...

virtual tmp< Field< Type > >	integral (const scalarField &x1, const scalarField &x2) const
	Integrate between two scalar fields. More...

Public Member Functions inherited from Function1< Type >
	TypeName ("Function1")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, Function1, dictionary,(const word &name, const Function1s::unitConversions &units, const dictionary &dict),(name, units, dict))

	declareRunTimeSelectionTable (autoPtr, Function1, Istream,(const word &name, const Function1s::unitConversions &units, Istream &is),(name, units, is))

	Function1 (const word &name)
	Construct from name. More...

	Function1 (const Function1< Type > &f1)
	Copy constructor. More...

virtual	~Function1 ()
	Destructor. More...

const word &	name () const
	Return the name of the entry. More...

virtual bool	constant () const
	Is this function guaranteed to be constant? More...

void	operator= (const Function1< Type > &)
	Assignment. More...

Public Member Functions inherited from refCount
int	count () const
	Return the current reference count. More...

bool	unique () const
	Return true if the reference count is zero. More...

void	operator++ ()
	Increment the reference count. More...

void	operator++ (int)
	Increment the reference count. More...

void	operator-- ()
	Decrement the reference count. More...

void	operator-- (int)
	Decrement the reference count. More...

void	operator= (const refCount &)=delete
	Disallow bitwise assignment. More...

Additional Inherited Members
Public Types inherited from Function1< Type >
typedef Type	returnType

Static Public Member Functions inherited from Function1< Type >
static autoPtr< Function1< Type > >	New (const word &name, const Function1s::unitConversions &units, const dictionary &dict)
	Select from dictionary. More...

static autoPtr< Function1< Type > >	New (const word &name, const unitConversion &xUnits, const unitConversion &valueUnits, const dictionary &dict)
	Select from dictionary. More...

static autoPtr< Function1< Type > >	New (const word &name, const Function1s::unitConversions &units, const word &Function1Type, Istream &is)
	Select from Istream. More...

static autoPtr< Function1< Type > >	New (const word &name, const unitConversion &xUnits, const unitConversion &valueUnits, const word &Function1Type, Istream &is)
	Select from Istream. More...

Protected Member Functions inherited from refCount
	refCount ()
	Construct null initialising count to 0. More...

	refCount (const refCount &)=delete
	Disallow copy. More...

Protected Attributes inherited from Function1< Type >
const word	name_
	Name of entry. More...

Detailed Description

template<class Type>
class Foam::Function1s::Polynomial< Type >

Arbitrary order polynomial Function1.

The coefficients in the polynomial are specified in order of increasing exponent, starting from the constant coefficient (i.e., zero exponent).

For example, the polynomial y = -1 + x^2 + 2x^3 can be specified as:

    <name>  polynomial (-1 0 1 2);

Or, alternatively:

    <name>
    {
        type    polynomial;
        coeffs  (-1 0 1 2);
    }

Source files

Definition at line 70 of file Polynomial1.H.

Constructor & Destructor Documentation

◆ Polynomial() [1/3]

Polynomial	(	const word &	name,
		const unitConversions &	units,
		const dictionary &	dict
	)

Construct from name and dictionary.

Definition at line 67 of file Polynomial1.C.

References dict, Foam::exit(), Foam::FatalError, FatalIOErrorInFunction, Function1< Type >::name(), and List< T >::size().

Here is the call graph for this function:

◆ Polynomial() [2/3]

Polynomial	(	const word &	name,
		const unitConversions &	units,
		Istream &	is
	)

Construct from name and Istream.

Definition at line 97 of file Polynomial1.C.

References Foam::exit(), Foam::FatalError, FatalIOErrorInFunction, Function1< Type >::name(), and List< T >::size().

Here is the call graph for this function:

◆ Polynomial() [3/3]

Polynomial ( const Polynomial< Type > & poly )

Copy constructor.

Definition at line 118 of file Polynomial1.C.

◆ ~Polynomial()

~Polynomial

virtual

Destructor.

Definition at line 128 of file Polynomial1.C.

Member Function Documentation

◆ TypeName()

TypeName ( "polynomial" )

Runtime type information.

◆ value()

Type value ( const scalar x ) const

virtual

Return Polynomial value as a function of scalar x.

Implements FieldFunction1< Type, Polynomial< Type > >.

Definition at line 135 of file Polynomial1.C.

References x, and y.

◆ integral()

Type integral	(	const scalar	x1,
		const scalar	x2
	)		const

virtual

Integrate between two scalar fields.

Implements FieldFunction1< Type, Polynomial< Type > >.

Definition at line 149 of file Polynomial1.C.

◆ write()

void write	(	Ostream &	os,
		const unitConversions &	units
	)		const

virtual

Write in dictionary format.

Implements Function1< Type >.

Definition at line 168 of file Polynomial1.C.

References Foam::units(), and Foam::Function1s::writeEntry().

Here is the call graph for this function:

◆ operator=()

void operator= ( const Polynomial< Type > & )

delete

Disallow default bitwise assignment.

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

src/OpenFOAM/primitives/functions/Function1/Polynomial1/Polynomial1.H
src/OpenFOAM/primitives/functions/Function1/Polynomial1/Polynomial1.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::Function1s::Polynomial< Type >

Constructor & Destructor Documentation

◆ Polynomial() [1/3]

◆ Polynomial() [2/3]

◆ Polynomial() [3/3]

◆ ~Polynomial()

Member Function Documentation

◆ TypeName()

◆ value()

◆ integral()

◆ write()

◆ operator=()

template<class Type>
class Foam::Function1s::Polynomial< Type >