facePointPatch Class Reference

A pointPatch based on a polyPatch. More...

#include <facePointPatch.H>

Inheritance diagram for facePointPatch:

Collaboration diagram for facePointPatch:

Public Member Functions
	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).

Static Public Member Functions
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 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.
	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 Attributes
const polyPatch &	polyPatch_
	Reference to the underlying polyPatch.

Friends
class	processorPointPatch
class	cyclicPointPatch

Detailed Description

A pointPatch based on a polyPatch.

Source files

• facePointPatch.H
• facePointPatch.C
• facePointPatchNew.C

Definition at line 53 of file facePointPatch.H.

Constructor & Destructor Documentation

facePointPatch() [1/3]

facePointPatch ( const facePointPatch & )

protecteddelete

No copy construct.

References facePointPatch().

Referenced by coupledFacePointPatch::coupledFacePointPatch(), coupledFacePointPatch::coupledFacePointPatch(), declareRunTimeSelectionTable(), emptyPointPatch::emptyPointPatch(), emptyPointPatch::emptyPointPatch(), facePointPatch(), facePointPatch(), genericPointPatch::genericPointPatch(), genericPointPatch::genericPointPatch(), mappedPointPatch::mappedPointPatch(), operator=(), symmetryPlanePointPatch::symmetryPlanePointPatch(), symmetryPlanePointPatch::symmetryPlanePointPatch(), symmetryPointPatch::symmetryPointPatch(), symmetryPointPatch::symmetryPointPatch(), wallPointPatch::wallPointPatch(), wallPointPatch::wallPointPatch(), wedgePointPatch::wedgePointPatch(), and wedgePointPatch::wedgePointPatch().

Here is the call graph for this function:

Here is the caller graph for this function:

facePointPatch() [2/3]

facePointPatch	(	const polyPatch &	p,
		const pointBoundaryMesh &	pm )

Construct from polyPatch and boundary mesh.

Definition at line 74 of file facePointPatch.C.

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

Here is the call graph for this function:

facePointPatch() [3/3]

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

Construct given the original patch and a map.

Definition at line 85 of file facePointPatch.C.

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

Here is the call graph for this function:

~facePointPatch()

virtual ~facePointPatch ( )

virtualdefault

Destructor.

Member Function Documentation

initGeometry()

void initGeometry ( PstreamBuffers & )

protectedvirtual

Initialise the calculation of the patch geometry.

Reimplemented from pointPatch.

Reimplemented in cyclicACMIPointPatch, and cyclicAMIPointPatch.

Definition at line 46 of file facePointPatch.C.

Referenced by initUpdateMesh().

Here is the caller graph for this function:

calcGeometry()

void calcGeometry ( PstreamBuffers & )

protectedvirtual

Calculate the patch geometry.

Reimplemented from pointPatch.

Reimplemented in coupledFacePointPatch, cyclicACMIPointPatch, and cyclicAMIPointPatch.

Definition at line 50 of file facePointPatch.C.

initMovePoints()

void initMovePoints ( PstreamBuffers & , const pointField &  )

protectedvirtual

Initialise the patches for moving points.

Reimplemented from pointPatch.

Reimplemented in cyclicACMIPointPatch, and cyclicAMIPointPatch.

Definition at line 54 of file facePointPatch.C.

movePoints()

void movePoints ( PstreamBuffers & , const pointField &  )

protectedvirtual

Correct patches after moving points.

Reimplemented from pointPatch.

Reimplemented in cyclicACMIPointPatch, and cyclicAMIPointPatch.

Definition at line 58 of file facePointPatch.C.

initUpdateMesh()

void initUpdateMesh ( PstreamBuffers & pBufs )

protectedvirtual

Initialise the update of the patch topology.

Reimplemented from pointPatch.

Reimplemented in cyclicACMIPointPatch, and cyclicAMIPointPatch.

Definition at line 62 of file facePointPatch.C.

References initGeometry().

Referenced by cyclicACMIPointPatch::initUpdateMesh(), and cyclicAMIPointPatch::initUpdateMesh().

Here is the call graph for this function:

Here is the caller graph for this function:

updateMesh()

void updateMesh ( PstreamBuffers & )

protectedvirtual

Update of the patch topology.

Reimplemented from pointPatch.

Reimplemented in cyclicACMIPointPatch, and cyclicAMIPointPatch.

Definition at line 68 of file facePointPatch.C.

Referenced by cyclicACMIPointPatch::updateMesh(), and cyclicAMIPointPatch::updateMesh().

Here is the caller graph for this function:

operator=()

void operator= ( const facePointPatch & )

protecteddelete

No copy assignment.

References facePointPatch().

Here is the call graph for this function:

TypeName()

TypeName

(

polyPatch::typeName_()

)

Runtime type information.

declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		facePointPatch	,
		polyPatch	,
		(const polyPatch &patch, const pointBoundaryMesh &bm)	,
		(patch, bm)	)

References facePointPatch(), index(), p, patch(), pointPatch::pointBoundaryMesh, and pp().

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

inlinevirtual

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

Implements pointPatch.

Reimplemented in cyclicPointPatch, cyclicSlipPointPatch, emptyPointPatch, genericPointPatch, nonuniformTransformCyclicPointPatch, processorCyclicPointPatch, processorPointPatch, symmetryPlanePointPatch, symmetryPointPatch, wallPointPatch, and wedgePointPatch.

Definition at line 164 of file facePointPatch.H.

References index(), autoPtr< T >::NewFrom(), and pointPatch::pointBoundaryMesh.

Here is the call graph for this function:

New()

Foam::autoPtr< Foam::facePointPatch > New ( const polyPatch & patch, const pointBoundaryMesh & bm )

static

Return a pointer to a new patch created on freestore from polyPatch.

Definition at line 26 of file facePointPatchNew.C.

References DebugInFunction, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInLookup, patch(), and pointPatch::pointBoundaryMesh.

Referenced by pointBoundaryMesh::pointBoundaryMesh().

Here is the call graph for this function:

Here is the caller graph for this function:

patch()

virtual const polyPatch & patch ( ) const

inlinevirtual

Return the polyPatch.

Definition at line 206 of file facePointPatch.H.

References polyPatch_.

Referenced by coupledFacePointPatch::coupledFacePointPatch(), coupledFacePointPatch::coupledFacePointPatch(), cyclicACMIPointPatch::cyclicACMIPointPatch(), cyclicAMIPointPatch::cyclicAMIPointPatch(), cyclicPointPatch::cyclicPointPatch(), cyclicPointPatch::cyclicPointPatch(), cyclicSlipPointPatch::cyclicSlipPointPatch(), cyclicSlipPointPatch::cyclicSlipPointPatch(), declareRunTimeSelectionTable(), emptyPointPatch::emptyPointPatch(), emptyPointPatch::emptyPointPatch(), facePointPatch(), genericPointPatch::genericPointPatch(), genericPointPatch::genericPointPatch(), mappedPointPatch::mappedPointPatch(), mappedWallPointPatch::mappedWallPointPatch(), New(), nonuniformTransformCyclicPointPatch::nonuniformTransformCyclicPointPatch(), nonuniformTransformCyclicPointPatch::nonuniformTransformCyclicPointPatch(), processorCyclicPointPatch::processorCyclicPointPatch(), processorCyclicPointPatch::processorCyclicPointPatch(), processorPointPatch::processorPointPatch(), processorPointPatch::processorPointPatch(), symmetryPlanePointPatch::symmetryPlanePointPatch(), symmetryPlanePointPatch::symmetryPlanePointPatch(), symmetryPointPatch::symmetryPointPatch(), symmetryPointPatch::symmetryPointPatch(), coupledFacePointPatch::TypeName(), cyclicACMIPointPatch::TypeName(), cyclicAMIPointPatch::TypeName(), cyclicPointPatch::TypeName(), processorCyclicPointPatch::TypeName(), processorPointPatch::TypeName(), symmetryPlanePointPatch::TypeName(), wedgePointPatch::TypeName(), wallPointPatch::wallPointPatch(), wallPointPatch::wallPointPatch(), wedgePointPatch::wedgePointPatch(), and wedgePointPatch::wedgePointPatch().

Here is the caller graph for this function:

name()

virtual const word & name ( ) const

inlinevirtual

Return name.

Definition at line 214 of file facePointPatch.H.

References polyPatch_.

Referenced by facePointPatch(), and facePointPatch().

Here is the caller graph for this function:

size()

virtual label size ( ) const

