Decomposition according to pseudo-random number generator, which is useful for development and stress testing implementations but obviously sub-optimal for normal uses. Can optionally specify the number of consecutive cells to assign to the same processor (agglomeration). More...

#include <randomDecomp.H>

Inheritance diagram for randomDecomp:

[legend]

Collaboration diagram for randomDecomp:

[legend]

Public Member Functions
	randomDecomp (const randomDecomp &)=delete
	No copy construct.
void	operator= (const randomDecomp &)=delete
	No copy assignment.
	TypeNameNoDebug ("random")
	Runtime type information.
	randomDecomp (const label numDomains)
	Construct with number of domains (no coefficients or constraints).
	randomDecomp (const dictionary &decompDict, const word &regionName="", int select=selectionType::DEFAULT)
	Construct for decomposition dictionary and optional region name.
virtual	~randomDecomp ()=default
	Destructor.
virtual bool	parallelAware () const
	Does not care about proc boundaries.
virtual labelList	decompose (const pointField &points, const scalarField &pointWeights_unused=scalarField::null()) const
	Return for every coordinate the wanted processor number.
virtual labelList	decompose (const polyMesh &mesh, const pointField &cc_unused=pointField::null(), const scalarField &cWeights_unused=scalarField::null()) const
	Return for every coordinate the wanted processor number.
virtual labelList	decompose (const CompactListList< label > &globalCellCells, const pointField &cc_unused=pointField::null(), const scalarField &cWeights_unused=scalarField::null()) const
	Return for every coordinate the wanted processor number.
virtual labelList	decompose (const labelListList &globalCellCells, const pointField &cc_unused=pointField::null(), const scalarField &cWeights_unused=scalarField::null()) const
	Return for every coordinate the wanted processor number.
Public Member Functions inherited from decompositionMethod
	decompositionMethod (const decompositionMethod &)=delete
	No copy construct.
void	operator= (const decompositionMethod &)=delete
	No copy assignment.
	TypeName ("decompositionMethod")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, decompositionMethod, dictionary,(const dictionary &decompDict, const word &regionName),(decompDict, regionName))
	decompositionMethod (const dictionary &decompDict, const word &regionName="")
	Construct given the decomposition dictionary, optionally region-specific.
virtual	~decompositionMethod ()=default
	Destructor.
label	nDomains () const noexcept
	Number of domains.
label	nDomains (const label n)
	Set number of domains. Return old value.
virtual bool	geometric () const
	True if the method is purely geometric, often using cell centre points.
virtual labelList	decompose (const polyMesh &mesh, const labelList &cellToRegion, const pointField &regionPoints, const scalarField &regionWeights=scalarField::null()) const
	Return for every coordinate the wanted processor number.
void	setConstraints (const polyMesh &mesh, boolList &blockedFace, PtrList< labelList > &specifiedProcessorFaces, labelList &specifiedProcessor, List< labelPair > &explicitConnections) const
	Helper: extract constraints:
void	applyConstraints (const polyMesh &mesh, const boolList &blockedFace, const PtrList< labelList > &specifiedProcessorFaces, const labelList &specifiedProcessor, const List< labelPair > &explicitConnections, labelList &finalDecomp) const
	Helper: apply constraints to a decomposition.
virtual labelList	decompose (const polyMesh &mesh, const scalarField &cellWeights, const boolList &blockedFace, const PtrList< labelList > &specifiedProcessorFaces, const labelList &specifiedProcessor, const List< labelPair > &explicitConnections) const
labelList	decompose (const polyMesh &mesh, const scalarField &cWeights) const
	Decompose a mesh.

Additional Inherited Members
Static Public Member Functions inherited from decompositionMethod
static label	nDomains (const dictionary &decompDict, const word &regionName="")
	Return region-specific or top-level `numberOfSubdomains` entry.
static const dictionary &	optionalRegionDict (const dictionary &decompDict, const word &regionName)
	Return an optional region-specific dictionary from "regions" sub-dictionary, or dictionary::null on failure.
static autoPtr< decompositionMethod >	New (const dictionary &decompDict, const word &regionName="")
	Return a reference to the selected decomposition method, optionally region-specific.
static void	calcCellCells (const polyMesh &mesh, const labelList &agglom, const label nLocalCoarse, const bool parallel, CompactListList< label > &cellCells)
	Determine (local or global) cellCells from mesh agglomeration.
static void	calcCellCells (const polyMesh &mesh, const labelList &agglom, const label nLocalCoarse, const bool parallel, CompactListList< label > &cellCells, CompactListList< scalar > &cellCellWeights)
	Determine (local or global) cellCells and face weights from mesh agglomeration.
Protected Types inherited from decompositionMethod
enum	selectionType { DEFAULT = 0 , EXACT = 1 , MANDATORY = 2 , NULL_DICT = 4 }
	Selection type when handling the coefficients dictionary. More...
Protected Member Functions inherited from decompositionMethod
FOAM_NO_DANGLING_REFERENCE const dictionary &	findCoeffsDict (const word &coeffsName, int select=selectionType::DEFAULT) const
	Locate coeffsName dictionary or the fallback "coeffs" dictionary.
	decompositionMethod (const label numDomains)
	Construct with specified number of domains, no coefficients or constraints.
