ensightGeoFile Class Reference

Specialized Ensight output with extra geometry file header. More...

Inheritance diagram for ensightGeoFile:

Collaboration diagram for ensightGeoFile:

Public Member Functions
	ensightGeoFile (const fileName &pathname, IOstream::streamFormat format=IOstream::BINARY)
	Construct from pathName. More...
	ensightGeoFile (const fileName &path, const fileName &name, IOstream::streamFormat format=IOstream::BINARY)
	Construct from path and name. More...
	~ensightGeoFile ()=default
	Destructor. More...
virtual Ostream &	writeKeyword (const keyType &key)
	Write keyword with trailing newline. More...
void	beginPart (const label index, const string &description)
	Begin a "part" (0-based index), with a description. More...
void	beginCoordinates (const label npoints)
	Begin a "coordinates" block. More...
void	beginPart (const label index)
	Begin a part (0-based index). More...
Public Member Functions inherited from ensightFile
	ensightFile (const fileName &pathname, IOstream::streamFormat format=IOstream::BINARY)
	Construct from pathName. More...
	ensightFile (const fileName &path, const fileName &name, IOstream::streamFormat format=IOstream::BINARY)
	Construct from path and name. More...
	~ensightFile ()=default
	Destructor. More...
Ostream &	writeBinaryHeader ()
	Write "C Binary" string for binary files (eg, geometry/measured) More...
Ostream &	writeString (const char *str)
	Write C-string as "%79s" or as binary (max 80 chars) More...
Ostream &	writeString (const std::string &str)
	Write string as "%79s" or as binary (max 80 chars) More...
Ostream &	writeUndef ()
	Write undef value. More...
virtual bool	write (const token &)
	Writing token does not make sense. More...
virtual Ostream &	write (const char)
	Writing single character does not make sense. More...
virtual Ostream &	write (const char *buf, std::streamsize count)
	Binary write. More...
virtual Ostream &	write (const char *str)
	Write C-string, uses writeString() More...
virtual Ostream &	write (const word &str)
	Write word, uses writeString() More...
virtual Ostream &	write (const string &str)
	Write string, uses writeString() More...
virtual Ostream &	write (const int32_t val)
	Write integer as "%10d" or as binary. More...
virtual Ostream &	write (const int64_t val)
	Write integer as "%10d" or as binary. More...
Ostream &	write (const label value, const label fieldWidth)
	Write integer with specified width or as binary. More...
virtual Ostream &	write (const floatScalar val)
	Write floating-point as "%12.5e" or as binary. More...
virtual Ostream &	write (const doubleScalar val)
	Write floating-point as "%12.5e" or as binary. More...
void	newline ()
	Add carriage return to ascii stream. More...
void	beginPart (const label index)
	Begin a part (0-based index internally). More...
void	beginParticleCoordinates (const label nparticles)
	Begin a "particle coordinates" block (measured data) More...
void	writeLabels (const UList< label > &list)
	Write a list of integers. More...
template<class Addr >
void	writeLabels (const IndirectListBase< label, Addr > &list)
	Write a list of integers. More...
void	writeList (const UList< label > &field)
	Write a list of integers as float values. More...
void	writeList (const UList< scalar > &field)
	Write a list of floats as "%12.5e" or as binary. More...
template<class Addr >
void	writeList (const IndirectListBase< scalar, Addr > &field)
	Write an indirect list of scalars as "%12.5e" or as binary. More...
Public Member Functions inherited from OFstream
	ClassName ("OFstream")
	Declare type-name (with debug switch) More...
	OFstream (std::nullptr_t)
	Construct a null output file stream. More...
	OFstream (const fileName &pathname, IOstreamOption streamOpt=IOstreamOption(), const bool append=false)
	Construct from pathname. More...
	OFstream (const fileName &pathname, IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver=IOstreamOption::currentVersion, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED, const bool append=false)
	Construct from pathname, format (version, compression) More...
	~OFstream ()=default
	Destructor. More...
virtual std::ostream &	stdStream ()
	Access to underlying std::ostream. More...
