Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
decompositionConstraint Class Referenceabstract

Abstract class for handling decomposition constraints. More...

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

Public Member Functions

 TypeName ("decompositionConstraint")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, decompositionConstraint, dictionary,(const dictionary &dict),(dict))
 
 decompositionConstraint (const dictionary &constraintDict)
 Construct with constraint dictionary. More...
 
 decompositionConstraint (const dictionary &constraintDict, const word &modelType)
 Construct with constraint dictionary and model type. More...
 
virtual ~decompositionConstraint ()=default
 Destructor. More...
 
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. More...
 
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. More...
 

Static Public Member Functions

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

Protected Member Functions

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

Protected Attributes

dictionary coeffDict_
 Constraint coefficients dictionary. More...
 

Detailed Description

Abstract class for handling decomposition constraints.

Source files

Definition at line 58 of file decompositionConstraint.H.

Constructor & Destructor Documentation

◆ decompositionConstraint() [1/3]

decompositionConstraint ( const decompositionConstraint &  )
protecteddelete

No copy construct.

◆ decompositionConstraint() [2/3]

decompositionConstraint ( const dictionary &  constraintDict)
explicit

Construct with constraint dictionary.

Definition at line 133 of file decompositionConstraint.C.

◆ 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 142 of file decompositionConstraint.C.

◆ ~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 45 of file decompositionConstraint.C.

References fld, forAll, Foam::labelMax, mesh, Foam::min(), and List< T >::setSize().

Here is the call graph for this function:

◆ operator=()

void operator= ( const decompositionConstraint &  )
protecteddelete

No copy assignment.

◆ TypeName()

TypeName ( "decompositionConstraint"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

◆ New() [1/2]

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

Return a reference to the selected decompositionConstraint.

Definition at line 155 of file decompositionConstraint.C.

References dict, and Foam::New().

Here is the call 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 169 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, singleProcessorFaceSets, preservePatches, preserveFaceZones, refinementHistory, and preserveBaffles.

◆ 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 singleProcessorFaceSets, preservePatches, preserveFaceZones, refinementHistory, and preserveBaffles.

Definition at line 156 of file decompositionConstraint.H.

Member Data Documentation

◆ coeffDict_

dictionary coeffDict_
protected

Constraint coefficients dictionary.

Definition at line 65 of file decompositionConstraint.H.

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