Static Protected Member Functions inherited from decompositionMethod
static FOAM_NO_DANGLING_REFERENCE const dictionary &	findCoeffsDict (const dictionary &dict, const word &coeffsName, int select=selectionType::DEFAULT)
	Locate coeffsName dictionary or the fallback "coeffs" dictionary within an enclosing dictionary.
Protected Attributes inherited from decompositionMethod
const dictionary &	decompDict_
	Top-level decomposition dictionary (eg, decomposeParDict).
const dictionary &	decompRegionDict_
	Region-specific decomposition dictionary information.
label	nDomains_
	Number of domains for the decomposition.
PtrList< decompositionConstraint >	constraints_
	Optional constraints.

Detailed Description

Decomposition according to pseudo-random number generator, which is useful for development and stress testing implementations but obviously sub-optimal for normal uses. Can optionally specify the number of consecutive cells to assign to the same processor (agglomeration).

Coefficients:

Property	Description	Required	Default
`agglom`	Number of cells to agglomerate	no	0

Source files

Definition at line 64 of file randomDecomp.H.

Constructor & Destructor Documentation

◆ randomDecomp() [1/3]

randomDecomp ( const randomDecomp & )

delete

No copy construct.

References randomDecomp().

Referenced by operator=(), and randomDecomp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ randomDecomp() [2/3]

randomDecomp ( const label numDomains )

explicit

Construct with number of domains (no coefficients or constraints).

Definition at line 78 of file randomDecomp.C.

References decompositionMethod::decompositionMethod().

Here is the call graph for this function:

◆ randomDecomp() [3/3]

randomDecomp	(	const dictionary &	decompDict,
		const word &	regionName = "",
		int	select = selectionType::DEFAULT )

explicit

Construct for decomposition dictionary and optional region name.

Definition at line 85 of file randomDecomp.C.

References decompositionMethod::decompositionMethod(), decompositionMethod::findCoeffsDict(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, dictionary::readIfPresent(), and regionName.

Here is the call graph for this function:

◆ ~randomDecomp()

virtual ~randomDecomp ( )

virtualdefault

Destructor.

Member Function Documentation

◆ operator=()

void operator= ( const randomDecomp & )

delete

No copy assignment.

References randomDecomp().

Here is the call graph for this function:

◆ TypeNameNoDebug()

TypeNameNoDebug ( "random" )

Runtime type information.

References decompositionMethod::DEFAULT, and regionName.

◆ parallelAware()

virtual bool parallelAware ( ) const

inlinevirtual

Does not care about proc boundaries.

Implements decompositionMethod.

Definition at line 133 of file randomDecomp.H.

◆ decompose() [1/4]

Foam::labelList decompose	(	const pointField &	points,
		const scalarField &	pointWeights_unused = scalarField::null() ) const

virtual

Return for every coordinate the wanted processor number.

Reimplemented from decompositionMethod.

Definition at line 104 of file randomDecomp.C.

References points, and Foam::randomMap().

Here is the call graph for this function:

◆ decompose() [2/4]

Foam::labelList decompose	(	const polyMesh &	mesh,
		const pointField &	cc_unused = pointField::null(),
		const scalarField &	cWeights_unused = scalarField::null() ) const

virtual

Return for every coordinate the wanted processor number.

Implements decompositionMethod.

Definition at line 114 of file randomDecomp.C.

References mesh, and Foam::randomMap().

Here is the call graph for this function:

◆ decompose() [3/4]

Foam::labelList decompose	(	const CompactListList< label > &	globalCellCells,
		const pointField &	cc_unused = pointField::null(),
		const scalarField &	cWeights_unused = scalarField::null() ) const

virtual

Return for every coordinate the wanted processor number.

Explicitly provided connectivity - does not use mesh_.

Implements decompositionMethod.

Definition at line 125 of file randomDecomp.C.

References Foam::randomMap(), and CompactListList< T >::size().

Here is the call graph for this function:

◆ decompose() [4/4]

Foam::labelList decompose	(	const labelListList &	globalCellCells,
		const pointField &	cc_unused = pointField::null(),
		const scalarField &	cWeights_unused = scalarField::null() ) const

virtual

Return for every coordinate the wanted processor number.

Explicitly provided connectivity - does not use mesh_.

Implements decompositionMethod.

Definition at line 136 of file randomDecomp.C.

References Foam::randomMap(), and UList< T >::size().

Here is the call graph for this function:

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

src/parallel/decompose/decompositionMethods/randomDecomp/randomDecomp.H
src/parallel/decompose/decompositionMethods/randomDecomp/randomDecomp.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ randomDecomp() [1/3]

◆ randomDecomp() [2/3]

◆ randomDecomp() [3/3]

◆ ~randomDecomp()

Member Function Documentation

◆ operator=()

◆ TypeNameNoDebug()

◆ parallelAware()

◆ decompose() [1/4]

◆ decompose() [2/4]

◆ decompose() [3/4]

◆ decompose() [4/4]