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

Templated CSV container data entry. Reference column is always a scalar, e.g. time. More...

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

Public Member Functions

 TypeName ("csvFile")
 Runtime type information. More...
 
 CSV (const word &entryName, const dictionary &dict, const word &ext="Coeffs")
 Construct from entry name and dictionary. More...
 
 CSV (const CSV< Type > &tbl)
 Copy constructor. More...
 
virtual tmp< Function1< Type > > clone () const
 Construct and return a clone. More...
 
virtual ~CSV ()
 Destructor. More...
 
virtual const fileNamefName () const
 Return const access to the file name. More...
 
virtual void writeData (Ostream &os) const
 Write in dictionary format. 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 tmp< scalarFieldx () const
 Return the reference values. More...
 
virtual tmp< Field< Type > > y () const
 Return the dependent values. More...
 
virtual void writeEntries (Ostream &os) const
 Write keywords only in dictionary format. Used for non-inline. More...
 
- Public Member Functions inherited from Function1< Type >
 TypeName ("Function1") declareRunTimeSelectionTable(autoPtr
 Runtime type information. More...
 
 Function1 (const word &entryName)
 Construct from entry name. More...
 
 Function1 (const Function1< Type > &de)
 Copy constructor. More...
 
virtual ~Function1 ()
 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...
 
- Public Member Functions inherited from refCount
int count () const
 Return the current reference count. More...
 
bool unique () const
 Return true if the reference count is 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 Function1< Type >
static autoPtr< Function1< Type > > New (const word &entryName, const dictionary &dict)
 Selector. More...
 
- Public Attributes inherited from Function1< Type >
 Function1
 
 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 Member Functions inherited from refCount
 refCount ()
 Construct null initializing count to 0. 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...
 
autoPtr< scalarFieldtableSamplesPtr_
 Extracted values. More...
 
autoPtr< interpolationWeightsinterpolatorPtr_
 Interpolator method. More...
 
labelList currentIndices_
 Cached indices and weights. More...
 
scalarField currentWeights_
 
- Protected Attributes inherited from Function1< Type >
const word name_
 Name of entry. More...
 

Detailed Description

template<class Type>
class Foam::Function1Types::CSV< Type >

Templated CSV container data entry. Reference column is always a scalar, e.g. time.

    <entryName> csvFile;
    <entryName>Coeffs
    {
        nHeaderLine         4;          // number of header lines
        refColumn           0;          // reference column index
        componentColumns    (1 2 3);    // component column indices
        separator           ",";        // optional (defaults to ",")
        mergeSeparators     no;         // merge multiple separators
        fileName            "fileXYZ";  // name of csv data file
        outOfBounds         clamp;      // optional out-of-bounds handling
        interpolationScheme linear;     // optional interpolation scheme
    }
Source files

Definition at line 71 of file CSV.H.

Constructor & Destructor Documentation

CSV ( const word entryName,
const dictionary dict,
const word ext = "Coeffs" 
)

Construct from entry name and dictionary.

Definition at line 204 of file CSV.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::read().

Here is the call graph for this function:

CSV ( const CSV< Type > &  tbl)

Copy constructor.

Definition at line 234 of file CSV.C.

~CSV ( )
virtual

Destructor.

Definition at line 249 of file CSV.C.

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

Here is the caller graph for this function:

Member Function Documentation

TypeName ( "csvFile"  )

Runtime type information.

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

Construct and return a clone.

Reimplemented from Function1< Type >.

Definition at line 131 of file CSV.H.

References CSV< Type >::fName(), CSV< Type >::writeData(), and CSV< Type >::~CSV().

Here is the call graph for this function:

const Foam::fileName & fName ( ) const
virtual

Return const access to the file name.

Definition at line 256 of file CSV.C.

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

Here is the caller graph for this function:

void writeData ( Ostream os) const
virtual

Write in dictionary format.

Reimplemented from TableBase< Type >.

Definition at line 263 of file CSV.C.

References IOstream::ASCII, token::BEGIN_BLOCK, IOstream::BINARY, Foam::decrIndent(), token::END_BLOCK, token::END_STATEMENT, Foam::endl(), IOstream::format(), Foam::incrIndent(), Foam::indent(), Function1< Type >::name(), Foam::nl, Function1< Type >::writeData(), TableBase< Type >::writeEntries(), and Ostream::writeKeyword().

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

Here is the call graph for this function:

Here is the caller graph for this function:


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