ensightCase::options Class Reference

Configuration options for the ensightCase. More...

Public Member Functions
	options (IOstream::streamFormat format=IOstream::BINARY)
	Construct with the specified format (default is binary) More...
IOstream::streamFormat	format () const
	Ascii/Binary file output. More...
const word &	mask () const
	The '*' mask appropriate for sub-directories. More...
word	padded (const label i) const
	Consistent zero-padded integer value. More...
label	width () const
	Return current width of mask and padded. More...
bool	overwrite () const
	Remove existing directory and sub-directories on creation. More...
bool	separateCloud () const
	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)
	Remove existing directory and sub-directories on creation. More...
void	separateCloud (bool)
	Write clouds into their own directory instead in "data" directory. More...
bool	nodeValues () const
	Force use of values per node instead of per element. More...
void	nodeValues (bool)
	Force use of values per node instead of per element. More...

Detailed Description

Configuration options for the ensightCase.

Definition at line 328 of file ensightCase.H.

Constructor & Destructor Documentation

options()

options

(

IOstream::streamFormat

format = IOstream::BINARY

)

Construct with the specified format (default is binary)

Definition at line 32 of file ensightCaseOptions.C.

References ensightCase::options::width().

Here is the call graph for this function:

Member Function Documentation

format()

Foam::IOstream::streamFormat format

(

)

const

Ascii/Binary file output.

Definition at line 48 of file ensightCaseOptions.C.

mask()

const Foam::word & mask

(

)

const

The '*' mask appropriate for sub-directories.

Definition at line 54 of file ensightCaseOptions.C.

padded()

Foam::word padded

(

const label

i

)

const

Consistent zero-padded integer value.

Definition at line 60 of file ensightCaseOptions.C.

width() [1/2]

Foam::label width

(

)

const

Return current width of mask and padded.

Definition at line 73 of file ensightCaseOptions.C.

Referenced by ensightCase::options::options().

Here is the caller graph for this function:

overwrite() [1/2]

bool overwrite

(

)

const

Remove existing directory and sub-directories on creation.

Definition at line 95 of file ensightCaseOptions.C.

separateCloud() [1/2]

bool separateCloud

(

)

const

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

Definition at line 119 of file ensightCaseOptions.C.

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 79 of file ensightCaseOptions.C.

References n.

overwrite() [2/2]

void overwrite

(

bool

b

)

Remove existing directory and sub-directories on creation.

Definition at line 101 of file ensightCaseOptions.C.

References Foam::constant::physicoChemical::b.

separateCloud() [2/2]

void separateCloud

(

bool

b

)

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

Definition at line 125 of file ensightCaseOptions.C.

References Foam::constant::physicoChemical::b.

nodeValues() [1/2]

bool nodeValues

(

)

const

Force use of values per node instead of per element.

Definition at line 107 of file ensightCaseOptions.C.

nodeValues() [2/2]

void nodeValues

(

bool

b

)

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 113 of file ensightCaseOptions.C.

References Foam::constant::physicoChemical::b.

---

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

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