Classes | Public Member Functions | List of all members
ensightPart Class Referenceabstract

Base class for ensightPartCells and ensightPartFaces. More...

Inheritance diagram for ensightPart:
[legend]

Classes

struct  localPoints
 Track the points used by the part and map global to local indices. More...
 

Public Member Functions

 TypeName ("ensightPart")
 Runtime type information. More...
 
 ensightPart (const string &description)
 Construct with description. More...
 
virtual ~ensightPart ()=default
 Destructor. More...
 
virtual label index () const =0
 Part index (0-based) More...
 
virtual label size () const
 Number of elements in this part. More...
 
const string & name () const
 Return the part name or description. More...
 
void rename (string value)
 Change the part name or description. More...
 
virtual void writeSummary (Ostream &os) const =0
 Write summary information about the object. More...
 
virtual void dumpInfo (Ostream &os) const =0
 Print various types of debugging information. More...
 
virtual void write (ensightGeoFile &os) const =0
 Write geometry. More...
 
virtual void write (ensightGeoFile &os, const pointField &) const =0
 Helper: write geometry with given pointField. More...
 
void FOAM_DEPRECATED_FOR (2019-12, "rename() method") name(string value)
 Deprecated(2019-12) - use rename() method. More...
 

Detailed Description

Base class for ensightPartCells and ensightPartFaces.

Source files

Definition at line 56 of file ensightPart.H.

Constructor & Destructor Documentation

◆ ensightPart()

ensightPart ( const string &  description)
explicit

Construct with description.

Definition at line 65 of file ensightPart.C.

◆ ~ensightPart()

virtual ~ensightPart ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "ensightPart"  )

Runtime type information.

◆ index()

virtual label index ( ) const
pure virtual

Part index (0-based)

Implemented in ensightPartFaces, and ensightPartCells.

Referenced by ensightParts::write().

Here is the caller graph for this function:

◆ size()

virtual label size ( ) const
inlinevirtual

Number of elements in this part.

Reimplemented in ensightPartFaces, and ensightPartCells.

Definition at line 123 of file ensightPart.H.

◆ name()

const string& name ( ) const
inline

Return the part name or description.

Definition at line 129 of file ensightPart.H.

◆ rename()

void rename ( string  value)
inline

Change the part name or description.

Definition at line 135 of file ensightPart.H.

◆ writeSummary()

virtual void writeSummary ( Ostream &  os) const
pure virtual

Write summary information about the object.

Implemented in ensightPartFaces, and ensightPartCells.

Referenced by ensightParts::writeSummary().

Here is the caller graph for this function:

◆ dumpInfo()

virtual void dumpInfo ( Ostream &  os) const
pure virtual

Print various types of debugging information.

Implemented in ensightPartFaces, and ensightPartCells.

Referenced by ensightParts::dumpInfo().

Here is the caller graph for this function:

◆ write() [1/2]

virtual void write ( ensightGeoFile &  os) const
pure virtual

Write geometry.

Implemented in ensightPartFaces, and ensightPartCells.

Referenced by ensightParts::write().

Here is the caller graph for this function:

◆ write() [2/2]

virtual void write ( ensightGeoFile &  os,
const pointField &   
) const
pure virtual

Helper: write geometry with given pointField.

Implemented in ensightPartFaces, and ensightPartCells.

◆ FOAM_DEPRECATED_FOR()

void FOAM_DEPRECATED_FOR ( 2019-  12,
"rename() method"   
)
inline

Deprecated(2019-12) - use rename() method.

Deprecated:
(2019-12) - use rename() method

Definition at line 160 of file ensightPart.H.

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