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

Inheritance diagram for setWriter< Type >:

[legend]

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

	declareRunTimeSelectionTable (autoPtr, setWriter, word,(),())

	setWriter ()
	Construct null. More...

virtual	~setWriter ()=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< setWriter >	New (const word &writeFormat)
	Return a reference to the selected setWriter. 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::setWriter< 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 setWriter of xmgr type
    autoPtr<setWriter<scalar>> scalarFormatter =
        setWriter<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 79 of file setWriter.H.

Constructor & Destructor Documentation

◆ setWriter()

setWriter ( )

Construct null.

Definition at line 140 of file setWriter.C.

◆ ~setWriter()

~setWriter ( )

pure virtual

Destructor.

Definition at line 147 of file setWriter.C.

Member Function Documentation

◆ getBaseName()

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

protected

Generates filename from coordSet and sampled fields.

Definition at line 60 of file setWriter.C.

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

Here is the caller graph for this function:

◆ writeCoord()

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

protected

Definition at line 78 of file setWriter.C.

Referenced by setWriter< Foam::SphericalTensor >::getBaseName().

Here is the caller graph for this function:

◆ writeTable() [1/2]

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 setWriter.C.

Referenced by gnuplotSetWriter< Type >::write(), rawSetWriter< Type >::write(), xmgraceSetWriter< Type >::write(), jplotSetWriter< Type >::write(), csvSetWriter< Type >::write(), setWriter< Foam::SphericalTensor >::writeCoord(), and setWriter< Foam::SphericalTensor >::writeTable().

Here is the caller graph for this function:

◆ writeTable() [2/2]

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 setWriter.C.

◆ writeSeparator()

void writeSeparator ( Ostream & os ) const

protectedvirtual

Writes a separator. Used by write functions.

Reimplemented in csvSetWriter< Type >.

Definition at line 205 of file setWriter.C.

Referenced by setWriter< Foam::SphericalTensor >::writeVS().

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "setWriter< Type >" )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

◆ New()

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

static

Return a reference to the selected setWriter.

Definition at line 35 of file setWriter.C.

Referenced by histogram::read(), regionSizeDistribution::read(), and streamlines::read().

Here is the caller graph for this function:

◆ getFileName()

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 >.

◆ write() [1/8]

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

pure virtual

General entry point for writing.

The data is organised 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(), setWriter< Foam::SphericalTensor >::write(), setWriter< Foam::SphericalTensor >::writeSeparator(), and setWriter< Foam::SphericalTensor >::~setWriter().

Here is the caller graph for this function:

◆ write() [2/8]

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 organised in a set of point with one or more values per point

Definition at line 155 of file setWriter.C.

◆ write() [3/8]

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 >.

◆ write() [4/8]

Foam::Ostream & write	(	const scalar	value,
		Ostream &	os
	)		const

virtual

Write scalar as ascii.

Definition at line 173 of file setWriter.C.

◆ writeVS() [1/2]

Ostream& writeVS	(	const VSType &	,
		Ostream &
	)		const

Referenced by setWriter< Foam::SphericalTensor >::write().

Here is the caller graph for this function:

◆ write() [5/8]

Foam::Ostream & write	(	const vector &	value,
		Ostream &	os
	)		const

virtual

Write vector. Tab separated ascii.

Definition at line 215 of file setWriter.C.

◆ write() [6/8]

Foam::Ostream & write	(	const sphericalTensor &	value,
		Ostream &	os
	)		const

virtual

Write sphericalTensor. Tab separated ascii.

Definition at line 226 of file setWriter.C.

◆ write() [7/8]

Foam::Ostream & write	(	const symmTensor &	value,
		Ostream &	os
	)		const

virtual

Write symmTensor. Tab separated ascii.

Definition at line 237 of file setWriter.C.

◆ write() [8/8]

Foam::Ostream & write	(	const tensor &	value,
		Ostream &	os
	)		const

virtual

Write tensor. Tab separated ascii.

Definition at line 248 of file setWriter.C.

◆ writeVS() [2/2]

Foam::Ostream& writeVS	(	const VSType &	value,
		Ostream &	os
	)		const

Definition at line 185 of file setWriter.C.

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

src/sampling/sampledSet/writers/setWriter.H
src/sampling/sampledSet/writers/setWriter.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

template<class Type> class Foam::setWriter< Type >

Constructor & Destructor Documentation

◆ setWriter()

◆ ~setWriter()

Member Function Documentation

◆ getBaseName()

◆ writeCoord()

◆ writeTable() [1/2]

◆ writeTable() [2/2]

◆ writeSeparator()

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New()

◆ getFileName()

◆ write() [1/8]

◆ write() [2/8]

◆ write() [3/8]

◆ write() [4/8]

◆ writeVS() [1/2]

◆ write() [5/8]

◆ write() [6/8]

◆ write() [7/8]

◆ write() [8/8]

◆ writeVS() [2/2]

template<class Type>
class Foam::setWriter< Type >