Public Member Functions | List of all members
springRenumber Class Reference

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

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

Public Member Functions

 TypeName ("spring")
 Runtime type information. More...
 
 springRenumber (const dictionary &renumberDict)
 Construct given the renumber dictionary. More...
 
virtual ~springRenumber ()
 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 &mesh, const pointField &cc) const
 Return the order in which cells need to be visited, i.e. More...
 
virtual labelList renumber (const labelListList &cellCells, const pointField &cc) const
 Return the order in which cells need to be visited, i.e. More...
 
- Public Member Functions inherited from renumberMethod
 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 ()
 Destructor. 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...
 

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 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 57 of file springRenumber.H.

Constructor & Destructor Documentation

◆ springRenumber()

springRenumber ( const dictionary renumberDict)

Construct given the renumber dictionary.

Definition at line 47 of file springRenumber.C.

References springRenumber::renumber().

Here is the call graph for this function:

◆ ~springRenumber()

virtual ~springRenumber ( )
inlinevirtual

Destructor.

Definition at line 91 of file springRenumber.H.

References mesh, NotImplemented, and springRenumber::renumber().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "spring"  )

Runtime type information.

◆ renumber() [1/3]

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

Definition at line 100 of file springRenumber.H.

Referenced by springRenumber::renumber(), springRenumber::springRenumber(), and springRenumber::~springRenumber().

Here is the caller graph for this function:

◆ renumber() [2/3]

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

Definition at line 60 of file springRenumber.C.

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

Here is the call graph for this function:

◆ renumber() [3/3]

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

Implements renumberMethod.

Definition at line 80 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(), List< T >::size(), and Foam::sortedOrder().

Here is the call graph for this function:

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