Loading...
Searching...
No Matches
ensightPart Class Reference

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

#include <ensightPart.H>

Inheritance diagram for ensightPart:
Inheritance graph
[legend]

Public Member Functions

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

Protected Member Functions

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

Detailed Description

Base class for ensightCells, ensightFaces, ensightOutputSurfaces.

Source files

Definition at line 49 of file ensightPart.H.

Constructor & Destructor Documentation

◆ ensightPart() [1/2]

ensightPart ( )

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

Definition at line 54 of file ensightPart.C.

Referenced by ensightCells::ensightCells(), ensightFaces::ensightFaces(), ensightPart(), and ensightCells::~ensightCells().

Here is the caller graph for this function:

◆ ensightPart() [2/2]

ensightPart ( const string & description)
explicit

Default construct, with description/partName.

Definition at line 61 of file ensightPart.C.

References ensightPart().

Here is the call graph for this function:

◆ ~ensightPart()

virtual ~ensightPart ( )
virtualdefault

Destructor.

Member Function Documentation

◆ addressing() [1/2]

const labelList & addressing ( ) const
inlineprotectednoexcept

Element addressing.

Definition at line 85 of file ensightPart.H.

References Foam::noexcept.

Referenced by ensightCells::cellIds(), ensightCells::cellIds(), ensightFaces::classify(), ensightFaces::faceIds(), ensightFaces::faceIds(), ensightCells::sort(), and ensightFaces::sort().

Here is the caller graph for this function:

◆ addressing() [2/2]

labelList & addressing ( )
inlineprotectednoexcept

Element addressing.

Definition at line 93 of file ensightPart.H.

References Foam::noexcept.

◆ clear()

void clear ( )
inlineprotected

Clear element addressing.

Definition at line 101 of file ensightPart.H.

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

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 34 of file ensightPart.C.

Referenced by ensightFaces::classify(), ensightCells::incrCellIds(), and ensightFaces::incrFaceIds().

Here is the caller graph for this function:

◆ decrAddressing()

void decrAddressing ( const label off)
protected

Decrease addressing by specified offset value.

Eg, change global to local id

Definition at line 43 of file ensightPart.C.

Referenced by ensightCells::decrCellIds(), and ensightFaces::decrFaceIds().

Here is the caller graph for this function:

◆ TypeNameNoDebug()

TypeNameNoDebug ( "ensightPart" )

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

◆ index() [1/2]

label index ( ) const
inlinenoexcept

The index in a list (0-based).

Definition at line 153 of file ensightPart.H.

References Foam::noexcept.

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

Here is the caller graph for this function:

◆ index() [2/2]

label & index ( )
inlinenoexcept

The index in a list (0-based).

Definition at line 161 of file ensightPart.H.

References Foam::noexcept.

◆ identifier() [1/2]

label identifier ( ) const
inlinenoexcept

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

Definition at line 169 of file ensightPart.H.

References Foam::noexcept.

Referenced by ensightFaMesh::correct(), and ensightMesh::correct().

Here is the caller graph for this function:

◆ identifier() [2/2]

label & identifier ( )
inlinenoexcept

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

Definition at line 177 of file ensightPart.H.

References Foam::noexcept.

◆ empty()

bool empty ( ) const
inlinenoexcept

Processor-local test for any elements.

Definition at line 185 of file ensightPart.H.

References Foam::noexcept.

◆ size()

label size ( ) const
inlinenoexcept

Processor-local size of all elements.

Definition at line 193 of file ensightPart.H.

References Foam::noexcept.

Referenced by ensightFaces::~ensightFaces().

Here is the caller graph for this function:

◆ name()

const string & name ( ) const
inlinenoexcept

The part name or description.

Definition at line 201 of file ensightPart.H.

References Foam::noexcept.

Referenced by ensightCells::write(), and ensightFaces::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 209 of file ensightPart.H.

Referenced by ensightFaMesh::correct(), 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 217 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 229 of file ensightPart.H.

References os().

Here is the call graph for this function:

◆ operator[]()

label operator[] ( const label i) const
inline

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

Definition at line 238 of file ensightPart.H.

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