pointPatch Class Referenceabstract

Basic pointPatch represents a set of points from the mesh. More...

Inheritance diagram for pointPatch:
Collaboration diagram for pointPatch:

Public Member Functions

 TypeName ("basePatch")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, pointPatch, dictionary,(const word &name, const dictionary &dict, const label index, const pointBoundaryMesh &bm, const word &patchType),(name, dict, index, bm, patchType))
 
 pointPatch (const word &name, const label index, const pointBoundaryMesh &bm, const word &physicalType, const wordList &inGroups)
 Construct from components. More...
 
 pointPatch (const word &name, const dictionary &dict, const label index, const pointBoundaryMesh &bm)
 Construct from dictionary. More...
 
 pointPatch (const pointPatch &pp, const pointBoundaryMesh &bm, const label index, const labelUList &mapAddressing, const labelUList &reversePointMap)
 Construct given the original patch and a map. More...
 
virtual autoPtr< pointPatchclone (const pointBoundaryMesh &bm, const label index, const labelUList &mapAddressing, const labelUList &reversePointMap) const =0
 Construct and return a subset clone, resetting the point list and boundary mesh. More...
 
virtual ~pointPatch ()=default
 Destructor. More...
 
virtual label size () const =0
 Return size. More...
 
const pointBoundaryMeshboundaryMesh () const
 Return boundaryMesh reference. More...
 
virtual bool coupled () const
 Return true if this patch field is coupled. More...
 
virtual const labelListmeshPoints () const =0
 Return mesh points. More...
 
virtual const vectorFieldlocalPoints () const =0
 Return pointField of points in patch. More...
 
virtual const vectorFieldpointNormals () const =0
 Return point unit normals. More...
 
virtual const wordconstraintType () const
 Return the constraint type this pointPatch implements. More...
 
virtual void applyConstraint (const label pointi, pointConstraint &) const
 Accumulate the effect of constraint direction of this patch. More...
 
virtual void write (Ostream &) const
 Write the pointPatch data as a dictionary. More...
 
- Public Member Functions inherited from patchIdentifier
 patchIdentifier (const patchIdentifier &)=default
 Copy construct. More...
 
 patchIdentifier (patchIdentifier &&)=default
 Move construct. More...
 
patchIdentifieroperator= (const patchIdentifier &)=default
 Copy assignment. More...
 
patchIdentifieroperator= (patchIdentifier &&)=default
 Move assignment. More...
 
virtual ~patchIdentifier ()=default
 Destructor. More...
 
 patchIdentifier ()
 Default construct: name="", index=0. More...
 
 patchIdentifier (const word &name, const label index)
 Construct from mandatory components. More...
 
 patchIdentifier (const word &name, const label index, const word &physicalType, const wordList &inGroups=wordList())
 Construct from components. More...
 
 patchIdentifier (const word &name, const dictionary &dict, const label index)
 Construct from dictionary. More...
 
 patchIdentifier (const patchIdentifier &ident, const label newIndex)
 Copy construct, resetting the index (if non-negative) More...
 
 patchIdentifier (patchIdentifier &&ident, const label newIndex)
 Move construct, resetting the index (if non-negative) More...
 
const wordname () const noexcept
 The patch name. More...
 
wordname () noexcept
 Modifiable patch name. More...
 
label index () const noexcept
 The index of this patch in the boundaryMesh. More...
 
label & index () noexcept
 Modifiable index of this patch in the boundaryMesh. More...
 
const wordphysicalType () const noexcept
 The (optional) physical type of the patch. More...
 
wordphysicalType () noexcept
 Modifiable (optional) physical type of the patch. More...
 
const wordListinGroups () const noexcept
 The (optional) groups that the patch belongs to. More...
 
wordListinGroups () noexcept
 Modifiable (optional) groups that the patch belongs to. More...
 
bool inGroup (const word &name) const
 True if given name is in a group. More...
 
void addGroup (const word &name)
 Add (unique) group for the patch. More...
 
void removeGroup (const word &name)
 Remove group for the patch. More...
 
void write (Ostream &os) const
 Write (physicalType, inGroups) dictionary entries (without surrounding braces) More...
 

Static Public Member Functions

static autoPtr< pointPatchNew (const word &name, const dictionary &dict, const label index, const pointBoundaryMesh &)
 Return a pointer to a new patch created on freestore. Returns null if not found. More...
 
- Static Public Member Functions inherited from patchIdentifier
static word defaultName (const label n=-1)
 Default patch name: "patch" or "patchN". More...
 

Protected Member Functions

virtual void initGeometry (PstreamBuffers &)
 Initialise the calculation of the patch geometry. More...
 
virtual void calcGeometry (PstreamBuffers &)
 Calculate the patch geometry. More...
 
virtual void initMovePoints (PstreamBuffers &, const pointField &)
 Initialise the patches for moving points. More...
 
virtual void movePoints (PstreamBuffers &, const pointField &)
 Correct patches after moving points. More...
 
virtual void initUpdateMesh (PstreamBuffers &)
 Initialise the update of the patch topology. More...
 
virtual void updateMesh (PstreamBuffers &)
 Update of the patch topology. More...
 
 pointPatch (const pointPatch &)=delete
 No copy construct. More...
 
void operator= (const pointPatch &)=delete
 No copy assignment. More...
 

Friends

class pointBoundaryMesh
 
Ostreamoperator<< (Ostream &, const pointPatch &)
 

Detailed Description

Basic pointPatch represents a set of points from the mesh.

Source files

Definition at line 64 of file pointPatch.H.

Constructor & Destructor Documentation

◆ pointPatch() [1/4]

pointPatch ( const pointPatch )
protecteddelete

No copy construct.

◆ pointPatch() [2/4]

pointPatch ( const word name,
const label  index,
const pointBoundaryMesh bm,
const word physicalType,
const wordList inGroups 
)
inlineexplicit

Construct from components.

Definition at line 163 of file pointPatch.H.

◆ pointPatch() [3/4]

pointPatch ( const word name,
const dictionary dict,
const label  index,
const pointBoundaryMesh bm 
)
inlineexplicit

Construct from dictionary.

Definition at line 179 of file pointPatch.H.

◆ pointPatch() [4/4]

pointPatch ( const pointPatch pp,
const pointBoundaryMesh bm,
const label  index,
const labelUList mapAddressing,
const labelUList reversePointMap 
)
inlineexplicit

Construct given the original patch and a map.

Definition at line 194 of file pointPatch.H.

◆ ~pointPatch()

virtual ~pointPatch ( )
virtualdefault

Destructor.

Member Function Documentation

◆ initGeometry()

virtual void initGeometry ( PstreamBuffers )
inlineprotectedvirtual

Initialise the calculation of the patch geometry.

Reimplemented in cyclicACMIPointPatch, cyclicAMIPointPatch, and facePointPatch.

Definition at line 86 of file pointPatch.H.

◆ calcGeometry()

virtual void calcGeometry ( PstreamBuffers )
inlineprotectedvirtual

Calculate the patch geometry.

Reimplemented in cyclicACMIPointPatch, cyclicAMIPointPatch, facePointPatch, and coupledFacePointPatch.

Definition at line 92 of file pointPatch.H.

◆ initMovePoints()

virtual void initMovePoints ( PstreamBuffers ,
const pointField  
)
inlineprotectedvirtual

Initialise the patches for moving points.

Reimplemented in cyclicACMIPointPatch, cyclicAMIPointPatch, and facePointPatch.

Definition at line 98 of file pointPatch.H.

◆ movePoints()

virtual void movePoints ( PstreamBuffers ,
const pointField  
)
inlineprotectedvirtual

Correct patches after moving points.

Reimplemented in meshPointPatch, cyclicACMIPointPatch, cyclicAMIPointPatch, and facePointPatch.

Definition at line 104 of file pointPatch.H.

◆ initUpdateMesh()

virtual void initUpdateMesh ( PstreamBuffers )
inlineprotectedvirtual

Initialise the update of the patch topology.

Reimplemented in cyclicACMIPointPatch, cyclicAMIPointPatch, and facePointPatch.

Definition at line 110 of file pointPatch.H.

◆ updateMesh()

virtual void updateMesh ( PstreamBuffers )
inlineprotectedvirtual

Update of the patch topology.

Reimplemented in meshPointPatch, cyclicACMIPointPatch, cyclicAMIPointPatch, and facePointPatch.

Definition at line 116 of file pointPatch.H.

◆ operator=()

void operator= ( const pointPatch )
protecteddelete

No copy assignment.

◆ TypeName()

TypeName ( "basePatch"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
pointPatch  ,
dictionary  ,
(const word &name, const dictionary &dict, const label index, const pointBoundaryMesh &bm, const word &patchType)  ,
(name, dict, index, bm, patchType)   
)

◆ clone()

virtual autoPtr<pointPatch> clone ( const pointBoundaryMesh bm,
const label  index,
const labelUList mapAddressing,
const labelUList reversePointMap 
) const
pure virtual

◆ New()

Foam::autoPtr< Foam::pointPatch > New ( const word name,
const dictionary dict,
const label  index,
const pointBoundaryMesh bm 
)
static

Return a pointer to a new patch created on freestore. Returns null if not found.

Definition at line 24 of file pointPatchNew.C.

References DebugInFunction, dict, Foam::endl(), and Foam::name().

Referenced by pointBoundaryMesh::pointBoundaryMesh().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ size()

virtual label size ( ) const
pure virtual

◆ boundaryMesh()

◆ coupled()

virtual bool coupled ( ) const
inlinevirtual

Return true if this patch field is coupled.

Reimplemented in facePointPatch, cyclicACMIPointPatch, and cyclicAMIPointPatch.

Definition at line 258 of file pointPatch.H.

◆ meshPoints()

virtual const labelList& meshPoints ( ) const
pure virtual

◆ localPoints()

virtual const vectorField& localPoints ( ) const
pure virtual

Return pointField of points in patch.

Implemented in facePointPatch, and meshPointPatch.

◆ pointNormals()

virtual const vectorField& pointNormals ( ) const
pure virtual

◆ constraintType()

virtual const word& constraintType ( ) const
inlinevirtual

Return the constraint type this pointPatch implements.

Reimplemented in processorPointPatch, cyclicPointPatch, cyclicACMIPointPatch, cyclicAMIPointPatch, symmetryPointPatch, symmetryPlanePointPatch, wedgePointPatch, and emptyPointPatch.

Definition at line 281 of file pointPatch.H.

References word::null.

◆ applyConstraint()

virtual void applyConstraint ( const label  pointi,
pointConstraint  
) const
inlinevirtual

Accumulate the effect of constraint direction of this patch.

Reimplemented in cyclicSlipPointPatch, nonuniformTransformCyclicPointPatch, symmetryPointPatch, symmetryPlanePointPatch, wedgePointPatch, and emptyPointPatch.

Definition at line 290 of file pointPatch.H.

◆ write()

void write ( Ostream os) const
virtual

Write the pointPatch data as a dictionary.

Reimplemented in meshPointPatch.

Definition at line 41 of file pointPatch.C.

References token::END_STATEMENT, Foam::nl, os(), Foam::type(), and patchIdentifier::write().

Referenced by meshPointPatch::write().

Here is the call graph for this function:
Here is the caller graph for this function:

Friends And Related Function Documentation

◆ pointBoundaryMesh

friend class pointBoundaryMesh
friend

Definition at line 81 of file pointPatch.H.

◆ operator<<

Ostream& operator<< ( Ostream ,
const pointPatch  
)
friend

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