Public Member Functions | List of all members
ensightFaMesh Class Reference

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

Public Member Functions

 ensightFaMesh (const faMesh &mesh)
 Construct from mesh with all default options. More...
 
const faMesh & mesh () const noexcept
 Reference to the underlying faMesh. More...
 
const ensightFaces & areaPart () const noexcept
 Face elements for finite-area. 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...
 

Detailed Description

Encapsulation of area meshes for writing in ensight format.

Note
Currently restricted to a single faMesh representation. The face elements are created from a specified subset of polyMesh faces. The original ordering of these faces is retained in the ensightFaces faceOrder().
Source files

Definition at line 62 of file ensightFaMesh.H.

Constructor & Destructor Documentation

◆ ensightFaMesh()

ensightFaMesh ( const faMesh &  mesh)
explicit

Construct from mesh with all default options.

Definition at line 51 of file ensightFaMesh.C.

References correct().

Here is the call graph for this function:

Member Function Documentation

◆ mesh()

const faMesh& mesh ( ) const
inlinenoexcept

Reference to the underlying faMesh.

Definition at line 104 of file ensightFaMesh.H.

Referenced by Foam::writeAreaFields().

Here is the caller graph for this function:

◆ areaPart()

const ensightFaces& areaPart ( ) const
inlinenoexcept

Face elements for finite-area.

Definition at line 110 of file ensightFaMesh.H.

Referenced by Foam::ensightOutput::writeAreaField().

Here is the caller graph for this function:

◆ needsUpdate()

bool needsUpdate ( ) const
inlinenoexcept

Does the content need an update?

Definition at line 119 of file ensightFaMesh.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 30 of file ensightFaMeshI.H.

◆ correct()

void correct ( )

Update for new mesh.

Definition at line 68 of file ensightFaMesh.C.

References ensightFaces::classify(), clear(), ensightFaces::clear(), ensightPart::identifier(), ensightFaces::reduce(), ensightPart::rename(), and Foam::renumber().

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 103 of file ensightFaMesh.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 46 of file ensightFaMeshI.H.

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

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