Configuration options for the ensightMesh. More...

Public Member Functions
	options ()
	Default construct. Non-lazy with internal/boundary/cellZones. More...

bool	lazy () const noexcept
	Lazy creation? (ie, starts as needsUpdate) More...

bool	useInternalMesh () const noexcept
	Using internal? More...

bool	useBoundaryMesh () const noexcept
	Using boundary? More...

bool	useFaceZones () const noexcept
	Using faceZones? More...

bool	useCellZones () const noexcept
	Using cellZones? More...

const wordRes &	patchSelection () const noexcept
	Selection of patches. Empty if unspecified. More...

const wordRes &	patchExclude () const noexcept
	Selection of black listed patches. Empty if unspecified. More...

const wordRes &	faceZoneSelection () const noexcept
	Selection of faceZones. Empty if unspecified. More...

const wordRes &	cellZoneSelection () const noexcept
	Selection of faceZones. Empty if unspecified. More...

void	reset ()
	Reset to defaults. More...

bool	lazy (bool on) noexcept
	Lazy creation - ensightMesh starts as needsUpdate. More...

bool	useInternalMesh (bool on) noexcept
	Alter the useBoundaryMesh state. More...

bool	useBoundaryMesh (bool on)
	Alter the useBoundaryMesh state. More...

bool	useCellZones (bool on)
	Alter the useCellZones state. More...

void	patchSelection (const UList< wordRe > &patterns)
	Define patch selection matcher. More...

void	patchSelection (List< wordRe > &&patterns)
	Define patch selection matcher. More...

void	patchExclude (const UList< wordRe > &patterns)
	Define patch selection to exclude. More...

void	patchExclude (List< wordRe > &&patterns)
	Define patch selection to exclude. More...

void	faceZoneSelection (const UList< wordRe > &patterns)
	Define faceZone selection matcher. More...

void	faceZoneSelection (List< wordRe > &&patterns)
	Define faceZone selection matcher. More...

void	cellZoneSelection (const UList< wordRe > &patterns)
	Define cellZone selection matcher. More...

void	cellZoneSelection (List< wordRe > &&patterns)
	Define cellZone selection matcher. More...

void	print (Ostream &os) const
	Report values. More...

Detailed Description

Configuration options for the ensightMesh.

Definition at line 239 of file ensightMesh.H.

Constructor & Destructor Documentation

◆ options()

options ( )

Default construct. Non-lazy with internal/boundary/cellZones.

Definition at line 60 of file ensightMeshOptions.C.

Member Function Documentation

◆ lazy() [1/2]

bool lazy ( ) const

noexcept

Lazy creation? (ie, starts as needsUpdate)

Definition at line 75 of file ensightMeshOptions.C.

◆ useInternalMesh() [1/2]

bool useInternalMesh ( ) const

noexcept

Using internal?

Definition at line 81 of file ensightMeshOptions.C.

◆ useBoundaryMesh() [1/2]

bool useBoundaryMesh ( ) const

noexcept

Using boundary?

Definition at line 87 of file ensightMeshOptions.C.

◆ useFaceZones()

bool useFaceZones ( ) const

noexcept

Using faceZones?

Definition at line 99 of file ensightMeshOptions.C.

◆ useCellZones() [1/2]

bool useCellZones ( ) const

noexcept

Using cellZones?

Definition at line 93 of file ensightMeshOptions.C.

◆ patchSelection() [1/3]

const wordRes & patchSelection ( ) const

inlinenoexcept

Selection of patches. Empty if unspecified.

Definition at line 296 of file ensightMesh.H.

◆ patchExclude() [1/3]

const wordRes & patchExclude ( ) const

inlinenoexcept

Selection of black listed patches. Empty if unspecified.

Definition at line 302 of file ensightMesh.H.

◆ faceZoneSelection() [1/3]

const wordRes & faceZoneSelection ( ) const

inlinenoexcept

Selection of faceZones. Empty if unspecified.

Definition at line 308 of file ensightMesh.H.

◆ cellZoneSelection() [1/3]

const wordRes & cellZoneSelection ( ) const

inlinenoexcept

Selection of faceZones. Empty if unspecified.

Definition at line 314 of file ensightMesh.H.

◆ reset()

void reset ( )

Reset to defaults.

Definition at line 105 of file ensightMeshOptions.C.

