FreeFOAM The Cross-Platform CFD Toolkit
polynomial Class Reference

Polynomial container data entry for scalars. Items are stored in a list of Tuple2's. Data is input in the form, e.g. for an entry <entryName> that describes y = x^2 + 2x^3. More...

#include <lagrangianIntermediate/polynomial.H>


Detailed Description

Polynomial container data entry for scalars. Items are stored in a list of Tuple2's. Data is input in the form, e.g. for an entry <entryName> that describes y = x^2 + 2x^3.

<entryName>   polynomial
(
(12)
(23)
);
Source files

Definition at line 70 of file polynomial.H.

+ Inheritance diagram for polynomial:
+ Collaboration diagram for polynomial:

List of all members.

Public Member Functions

 TypeName ("polynomial")
 Runtime type information.
 polynomial (const word &entryName, Istream &is)
 Construct from entry name and Istream.
 polynomial (const polynomial &poly)
 Copy constructor.
virtual ~polynomial ()
 Destructor.
scalar value (const scalar x) const
 Return polynomial value.
scalar integrate (const scalar x1, const scalar x2) const
 Integrate between two (scalar) values.
- Public Member Functions inherited from DataEntry< scalar >
 DataEntry (const word &entryName)
 Construct from entry name.
 DataEntry (const DataEntry< scalar > &de)
 Copy constructor.
 TypeName ("DataEntry") declareRunTimeSelectionTable(autoPtr
 Runtime type information.
virtual ~DataEntry ()
 Destructor.
const wordname () const
 Return the name of the entry.

Friends

Ostreamoperator<< (Ostream &, const polynomial &)
 Ostream Operator.

Additional Inherited Members

- Static Public Member Functions inherited from DataEntry< scalar >
static autoPtr< DataEntry
< scalar > > 
New (const word &entryName, const dictionary &dict)
 Selector.
- Public Attributes inherited from DataEntry< scalar >
 DataEntry
 dictionary
const wordentryName
const word Istream entryName
const word Istreamis
const word Istream is
- Protected Attributes inherited from DataEntry< scalar >
const word name_
 Name of entry.

Constructor & Destructor Documentation

polynomial ( const word entryName,
Istream is 
)

Construct from entry name and Istream.

Definition at line 37 of file polynomial.C.

References Foam::exit(), Foam::FatalError, FatalErrorIn, DataEntry< scalar >::name_, Foam::nl, and List< T >::size().

polynomial ( const polynomial poly)

Copy constructor.

Definition at line 51 of file polynomial.C.

~polynomial ( )
virtual

Destructor.

Definition at line 60 of file polynomial.C.


Member Function Documentation

TypeName ( "polynomial"  )

Runtime type information.

Foam::scalar value ( const scalar  x) const
virtual

Return polynomial value.

Implements DataEntry< scalar >.

Definition at line 66 of file polynomial.C.

References forAll, Foam::pow(), and y.

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

Integrate between two (scalar) values.

Implements DataEntry< scalar >.

Definition at line 78 of file polynomial.C.

References forAll, and Foam::pow().


Friends And Related Function Documentation

Ostream& operator<< ( Ostream ,
const polynomial  
)
friend

Ostream Operator.


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