CSV< Type > Class Template Reference

Templated CSV function. More...

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

Public Member Functions

 TypeName ("csvFile")
 Declare type-name, virtual type (with debug switch) More...
 
 CSV (const word &entryName, const dictionary &dict, const fileName &fName=fileName::null)
 Construct from entry name and dictionary. More...
 
 CSV (const CSV< Type > &csv)
 Copy construct. More...
 
virtual tmp< Function1< Type > > clone () const
 Construct and return a clone. More...
 
virtual ~CSV ()=default
 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...
 
void writeEntries (Ostream &os) const
 Write coefficient entries 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...
 
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...
 
- 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 word &entryName, const dictionary &dict)
 Construct from entry name and dictionary. More...
 
 Function1 (const Function1< Type > &rhs)
 Copy construct. More...
 
virtual ~Function1 ()=default
 Destructor. 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...
 
void writeEntries (Ostream &os) const
 Write coefficient entries in dictionary format. More...
 

Additional Inherited Members

- Public Types inherited from Function1< Type >
typedef Type returnType
 
- Static Public Member Functions inherited from Function1< Type >
static autoPtr< Function1< Type > > New (const word &entryName, const dictionary &dict, const word &redirectType, const bool mandatory=true)
 Selector, with fallback redirection. More...
 
static autoPtr< Function1< Type > > NewCompat (const word &entryName, std::initializer_list< std::pair< const char *, int >> compat, const dictionary &dict, const word &redirectType=word::null, const bool mandatory=true)
 Compatibility selector, with fallback redirection. More...
 
static autoPtr< Function1< Type > > New (const word &entryName, const dictionary &dict, const bool mandatory=true)
 Selector, without fallback redirection. More...
 
static autoPtr< Function1< Type > > NewIfPresent (const word &entryName, const dictionary &dict, const word &redirectType=word::null)
 An optional 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 > &)=delete
 No copy assignment. More...
 
- Protected Member Functions inherited from Function1< Type >
void operator= (const Function1< Type > &)=delete
 No copy assignment. More...
 
- Protected Attributes inherited from TableBase< Type >
const bounds::repeatableBounding bounding_
 Handling for 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_
 

Detailed Description

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

Templated CSV function.

Reference column is always a scalar, e.g. time.

Usage:

    <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
        file                "fileXYZ";  // name of csv data file
        outOfBounds         clamp;      // optional out-of-bounds handling
        interpolationScheme linear;     // optional interpolation scheme
    }
Source files

Definition at line 75 of file CSV.H.

Constructor & Destructor Documentation

◆ CSV() [1/2]

CSV ( const word entryName,
const dictionary dict,
const fileName fName = fileName::null 
)

Construct from entry name and dictionary.

Definition at line 210 of file CSV.C.

References Foam::blockMeshTools::read().

Here is the call graph for this function:

◆ CSV() [2/2]

CSV ( const CSV< Type > &  csv)
explicit

Copy construct.

Definition at line 231 of file CSV.C.

◆ ~CSV()

virtual ~CSV ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "csvFile"  )

Declare type-name, virtual type (with debug switch)

◆ clone()

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

Construct and return a clone.

Implements Function1< Type >.

Definition at line 139 of file CSV.H.

◆ fName()

const Foam::fileName & fName ( ) const
virtual

Return const access to the file name.

Definition at line 246 of file CSV.C.

◆ writeData()

void writeData ( Ostream os) const
virtual

Write in dictionary format.

Reimplemented from TableBase< Type >.

Definition at line 275 of file CSV.C.

References Ostream::beginBlock(), Ostream::endBlock(), Ostream::endEntry(), Foam::name(), and Function1< Type >::writeData().

Here is the call graph for this function:

◆ writeEntries()

void writeEntries ( Ostream os) const
virtual

Write coefficient entries in dictionary format.

Reimplemented from TableBase< Type >.

Definition at line 253 of file CSV.C.

References IOstreamOption::ASCII, IOstreamOption::format(), TableBase< Type >::writeEntries(), and Ostream::writeEntry().

Here is the call graph for this function:

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