Referenced by vtuCells::reset(), and IListStreamAllocator::reset_gbuffer().

Here is the caller graph for this function:

◆ lazy() [2/2]

bool lazy ( bool on )

noexcept

Lazy creation - ensightMesh starts as needsUpdate.

Returns: old value

Definition at line 117 of file ensightMeshOptions.C.

◆ useInternalMesh() [2/2]

bool useInternalMesh ( bool on )

noexcept

Alter the useBoundaryMesh state.

Returns: old value

Definition at line 125 of file ensightMeshOptions.C.

◆ useBoundaryMesh() [2/2]

bool useBoundaryMesh ( bool on )

Alter the useBoundaryMesh state.

Returns: old value

Definition at line 133 of file ensightMeshOptions.C.

References Foam::endl(), and WarningInFunction.

Here is the call graph for this function:

◆ useCellZones() [2/2]

bool useCellZones ( bool on )

Alter the useCellZones state.

Returns: old value

Definition at line 154 of file ensightMeshOptions.C.

References Foam::endl(), and WarningInFunction.

Here is the call graph for this function:

◆ patchSelection() [2/3]

void patchSelection ( const UList< wordRe > & patterns )

Define patch selection matcher.

Definition at line 172 of file ensightMeshOptions.C.

References Foam::endl(), and WarningInFunction.

Here is the call graph for this function:

◆ patchSelection() [3/3]

void patchSelection ( List< wordRe > && patterns )

Define patch selection matcher.

Definition at line 190 of file ensightMeshOptions.C.

References Foam::endl(), and WarningInFunction.

Here is the call graph for this function:

◆ patchExclude() [2/3]

void patchExclude ( const UList< wordRe > & patterns )

Define patch selection to exclude.

Definition at line 208 of file ensightMeshOptions.C.

◆ patchExclude() [3/3]

void patchExclude ( List< wordRe > && patterns )

Define patch selection to exclude.

Definition at line 217 of file ensightMeshOptions.C.

◆ faceZoneSelection() [2/3]

void faceZoneSelection ( const UList< wordRe > & patterns )

Define faceZone selection matcher.

Definition at line 226 of file ensightMeshOptions.C.

◆ faceZoneSelection() [3/3]

void faceZoneSelection ( List< wordRe > && patterns )

Define faceZone selection matcher.

Definition at line 235 of file ensightMeshOptions.C.

◆ cellZoneSelection() [2/3]

void cellZoneSelection ( const UList< wordRe > & patterns )

Define cellZone selection matcher.

Definition at line 244 of file ensightMeshOptions.C.

References Foam::endl(), and WarningInFunction.

Here is the call graph for this function:

◆ cellZoneSelection() [3/3]

void cellZoneSelection ( List< wordRe > && patterns )

Define cellZone selection matcher.

Definition at line 262 of file ensightMeshOptions.C.

References Foam::endl(), and WarningInFunction.

Here is the call graph for this function:

◆ print()

void print ( Ostream & os ) const

Report values.

Definition at line 280 of file ensightMeshOptions.C.

References Ostream::decrIndent(), Ostream::incrIndent(), solutionControl::fieldData::name, Foam::nl, os(), Foam::printPatterns(), and Ostream::writeKeyword().

Here is the call graph for this function:

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

src/fileFormats/ensight/mesh/ensightMesh.H
src/fileFormats/ensight/mesh/ensightMeshOptions.C

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ options()

Member Function Documentation

◆ lazy() [1/2]

◆ useInternalMesh() [1/2]

◆ useBoundaryMesh() [1/2]

◆ useFaceZones()

◆ useCellZones() [1/2]

◆ patchSelection() [1/3]

◆ patchExclude() [1/3]

◆ faceZoneSelection() [1/3]

◆ cellZoneSelection() [1/3]

◆ reset()

◆ lazy() [2/2]

◆ useInternalMesh() [2/2]

◆ useBoundaryMesh() [2/2]

◆ useCellZones() [2/2]

◆ patchSelection() [2/3]

◆ patchSelection() [3/3]

◆ patchExclude() [2/3]

◆ patchExclude() [3/3]

◆ faceZoneSelection() [2/3]

◆ faceZoneSelection() [3/3]

◆ cellZoneSelection() [2/3]

◆ cellZoneSelection() [3/3]

◆ print()