Abstract class for handling decomposition constraints. More...

#include <decompositionConstraint.H>

Inheritance diagram for decompositionConstraint:

[legend]

Collaboration diagram for decompositionConstraint:

[legend]

Public Member Functions
	TypeName ("decompositionConstraint")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, decompositionConstraint, dictionary,(const dictionary &dict),(dict))
	decompositionConstraint (const dictionary &constraintDict)
	Construct with constraint dictionary.
	decompositionConstraint (const dictionary &constraintDict, const word &modelType)
	Construct with constraint dictionary and model type.
virtual	~decompositionConstraint ()=default
	Destructor.
virtual void	add (const polyMesh &mesh, boolList &blockedFace, PtrList< labelList > &specifiedProcessorFaces, labelList &specifiedProcessor, List< labelPair > &explicitConnections) const =0
	Add this constraint to list of constraints.
virtual void	apply (const polyMesh &mesh, const boolList &blockedFace, const PtrList< labelList > &specifiedProcessorFaces, const labelList &specifiedProcessor, const List< labelPair > &explicitConnections, labelList &decomposition) const
	Apply any additional post-decomposition constraints.

Static Public Member Functions
static autoPtr< decompositionConstraint >	New (const dictionary &constraintDict)
	Return a reference to the selected decompositionConstraint.
static autoPtr< decompositionConstraint >	New (const dictionary &constraintDict, const word &modelType)
	Return a reference to the selected decompositionConstraint.

Protected Member Functions
void	getMinBoundaryValue (const polyMesh &mesh, const labelList &decomposition, labelList &destProc) const
	Get minimum label across coupled boundary faces.
	decompositionConstraint (const decompositionConstraint &)=delete
	No copy construct.
void	operator= (const decompositionConstraint &)=delete
	No copy assignment.

Protected Attributes
dictionary	coeffDict_
	Constraint coefficients dictionary.

Detailed Description

Abstract class for handling decomposition constraints.

Source files

Definition at line 54 of file decompositionConstraint.H.

Constructor & Destructor Documentation

◆ decompositionConstraint() [1/3]

decompositionConstraint ( const decompositionConstraint & )

protecteddelete

No copy construct.

References decompositionConstraint().

Referenced by declareRunTimeSelectionTable(), decompositionConstraint(), geometric::geometric(), geometric::geometric(), operator=(), preserveBaffles::preserveBaffles(), preserveBaffles::preserveBaffles(), preserveFaceZones::preserveFaceZones(), preserveFaceZones::preserveFaceZones(), preservePatches::preservePatches(), preservePatches::preservePatches(), refinementHistory::refinementHistory(), refinementHistory::refinementHistory(), singleProcessorFaceSets::singleProcessorFaceSets(), singleProcessorFaceSets::singleProcessorFaceSets(), and singleProcessorFaceSets::singleProcessorFaceSets().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ decompositionConstraint() [2/3]

decompositionConstraint ( const dictionary & constraintDict )

explicit

Construct with constraint dictionary.

Definition at line 125 of file decompositionConstraint.C.

References coeffDict_.

◆ decompositionConstraint() [3/3]

decompositionConstraint	(	const dictionary &	constraintDict,
		const word &	modelType )

Construct with constraint dictionary and model type.

The model type could be used for defining a coefficients sub-dictionary.

Definition at line 134 of file decompositionConstraint.C.

References coeffDict_.

◆ ~decompositionConstraint()

virtual ~decompositionConstraint ( )

virtualdefault

Destructor.

Member Function Documentation

◆ getMinBoundaryValue()

void getMinBoundaryValue	(	const polyMesh &	mesh,
		const labelList &	decomposition,
		labelList &	destProc ) const

protected

Get minimum label across coupled boundary faces.

Definition at line 37 of file decompositionConstraint.C.

References fld(), forAll, Foam::isA(), Foam::labelMax, mesh, Foam::min(), pbm, pp(), List< T >::setSize(), and syncTools::syncBoundaryFaceList().

Referenced by preserveFaceZones::apply(), and preservePatches::apply().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

void operator= ( const decompositionConstraint & )

protecteddelete

No copy assignment.

References decompositionConstraint().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "decompositionConstraint" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		decompositionConstraint	,
		dictionary	,
		(const dictionary &dict)	,
		(dict)	)

References decompositionConstraint(), and dict.

Here is the call graph for this function:

◆ New() [1/2]

Foam::autoPtr< Foam::decompositionConstraint > New ( const dictionary & constraintDict )

static

Return a reference to the selected decompositionConstraint.

Definition at line 147 of file decompositionConstraint.C.

References dict, and New().

Referenced by New().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ New() [2/2]

Foam::autoPtr< Foam::decompositionConstraint > New	(	const dictionary &	constraintDict,
		const word &	modelType )

static

Return a reference to the selected decompositionConstraint.

Definition at line 161 of file decompositionConstraint.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, and Foam::Info.

Here is the call graph for this function:

◆ add()

virtual void add	(	const polyMesh &	mesh,
		boolList &	blockedFace,
		PtrList< labelList > &	specifiedProcessorFaces,
		labelList &	specifiedProcessor,
		List< labelPair > &	explicitConnections ) const

pure virtual

Add this constraint to list of constraints.

Implemented in geometric, preserveBaffles, preserveFaceZones, preservePatches, refinementHistory, and singleProcessorFaceSets.

References mesh.

◆ apply()

virtual void apply	(	const polyMesh &	mesh,
		const boolList &	blockedFace,
		const PtrList< labelList > &	specifiedProcessorFaces,
		const labelList &	specifiedProcessor,
		const List< labelPair > &	explicitConnections,
		labelList &	decomposition ) const

inlinevirtual

Apply any additional post-decomposition constraints.

Usually no need to do anything since decomposition method should have already obeyed the constraints

Reimplemented in preserveBaffles, preserveFaceZones, preservePatches, refinementHistory, and singleProcessorFaceSets.

Definition at line 177 of file decompositionConstraint.H.

References mesh.

Member Data Documentation

◆ coeffDict_

dictionary coeffDict_

protected

Constraint coefficients dictionary.

Definition at line 63 of file decompositionConstraint.H.

Referenced by preserveBaffles::add(), decompositionConstraint(), decompositionConstraint(), geometric::geometric(), preserveFaceZones::preserveFaceZones(), preservePatches::preservePatches(), and singleProcessorFaceSets::singleProcessorFaceSets().

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

src/parallel/decompose/decompositionMethods/decompositionConstraints/decompositionConstraint/decompositionConstraint.H
src/parallel/decompose/decompositionMethods/decompositionConstraints/decompositionConstraint/decompositionConstraint.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ decompositionConstraint() [1/3]

◆ decompositionConstraint() [2/3]

◆ decompositionConstraint() [3/3]

◆ ~decompositionConstraint()

Member Function Documentation

◆ getMinBoundaryValue()

◆ operator=()

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New() [1/2]

◆ New() [2/2]

◆ add()

◆ apply()

Member Data Documentation

◆ coeffDict_