Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
renumberMethod Class Referenceabstract

Abstract base class for renumbering. More...

Inheritance diagram for renumberMethod:
[legend]
Collaboration diagram for renumberMethod:
[legend]

Public Member Functions

 TypeName ("renumberMethod")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, renumberMethod, dictionary,(const dictionary &renumberDict),(renumberDict))
 
 renumberMethod (const dictionary &renumberDict)
 Construct given the renumber dictionary. More...
 
virtual ~renumberMethod ()=default
 Destructor. More...
 
virtual labelList renumber (const pointField &) const
 Return the order in which cells need to be visited, i.e. More...
 
virtual labelList renumber (const polyMesh &, const pointField &) const
 Return the order in which cells need to be visited, i.e. More...
 
virtual labelList renumber (const labelList &cellCells, const labelList &offsets, const pointField &) const
 Return the order in which cells need to be visited, i.e. More...
 
virtual labelList renumber (const polyMesh &mesh, const labelList &cellToRegion, const pointField &regionPoints) const
 Return the order in which cells need to be visited, i.e. More...
 
virtual labelList renumber (const labelListList &cellCells, const pointField &cc) const =0
 Return the order in which cells need to be visited, i.e. More...
 

Static Public Member Functions

static autoPtr< renumberMethod > New (const dictionary &renumberDict)
 Return a reference to the selected renumbering method. More...
 

Protected Attributes

const dictionary & renumberDict_
 

Detailed Description

Abstract base class for renumbering.

Source files

Definition at line 50 of file renumberMethod.H.

Constructor & Destructor Documentation

◆ renumberMethod()

renumberMethod ( const dictionary &  renumberDict)
inline

Construct given the renumber dictionary.

Definition at line 102 of file renumberMethod.H.

◆ ~renumberMethod()

virtual ~renumberMethod ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "renumberMethod"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
renumberMethod  ,
dictionary  ,
(const dictionary &renumberDict)  ,
(renumberDict)   
)

◆ New()

Foam::autoPtr< Foam::renumberMethod > New ( const dictionary &  renumberDict)
static

Return a reference to the selected renumbering method.

Definition at line 46 of file renumberMethod.C.

References dict, Foam::exit(), Foam::FatalIOError, and FatalIOErrorInLookup.

Here is the call graph for this function:

◆ renumber() [1/5]

virtual labelList renumber ( const pointField &  ) const
inlinevirtual

Return the order in which cells need to be visited, i.e.

from ordered back to original cell label. This is only defined for geometric renumberMethods.

Reimplemented in structuredRenumber, springRenumber, SloanRenumber, CuthillMcKeeRenumber, zoltanRenumber, manualRenumber, and randomRenumber.

Definition at line 117 of file renumberMethod.H.

◆ renumber() [2/5]

Foam::labelList renumber ( const polyMesh &  mesh,
const pointField &  points 
) const
virtual

Return the order in which cells need to be visited, i.e.

from ordered back to original cell label. Use the mesh connectivity (if needed)

Reimplemented in structuredRenumber, springRenumber, SloanRenumber, CuthillMcKeeRenumber, zoltanRenumber, manualRenumber, and randomRenumber.

Definition at line 72 of file renumberMethod.C.

References Foam::identity(), mesh, points, and Foam::renumber().

Here is the call graph for this function:

◆ renumber() [3/5]

Foam::labelList renumber ( const labelList &  cellCells,
const labelList &  offsets,
const pointField &  cc 
) const
virtual

Return the order in which cells need to be visited, i.e.

from ordered back to original cell label. Addressing in losort addressing (= neighbour + offsets into neighbour)

Reimplemented in CuthillMcKeeRenumber.

Definition at line 93 of file renumberMethod.C.

References NotImplemented.

◆ renumber() [4/5]

Foam::labelList renumber ( const polyMesh &  mesh,
const labelList &  cellToRegion,
const pointField &  regionPoints 
) const
virtual

Return the order in which cells need to be visited, i.e.

from ordered back to original cell label. Gets passed agglomeration map (from fine to coarse cells) and coarse cell location. Can be overridden by renumberMethods that provide this functionality natively. Coarse cells are local to the processor (if in parallel). If you want to have coarse cells spanning processors use the globalCellCells instead.

Definition at line 105 of file renumberMethod.C.

References forAll, mesh, and Foam::renumber().

Here is the call graph for this function:

◆ renumber() [5/5]

virtual labelList renumber ( const labelListList &  cellCells,
const pointField &  cc 
) const
pure virtual

Return the order in which cells need to be visited, i.e.

from ordered back to original cell label. The connectivity is equal to mesh.cellCells() except

  • the connections are across coupled patches

Implemented in structuredRenumber, springRenumber, CuthillMcKeeRenumber, SloanRenumber, zoltanRenumber, manualRenumber, and randomRenumber.

Member Data Documentation

◆ renumberDict_

const dictionary& renumberDict_
protected

Definition at line 57 of file renumberMethod.H.

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