Classes | Public Member Functions | Static Public Attributes | List of all members
ensightMesh Class Reference

Encapsulation of volume meshes for writing in ensight format. It manages cellZones, facesZone, patches. More...

Classes

class  options
 Configuration options for the ensightMesh. More...
 

Public Member Functions

 ensightMesh (const polyMesh &mesh)
 Construct from mesh with all default options. More...
 
 ensightMesh (const polyMesh &mesh, const options &opts)
 Construct from components. More...
 
const polyMesh & mesh () const noexcept
 Reference to the underlying polyMesh. More...
 
const ensightMesh::options & option () const
 Reference to the writer/mesh options. More...
 
const Map< ensightCells > & cellZoneParts () const noexcept
 Face elements per selected patch, lookup by patch index. More...
 
const Map< ensightFaces > & faceZoneParts () const noexcept
 Face elements per faceZone, lookup by zone index. More...
 
const Map< ensightFaces > & boundaryParts () const noexcept
 Face elements per selected patch, lookup by patch index. More...
 
bool empty () const noexcept
 Any parts? More...
 
label size () const noexcept
 Number of parts. More...
 
bool needsUpdate () const noexcept
 Does the content need an update? More...
 
bool expire ()
 Mark as needing an update. More...
 
void correct ()
 Update for new mesh. More...
 
void write (ensightGeoFile &os, bool parallel=Pstream::parRun()) const
 Write geometry to file. Normally in parallel. More...
 
void write (autoPtr< ensightGeoFile > &os, bool parallel=Pstream::parRun()) const
 Write geometry to file. Normally in parallel. More...
 

Static Public Attributes

static const label internalZone = -1
 The zone-id for internal mesh or unzoned cells. More...
 

Detailed Description

Encapsulation of volume meshes for writing in ensight format. It manages cellZones, facesZone, patches.

When cellZones are present (and not disabled), the cells are grouped in parts according to the zone. Any remaining unzoned cells are placed into the "internalMesh" part, which is always part 0. If cellZones are missing or disabled, all cells are placed into the "internalMesh" part.

If one or more cellZones are explicitly requested, all other cells (including any unzoned cells) are ignored.

The converted patch faces are restricted by the volume mesh coverage. Except when the entire internal mesh has been explicitly suppressed.

Note
The internal data management uses a Map for cellZones, faceZones and patches. The internalMesh is treated as cellZone with a special index.

Since the patches are subsetted by the internal mesh coverage, they are treated as indirect patches rather than regular poly patches.

Source files

Definition at line 82 of file ensightMesh.H.

Constructor & Destructor Documentation

◆ ensightMesh() [1/2]

ensightMesh ( const polyMesh &  mesh)
explicit

Construct from mesh with all default options.

Definition at line 97 of file ensightMesh.C.

◆ ensightMesh() [2/2]

ensightMesh ( const polyMesh &  mesh,
const options &  opts 
)

Construct from components.

Definition at line 106 of file ensightMesh.C.

References correct().

Here is the call graph for this function:

Member Function Documentation

◆ mesh()

const polyMesh& mesh ( ) const
inlinenoexcept

Reference to the underlying polyMesh.

Definition at line 148 of file ensightMesh.H.

Referenced by Foam::writeDimFields(), Foam::ensightOutput::writePointField(), Foam::writePointFields(), and Foam::writeVolFields().

Here is the caller graph for this function:

◆ option()

const Foam::ensightMesh::options & option ( ) const
inline

Reference to the writer/mesh options.

Definition at line 30 of file ensightMeshI.H.

◆ cellZoneParts()

const Map<ensightCells>& cellZoneParts ( ) const
inlinenoexcept

Face elements per selected patch, lookup by patch index.

Process in sorted order. May require special treatment for zone -1 (internal).

Definition at line 159 of file ensightMesh.H.

Referenced by Foam::ensightOutput::writePointField(), and Foam::ensightOutput::writeVolField().

Here is the caller graph for this function:

◆ faceZoneParts()

const Map<ensightFaces>& faceZoneParts ( ) const
inlinenoexcept

Face elements per faceZone, lookup by zone index.

Process in sorted order.

Definition at line 166 of file ensightMesh.H.

Referenced by Foam::ensightOutput::writePointField(), and Foam::ensightOutput::writeVolField().

Here is the caller graph for this function:

◆ boundaryParts()

const Map<ensightFaces>& boundaryParts ( ) const
inlinenoexcept

Face elements per selected patch, lookup by patch index.

Process in sorted order.

Definition at line 173 of file ensightMesh.H.

Referenced by Foam::ensightOutput::writePointField(), and Foam::ensightOutput::writeVolField().

Here is the caller graph for this function:

◆ empty()

bool empty ( ) const
inlinenoexcept

Any parts?

Definition at line 51 of file ensightMeshI.H.

◆ size()

Foam::label size ( ) const
inlinenoexcept

Number of parts.

Definition at line 62 of file ensightMeshI.H.

◆ needsUpdate()

bool needsUpdate ( ) const
inlinenoexcept

Does the content need an update?

Definition at line 191 of file ensightMesh.H.

◆ expire()

bool expire ( )
inline

Mark as needing an update.

May also free up unneeded data. Return false if already marked as expired.

Definition at line 36 of file ensightMeshI.H.

References clear().

Here is the call graph for this function:

◆ correct()

void correct ( )

Update for new mesh.

Definition at line 124 of file ensightMesh.C.

References bitSet::any(), ensightFaces::classify(), ensightCells::classify(), clear(), ensightFaces::clear(), ensightCells::clear(), PackedList< Width >::clearStorage(), PackedList< Width >::empty(), Foam::stringListOps::findMatching(), bitSet::flip(), faceZone::flipMap(), forAll, ensightPart::identifier(), Foam::identity(), wordRes::matching(), bitSet::none(), Foam::nonProcessorPatchNames(), p, patchId(), patchIds, patchNames(), ensightFaces::reduce(), ensightCells::reduce(), ensightPart::rename(), Foam::renumber(), PackedList< Width >::resize(), Foam::returnReduce(), bitSet::set(), bitSet::test(), and ensightFaces::total().

Here is the call graph for this function:

◆ write() [1/2]

void write ( ensightGeoFile &  os,
bool  parallel = Pstream::parRun() 
) const

Write geometry to file. Normally in parallel.

Definition at line 396 of file ensightMesh.C.

References os().

Here is the call graph for this function:

◆ write() [2/2]

void write ( autoPtr< ensightGeoFile > &  os,
bool  parallel = Pstream::parRun() 
) const
inline

Write geometry to file. Normally in parallel.

Definition at line 74 of file ensightMeshI.H.

References os(), and Foam::vtk::write().

Here is the call graph for this function:

Member Data Documentation

◆ internalZone

const Foam::label internalZone = -1
static

The zone-id for internal mesh or unzoned cells.

Definition at line 87 of file ensightMesh.H.

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