Configuration options for the ensightCase. More...
Public Member Functions | |
options (IOstreamOption::streamFormat fmt=IOstreamOption::BINARY) | |
Construct with the specified format (default is binary) More... | |
options (const word &formatKeyword, const dictionary &dict, IOstreamOption::streamFormat fmt=IOstreamOption::BINARY) | |
If present, construct with the format specified in the dictionary or use default (binary) More... | |
IOstreamOption::streamFormat | format () const noexcept |
The output file format (ascii/binary) More... | |
IOstreamOption::floatFormat | timeFormat () const noexcept |
Time format for case file (general/fixed/scientific) More... | |
int | timePrecision () const noexcept |
Time precision for case file. More... | |
const word & | mask () const noexcept |
The '*' mask appropriate for sub-directories. More... | |
word | padded (const label i) const |
Consistent zero-padded integer value. More... | |
int | width () const noexcept |
Return current width of mask and padded. More... | |
bool | overwrite () const noexcept |
Remove existing directory and sub-directories on creation. More... | |
bool | separateCloud () const noexcept |
Write clouds into their own directory instead in "data" directory. More... | |
void | width (const int i) |
Set width of mask and padded. More... | |
void | timeFormat (IOstreamOption::floatFormat fmt) noexcept |
Set the time format for case file. More... | |
void | timePrecision (int prec) noexcept |
Set the time precision for case file. More... | |
void | timeFormat (const word &key, const dictionary &dict) |
Set the time format for case file. More... | |
void | timePrecision (const word &key, const dictionary &dict) |
Set the time precision for case file. More... | |
void | overwrite (bool on) noexcept |
Remove existing directory and sub-directories on creation. More... | |
void | separateCloud (bool on) noexcept |
Write clouds into their own directory instead in "data" directory. More... | |
bool | nodeValues () const noexcept |
Forced use of values per node instead of per element. More... | |
void | nodeValues (bool on) noexcept |
Force use of values per node instead of per element. More... | |
Configuration options for the ensightCase.
Definition at line 546 of file ensightCase.H.
|
explicit |
Construct with the specified format (default is binary)
Definition at line 26 of file ensightCaseOptions.C.
References ensightCase::options::width().
options | ( | const word & | formatKeyword, |
const dictionary & | dict, | ||
IOstreamOption::streamFormat | fmt = IOstreamOption::BINARY |
||
) |
If present, construct with the format specified in the dictionary or use default (binary)
formatKeyword | The lookup name for the format, typically 'format' or 'writeFormat' etc. |
Definition at line 49 of file ensightCaseOptions.C.
|
inlinenoexcept |
The output file format (ascii/binary)
Definition at line 629 of file ensightCase.H.
|
inlinenoexcept |
Time format for case file (general/fixed/scientific)
Definition at line 634 of file ensightCase.H.
Referenced by ensightWriter::ensightWriter(), and ensightCase::setTimeFormat().
|
inlinenoexcept |
Time precision for case file.
Definition at line 642 of file ensightCase.H.
Referenced by ensightWriter::ensightWriter(), and ensightCase::setTimeFormat().
|
inlinenoexcept |
The '*' mask appropriate for sub-directories.
Definition at line 647 of file ensightCase.H.
Foam::word padded | ( | const label | i | ) | const |
Consistent zero-padded integer value.
Definition at line 61 of file ensightCaseOptions.C.
|
inlinenoexcept |
Return current width of mask and padded.
Definition at line 657 of file ensightCase.H.
Referenced by ensightCase::options::options().
|
inlinenoexcept |
Remove existing directory and sub-directories on creation.
Definition at line 662 of file ensightCase.H.
|
inlinenoexcept |
Write clouds into their own directory instead in "data" directory.
Definition at line 667 of file ensightCase.H.
void width | ( | const int | i | ) |
Set width of mask and padded.
Default width is 8 digits, max width is 31 digits.
Definition at line 74 of file ensightCaseOptions.C.
References n.
|
inlinenoexcept |
Set the time format for case file.
Definition at line 682 of file ensightCase.H.
|
inlinenoexcept |
Set the time precision for case file.
Definition at line 690 of file ensightCase.H.
void timeFormat | ( | const word & | key, |
const dictionary & | dict | ||
) |
Set the time format for case file.
Definition at line 91 of file ensightCaseOptions.C.
References dict, IOstreamOption::floatFormatEnum(), and Foam::glTF::key().
void timePrecision | ( | const word & | key, |
const dictionary & | dict | ||
) |
Set the time precision for case file.
Definition at line 101 of file ensightCaseOptions.C.
References dict, Foam::glTF::key(), and keyType::LITERAL.
|
inlinenoexcept |
Remove existing directory and sub-directories on creation.
Definition at line 705 of file ensightCase.H.
|
inlinenoexcept |
Write clouds into their own directory instead in "data" directory.
Definition at line 710 of file ensightCase.H.
|
inlinenoexcept |
Forced use of values per node instead of per element.
Definition at line 718 of file ensightCase.H.
|
inlinenoexcept |
Force use of values per node instead of per element.
Deprecated(2020-02) - The newData() method with a second parameter is more flexible.
Definition at line 727 of file ensightCase.H.