coupled patch for post-processing. Used as the base class for processor and cyclic pointPatches More...

#include <coupledFacePointPatch.H>

Inheritance diagram for coupledFacePointPatch:

[legend]

Collaboration diagram for coupledFacePointPatch:

[legend]

Public Member Functions
	TypeName (coupledPolyPatch::typeName_())
	Runtime type information.
	coupledFacePointPatch (const polyPatch &patch, const pointBoundaryMesh &bm)
	Construct from components.
	coupledFacePointPatch (const coupledFacePointPatch &pp, const pointBoundaryMesh &bm, const label index, const labelUList &mapAddressing, const labelUList &reversePointMap)
	Construct given the original patch and a map.
virtual	~coupledFacePointPatch ()=default
	Destructor.
Public Member Functions inherited from facePointPatch
	TypeName (polyPatch::typeName_())
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, facePointPatch, polyPatch,(const polyPatch &patch, const pointBoundaryMesh &bm),(patch, bm))
	facePointPatch (const polyPatch &p, const pointBoundaryMesh &pm)
	Construct from polyPatch and boundary mesh.
	facePointPatch (const facePointPatch &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
	Construct and return a subset clone, resetting the point list and boundary mesh.
virtual	~facePointPatch ()=default
	Destructor.
virtual const polyPatch &	patch () const
	Return the polyPatch.
virtual const word &	name () const
	Return name.
virtual label	size () const
	Return size.
virtual label	index () const
	Return the index of this patch in the pointBoundaryMesh.
virtual bool	coupled () const
	Return true if this patch field is coupled.
virtual const labelList &	meshPoints () const
	Return mesh points.
virtual const pointField &	localPoints () const
	Return pointField of points in patch.
virtual const vectorField &	pointNormals () const
	Return point unit normals.
Public Member Functions inherited from pointPatch
	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	~pointPatch ()=default
	Destructor.
const pointBoundaryMesh &	boundaryMesh () const
	Return boundaryMesh reference.
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).
Public Member Functions inherited from coupledPointPatch
	TypeName (coupledPolyPatch::typeName_())
	Runtime type information.
	coupledPointPatch (const pointBoundaryMesh &bm)
	Construct from components.
virtual	~coupledPointPatch ()=default
	Destructor.

Protected Member Functions
virtual void	calcGeometry (PstreamBuffers &)=0
	Calculate mesh points.
	coupledFacePointPatch (const coupledFacePointPatch &)=delete
	No copy construct.
void	operator= (const coupledFacePointPatch &)=delete
	No copy assignment.
Protected Member Functions inherited from facePointPatch
virtual void	initGeometry (PstreamBuffers &)
	Initialise the calculation of 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.
	facePointPatch (const facePointPatch &)=delete
	No copy construct.
void	operator= (const facePointPatch &)=delete
	No copy assignment.
Protected Member Functions inherited from pointPatch
	pointPatch (const pointPatch &)=delete
	No copy construct.
void	operator= (const pointPatch &)=delete
	No copy assignment.
Protected Member Functions inherited from coupledPointPatch
virtual void	initGeometry (PstreamBuffers &)=0
	Initialise the calculation of the patch geometry.
virtual void	initMovePoints (PstreamBuffers &, const pointField &)=0
	Initialise the patches for moving points.
virtual void	movePoints (PstreamBuffers &, const pointField &)=0
	Correct patches after moving points.
virtual void	initUpdateMesh (PstreamBuffers &)=0
	Initialise the update of the patch topology.
virtual void	updateMesh (PstreamBuffers &)=0
	Update of the patch topology.
	coupledPointPatch (const coupledPointPatch &)=delete
	No copy construct.
void	operator= (const coupledPointPatch &)=delete
	No copy assignment.

Additional Inherited Members
Static Public Member Functions inherited from facePointPatch
static autoPtr< facePointPatch >	New (const polyPatch &, const pointBoundaryMesh &)
	Return a pointer to a new patch created on freestore from polyPatch.
Static Public Member Functions inherited from pointPatch
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 Attributes inherited from facePointPatch
const polyPatch &	polyPatch_
	Reference to the underlying polyPatch.

Detailed Description

coupled patch for post-processing. Used as the base class for processor and cyclic pointPatches

Source files

Definition at line 49 of file coupledFacePointPatch.H.

Constructor & Destructor Documentation

◆ coupledFacePointPatch() [1/3]

coupledFacePointPatch ( const coupledFacePointPatch & )

protecteddelete

No copy construct.

References coupledFacePointPatch().

Referenced by coupledFacePointPatch(), coupledFacePointPatch(), cyclicACMIPointPatch::cyclicACMIPointPatch(), cyclicAMIPointPatch::cyclicAMIPointPatch(), cyclicPointPatch::cyclicPointPatch(), cyclicPointPatch::cyclicPointPatch(), operator=(), processorPointPatch::processorPointPatch(), processorPointPatch::processorPointPatch(), and TypeName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coupledFacePointPatch() [2/3]

coupledFacePointPatch	(	const polyPatch &	patch,
		const pointBoundaryMesh &	bm )

Construct from components.

Definition at line 34 of file coupledFacePointPatch.C.

References coupledPointPatch::coupledPointPatch(), facePointPatch::facePointPatch(), facePointPatch::patch(), and Foam::refCast().

Here is the call graph for this function:

◆ coupledFacePointPatch() [3/3]

coupledFacePointPatch	(	const coupledFacePointPatch &	pp,
		const pointBoundaryMesh &	bm,
		const label	index,
		const labelUList &	mapAddressing,
		const labelUList &	reversePointMap )

Construct given the original patch and a map.

Definition at line 46 of file coupledFacePointPatch.C.

References coupledFacePointPatch(), coupledPointPatch::coupledPointPatch(), facePointPatch::facePointPatch(), facePointPatch::index(), facePointPatch::patch(), and Foam::refCast().

Here is the call graph for this function:

◆ ~coupledFacePointPatch()

virtual ~coupledFacePointPatch ( )

virtualdefault

Destructor.

Member Function Documentation

◆ calcGeometry()

virtual void calcGeometry ( PstreamBuffers & )

protectedpure virtual

Calculate mesh points.

Reimplemented from facePointPatch.

Implemented in cyclicACMIPointPatch, and cyclicAMIPointPatch.

◆ operator=()

void operator= ( const coupledFacePointPatch & )

protecteddelete

No copy assignment.

References coupledFacePointPatch().

Here is the call graph for this function:

◆ TypeName()

TypeName ( coupledPolyPatch::typeName_() )

Runtime type information.

References coupledFacePointPatch(), facePointPatch::index(), facePointPatch::patch(), and pp().

Here is the call graph for this function:

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

src/OpenFOAM/meshes/pointMesh/pointPatches/derived/coupled/coupledFacePointPatch.H
src/OpenFOAM/meshes/pointMesh/pointPatches/derived/coupled/coupledFacePointPatch.C

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ coupledFacePointPatch() [1/3]

◆ coupledFacePointPatch() [2/3]

◆ coupledFacePointPatch() [3/3]

◆ ~coupledFacePointPatch()

Member Function Documentation

◆ calcGeometry()

◆ operator=()

◆ TypeName()