ensightCase::options Class Reference

Configuration options for the ensightCase. More...

Public Member Functions
	options (IOstreamOption::streamFormat fmt=IOstreamOption::BINARY)
	Construct with the specified format (default is binary) More...
IOstreamOption::streamFormat	format () const noexcept
	Ascii/Binary file output. 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...
label	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 label i)
	Set width of mask and padded. 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...

Detailed Description

Configuration options for the ensightCase.

Definition at line 510 of file ensightCase.H.

Constructor & Destructor Documentation

options()

options

(

IOstreamOption::streamFormat

fmt = IOstreamOption::BINARY

)

Construct with the specified format (default is binary)

Definition at line 25 of file ensightCaseOptions.C.

References ensightCase::options::width().

Here is the call graph for this function:

Member Function Documentation

format()

IOstreamOption::streamFormat format ( ) const

inlinenoexcept

Ascii/Binary file output.

Definition at line 567 of file ensightCase.H.

mask()

const word& mask ( ) const

inlinenoexcept

The '*' mask appropriate for sub-directories.

Definition at line 572 of file ensightCase.H.

padded()

Foam::word padded

(

const label

i

)

const

Consistent zero-padded integer value.

Definition at line 41 of file ensightCaseOptions.C.

width() [1/2]

label width ( ) const

inlinenoexcept

Return current width of mask and padded.

Definition at line 582 of file ensightCase.H.

Referenced by ensightCase::options::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 587 of file ensightCase.H.

separateCloud() [1/2]

bool separateCloud ( ) const

inlinenoexcept

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

Definition at line 592 of file ensightCase.H.

width() [2/2]

void width

(

const label

i

)

Set width of mask and padded.

Default width is 8 digits, max width is 31 digits.

Definition at line 54 of file ensightCaseOptions.C.

References n.

overwrite() [2/2]

void overwrite ( bool  on )

inlinenoexcept

Remove existing directory and sub-directories on creation.

Definition at line 607 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 612 of file ensightCase.H.

nodeValues() [1/2]

bool nodeValues ( ) const

inlinenoexcept

Forced use of values per node instead of per element.

Definition at line 620 of file ensightCase.H.

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 629 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