Ensight output with specialized write() for strings, integers and floats. Correctly handles binary write as well. More...

Inheritance diagram for ensightFile:

[legend]

Collaboration diagram for ensightFile:

[legend]

Public Member Functions
	ensightFile (const fileName &pathname, IOstream::streamFormat format=IOstream::BINARY)

	ensightFile (const fileName &path, const fileName &name, IOstream::streamFormat format=IOstream::BINARY)

	~ensightFile ()=default

virtual Ostream &	writeKeyword (const keyType &key)

Ostream &	writeBinaryHeader ()

Ostream &	writeString (const char *str)

Ostream &	writeString (const std::string &str)

Ostream &	writeUndef ()

virtual bool	write (const token &)

virtual Ostream &	write (const char)

virtual Ostream &	write (const char *buf, std::streamsize count)

virtual Ostream &	write (const char *str)

virtual Ostream &	write (const word &str)

virtual Ostream &	write (const string &str)

virtual Ostream &	write (const int32_t val)

virtual Ostream &	write (const int64_t val)

Ostream &	write (const label value, const label fieldWidth)

virtual Ostream &	write (const floatScalar val)

virtual Ostream &	write (const doubleScalar val)

void	newline ()

void	beginPart (const label index)

void	beginParticleCoordinates (const label nparticles)

void	writeLabels (const UList< label > &list)

template<class Addr >
void	writeLabels (const IndirectListBase< label, Addr > &list)

void	writeList (const UList< label > &field)

void	writeList (const UList< scalar > &field)

template<class Addr >
void	writeList (const IndirectListBase< scalar, Addr > &field)

Public Member Functions inherited from OFstream
	ClassName ("OFstream")

	OFstream (std::nullptr_t)

	OFstream (const fileName &pathname, IOstreamOption streamOpt=IOstreamOption(), const bool append=false)

	OFstream (const fileName &pathname, IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver=IOstreamOption::currentVersion, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED, const bool append=false)

	~OFstream ()=default

virtual std::ostream &	stdStream ()

virtual const std::ostream &	stdStream () const

virtual void	rewind ()

void	print (Ostream &os) const

virtual const fileName &	name () const

virtual fileName &	name ()

Public Member Functions inherited from OSstream
	OSstream (const OSstream &)=default

void	operator= (const OSstream &)=delete

	OSstream (std::ostream &os, const string &streamName, IOstreamOption streamOpt=IOstreamOption())

	OSstream (std::ostream &os, const string &streamName, IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver=IOstreamOption::currentVersion, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)

virtual const fileName &	name () const

virtual fileName &	name ()

virtual ios_base::fmtflags	flags () const

virtual Ostream &	writeQuoted (const std::string &str, const bool quoted=true)

virtual Ostream &	writeRaw (const char *data, std::streamsize count)

virtual bool	beginRawWrite (std::streamsize count)

virtual bool	endRawWrite ()

virtual void	indent ()

virtual ios_base::fmtflags	flags (const ios_base::fmtflags f)

virtual void	flush ()

virtual void	endl ()

virtual char	fill () const

virtual char	fill (const char fillch)

virtual int	width () const

virtual int	width (const int w)

virtual int	precision () const

virtual int	precision (const int p)

Public Member Functions inherited from Ostream
	Ostream (const Ostream &)=default

virtual	~Ostream ()=default

	Ostream (IOstreamOption streamOpt=IOstreamOption())

	Ostream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver=IOstreamOption::currentVersion, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)

virtual Ostream &	write (const keyType &kw)

unsigned short	indentSize () const noexcept

unsigned short	indentSize (unsigned short val) noexcept

unsigned short	indentLevel () const noexcept

unsigned short	indentLevel (unsigned short val) noexcept

void	incrIndent () noexcept

void	decrIndent ()

virtual Ostream &	beginBlock (const keyType &kw)

virtual Ostream &	beginBlock ()

virtual Ostream &	endBlock ()

virtual Ostream &	endEntry ()

template<class T >
Ostream &	writeEntry (const keyType &key, const T &value)

template<class T >
Ostream &	writeEntryIfDifferent (const word &key, const T &value1, const T &value2)

Ostream &	operator() () const

unsigned short &	indentLevel () noexcept

unsigned short &	indentSize () noexcept

Public Member Functions inherited from IOstream
	IOstream (const IOstream &)=default

virtual	~IOstream ()=default

	IOstream (IOstreamOption streamOpt=IOstreamOption())

	IOstream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)

