CuthillMcKeeRenumber Class Reference

Cuthill-McKee renumbering (CM or RCM) More...

Inheritance diagram for CuthillMcKeeRenumber:
Collaboration diagram for CuthillMcKeeRenumber:

Public Member Functions

 TypeNameNoDebug ("CuthillMcKee")
 Runtime type information. More...
 
 CuthillMcKeeRenumber (const bool reverse=false)
 Default construct, optionally with reverse. More...
 
 CuthillMcKeeRenumber (const dictionary &dict)
 Construct given the renumber dictionary. More...
 
 CuthillMcKeeRenumber (const dictionary &dict, const bool reverse)
 Construct given the renumber dictionary (ignored) and specified reverse handling. More...
 
virtual ~CuthillMcKeeRenumber ()=default
 Destructor. More...
 
void reverse (bool on) noexcept
 Toggle reverse on/off. More...
 
virtual labelList renumber (const polyMesh &mesh) const
 Return the cell visit order (from ordered back to original cell id) using the mesh to determine the connectivity. More...
 
virtual labelList renumber (const CompactListList< label > &cellCells) const
 Return the cell visit order (from ordered back to original cell id). More...
 
virtual labelList renumber (const labelListList &cellCells) const
 Return the cell visit order (from ordered back to original cell id). More...
 
- Public Member Functions inherited from renumberMethod
 TypeNameNoDebug ("renumberMethod")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, renumberMethod, dictionary,(const dictionary &renumberDict),(renumberDict))
 
 renumberMethod ()
 Default construct. More...
 
 renumberMethod (const dictionary &)
 Construct with renumber dictionary (which is currently unused) More...
 
virtual ~renumberMethod ()=default
 Destructor. More...
 
virtual bool no_topology () const
 Renumbering method without mesh or cell-cell topology (very special case) More...
 
virtual bool needs_mesh () const
 Renumbering method requires a polyMesh for its topology. More...
 
virtual labelList renumber (const label nCells) const
 Return the cell visit order (from ordered back to original cell id) based solely on the number of cells. More...
 
virtual labelList renumber (const pointField &) const
 Return the cell visit order (from ordered back to original cell id) based solely on the cell centres (or number of cell centres). More...
 
virtual labelList renumber (const polyMesh &mesh, const pointField &) const
 Deprecated - the pointField is unused. More...
 
virtual labelList renumber (const CompactListList< label > &cellCells, const pointField &) const
 Deprecated - the pointField is unused. More...
 
virtual labelList renumber (const labelListList &cellCells, const pointField &) const
 Deprecated - the pointField is unused. More...
 
virtual labelList renumber (const polyMesh &mesh, const labelUList &fineToCoarse, const pointField &coarsePoints) const
 Deprecated - renumbering with agglomeration map. Calculate globalCellCells directly. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from renumberMethod
static autoPtr< renumberMethodNew (const dictionary &dict)
 Construct/select a renumbering method. More...
 
static wordList supportedMethods ()
 Return a list of the known methods. More...
 

Detailed Description

Cuthill-McKee renumbering (CM or RCM)

See also
Foam::meshTools::bandCompression
Source files

Definition at line 48 of file CuthillMcKeeRenumber.H.

Constructor & Destructor Documentation

◆ CuthillMcKeeRenumber() [1/3]

CuthillMcKeeRenumber ( const bool  reverse = false)
explicit

Default construct, optionally with reverse.

Definition at line 60 of file CuthillMcKeeRenumber.C.

◆ CuthillMcKeeRenumber() [2/3]

CuthillMcKeeRenumber ( const dictionary dict)
explicit

Construct given the renumber dictionary.

Definition at line 67 of file CuthillMcKeeRenumber.C.

◆ CuthillMcKeeRenumber() [3/3]

CuthillMcKeeRenumber ( const dictionary dict,
const bool  reverse 
)

Construct given the renumber dictionary (ignored) and specified reverse handling.

Definition at line 79 of file CuthillMcKeeRenumber.C.

◆ ~CuthillMcKeeRenumber()

virtual ~CuthillMcKeeRenumber ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeNameNoDebug()

TypeNameNoDebug ( "CuthillMcKee"  )

Runtime type information.

◆ reverse()

void reverse ( bool  on)
inlinenoexcept

Toggle reverse on/off.

Definition at line 98 of file CuthillMcKeeRenumber.H.

◆ renumber() [1/3]

Foam::labelList renumber ( const polyMesh mesh) const
virtual

Return the cell visit order (from ordered back to original cell id) using the mesh to determine the connectivity.

Parameters
meshMesh connectivity (see globalMeshData::calcCellCells)

Reimplemented from renumberMethod.

Definition at line 107 of file CuthillMcKeeRenumber.C.

References Foam::meshTools::bandCompression(), mesh, and Foam::reverse().

Here is the call graph for this function:

◆ renumber() [2/3]

Foam::labelList renumber ( const CompactListList< label > &  cellCells) const
virtual

Return the cell visit order (from ordered back to original cell id).

Parameters
cellCellsMesh connectivity

Implements renumberMethod.

Definition at line 123 of file CuthillMcKeeRenumber.C.

References Foam::meshTools::bandCompression(), and Foam::reverse().

Here is the call graph for this function:

◆ renumber() [3/3]

Foam::labelList renumber ( const labelListList cellCells) const
virtual

Return the cell visit order (from ordered back to original cell id).

Parameters
cellCellsMesh connectivity

Implements renumberMethod.

Definition at line 139 of file CuthillMcKeeRenumber.C.

References Foam::meshTools::bandCompression(), and Foam::reverse().

Here is the call graph for this function:

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