virtual const std::ostream &	stdStream () const
	Const access to underlying std::ostream. More...
virtual void	rewind ()
void	print (Ostream &os) const
	Print stream description. More...
virtual const fileName &	name () const
	Read/write access to the name of the stream. More...
virtual fileName &	name ()
	Read/write access to the name of the stream. More...
Public Member Functions inherited from OSstream
	OSstream (const OSstream &)=default
	Copy construct. More...
void	operator= (const OSstream &)=delete
	No copy assignment. More...
	OSstream (std::ostream &os, const string &streamName, IOstreamOption streamOpt=IOstreamOption())
	Construct wrapper around std::ostream, set stream status. More...
	OSstream (std::ostream &os, const string &streamName, IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver=IOstreamOption::currentVersion, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct wrapper around std::ostream, set stream status. More...
virtual const fileName &	name () const
	Get the name of the stream. More...
virtual fileName &	name ()
	Return stream name for modification. More...
virtual ios_base::fmtflags	flags () const
	Get stream flags. More...
virtual Ostream &	writeQuoted (const std::string &str, const bool quoted=true)
	Write std::string surrounded by quotes. More...
virtual Ostream &	writeRaw (const char *data, std::streamsize count)
	Low-level raw binary output. More...
virtual bool	beginRawWrite (std::streamsize count)
	Begin marker for low-level raw binary output. More...
virtual bool	endRawWrite ()
	End marker for low-level raw binary output. More...
virtual void	indent ()
	Add indentation characters. More...
virtual ios_base::fmtflags	flags (const ios_base::fmtflags f)
	Set stream flags. More...
virtual void	flush ()
	Flush stream. More...
virtual void	endl ()
	Add newline and flush stream. More...
virtual char	fill () const
	Get the current padding character. More...
virtual char	fill (const char fillch)
	Set padding character for formatted field up to field width. More...
virtual int	width () const
	Get width of output field. More...
virtual int	width (const int w)
	Set width of output field. More...
virtual int	precision () const
	Get precision of output field. More...
virtual int	precision (const int p)
	Set precision of output field. More...
Public Member Functions inherited from Ostream
	Ostream (const Ostream &)=default
	Copy construct. More...
virtual	~Ostream ()=default
	Destructor. More...
	Ostream (IOstreamOption streamOpt=IOstreamOption())
	Ostream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver=IOstreamOption::currentVersion, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct with format, version (compression) More...
virtual Ostream &	write (const keyType &kw)
	Write keyType. More...
unsigned short	indentSize () const noexcept
	Return indent size (spaces per level) More...
unsigned short	indentSize (unsigned short val) noexcept
	Change indent size (spaces per level), return old value. More...
unsigned short	indentLevel () const noexcept
	Return the indent level. More...
unsigned short	indentLevel (unsigned short val) noexcept
	Change the indent level, return old value. More...
void	incrIndent () noexcept
	Increment the indent level. More...
void	decrIndent ()
	Decrement the indent level. More...
virtual Ostream &	beginBlock (const keyType &kw)
	Write begin block group with the given name. More...
virtual Ostream &	beginBlock ()
	Write begin block group without a name. More...
virtual Ostream &	endBlock ()
	Write end block group. More...
virtual Ostream &	endEntry ()
	Write end entry (';') followed by newline. More...
template<class T >
Ostream &	writeEntry (const keyType &key, const T &value)
	Write a keyword/value entry. More...
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. More...
Ostream &	operator() () const
	Return a non-const reference to const Ostream. More...
unsigned short &	indentLevel () noexcept
	Access to indent level. More...
unsigned short &	indentSize () noexcept
	Access to indent size. More...
Public Member Functions inherited from IOstream
	IOstream (const IOstream &)=default
	Copy construct. More...
virtual	~IOstream ()=default
	Destructor. More...
	IOstream (IOstreamOption streamOpt=IOstreamOption())
	IOstream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct with format, version (compression) More...
fileName	relativeName () const
	Return the name of the stream relative to the current case. More...
virtual bool	check (const char *operation) const
	Check IOstream status for given operation. More...
bool	fatalCheck (const char *operation) const
	Check IOstream status for given operation. More...
bool	opened () const noexcept
	True if stream has been opened. More...
bool	closed () const noexcept
	True if stream is closed. More...
bool	good () const noexcept
	True if next operation might succeed. More...
bool	eof () const noexcept
	True if end of input seen. More...
bool	fail () const noexcept
	True if next operation will fail. More...
bool	bad () const noexcept
	True if stream is corrupted. More...
	operator bool () const noexcept
	Return true if the stream has not failed. More...
bool	operator! () const noexcept
	Return true if the stream has failed. More...
unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes associated with the stream. More...
unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes associated with the stream. More...
void	setLabelByteSize (unsigned nbytes) noexcept
	Set the sizeof (label) in bytes associated with the stream. More...
void	setScalarByteSize (unsigned nbytes) noexcept
	Set the sizeof (scalar) in bytes associated with the stream. More...
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
	Const access to the current stream line number. More...
label &	lineNumber () noexcept
	Non-const access to the current stream line number. More...
label	lineNumber (const label num) noexcept
	Set the stream line number. More...
void	setEof () noexcept
	Set stream state as reached 'eof'. More...
void	setFail () noexcept
	Set stream state as 'failed'. More...
void	setBad ()
	Set stream state to be 'bad'. More...
ios_base::fmtflags	setf (const ios_base::fmtflags f)
	Set flags of stream. More...
ios_base::fmtflags	setf (const ios_base::fmtflags f, const ios_base::fmtflags mask)
	Set flags of given field of stream. More...
void	unsetf (const ios_base::fmtflags f)
	Unset flags of stream. More...
void	print (Ostream &os, const int streamState) const
	Print information about the stream state bits. More...
InfoProxy< IOstream >	info () const
	Return info proxy. More...
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
	Construct from components (format, compression, version) More...
constexpr	IOstreamOption (streamFormat fmt, versionNumber ver, compressionType comp=compressionType::UNCOMPRESSED) noexcept
	Construct from components (format, version, compression) More...
	IOstreamOption (const IOstreamOption &opt, streamFormat fmt) noexcept
	Copy construct with change of format. More...
streamFormat	format () const noexcept
	Get the current stream format. More...
streamFormat	format (const streamFormat fmt) noexcept
	Set the stream format. More...
streamFormat	format (const word &formatName)
	Set the stream format from string value. More...
compressionType	compression () const noexcept
	Get the stream compression. More...
compressionType	compression (const compressionType comp) noexcept
	Set the stream compression. More...
compressionType	compression (const word &compName)
	Set the stream compression from string value. More...
versionNumber	version () const noexcept
	Get the stream version. More...
versionNumber	version (const versionNumber ver) noexcept
	Set the stream version. More...
versionNumber	version (const token &tok)
	Set the stream version from token. More...

Static Public Member Functions
static const ensightGeoFile &	null ()
	Return a null ensightGeoFile. More...
Static Public Member Functions inherited from ensightFile
static const ensightFile &	null ()
	Return a null ensightFile. More...
static bool	allowUndef ()
	Return setting for whether 'undef' values are allowed in results. More...
static string	mask ()
	The '*' mask appropriate for subDir. More...
static string	subDir (const label)
	Consistent zero-padded numbers for subdirectories. More...
static void	subDirWidth (const label)
	Set width of subDir and mask. Default width is 8 digits. More...
static label	subDirWidth ()
	Return current width of subDir and mask. More...
static bool	allowUndef (bool enabled)
	Enable/disable use of undef keyword and value. More...
static scalar	undefValue (const scalar value)
	Assign the value to represent undef in the results. More...
static bool	isUndef (const UList< scalar > &field)
	Check for any NaN in the field. More...
template<class Addr >
static bool	isUndef (const IndirectListBase< scalar, Addr > &field)
	Check for any NaN in the field. More...
Static Public Member Functions inherited from IOstream
static unsigned int	defaultPrecision () noexcept
	Return the default precision. More...
static unsigned int	defaultPrecision (unsigned int prec) noexcept
	Reset the default precision. More...
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)
	Failsafe construct streamFormat from optional dictionary lookup. More...
static compressionType	compressionEnum (const word &compName, const compressionType deflt=compressionType::UNCOMPRESSED)
	The compression enum corresponding to the string. More...
static compressionType	compressionEnum (const word &key, const dictionary &dict, const compressionType deflt=compressionType::UNCOMPRESSED)
	Failsafe construct compressionType from optional dictionary lookup. More...

Additional Inherited Members
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 }
	Data format (ascii | binary) More...
enum	compressionType : char { UNCOMPRESSED = 0, COMPRESSED }
	Compression treatment (UNCOMPRESSED | COMPRESSED) More...
Static Public Attributes inherited from ensightFile
static const char *const	coordinates = "coordinates"
	The keyword "coordinates". More...
Static Public Attributes inherited from IOstream
static unsigned int	precision_
	Default precision. More...
Static Public Attributes inherited from IOstreamOption
static const Enum< streamFormat >	formatNames
	Stream format names (ascii, binary) More...
static const versionNumber	currentVersion
	The current version number (2.0) More...
Protected Member Functions inherited from IOstream
void	setOpened () noexcept
	Set stream opened. More...
void	setClosed () noexcept
	Set stream closed. More...
void	setState (std::ios_base::iostate state) noexcept
	Set stream state. More...
void	setGood () noexcept
	Set stream state to be good. More...
Protected Attributes inherited from Ostream
unsigned short	indentSize_ = 4
	Number of spaces per indent level. More...
unsigned short	indentLevel_ = 0
	Current indent level. More...
Protected Attributes inherited from IOstream
std::ios_base::iostate	ioState_
	Mirror of internal stream io state. More...
streamAccess	openClosed_
	The stream open/closed state. More...
unsigned char	sizeofLabel_
	The sizeof (label), possibly read from the header. More...
unsigned char	sizeofScalar_
	The sizeof (scalar), possibly read from the header. More...
label	lineNumber_
	The file line. More...
Static Protected Attributes inherited from Ostream
static constexpr const unsigned short	entryIndentation_ = 16
	Indentation of the entry from the start of the keyword. More...
Static Protected Attributes inherited from IOstream
static fileName	staticName_
	Name for any generic stream - normally treat as readonly. More...

Detailed Description

Specialized Ensight output with extra geometry file header.

Definition at line 48 of file ensightGeoFile.H.

Constructor & Destructor Documentation

ensightGeoFile() [1/2]

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

explicit

Construct from pathName.

The entire pathName is checked for valid ensight naming.

Definition at line 57 of file ensightGeoFile.C.

ensightGeoFile() [2/2]

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

Construct from path and name.

Only the name portion is checked for valid ensight naming.

Definition at line 69 of file ensightGeoFile.C.

~ensightGeoFile()

~ensightGeoFile ( )

default

Destructor.

Member Function Documentation

null()

static const ensightGeoFile& null ( )

inlinestatic

Return a null ensightGeoFile.

Definition at line 69 of file ensightGeoFile.H.

writeKeyword()

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

virtual

Write keyword with trailing newline.

Reimplemented from ensightFile.

Definition at line 83 of file ensightGeoFile.C.

References Foam::glTF::key().

Here is the call graph for this function:

beginPart() [1/2]

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

Begin a "part" (0-based index), with a description.

Definition at line 97 of file ensightGeoFile.C.

beginCoordinates()

void beginCoordinates

(

const label

npoints

)

Begin a "coordinates" block.

Definition at line 108 of file ensightGeoFile.C.

References ensightFile::coordinates, and Foam::vtk::write().

Here is the call graph for this function:

beginPart() [2/2]

void beginPart

Begin a part (0-based index).

Definition at line 354 of file ensightFile.C.

---

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

• src/fileFormats/ensight/file/ensightGeoFile.H
• src/fileFormats/ensight/file/ensightGeoFile.C