fileName	relativeName () const

virtual bool	check (const char *operation) const

bool	fatalCheck (const char *operation) const

bool	opened () const noexcept

bool	closed () const noexcept

bool	good () const noexcept

bool	eof () const noexcept

bool	fail () const noexcept

bool	bad () const noexcept

	operator bool () const noexcept

bool	operator! () const noexcept

unsigned	labelByteSize () const noexcept

unsigned	scalarByteSize () const noexcept

void	setLabelByteSize (unsigned nbytes) noexcept

void	setScalarByteSize (unsigned nbytes) noexcept

template<class T = label>
std::enable_if< std::is_integral< T >::value, bool >::type	checkLabelSize () const noexcept

template<class T = scalar>
std::enable_if< std::is_floating_point< T >::value, bool >::type	checkScalarSize () const noexcept

label	lineNumber () const noexcept

label &	lineNumber () noexcept

label	lineNumber (const label num) noexcept

void	setEof () noexcept

void	setFail () noexcept

void	setBad ()

ios_base::fmtflags	setf (const ios_base::fmtflags f)

ios_base::fmtflags	setf (const ios_base::fmtflags f, const ios_base::fmtflags mask)

void	unsetf (const ios_base::fmtflags f)

void	print (Ostream &os, const int streamState) const

InfoProxy< IOstream >	info () const

Public Member Functions inherited from IOstreamOption
constexpr	IOstreamOption (streamFormat fmt=streamFormat::ASCII, compressionType comp=compressionType::UNCOMPRESSED) noexcept

constexpr	IOstreamOption (streamFormat fmt, compressionType comp, versionNumber ver) noexcept

constexpr	IOstreamOption (streamFormat fmt, versionNumber ver, compressionType comp=compressionType::UNCOMPRESSED) noexcept

	IOstreamOption (const IOstreamOption &opt, streamFormat fmt) noexcept

streamFormat	format () const noexcept

streamFormat	format (const streamFormat fmt) noexcept

streamFormat	format (const word &formatName)

compressionType	compression () const noexcept

compressionType	compression (const compressionType comp) noexcept

compressionType	compression (const word &compName)

versionNumber	version () const noexcept

versionNumber	version (const versionNumber ver) noexcept

versionNumber	version (const token &tok)

Static Public Member Functions
static const ensightFile &	null ()

static bool	allowUndef ()

static string	mask ()

static string	subDir (const label)

static void	subDirWidth (const label)

static label	subDirWidth ()

static bool	allowUndef (bool enabled)

static scalar	undefValue (const scalar value)

static bool	isUndef (const UList< scalar > &field)

template<class Addr >
static bool	isUndef (const IndirectListBase< scalar, Addr > &field)

Static Public Member Functions inherited from IOstream
static unsigned int	defaultPrecision () noexcept

static unsigned int	defaultPrecision (unsigned int prec) noexcept

Static Public Member Functions inherited from IOstreamOption
static streamFormat	formatEnum (const word &formatName, const streamFormat deflt=streamFormat::ASCII)

static streamFormat	formatEnum (const word &key, const dictionary &dict, const streamFormat deflt=streamFormat::ASCII)

static compressionType	compressionEnum (const word &compName, const compressionType deflt=compressionType::UNCOMPRESSED)

static compressionType	compressionEnum (const word &key, const dictionary &dict, const compressionType deflt=compressionType::UNCOMPRESSED)

Static Public Attributes
static const char *const	coordinates = "coordinates"

Static Public Attributes inherited from IOstream
static unsigned int	precision_

Static Public Attributes inherited from IOstreamOption
static const Enum< streamFormat >	formatNames

static const versionNumber	currentVersion

Additional Inherited Members
Public Types inherited from IOstream
enum	streamAccess : char { CLOSED = 0, OPENED }

Public Types inherited from IOstreamOption
enum	streamFormat : char { ASCII = 0, BINARY }

enum	compressionType : char { UNCOMPRESSED = 0, COMPRESSED }

Protected Member Functions inherited from IOstream
void	setOpened () noexcept

void	setClosed () noexcept

void	setState (std::ios_base::iostate state) noexcept

void	setGood () noexcept

Protected Attributes inherited from Ostream
unsigned short	indentSize_ = 4

unsigned short	indentLevel_ = 0

Protected Attributes inherited from IOstream
std::ios_base::iostate	ioState_

streamAccess	openClosed_

unsigned char	sizeofLabel_

unsigned char	sizeofScalar_

label	lineNumber_

Static Protected Attributes inherited from Ostream
static constexpr const unsigned short	entryIndentation_ = 16

Static Protected Attributes inherited from IOstream
static fileName	staticName_

Detailed Description

Ensight output with specialized write() for strings, integers and floats. Correctly handles binary write as well.

Definition at line 46 of file ensightFile.H.

Constructor & Destructor Documentation

◆ ensightFile() [1/2]

ensightFile	(	const fileName &	pathname,
		IOstream::streamFormat	format = `IOstream::BINARY`
	)

explicit

Definition at line 113 of file ensightFile.C.

◆ ensightFile() [2/2]

ensightFile	(	const fileName &	path,
		const fileName &	name,
		IOstream::streamFormat	format = `IOstream::BINARY`
	)

Definition at line 125 of file ensightFile.C.

◆ ~ensightFile()

~ensightFile ( )

default

Member Function Documentation

◆ null()

static const ensightFile& null ( )

inlinestatic

Definition at line 88 of file ensightFile.H.

◆ allowUndef() [1/2]

bool allowUndef ( )

static

Definition at line 139 of file ensightFile.C.

◆ mask()

Foam::string mask ( )

static

Definition at line 43 of file ensightFile.C.

◆ subDir()

Foam::string subDir ( const label n )

static

Definition at line 49 of file ensightFile.C.

References n.

◆ subDirWidth() [1/2]

void subDirWidth ( const label n )

static

Definition at line 58 of file ensightFile.C.

References n.

◆ subDirWidth() [2/2]

Foam::label subDirWidth ( )

static

Definition at line 76 of file ensightFile.C.

◆ allowUndef() [2/2]

bool allowUndef ( bool enabled )

static

Definition at line 145 of file ensightFile.C.

◆ undefValue()

Foam::scalar undefValue ( const scalar value )

static

Definition at line 153 of file ensightFile.C.

◆ writeKeyword()

Foam::Ostream & writeKeyword ( const keyType & key )

virtual

Reimplemented from Ostream.

Reimplemented in ensightGeoFile.

Definition at line 313 of file ensightFile.C.

References Foam::glTF::key(), and Foam::vtk::write().

Referenced by ensightWriter::writeCollated(), and ensightWriter::writeUncollated().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeBinaryHeader()

Foam::Ostream & writeBinaryHeader ( )

Definition at line 332 of file ensightFile.C.

References IOstreamOption::BINARY, and format().

Here is the call graph for this function:

◆ writeString() [1/2]

Foam::Ostream & writeString ( const char * str )

Definition at line 164 of file ensightFile.C.

References IOstreamOption::BINARY, format(), and Foam::vtk::write().

Here is the call graph for this function:

◆ writeString() [2/2]

Foam::Ostream & writeString ( const std::string & str )

Definition at line 186 of file ensightFile.C.

◆ writeUndef()

Foam::Ostream & writeUndef ( )

Definition at line 306 of file ensightFile.C.

References Foam::vtk::write().

Here is the call graph for this function:

◆ write() [1/11]

virtual bool write ( const token & )

inlinevirtual

Reimplemented from OSstream.

Definition at line 170 of file ensightFile.H.

References NotImplemented.

◆ write() [2/11]

virtual Ostream& write ( const char )

inlinevirtual

Reimplemented from OSstream.

Definition at line 177 of file ensightFile.H.

References NotImplemented.

◆ write() [3/11]

Foam::Ostream & write	(	const char *	buf,
		std::streamsize	count
	)

virtual

Reimplemented from OSstream.

Definition at line 211 of file ensightFile.C.

References Foam::BitOps::count().

Here is the call graph for this function:

◆ write() [4/11]

Foam::Ostream & write ( const char * str )

virtual

Reimplemented from OSstream.

Definition at line 192 of file ensightFile.C.

◆ write() [5/11]

Foam::Ostream & write ( const word & str )

virtual

Reimplemented from OSstream.

Definition at line 198 of file ensightFile.C.

◆ write() [6/11]

Foam::Ostream & write ( const string & str )

virtual

Reimplemented from OSstream.

Definition at line 204 of file ensightFile.C.

◆ write() [7/11]

Foam::Ostream & write ( const int32_t val )

virtual

Reimplemented from OSstream.

Definition at line 221 of file ensightFile.C.

References IOstreamOption::BINARY, format(), and Foam::vtk::write().

Here is the call graph for this function:

◆ write() [8/11]

Foam::Ostream & write ( const int64_t val )

virtual

Reimplemented from OSstream.

Definition at line 241 of file ensightFile.C.

References Foam::narrowInt32(), and Foam::vtk::write().

Here is the call graph for this function:

◆ write() [9/11]

Foam::Ostream & write	(	const label	value,
		const label	fieldWidth
	)

Definition at line 278 of file ensightFile.C.

References IOstreamOption::BINARY, format(), and Foam::vtk::write().

Here is the call graph for this function:

◆ write() [10/11]

Foam::Ostream & write ( const floatScalar val )

virtual

Reimplemented from OSstream.

Definition at line 249 of file ensightFile.C.

References IOstreamOption::BINARY, format(), and Foam::vtk::write().

Here is the call graph for this function:

◆ write() [11/11]

Foam::Ostream & write ( const doubleScalar val )

virtual

Reimplemented from OSstream.

Definition at line 269 of file ensightFile.C.

References Foam::narrowFloat(), and Foam::vtk::write().

Here is the call graph for this function:

◆ newline()

void newline ( )

Definition at line 297 of file ensightFile.C.

References IOstreamOption::ASCII, format(), and Foam::nl.

Here is the call graph for this function:

◆ beginPart()

void beginPart ( const label index )

Definition at line 347 of file ensightFile.C.

References Foam::vtk::write().

Here is the call graph for this function:

◆ beginParticleCoordinates()

void beginParticleCoordinates ( const label nparticles )

Definition at line 356 of file ensightFile.C.

References Foam::vtk::write().

Here is the call graph for this function:

◆ writeLabels() [1/2]

void writeLabels ( const UList< label > & list )

Definition at line 365 of file ensightFile.C.

References Foam::vtk::write().

Here is the call graph for this function:

◆ writeLabels() [2/2]

void writeLabels ( const IndirectListBase< label, Addr > & list )

Definition at line 41 of file ensightFileTemplates.C.

References Foam::vtk::write().

Here is the call graph for this function:

◆ writeList() [1/3]

void writeList ( const UList< label > & field )

Definition at line 375 of file ensightFile.C.

References field(), and Foam::vtk::write().

Here is the call graph for this function:

◆ writeList() [2/3]

void writeList ( const UList< scalar > & field )

Definition at line 385 of file ensightFile.C.

References field(), and Foam::vtk::write().

Here is the call graph for this function:

◆ writeList() [3/3]

void writeList ( const IndirectListBase< scalar, Addr > & field )

Definition at line 52 of file ensightFileTemplates.C.

References field(), and Foam::vtk::write().

Here is the call graph for this function:

◆ isUndef() [1/2]

bool isUndef ( const UList< scalar > & field )

static

Definition at line 82 of file ensightFile.C.

References field().

Here is the call graph for this function:

◆ isUndef() [2/2]

bool isUndef ( const IndirectListBase< scalar, Addr > & field )

static

Definition at line 24 of file ensightFileTemplates.C.

References field().

Here is the call graph for this function:

Member Data Documentation

◆ coordinates

const char *const coordinates = "coordinates"

static

Definition at line 82 of file ensightFile.H.

Referenced by ensightGeoFile::beginCoordinates().

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

src/fileFormats/ensight/file/ensightFile.H
src/fileFormats/ensight/file/ensightFile.C
src/fileFormats/ensight/file/ensightFileTemplates.C

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ensightFile() [1/2]

◆ ensightFile() [2/2]

◆ ~ensightFile()

Member Function Documentation

◆ null()

◆ allowUndef() [1/2]

◆ mask()

◆ subDir()

◆ subDirWidth() [1/2]

◆ subDirWidth() [2/2]

◆ allowUndef() [2/2]

◆ undefValue()

◆ writeKeyword()

◆ writeBinaryHeader()

◆ writeString() [1/2]

◆ writeString() [2/2]

◆ writeUndef()

◆ write() [1/11]

◆ write() [2/11]

◆ write() [3/11]

◆ write() [4/11]

◆ write() [5/11]

◆ write() [6/11]

◆ write() [7/11]

◆ write() [8/11]

◆ write() [9/11]

◆ write() [10/11]

◆ write() [11/11]

◆ newline()

◆ beginPart()

◆ beginParticleCoordinates()

◆ writeLabels() [1/2]

◆ writeLabels() [2/2]

◆ writeList() [1/3]

◆ writeList() [2/3]

◆ writeList() [3/3]

◆ isUndef() [1/2]

◆ isUndef() [2/2]

Member Data Documentation

◆ coordinates