Polynomial Class Reference

Polynomial templated on size (order): More...

Inheritance diagram for Polynomial:

Public Types
typedef Polynomial< PolySize >	polyType
typedef Polynomial< PolySize+1 >	intPolyType

Public Member Functions
	Polynomial ()
	Polynomial (std::initializer_list< scalar > coeffs)
	Polynomial (const scalar coeffs[PolySize])
	Polynomial (const UList< scalar > &coeffs)
	Polynomial (Istream &is)
	Polynomial (const word &name, Istream &is)
bool	logActive () const
scalar	logCoeff () const
scalar	value (const scalar x) const
scalar	derivative (const scalar x) const
scalar	integral (const scalar x1, const scalar x2) const
intPolyType	integral (const scalar intConstant=0.0) const
polyType	integralMinus1 (const scalar intConstant=0.0) const

Detailed Description

Polynomial templated on size (order):

    poly = sum(coeffs[i]*x^i) + logCoeff*log(x)

where 0 <= i <= N

• integer powers, starting at zero
• value(x) to evaluate the poly for a given value
• derivative(x) returns derivative at value
• integral(x1, x2) returns integral between two scalar values
• integral() to return a new, integral coeff polynomial
  • increases the size (order)
• integralMinus1() to return a new, integral coeff polynomial where the base poly starts at order -1

Source files

• Polynomial.H
• Polynomial.C

Definition at line 64 of file Polynomial.H.

Member Typedef Documentation

polyType

typedef Polynomial<PolySize> polyType

Definition at line 90 of file Polynomial.H.

intPolyType

typedef Polynomial<PolySize+1> intPolyType

Definition at line 91 of file Polynomial.H.

Constructor & Destructor Documentation

Polynomial() [1/6]

Polynomial

(

)

Definition at line 27 of file Polynomial.C.

Polynomial() [2/6]

Polynomial

(

std::initializer_list< scalar >

coeffs

)

Definition at line 36 of file Polynomial.C.

Polynomial() [3/6]

Polynomial ( const scalar  coeffs[PolySize] )

explicit

Definition at line 60 of file Polynomial.C.

Polynomial() [4/6]

Polynomial ( const UList< scalar > &  coeffs )

explicit

Definition at line 74 of file Polynomial.C.

Polynomial() [5/6]

Polynomial ( Istream &  is )

explicit

Definition at line 96 of file Polynomial.C.

Polynomial() [6/6]

Polynomial	(	const word &	name,
		Istream &	is
	)

Definition at line 105 of file Polynomial.C.

Member Function Documentation

logActive()

bool logActive

(

)

const

Definition at line 131 of file Polynomial.C.

logCoeff()

Foam::scalar logCoeff

(

)

const

Definition at line 138 of file Polynomial.C.

value()

Foam::scalar value

(

const scalar

x

)

const

Definition at line 145 of file Polynomial.C.

derivative()

Foam::scalar derivative

(

const scalar

x

)

const

Definition at line 167 of file Polynomial.C.

integral() [1/2]

Foam::scalar integral	(	const scalar	x1,
		const scalar	x2
	)		const

Definition at line 195 of file Polynomial.C.

integral() [2/2]

intPolyType integral

(

const scalar

intConstant = 0.0

)

const

integralMinus1()

Foam::Polynomial< PolySize >::polyType integralMinus1

(

const scalar

intConstant = 0.0

)

const

Definition at line 239 of file Polynomial.C.

---

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

• src/OpenFOAM/primitives/functions/Polynomial/Polynomial.H
• src/OpenFOAM/primitives/functions/Polynomial/Polynomial.C