ensightMesh::options Class Reference

Configuration options for the ensightMesh. More...

Public Member Functions

 options ()
 Default construct. Non-lazy with internal/boundary/cellZones. More...
 
bool lazy () const
 Lazy creation? (ie, ensightMesh starts as needsUpdate) More...
 
bool useInternalMesh () const
 Using internal? More...
 
bool useBoundaryMesh () const
 Using boundary? More...
 
bool useFaceZones () const
 Using faceZones? More...
 
bool useCellZones () const
 Using cellZones? More...
 
const wordRespatchSelection () const
 Selection of patches. Empty if unspecified. More...
 
const wordRespatchExclude () const
 Selection of black listed patches. Empty if unspecified. More...
 
const wordResfaceZoneSelection () const
 Selection of faceZones. Empty if unspecified. More...
 
const wordRescellZoneSelection () const
 Selection of faceZones. Empty if unspecified. More...
 
void reset ()
 Reset to defaults. More...
 
void lazy (bool beLazy)
 Lazy creation - ensightMesh starts as needsUpdate. More...
 
void useInternalMesh (bool on)
 Alter the useBoundaryMesh state. More...
 
void useBoundaryMesh (bool on)
 Alter the useBoundaryMesh state. More...
 
void 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 blacklist. More...
 
void patchExclude (List< wordRe > &&patterns)
 Define patch selection blacklist. 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 213 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

Lazy creation? (ie, ensightMesh starts as needsUpdate)

Definition at line 75 of file ensightMeshOptions.C.

◆ useInternalMesh() [1/2]

bool useInternalMesh ( ) const

Using internal?

Definition at line 81 of file ensightMeshOptions.C.

◆ useBoundaryMesh() [1/2]

bool useBoundaryMesh ( ) const

Using boundary?

Definition at line 87 of file ensightMeshOptions.C.

◆ useFaceZones()

bool useFaceZones ( ) const

Using faceZones?

Definition at line 99 of file ensightMeshOptions.C.

◆ useCellZones() [1/2]

bool useCellZones ( ) const

Using cellZones?

Definition at line 93 of file ensightMeshOptions.C.

◆ patchSelection() [1/3]

const Foam::wordRes & patchSelection ( ) const

Selection of patches. Empty if unspecified.

Definition at line 270 of file ensightMeshOptions.C.

◆ patchExclude() [1/3]

const Foam::wordRes & patchExclude ( ) const

Selection of black listed patches. Empty if unspecified.

Definition at line 276 of file ensightMeshOptions.C.

◆ faceZoneSelection() [1/3]

const Foam::wordRes & faceZoneSelection ( ) const

Selection of faceZones. Empty if unspecified.

Definition at line 282 of file ensightMeshOptions.C.

◆ cellZoneSelection() [1/3]

const Foam::wordRes & cellZoneSelection ( ) const

Selection of faceZones. Empty if unspecified.

Definition at line 288 of file ensightMeshOptions.C.

◆ reset()

void reset ( )

Reset to defaults.

Definition at line 105 of file ensightMeshOptions.C.

◆ lazy() [2/2]

void lazy ( bool  beLazy)

Lazy creation - ensightMesh starts as needsUpdate.

Definition at line 117 of file ensightMeshOptions.C.

◆ useInternalMesh() [2/2]

void useInternalMesh ( bool  on)

Alter the useBoundaryMesh state.

Definition at line 123 of file ensightMeshOptions.C.

◆ useBoundaryMesh() [2/2]

void useBoundaryMesh ( bool  on)

Alter the useBoundaryMesh state.

Definition at line 129 of file ensightMeshOptions.C.

References Foam::endl(), and WarningInFunction.

Here is the call graph for this function:

◆ useCellZones() [2/2]

void useCellZones ( bool  on)

Alter the useCellZones state.

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 163 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 181 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 blacklist.

Definition at line 199 of file ensightMeshOptions.C.

◆ patchExclude() [3/3]

void patchExclude ( List< wordRe > &&  patterns)

Define patch selection blacklist.

Definition at line 208 of file ensightMeshOptions.C.

◆ faceZoneSelection() [2/3]

void faceZoneSelection ( const UList< wordRe > &  patterns)

Define faceZone selection matcher.

Definition at line 217 of file ensightMeshOptions.C.

◆ faceZoneSelection() [3/3]

void faceZoneSelection ( List< wordRe > &&  patterns)

Define faceZone selection matcher.

Definition at line 226 of file ensightMeshOptions.C.

◆ cellZoneSelection() [2/3]

void cellZoneSelection ( const UList< wordRe > &  patterns)

Define cellZone selection matcher.

Definition at line 235 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 253 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 294 of file ensightMeshOptions.C.

References Ostream::decrIndent(), Ostream::incrIndent(), Switch::name(), Foam::nl, Foam::printPatterns(), and Ostream::writeKeyword().

Here is the call graph for this function:

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