A variant of OFstream with specialised handling for Ensight writing of strings, integers and floats (ASCII and BINARY). More...

#include <ensightFile.H>

Inheritance diagram for ensightFile:

[legend]

Collaboration diagram for ensightFile:

[legend]

Public Types
typedef float	floatType
	Ensight uses `float` not \d double for floating-point.
Public Types inherited from IOstream
enum	streamAccess : char { CLOSED = 0 , OPENED }
	Enumeration for stream open/closed state. More...
Public Types inherited from IOstreamOption
enum	streamFormat : char { ASCII = 0 , BINARY , COHERENT , UNKNOWN_FORMAT }
	Data format (ascii \| binary \| coherent). More...
enum	compressionType : char { UNCOMPRESSED = 0 , COMPRESSED }
	Compression treatment (UNCOMPRESSED \| COMPRESSED). More...
enum	appendType : char { NO_APPEND = 0 , APPEND_APP , APPEND_ATE , NON_APPEND = NO_APPEND , APPEND = APPEND_APP }
	File appending (NO_APPEND \| APPEND_APP \| APPEND_ATE). More...
enum	atomicType : char { NON_ATOMIC = 0 , ATOMIC }
	Atomic operations (output). More...
enum class	floatFormat : unsigned { general = unsigned(0) , fixed = unsigned(std::ios_base::fixed) , scientific = unsigned(std::ios_base::scientific) }
	Float formats (eg, time directory name formats). More...

Public Member Functions
	ensightFile (const ensightFile &)=delete
	No copy construct.
void	operator= (const ensightFile &)=delete
	No copy assignment.
	ensightFile (IOstreamOption::appendType append, const fileName &pathname, IOstreamOption::streamFormat fmt=IOstreamOption::BINARY)
	Construct from path-name.
	ensightFile (IOstreamOption::appendType append, const fileName &path, const fileName &name, IOstreamOption::streamFormat fmt=IOstreamOption::BINARY)
	Construct from path and name.
	ensightFile (const fileName &pathname, IOstreamOption::streamFormat fmt=IOstreamOption::BINARY)
	Construct from path-name.
	ensightFile (const fileName &path, const fileName &name, IOstreamOption::streamFormat fmt=IOstreamOption::BINARY)
	Construct from path and name.
	~ensightFile ()
	Destructor. Commits the time-step footer information (if any).
void	writeBinaryHeader ()
	Write "C Binary" string for binary files (eg, geometry/measured).
void	writeString (const char *str, size_t len)
	Write character/string content as "%79s" or as binary (max 80 chars).
void	writeString (const char *str)
	Write C-string as "%79s" or as binary (max 80 chars).
void	writeString (const std::string &str)
	Write string as "%79s" or as binary (max 80 chars).
void	writeInt (const int32_t val, const int fieldWidth)
	Write integer value with specified width or as binary.
void	writeInt (const int64_t val, const int fieldWidth)
	Write (narrowed) integer value with specified width or as binary.
void	writeFloat (const float val, const int fieldWidth)
	Write floating-point with specified width or as binary.
void	writeFloat (const double val, const int fieldWidth)
	Write (narrowed) floating-point with specified width or as binary.
void	writeUndef ()
	Write undef value.
virtual Ostream &	writeKeyword (const keyType &key) override
	Write element keyword with trailing newline, optionally with undef and the value for undefined.
virtual bool	write (const token &) override
	Writing token does not make sense.
virtual Ostream &	write (const char) override
	Writing single character does not make sense.
virtual Ostream &	write (const char *buf, std::streamsize count) override
	Binary write.
virtual Ostream &	write (const char *str) override
	Write C-string, uses writeString().
virtual Ostream &	write (const word &str) override
	Write word, uses writeString().
virtual Ostream &	write (const std::string &str) override
	Write string, uses writeString().
virtual Ostream &	write (const int32_t val) override
	Write integer value as "%10d" or as binary.
virtual Ostream &	write (const int64_t val) override
	Write integer value as "%10d" or as binary (narrowed to int32_t).
virtual Ostream &	write (const float val) override
	Write floating-point as "%12.5e" or as binary.
virtual Ostream &	write (const double val) override
	Write floating-point as "%12.5e" or as binary (narrowed to float).
void	newline ()
	Add carriage return to ascii stream.
int64_t	beginTimeStep ()
	Write "BEGIN TIME STEP" string and newline (for transient single-file format).
int64_t	endTimeStep ()
	Write "END TIME STEP" string and newline (for transient single-file format).
int64_t	writeTimeStepFooter ()
	Transient single-file: write the time-step file-offsets as footer information.
