Public Member Functions | Static Public Member Functions | Protected 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 &dict)
 Construct given the renumber dictionary. More...
 
virtual ~renumberMethod ()=default
 Destructor. More...
 
virtual labelList renumber (const pointField &) const
 
virtual labelList renumber (const polyMesh &, const pointField &) const
 
virtual labelList renumber (const labelList &cellCells, const labelList &offsets, const pointField &) const
 
virtual labelList renumber (const polyMesh &mesh, const labelList &fineToCoarse, const pointField &coarsePoints) const
 
virtual labelList renumber (const CompactListList< label > &cellCells, const pointField &cellCentres) const
 
virtual labelList renumber (const labelListList &cellCells, const pointField &cellCentres) const =0
 

Static Public Member Functions

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

Protected Member Functions

 renumberMethod (const renumberMethod &)=delete
 No copy construct. More...
 
void operator= (const renumberMethod &)=delete
 No copy assignment. More...
 

Protected Attributes

const dictionary & renumberDict_
 

Detailed Description

Abstract base class for renumbering.

Source files

Definition at line 51 of file renumberMethod.H.

Constructor & Destructor Documentation

◆ renumberMethod() [1/2]

renumberMethod ( const renumberMethod &  )
protecteddelete

No copy construct.

◆ renumberMethod() [2/2]

renumberMethod ( const dictionary &  dict)
inlineexplicit

Construct given the renumber dictionary.

Definition at line 101 of file renumberMethod.H.

◆ ~renumberMethod()

virtual ~renumberMethod ( )
virtualdefault

Destructor.

References NotImplemented.

Member Function Documentation

◆ operator=()

void operator= ( const renumberMethod &  )
protecteddelete

No copy assignment.

◆ 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 42 of file renumberMethod.C.

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

Here is the call graph for this function:

◆ renumber() [1/6]

virtual labelList renumber ( const pointField &  ) const
inlinevirtual

Return the order in which cells need to be visited (ie. from ordered back to original cell label).

This is only defined for geometric renumberMethods.

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

Definition at line 116 of file renumberMethod.H.

Referenced by renumberMethod::renumber().

Here is the caller graph for this function:

◆ renumber() [2/6]

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

Return the order in which cells need to be visited (ie. from ordered back to original cell label).

Use the mesh connectivity (if needed)

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

Definition at line 70 of file renumberMethod.C.

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

Here is the call graph for this function:

◆ renumber() [3/6]

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

Return the order in which cells need to be visited (ie. from ordered back to original cell label).

Addressing in losort addressing (= neighbour + offsets into neighbour)

Reimplemented in CuthillMcKeeRenumber.

Definition at line 100 of file renumberMethod.C.

References NotImplemented, and renumberMethod::renumber().

Here is the call graph for this function:

◆ renumber() [4/6]

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

Return the order in which cells need to be visited (ie. 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 112 of file renumberMethod.C.

References forAll, mesh, Foam::renumber(), renumberMethod::renumber(), and UList< T >::size().

Here is the call graph for this function:

◆ renumber() [5/6]

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

Return the order in which cells need to be visited (ie. from ordered back to original cell label).

Uses 'unpack' internally, so should be overloaded when possible

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

Definition at line 90 of file renumberMethod.C.

References points, Foam::renumber(), renumberMethod::renumber(), and CompactListList< T >::unpack().

Here is the call graph for this function:

◆ renumber() [6/6]

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

Return the order in which cells need to be visited (ie. from ordered back to original cell label).

The connectivity is equal to mesh.cellCells() except

  • the connections are across coupled patches

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

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: