Specialized Ensight output with extra geometry file header. More...
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 (const fileName &pathname, IOstreamOption streamOpt=IOstreamOption(), const bool append=false) | |
| Construct from pathname. More... | |
| OFstream (const fileName &pathname, streamFormat fmt, versionNumber ver=currentVersion, compressionType comp=compressionType::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... | |
| void | print (Ostream &os) const |
| Print stream description to Ostream. 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, streamFormat fmt, versionNumber ver=currentVersion, compressionType comp=compressionType::UNCOMPRESSED) | |
| Construct wrapper around std::ostream, set stream status. More... | |
| virtual const fileName & | name () const |
| Return the name of the stream. More... | |
| virtual fileName & | name () |
| Return non-const access to the name of the stream. More... | |
| virtual ios_base::fmtflags | flags () const |
| Return flags of output stream. 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 (streamFormat fmt, versionNumber ver=currentVersion, compressionType comp=compressionType::UNCOMPRESSED) | |
| Construct with format, version (compression) More... | |
| virtual Ostream & | write (const keyType &kw) |
| Write keyType. More... | |
| unsigned short | indentSize () const |
| Return indent level. More... | |
| unsigned short & | indentSize () |
| Access to indent size. More... | |
| unsigned short | indentLevel () const |
| Return indent level. More... | |
| unsigned short & | indentLevel () |
| Access to indent level. More... | |
| void | incrIndent () |
| 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... | |
| Public Member Functions inherited from IOstream | |
| IOstream (const IOstream &)=default | |
| Copy construct. More... | |
| virtual | ~IOstream ()=default |
| Destructor. More... | |
| IOstream (IOstreamOption streamOpt=IOstreamOption()) | |
| IOstream (streamFormat fmt, versionNumber ver, compressionType comp=compressionType::UNCOMPRESSED) | |
| Construct with format, version (compression) 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 |
| Return true if stream has been opened. More... | |
| bool | closed () const |
| Return true if stream is closed. More... | |
| bool | good () const |
| Return true if next operation might succeed. More... | |
| bool | eof () const |
| Return true if end of input seen. More... | |
| bool | fail () const |
| Return true if next operation will fail. More... | |
| bool | bad () const |
| Return true if stream is corrupted. More... | |
| operator bool () const | |
| Return true if the stream has not failed. More... | |
| bool | operator! () const |
| Return true if the stream has failed. More... | |
| unsigned | labelByteSize () const |
| The label byte-size associated with the stream. More... | |
| unsigned | scalarByteSize () const |
| The scalar byte-size associated with the stream. More... | |
| void | setLabelByteSize (unsigned nbytes) |
| Set the label byte-size associated with the stream. More... | |
| void | setScalarByteSize (unsigned nbytes) |
| Set the scalar byte-size associated with the stream. More... | |
| template<class T = label> | |
| std::enable_if< std::is_integral< T >::value, bool >::type | checkLabelSize () const |
| template<class T = scalar> | |
| std::enable_if< std::is_floating_point< T >::value, bool >::type | checkScalarSize () const |
| label | lineNumber () const |
| Const access to the current stream line number. More... | |
| label & | lineNumber () |
| Non-const access to the current stream line number. More... | |
| label | lineNumber (const label num) |
| Set the stream line number. More... | |
| void | setEof () |
| Set stream to have reached eof. More... | |
| void | setFail () |
| Set stream to have failed. More... | |
| void | setBad () |
| Set stream 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 () |
| Return the default precision. More... | |
| static unsigned int | defaultPrecision (unsigned int prec) |
| 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 OFstreamAllocator | |
| OFstreamAllocator (const fileName &pathname, IOstream::compressionType comp=IOstream::UNCOMPRESSED, const bool append=false) | |
| Construct from pathname. More... | |
| Protected Member Functions inherited from IOstream | |
| void | setOpened () |
| Set stream opened. More... | |
| void | setClosed () |
| Set stream closed. More... | |
| void | setState (ios_base::iostate state) |
| Set stream state. More... | |
| void | setGood () |
| Set stream to be good. More... | |
| Protected Attributes inherited from OFstreamAllocator | |
| std::unique_ptr< std::ostream > | allocatedPtr_ |
| The allocated stream pointer (ofstream or ogzstream). 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 | |
| streamAccess | openClosed_ |
| ios_base::iostate | ioState_ |
| unsigned short | labelByteSize_ |
| The label byte-size (could also be stored as byte) More... | |
| unsigned short | scalarByteSize_ |
| The scalar byte-size (could also be stored as byte) 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... | |
Specialized Ensight output with extra geometry file header.
Definition at line 48 of file ensightGeoFile.H.
|
explicit |
Construct from pathName.
The entire pathName is checked for valid ensight naming.
Definition at line 57 of file ensightGeoFile.C.
| 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.
|
default |
Destructor.
|
inlinestatic |
Return a null ensightGeoFile.
Definition at line 69 of file ensightGeoFile.H.
|
virtual |
Write keyword with trailing newline.
Reimplemented from ensightFile.
Definition at line 83 of file ensightGeoFile.C.
Referenced by Foam::ensightOutput::writeFaceConnectivity().
| 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.
Referenced by Foam::ensightOutput::Detail::writeCoordinates().
| void beginCoordinates | ( | const label | npoints | ) |
Begin a "coordinates" block.
Definition at line 108 of file ensightGeoFile.C.
References ensightFile::coordinates, and Foam::vtk::write().
Referenced by Foam::ensightOutput::Detail::writeCoordinates().
| void beginPart |
Begin a part (0-based index).
Definition at line 354 of file ensightFile.C.
1.8.17 