Loading...
Searching...
No Matches
ensightMesh::options Class Reference

Configuration options for the ensightMesh. More...

#include <ensightMesh.H>

Public Member Functions

 options ()
 Default construct. Non-lazy with internal/boundary/cellZones.
bool lazy () const noexcept
 Lazy creation? (ie, starts as needsUpdate).
bool useInternalMesh () const noexcept
 Using internal?
bool useBoundaryMesh () const noexcept
 Using boundary?
bool useCellZones () const noexcept
 Using cellZones?
bool useFaceZones () const noexcept
 Using faceZones?
const wordRes & patchSelection () const noexcept
 Selection of patches. Empty if unspecified.
const wordRes & patchExclude () const noexcept
 Excluded patches. Empty if unspecified.
const wordRes & cellZoneSelection () const noexcept
 Selection of cell zones. Empty if unspecified.
const wordRes & cellZoneExclude () const noexcept
 Excluded cell zones. Future use.
const wordRes & faceZoneSelection () const noexcept
 Selection of face zones. Empty if unspecified.
const wordRes & faceZoneExclude () const noexcept
 Excluded face zones. Future use.
void reset ()
 Reset to defaults.
bool lazy (bool on) noexcept
 Lazy creation - ensightMesh starts as needsUpdate.
bool useInternalMesh (bool on) noexcept
 Alter the useBoundaryMesh state.
bool useBoundaryMesh (bool on)
 Alter the useBoundaryMesh state.
bool useCellZones (bool on)
 Alter the useCellZones state.
void patchSelection (const UList< wordRe > &patterns)
 Define patch selection matcher.
void patchSelection (List< wordRe > &&patterns)
 Define patch selection matcher.
void patchExclude (const UList< wordRe > &patterns)
 Define patch selection to exclude.
void patchExclude (List< wordRe > &&patterns)
 Define patch selection to exclude.
void cellZoneSelection (const UList< wordRe > &patterns)
 Define cellZone selection matcher.
void cellZoneSelection (List< wordRe > &&patterns)
 Define cellZone selection matcher.
void faceZoneSelection (const UList< wordRe > &patterns)
 Define faceZone selection matcher.
void faceZoneSelection (List< wordRe > &&patterns)
 Define faceZone selection matcher.
void print (Ostream &os) const
 Report values.

Detailed Description

Configuration options for the ensightMesh.

Definition at line 305 of file ensightMesh.H.

Constructor & Destructor Documentation

◆ options()

options ( )

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

Definition at line 53 of file ensightMeshOptions.C.

Member Function Documentation

◆ lazy() [1/2]

bool lazy ( ) const
noexcept

Lazy creation? (ie, starts as needsUpdate).

Definition at line 68 of file ensightMeshOptions.C.

References Foam::noexcept.

◆ useInternalMesh() [1/2]

bool useInternalMesh ( ) const
noexcept

Using internal?

Definition at line 74 of file ensightMeshOptions.C.

References Foam::noexcept.

◆ useBoundaryMesh() [1/2]

bool useBoundaryMesh ( ) const
noexcept

Using boundary?

Definition at line 80 of file ensightMeshOptions.C.

References Foam::noexcept.

◆ useCellZones() [1/2]

bool useCellZones ( ) const
noexcept

Using cellZones?

Definition at line 86 of file ensightMeshOptions.C.

References Foam::noexcept.

◆ useFaceZones()

bool useFaceZones ( ) const
noexcept

Using faceZones?

Definition at line 92 of file ensightMeshOptions.C.

References Foam::noexcept.

Referenced by print().

Here is the caller graph for this function:

◆ patchSelection() [1/3]

const wordRes & patchSelection ( ) const
inlinenoexcept

Selection of patches. Empty if unspecified.

Definition at line 392 of file ensightMesh.H.

References Foam::noexcept.

◆ patchExclude() [1/3]

const wordRes & patchExclude ( ) const
inlinenoexcept

Excluded patches. Empty if unspecified.

Definition at line 400 of file ensightMesh.H.

References Foam::noexcept.

◆ cellZoneSelection() [1/3]

const wordRes & cellZoneSelection ( ) const
inlinenoexcept

Selection of cell zones. Empty if unspecified.

Definition at line 408 of file ensightMesh.H.

References Foam::noexcept.

◆ cellZoneExclude()

const wordRes & cellZoneExclude ( ) const
inlinenoexcept

Excluded cell zones. Future use.

Definition at line 416 of file ensightMesh.H.

References Foam::noexcept, and wordRes::null().

Here is the call graph for this function:

◆ faceZoneSelection() [1/3]

const wordRes & faceZoneSelection ( ) const
inlinenoexcept

Selection of face zones. Empty if unspecified.

Definition at line 424 of file ensightMesh.H.

References Foam::noexcept.

◆ faceZoneExclude()

const wordRes & faceZoneExclude ( ) const
inlinenoexcept

Excluded face zones. Future use.

Definition at line 432 of file ensightMesh.H.

References Foam::noexcept, and wordRes::null().

Here is the call graph for this function:

◆ reset()

void reset ( )

Reset to defaults.

Definition at line 98 of file ensightMeshOptions.C.

◆ lazy() [2/2]

bool lazy ( bool on)
noexcept

Lazy creation - ensightMesh starts as needsUpdate.

Returns
old value

Definition at line 110 of file ensightMeshOptions.C.

◆ useInternalMesh() [2/2]

bool useInternalMesh ( bool on)
noexcept

Alter the useBoundaryMesh state.

Returns
old value

Definition at line 118 of file ensightMeshOptions.C.

◆ useBoundaryMesh() [2/2]

bool useBoundaryMesh ( bool on)

Alter the useBoundaryMesh state.

Returns
old value

Definition at line 126 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 147 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 165 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 183 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 201 of file ensightMeshOptions.C.

◆ patchExclude() [3/3]

void patchExclude ( List< wordRe > && patterns)

Define patch selection to exclude.

Definition at line 210 of file ensightMeshOptions.C.

◆ cellZoneSelection() [2/3]

void cellZoneSelection ( const UList< wordRe > & patterns)

Define cellZone selection matcher.

Definition at line 237 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 255 of file ensightMeshOptions.C.

References Foam::endl(), and WarningInFunction.

Here is the call graph for this function:

◆ faceZoneSelection() [2/3]

void faceZoneSelection ( const UList< wordRe > & patterns)

Define faceZone selection matcher.

Definition at line 219 of file ensightMeshOptions.C.

◆ faceZoneSelection() [3/3]

void faceZoneSelection ( List< wordRe > && patterns)

Define faceZone selection matcher.

Definition at line 228 of file ensightMeshOptions.C.

◆ print()

void print ( Ostream & os) const

Report values.

Definition at line 273 of file ensightMeshOptions.C.

References Switch::name(), Foam::nl, os(), Foam::printPatterns(), and useFaceZones().

Here is the call graph for this function:
The documentation for this class was generated from the following files: