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

Encapsulation of volume meshes for writing in ensight format. More...

Classes

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

Public Member Functions

 ensightMesh (const fvMesh &mesh, const options &opts)
 Construct from components. More...
 
 ensightMesh (const fvMesh &mesh)
 Construct from fvMesh with all default options, binary output. More...
 
 ensightMesh (const fvMesh &mesh, const IOstream::streamFormat format)
 Construct from fvMesh with all default options and specified format. More...
 
 ~ensightMesh ()
 Destructor. More...
 
const fvMesh & mesh () const
 Reference to the underlying fvMesh. More...
 
const ensightMesh::options & option () const
 Reference to the writer/mesh options. More...
 
IOstream::streamFormat format () const
 Ascii/Binary file output. More...
 
bool useInternalMesh () const
 Using internal? More...
 
bool useBoundaryMesh () const
 Using boundary? More...
 
const ensightCells & meshCells () const
 The volume cells (internalMesh) More...
 
const Map< word > & patches () const
 The list of patches to be output. More...
 
const HashTable< ensightFaces > & boundaryPatchFaces () const
 Face elements per selected patch. More...
 
const HashTable< ensightFaces > & faceZoneFaces () const
 Face elements per selected faceZone. More...
 
const globalIndex & globalPoints () const
 Global numbering for merged points. More...
 
const labelList & pointToGlobal () const
 From mesh point to global merged point. More...
 
const labelList & uniquePointMap () const
 Local points that are unique. More...
 
bool needsUpdate () const
 Does the content need an update? More...
 
bool expire ()
 Mark as needing an update. More...
 
void correct ()
 Update for new mesh. More...
 
void write (autoPtr< ensightGeoFile > &os) const
 Write to file. More...
 
void write (ensightGeoFile &os) const
 Write to file. More...
 

Detailed Description

Encapsulation of volume meshes for writing in ensight format.

Source files

Definition at line 68 of file ensightMesh.H.

Constructor & Destructor Documentation

◆ ensightMesh() [1/3]

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

Construct from components.

Definition at line 57 of file ensightMesh.C.

References correct().

Here is the call graph for this function:

◆ ensightMesh() [2/3]

ensightMesh ( const fvMesh &  mesh)
explicit

Construct from fvMesh with all default options, binary output.

Definition at line 73 of file ensightMesh.C.

◆ ensightMesh() [3/3]

ensightMesh ( const fvMesh &  mesh,
const IOstream::streamFormat  format 
)

Construct from fvMesh with all default options and specified format.

Definition at line 80 of file ensightMesh.C.

References correct().

Here is the call graph for this function:

◆ ~ensightMesh()

~ensightMesh ( )

Destructor.

Definition at line 98 of file ensightMesh.C.

References Foam::deleteDemandDrivenData().

Here is the call graph for this function:

Member Function Documentation

◆ mesh()

const Foam::fvMesh & mesh ( ) const
inline

Reference to the underlying fvMesh.

Definition at line 30 of file ensightMeshI.H.

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

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 36 of file ensightMeshI.H.

◆ format()

Foam::IOstream::streamFormat format ( ) const
inline

Ascii/Binary file output.

Definition at line 42 of file ensightMeshI.H.

◆ useInternalMesh()

bool useInternalMesh ( ) const
inline

Using internal?

Definition at line 48 of file ensightMeshI.H.

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

Here is the caller graph for this function:

◆ useBoundaryMesh()

bool useBoundaryMesh ( ) const
inline

Using boundary?

Definition at line 54 of file ensightMeshI.H.

◆ meshCells()

const Foam::ensightCells & meshCells ( ) const
inline

The volume cells (internalMesh)

Definition at line 60 of file ensightMeshI.H.

Referenced by Foam::ensightOutput::Detail::writeVolField().

Here is the caller graph for this function:

◆ patches()

const Foam::Map< Foam::word > & patches ( ) const
inline

The list of patches to be output.

Definition at line 66 of file ensightMeshI.H.

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

Here is the caller graph for this function:

◆ boundaryPatchFaces()

const Foam::HashTable< Foam::ensightFaces > & boundaryPatchFaces ( ) const
inline

Face elements per selected patch.

Definition at line 73 of file ensightMeshI.H.

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

Here is the caller graph for this function:

◆ faceZoneFaces()

const Foam::HashTable< Foam::ensightFaces > & faceZoneFaces ( ) const
inline

Face elements per selected faceZone.

To be output in sorted order.

Definition at line 80 of file ensightMeshI.H.

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

Here is the caller graph for this function:

◆ globalPoints()

const globalIndex& globalPoints ( ) const
inline

Global numbering for merged points.

Definition at line 350 of file ensightMesh.H.

◆ pointToGlobal()

const labelList& pointToGlobal ( ) const
inline

From mesh point to global merged point.

Definition at line 356 of file ensightMesh.H.

◆ uniquePointMap()

const labelList& uniquePointMap ( ) const
inline

Local points that are unique.

Definition at line 362 of file ensightMesh.H.

Referenced by Foam::ensightOutput::Detail::writePointField().

Here is the caller graph for this function:

◆ needsUpdate()

bool needsUpdate ( ) const

Does the content need an update?

Definition at line 106 of file ensightMesh.C.

◆ expire()

bool expire ( )

Mark as needing an update.

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

Definition at line 112 of file ensightMesh.C.

References clear().

Here is the call graph for this function:

◆ correct()

void correct ( )

Update for new mesh.

Definition at line 127 of file ensightMesh.C.

References polyPatch::boundaryMesh(), ensightFaces::classify(), clear(), ensightFaces::clear(), Foam::findStrings(), faceZone::flipMap(), Foam::identity(), ensightFaces::index(), p, UPstream::parRun(), patchId(), patchIds, patchNames(), ensightFaces::reduce(), List< T >::resize(), ensightFaces::total(), and zoneID.

Here is the call graph for this function:

◆ write() [1/2]

void write ( autoPtr< ensightGeoFile > &  os) const
inline

Write to file.

Definition at line 86 of file ensightMeshI.H.

References autoPtr< T >::ref(), and Foam::vtk::write().

Here is the call graph for this function:

◆ write() [2/2]

void write ( ensightGeoFile &  os) const

Write to file.

Definition at line 275 of file ensightMesh.C.

References polyPatch::boundaryMesh(), f(), ensightFaces::faceIds(), ensightFaces::flipMap(), forAll, ensightFaces::index(), Foam::inplaceRenumber(), PrimitivePatch< Face, FaceList, PointField, PointType >::localFaces(), PrimitivePatch< Face, FaceList, PointField, PointType >::meshPointMap(), PrimitivePatch< Face, FaceList, PointField, PointType >::meshPoints(), nPoints, and patchId().

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