void	clearTimeSteps () noexcept
	Transient single-file: forget time-step file positions (advanced use).
label	nTimes () const noexcept
	Transient single-file: the current number of time steps.
const UList< int64_t > &	timeStepOffets () const noexcept
	Transient single-file: the current file-offsets for time steps within the file.
void	beginPart (const label index)
	Begin a part (0-based index internally).
void	beginPart (const label index, const std::string &description)
	Begin a part (0-based index internally), with a description. Only used for geometry files.
void	beginCoordinates (const label nparticles)
	Begin a "coordinates" block. Only used for geometry files.
void	beginParticleCoordinates (const label nparticles)
	Begin a "particle coordinates" block (measured data).
void	writeLabels (const UList< label > &list)
	Write a list of integers.
template<class Addr>
void	writeLabels (const IndirectListBase< label, Addr > &list)
	Write a list of integers.
void	writeList (const UList< label > &field)
	Write a list of integers as float values.
void	writeList (const UList< float > &field)
	Write a list of floats as "%12.5e" or as binary.
void	writeList (const UList< double > &field)
	Write a list of double as "%12.5e" or as binary. (double is narrowed to float).
template<class Addr>
void	writeList (const IndirectListBase< float, Addr > &field)
	Write an indirect list of float as "%12.5e" or as binary.
template<class Addr>
void	writeList (const IndirectListBase< double, Addr > &field)
	Write an indirect list of double as "%12.5e" or as binary. (double is narrowed to float).
Public Member Functions inherited from OFstream
	ClassName ("OFstream")
	Declare type-name (with debug switch).
	OFstream (std::nullptr_t)
	Construct a null output file stream that behaves like `/dev/null`.
	OFstream (IOstreamOption::atomicType atomic, const fileName &pathname, IOstreamOption streamOpt=IOstreamOption(), IOstreamOption::appendType append=IOstreamOption::NO_APPEND)
	Construct with specified atomic behaviour from pathname, stream option, optional append (see note).
	OFstream (const fileName &pathname, IOstreamOption streamOpt=IOstreamOption(), IOstreamOption::appendType append=IOstreamOption::NO_APPEND)
	Construct from pathname and other specifications.
	OFstream (const fileName &pathname, IOstreamOption::streamFormat fmt, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED, IOstreamOption::appendType append=IOstreamOption::NO_APPEND)
	Construct from pathname, format (uncompressed), optional append (see note), atomic behaviour as per system default.
	OFstream (IOstreamOption::atomicType atomic, const fileName &pathname, IOstreamOption::streamFormat fmt, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED, IOstreamOption::appendType append=IOstreamOption::NO_APPEND)
	Construct with specified atomic behaviour from pathname, format (uncompressed), optional append (see note).
	~OFstream ()
	Destructor. Possibly invokes an atomic rename (preference defined during construction).
virtual const std::ostream &	stdStream () const override
	Const access to underlying std::ostream.
virtual std::ostream &	stdStream () override
	Access to underlying std::ostream.
virtual void	rewind ()
	Rewind the stream so that it may be written again. Reopens the file (truncation).
bool	is_appending () const noexcept
	True if opened in append mode and file already existed.
bool	is_atomic () const noexcept
	True if file creation behaves as atomic.
void	print (Ostream &os) const override
	Print stream description.
virtual const fileName &	name () const override
	Read/write access to the name of the stream.
virtual fileName &	name ()
	Read/write access to the name of the stream.
Public Member Functions inherited from OSstream
	OSstream (const OSstream &)=default
	Copy construct.
void	operator= (const OSstream &)=delete
	No copy assignment.
	OSstream (std::ostream &os, const string &streamName, IOstreamOption streamOpt=IOstreamOption())
	Construct wrapper around std::ostream, set stream status.
	OSstream (std::ostream &os, const string &streamName, IOstreamOption::streamFormat fmt, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct wrapper around std::ostream, set stream status.
	OSstream (std::ostream &os, const string &streamName, IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct wrapper around std::ostream, set stream status.
virtual std::ios_base::fmtflags	flags () const override
	Get current stream flags.
virtual std::ios_base::fmtflags	flags (std::ios_base::fmtflags f) override
	Set stream flags, return old stream flags.
void	syncState ()
	Set stream state to match that of the std::ostream.
virtual Ostream &	writeQuoted (const char *str, std::streamsize len, const bool quoted=true) override
	Write character/string content, with/without surrounding quotes.
virtual Ostream &	write (const uint32_t val) override
	Write uint32_t.
virtual Ostream &	write (const uint64_t val) override
	Write uint64_t.
virtual Ostream &	writeRaw (const char *data, std::streamsize count) override
	Low-level raw binary output.
virtual bool	beginRawWrite (std::streamsize count) override
	Begin marker for low-level raw binary output.
virtual bool	endRawWrite () override
	End marker for low-level raw binary output.
virtual void	indent () override
	Add indentation characters.
virtual void	flush () override
	Flush stream.
virtual void	endl () override
	Add newline and flush stream.
virtual char	fill () const override
	Get the current padding character.
virtual char	fill (const char fillch) override
	Set padding character for formatted field up to field width.
virtual int	width () const override
	Get width of output field.
virtual int	width (const int w) override
	Set width of output field.
virtual int	precision () const override
	Get precision of output field.
virtual int	precision (const int p) override
	Set precision of output field.
virtual Ostream &	writeQuoted (const std::string &str, const bool quoted=true)
	Inherit write methods from Ostream.
Public Member Functions inherited from Ostream
	Ostream (const Ostream &)=default
	Copy construct.
virtual	~Ostream ()=default
	Destructor.
	Ostream (IOstreamOption streamOpt=IOstreamOption())
	Default construct (ASCII, uncompressed), construct with specified stream option.
	Ostream (IOstreamOption::streamFormat fmt, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct with format (uncompressed).
virtual Ostream &	write (const keyType &kw)
	Write keyType.
unsigned short	indentSize () const noexcept
	Return indent size (spaces per level).
unsigned short	indentSize (unsigned short val) noexcept
	Change indent size (spaces per level), return old value.
unsigned short	indentLevel () const noexcept
	Return the indent level.
unsigned short	indentLevel (unsigned short val) noexcept
	Change the indent level, return old value.
void	incrIndent () noexcept
	Increment the indent level.
void	decrIndent ()
	Decrement the indent level.
virtual Ostream &	beginBlock (const keyType &kw)
	Write begin block group with the given name.
virtual Ostream &	beginBlock ()
	Write begin block group without a name.
virtual Ostream &	endBlock ()
	Write end block group.
virtual Ostream &	endEntry ()
	Write end entry (';') followed by newline.
template<class T>
Ostream &	writeEntry (const keyType &key, const T &value)
	Write a keyword/value entry.
template<class T>
Ostream &	writeEntryIfDifferent (const word &key, const T &value1, const T &value2)
	Write a keyword/value entry only when the two values differ.
Ostream &	operator() () const
	Return a non-const reference to const Ostream.
unsigned short &	indentLevel () noexcept
	Access to indent level.
unsigned short &	indentSize () noexcept
	Access to indent size.
Public Member Functions inherited from IOstream
	IOstream (const IOstream &)=default
	Copy construct.
virtual	~IOstream ()=default
	Destructor.
	IOstream (IOstreamOption streamOpt=IOstreamOption())
	Default construct (ASCII, uncompressed), construct with specified stream option.
	IOstream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct with format, version (compression).
fileName	relativeName () const
	Return the name of the stream relative to the current case.
virtual bool	check (const char *operation) const
	Check IOstream status for given operation.
bool	fatalCheck (const char *operation) const
	Check IOstream status for given operation.
bool	opened () const noexcept
	True if stream has been opened.
bool	closed () const noexcept
	True if stream is closed.
bool	good () const noexcept
	True if next operation might succeed.
bool	eof () const noexcept
	True if end of input seen.
bool	fail () const noexcept
	True if next operation will fail.
bool	bad () const noexcept
	True if stream is corrupted.
	operator bool () const noexcept
	True if the stream has not failed.
bool	operator! () const noexcept
	True if the stream has failed.
unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes associated with the stream.
unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes associated with the stream.
void	setLabelByteSize (unsigned nbytes) noexcept
	Set the sizeof (label) in bytes associated with the stream.
void	setScalarByteSize (unsigned nbytes) noexcept
	Set the sizeof (scalar) in bytes associated with the stream.
template<class T, class = std::enable_if_t<std::is_integral_v<T>>>
bool	checkLabelSize () const noexcept
	Test if the label byte-size associated with the stream is the same as the given type.
template<class T, class = std::enable_if_t<std::is_floating_point_v<T>>>
bool	checkScalarSize () const noexcept
	Test if the scalar byte-size associated with the stream is the same as the given type.
bool	checkNativeSizes () const noexcept
	Test if the label/scalar byte-size associated with the stream are the native label/scalar sizes.
bool	fatalCheckNativeSizes (const char *operation) const
	Assert that the label/scalar byte-size associated with the stream are the native label/scalar sizes.
label	lineNumber () const noexcept
	Const access to the current stream line number.
label &	lineNumber () noexcept
	Non-const access to the current stream line number.
label	lineNumber (const label num) noexcept
	Set the stream line number.
void	setEof () noexcept
	Set stream state as reached 'eof'.
void	setFail () noexcept
	Set stream state as 'failed'.
void	setBad () noexcept
	Set stream state to be 'bad'.
std::ios_base::fmtflags	setf (std::ios_base::fmtflags f)
	Set stream flag(s), return old stream flags.
std::ios_base::fmtflags	setf (const std::ios_base::fmtflags f, const std::ios_base::fmtflags mask)
	Set stream flag(s) with mask, return old stream flags.
std::ios_base::fmtflags	unsetf (std::ios_base::fmtflags f)
	Unset stream flags, return old stream flags.
void	print (Ostream &os, const int streamState) const
	Print information about the stream state bits.
InfoProxy< IOstream >	info () const noexcept
	Return info proxy, used to print IOstream information to a stream.
Public Member Functions inherited from IOstreamOption
constexpr	IOstreamOption (streamFormat fmt=streamFormat::ASCII, compressionType comp=compressionType::UNCOMPRESSED) noexcept
	Default construct (ASCII, UNCOMPRESSED, currentVersion) or construct with format, compression.
constexpr	IOstreamOption (streamFormat fmt, compressionType comp, versionNumber ver) noexcept
	Construct from components (format, compression, version).
constexpr	IOstreamOption (streamFormat fmt, versionNumber ver, compressionType comp=compressionType::UNCOMPRESSED) noexcept
	Construct from components (format, version, compression).
	IOstreamOption (const IOstreamOption &opt, streamFormat fmt) noexcept
	Copy construct with change of format.
streamFormat	format () const noexcept
	Get the current stream format.
streamFormat	format (const streamFormat fmt) noexcept
	Set the stream format.
streamFormat	format (const word &formatName)
	Set the stream format from string value.
compressionType	compression () const noexcept
	Get the stream compression.
compressionType	compression (const compressionType comp) noexcept
	Set the stream compression.
compressionType	compression (const word &compName)
	Set the stream compression from string value.
versionNumber	version () const noexcept
	Get the stream version.
versionNumber	version (const versionNumber ver) noexcept
	Set the stream version.
versionNumber	version (const token &tok)
	Set the stream version from token.

Static Public Member Functions
static const ensightFile &	null () noexcept
	Return a null ensightFile.
static bool	allowUndef () noexcept
	Return setting for whether 'undef' values are allowed in results.
static bool	allowUndef (bool on) noexcept
	Enable/disable use of `undef` keyword and value.
static float	undefValue (float value) noexcept
	Assign the value to represent undef in the results.
static bool	hasUndef (const UList< float > &field)
	Check for any NaN in the field.
static bool	hasUndef (const UList< double > &field)
	Check for any NaN in the field.
template<class Addr>
static bool	hasUndef (const IndirectListBase< float, Addr > &field)
	Check for any NaN in the field.
template<class Addr>
static bool	hasUndef (const IndirectListBase< double, Addr > &field)
	Check for any NaN in the field.
Static Public Member Functions inherited from IOstream
static unsigned int	defaultPrecision () noexcept
	Return the default precision.
static unsigned int	defaultPrecision (unsigned int prec) noexcept
	Reset the default precision.
static unsigned int	minPrecision (unsigned int prec) noexcept
	Set the minimum default precision.
Static Public Member Functions inherited from IOstreamOption
static floatFormat	floatFormatEnum (const word &fmtName, const floatFormat deflt=floatFormat::general)
	Lookup floatFormat enum corresponding to the string (general \| fixed \| scientific).
static floatFormat	floatFormatEnum (const word &key, const dictionary &dict, const floatFormat deflt=floatFormat::general)
	getOrDefault floatFormat from dictionary, warn only on bad enumeration.
static streamFormat	formatEnum (const word &fmtName, const streamFormat deflt=streamFormat::ASCII)
	Lookup streamFormat enum corresponding to the string (ascii \| binary).
static streamFormat	formatEnum (const word &key, const dictionary &dict, const streamFormat deflt=streamFormat::ASCII)
	getOrDefault streamFormat from dictionary, warn only on bad enumeration.
static compressionType	compressionEnum (const word &compName, const compressionType deflt=compressionType::UNCOMPRESSED)
	The compression enum corresponding to the string.
static compressionType	compressionEnum (const word &key, const dictionary &dict, const compressionType deflt=compressionType::UNCOMPRESSED)
	getOrDefault compressionType from dictionary, warn only on bad enumeration.

Static Public Attributes
static const char *const	coordinates = "coordinates"
	The keyword "coordinates".
Static Public Attributes inherited from IOstream
static unsigned int	precision_
	Default precision.
Static Public Attributes inherited from IOstreamOption
static const Enum< floatFormat >	floatFormatNames
	Names for float formats (general, fixed, scientific).
static const Enum< streamFormat >	formatNames
	Stream format names (ascii, binary).
static const versionNumber	currentVersion
	The current version number (2.0).

Additional Inherited Members
Protected Member Functions inherited from IOstream
void	setOpened () noexcept
	Set stream opened.
void	setClosed () noexcept
	Set stream closed.
void	setState (std::ios_base::iostate state) noexcept
	Set stream state.
void	setGood () noexcept
	Set stream state to be good.
Protected Attributes inherited from Ostream
unsigned short	indentSize_ = 4
	Number of spaces per indent level.
unsigned short	indentLevel_ = 0
	Current indent level.
Protected Attributes inherited from IOstream
std::ios_base::iostate	ioState_
	Mirror of internal stream io state.
streamAccess	openClosed_
	The stream open/closed state.
unsigned char	sizeofLabel_
	The sizeof (label), possibly read from the header.
unsigned char	sizeofScalar_
	The sizeof (scalar), possibly read from the header.
label	lineNumber_
	The file line.
Static Protected Attributes inherited from Ostream
static constexpr const unsigned short	entryIndentation_ = 16
	Indentation of the entry from the start of the keyword.
Static Protected Attributes inherited from IOstream
static fileName	staticName_
	Name for any generic stream - normally treat as readonly.

Detailed Description

A variant of OFstream with specialised handling for Ensight writing of strings, integers and floats (ASCII and BINARY).

Definition at line 47 of file ensightFile.H.

Member Typedef Documentation

◆ floatType

typedef float floatType

Ensight uses float not \d double for floating-point.

Definition at line 112 of file ensightFile.H.

Constructor & Destructor Documentation

◆ ensightFile() [1/5]

ensightFile ( const ensightFile & )

delete

No copy construct.

◆ ensightFile() [2/5]

ensightFile	(	IOstreamOption::appendType	append,
		const fileName &	pathname,
		IOstreamOption::streamFormat	fmt = IOstreamOption::BINARY )

Construct from path-name.

The path-name is adjusted for valid ensight file naming. Created as an atomic or in append mode (single-file format). In append mode, attempts to parse existing time-step information.

Parameters

append Append mode: NO_APPEND or APPEND_ATE

Definition at line 191 of file ensightFile.C.

References append().

Here is the call graph for this function:

◆ ensightFile() [3/5]

ensightFile	(	IOstreamOption::appendType	append,
		const fileName &	path,
		const fileName &	name,
		IOstreamOption::streamFormat	fmt = IOstreamOption::BINARY )

Construct from path and name.

Only the name portion is adjusted for valid ensight file naming. Created as an atomic or in append mode (single-file format). In append mode, attempts to parse existing time-step information.

Parameters

append Append mode: NO_APPEND or APPEND_ATE

Definition at line 208 of file ensightFile.C.

References append(), OFstream::name(), and path().

Here is the call graph for this function:

◆ ensightFile() [4/5]

ensightFile	(	const fileName &	pathname,
		IOstreamOption::streamFormat	fmt = IOstreamOption::BINARY )

inlineexplicit

Construct from path-name.

The path-name is adjusted for valid ensight file naming. Created as an atomic, non-append mode.

Definition at line 186 of file ensightFile.H.

References IOstreamOption::BINARY, and IOstreamOption::NO_APPEND.

◆ ensightFile() [5/5]

ensightFile	(	const fileName &	path,
		const fileName &	name,
		IOstreamOption::streamFormat	fmt = IOstreamOption::BINARY )

inline

Construct from path and name.

Only the name portion is adjusted for valid ensight file naming. Created as an atomic, non-append mode.

Definition at line 201 of file ensightFile.H.

References IOstreamOption::BINARY, OFstream::name(), IOstreamOption::NO_APPEND, and path().

Here is the call graph for this function:

◆ ~ensightFile()

~ensightFile ( )

Destructor. Commits the time-step footer information (if any).

Definition at line 228 of file ensightFile.C.

References writeTimeStepFooter().

Here is the call graph for this function:

Member Function Documentation

◆ null()

const ensightFile & null ( )

inlinestaticnoexcept

Return a null ensightFile.

Definition at line 128 of file ensightFile.H.

References Foam::noexcept, and Foam::NullObjectRef().

Here is the call graph for this function:

◆ operator=()

void operator= ( const ensightFile & )

delete

No copy assignment.

References append(), IOstreamOption::BINARY, OFstream::name(), and path().

Here is the call graph for this function:

◆ allowUndef() [1/2]

bool allowUndef ( )

staticnoexcept

Return setting for whether 'undef' values are allowed in results.

Definition at line 236 of file ensightFile.C.

References Foam::noexcept.

◆ allowUndef() [2/2]

bool allowUndef ( bool on )

staticnoexcept

Enable/disable use of undef keyword and value.

Definition at line 248 of file ensightFile.C.

◆ undefValue()

float undefValue ( float value )

staticnoexcept

Assign the value to represent undef in the results.

Returns the previous value NB: do not use values larger than floatScalarVGREAT

Definition at line 256 of file ensightFile.C.

◆ writeBinaryHeader()

void writeBinaryHeader ( )

Write "C Binary" string for binary files (eg, geometry/measured).

Definition at line 437 of file ensightFile.C.

References IOstreamOption::BINARY, format(), and writeString().

Referenced by ensightGeoFile::ensightGeoFile(), and ensightGeoFile::ensightGeoFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeString() [1/3]

void writeString	(	const char *	str,
		size_t	len )

Write character/string content as "%79s" or as binary (max 80 chars).

Definition at line 269 of file ensightFile.C.

References IOstreamOption::BINARY, format(), OFstream::stdStream(), and OSstream::syncState().

Referenced by beginCoordinates(), ensightGeoFile::beginGeometry(), beginPart(), beginPart(), beginParticleCoordinates(), beginTimeStep(), endTimeStep(), write(), write(), write(), writeBinaryHeader(), writeKeyword(), ensightGeoFile::writeKeyword(), writeString(), writeString(), and writeTimeStepFooter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeString() [2/3]

void writeString ( const char * str )

Write C-string as "%79s" or as binary (max 80 chars).

Definition at line 301 of file ensightFile.C.

References writeString().

Here is the call graph for this function:

◆ writeString() [3/3]

void writeString ( const std::string & str )

Write string as "%79s" or as binary (max 80 chars).

Definition at line 307 of file ensightFile.C.

References writeString().

Here is the call graph for this function:

◆ writeInt() [1/2]

void writeInt	(	const int32_t	val,
		const int	fieldWidth )

Write integer value with specified width or as binary.

Definition at line 347 of file ensightFile.C.

References Foam::putPrimitive().

Referenced by beginParticleCoordinates().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeInt() [2/2]

void writeInt	(	const int64_t	val,
		const int	fieldWidth )

Write (narrowed) integer value with specified width or as binary.

Definition at line 353 of file ensightFile.C.

References Foam::narrowInt32(), and Foam::putPrimitive().

Here is the call graph for this function:

◆ writeFloat() [1/2]

void writeFloat	(	const float	val,
		const int	fieldWidth )

Write floating-point with specified width or as binary.

Definition at line 359 of file ensightFile.C.

References Foam::putPrimitive().

Here is the call graph for this function:

◆ writeFloat() [2/2]

void writeFloat	(	const double	val,
		const int	fieldWidth )

Write (narrowed) floating-point with specified width or as binary.

Definition at line 365 of file ensightFile.C.

References Foam::narrowFloat(), and Foam::putPrimitive().

Here is the call graph for this function:

◆ writeUndef()

void writeUndef ( )

Write undef value.

Definition at line 412 of file ensightFile.C.

References write().

Referenced by writeList(), and writeList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeKeyword()

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

overridevirtual

Write element keyword with trailing newline, optionally with undef and the value for undefined.

Reimplemented from Ostream.

Reimplemented in ensightGeoFile.

Definition at line 418 of file ensightFile.C.

References newline(), write(), and writeString().

Here is the call graph for this function:

◆ write() [1/10]

virtual bool write ( const token & )

inlineoverridevirtual

Writing token does not make sense.

Reimplemented from OSstream.

Definition at line 301 of file ensightFile.H.

References NotImplemented, and write().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write() [2/10]

virtual Ostream & write ( const char )

inlineoverridevirtual

Writing single character does not make sense.

Reimplemented from OSstream.

Definition at line 310 of file ensightFile.H.

References NotImplemented.

◆ write() [3/10]

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

overridevirtual

Binary write.

Reimplemented from OSstream.

Definition at line 335 of file ensightFile.C.

References OFstream::stdStream(), and OSstream::syncState().

Here is the call graph for this function:

◆ write() [4/10]

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

overridevirtual

Write C-string, uses writeString().

Reimplemented from OSstream.

Definition at line 313 of file ensightFile.C.

References writeString().

Here is the call graph for this function:

◆ write() [5/10]

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

overridevirtual

Write word, uses writeString().

Reimplemented from OSstream.

Definition at line 320 of file ensightFile.C.

References writeString().

Here is the call graph for this function:

◆ write() [6/10]

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

overridevirtual

Write string, uses writeString().

Reimplemented from OSstream.

Definition at line 327 of file ensightFile.C.

References writeString().

Here is the call graph for this function:

◆ write() [7/10]

Foam::Ostream & write ( const int32_t val )

overridevirtual

Write integer value as "%10d" or as binary.

Reimplemented from OSstream.

Definition at line 371 of file ensightFile.C.

References Foam::putPrimitive().

Here is the call graph for this function:

◆ write() [8/10]

Foam::Ostream & write ( const int64_t val )

overridevirtual

Write integer value as "%10d" or as binary (narrowed to int32_t).

Reimplemented from OSstream.

Definition at line 379 of file ensightFile.C.

References Foam::narrowInt32(), and Foam::putPrimitive().

Here is the call graph for this function:

◆ write() [9/10]

Foam::Ostream & write ( const float val )

overridevirtual

Write floating-point as "%12.5e" or as binary.

Reimplemented from OSstream.

Definition at line 387 of file ensightFile.C.

References Foam::putPrimitive().

Here is the call graph for this function:

◆ write() [10/10]

Foam::Ostream & write ( const double val )

overridevirtual

Write floating-point as "%12.5e" or as binary (narrowed to float).

Reimplemented from OSstream.

Definition at line 395 of file ensightFile.C.

References Foam::narrowFloat(), and Foam::putPrimitive().

Here is the call graph for this function:

◆ newline()

void newline ( )

Add carriage return to ascii stream.

Definition at line 403 of file ensightFile.C.

References IOstreamOption::ASCII, format(), and Ostream::write().

Referenced by beginCoordinates(), ensightGeoFile::beginGeometry(), beginPart(), beginPart(), beginParticleCoordinates(), beginTimeStep(), endTimeStep(), ensightWriter::writeCollated(), writeKeyword(), ensightGeoFile::writeKeyword(), writeLabels(), writeList(), writeList(), writeList(), writeTimeStepFooter(), and ensightWriter::writeUncollated().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ beginTimeStep()

int64_t beginTimeStep ( )

Write "BEGIN TIME STEP" string and newline (for transient single-file format).

Returns: file position after the write

Definition at line 512 of file ensightFile.C.

References OSstream::fill(), newline(), Foam::pos(), OFstream::stdStream(), OSstream::syncState(), and writeString().

Here is the call graph for this function:

◆ endTimeStep()

int64_t endTimeStep ( )

Write "END TIME STEP" string and newline (for transient single-file format).

Returns: file position after the write

Definition at line 552 of file ensightFile.C.

References newline(), OFstream::stdStream(), and writeString().

Here is the call graph for this function:

◆ writeTimeStepFooter()

int64_t writeTimeStepFooter ( )

Transient single-file: write the time-step file-offsets as footer information.

Maintains the current file position to allow manual use and seamless overwriting.

Returns: the output file position at the start of the footer

Definition at line 463 of file ensightFile.C.

References newline(), Foam::putPrimitive(), OFstream::stdStream(), and writeString().

Referenced by ~ensightFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearTimeSteps()

void clearTimeSteps ( )

inlinenoexcept

Transient single-file: forget time-step file positions (advanced use).

Definition at line 394 of file ensightFile.H.

References Foam::noexcept.

◆ nTimes()

label nTimes ( ) const

inlinenoexcept

Transient single-file: the current number of time steps.

Definition at line 403 of file ensightFile.H.

References Foam::noexcept.

◆ timeStepOffets()

const UList< int64_t > & timeStepOffets ( ) const

inlinenoexcept

Transient single-file: the current file-offsets for time steps within the file.

Definition at line 412 of file ensightFile.H.

References Foam::noexcept.

◆ beginPart() [1/2]

void beginPart ( const label index )

Begin a part (0-based index internally).

Definition at line 561 of file ensightFile.C.

References newline(), write(), and writeString().

Referenced by beginPart().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ beginPart() [2/2]

void beginPart	(	const label	index,
		const std::string &	description )

Begin a part (0-based index internally), with a description. Only used for geometry files.

Definition at line 570 of file ensightFile.C.

References beginPart(), newline(), and writeString().

Here is the call graph for this function:

◆ beginCoordinates()

void beginCoordinates ( const label nparticles )

Begin a "coordinates" block. Only used for geometry files.

Definition at line 582 of file ensightFile.C.

References newline(), write(), and writeString().

Here is the call graph for this function:

◆ beginParticleCoordinates()

void beginParticleCoordinates ( const label nparticles )

Begin a "particle coordinates" block (measured data).

Definition at line 592 of file ensightFile.C.

References newline(), writeInt(), and writeString().

Here is the call graph for this function:

◆ writeLabels() [1/2]

void writeLabels ( const UList< label > & list )

Write a list of integers.

Adds newline after each value (ascii stream)

Definition at line 601 of file ensightFile.C.

References newline(), and write().

Here is the call graph for this function:

◆ writeLabels() [2/2]

template<class Addr>

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

Write a list of integers.

Adds newline after each value (ascii stream)

References field().

Here is the call graph for this function:

◆ writeList() [1/5]

void writeList ( const UList< label > & field )

Write a list of integers as float values.

Adds newline after each value (ascii stream)

Definition at line 611 of file ensightFile.C.

References field(), newline(), and write().

Here is the call graph for this function:

◆ writeList() [2/5]

void writeList ( const UList< float > & field )

Write a list of floats as "%12.5e" or as binary.

Adds newline after each value (ascii stream)

Definition at line 621 of file ensightFile.C.

References field(), newline(), write(), and writeUndef().

Here is the call graph for this function:

◆ writeList() [3/5]

void writeList ( const UList< double > & field )

Write a list of double as "%12.5e" or as binary. (double is narrowed to float).

Adds newline after each value (ascii stream)

Definition at line 638 of file ensightFile.C.

References field(), newline(), write(), and writeUndef().

Here is the call graph for this function:

◆ writeList() [4/5]

template<class Addr>

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

Write an indirect list of float as "%12.5e" or as binary.

Adds newline after each value (ascii stream)

References field().

Here is the call graph for this function:

◆ writeList() [5/5]

template<class Addr>

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

Write an indirect list of double as "%12.5e" or as binary. (double is narrowed to float).

Adds newline after each value (ascii stream)

References field().

Here is the call graph for this function:

◆ hasUndef() [1/4]

bool hasUndef ( const UList< float > & field )

static

Check for any NaN in the field.

Definition at line 71 of file ensightFile.C.

References field().

Here is the call graph for this function:

◆ hasUndef() [2/4]

bool hasUndef ( const UList< double > & field )

static

Check for any NaN in the field.

Definition at line 85 of file ensightFile.C.

References field().

Here is the call graph for this function:

◆ hasUndef() [3/4]

template<class Addr>

bool hasUndef ( const IndirectListBase< float, Addr > & field )

static

Check for any NaN in the field.

References field().

Here is the call graph for this function:

◆ hasUndef() [4/4]

template<class Addr>

bool hasUndef ( const IndirectListBase< double, Addr > & field )

static

Check for any NaN in the field.

References field().

Here is the call graph for this function:

Member Data Documentation

◆ coordinates

const char *const coordinates = "coordinates"

static

The keyword "coordinates".

Definition at line 120 of file ensightFile.H.

Referenced by Foam::writeTrackField().

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

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ floatType

Constructor & Destructor Documentation

◆ ensightFile() [1/5]

◆ ensightFile() [2/5]

◆ ensightFile() [3/5]

◆ ensightFile() [4/5]

◆ ensightFile() [5/5]

◆ ~ensightFile()

Member Function Documentation

◆ null()

◆ operator=()

◆ allowUndef() [1/2]

◆ allowUndef() [2/2]

◆ undefValue()

◆ writeBinaryHeader()

◆ writeString() [1/3]

◆ writeString() [2/3]

◆ writeString() [3/3]

◆ writeInt() [1/2]

◆ writeInt() [2/2]

◆ writeFloat() [1/2]

◆ writeFloat() [2/2]

◆ writeUndef()

◆ writeKeyword()

◆ write() [1/10]

◆ write() [2/10]

◆ write() [3/10]

◆ write() [4/10]

◆ write() [5/10]

◆ write() [6/10]

◆ write() [7/10]

◆ write() [8/10]

◆ write() [9/10]

◆ write() [10/10]

◆ newline()

◆ beginTimeStep()

◆ endTimeStep()

◆ writeTimeStepFooter()

◆ clearTimeSteps()

◆ nTimes()

◆ timeStepOffets()

◆ beginPart() [1/2]

◆ beginPart() [2/2]

◆ beginCoordinates()

◆ beginParticleCoordinates()

◆ writeLabels() [1/2]

◆ writeLabels() [2/2]

◆ writeList() [1/5]

◆ writeList() [2/5]

◆ writeList() [3/5]

◆ writeList() [4/5]

◆ writeList() [5/5]

◆ hasUndef() [1/4]

◆ hasUndef() [2/4]

◆ hasUndef() [3/4]

◆ hasUndef() [4/4]

Member Data Documentation

◆ coordinates