Base class for graphics format writing. Entry points are. More...

Inheritance diagram for writer< Type >:

[legend]

Public Member Functions
	TypeName ("writer")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, writer, word,(),())

	writer ()
	Construct null. More...

virtual	~writer ()=0
	Destructor. More...

virtual fileName	getFileName (const coordSet &, const wordList &) const =0
	Generate file name with correct extension. More...

virtual void	write (const coordSet &, const wordList &, const List< const Field< Type > * > &, Ostream &) const =0
	General entry point for writing. More...

virtual void	write (const coordSet &, const wordList &, const List< Field< Type >> &, Ostream &) const
	General entry point for writing. More...

virtual void	write (const bool writeTracks, const PtrList< coordSet > &, const wordList &valueSetNames, const List< List< Field< Type >>> &, Ostream &) const =0
	General entry point for writing of multiple coordSets. 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

Static Public Member Functions
static autoPtr< writer >	New (const word &writeFormat)
	Return a reference to the selected writer. More...

Protected Member Functions
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...

virtual void	writeSeparator (Ostream &os) const
	Writes a separator. Used by write functions. More...

Detailed Description

template<class Type>
class Foam::writer< Type >

Base class for graphics format writing. Entry points are.

- write(..).
Write to an Ostream a table of points with corresponding values.

write(scalar/vector/sphericalTensor/symmTensor/tensor).
Write single scalar/vector/sphericalTensor/symmTensor/tensor. Default is to write space separated components.

Example:

    // Construct writer of xmgr type
    autoPtr<writer<scalar>> scalarFormatter(writer<scalar>::New("xmgr"));

    // Output list of points and corresponding values
    scalarFormatter().write
    (
        coordSet(...)
        "U.component(0)",   // name of values
        vals                // values
    );

Source files

Definition at line 78 of file writer.H.

Constructor & Destructor Documentation

writer ( )

Construct null.

Definition at line 140 of file writer.C.

~writer ( )

pure virtual

Destructor.

Definition at line 147 of file writer.C.

References writer< Type >::write().

Here is the call graph for this function:

Member Function Documentation

Foam::fileName getBaseName	(	const coordSet &	points,
		const wordList &	valueSets
	)		const

protected

Generates filename from coordSet and sampled fields.

Definition at line 60 of file writer.C.

References forAll, coordSet::name(), and writer< Type >::writeCoord().

Referenced by ensightSetWriter< Type >::getFileName(), rawSetWriter< Type >::getFileName(), xmgraceSetWriter< Type >::getFileName(), vtkSetWriter< Type >::getFileName(), gnuplotSetWriter< Type >::getFileName(), jplotSetWriter< Type >::getFileName(), csvSetWriter< Type >::getFileName(), and writer< Type >::New().

Here is the call graph for this function:

Here is the caller graph for this function:

void writeCoord	(	const coordSet &	points,
		const label	sampleI,
		Ostream &	os
	)		const

protected

Definition at line 78 of file writer.C.

References coordSet::hasVectorAxis(), coordSet::scalarCoord(), coordSet::vectorCoord(), write(), and writer< Type >::writeTable().

Referenced by writer< Type >::getBaseName().

Here is the call graph for this function:

Here is the caller graph for this function:

void writeTable	(	const coordSet &	points,
		const List< Type > &	values,
		Ostream &	os
	)		const

protected

Writes single-column ascii write. Column 1 is coordSet coordinate,.

columns 2 is the value. Uses write() function to write coordinate in correct format.

Definition at line 97 of file writer.C.

References forAll, Foam::nl, and write().

Referenced by gnuplotSetWriter< Type >::write(), rawSetWriter< Type >::write(), xmgraceSetWriter< Type >::write(), jplotSetWriter< Type >::write(), csvSetWriter< Type >::write(), and writer< Type >::writeCoord().

Here is the call graph for this function:

Here is the caller graph for this function:

void writeTable	(	const coordSet &	points,
		const List< const List< Type > * > &	valuesPtrList,
		Ostream &	os
	)		const

protected

Writes multi-column ascii write. Column 1 is coordSet coordinate,.

columns 2..n are the values. Uses write() function to write coordinate in correct format.

Definition at line 115 of file writer.C.

References forAll, Foam::nl, and write().

Here is the call graph for this function:

void writeSeparator ( Ostream & os ) const

protectedvirtual

Writes a separator. Used by write functions.

Reimplemented in csvSetWriter< Type >.

Definition at line 205 of file writer.C.

References writer< Type >::write().

Referenced by writer< Type >::writeVS().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeName ( "writer< Type >" )

Runtime type information.

declareRunTimeSelectionTable	(	autoPtr	,
		writer< Type >	,
		word	,
		()	,
		()
	)

Foam::autoPtr< Foam::writer< Type > > New ( const word & writeFormat )

static

Return a reference to the selected writer.

Definition at line 35 of file writer.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, writer< Type >::getBaseName(), and Foam::nl.

Referenced by histogram::read(), streamLine::read(), regionSizeDistribution::read(), and wallBoundedStreamLine::read().

Here is the call graph for this function:

Here is the caller graph for this function:

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

pure virtual

Generate file name with correct extension.

Implemented in csvSetWriter< Type >, jplotSetWriter< Type >, ensightSetWriter< Type >, gnuplotSetWriter< Type >, rawSetWriter< Type >, vtkSetWriter< Type >, and xmgraceSetWriter< Type >.

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

pure virtual

General entry point for writing.

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

Implemented in csvSetWriter< Type >, jplotSetWriter< Type >, ensightSetWriter< Type >, gnuplotSetWriter< Type >, rawSetWriter< Type >, vtkSetWriter< Type >, and xmgraceSetWriter< Type >.

Referenced by vtkSetWriter< Type >::write(), writer< Type >::write(), writer< Type >::writeSeparator(), and writer< Type >::~writer().

Here is the caller graph for this function:

void write	(	const coordSet &	points,
		const wordList &	valueSetNames,
		const List< Field< Type >> &	valueSets,
		Ostream &	os
	)		const

virtual

General entry point for writing.

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

Definition at line 155 of file writer.C.

References forAll, List< T >::size(), write(), and writer< Type >::write().

Here is the call graph for this function:

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

pure 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)

Implemented in csvSetWriter< Type >, jplotSetWriter< Type >, ensightSetWriter< Type >, gnuplotSetWriter< Type >, rawSetWriter< Type >, vtkSetWriter< Type >, and xmgraceSetWriter< Type >.