pointPatch Class Reference

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

#include <pointPatch.H>

Inheritance diagram for pointPatch:

Collaboration diagram for pointPatch:

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

Static Public Member Functions
static autoPtr< pointPatch >	New (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.
Static Public Member Functions inherited from patchIdentifier
static word	defaultName (const label n=-1)
	Default patch name: "patch" or "patchN".

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

Friends
class	pointBoundaryMesh
Ostream &	operator<< (Ostream &, const pointPatch &)

Detailed Description

Basic pointPatch represents a set of points from the mesh.

Source files

• pointPatch.H
• pointPatch.C

Definition at line 64 of file pointPatch.H.

Constructor & Destructor Documentation

pointPatch() [1/4]

pointPatch ( const pointPatch & )

protecteddelete

No copy construct.

References pointPatch().

Referenced by declareRunTimeSelectionTable(), facePointPatch::facePointPatch(), facePointPatch::facePointPatch(), meshPointPatch::meshPointPatch(), meshPointPatch::meshPointPatch(), meshPointPatch::meshPointPatch(), operator<<, operator=(), pointPatch(), and pointPatch().

Here is the call graph for this function:

Here is the caller graph for this function:

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 162 of file pointPatch.H.

References patchIdentifier::index(), patchIdentifier::inGroups(), patchIdentifier::name(), patchIdentifier::patchIdentifier(), patchIdentifier::physicalType(), and pointBoundaryMesh.

Here is the call graph for this function:

pointPatch() [3/4]

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

inlineexplicit

Construct from dictionary.

Definition at line 178 of file pointPatch.H.

References dict, patchIdentifier::index(), patchIdentifier::name(), patchIdentifier::patchIdentifier(), and pointBoundaryMesh.

Here is the call graph for this function:

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 193 of file pointPatch.H.

References patchIdentifier::index(), patchIdentifier::inGroups(), patchIdentifier::name(), patchIdentifier::patchIdentifier(), patchIdentifier::physicalType(), pointBoundaryMesh, pointPatch(), and pp().

Here is the call graph for this function:

~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 coupledFacePointPatch, cyclicACMIPointPatch, cyclicAMIPointPatch, and facePointPatch.

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 cyclicACMIPointPatch, cyclicAMIPointPatch, facePointPatch, and meshPointPatch.

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 cyclicACMIPointPatch, cyclicAMIPointPatch, facePointPatch, and meshPointPatch.

Definition at line 116 of file pointPatch.H.

operator=()

void operator= ( const pointPatch & )

protecteddelete

No copy assignment.

References pointPatch().

Here is the call graph for this function:

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)	)

References dict, patchIdentifier::index(), patchIdentifier::name(), pointBoundaryMesh, and pointPatch().

Here is the call graph for this function:

clone()

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

pure virtual

Construct and return a subset clone, resetting the point list and boundary mesh.

Implemented in cyclicPointPatch, cyclicSlipPointPatch, emptyPointPatch, facePointPatch, genericPointPatch, meshPointPatch, nonuniformTransformCyclicPointPatch, processorCyclicPointPatch, processorPointPatch, symmetryPlanePointPatch, symmetryPointPatch, wallPointPatch, and wedgePointPatch.

References dict, patchIdentifier::index(), patchIdentifier::name(), and pointBoundaryMesh.

Here is the call graph for this function:

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 23 of file pointPatchNew.C.

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

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

Return size.

Implemented in facePointPatch, and meshPointPatch.

Referenced by fvMeshSubset::interpolate(), and pointPatchField< scalar >::size().

Here is the caller graph for this function:

boundaryMesh()

const pointBoundaryMesh & boundaryMesh ( ) const

inline

Return boundaryMesh reference.

Definition at line 250 of file pointPatch.H.

References pointBoundaryMesh.

Referenced by meshPointPatch::localPoints(), cyclicACMIPointPatch::neighbPatch(), cyclicAMIPointPatch::neighbPatch(), and cyclicPointPatch::neighbPatch().

Here is the call graph for this function:

Here is the caller graph for this function:

coupled()

virtual bool coupled ( ) const

inlinevirtual

Return true if this patch field is coupled.

Reimplemented in cyclicACMIPointPatch, cyclicAMIPointPatch, and facePointPatch.

Definition at line 258 of file pointPatch.H.

meshPoints()

virtual const labelList & meshPoints ( ) const

pure virtual

Return mesh points.

Implemented in facePointPatch, and meshPointPatch.

Referenced by fvMeshSubset::interpolate().

Here is the caller graph for this function:

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

Return point unit normals.

Implemented in cyclicSlipPointPatch, facePointPatch, meshPointPatch, and nonuniformTransformCyclicPointPatch.

constraintType()

virtual const word & constraintType ( ) const

inlinevirtual

Return the constraint type this pointPatch implements.

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

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, emptyPointPatch, nonuniformTransformCyclicPointPatch, symmetryPlanePointPatch, symmetryPointPatch, and wedgePointPatch.

Definition at line 289 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 Symbol Documentation

pointBoundaryMesh

friend class pointBoundaryMesh

friend

Definition at line 81 of file pointPatch.H.

References pointBoundaryMesh.

Referenced by boundaryMesh(), facePointPatch::clone(), meshPointPatch::clone(), clone(), facePointPatch::declareRunTimeSelectionTable(), declareRunTimeSelectionTable(), facePointPatch::facePointPatch(), facePointPatch::facePointPatch(), meshPointPatch::meshPointPatch(), meshPointPatch::meshPointPatch(), meshPointPatch::meshPointPatch(), meshPointPatch::meshPointPatch(), facePointPatch::New(), New(), pointBoundaryMesh, pointPatch(), pointPatch(), pointPatch(), and meshPointPatch::TypeName().

operator<<

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

friend

References pointPatch().

---

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

• src/OpenFOAM/meshes/pointMesh/pointPatches/pointPatch/pointPatch.H
• src/OpenFOAM/meshes/pointMesh/pointPatches/pointPatch/pointPatch.C
• src/OpenFOAM/meshes/pointMesh/pointPatches/pointPatch/pointPatchNew.C