Base class for writing coordinate sets with data. More...

Inheritance diagram for setWriter:

[legend]

Collaboration diagram for setWriter:

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

	declareRunTimeSelectionTable (autoPtr, setWriter, word,(const IOstream::streamFormat writeFormat, const IOstream::compressionType writeCompression),(writeFormat, writeCompression))

	declareRunTimeSelectionTable (autoPtr, setWriter, dict,(const dictionary &dict),(dict))

	setWriter (const IOstream::streamFormat writeFormat, const IOstream::compressionType writeCompression)
	Construct given write options. More...

	setWriter (const dictionary &dict)
	Construct from dictionary. More...

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

virtual void	write (const fileName &outputDir, const fileName &setName, const coordSet &set, const wordList &valueSetNames #define TypeValueSetsConstArg(Type, nullArg)) const =0
	Write a coordSet and associated data. More...

virtual void	write (const fileName &outputDir, const fileName &setName, const coordSet &set, const wordList &valueSetNames #define TypeValueSetsConstArg(Type, nullArg)) const
	Write a coordSet and associated data. More...

template<class ... Args>
void	write (const fileName &outputDir, const fileName &setName, const coordSet &set, const Args &... args) const
	Write fields for a single surface to file. For use in code where. More...

template<class Type >
Foam::Ostream &	writeValue (const Type &value, Ostream &os, const bool align) const

Static Public Member Functions
template<class Types , class Type >
static void	appendTypeValueSet (UPtrList< const Field< Types >> &valueSets, const Field< Type > &valueSet)
	Helper for variadic write. More...

template<class Type >
static void	appendTypeValueSet (UPtrList< const Field< Type >> &valueSets, const Field< Type > &valueSet)
	Helper for variadic write. More...

static void	unpackTypeValueSets (wordList &valueSetNames #define TypeValueSetsNonConstArg(Type, nullArg))
	Helper for variadic write. More...

template<class Type , class ... Args>
static void	unpackTypeValueSets (wordList &valueSetNames #define TypeValueSetsNonConstArg(Type, nullArg) FOR_ALL_FIELD_TYPES(TypeValueSetsNonConstArg), const word &valueSetName, const Field< Type > &valueSet, Args &... args)
	Helper for variadic write. More...

template<class Type , class ... Args>
static void	unpackTypeValueSets (wordList &valueSetNames #define TypeValueSetsNonConstArg(Type, nullArg) FOR_ALL_FIELD_TYPES(TypeValueSetsNonConstArg), const wordList &valueSetNamesPart, const UPtrList< const Field< Type >> &valueSetsPart, Args &... args)
	Helper for variadic write. More...

template<class Type , class ... Args>
static void	unpackTypeValueSets (wordList &valueSetNames #define TypeValueSetsNonConstArg(Type, nullArg) FOR_ALL_FIELD_TYPES(TypeValueSetsNonConstArg), const wordList &valueSetNamesPart, const PtrList< Field< Type >> &valueSetsPart, Args &... args)
	Helper for variadic write. More...

static autoPtr< setWriter >	New (const word &writeType, const IOstream::streamFormat writeFormat=IOstream::ASCII, const IOstream::compressionType writeCompression=IOstream::UNCOMPRESSED)
	Select given write options. More...

static autoPtr< setWriter >	New (const word &writeType, const dictionary &dict)
	Select given a dictionary. More...

Protected Member Functions
virtual void	writeValueSeparator (Ostream &os) const
	Write a value separator. More...

virtual void	writeCoordSeparator (Ostream &os) const
	Write a coordinate separator. More...

virtual void	writeSegmentSeparator (Ostream &os) const
	Write a segment separator. More...

const List< string > &	delimiters () const
	Possible delimiters that need quoting. More...

Ostream &	writeWord (const word &w, Ostream &os, const bool align=false, const unsigned long alignPad=0) const
	Write a word. More...

template<class Type >
Ostream &	writeValue (const Type &value, Ostream &os, const bool align=false) const
	Write a value. More...

void	writeTableHeader (const coordSet &set, const wordList &valueSetNames, #define TypeValueSetsConstArg(Type, nullArg) Ostream &os, const bool align=false, const unsigned long alignPad=0) const
	Write multi-column table header. More...

void	writeTable (const coordSet &set, #define TypeValueSetsConstArg(Type, nullArg) Ostream &os, const bool align=false) const
	Write multi-column table of data. More...

Static Protected Member Functions
static unsigned long	columnWidth (Ostream &os)
	Width of columns in tabulated output. More...

Protected Attributes
IOstream::streamFormat	writeFormat_
	Write format. More...

IOstream::compressionType	writeCompression_
	Write compression. More...

autoPtr< List< string > >	delimiters_
	Possible delimiters that need quoting. Constructed on demand from. More...

Detailed Description

Base class for writing coordinate sets with data.

Example:

    setWriter::New("vtk")->write
    (
        "myDirectory",
        "mySet",
        coordSet(points, true),
        "p", p,
        "U", U
    );

Source files

Definition at line 63 of file setWriter.H.

Constructor & Destructor Documentation

◆ setWriter() [1/2]

setWriter	(	const IOstream::streamFormat	writeFormat,
		const IOstream::compressionType	writeCompression
	)

Construct given write options.

Definition at line 249 of file setWriter.C.

Referenced by setWriter::columnWidth(), and setWriter::writeTable().

Here is the caller graph for this function:

◆ setWriter() [2/2]

setWriter ( const dictionary & dict )

Construct from dictionary.

Definition at line 259 of file setWriter.C.

References setWriter::New().

Here is the call graph for this function:

◆ ~setWriter()

~setWriter ( )

pure virtual

Destructor.

Definition at line 340 of file setWriter.C.

Referenced by setWriter::columnWidth().

Here is the caller graph for this function:

Member Function Documentation

◆ appendTypeValueSet() [1/2]

static void appendTypeValueSet	(	UPtrList< const Field< Types >> &	valueSets,
		const Field< Type > &	valueSet
	)

inlinestatic

Helper for variadic write.

Definition at line 72 of file setWriter.H.

◆ appendTypeValueSet() [2/2]

static void appendTypeValueSet	(	UPtrList< const Field< Type >> &	valueSets,
		const Field< Type > &	valueSet
	)

inlinestatic

Helper for variadic write.

Definition at line 84 of file setWriter.H.

References setWriter::unpackTypeValueSets().

Here is the call graph for this function:

◆ unpackTypeValueSets() [1/4]

static void unpackTypeValueSets ( wordList &valueSetNames #define TypeValueSetsNonConstArgType, nullArg )

inlinestatic

Helper for variadic write.

Definition at line 95 of file setWriter.H.

Referenced by setWriter::appendTypeValueSet(), setWriter::unpackTypeValueSets(), surfaceWriter::write(), and setWriter::write().

Here is the caller graph for this function:

◆ unpackTypeValueSets() [2/4]

static void unpackTypeValueSets	(	wordList &valueSetNames #define	TypeValueSetsNonConstArgType, nullArg) FOR_ALL_FIELD_TYPES(TypeValueSetsNonConstArg,
		const word &	valueSetName,
		const Field< Type > &	valueSet,
		Args &...	args
	)

inlinestatic

Helper for variadic write.

Definition at line 107 of file setWriter.H.

References AppendTypeValueSet, Foam::FOR_ALL_FIELD_TYPES(), TypeValueSetsParameter, and setWriter::unpackTypeValueSets().

Here is the call graph for this function:

◆ unpackTypeValueSets() [3/4]

static void unpackTypeValueSets	(	wordList &valueSetNames #define	TypeValueSetsNonConstArgType, nullArg) FOR_ALL_FIELD_TYPES(TypeValueSetsNonConstArg,
		const wordList &	valueSetNamesPart,
		const UPtrList< const Field< Type >> &	valueSetsPart,
		Args &...	args
	)

inlinestatic

Helper for variadic write.

Definition at line 138 of file setWriter.H.

References AppendTypeValueSet, Foam::FOR_ALL_FIELD_TYPES(), forAll, TypeValueSetsParameter, and setWriter::unpackTypeValueSets().

Here is the call graph for this function:

◆ unpackTypeValueSets() [4/4]

static void unpackTypeValueSets	(	wordList &valueSetNames #define	TypeValueSetsNonConstArgType, nullArg) FOR_ALL_FIELD_TYPES(TypeValueSetsNonConstArg,
		const wordList &	valueSetNamesPart,
		const PtrList< Field< Type >> &	valueSetsPart,
		Args &...	args
	)

inlinestatic

Helper for variadic write.

Definition at line 172 of file setWriter.H.

References Foam::FOR_ALL_FIELD_TYPES(), TypeValueSetsParameter, and setWriter::unpackTypeValueSets().

Here is the call graph for this function:

◆ writeValueSeparator()

void writeValueSeparator ( Ostream & os ) const

protectedvirtual

Write a value separator.

Reimplemented in csvSetWriter.

Definition at line 43 of file setWriter.C.

References token::SPACE.

Referenced by rawSetWriter::write().

Here is the caller graph for this function:

◆ writeCoordSeparator()

void writeCoordSeparator ( Ostream & os ) const

protectedvirtual

Write a coordinate separator.

Definition at line 49 of file setWriter.C.

References Foam::nl.

◆ writeSegmentSeparator()

void writeSegmentSeparator ( Ostream & os ) const

protectedvirtual

Write a segment separator.

Reimplemented in csvSetWriter, and rawSetWriter.

Definition at line 55 of file setWriter.C.

References Foam::nl.

◆ delimiters()

const Foam::List< Foam::string > & delimiters ( ) const

protected

Possible delimiters that need quoting.

Definition at line 61 of file setWriter.C.

References OStringStream::rewind(), OStringStream::str(), and setWriter::writeWord().

Here is the call graph for this function:

◆ columnWidth()

static unsigned long columnWidth ( Ostream & os )

inlinestaticprotected

Width of columns in tabulated output.

Definition at line 228 of file setWriter.H.

References IOstream::ASCII, setWriter::declareRunTimeSelectionTable(), dict, Foam::FOR_ALL_FIELD_TYPES(), setWriter::New(), Ostream::precision(), setWriter::setWriter(), setWriter::TypeName(), TypeValueSetsConstArg, IOstream::UNCOMPRESSED, setWriter::write(), setWriter::writeTable(), setWriter::writeTableHeader(), setWriter::writeValue(), setWriter::writeWord(), and setWriter::~setWriter().

Here is the call graph for this function:

◆ writeWord()

Foam::Ostream & writeWord	(	const word &	w,
		Ostream &	os,
		const bool	align = `false`,
		const unsigned long	alignPad = `0`
	)		const

inlineprotected

Write a word.

Definition at line 83 of file setWriter.C.

References forAll, s(), and setWriter::writeTableHeader().

Referenced by setWriter::columnWidth(), and setWriter::delimiters().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeValue() [1/2]

Ostream& writeValue	(	const Type &	value,
		Ostream &	os,
		const bool	align = `false`
	)		const

protected

Write a value.

Referenced by setWriter::columnWidth().

Here is the caller graph for this function:

◆ writeTableHeader()

void writeTableHeader	(	const coordSet &	set,
		const wordList &	valueSetNames,
		#define TypeValueSetsConstArg(Type, nullArg) Ostream &	os,
		const bool	align = `false`,
		const unsigned long	alignPad = `0`
	)		const

protected

Write multi-column table header.

Definition at line 119 of file setWriter.C.

References Foam::first(), Foam::FOR_ALL_FIELD_TYPES(), forAll, scalarName, setWriter::writeTable(), and WriteTypeValueSetNames.

Referenced by setWriter::columnWidth(), rawSetWriter::write(), csvSetWriter::write(), and setWriter::writeWord().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeTable()

void writeTable	(	const coordSet &	set,
		#define TypeValueSetsConstArg(Type, nullArg) Ostream &	os,
		const bool	align = `false`
	)		const

protected

Write multi-column table of data.

Definition at line 193 of file setWriter.C.

References Foam::first(), Foam::FOR_ALL_FIELD_TYPES(), forAll, setWriter::setWriter(), and WriteTypeValueSets.

Referenced by setWriter::columnWidth(), rawSetWriter::write(), csvSetWriter::write(), and setWriter::writeTableHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "setWriter" )

Runtime type information.

Referenced by setWriter::columnWidth().

Here is the caller graph for this function:

◆ declareRunTimeSelectionTable() [1/2]

declareRunTimeSelectionTable	(	autoPtr	,
		setWriter	,
		word	,
		(const IOstream::streamFormat writeFormat, const IOstream::compressionType writeCompression)	,
		(writeFormat, writeCompression)
	)

Referenced by setWriter::columnWidth().

Here is the caller graph for this function:

◆ declareRunTimeSelectionTable() [2/2]

declareRunTimeSelectionTable	(	autoPtr	,
		setWriter	,
		dict	,
		(const dictionary &dict)	,
		(dict)
	)

◆ New() [1/2]

Foam::autoPtr< Foam::setWriter > New	(	const word &	writeType,
		const IOstream::streamFormat	writeFormat = `IOstream::ASCII`,
		const IOstream::compressionType	writeCompression = `IOstream::UNCOMPRESSED`
	)

static

Select given write options.

Definition at line 279 of file setWriter.C.

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

Referenced by setWriter::columnWidth(), setWriter::New(), sampledSets::read(), histogram::read(), layerAverage::read(), regionSizeDistribution::read(), streamlines::read(), and setWriter::setWriter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ New() [2/2]

Foam::autoPtr< Foam::setWriter > New	(	const word &	writeType,
		const dictionary &	dict
	)

static

Select given a dictionary.

Definition at line 303 of file setWriter.C.

References IOstream::ASCII, IOstream::compressionEnum(), dict, IOstream::formatEnum(), dictionary::found(), dictionary::lookup(), setWriter::New(), and IOstream::UNCOMPRESSED.

Here is the call graph for this function:

◆ write() [1/3]

virtual void write	(	const fileName &	outputDir,
		const fileName &	setName,
		const coordSet &	set,
		const wordList &valueSetNames #define	TypeValueSetsConstArgType, nullArg
	)		const

pure virtual

Write a coordSet and associated data.

Implemented in csvSetWriter, rawSetWriter, gnuplotSetWriter, noSetWriter, vtkSetWriter, and ensightSetWriter.

Referenced by setWriter::columnWidth(), and setWriter::write().

Here is the caller graph for this function:

◆ write() [2/3]

virtual void write	(	const fileName &	outputDir,
		const fileName &	setName,
		const coordSet &	set,
		const wordList &valueSetNames #define	TypeValueSetsConstArgType, nullArg
	)		const

inlinevirtual

Write a coordSet and associated data.

Reimplemented in csvSetWriter, rawSetWriter, gnuplotSetWriter, noSetWriter, vtkSetWriter, and ensightSetWriter.

Definition at line 364 of file setWriter.H.

References Foam::FOR_ALL_FIELD_TYPES(), TypeValueSetsParameter, and setWriter::write().

Here is the call graph for this function:

◆ write() [3/3]

void write	(	const fileName &	outputDir,
		const fileName &	setName,
		const coordSet &	set,
		const Args &...	args
	)		const

inline

Write fields for a single surface to file. For use in code where.

the fields that are to be written are known. Takes any number of name, values arguments at the end. E.g.:

write ( Output options "myDirectory", "mySet",

Geometry coordSet(points, true),

Fields "p", Field<scalar>(points.size(), ...), "U", Field<vector>(points.size(), ...) );

Definition at line 408 of file setWriter.H.

References DeclareTypeValueSets, Foam::FOR_ALL_FIELD_TYPES(), TypeValueSetsParameter, setWriter::unpackTypeValueSets(), and setWriter::write().

Here is the call graph for this function:

◆ writeValue() [2/2]

Foam::Ostream& writeValue	(	const Type &	value,
		Ostream &	os,
		const bool	align
	)		const

Definition at line 33 of file setWriterTemplates.C.

References Foam::component(), and Foam::setw().

Here is the call graph for this function:

Member Data Documentation

◆ writeFormat_

IOstream::streamFormat writeFormat_

protected

Write format.

Definition at line 203 of file setWriter.H.

◆ writeCompression_

IOstream::compressionType writeCompression_

protected

Write compression.

Definition at line 206 of file setWriter.H.

Referenced by rawSetWriter::write(), and csvSetWriter::write().

◆ delimiters_

autoPtr<List<string> > delimiters_

mutableprotected

Possible delimiters that need quoting. Constructed on demand from.

the write.*Separator functions.

Definition at line 210 of file setWriter.H.

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ setWriter() [1/2]

◆ setWriter() [2/2]

◆ ~setWriter()

Member Function Documentation

◆ appendTypeValueSet() [1/2]

◆ appendTypeValueSet() [2/2]

◆ unpackTypeValueSets() [1/4]

◆ unpackTypeValueSets() [2/4]

◆ unpackTypeValueSets() [3/4]

◆ unpackTypeValueSets() [4/4]

◆ writeValueSeparator()

◆ writeCoordSeparator()

◆ writeSegmentSeparator()

◆ delimiters()

◆ columnWidth()

◆ writeWord()

◆ writeValue() [1/2]

◆ writeTableHeader()

◆ writeTable()

◆ TypeName()

◆ declareRunTimeSelectionTable() [1/2]

◆ declareRunTimeSelectionTable() [2/2]

◆ New() [1/2]

◆ New() [2/2]

◆ write() [1/3]

◆ write() [2/3]

◆ write() [3/3]

◆ writeValue() [2/2]

Member Data Documentation

◆ writeFormat_

◆ writeCompression_

◆ delimiters_