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

Write set in csv format. More...

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

Public Member Functions

 TypeName ("csv")
 Runtime type information. More...
 
 csvSetWriter ()
 Default construct. More...
 
 csvSetWriter (const dictionary &dict)
 Construct with dictionary. More...
 
virtual ~csvSetWriter ()=default
 Destructor. More...
 
virtual fileName getFileName (const coordSet &, const wordList &) const
 Generate file name with correct extension. More...
 
virtual void write (const coordSet &, const wordList &, const List< const Field< Type > * > &, Ostream &) const
 General entry point for writing. More...
 
virtual void write (const bool writeTracks, const List< scalarField > &times, const PtrList< coordSet > &tracks, const wordList &valueSetNames, const List< List< Field< Type >>> &valueSets, Ostream &) const
 General entry point for writing of multiple coordSets. More...
 
- Public Member Functions inherited from writer< Type >
 TypeName ("writer")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, writer, word,(),())
 
 declareRunTimeSelectionTable (autoPtr, writer, dict,(const dictionary &formatOptions),(formatOptions))
 
 writer ()
 Default construct. More...
 
 writer (const dictionary &dict)
 Construct with dictionary. More...
 
virtual ~writer ()=default
 Destructor. More...
 
virtual void write (const coordSet &, const wordList &, const List< Field< Type >> &, Ostream &) const
 General entry point for writing. More...
 
virtual Ostream & write (const scalar, Ostream &) const
 Write scalar as ascii. More...
 
template<class VSType >
Ostream & writeVS (const VSType &, Ostream &) const
 
virtual Ostream & write (const vector &, Ostream &) const
 Write vector. Tab separated ascii. More...
 
virtual Ostream & write (const sphericalTensor &, Ostream &) const
 Write sphericalTensor. Tab separated ascii. More...
 
virtual Ostream & write (const symmTensor &, Ostream &) const
 Write symmTensor. Tab separated ascii. More...
 
virtual Ostream & write (const tensor &, Ostream &) const
 Write tensor. Tab separated ascii. More...
 
template<class VSType >
Foam::Ostream & writeVS (const VSType &value, Ostream &os) const
 

Protected Member Functions

virtual void writeSeparator (Ostream &) const
 Writes a separator. Used by write functions. More...
 
- Protected Member Functions inherited from writer< Type >
fileName getBaseName (const coordSet &, const wordList &) const
 Generates filename from coordSet and sampled fields. More...
 
void writeCoord (const coordSet &, const label sampleI, Ostream &) const
 
void writeTable (const coordSet &, const List< Type > &, Ostream &) const
 Writes single-column ascii write. Column 1 is coordSet coordinate,. More...
 
void writeTable (const coordSet &, const List< const List< Type > * > &, Ostream &os) const
 Writes multi-column ascii write. Column 1 is coordSet coordinate,. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from writer< Type >
static autoPtr< writer > New (const word &writeFormat)
 Return a reference to the selected writer. More...
 
static autoPtr< writer > New (const word &writeFormat, const dictionary &formatOptions)
 Return a reference to the selected writer. More...
 

Detailed Description

template<class Type>
class Foam::csvSetWriter< Type >

Write set in csv format.

Source files

Definition at line 52 of file csvSetWriter.H.

Constructor & Destructor Documentation

◆ csvSetWriter() [1/2]

csvSetWriter ( )

Default construct.

Definition at line 37 of file csvSetWriter.C.

◆ csvSetWriter() [2/2]

csvSetWriter ( const dictionary &  dict)
explicit

Construct with dictionary.

Definition at line 44 of file csvSetWriter.C.

◆ ~csvSetWriter()

virtual ~csvSetWriter ( )
virtualdefault

Destructor.

Member Function Documentation

◆ writeSeparator()

void writeSeparator ( Ostream &  os) const
protectedvirtual

Writes a separator. Used by write functions.

Reimplemented from writer< Type >.

Definition at line 124 of file csvSetWriter.C.

References token::COMMA, and os().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "csv"  )

Runtime type information.

◆ getFileName()

Foam::fileName getFileName ( const coordSet &  ,
const wordList &   
) const
virtual

Generate file name with correct extension.

Implements writer< Type >.

Definition at line 54 of file csvSetWriter.C.

References points.

◆ write() [1/2]

void write ( const coordSet &  ,
const wordList &  ,
const List< const Field< Type > * > &  ,
Ostream &   
) const
virtual

General entry point for writing.

The data is organized in a set of point with one or more values per point

Implements writer< Type >.

Definition at line 65 of file csvSetWriter.C.

References forAll, os(), points, and Foam::writeHeader().

Here is the call graph for this function:

◆ write() [2/2]

void write ( const bool  writeTracks,
const List< scalarField > &  times,
const PtrList< coordSet > &  tracks,
const wordList &  valueSetNames,
const List< List< Field< Type >>> &  valueSets,
Ostream &   
) const
virtual

General entry point for writing of multiple coordSets.

Each coordSet (track) has same data variables. The data is per variable, per track, per point of track. If writeTracks adds connecting lines (wherever applicable)

Implements writer< Type >.

Definition at line 88 of file csvSetWriter.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::nl, os(), and Foam::writeHeader().

Here is the call graph for this function:
The documentation for this class was generated from the following files: