A variant of OFstream with specialised handling for Ensight writing of strings, integers and floats (ASCII and BINARY). More...
Public Types | |
typedef float | floatType |
Ensight uses float not double for floating-point. More... | |
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... | |
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 | 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. More... | |
void | operator= (const ensightFile &)=delete |
No copy assignment. More... | |
ensightFile (IOstreamOption::appendType append, const fileName &pathname, IOstreamOption::streamFormat fmt=IOstreamOption::BINARY) | |
Construct from path-name. More... | |
ensightFile (IOstreamOption::appendType append, const fileName &path, const fileName &name, IOstreamOption::streamFormat fmt=IOstreamOption::BINARY) | |
Construct from path and name. More... | |
ensightFile (const fileName &pathname, IOstreamOption::streamFormat fmt=IOstreamOption::BINARY) | |
Construct from path-name. More... | |
ensightFile (const fileName &path, const fileName &name, IOstreamOption::streamFormat fmt=IOstreamOption::BINARY) | |
Construct from path and name. More... | |
~ensightFile () | |
Destructor. Commits the time-step footer information (if any) More... | |
void | writeBinaryHeader () |
Write "C Binary" string for binary files (eg, geometry/measured) More... | |
void | writeString (const char *str, size_t len) |
Write character/string content as "%79s" or as binary (max 80 chars) More... | |
void | writeString (const char *str) |
Write C-string as "%79s" or as binary (max 80 chars) More... | |
void | writeString (const std::string &str) |
Write string as "%79s" or as binary (max 80 chars) More... | |
void | writeInt (const int32_t val, const int fieldWidth) |
Write integer value with specified width or as binary. More... | |
void | writeInt (const int64_t val, const int fieldWidth) |
Write (narrowed) integer value with specified width or as binary. More... | |
void | writeFloat (const float val, const int fieldWidth) |
Write floating-point with specified width or as binary. More... | |
void | writeFloat (const double val, const int fieldWidth) |
Write (narrowed) floating-point with specified width or as binary. More... | |
void | writeUndef () |
Write undef value. More... | |
virtual Ostream & | writeKeyword (const keyType &key) override |
Write element keyword with trailing newline, optionally with undef and the value for undefined. More... | |
virtual bool | write (const token &) override |
Writing token does not make sense. More... | |
virtual Ostream & | write (const char) override |
Writing single character does not make sense. More... | |
virtual Ostream & | write (const char *buf, std::streamsize count) override |
Binary write. More... | |
virtual Ostream & | write (const char *str) override |
Write C-string, uses writeString() More... | |
virtual Ostream & | write (const word &str) override |
Write word, uses writeString() More... | |
virtual Ostream & | write (const std::string &str) override |
Write string, uses writeString() More... | |
virtual Ostream & | write (const int32_t val) override |
Write integer value as "%10d" or as binary. More... | |
virtual Ostream & | write (const int64_t val) override |
Write integer value as "%10d" or as binary (narrowed to int32_t) More... | |
virtual Ostream & | write (const float val) override |
Write floating-point as "%12.5e" or as binary. More... | |
virtual Ostream & | write (const double val) override |
Write floating-point as "%12.5e" or as binary (narrowed to float) More... | |
void | newline () |
Add carriage return to ascii stream. More... | |
int64_t | beginTimeStep () |
Write "BEGIN TIME STEP" string and newline (for transient single-file format). More... | |
int64_t | endTimeStep () |
Write "END TIME STEP" string and newline (for transient single-file format) More... | |
int64_t | writeTimeStepFooter () |
Transient single-file: write the time-step file-offsets as footer information. More... | |
void | clearTimeSteps () noexcept |
Transient single-file: forget time-step file positions (advanced use) More... | |
label | nTimes () const noexcept |
Transient single-file: the current number of time steps. More... | |
const UList< int64_t > & | timeStepOffets () const noexcept |
Transient single-file: the current file-offsets for time steps within the file. More... | |
void | beginPart (const label index) |
Begin a part (0-based index internally). More... | |
void | beginPart (const label index, const std::string &description) |
Begin a part (0-based index internally), with a description. Only used for geometry files. More... | |
void | beginCoordinates (const label nparticles) |
Begin a "coordinates" block. Only used for geometry files. 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< float > &field) |
Write a list of floats as "%12.5e" or as binary. More... | |
void | writeList (const UList< double > &field) |
Write a list of double as "%12.5e" or as binary. (double is narrowed to float) More... | |
template<class Addr > | |
void | writeList (const IndirectListBase< float, Addr > &field) |
Write an indirect list of float as "%12.5e" or as binary. More... | |
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) 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 that behaves like /dev/null . More... | |
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). More... | |
OFstream (const fileName &pathname, IOstreamOption streamOpt=IOstreamOption(), IOstreamOption::appendType append=IOstreamOption::NO_APPEND) | |
Construct from pathname and other specifications. More... | |
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. More... | |
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). More... | |
~OFstream () | |
Destructor. Possibly invokes an atomic rename (preference defined during construction) More... | |
virtual const std::ostream & | stdStream () const override |
Const access to underlying std::ostream. More... | |
virtual std::ostream & | stdStream () override |
Access to underlying std::ostream. More... | |
virtual void | rewind () |
Rewind the stream so that it may be written again. Reopens the file (truncation) More... | |
bool | is_appending () const noexcept |
True if opened in append mode and file already existed. More... | |
bool | is_atomic () const noexcept |
True if file creation behaves as atomic. More... | |
void | print (Ostream &os) const override |
Print stream description. More... | |
virtual const fileName & | name () const override |
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::compressionType cmp=IOstreamOption::UNCOMPRESSED) | |
Construct wrapper around std::ostream, set stream status. More... | |
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. More... | |
virtual const fileName & | name () const override |
Get the name of the output serial stream. (eg, the name of the Fstream file name) More... | |
virtual fileName & | name () |
The name of the output serial stream, for modification. More... | |
virtual std::ios_base::fmtflags | flags () const override |
Get current stream flags. More... | |
virtual std::ios_base::fmtflags | flags (std::ios_base::fmtflags f) override |
Set stream flags, return old stream flags. More... | |
void | syncState () |
Set stream state to match that of the std::ostream. More... | |
virtual Ostream & | writeQuoted (const char *str, std::streamsize len, const bool quoted=true) override |
Write character/string content, with/without surrounding quotes. More... | |
virtual Ostream & | writeRaw (const char *data, std::streamsize count) override |
Low-level raw binary output. More... | |
virtual bool | beginRawWrite (std::streamsize count) override |
Begin marker for low-level raw binary output. More... | |
virtual bool | endRawWrite () override |
End marker for low-level raw binary output. More... | |
virtual void | indent () override |
Add indentation characters. More... | |
virtual void | flush () override |
Flush stream. More... | |
virtual void | endl () override |
Add newline and flush stream. More... | |
virtual char | fill () const override |
Get the current padding character. More... | |
virtual char | fill (const char fillch) override |
Set padding character for formatted field up to field width. More... | |
virtual int | width () const override |
Get width of output field. More... | |
virtual int | width (const int w) override |
Set width of output field. More... | |
virtual int | precision () const override |
Get precision of output field. More... | |
virtual int | precision (const int p) override |
Set precision of output field. More... | |
virtual Ostream & | writeQuoted (const char *str, std::streamsize len, const bool quoted=true)=0 |
Inherit write methods from Ostream. More... | |
virtual Ostream & | writeQuoted (const std::string &str, const bool quoted=true) |
Inherit write methods from Ostream. More... | |
Public Member Functions inherited from Ostream | |
Ostream (const Ostream &)=default | |
Copy construct. More... | |
virtual | ~Ostream ()=default |
Destructor. More... | |
Ostream (IOstreamOption streamOpt=IOstreamOption()) | |
Default construct (ASCII, uncompressed), construct with specified stream option. More... | |
Ostream (IOstreamOption::streamFormat fmt, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED) | |
Construct with format (uncompressed) More... | |
virtual Ostream & | writeQuoted (const std::string &str, const bool quoted=true) |
Write string content, with/without surrounding quotes. 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()) | |
Default construct (ASCII, uncompressed), construct with specified stream option. More... | |
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 |
Check if the label byte-size associated with the stream is the same as the given type. More... | |
template<class T = scalar> | |
std::enable_if< std::is_floating_point< T >::value, bool >::type | checkScalarSize () const noexcept |
Check if the scalar byte-size associated with the stream is the same as the given type. More... | |
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 () noexcept |
Set stream state to be 'bad'. More... | |
std::ios_base::fmtflags | setf (std::ios_base::fmtflags f) |
Set stream flag(s), return old stream flags. More... | |
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. More... | |
void | unsetf (std::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 noexcept |
Return info proxy, used to print IOstream information to a stream. More... | |
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. More... | |
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 ensightFile & | null () noexcept |
Return a null ensightFile. More... | |
static bool | allowUndef () noexcept |
Return setting for whether 'undef' values are allowed in results. More... | |
static bool | allowUndef (bool on) noexcept |
Enable/disable use of undef keyword and value. More... | |
static float | undefValue (float value) noexcept |
Assign the value to represent undef in the results. More... | |
static bool | hasUndef (const UList< float > &field) |
Check for any NaN in the field. More... | |
static bool | hasUndef (const UList< double > &field) |
Check for any NaN in the field. More... | |
template<class Addr > | |
static bool | hasUndef (const IndirectListBase< float, Addr > &field) |
Check for any NaN in the field. More... | |
template<class Addr > | |
static bool | hasUndef (const IndirectListBase< double, 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 unsigned int | minPrecision (unsigned int prec) noexcept |
Set the minimum default precision. More... | |
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). More... | |
static floatFormat | floatFormatEnum (const word &key, const dictionary &dict, const floatFormat deflt=floatFormat::general) |
getOrDefault floatFormat from dictionary, warn only on bad enumeration. More... | |
static streamFormat | formatEnum (const word &fmtName, const streamFormat deflt=streamFormat::ASCII) |
Lookup streamFormat enum corresponding to the string (ascii | binary). More... | |
static streamFormat | formatEnum (const word &key, const dictionary &dict, const streamFormat deflt=streamFormat::ASCII) |
getOrDefault streamFormat from dictionary, warn only on bad enumeration. 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) |
getOrDefault compressionType from dictionary, warn only on bad enumeration. More... | |
Static Public Attributes | |
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< floatFormat > | floatFormatNames |
Names for float formats (general, fixed, scientific) More... | |
static const Enum< streamFormat > | formatNames |
Stream format names (ascii, binary) More... | |
static const versionNumber | currentVersion |
The current version number (2.0) More... | |
Additional Inherited Members | |
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... | |
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.
typedef float floatType |
Ensight uses float
not double for floating-point.
Definition at line 112 of file ensightFile.H.
|
delete |
No copy construct.
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.
append | Append mode: NO_APPEND or APPEND_ATE |
Definition at line 192 of file ensightFile.C.
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.
append | Append mode: NO_APPEND or APPEND_ATE |
Definition at line 209 of file ensightFile.C.
|
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 187 of file ensightFile.H.
|
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 202 of file ensightFile.H.
~ensightFile | ( | ) |
Destructor. Commits the time-step footer information (if any)
Definition at line 228 of file ensightFile.C.
|
inlinestaticnoexcept |
Return a null ensightFile.
Definition at line 128 of file ensightFile.H.
|
delete |
No copy assignment.
|
staticnoexcept |
Return setting for whether 'undef' values are allowed in results.
Definition at line 236 of file ensightFile.C.
|
staticnoexcept |
Enable/disable use of undef
keyword and value.
Definition at line 248 of file ensightFile.C.
|
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.
void writeBinaryHeader | ( | ) |
Write "C Binary" string for binary files (eg, geometry/measured)
Definition at line 437 of file ensightFile.C.
References IOstreamOption::BINARY, and format().
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, and format().
Referenced by ensightGeoFile::writeKeyword().
void writeString | ( | const char * | str | ) |
Write C-string as "%79s" or as binary (max 80 chars)
Definition at line 301 of file ensightFile.C.
void writeString | ( | const std::string & | str | ) |
Write string as "%79s" or as binary (max 80 chars)
Definition at line 307 of file ensightFile.C.
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.
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().
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.
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().
void writeUndef | ( | ) |
Write undef value.
Definition at line 412 of file ensightFile.C.
References Foam::vtk::write().
|
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 Foam::glTF::key(), and Foam::vtk::write().
|
inlineoverridevirtual |
Writing token does not make sense.
Reimplemented from OSstream.
Definition at line 301 of file ensightFile.H.
References NotImplemented.
Referenced by ensightWriter::writeUncollated().
|
inlineoverridevirtual |
Writing single character does not make sense.
Reimplemented from OSstream.
Definition at line 310 of file ensightFile.H.
References NotImplemented.
|
overridevirtual |
Binary write.
Reimplemented from OSstream.
Definition at line 336 of file ensightFile.C.
References Foam::BitOps::count().
|
overridevirtual |
Write C-string, uses writeString()
Reimplemented from OSstream.
Definition at line 313 of file ensightFile.C.
|
overridevirtual |
Write word, uses writeString()
Reimplemented from OSstream.
Definition at line 320 of file ensightFile.C.
|
overridevirtual |
Write string, uses writeString()
Reimplemented from OSstream.
Definition at line 327 of file ensightFile.C.
|
overridevirtual |
Write integer value as "%10d" or as binary.
Reimplemented from OSstream.
Definition at line 371 of file ensightFile.C.
|
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().
|
overridevirtual |
Write floating-point as "%12.5e" or as binary.
Reimplemented from OSstream.
Definition at line 387 of file ensightFile.C.
|
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().
void newline | ( | ) |
Add carriage return to ascii stream.
Definition at line 403 of file ensightFile.C.
References IOstreamOption::ASCII, format(), and OSstream::write().
Referenced by ensightGeoFile::writeKeyword().
int64_t beginTimeStep | ( | ) |
Write "BEGIN TIME STEP" string and newline (for transient single-file format).
Definition at line 512 of file ensightFile.C.
References Foam::pos(), OFstream::stdStream(), and OSstream::syncState().
int64_t endTimeStep | ( | ) |
Write "END TIME STEP" string and newline (for transient single-file format)
Definition at line 552 of file ensightFile.C.
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.
Definition at line 463 of file ensightFile.C.
References OFstream::stdStream().
|
inlinenoexcept |
Transient single-file: forget time-step file positions (advanced use)
Definition at line 394 of file ensightFile.H.
References DynamicList< T, SizeMin >::clear().
|
inlinenoexcept |
Transient single-file: the current number of time steps.
Definition at line 403 of file ensightFile.H.
References UList< T >::size().
|
inlinenoexcept |
Transient single-file: the current file-offsets for time steps within the file.
Definition at line 412 of file ensightFile.H.
void beginPart | ( | const label | index | ) |
Begin a part (0-based index internally).
Definition at line 561 of file ensightFile.C.
References Foam::vtk::write().
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 571 of file ensightFile.C.
void beginCoordinates | ( | const label | nparticles | ) |
Begin a "coordinates" block. Only used for geometry files.
Definition at line 582 of file ensightFile.C.
References Foam::vtk::write().
void beginParticleCoordinates | ( | const label | nparticles | ) |
Begin a "particle coordinates" block (measured data)
Definition at line 592 of file ensightFile.C.
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 Foam::vtk::write().
void writeLabels | ( | const IndirectListBase< label, Addr > & | list | ) |
Write a list of integers.
Adds newline after each value (ascii stream)
Definition at line 56 of file ensightFileTemplates.C.
References Foam::vtk::write().
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(), and Foam::vtk::write().
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(), and Foam::vtk::write().
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(), and Foam::vtk::write().
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)
Definition at line 67 of file ensightFileTemplates.C.
References field(), and Foam::vtk::write().
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)
Definition at line 85 of file ensightFileTemplates.C.
References field(), and Foam::vtk::write().
|
static |
Check for any NaN in the field.
Definition at line 71 of file ensightFile.C.
References field().
|
static |
Check for any NaN in the field.
Definition at line 85 of file ensightFile.C.
References field().
|
static |
Check for any NaN in the field.
Definition at line 24 of file ensightFileTemplates.C.
References field().
|
static |
Check for any NaN in the field.
Definition at line 39 of file ensightFileTemplates.C.
References field().
|
static |
The keyword "coordinates".
Definition at line 120 of file ensightFile.H.
Referenced by Foam::writeTrackField().