Loading...
Searching...
No Matches
polynomialFunction Class Reference

Polynomial function representation. More...

#include <polynomialFunction.H>

Inheritance diagram for polynomialFunction:
Inheritance graph
[legend]
Collaboration diagram for polynomialFunction:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("polynomialFunction")
 Runtime type information.
 polynomialFunction ()
 Default construct as size 1 with coefficient == 0.
 polynomialFunction (const label order)
 Construct a particular size, with all coefficients == 0.
 polynomialFunction (std::initializer_list< scalar > coeffs)
 Construct from an initializer list of coefficients.
 polynomialFunction (const UList< scalar > &coeffs)
 Construct from a list of coefficients.
 polynomialFunction (Istream &is)
 Construct from Istream.
virtual ~polynomialFunction ()=default
 Destructor.
bool logActive () const
 True if the log term is active.
scalar logCoeff () const
 The log coefficient.
scalar value (const scalar x) const
 Return polynomial value.
scalar integrate (const scalar x1, const scalar x2) const
 Integrate between two values.
polynomialFunction integral (const scalar intConstant=0) const
 Return integral coefficients.
polynomialFunction integralMinus1 (const scalar intConstant=0) const
 Return integral coefficients when lowest order is -1.
bool operator== (const polynomialFunction &rhs) const
 Equality of coefficients, and logCoeff (if active).
bool operator!= (const polynomialFunction &rhs) const
polynomialFunction & operator+= (const polynomialFunction &)
polynomialFunction & operator-= (const polynomialFunction &)
polynomialFunction & operator*= (const scalar)
polynomialFunction & operator/= (const scalar)

Friends

Istream & operator>> (Istream &, polynomialFunction &poly)
Ostream & operator<< (Ostream &, const polynomialFunction &poly)

Detailed Description

Polynomial function representation. 

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

where 0 <= i <= N

  • integer powers, starting at zero
  • value(x) to evaluate the poly for a given value
  • integrate(x1, x2) 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
See also
Foam::Polynomial for a templated implementation
Source files

Definition at line 72 of file polynomialFunction.H.

Constructor & Destructor Documentation

◆ polynomialFunction() [1/5]

polynomialFunction ( )

Default construct as size 1 with coefficient == 0.

Definition at line 92 of file polynomialFunction.C.

References Foam::Zero.

Referenced by operator!=(), operator+=(), operator-=(), operator<<, operator==(), operator>>, and ~polynomialFunction().

Here is the caller graph for this function:

◆ polynomialFunction() [2/5]

polynomialFunction ( const label order)
explicit

Construct a particular size, with all coefficients == 0.

Definition at line 100 of file polynomialFunction.C.

References Foam::Zero.

◆ polynomialFunction() [3/5]

polynomialFunction ( std::initializer_list< scalar > coeffs)
explicit

Construct from an initializer list of coefficients.

Definition at line 110 of file polynomialFunction.C.

◆ polynomialFunction() [4/5]

polynomialFunction ( const UList< scalar > & coeffs)
explicit

Construct from a list of coefficients.

Definition at line 123 of file polynomialFunction.C.

◆ polynomialFunction() [5/5]

polynomialFunction ( Istream & is)
explicit

Construct from Istream.

Definition at line 133 of file polynomialFunction.C.

◆ ~polynomialFunction()

virtual ~polynomialFunction ( )
virtualdefault

Destructor.

References UList< scalar >::empty(), polynomialFunction(), Foam::rhs(), UList< scalar >::size(), and x.

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "polynomialFunction" )

Runtime type information.

◆ logActive()

bool logActive ( ) const

True if the log term is active.

Definition at line 145 of file polynomialFunction.C.

◆ logCoeff()

Foam::scalar logCoeff ( ) const

The log coefficient.

Definition at line 151 of file polynomialFunction.C.

◆ value()

Foam::scalar value ( const scalar x) const

Return polynomial value.

Definition at line 157 of file polynomialFunction.C.

References Foam::log(), UList< T >::size(), and x.

Here is the call graph for this function:

◆ integrate()

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

Integrate between two values.

Definition at line 179 of file polynomialFunction.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Foam::nl, and UList< T >::size().

Here is the call graph for this function:

◆ integral()

Foam::polynomialFunction integral ( const scalar intConstant = 0) const

Return integral coefficients.

Argument becomes zeroth element (constant of integration)

Definition at line 211 of file polynomialFunction.C.

◆ integralMinus1()

Foam::polynomialFunction integralMinus1 ( const scalar intConstant = 0) const

Return integral coefficients when lowest order is -1.

Argument becomes zeroth element (constant of integration)

Definition at line 218 of file polynomialFunction.C.

◆ operator==()

bool operator== ( const polynomialFunction & rhs) const

Equality of coefficients, and logCoeff (if active).

Definition at line 226 of file polynomialFunction.C.

References polynomialFunction(), and Foam::rhs().

Referenced by operator!=().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator!=()

bool operator!= ( const polynomialFunction & rhs) const
inline

Definition at line 236 of file polynomialFunction.H.

References operator==(), polynomialFunction(), and Foam::rhs().

Here is the call graph for this function:

◆ operator+=()

Foam::polynomialFunction & operator+= ( const polynomialFunction & poly)

Definition at line 238 of file polynomialFunction.C.

References forAll, polynomialFunction(), List< T >::resize(), UList< T >::size(), and Foam::Zero.

Here is the call graph for this function:

◆ operator-=()

Foam::polynomialFunction & operator-= ( const polynomialFunction & poly)

Definition at line 257 of file polynomialFunction.C.

References forAll, polynomialFunction(), List< T >::resize(), UList< T >::size(), and Foam::Zero.

Here is the call graph for this function:

◆ operator*=()

Foam::polynomialFunction & operator*= ( const scalar s)

Definition at line 276 of file polynomialFunction.C.

References forAll, and s().

Here is the call graph for this function:

◆ operator/=()

Foam::polynomialFunction & operator/= ( const scalar s)

Definition at line 289 of file polynomialFunction.C.

References forAll, and s().

Here is the call graph for this function:

◆ operator>>

Istream & operator>> ( Istream & ,
polynomialFunction & poly )
friend

References polynomialFunction().

◆ operator<<

Ostream & operator<< ( Ostream & ,
const polynomialFunction & poly )
friend

References polynomialFunction().

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