springRenumber Class Reference

Use spring analogy - attract neighbouring cells according to the distance of their cell indices. More...

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

Public Member Functions

 TypeName ("spring")
 Runtime type information. More...
 
 springRenumber (const dictionary &dict)
 Construct given the renumber dictionary. More...
 
virtual ~springRenumber ()=default
 Destructor. More...
 
virtual labelList renumber (const pointField &) const
 
virtual labelList renumber (const polyMesh &mesh, const pointField &) const
 
virtual labelList renumber (const CompactListList< label > &cellCells, const pointField &cellCentres) const
 
virtual labelList renumber (const labelListList &cellCells, const pointField &cellCentres) const
 
template<class ConnectionListListType >
Foam::labelList renumberImpl (const ConnectionListListType &cellCells) const
 
- Public Member Functions inherited from renumberMethod
 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
 

Additional Inherited Members

- Static Public Member Functions inherited from renumberMethod
static autoPtr< renumberMethodNew (const dictionary &renumberDict)
 Return a reference to the selected renumbering method. More...
 
- Protected Member Functions inherited from renumberMethod
 renumberMethod (const renumberMethod &)=delete
 No copy construct. More...
 
void operator= (const renumberMethod &)=delete
 No copy assignment. More...
 
- Protected Attributes inherited from renumberMethod
const dictionaryrenumberDict_
 

Detailed Description

Use spring analogy - attract neighbouring cells according to the distance of their cell indices.

Maximum jump of cell indices. Is fraction of number of cells maxCo 0.1;

Limit the amount of movement; the fraction maxCo gets decreased with every iteration. freezeFraction 0.9;

Maximum number of iterations maxIter 1000;

Source files

Definition at line 60 of file springRenumber.H.

Constructor & Destructor Documentation

◆ springRenumber()

springRenumber ( const dictionary dict)
explicit

Construct given the renumber dictionary.

Definition at line 50 of file springRenumber.C.

◆ ~springRenumber()

virtual ~springRenumber ( )
virtualdefault

Destructor.

References NotImplemented.

Member Function Documentation

◆ TypeName()

TypeName ( "spring"  )

Runtime type information.

◆ renumber() [1/4]

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 from renumberMethod.

Definition at line 113 of file springRenumber.H.

Referenced by springRenumber::renumber().

Here is the caller graph for this function:

◆ renumber() [2/4]

Foam::labelList renumber ( const polyMesh mesh,
const pointField  
) 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 from renumberMethod.

Definition at line 160 of file springRenumber.C.

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

Here is the call graph for this function:

◆ renumber() [3/4]

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).

Reimplemented from renumberMethod.

Definition at line 180 of file springRenumber.C.

References springRenumber::renumber().

Here is the call graph for this function:

◆ renumber() [4/4]

Foam::labelList renumber ( const labelListList cellCells,
const pointField cellCentres 
) const
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

Implements renumberMethod.

Definition at line 190 of file springRenumber.C.

References springRenumber::renumber().

Here is the call graph for this function:

◆ renumberImpl()

Foam::labelList renumberImpl ( const ConnectionListListType &  cellCells) const

Definition at line 63 of file springRenumber.C.

References Foam::average(), Foam::endl(), forAll, Foam::identity(), Foam::Info, Foam::inplaceReorder(), Foam::invert(), Foam::mag(), Foam::max(), maxCo, Foam::min(), Foam::shuffle(), UList< T >::size(), Foam::sortedOrder(), and Foam::Zero.

Here is the call graph for this function:

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