inlinevirtual

Return size.

Implements pointPatch.

Definition at line 222 of file facePointPatch.H.

References meshPoints(), and UList< T >::size().

Here is the call graph for this function:

index()

virtual label index ( ) const

inlinevirtual

Return the index of this patch in the pointBoundaryMesh.

Definition at line 230 of file facePointPatch.H.

References polyPatch_.

Referenced by cyclicPointPatch::clone(), cyclicSlipPointPatch::clone(), emptyPointPatch::clone(), clone(), genericPointPatch::clone(), nonuniformTransformCyclicPointPatch::clone(), processorCyclicPointPatch::clone(), processorPointPatch::clone(), symmetryPlanePointPatch::clone(), symmetryPointPatch::clone(), wallPointPatch::clone(), wedgePointPatch::clone(), coupledFacePointPatch::coupledFacePointPatch(), cyclicPointPatch::cyclicPointPatch(), cyclicSlipPointPatch::cyclicSlipPointPatch(), declareRunTimeSelectionTable(), emptyPointPatch::emptyPointPatch(), facePointPatch(), facePointPatch(), genericPointPatch::genericPointPatch(), nonuniformTransformCyclicPointPatch::nonuniformTransformCyclicPointPatch(), processorCyclicPointPatch::processorCyclicPointPatch(), processorPointPatch::processorPointPatch(), cyclicACMIPointPatchField< Type >::swapAddSeparated(), cyclicAMIPointPatchField< Type >::swapAddSeparated(), cyclicPointPatchField< Type >::swapAddSeparated(), symmetryPlanePointPatch::symmetryPlanePointPatch(), symmetryPointPatch::symmetryPointPatch(), coupledFacePointPatch::TypeName(), cyclicPointPatch::TypeName(), processorCyclicPointPatch::TypeName(), processorPointPatch::TypeName(), symmetryPlanePointPatch::TypeName(), wedgePointPatch::TypeName(), wallPointPatch::wallPointPatch(), and wedgePointPatch::wedgePointPatch().

Here is the caller graph for this function:

coupled()

virtual bool coupled ( ) const

inlinevirtual

Return true if this patch field is coupled.

Reimplemented from pointPatch.

Reimplemented in cyclicACMIPointPatch, and cyclicAMIPointPatch.

Definition at line 238 of file facePointPatch.H.

References polyPatch_.

meshPoints()

virtual const labelList & meshPoints ( ) const

inlinevirtual

Return mesh points.

Implements pointPatch.

Definition at line 246 of file facePointPatch.H.

References polyPatch_.

Referenced by size().

Here is the caller graph for this function:

localPoints()

virtual const pointField & localPoints ( ) const

inlinevirtual

Return pointField of points in patch.

Implements pointPatch.

Definition at line 254 of file facePointPatch.H.

References polyPatch_.

pointNormals()

virtual const vectorField & pointNormals ( ) const

inlinevirtual

Return point unit normals.

Implements pointPatch.

Reimplemented in cyclicSlipPointPatch, and nonuniformTransformCyclicPointPatch.

Definition at line 262 of file facePointPatch.H.

References polyPatch_.

Referenced by emptyPointPatch::applyConstraint(), and symmetryPointPatch::applyConstraint().

Here is the caller graph for this function:

Friends And Related Symbol Documentation

processorPointPatch

friend class processorPointPatch

friend

Definition at line 115 of file facePointPatch.H.

References processorPointPatch.

Referenced by processorPointPatch.

cyclicPointPatch

friend class cyclicPointPatch

friend

Definition at line 116 of file facePointPatch.H.

References cyclicPointPatch.

Referenced by cyclicPointPatch.

Member Data Documentation

polyPatch_

const polyPatch& polyPatch_

protected

Reference to the underlying polyPatch.

Definition at line 64 of file facePointPatch.H.

Referenced by coupled(), facePointPatch(), facePointPatch(), index(), localPoints(), meshPoints(), name(), patch(), and pointNormals().

---

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

• src/OpenFOAM/meshes/pointMesh/pointPatches/facePointPatch/facePointPatch.H
• src/OpenFOAM/meshes/pointMesh/pointPatches/facePointPatch/facePointPatch.C
• src/OpenFOAM/meshes/pointMesh/pointPatches/facePointPatch/facePointPatchNew.C