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:
Inheritance graph
[legend]
Collaboration diagram for renumberMethod:
Collaboration graph
[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...
 
 renumberMethod (const renumberMethod &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~renumberMethod ()
 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...
 
void operator= (const renumberMethod &)=delete
 Disallow default bitwise assignment. 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 48 of file renumberMethod.H.

Constructor & Destructor Documentation

◆ renumberMethod() [1/2]

renumberMethod ( const dictionary &  renumberDict)
inline

Construct given the renumber dictionary.

Definition at line 81 of file renumberMethod.H.

References renumberMethod::New().

Here is the call graph for this function:

◆ renumberMethod() [2/2]

renumberMethod ( const renumberMethod &  )
delete

Disallow default bitwise copy construction.

◆ ~renumberMethod()

virtual ~renumberMethod ( )
inlinevirtual

Destructor.

Definition at line 100 of file renumberMethod.H.

References mesh, NotImplemented, renumberMethod::operator=(), and renumberMethod::renumber().

Here is the call graph for this function:

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

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, Foam::libs, dictionary::lookup(), Foam::nl, dlLibraryTable::open(), and renumberMethod::renumber().

Referenced by renumberMethod::renumberMethod().

Here is the call graph for this function:
Here is the caller 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, zoltanRenumber, SloanRenumber, CuthillMcKeeRenumber, manualRenumber, and randomRenumber.

Definition at line 109 of file renumberMethod.H.

Referenced by renumberMethod::New(), renumberMethod::renumber(), and renumberMethod::~renumberMethod().

Here is the caller graph for this function:

◆ 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, zoltanRenumber, SloanRenumber, CuthillMcKeeRenumber, manualRenumber, and randomRenumber.

Definition at line 77 of file renumberMethod.C.

References decompositionMethod::calcCellCells(), Foam::identity(), UCompactListList< T >::list(), primitiveMesh::nCells(), points, Foam::renumber(), and renumberMethod::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 98 of file renumberMethod.C.

References NotImplemented, and renumberMethod::renumber().

Here is the call graph for this function:

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

References decompositionMethod::calcCellCells(), forAll, UCompactListList< T >::list(), Foam::renumber(), and List< T >::size().

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, zoltanRenumber, SloanRenumber, manualRenumber, and randomRenumber.

◆ operator=()

void operator= ( const renumberMethod &  )
delete

Disallow default bitwise assignment.

Referenced by renumberMethod::~renumberMethod().

Here is the caller graph for this function:

Member Data Documentation

◆ renumberDict_

const dictionary& renumberDict_
protected

Definition at line 55 of file renumberMethod.H.

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