Configuration options for the ensightCase. More...

#include <ensightCase.H>

Public Member Functions
	options (IOstreamOption::streamFormat fmt=IOstreamOption::BINARY)
	Construct with the specified format (default is binary).
	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).
IOstreamOption::streamFormat	format () const noexcept
	The output file format (ascii/binary).
IOstreamOption::floatFormat	timeFormat () const noexcept
	Time format for case file (general/fixed/scientific).
int	timePrecision () const noexcept
	Time precision for case file.
const word &	mask () const noexcept
	The '*' mask appropriate for sub-directories.
word	padded (const label i) const
	Consistent zero-padded integer value.
int	width () const noexcept
	Return current width of mask and padded.
bool	overwrite () const noexcept
	Remove existing directory and sub-directories on creation.
bool	separateCloud () const noexcept
	Write clouds into their own directory instead in "data" directory.
void	width (const int i)
	Set width of mask and padded.
void	timeFormat (IOstreamOption::floatFormat fmt) noexcept
	Set the time format for case file.
void	timePrecision (int prec) noexcept
	Set the time precision for case file.
void	timeFormat (const word &key, const dictionary &dict)
	Set the time format for case file.
void	timePrecision (const word &key, const dictionary &dict)
	Set the time precision for case file.
void	overwrite (bool on) noexcept
	Remove existing directory and sub-directories on creation.
void	separateCloud (bool on) noexcept
	Write clouds into their own directory instead in "data" directory.
bool	nodeValues () const noexcept
	Forced use of values per node instead of per element.
void	nodeValues (bool on) noexcept
	Force use of values per node instead of per element.

Detailed Description

Configuration options for the ensightCase.

Definition at line 546 of file ensightCase.H.

Constructor & Destructor Documentation

◆ options() [1/2]

options ( IOstreamOption::streamFormat fmt = IOstreamOption::BINARY )

explicit

Construct with the specified format (default is binary).

Definition at line 26 of file ensightCaseOptions.C.

References Foam::scientific(), and width().

Referenced by options().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ options() [2/2]

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).

Parameters

formatKeyword The lookup name for the format, typically 'format' or 'writeFormat' etc.

Definition at line 48 of file ensightCaseOptions.C.

References dict, and options().

Here is the call graph for this function:

Member Function Documentation

◆ format()

IOstreamOption::streamFormat format ( ) const

inlinenoexcept

The output file format (ascii/binary).

Definition at line 629 of file ensightCase.H.

References Foam::noexcept.

◆ timeFormat() [1/3]

IOstreamOption::floatFormat timeFormat ( ) const

inlinenoexcept

Time format for case file (general/fixed/scientific).

Definition at line 634 of file ensightCase.H.

References Foam::noexcept.

Referenced by ensightCase::setTimeFormat().

Here is the caller graph for this function:

◆ timePrecision() [1/3]

int timePrecision ( ) const

inlinenoexcept

Time precision for case file.

Definition at line 642 of file ensightCase.H.

References Foam::noexcept.

Referenced by ensightCase::setTimeFormat().

Here is the caller graph for this function:

◆ mask()

const word & mask ( ) const

inlinenoexcept

The '*' mask appropriate for sub-directories.

Definition at line 647 of file ensightCase.H.

References Foam::noexcept.

◆ padded()

Foam::word padded ( const label i ) const

Consistent zero-padded integer value.

Definition at line 61 of file ensightCaseOptions.C.

◆ width() [1/2]

int width ( ) const

inlinenoexcept

Return current width of mask and padded.

Definition at line 657 of file ensightCase.H.

References Foam::noexcept.

Referenced by options().

Here is the caller graph for this function:

◆ overwrite() [1/2]

bool overwrite ( ) const

inlinenoexcept

Remove existing directory and sub-directories on creation.

Definition at line 662 of file ensightCase.H.

References Foam::noexcept.

◆ separateCloud() [1/2]

bool separateCloud ( ) const

inlinenoexcept

Write clouds into their own directory instead in "data" directory.

Definition at line 667 of file ensightCase.H.

References Foam::noexcept.

◆ width() [2/2]

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.

◆ timeFormat() [2/3]

void timeFormat ( IOstreamOption::floatFormat fmt )

inlinenoexcept

Set the time format for case file.

Definition at line 682 of file ensightCase.H.

◆ timePrecision() [2/3]

void timePrecision ( int prec )

inlinenoexcept

Set the time precision for case file.

Definition at line 690 of file ensightCase.H.

◆ timeFormat() [3/3]

void timeFormat	(	const word &	key,
		const dictionary &	dict )

Set the time format for case file.

Definition at line 90 of file ensightCaseOptions.C.

References dict, and IOstreamOption::floatFormatEnum().

Here is the call graph for this function:

◆ timePrecision() [3/3]

void timePrecision	(	const word &	key,
		const dictionary &	dict )

Set the time precision for case file.

Definition at line 100 of file ensightCaseOptions.C.

References dict, and keyType::LITERAL.

◆ overwrite() [2/2]

void overwrite ( bool on )

inlinenoexcept

Remove existing directory and sub-directories on creation.

Definition at line 705 of file ensightCase.H.

◆ separateCloud() [2/2]

void separateCloud ( bool on )

inlinenoexcept

Write clouds into their own directory instead in "data" directory.

Definition at line 710 of file ensightCase.H.

◆ nodeValues() [1/2]

bool nodeValues ( ) const

inlinenoexcept

Forced use of values per node instead of per element.

Definition at line 718 of file ensightCase.H.

References Foam::noexcept.

◆ nodeValues() [2/2]

void nodeValues ( bool on )

inlinenoexcept

Force use of values per node instead of per element.

Deprecated(2020-02) - The newData() method with a second parameter is more flexible.

Deprecated: (2020-02) - newData() with second parameter

Definition at line 727 of file ensightCase.H.

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

src/fileFormats/ensight/file/ensightCase.H
src/fileFormats/ensight/file/ensightCaseOptions.C

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ options() [1/2]

◆ options() [2/2]

Member Function Documentation

◆ format()

◆ timeFormat() [1/3]

◆ timePrecision() [1/3]

◆ mask()

◆ padded()

◆ width() [1/2]

◆ overwrite() [1/2]

◆ separateCloud() [1/2]

◆ width() [2/2]

◆ timeFormat() [2/3]

◆ timePrecision() [2/3]

◆ timeFormat() [3/3]

◆ timePrecision() [3/3]

◆ overwrite() [2/2]

◆ separateCloud() [2/2]

◆ nodeValues() [1/2]

◆ nodeValues() [2/2]