Polynomial templated on size (order): More...
Public Types | |
typedef Polynomial< PolySize > | polyType |
typedef Polynomial< PolySize+1 > | intPolyType |
Public Types inherited from VectorSpace< Polynomial< PolySize >, scalar, PolySize > | |
typedef VectorSpace< Polynomial< PolySize >, scalar, Ncmpts > | vsType |
VectorSpace type. More... | |
typedef scalar | cmptType |
Component type. More... | |
typedef scalar | magType |
Magnitude type. More... | |
typedef scalar * | iterator |
Random access iterator for traversing VectorSpace. More... | |
typedef const scalar * | const_iterator |
Random access iterator for traversing VectorSpace. More... | |
Public Member Functions | |
Polynomial () | |
Default construct, with all coefficients = 0. More... | |
Polynomial (std::initializer_list< scalar > coeffs) | |
Construct from an initializer list of coefficients. More... | |
Polynomial (const scalar coeffs[PolySize]) | |
Construct from C-array of coefficients. More... | |
Polynomial (const UList< scalar > &coeffs) | |
Construct from a list of coefficients. More... | |
Polynomial (Istream &is) | |
Construct from Istream. More... | |
Polynomial (const word &name, Istream &is) | |
Construct from name and Istream. More... | |
bool | logActive () const noexcept |
Return true if the log term is active. More... | |
scalar | logCoeff () const noexcept |
Return the log coefficient. More... | |
scalar | value (const scalar x) const |
Return polynomial value. More... | |
scalar | derivative (const scalar x) const |
Return derivative of the polynomial at the given x. More... | |
scalar | integral (const scalar x1, const scalar x2) const |
Return integral between two values. More... | |
intPolyType | integral (const scalar intConstant=0.0) const |
Return integral coefficients. More... | |
polyType | integralMinus1 (const scalar intConstant=0.0) const |
Return integral coefficients when lowest order is -1. More... | |
Public Member Functions inherited from VectorSpace< Polynomial< PolySize >, scalar, PolySize > | |
VectorSpace ()=default | |
Default construct. More... | |
VectorSpace (const Foam::zero) | |
Construct initialized to zero. More... | |
VectorSpace (const VectorSpace< Polynomial< PolySize >, scalar, Ncmpts > &vs) | |
Copy construct. More... | |
VectorSpace (const VectorSpace< Form2, Cmpt2, Ncmpts > &) | |
Copy construct of a VectorSpace with the same size. More... | |
VectorSpace (Istream &is) | |
Construct from Istream. More... | |
const scalar & | component (const direction) const |
scalar & | component (const direction) |
void | component (scalar &, const direction) const |
void | replace (const direction, const scalar &) |
const scalar * | cdata () const noexcept |
Return const pointer to the first data element. More... | |
scalar * | data () noexcept |
Return pointer to the first data element. More... | |
const ConstBlock< SubVector, BStart > | block () const |
const Foam::VectorSpace< Polynomial< PolySize >, scalar, Ncmpts >::template ConstBlock< SubVector, BStart > | block () const |
const scalar & | operator[] (const direction) const |
scalar & | operator[] (const direction) |
void | operator= (const VectorSpace< Polynomial< PolySize >, scalar, Ncmpts > &) |
void | operator= (const Foam::zero) |
void | operator+= (const VectorSpace< Polynomial< PolySize >, scalar, Ncmpts > &) |
void | operator-= (const VectorSpace< Polynomial< PolySize >, scalar, Ncmpts > &) |
void | operator*= (const scalar) |
void | operator/= (const scalar) |
iterator | begin () noexcept |
Return an iterator to begin of VectorSpace. More... | |
const_iterator | begin () const noexcept |
Return const_iterator to begin of VectorSpace. More... | |
iterator | end () noexcept |
Return an iterator to end of VectorSpace. More... | |
const_iterator | end () const noexcept |
Return const_iterator to end of VectorSpace. More... | |
const_iterator | cbegin () const noexcept |
Return const_iterator to begin of VectorSpace. More... | |
const_iterator | cend () const noexcept |
Return const_iterator to end of VectorSpace. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from VectorSpace< Polynomial< PolySize >, scalar, PolySize > | |
static constexpr direction | size () noexcept |
The number of elements in the VectorSpace = Ncmpts. More... | |
static Polynomial< PolySize > | uniform (const scalar &s) |
Return a VectorSpace with all elements = s. More... | |
Public Attributes inherited from VectorSpace< Polynomial< PolySize >, scalar, PolySize > | |
scalar | v_ [Ncmpts] |
The components of this vector space. More... | |
Static Public Attributes inherited from VectorSpace< Polynomial< PolySize >, scalar, PolySize > | |
static constexpr direction | dim |
Dimensionality of space. More... | |
static constexpr direction | nComponents |
Number of components in this vector space. More... | |
static constexpr direction | mRows |
static constexpr direction | nCols |
static const char *const | typeName |
static const char *const | componentNames [] |
static const Polynomial< PolySize > | zero |
static const Polynomial< PolySize > | one |
static const Polynomial< PolySize > | max |
static const Polynomial< PolySize > | min |
static const Polynomial< PolySize > | rootMax |
static const Polynomial< PolySize > | rootMin |
Polynomial templated on size (order):
poly = sum(coeffs[i]*x^i) + logCoeff*log(x)
where 0 <= i <= N
value(x)
to evaluate the poly for a given valuederivative(x)
returns derivative at valueintegral(x1, x2)
returns integral between two scalar valuesintegral()
to return a new, integral coeff polynomialintegralMinus1()
to return a new, integral coeff polynomial where the base poly starts at order -1Definition at line 64 of file Polynomial.H.
typedef Polynomial<PolySize> polyType |
Definition at line 94 of file Polynomial.H.
typedef Polynomial<PolySize+1> intPolyType |
Definition at line 95 of file Polynomial.H.
Polynomial | ( | ) |
Default construct, with all coefficients = 0.
Definition at line 27 of file Polynomial.C.
Polynomial | ( | std::initializer_list< scalar > | coeffs | ) |
Construct from an initializer list of coefficients.
Definition at line 36 of file Polynomial.C.
|
explicit |
Construct from C-array of coefficients.
Definition at line 60 of file Polynomial.C.
|
explicit |
Construct from a list of coefficients.
Definition at line 74 of file Polynomial.C.
|
explicit |
Construct from Istream.
Definition at line 96 of file Polynomial.C.
Polynomial | ( | const word & | name, |
Istream & | is | ||
) |
Construct from name and Istream.
Definition at line 105 of file Polynomial.C.
|
noexcept |
Return true if the log term is active.
Definition at line 131 of file Polynomial.C.
|
noexcept |
Return the log coefficient.
Definition at line 138 of file Polynomial.C.
Foam::scalar value | ( | const scalar | x | ) | const |
Return polynomial value.
Definition at line 145 of file Polynomial.C.
Foam::scalar derivative | ( | const scalar | x | ) | const |
Return derivative of the polynomial at the given x.
Definition at line 167 of file Polynomial.C.
Foam::scalar integral | ( | const scalar | x1, |
const scalar | x2 | ||
) | const |
Return integral between two values.
Definition at line 195 of file Polynomial.C.
Foam::Polynomial< PolySize >::intPolyType integral | ( | const scalar | intConstant = 0.0 | ) | const |
Return integral coefficients.
Argument becomes zero'th element (constant of integration)
Definition at line 223 of file Polynomial.C.
Foam::Polynomial< PolySize >::polyType integralMinus1 | ( | const scalar | intConstant = 0.0 | ) | const |
Return integral coefficients when lowest order is -1.
Argument becomes zero'th element (constant of integration)
Definition at line 239 of file Polynomial.C.
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.