CuthillMcKeeRenumber Class Reference

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

#include <CuthillMcKeeRenumber.H>

Inheritance diagram for CuthillMcKeeRenumber:

Collaboration diagram for CuthillMcKeeRenumber:

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

Additional Inherited Members
Static Public Member Functions inherited from renumberMethod
static autoPtr< renumberMethod >	New (const dictionary &dict)
	Construct/select a renumbering method.
static wordList	supportedMethods ()
	Return a list of the known methods.

Detailed Description

Cuthill-McKee renumbering (CM or RCM).

See also

Foam::meshTools::bandCompression

Source files

• CuthillMcKeeRenumber.H
• CuthillMcKeeRenumber.C

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.

References renumberMethod::renumberMethod(), and reverse().

Referenced by reverseCuthillMcKeeRenumber::reverseCuthillMcKeeRenumber(), and reverseCuthillMcKeeRenumber::reverseCuthillMcKeeRenumber().

Here is the call graph for this function:

Here is the caller graph for this function:

CuthillMcKeeRenumber() [2/3]

CuthillMcKeeRenumber ( const dictionary & dict )

explicit

Construct given the renumber dictionary.

Definition at line 67 of file CuthillMcKeeRenumber.C.

References dict, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, and renumberMethod::renumberMethod().

Here is the call graph for this function:

CuthillMcKeeRenumber() [3/3]

CuthillMcKeeRenumber	(	const dictionary &	dict,
		const bool	reverse )

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

Definition at line 78 of file CuthillMcKeeRenumber.C.

References dict, renumberMethod::renumberMethod(), and reverse().

Here is the call graph for this function:

~CuthillMcKeeRenumber()

virtual ~CuthillMcKeeRenumber ( )

virtualdefault

Destructor.

Member Function Documentation

TypeNameNoDebug()

TypeNameNoDebug

(

"CuthillMcKee"

)

Runtime type information.

References dict, and reverse().

Here is the call graph for this function:

reverse()

void reverse ( bool on )

inlinenoexcept

Toggle reverse on/off.

Definition at line 98 of file CuthillMcKeeRenumber.H.

Referenced by CuthillMcKeeRenumber(), CuthillMcKeeRenumber(), and TypeNameNoDebug().

Here is the caller graph for this function:

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

mesh	Mesh connectivity (see globalMeshData::calcCellCells)

Reimplemented from renumberMethod.

Definition at line 106 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

cellCells

Mesh connectivity

Implements renumberMethod.

Definition at line 122 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

cellCells

Mesh connectivity

Implements renumberMethod.

Definition at line 138 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:

• src/renumber/renumberMethods/CuthillMcKeeRenumber/CuthillMcKeeRenumber.H
• src/renumber/renumberMethods/CuthillMcKeeRenumber/CuthillMcKeeRenumber.C