Public Member Functions | List of all members
Table< Type > Class Template Reference

Templated table container data entry. Items are stored in a list of Tuple2's. First column is always stored as scalar entries. Data is read in Tuple2 form, e.g. for an entry <entryName> that is (scalar, vector): More...

Inheritance diagram for Table< Type >:
Inheritance graph
[legend]
Collaboration diagram for Table< Type >:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("table")
 Runtime type information. More...
 
 Table (const word &entryName, const dictionary &dict)
 Construct from entry name and Istream. More...
 
 Table (const Table< Type > &tbl)
 Copy constructor. More...
 
virtual tmp< DataEntry< Type > > clone () const
 Construct and return a clone. More...
 
virtual ~Table ()
 Destructor. More...
 
- Public Member Functions inherited from TableBase< Type >
 TableBase (const word &name, const dictionary &dict)
 Construct from dictionary - note table is not populated. More...
 
 TableBase (const TableBase< Type > &tbl)
 Copy constructor. Note: steals interpolator, tableSamples. More...
 
virtual ~TableBase ()
 Destructor. More...
 
word boundsHandlingToWord (const boundsHandling &bound) const
 Return the out-of-bounds handling as a word. More...
 
boundsHandling wordToBoundsHandling (const word &bound) const
 Return the out-of-bounds handling as an enumeration. More...
 
boundsHandling outOfBounds (const boundsHandling &bound)
 Set the out-of-bounds handling from enum, return previous setting. More...
 
void check () const
 Check the table for size and consistency. More...
 
bool checkMinBounds (const scalar x, scalar &xDash) const
 Check minimum table bounds. More...
 
bool checkMaxBounds (const scalar x, scalar &xDash) const
 Check maximum table bounds. More...
 
virtual void convertTimeBase (const Time &t)
 Convert time. More...
 
virtual Type value (const scalar x) const
 Return Table value. More...
 
virtual Type integrate (const scalar x1, const scalar x2) const
 Integrate between two (scalar) values. More...
 
virtual dimensioned< Type > dimValue (const scalar x) const
 Return dimensioned constant value. More...
 
virtual dimensioned< Type > dimIntegrate (const scalar x1, const scalar x2) const
 Integrate between two values and return dimensioned type. More...
 
virtual tmp< scalarFieldx () const
 Return the reference values. More...
 
virtual tmp< Field< Type > > y () const
 Return the dependent values. More...
 
virtual void writeData (Ostream &os) const
 Write all table data in dictionary format. More...
 
virtual void writeEntries (Ostream &os) const
 Write keywords only in dictionary format. Used for non-inline. More...
 
- Public Member Functions inherited from DataEntry< Type >
 TypeName ("DataEntry") declareRunTimeSelectionTable(autoPtr
 Runtime type information. More...
 
 DataEntry (const word &entryName)
 Construct from entry name. More...
 
 DataEntry (const DataEntry< Type > &de)
 Copy constructor. More...
 
virtual ~DataEntry ()
 Destructor. More...
 
const wordname () const
 Return the name of the entry. More...
 
virtual tmp< Field< Type > > value (const scalarField &x) const
 Return value as a function of (scalar) independent variable. More...
 
virtual tmp< Field< Type > > integrate (const scalarField &x1, const scalarField &x2) const
 Integrate between two (scalar) values. More...
 
virtual tmp< Field< dimensioned< Type > > > dimValue (const scalarField &x) const
 Return dimensioned type as a function of (scalar) More...
 
virtual tmp< Field< dimensioned< Type > > > dimIntegrate (const scalarField &x1, const scalarField &x2) const
 Integrate between two scalar fields and return a field of. More...
 
- Public Member Functions inherited from refCount
 refCount ()
 Construct null with zero count. More...
 
int count () const
 Return the reference count. More...
 
bool okToDelete () const
 Return true if the reference count is zero. More...
 
void resetRefCount ()
 Reset the reference count to 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...
 

Additional Inherited Members

- Public Types inherited from TableBase< Type >
enum  boundsHandling { ERROR, WARN, CLAMP, REPEAT }
 Enumeration for handling out-of-bound values. More...
 
- Static Public Member Functions inherited from DataEntry< Type >
static autoPtr< DataEntry< Type > > New (const word &entryName, const dictionary &dict)
 Selector. More...
 
- Public Attributes inherited from DataEntry< Type >
 DataEntry
 
 dictionary
 
const wordentryName
 
const word const dictionarydict
 
const word const dictionary entryName
 
const word const dictionary dict
 
- Protected Member Functions inherited from TableBase< Type >
const interpolationWeightsinterpolator () const
 Return (demand driven) interpolator. More...
 
void operator= (const TableBase< Type > &)
 Disallow default bitwise assignment. More...
 
- Protected Attributes inherited from TableBase< Type >
const word name_
 Table name. More...
 
const boundsHandling boundsHandling_
 Enumeration for handling out-of-bound values. More...
 
const word interpolationScheme_
 Interpolation type. More...
 
List< Tuple2< scalar, Type > > table_
 Table data. More...
 
dimensionSet dimensions_
 The dimension set. More...
 
autoPtr< scalarFieldtableSamplesPtr_
 Extracted values. More...
 
autoPtr< interpolationWeightsinterpolatorPtr_
 Interpolator method. More...
 
labelList currentIndices_
 Cached indices and weights. More...
 
scalarField currentWeights_
 
- Protected Attributes inherited from DataEntry< Type >
const word name_
 Name of entry. More...
 

Detailed Description

template<class Type>
class Foam::Table< Type >

Templated table container data entry. Items are stored in a list of Tuple2's. First column is always stored as scalar entries. Data is read in Tuple2 form, e.g. for an entry <entryName> that is (scalar, vector):

    <entryName>   table
    (
        (0.0 (1 2 3))
        (1.0 (4 5 6))
    );
Source files

Definition at line 56 of file Table.H.

Constructor & Destructor Documentation

Table ( const word entryName,
const dictionary dict 
)

Construct from entry name and Istream.

Definition at line 31 of file Table.C.

References token::BEGIN_SQR, TableBase< Type >::check(), TableBase< Type >::dimensions_, dictionary::lookup(), and TableBase< Type >::table_.

Here is the call graph for this function:

Table ( const Table< Type > &  tbl)

Copy constructor.

Definition at line 51 of file Table.C.

~Table ( )
virtual

Destructor.

Definition at line 60 of file Table.C.

Referenced by Table< Type >::clone().

Here is the caller graph for this function:

Member Function Documentation

TypeName ( "table"  )

Runtime type information.

virtual tmp<DataEntry<Type> > clone ( ) const
inlinevirtual

Construct and return a clone.

Reimplemented from DataEntry< Type >.

Definition at line 95 of file Table.H.

References Table< Type >::~Table().

Here is the call graph for this function:


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