Public Member Functions | Protected Member Functions | List of all members
ensightPart Class Reference

Base class for ensightCells, ensightFaces, ensightOutputSurfaces. More...

Inheritance diagram for ensightPart:
[legend]

Public Member Functions

 TypeNameNoDebug ("ensightPart")
 Declare type-name, virtual type (without debug switch) More...
 
 ensightPart () noexcept
 Default construct. Index=0, identifier = -1. More...
 
 ensightPart (const string &description)
 Default construct, with description/partName. More...
 
virtual ~ensightPart ()=default
 Destructor. More...
 
label index () const
 The index in a list (0-based) More...
 
label & index ()
 The index in a list (0-based) More...
 
label identifier () const
 OpenFOAM identifier (patch, zone, etc), -1 when not in use. More...
 
label & identifier ()
 OpenFOAM identifier (patch, zone, etc), -1 when not in use. More...
 
bool empty () const
 Processor-local test for any elements. More...
 
label size () const
 Processor-local size of all elements. More...
 
const string & name () const
 The part name or description. More...
 
void rename (const string &value)
 Change the part name or description. More...
 
void rename (string &&value)
 Change the part name or description. More...
 
virtual void writeDict (Ostream &os, const bool full=false) const
 
label operator[] (const label i) const
 Processor-local element id from linear-list of addresses. More...
 

Protected Member Functions

const labelList & addressing () const
 Element addressing. More...
 
labelList & addressing ()
 Element addressing. More...
 
void clear ()
 Clear element addressing. More...
 
void incrAddressing (const label off)
 Increase addressing by specified offset value. More...
 
void decrAddressing (const label off)
 Decrease addressing by specified offset value. More...
 

Detailed Description

Base class for ensightCells, ensightFaces, ensightOutputSurfaces.

Source files

Definition at line 53 of file ensightPart.H.

Constructor & Destructor Documentation

◆ ensightPart() [1/2]

ensightPart ( )
noexcept

Default construct. Index=0, identifier = -1.

Definition at line 61 of file ensightPart.C.

◆ ensightPart() [2/2]

ensightPart ( const string &  description)
explicit

Default construct, with description/partName.

Definition at line 70 of file ensightPart.C.

◆ ~ensightPart()

virtual ~ensightPart ( )
virtualdefault

Destructor.

Member Function Documentation

◆ addressing() [1/2]

const labelList& addressing ( ) const
inlineprotected

Element addressing.

Definition at line 76 of file ensightPart.H.

◆ addressing() [2/2]

labelList& addressing ( )
inlineprotected

Element addressing.

Definition at line 82 of file ensightPart.H.

◆ clear()

void clear ( )
inlineprotected

Clear element addressing.

Definition at line 88 of file ensightPart.H.

References List< T >::clear().

Referenced by ensightFaces::clear(), and ensightCells::clear().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ incrAddressing()

void incrAddressing ( const label  off)
protected

Increase addressing by specified offset value.

Eg, change local to global id

Definition at line 41 of file ensightPart.C.

◆ decrAddressing()

void decrAddressing ( const label  off)
protected

Decrease addressing by specified offset value.

Eg, change global to local id

Definition at line 50 of file ensightPart.C.

◆ TypeNameNoDebug()

TypeNameNoDebug ( "ensightPart"  )

Declare type-name, virtual type (without debug switch)

◆ index() [1/2]

label index ( ) const
inline

The index in a list (0-based)

Definition at line 124 of file ensightPart.H.

Referenced by ensightOutputSurface::write(), ensightFaces::write(), ensightCells::write(), Foam::ensightOutput::Detail::writeFaceSubField(), Foam::ensightOutput::writeField(), ensightOutputSurface::writePointData(), and Foam::ensightOutput::writePointField().

Here is the caller graph for this function:

◆ index() [2/2]

label& index ( )
inline

The index in a list (0-based)

Definition at line 130 of file ensightPart.H.

◆ identifier() [1/2]

label identifier ( ) const
inline

OpenFOAM identifier (patch, zone, etc), -1 when not in use.

Definition at line 136 of file ensightPart.H.

Referenced by ensightMesh::correct().

Here is the caller graph for this function:

◆ identifier() [2/2]

label& identifier ( )
inline

OpenFOAM identifier (patch, zone, etc), -1 when not in use.

Definition at line 142 of file ensightPart.H.

◆ empty()

bool empty ( ) const
inline

Processor-local test for any elements.

Definition at line 148 of file ensightPart.H.

Referenced by ensightOutputSurface::writePointData().

Here is the caller graph for this function:

◆ size()

label size ( ) const
inline

Processor-local size of all elements.

Definition at line 154 of file ensightPart.H.

Referenced by ensightCells::meshPointMap().

Here is the caller graph for this function:

◆ name()

const string& name ( ) const
inline

The part name or description.

Definition at line 160 of file ensightPart.H.

Referenced by ensightOutputSurface::write(), ensightFaces::write(), and ensightCells::write().

Here is the caller graph for this function:

◆ rename() [1/2]

void rename ( const string &  value)
inline

Change the part name or description.

Definition at line 166 of file ensightPart.H.

Referenced by ensightMesh::correct(), ensightCells::ensightCells(), and ensightFaces::ensightFaces().

Here is the caller graph for this function:

◆ rename() [2/2]

void rename ( string &&  value)
inline

Change the part name or description.

Definition at line 172 of file ensightPart.H.

◆ writeDict()

virtual void writeDict ( Ostream &  os,
const bool  full = false 
) const
inlinevirtual

Write information about the object as a dictionary, optionally write all element addresses

Reimplemented in ensightCells, and ensightFaces.

Definition at line 182 of file ensightPart.H.

◆ operator[]()

label operator[] ( const label  i) const
inline

Processor-local element id from linear-list of addresses.

Definition at line 189 of file ensightPart.H.

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