polyPatch Class Reference

A patch is a list of labels that address the faces in the global face list. More...

#include <polyPatch.H>

Inheritance diagram for polyPatch:

Collaboration diagram for polyPatch:

Public Member Functions
	TypeName ("patch")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, polyPatch, word,(const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType),(name, size, start, index, bm, patchType))
	declareRunTimeSelectionTable (autoPtr, polyPatch, dictionary,(const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm, const word &patchType),(name, dict, index, bm, patchType))
	polyPatch (const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType)
	Construct from components.
	polyPatch (const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &physicalType, const wordList &inGroups)
	Construct from components.
	polyPatch (const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm, const word &patchType)
	Construct from dictionary.
	polyPatch (const polyPatch &, const polyBoundaryMesh &)
	Copy construct, resetting the boundary mesh.
	polyPatch (const polyPatch &pp, const polyBoundaryMesh &bm, const label index, const label newSize, const label newStart)
	Construct given the original patch and resetting the face list and boundary mesh information.
	polyPatch (const polyPatch &pp, const polyBoundaryMesh &bm, const label index, const labelUList &mapAddressing, const label newStart)
	Construct given the original patch and a map.
	polyPatch (const polyPatch &p)
	Copy construct.
	polyPatch (const polyPatch &p, const labelList &faceCells)
	Copy construct, setting faceCells.
virtual autoPtr< polyPatch >	clone (const labelList &faceCells) const
	Construct and return a clone, setting faceCells.
virtual autoPtr< polyPatch >	clone (const polyBoundaryMesh &bm) const
	Construct and return a clone, resetting the boundary mesh.
virtual autoPtr< polyPatch >	clone (const polyBoundaryMesh &bm, const label index, const label newSize, const label newStart) const
	Construct and return a clone, resetting the face list and boundary mesh.
virtual autoPtr< polyPatch >	clone (const polyBoundaryMesh &bm, const label index, const labelUList &mapAddressing, const label newStart) const
	Construct and return a clone, resetting the face list and boundary mesh.
virtual	~polyPatch ()
	Destructor.
virtual void	newInternalProcFaces (label &, label &) const
	Return number of new internal of this polyPatch faces.
virtual const labelUList &	nbrCells () const
	Return nbrCells.
virtual label	neighbPolyPatchID () const
	Return nbr patchID.
virtual refPtr< labelListList >	mapCollocatedFaces () const
	Return mapped collocated faces.
virtual bool	masterImplicit () const
	Return implicit master.
virtual word	neighbRegionID () const
	Return neighbour region name.
label	offset () const noexcept
	The offset where this patch starts in the boundary face list.
label	start () const noexcept
	Return start label of this patch in the polyMesh face list.
labelRange	range () const
	Return start/size range of this patch.
const polyBoundaryMesh &	boundaryMesh () const noexcept
	Return boundaryMesh reference.
virtual bool	coupled () const
	Return true if this patch is geometrically coupled (i.e. faces and.
template<class T>
const UIndirectList< T >	patchInternalList (const UList< T > &internalValues) const
	Extract face cell data.
template<class T>
const List< T >::subList	patchSlice (const UList< T > &values) const
	This patch slice from the complete list, which has size mesh::nFaces(), using the number of patch faces.
template<class T>
const Field< T >::subField	patchSlice (const Field< T > &values) const
	Slice Field to patch, using the number of patch faces.
template<class T>
const List< T >::subList	boundarySlice (const UList< T > &values) const
	This patch slice from the list of boundary values, which has size mesh::nBoundaryFaces(), using the number of patch faces.
virtual void	write (Ostream &os) const
	Write the polyPatch data as a dictionary.
const faceList::subList	faces () const
	Return mesh faces for the patch.
const labelList::subList	faceOwner () const
	Return face owner for the patch.
const vectorField::subField	faceCentres () const
	Return face centres.
const vectorField::subField	faceAreas () const
	Return face normals.
tmp< vectorField >	faceCellCentres () const
	Return face cell centres.
tmp< scalarField >	areaFraction (const pointField &points) const
	Calculate the area fraction as the ratio of the stored face area and the area given by the face points.
tmp< scalarField >	areaFraction () const
	Return the cached area fraction. Usually only set for the non-overlap patches on ACMI.
void	areaFraction (const scalar fraction)
	Set uniform cached area fraction.
void	areaFraction (const tmp< scalarField > &fraction)
	Set cached area fraction (non-uniform).
const labelUList &	faceCells () const
	Return face-cell addressing.
const labelList &	meshEdges () const
	Return global edge index for local edges.
virtual void	clearAddressing ()
	Clear addressing.
label	whichFace (const label facei) const noexcept
	Return label of face in patch from global face label.
virtual void	initOrder (PstreamBuffers &, const primitivePatch &) const
	Initialize ordering for primitivePatch. Does not.
virtual bool	order (PstreamBuffers &, const primitivePatch &, labelList &faceMap, labelList &rotation) const
	Return new ordering for primitivePatch.
virtual bool	changeTopology () const
	For dynamic mesh cases - return true if this patch will change the topology.
virtual bool	setTopology (polyTopoChange &)
	Collect topology changes in a polyTopoChange object.
void	operator= (const polyPatch &p)
	Copy assignment.
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 PrimitivePatch< SubList< face >, const pointField & >
	PrimitivePatch (const SubList< face > &faces, const const pointField &&points)
	Construct from components.
	PrimitivePatch (SubList< face > &&faces, const const pointField &&points)
	Construct from components, transferring faces.
	PrimitivePatch (SubList< face > &faces, const pointField &&points, const bool reuse)
	Construct from components, reuse storage.
	PrimitivePatch (const PrimitivePatch< SubList< face >, const pointField & > &pp)
	Copy construct.
virtual	~PrimitivePatch ()
	Destructor.
void	clearOut ()
void	clearGeom ()
void	clearTopology ()
void	clearPatchMeshAddr ()
void	swap (PrimitivePatch &)=delete
	Suppress direct swapping, since storage containers may be const.
const Field< point_type > &	points () const noexcept
	Return reference to global points.
label	nFaces () const noexcept
	Number of faces in the patch.
label	nPoints () const
	Number of points supporting patch faces.
label	nEdges () const
	Number of edges in patch.
const edgeList &	edges () const
	Return list of edges, address into LOCAL point list.
const edgeList::subList	internalEdges () const
	Return sub-list of internal edges, address into LOCAL point list.
const edgeList::subList	boundaryEdges () const
	Return sub-list of boundary edges, address into LOCAL point list.
label	nInternalEdges () const
	Number of internal edges.
label	nBoundaryEdges () const
	Number of boundary edges == (nEdges() - nInternalEdges()).
bool	isInternalEdge (const label edgei) const
	Is internal edge?
const labelList &	boundaryPoints () const
	Return list of boundary points, address into LOCAL point list.
const labelListList &	faceFaces () const
	Return face-face addressing.
const labelListList &	edgeFaces () const
	Return edge-face addressing.
const labelListList &	faceEdges () const
	Return face-edge addressing.
const labelListList &	pointEdges () const
	Return point-edge addressing.
const labelListList &	pointFaces () const
	Return point-face addressing.
const List< face_type > &	localFaces () const
	Return patch faces addressing into local point list.
labelList	boundaryFaces () const
	Extract list of local faces corresponding to the boundary edges.
labelList	uniqBoundaryFaces () const
	Extract sorted list of unique local faces associated with the boundary edges.
const labelList &	meshPoints () const
	Return labelList of mesh points in patch.
const Map< label > &	meshPointMap () const
	Mesh point map.
const Field< point_type > &	localPoints () const
	Return pointField of points in patch.
const labelList &	localPointOrder () const
	Return orders the local points for most efficient search.
label	whichPoint (const label gp) const
	Given a global point index, return the local point index.
edge	meshEdge (const label edgei) const
	From patch edge to global edge using meshPoints.
edge	meshEdge (const edge &e) const
	From patch edge to global edge using meshPoints.
label	findEdge (const edge &e) const
	Search for edge (local point labels) and return its index in the edge list or -1 if not found.
labelList	meshEdges (const edgeList &allEdges, const labelListList &cellEdges, const labelList &faceCells) const
	Return labels of patch edges in the global edge list using cell addressing.
labelList	meshEdges (const edgeList &allEdges, const labelListList &pointEdges) const
	Return labels of patch edges into the global edge list using basic edge addressing.
label	meshEdge (const label edgei, const edgeList &allEdges, const labelListList &pointEdges) const
	Return label of the local patch edge into the global edge list using basic edge addressing.
labelList	meshEdges (const labelUList &edgeLabels, const edgeList &allEdges, const labelListList &pointEdges) const
	Return labels of specified patch edges into the global edge list using basic edge addressing.
const Field< point_type > &	faceCentres () const
	Return face centres for patch.
const Field< point_type > &	faceAreas () const
	Return face area vectors for patch.
const Field< scalar > &	magFaceAreas () const
	Return face area magnitudes for patch.
const Field< point_type > &	faceNormals () const
	Return face unit normals for patch.
const Field< point_type > &	pointNormals () const
	Return point normals for patch.
Pair< point_type >	box () const
	The enclosing (bounding) box for the patch points.
scalar	sphere (const label facei) const
	The enclosing (bounding) sphere radius^2 for specified face.
bool	hasFaceAreas () const
bool	hasFaceCentres () const
bool	hasFaceNormals () const
bool	hasPointNormals () const
bool	hasBoundaryPoints () const
bool	hasEdges () const
bool	hasFaceFaces () const
bool	hasEdgeFaces () const
bool	hasFaceEdges () const
bool	hasPointEdges () const
bool	hasPointFaces () const
bool	hasMeshPoints () const
bool	hasMeshPointMap () const
List< objectHit >	projectPoints (const ToPatch &targetPatch, const Field< point_type > &projectionDirection, const intersection::algorithm=intersection::FULL_RAY, const intersection::direction=intersection::VECTOR) const
	Project vertices of patch onto another patch.
List< objectHit >	projectFaceCentres (const ToPatch &targetPatch, const Field< point_type > &projectionDirection, const intersection::algorithm=intersection::FULL_RAY, const intersection::direction=intersection::VECTOR) const
	Project vertices of patch onto another patch.
const labelListList &	edgeLoops () const
	Return list of closed loops of boundary vertices.
surfaceTopo	surfaceType (labelHashSet *badEdgesPtr=nullptr) const
	Calculate surface type formed by patch, optionally recording the indices of illegal edges.
bool	checkTopology (const bool report=false, labelHashSet *pointSetPtr=nullptr) const
	Check surface formed by patch for manifoldness (see above).
bool	checkPointManifold (const bool report=false, labelHashSet *pointSetPtr=nullptr) const
	Checks primitivePatch for faces sharing point but not edge.
void	operator= (const PrimitivePatch< SubList< face >, const pointField & > &rhs)
	Copy assign faces. Leave points alone (could be a reference).
void	operator= (PrimitivePatch< SubList< face >, const pointField & > &&rhs)
	Move assign faces. Leave points alone (could be a reference).
label	whichEdge (const edge &e) const
	Identical to findEdge.
Foam::List< Foam::objectHit >	projectPoints (const ToPatch &targetPatch, const Field< typename Foam::PrimitivePatch< SubList< face >, const pointField & >::point_type > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const
Foam::List< Foam::objectHit >	projectFaceCentres (const ToPatch &targetPatch, const Field< typename Foam::PrimitivePatch< SubList< face >, const pointField & >::point_type > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const
Public Member Functions inherited from PrimitivePatchBase
	ClassName ("PrimitivePatch")
	Runtime type information.
	PrimitivePatchBase ()=default
	Default construct.
Public Member Functions inherited from SubList< face >
	SubList () noexcept=default
	Default construct, zero-sized and nullptr.
	SubList (const SubList< face > &) noexcept=default
	Copy construct, shallow copy.
	SubList (const UList< face > &list) noexcept
	Construct from UList, the entire size.
	SubList (const FixedList< face, N > &list) noexcept
	Construct from FixedList, the entire size.
	SubList (const UList< face > &list, const label len)
	Construct from UList and sub-list size, start at 0.
	SubList (const UList< face > &list, const label len, const label start)
	Construct from UList, sub-list size and start index.
	SubList (const UList< face > &list, const labelRange &range)
	Construct from UList and a (start,size) range.
	SubList (const labelRange &range, const UList< face > &list)
	Construct from UList and a (start,size) range, but bypassing run-time range checking.
UList< face > &	reset (std::nullptr_t) noexcept
	Reset to zero-sized and nullptr.
UList< face > &	reset (const UList< face > &list) noexcept
	Reset to use entire UList.
UList< face > &	reset (const UList< face > &list, const label len)
	Reset to use UList with sub-list size, start at 0.
UList< face > &	reset (const UList< face > &list, const label len, const label start)
	Reset to use UList with sub-list size and start index.
UList< face > &	reset (const UList< face > &list, const labelRange &range)
	Reset to use UList with a (start,size) range.
UList< face > &	reset (const labelRange &range, const UList< face > &list)
	Reset to use UList with a (start,size) range, but bypassing run-time range checking.
	operator const Foam::List< face > & () const
	Allow cast to a const List<T>&.
void	operator= (const SubList< face > &list)
	Copy assign entries (deep copy) from given sub-list. Sizes must match!
void	operator= (const UList< face > &list)
	Copy assign entries (deep copy) from given list. Sizes must match!
void	operator= (const IndirectListBase< face, Addr > &list)
	Copy assign entries from given indirect list. Sizes must match!
void	operator= (const face &val)
	Assign all entries to the given value.
void	operator= (Foam::zero)
	Assign all entries to zero.
	operator const Foam::List< face > & () const
	Allow cast to a const List<T>&.
Public Member Functions inherited from UList< face >
	UList (const UList< face > &) noexcept=default
	Copy construct, shallow copy.
	UList (UList< face > &&) noexcept=default
	Move construct, shallow copy.
UList< face > &	operator= (const UList< face > &)=delete
	No copy assignment (default: shallow copy).
UList< face > &	operator= (UList< face > &&) noexcept=default
	Move assignment, shallow copy.
constexpr	UList () noexcept
	Default construct, zero-sized and nullptr.
	UList (face *__restrict__ ptr, const label len) noexcept
	Construct from components.
	UList (SubList< face > &&) noexcept
	Move construct from a SubList, shallow copy.
label	fcIndex (const label i) const noexcept
	The forward circular index. The next index in the list which returns to the first at the end of the list.
label	rcIndex (const label i) const noexcept
	The reverse circular index. The previous index in the list which returns to the last at the beginning of the list.
const face &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list).
face &	fcValue (const label i)
	Return forward circular value (ie, next value in the list).
const face &	rcValue (const label i) const
	Return reverse circular value (ie, previous value in the list).
face &	rcValue (const label i)
	Return reverse circular value (ie, previous value in the list).
const face *	cdata () const noexcept
	Return pointer to the underlying array serving as data storage.
face *	data () noexcept
	Return pointer to the underlying array serving as data storage.
const char *	cdata_bytes () const noexcept
	Return pointer to the underlying array serving as data storage,.
char *	data_bytes () noexcept
	Return pointer to the underlying array serving as data storage,.
face &	front ()
	Access first element of the list, position [0].
const face &	front () const
	Access first element of the list.
face &	back ()
	Access last element of the list, position [size()-1].
const face &	back () const
	Access last element of the list, position [size()-1].
std::streamsize	size_bytes () const noexcept
	Number of contiguous bytes for the List data.
std::streamsize	byteSize () const
	Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous.
void	checkStart (const label start) const
	Check start is within valid range [0,size).
void	checkSize (const label size) const
	Check size is within valid range [0,size].
void	checkRange (const label start, const label len) const
	Check that start and length define a valid range.
void	checkIndex (const label i) const
	Check index is within valid range [0,size).
bool	uniform () const
	True if all entries have identical values, and list is non-empty.
bool	contains (const face &val) const
	True if the value is contained in the list.
bool	contains (const face &val, label pos, label len=-1) const
	Is the value contained in the list?
label	find (const face &val) const
	Find index of the first occurrence of the value.
label	find (const face &val, label pos, label len=-1) const
	Find index of the first occurrence of the value.
label	rfind (const face &val, label pos=-1) const
	Find index of the last occurrence of the value.
void	moveFirst (const label i)
	Move element to the first position.
void	moveLast (const label i)
	Move element to the last position.
void	swapFirst (const label i)
	Swap element with the first element. Fatal on an empty list.
void	swapLast (const label i)
	Swap element with the last element. Fatal on an empty list.
void	shallowCopy (face *__restrict__ ptr, const label len) noexcept
	Copy the pointer and size.
void	shallowCopy (std::nullptr_t) noexcept
	Copy nullptr and zero size.
void	shallowCopy (const UList< face > &list) noexcept
	Copy the pointer and size held by the given UList.
void	deepCopy (const UList< face > &list)
	Copy elements of the given UList. Sizes must match!
void	deepCopy (const IndirectListBase< face, Addr > &list)
	Copy elements of the given indirect list. Sizes must match!
SubList< face >	slice (const label pos, label len=-1)
	Return SubList slice (non-const access) - no range checking.
const SubList< face >	slice (const label pos, label len=-1) const
	Return SubList slice (const access) - no range checking.
SubList< face >	slice (const labelRange &range)
	Return SubList slice (non-const access) - with range checking.
const SubList< face >	slice (const labelRange &range) const
	Return SubList slice (const access) - with range checking.
face &	operator[] (const label i)
	Return element of UList.
const face &	operator[] (const label i) const
	Return element of constant UList.
	operator const Foam::List< face > & () const
	Allow cast to a const List<T>&.
void	operator= (const face &val)
	Assignment of all entries to the given value.
void	operator= (Foam::zero)
	Assignment of all entries to zero.
iterator	begin () noexcept
	Return an iterator to begin traversing the UList.
iterator	end () noexcept
	Return an iterator to end traversing the UList.
iterator	begin (const label i) noexcept
	Return iterator at offset i from begin, clamped to [0,size] range.
const_iterator	cbegin () const noexcept
	Return const_iterator to begin traversing the constant UList.
const_iterator	cend () const noexcept
	Return const_iterator to end traversing the constant UList.
const_iterator	begin () const noexcept
	Return const_iterator to begin traversing the constant UList.
const_iterator	end () const noexcept
	Return const_iterator to end traversing the constant UList.
const_iterator	cbegin (const label i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,size] range.
const_iterator	begin (const label i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,size] range.
reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the UList.
reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the UList.
const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing the UList.
const_reverse_iterator	rbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator	rend () const
	Return const_reverse_iterator to end reverse traversing the UList.
bool	empty () const noexcept
	True if List is empty (ie, size() is zero).
label	size () const noexcept
	The number of elements in the container.
label	capacity () const noexcept
	Size of the underlying storage.
void	swap (UList< face > &list) noexcept
	Swap content with another UList of the same type in constant time.
bool	operator== (const UList< face > &list) const
	Equality operation on ULists of the same type.
bool	operator!= (const UList< face > &list) const
	The opposite of the equality operation. Takes linear time.
bool	operator< (const UList< face > &list) const
	Compare two ULists lexicographically. Takes linear time.
bool	operator> (const UList< face > &list) const
	Compare two ULists lexicographically. Takes linear time.
bool	operator<= (const UList< face > &list) const
	Return true if !(a > b). Takes linear time.
bool	operator>= (const UList< face > &list) const
	Return true if !(a < b). Takes linear time.
Istream &	readList (Istream &is)
	Read List contents from Istream.
void	writeEntry (const word &keyword, Ostream &os) const
	Write the List as a dictionary entry with keyword.
Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen.
bool	all () const
	True if all entries are 'true' or if the list is empty.
bool	any () const
	True if any entries are 'true'.
bool	none () const
	True if no entries are 'true'.
bool	test (const label i) const
	Test bool value at specified position, always false for out-of-range access.
bool	get (const label i) const
	Return bool value at specified position, always false for out-of-range access.
bool	unset (const label i)
	Unset the bool entry at specified position, always false for out-of-range access.
std::string_view	view () const
	Return a string_view of the charList. Content is non-modifiable.
face &	first ()
	Access first element of the list, position [0].
const face &	first () const
	Access first element of the list.
face &	last ()
	Access last element of the list, position [size()-1].
const face &	last () const
	Access last element of the list, position [size()-1].
bool	found (const face &val, label pos=0) const
	Same as contains().
auto	expr () const
	Wrap value as expression.
void	operator= (const Expression::ListExpression< E > &expr)
	Assign values from expression.
	operator const Foam::List< face > & () const
	Allow cast to a const List<T>&.

Static Public Member Functions
static autoPtr< polyPatch >	New (const word &patchType, const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm)
	Return pointer to a new patch created on freestore from components.
static autoPtr< polyPatch >	New (const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm)
	Return pointer to a new patch created on freestore from dictionary.
static autoPtr< polyPatch >	New (const word &patchType, const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm)
	Return pointer to a new patch created on freestore from dictionary.
static bool	constraintType (const word &patchType)
	Return true if the given type is a constraint type.
static wordList	constraintTypes ()
	Return a list of all the constraint patch types.
Static Public Member Functions inherited from patchIdentifier
static word	defaultName (const label n=-1)
	Default patch name: "patch" or "patchN".
Static Public Member Functions inherited from SubList< face >
static const SubList< face > &	null () noexcept
	Return a null SubList (reference to a nullObject). Behaves like an empty SubList.
Static Public Member Functions inherited from UList< face >
static const UList< face > &	null () noexcept
	Return a null UList (reference to a nullObject). Behaves like an empty UList.
static constexpr label	max_size () noexcept
	The size of the largest possible UList.

Static Public Attributes
static int	disallowGenericPolyPatch
	Debug switch to disallow the use of genericPolyPatch.

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 &p)
	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.
virtual void	clearGeom ()
	Clear geometry.
virtual void	movePoints (const Field< point_type > &)
	Inherit movePoints from primitivePatch.
Protected Member Functions inherited from UList< face >
void	setAddressableSize (const label n) noexcept
	Set addressed size to be inconsistent with allocated storage.
void	size (const label n)
	Older name for setAddressableSize.
void	writeEntry (Ostream &os) const
	Write the UList with its compound type.
labelRange	validateRange (const labelRange &requestedRange) const
	Return a validated (start,size) subset range, which means that it always addresses a valid section of the list.
void	fill_uniform (const face &val)
	Assign all entries to the given value.
void	fill_uniform (Foam::zero)
	Assign all entries to zero.

Friends
class	polyBoundaryMesh
Ostream &	operator<< (Ostream &, const polyPatch &)

Additional Inherited Members
Public Types inherited from PrimitivePatch< SubList< face >, const pointField & >
enum	surfaceTopo
	Enumeration defining the surface type. Used in check routines. More...
typedef std::remove_reference< SubList< face > >::type::value_type	face_type
	The face type.
typedef std::remove_reference< const pointField & >::type::value_type	point_type
	The point type.
typedef SubList< face >	FaceListType
	The face list type.
typedef const pointField &	PointFieldType
	The point field type.
typedef face_type	FaceType
	Deprecated(2020-03) prefer face_type typedef.
Public Types inherited from UList< face >
typedef face	value_type
	The value type the list contains.
typedef face *	pointer
	The pointer type for non-const access to value_type items.
typedef const face *	const_pointer
	The pointer type for const access to value_type items.
typedef face &	reference
	The type used for storing into value_type objects.
typedef const face &	const_reference
	The type used for reading from constant value_type objects.
typedef face *	iterator
	Random access iterator for traversing a UList.
typedef const face *	const_iterator
	Random access iterator for traversing a UList.
typedef label	size_type
	The type to represent the size of a UList.
typedef label	difference_type
	The difference between iterator objects.
typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator (non-const access).
typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator (const access).
using	is_List
	Have unique tag.

Detailed Description

A patch is a list of labels that address the faces in the global face list.

The patch can calculate its own edges based on the global faces. Patch also contains all addressing between the faces.

Source files

• polyPatch.H
• polyPatch.C
• polyPatchNew.C

Definition at line 69 of file polyPatch.H.

Constructor & Destructor Documentation

polyPatch() [1/8]

polyPatch	(	const word &	name,
		const label	size,
		const label	start,
		const label	index,
		const polyBoundaryMesh &	bm,
		const word &	patchType )

Construct from components.

Definition at line 74 of file polyPatch.C.

References patchIdentifier::addGroup(), constraintType(), faces(), patchIdentifier::index(), mesh, patchIdentifier::name(), patchIdentifier::patchIdentifier(), PrimitivePatch< SubList< face >, const pointField & >::points(), polyBoundaryMesh, UList< face >::size(), and start().

Referenced by coupledPolyPatch::coupledPolyPatch(), coupledPolyPatch::coupledPolyPatch(), coupledPolyPatch::coupledPolyPatch(), coupledPolyPatch::coupledPolyPatch(), coupledPolyPatch::coupledPolyPatch(), coupledPolyPatch::coupledPolyPatch(), declareRunTimeSelectionTable(), declareRunTimeSelectionTable(), emptyPolyPatch::emptyPolyPatch(), emptyPolyPatch::emptyPolyPatch(), emptyPolyPatch::emptyPolyPatch(), emptyPolyPatch::emptyPolyPatch(), emptyPolyPatch::emptyPolyPatch(), genericPolyPatch::genericPolyPatch(), genericPolyPatch::genericPolyPatch(), genericPolyPatch::genericPolyPatch(), genericPolyPatch::genericPolyPatch(), genericPolyPatch::genericPolyPatch(), mappedPolyPatch::mappedPolyPatch(), mappedPolyPatch::mappedPolyPatch(), mappedPolyPatch::mappedPolyPatch(), mappedPolyPatch::mappedPolyPatch(), mappedPolyPatch::mappedPolyPatch(), mappedPolyPatch::mappedPolyPatch(), mappedPolyPatch::mappedPolyPatch(), operator<<, operator=(), oversetPolyPatch::oversetPolyPatch(), oversetPolyPatch::oversetPolyPatch(), oversetPolyPatch::oversetPolyPatch(), oversetPolyPatch::oversetPolyPatch(), oversetPolyPatch::oversetPolyPatch(), polyPatch(), polyPatch(), polyPatch(), polyPatch(), polyPatch(), symmetryPlanePolyPatch::symmetryPlanePolyPatch(), symmetryPlanePolyPatch::symmetryPlanePolyPatch(), symmetryPlanePolyPatch::symmetryPlanePolyPatch(), symmetryPlanePolyPatch::symmetryPlanePolyPatch(), symmetryPlanePolyPatch::symmetryPlanePolyPatch(), symmetryPolyPatch::symmetryPolyPatch(), symmetryPolyPatch::symmetryPolyPatch(), symmetryPolyPatch::symmetryPolyPatch(), symmetryPolyPatch::symmetryPolyPatch(), symmetryPolyPatch::symmetryPolyPatch(), wallPolyPatch::wallPolyPatch(), wallPolyPatch::wallPolyPatch(), wallPolyPatch::wallPolyPatch(), wallPolyPatch::wallPolyPatch(), wallPolyPatch::wallPolyPatch(), wedgePolyPatch::wedgePolyPatch(), wedgePolyPatch::wedgePolyPatch(), wedgePolyPatch::wedgePolyPatch(), wedgePolyPatch::wedgePolyPatch(), and wedgePolyPatch::wedgePolyPatch().

Here is the call graph for this function:

polyPatch() [2/8]

polyPatch	(	const word &	name,
		const label	size,
		const label	start,
		const label	index,
		const polyBoundaryMesh &	bm,
		const word &	physicalType,
		const wordList &	inGroups )

Construct from components.

Definition at line 100 of file polyPatch.C.

References faces(), patchIdentifier::index(), patchIdentifier::inGroups(), mesh, patchIdentifier::name(), patchIdentifier::patchIdentifier(), patchIdentifier::physicalType(), PrimitivePatch< SubList< face >, const pointField & >::points(), polyBoundaryMesh, UList< face >::size(), and start().

Here is the call graph for this function:

polyPatch() [3/8]

polyPatch	(	const word &	name,
		const dictionary &	dict,
		const label	index,
		const polyBoundaryMesh &	bm,
		const word &	patchType )

Construct from dictionary.

Definition at line 122 of file polyPatch.C.

References patchIdentifier::addGroup(), constraintType(), dict, faces(), UList< face >::get(), patchIdentifier::index(), mesh, patchIdentifier::name(), patchIdentifier::patchIdentifier(), PrimitivePatch< SubList< face >, const pointField & >::points(), and polyBoundaryMesh.

Here is the call graph for this function:

polyPatch() [4/8]

polyPatch	(	const polyPatch &	pp,
		const polyBoundaryMesh &	bm )

Copy construct, resetting the boundary mesh.

Definition at line 152 of file polyPatch.C.

References faces(), mesh, patchIdentifier::patchIdentifier(), PrimitivePatch< SubList< face >, const pointField & >::points(), polyBoundaryMesh, polyPatch(), pp(), UList< face >::size(), and start().

Here is the call graph for this function:

polyPatch() [5/8]

polyPatch	(	const polyPatch &	pp,
		const polyBoundaryMesh &	bm,
		const label	index,
		const label	newSize,
		const label	newStart )

Construct given the original patch and resetting the face list and boundary mesh information.

Definition at line 174 of file polyPatch.C.

References faces(), patchIdentifier::index(), mesh, patchIdentifier::patchIdentifier(), PrimitivePatch< SubList< face >, const pointField & >::points(), polyBoundaryMesh, polyPatch(), and pp().

Here is the call graph for this function:

polyPatch() [6/8]

polyPatch	(	const polyPatch &	pp,
		const polyBoundaryMesh &	bm,
		const label	index,
		const labelUList &	mapAddressing,
		const label	newStart )

Construct given the original patch and a map.

Definition at line 199 of file polyPatch.C.

References faces(), patchIdentifier::index(), mesh, patchIdentifier::patchIdentifier(), PrimitivePatch< SubList< face >, const pointField & >::points(), polyBoundaryMesh, polyPatch(), pp(), and UList< face >::size().

Here is the call graph for this function:

polyPatch() [7/8]

polyPatch

(

const polyPatch &

p

)

Copy construct.

Definition at line 224 of file polyPatch.C.

References p, patchIdentifier::patchIdentifier(), and polyPatch().

Here is the call graph for this function:

polyPatch() [8/8]

polyPatch	(	const polyPatch &	p,
		const labelList &	faceCells )

Copy construct, setting faceCells.

Note

The faceCells are held by the caller

Definition at line 233 of file polyPatch.C.

References faceCells(), p, and polyPatch().

Here is the call graph for this function:

~polyPatch()

~polyPatch ( )

virtual

Destructor.

Definition at line 247 of file polyPatch.C.

References clearAddressing().

Here is the call graph for this function:

Member Function Documentation

initGeometry()

virtual void initGeometry ( PstreamBuffers & )

inlineprotectedvirtual

Initialise the calculation of the patch geometry.

Reimplemented in coupledPolyPatch, cyclicACMIPolyPatch, cyclicAMIPolyPatch, cyclicPolyPatch, mappedPolyPatch, mappedWallPolyPatch, oldCyclicPolyPatch, processorCyclicPolyPatch, and processorPolyPatch.

Definition at line 117 of file polyPatch.H.

Referenced by cyclicAMIPolyPatch::initGeometry(), cyclicPolyPatch::initGeometry(), mappedPolyPatch::initGeometry(), mappedWallPolyPatch::initGeometry(), and oldCyclicPolyPatch::initGeometry().

Here is the caller graph for this function:

calcGeometry()

virtual void calcGeometry ( PstreamBuffers & )

inlineprotectedvirtual

Calculate the patch geometry.

Reimplemented in coupledPolyPatch, cyclicACMIPolyPatch, cyclicAMIPolyPatch, cyclicPolyPatch, mappedPolyPatch, mappedWallPolyPatch, oldCyclicPolyPatch, processorCyclicPolyPatch, processorPolyPatch, symmetryPlanePolyPatch, and wedgePolyPatch.

Definition at line 123 of file polyPatch.H.

Referenced by mappedPolyPatch::calcGeometry(), and mappedWallPolyPatch::calcGeometry().

Here is the caller graph for this function:

initMovePoints()

virtual void initMovePoints ( PstreamBuffers & , const pointField &  )

inlineprotectedvirtual

Initialise the patches for moving points.

Reimplemented in coupledPolyPatch, cyclicACMIPolyPatch, cyclicAMIPolyPatch, cyclicPolyPatch, mappedPolyPatch, mappedWallPolyPatch, oldCyclicPolyPatch, processorCyclicPolyPatch, and processorPolyPatch.

Definition at line 129 of file polyPatch.H.

Referenced by cyclicPolyPatch::initMovePoints(), mappedPolyPatch::initMovePoints(), mappedWallPolyPatch::initMovePoints(), and oldCyclicPolyPatch::initMovePoints().

Here is the caller graph for this function:

movePoints() [1/2]

void movePoints ( PstreamBuffers & , const pointField & p )

protectedvirtual

Correct patches after moving points.

Reimplemented in coupledPolyPatch, cyclicACMIPolyPatch, cyclicAMIPolyPatch, cyclicPolyPatch, mappedPolyPatch, mappedWallPolyPatch, oldCyclicPolyPatch, processorCyclicPolyPatch, and processorPolyPatch.

Definition at line 53 of file polyPatch.C.

References PrimitivePatch< SubList< face >, const pointField & >::movePoints(), and p.

Referenced by processorPolyPatch::initMovePoints(), cyclicPolyPatch::movePoints(), mappedPolyPatch::movePoints(), mappedWallPolyPatch::movePoints(), and oldCyclicPolyPatch::movePoints().

Here is the call graph for this function:

Here is the caller graph for this function:

initUpdateMesh()

virtual void initUpdateMesh ( PstreamBuffers & )

inlineprotectedvirtual

Initialise the update of the patch topology.

Reimplemented in coupledPolyPatch, cyclicACMIPolyPatch, cyclicAMIPolyPatch, cyclicPolyPatch, mappedPolyPatch, mappedWallPolyPatch, oldCyclicPolyPatch, processorCyclicPolyPatch, and processorPolyPatch.

Definition at line 140 of file polyPatch.H.

Referenced by cyclicAMIPolyPatch::initUpdateMesh(), cyclicPolyPatch::initUpdateMesh(), mappedPolyPatch::initUpdateMesh(), mappedWallPolyPatch::initUpdateMesh(), oldCyclicPolyPatch::initUpdateMesh(), and processorPolyPatch::initUpdateMesh().

Here is the caller graph for this function:

updateMesh()

void updateMesh ( PstreamBuffers & )

protectedvirtual

Update of the patch topology.

Reimplemented in coupledPolyPatch, cyclicACMIPolyPatch, cyclicAMIPolyPatch, cyclicPolyPatch, mappedPolyPatch, mappedWallPolyPatch, oldCyclicPolyPatch, processorCyclicPolyPatch, and processorPolyPatch.

Definition at line 59 of file polyPatch.C.

References clearAddressing(), and PrimitivePatch< SubList< face >, const pointField & >::clearGeom().

Referenced by cyclicAMIPolyPatch::updateMesh(), cyclicPolyPatch::updateMesh(), mappedPolyPatch::updateMesh(), mappedWallPolyPatch::updateMesh(), oldCyclicPolyPatch::updateMesh(), and processorPolyPatch::updateMesh().

Here is the call graph for this function:

Here is the caller graph for this function:

clearGeom()

void clearGeom ( )

protectedvirtual

Clear geometry.

Reimplemented in cyclicACMIPolyPatch, and cyclicAMIPolyPatch.

Definition at line 66 of file polyPatch.C.

References PrimitivePatch< SubList< face >, const pointField & >::clearGeom().

Referenced by cyclicAMIPolyPatch::clearGeom().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeName()

TypeName

(

"patch"

)

Runtime type information.

declareRunTimeSelectionTable() [1/2]

declareRunTimeSelectionTable	(	autoPtr	,
		polyPatch	,
		word	,
		(const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType)	,
		(name, size, start, index, bm, patchType)	)

References patchIdentifier::index(), patchIdentifier::name(), polyBoundaryMesh, polyPatch(), UList< face >::size(), and start().

Here is the call graph for this function:

declareRunTimeSelectionTable() [2/2]

declareRunTimeSelectionTable	(	autoPtr	,
		polyPatch	,
		dictionary	,
		(const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm, const word &patchType)	,
		(name, dict, index, bm, patchType)	)

References dict, faceCells(), patchIdentifier::index(), patchIdentifier::inGroups(), patchIdentifier::name(), p, patchIdentifier::physicalType(), polyBoundaryMesh, polyPatch(), pp(), UList< face >::size(), and start().

Here is the call graph for this function:

clone() [1/4]

virtual autoPtr< polyPatch > clone ( const labelList & faceCells ) const

inlinevirtual

Construct and return a clone, setting faceCells.

Note

The faceCells are held by the caller

Definition at line 289 of file polyPatch.H.

References faceCells(), and autoPtr< T >::New().

Referenced by boundaryMesh::patchify().

Here is the call graph for this function:

Here is the caller graph for this function:

clone() [2/4]

virtual autoPtr< polyPatch > clone ( const polyBoundaryMesh & bm ) const

inlinevirtual

Construct and return a clone, resetting the boundary mesh.

Reimplemented in cyclicACMIPolyPatch, cyclicAMIPolyPatch, cyclicPeriodicAMIPolyPatch, cyclicPolyPatch, cyclicSlipPolyPatch, emptyPolyPatch, genericPolyPatch, mappedPolyPatch, mappedVariableThicknessWallPolyPatch, mappedWallPolyPatch, nonuniformTransformCyclicPolyPatch, oldCyclicPolyPatch, oversetPolyPatch, processorCyclicPolyPatch, processorPolyPatch, symmetryPlanePolyPatch, symmetryPolyPatch, wallPolyPatch, and wedgePolyPatch.

Definition at line 297 of file polyPatch.H.

References autoPtr< T >::New(), and polyBoundaryMesh.

Here is the call graph for this function:

clone() [3/4]

virtual autoPtr< polyPatch > clone ( const polyBoundaryMesh & bm, const label index, const label newSize, const label newStart ) const

inlinevirtual

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

Reimplemented in cyclicACMIPolyPatch, cyclicAMIPolyPatch, cyclicPeriodicAMIPolyPatch, cyclicPolyPatch, cyclicSlipPolyPatch, emptyPolyPatch, genericPolyPatch, mappedPolyPatch, mappedVariableThicknessWallPolyPatch, mappedWallPolyPatch, nonuniformTransformCyclicPolyPatch, oldCyclicPolyPatch, oversetPolyPatch, processorCyclicPolyPatch, processorPolyPatch, symmetryPlanePolyPatch, symmetryPolyPatch, wallPolyPatch, and wedgePolyPatch.

Definition at line 306 of file polyPatch.H.

References patchIdentifier::index(), autoPtr< T >::New(), and polyBoundaryMesh.

Here is the call graph for this function:

clone() [4/4]

virtual autoPtr< polyPatch > clone ( const polyBoundaryMesh & bm, const label index, const labelUList & mapAddressing, const label newStart ) const

inlinevirtual

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

Reimplemented in cyclicACMIPolyPatch, cyclicAMIPolyPatch, cyclicPeriodicAMIPolyPatch, cyclicPolyPatch, cyclicSlipPolyPatch, emptyPolyPatch, genericPolyPatch, mappedPolyPatch, mappedVariableThicknessWallPolyPatch, mappedWallPolyPatch, nonuniformTransformCyclicPolyPatch, oversetPolyPatch, processorCyclicPolyPatch, processorPolyPatch, symmetryPlanePolyPatch, symmetryPolyPatch, wallPolyPatch, and wedgePolyPatch.

Definition at line 321 of file polyPatch.H.

References patchIdentifier::index(), autoPtr< T >::New(), and polyBoundaryMesh.

Here is the call graph for this function:

New() [1/3]

Foam::autoPtr< Foam::polyPatch > New ( const word & patchType, const word & name, const label size, const label start, const label index, const polyBoundaryMesh & bm )

static

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

Definition at line 27 of file polyPatchNew.C.

References DebugInFunction, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInLookup, patchIdentifier::index(), patchIdentifier::name(), polyBoundaryMesh, UList< face >::size(), and start().

Referenced by columnFvMeshInfo::addLocalPatches(), meshRefinement::appendPatch(), extrudePatchMesh::extrudePatchMesh(), PDRblock::innerMesh(), New(), fvMeshTools::newMesh(), boundaryMesh::patchify(), polyMesh::polyMesh(), and polyMesh::polyMesh().

Here is the call graph for this function:

Here is the caller graph for this function:

New() [2/3]

Foam::autoPtr< Foam::polyPatch > New ( const word & name, const dictionary & dict, const label index, const polyBoundaryMesh & bm )

static

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

Definition at line 66 of file polyPatchNew.C.

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

Here is the call graph for this function:

New() [3/3]

Foam::autoPtr< Foam::polyPatch > New ( const word & patchType, const word & name, const dictionary & dict, const label index, const polyBoundaryMesh & bm )

static

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

Definition at line 83 of file polyPatchNew.C.

References DebugInFunction, dict, disallowGenericPolyPatch, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, patchIdentifier::index(), patchIdentifier::name(), and polyBoundaryMesh.

Here is the call graph for this function:

newInternalProcFaces()

virtual void newInternalProcFaces ( label & , label &  ) const

inlinevirtual

Return number of new internal of this polyPatch faces.

Reimplemented in cyclicACMIPolyPatch, cyclicAMIPolyPatch, cyclicPolyPatch, mappedPolyPatch, and mappedWallPolyPatch.

Definition at line 386 of file polyPatch.H.

References NotImplemented.

nbrCells()

virtual const labelUList & nbrCells ( ) const

inlinevirtual

Return nbrCells.

Reimplemented in cyclicAMIPolyPatch, cyclicPolyPatch, mappedPolyPatch, and mappedWallPolyPatch.

Definition at line 394 of file polyPatch.H.

References NotImplemented, and UList< label >::null().

Here is the call graph for this function:

neighbPolyPatchID()

virtual label neighbPolyPatchID ( ) const

inlinevirtual

Return nbr patchID.

Reimplemented in cyclicAMIPolyPatch, cyclicPolyPatch, mappedPolyPatch, and mappedWallPolyPatch.

Definition at line 403 of file polyPatch.H.

References NotImplemented.

mapCollocatedFaces()

virtual refPtr< labelListList > mapCollocatedFaces ( ) const

inlinevirtual

Return mapped collocated faces.

Reimplemented in cyclicACMIPolyPatch, cyclicAMIPolyPatch, cyclicPolyPatch, mappedPolyPatch, and mappedWallPolyPatch.

Definition at line 412 of file polyPatch.H.

References NotImplemented.

masterImplicit()

virtual bool masterImplicit ( ) const

inlinevirtual

Return implicit master.

Reimplemented in cyclicAMIPolyPatch, cyclicPolyPatch, mappedPolyPatch, and mappedWallPolyPatch.

Definition at line 421 of file polyPatch.H.

References NotImplemented.

neighbRegionID()

virtual word neighbRegionID ( ) const

inlinevirtual

Return neighbour region name.

Reimplemented in mappedPolyPatch, and mappedWallPolyPatch.

Definition at line 430 of file polyPatch.H.

offset()

Foam::label offset ( ) const

noexcept

The offset where this patch starts in the boundary face list.

The value is the same as patch.start() - mesh.nInternalFaces()

Definition at line 288 of file polyPatch.C.

References Foam::noexcept.

Referenced by boundarySlice(), and cyclicPolyPatch::transformGlobalFace().

Here is the caller graph for this function:

start()

label start ( ) const

inlinenoexcept

Return start label of this patch in the polyMesh face list.

Definition at line 446 of file polyPatch.H.

References Foam::noexcept, and start().

Referenced by cyclicAMIPolyPatch::addAMIFaces(), processorPolyPatch::calcGeometry(), particle< Type >::correctAfterParallelTransfer(), coupledPolyPatch::coupledPolyPatch(), cyclicACMIPolyPatch::cyclicACMIPolyPatch(), cyclicAMIPolyPatch::cyclicAMIPolyPatch(), cyclicPeriodicAMIPolyPatch::cyclicPeriodicAMIPolyPatch(), cyclicPolyPatch::cyclicPolyPatch(), cyclicPolyPatch::cyclicPolyPatch(), cyclicSlipPolyPatch::cyclicSlipPolyPatch(), declareRunTimeSelectionTable(), declareRunTimeSelectionTable(), Bezier::dndbBasedSensitivities(), Bezier::dndbBasedSensitivities(), NURBS3DVolume::dndbBasedSensitivities(), emptyPolyPatch::emptyPolyPatch(), genericPolyPatch::genericPolyPatch(), particle< Type >::hitCyclicACMIPatch(), particle< Type >::hitCyclicAMIPatch(), marchingCells::initialise(), isoSurfacePoint::isoSurfacePoint(), FaceCellWave< Type, int >::leaveDomain(), mappedPolyPatch::mappedPolyPatch(), mappedPolyPatch::mappedPolyPatch(), mappedPolyPatch::mappedPolyPatch(), mappedVariableThicknessWallPolyPatch::mappedVariableThicknessWallPolyPatch(), mappedVariableThicknessWallPolyPatch::mappedVariableThicknessWallPolyPatch(), mappedVariableThicknessWallPolyPatch::mappedVariableThicknessWallPolyPatch(), mappedWallPolyPatch::mappedWallPolyPatch(), mappedWallPolyPatch::mappedWallPolyPatch(), mappedWallPolyPatch::mappedWallPolyPatch(), New(), nonuniformTransformCyclicPolyPatch::nonuniformTransformCyclicPolyPatch(), oldCyclicPolyPatch::oldCyclicPolyPatch(), oversetPolyPatch::oversetPolyPatch(), boundaryMesh::patchify(), polyPatch(), polyPatch(), polyPatch(), processorCyclicPolyPatch::processorCyclicPolyPatch(), processorPolyPatch::processorPolyPatch(), processorPolyPatch::processorPolyPatch(), cyclicAMIPolyPatch::removeAMIFaces(), fvMeshSubset::reset(), removeFaces::setRefinement(), start(), symmetryPlanePolyPatch::symmetryPlanePolyPatch(), symmetryPolyPatch::symmetryPolyPatch(), syncTools::syncBoundaryFaceList(), syncTools::syncFaceList(), cyclicPolyPatch::transformGlobalFace(), coupledPolyPatch::TypeName(), cyclicACMIPolyPatch::TypeName(), cyclicAMIPolyPatch::TypeName(), cyclicPeriodicAMIPolyPatch::TypeName(), cyclicPolyPatch::TypeName(), emptyPolyPatch::TypeName(), genericPolyPatch::TypeName(), mappedPolyPatch::TypeName(), mappedVariableThicknessWallPolyPatch::TypeName(), mappedWallPolyPatch::TypeName(), oldCyclicPolyPatch::TypeName(), oversetPolyPatch::TypeName(), processorCyclicPolyPatch::TypeName(), processorPolyPatch::TypeName(), symmetryPlanePolyPatch::TypeName(), symmetryPolyPatch::TypeName(), wallPolyPatch::TypeName(), wedgePolyPatch::TypeName(), wallPolyPatch::wallPolyPatch(), wedgePolyPatch::wedgePolyPatch(), regionSizeDistribution::write(), genericPolyPatch::write(), oldCyclicPolyPatch::write(), and write().

Here is the call graph for this function:

range()

labelRange range ( ) const

inline

Return start/size range of this patch.

Definition at line 454 of file polyPatch.H.

References UList< face >::size().

Referenced by perfectInterface::setRefinement().

Here is the call graph for this function:

Here is the caller graph for this function:

boundaryMesh()

const Foam::polyBoundaryMesh & boundaryMesh ( ) const

noexcept

Return boundaryMesh reference.

Definition at line 295 of file polyPatch.C.

References Foam::noexcept.

Referenced by cyclicAMIPolyPatch::canResetAMI(), processorPolyPatch::comm(), patchPatchDist::correct(), faceAreas(), faceCells(), faceCentres(), faceOwner(), faces(), coupleGroupIdentifier::findOtherPatchID(), coupleGroupIdentifier::findOtherPatchID(), mappedVariableThicknessWallFvPatch::makeDeltaCoeffs(), oversetPolyPatch::master(), meshEdges(), cyclicPolyPatch::neighbPatch(), processorCyclicPolyPatch::referPatch(), cyclicAMIPolyPatch::restoreScaledGeometry(), cyclicACMIPolyPatch::updateAreas(), and outletMappedUniformInletHeatAdditionFvPatchField::updateCoeffs().

Here is the caller graph for this function:

coupled()

virtual bool coupled ( ) const

inlinevirtual

Return true if this patch is geometrically coupled (i.e. faces and.

points correspondence)

Reimplemented in coupledPolyPatch, cyclicAMIPolyPatch, and processorPolyPatch.

Definition at line 469 of file polyPatch.H.

References coupled().

Referenced by coupled().

Here is the call graph for this function:

Here is the caller graph for this function:

constraintType()

bool constraintType ( const word & patchType )

static

Return true if the given type is a constraint type.

Definition at line 255 of file polyPatch.C.

Referenced by faPatch::constraintType(), constraintTypes(), Foam::evaluateConstraintTypes(), surfaceDistance::execute(), KinematicParcel< ParcelType >::hitPatch(), meshRefinement::meshedPatches(), polyPatch(), polyPatch(), and Foam::Detail::reusable().

Here is the caller graph for this function:

constraintTypes()

Foam::wordList constraintTypes ( )

static

Return a list of all the constraint patch types.

Definition at line 266 of file polyPatch.C.

References constraintType(), forAllConstIters, and List< T >::resize().

Here is the call graph for this function:

patchInternalList()

template<class T>

const UIndirectList< T > patchInternalList ( const UList< T > & internalValues ) const

inline

Extract face cell data.

Definition at line 488 of file polyPatch.H.

References faceCells().

Here is the call graph for this function:

patchSlice() [1/2]

template<class T>

const List< T >::subList patchSlice ( const UList< T > & values ) const

inline

This patch slice from the complete list, which has size mesh::nFaces(), using the number of patch faces.

Definition at line 502 of file polyPatch.H.

References UList< face >::size().

Referenced by faceAreas(), faceCells(), faceCentres(), faceOwner(), faces(), and FaceCellWave< Type, TrackingData >::handleAMICyclicPatches().

Here is the call graph for this function:

Here is the caller graph for this function:

patchSlice() [2/2]

template<class T>

const Field< T >::subField patchSlice ( const Field< T > & values ) const

inline

Slice Field to patch, using the number of patch faces.

Definition at line 512 of file polyPatch.H.

References UList< face >::size().

Here is the call graph for this function:

boundarySlice()

template<class T>

const List< T >::subList boundarySlice ( const UList< T > & values ) const

inline

This patch slice from the list of boundary values, which has size mesh::nBoundaryFaces(), using the number of patch faces.

Definition at line 523 of file polyPatch.H.

References offset(), and UList< face >::size().

Here is the call graph for this function:

write()

void write ( Ostream & os ) const

virtual

Write the polyPatch data as a dictionary.

Reimplemented in coupledPolyPatch, cyclicACMIPolyPatch, cyclicAMIPolyPatch, cyclicPeriodicAMIPolyPatch, cyclicPolyPatch, genericPolyPatch, mappedPolyPatch, mappedVariableThicknessWallPolyPatch, mappedWallPolyPatch, oldCyclicPolyPatch, processorCyclicPolyPatch, and processorPolyPatch.

Definition at line 449 of file polyPatch.C.

References os(), UList< face >::size(), start(), Foam::type(), and patchIdentifier::write().

Referenced by coupledPolyPatch::write(), and mappedPolyPatch::write().

Here is the call graph for this function:

Here is the caller graph for this function:

faces()

const Foam::faceList::subList faces

(

)

const

Return mesh faces for the patch.

Definition at line 301 of file polyPatch.C.

References boundaryMesh(), faces(), mesh, and patchSlice().

Referenced by coupledPolyPatch::calcFaceTol(), faces(), coupledPolyPatch::getAnchorPoints(), coupledPolyPatch::order(), polyPatch(), polyPatch(), polyPatch(), polyPatch(), polyPatch(), polyPatch(), and coupledPolyPatch::writeOBJ().

Here is the call graph for this function:

Here is the caller graph for this function:

faceOwner()

const Foam::labelList::subList faceOwner

(

)

const

Return face owner for the patch.

Definition at line 307 of file polyPatch.C.

References boundaryMesh(), faceOwner(), mesh, and patchSlice().

Referenced by faceCells(), and faceOwner().

Here is the call graph for this function:

Here is the caller graph for this function:

faceCentres()

const Foam::vectorField::subField faceCentres

(

)

const

Return face centres.

Definition at line 320 of file polyPatch.C.

References boundaryMesh(), faceCentres(), mesh, and patchSlice().

Referenced by coupledPolyPatch::calcFaceTol(), cyclicPolyPatch::calcGeometry(), processorCyclicPolyPatch::calcGeometry(), processorPolyPatch::calcGeometry(), cyclicAMIPolyPatch::calcTransforms(), cyclicPolyPatch::calcTransforms(), faceCentres(), FaceCellWave< Type, TrackingData >::handleAMICyclicPatches(), processorPolyPatch::initGeometry(), marchingCells::initialise(), cyclicAMIPolyPatch::initInterpolate(), cyclicAMIPolyPatch::interpolate(), cyclicAMIPolyPatch::interpolate(), cyclicAMIFvPatch::movePoints(), coupledPolyPatch::order(), cyclicACMIFvPatch::resetPatchAreas(), cyclicAMIPolyPatch::restoreScaledGeometry(), and cyclicAMIPolyPatch::setAMIFaces().

Here is the call graph for this function:

Here is the caller graph for this function:

faceAreas()

const Foam::vectorField::subField faceAreas

(

)

const

Return face normals.

Definition at line 326 of file polyPatch.C.

References boundaryMesh(), faceAreas(), mesh, and patchSlice().

Referenced by areaFraction(), cyclicPolyPatch::calcGeometry(), processorCyclicPolyPatch::calcGeometry(), processorPolyPatch::calcGeometry(), symmetryPlanePolyPatch::calcGeometry(), faceAreas(), DSMCParcel< ParcelType >::hitWallPatch(), processorPolyPatch::initGeometry(), cyclicAMIFvPatch::movePoints(), cyclicACMIPolyPatch::nonOverlapPatchID(), cyclicACMIFvPatch::resetPatchAreas(), cyclicAMIPolyPatch::restoreScaledGeometry(), cyclicACMIPolyPatch::scalePatchFaceAreas(), cyclicACMIPolyPatch::scalePatchFaceAreas(), and cyclicAMIPolyPatch::setAMIFaces().

Here is the call graph for this function:

Here is the caller graph for this function:

faceCellCentres()

Foam::tmp< Foam::vectorField > faceCellCentres

(

)

const

Return face cell centres.

Definition at line 332 of file polyPatch.C.

References faceCells(), forAll, tmp< T >::New(), and UList< face >::size().

Referenced by cyclicPolyPatch::calcGeometry(), processorCyclicPolyPatch::calcGeometry(), and processorPolyPatch::initGeometry().

Here is the call graph for this function:

Here is the caller graph for this function:

areaFraction() [1/4]

Foam::tmp< Foam::scalarField > areaFraction

(

const pointField &

points

)

const

Calculate the area fraction as the ratio of the stored face area and the area given by the face points.

Definition at line 351 of file polyPatch.C.

References f(), faceAreas(), forAll, tmp< T >::New(), UList< face >::operator[](), PrimitivePatch< SubList< face >, const pointField & >::points(), and UList< face >::size().

Referenced by cyclicACMIPolyPatch::scalePatchFaceAreas(), and activePressureForceBaffleVelocityFvPatchVectorField::updateCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

areaFraction() [2/4]

Foam::tmp< Foam::scalarField > areaFraction

(

)

const

Return the cached area fraction. Usually only set for the non-overlap patches on ACMI.

Definition at line 371 of file polyPatch.C.

areaFraction() [3/4]

void areaFraction

(

const scalar

fraction

)

Set uniform cached area fraction.

Definition at line 381 of file polyPatch.C.

References UList< face >::size().

Here is the call graph for this function:

areaFraction() [4/4]

void areaFraction

(

const tmp< scalarField > &

fraction

)

Set cached area fraction (non-uniform).

Definition at line 387 of file polyPatch.C.

References tmp< T >::ptr().

Here is the call graph for this function:

faceCells()

const Foam::labelUList & faceCells

(

)

const

Return face-cell addressing.

Definition at line 401 of file polyPatch.C.

References boundaryMesh(), faceOwner(), mesh, and patchSlice().

Referenced by clone(), particle< Type >::correctAfterParallelTransfer(), coupledPolyPatch::coupledPolyPatch(), declareRunTimeSelectionTable(), faceCellCentres(), cyclicAMIPolyPatch::nbrCells(), cyclicPolyPatch::nbrCells(), mappedPolyPatch::nbrCells(), mappedWallPolyPatch::nbrCells(), patchInternalList(), polyPatch(), cyclicACMIPolyPatch::scalePatchFaceAreas(), cyclicACMIPolyPatch::scalePatchFaceAreas(), coupledPolyPatch::TypeName(), activeBaffleVelocityFvPatchVectorField::updateCoeffs(), activePressureForceBaffleVelocityFvPatchVectorField::updateCoeffs(), and zoneDistribute::zoneDistribute().

Here is the call graph for this function:

Here is the caller graph for this function:

meshEdges()

const Foam::labelList & meshEdges

(

)

const

Return global edge index for local edges.

Definition at line 418 of file polyPatch.C.

References boundaryMesh(), PrimitivePatch< SubList< face >, const pointField & >::edges(), mesh, PrimitivePatch< SubList< face >, const pointField & >::meshEdges(), and PrimitivePatch< SubList< face >, const pointField & >::pointEdges().

Here is the call graph for this function:

clearAddressing()

void clearAddressing ( )

virtual

Clear addressing.

Definition at line 439 of file polyPatch.C.

References PrimitivePatch< SubList< face >, const pointField & >::clearPatchMeshAddr(), and PrimitivePatch< SubList< face >, const pointField & >::clearTopology().

Referenced by operator=(), updateMesh(), and ~polyPatch().

Here is the call graph for this function:

Here is the caller graph for this function:

whichFace()

label whichFace ( const label facei ) const

inlinenoexcept

Return label of face in patch from global face label.

Definition at line 608 of file polyPatch.H.

Referenced by MaxwellianThermal< CloudType >::correct(), MixedDiffuseSpecular< CloudType >::correct(), particle< Type >::hitCyclicACMIPatch(), particle< Type >::hitCyclicAMIPatch(), particle< Type >::hitCyclicPatch(), DSMCParcel< ParcelType >::hitWallPatch(), and fvMeshSubset::interpolate().

Here is the caller graph for this function:

initOrder()

void initOrder ( PstreamBuffers & , const primitivePatch &  ) const

virtual

Initialize ordering for primitivePatch. Does not.

refer to *this (except for name() and type() etc.)

Reimplemented in coupledPolyPatch, cyclicACMIPolyPatch, cyclicAMIPolyPatch, cyclicPolyPatch, oldCyclicPolyPatch, processorCyclicPolyPatch, and processorPolyPatch.

Definition at line 458 of file polyPatch.C.

order()

bool order ( PstreamBuffers & , const primitivePatch & , labelList & faceMap, labelList & rotation ) const

virtual

Return new ordering for primitivePatch.

Ordering is -faceMap: for every face index of the new face -rotation:for every new face the clockwise shift of the original face. Return false if nothing changes (faceMap is identity, rotation is 0), true otherwise.

Reimplemented in coupledPolyPatch, cyclicACMIPolyPatch, cyclicAMIPolyPatch, cyclicPolyPatch, oldCyclicPolyPatch, processorCyclicPolyPatch, and processorPolyPatch.

Definition at line 462 of file polyPatch.C.

References Foam::faceMap().

Here is the call graph for this function:

changeTopology()

virtual bool changeTopology ( ) const

inlinevirtual

For dynamic mesh cases - return true if this patch will change the topology.

Reimplemented in cyclicAMIPolyPatch.

Definition at line 641 of file polyPatch.H.

setTopology()

virtual bool setTopology ( polyTopoChange & )

inlinevirtual

Collect topology changes in a polyTopoChange object.

Reimplemented in cyclicAMIPolyPatch.

Definition at line 649 of file polyPatch.H.

operator=()

void operator=

(

const polyPatch &

p

)

Copy assignment.

Definition at line 477 of file polyPatch.C.

References clearAddressing(), patchIdentifier::operator=(), PrimitivePatch< SubList< face >, const pointField & >::operator=(), p, and polyPatch().

Here is the call graph for this function:

movePoints() [2/2]

virtual void movePoints ( const Field< point_type > & )

protectedvirtual

Inherit movePoints from primitivePatch.

Reimplemented from PrimitivePatch< SubList< face >, const pointField & >.

Friends And Related Symbol Documentation

polyBoundaryMesh

friend class polyBoundaryMesh

friend

Definition at line 112 of file polyPatch.H.

References polyBoundaryMesh.

Referenced by emptyPolyPatch::clone(), emptyPolyPatch::clone(), emptyPolyPatch::clone(), genericPolyPatch::clone(), genericPolyPatch::clone(), genericPolyPatch::clone(), mappedPolyPatch::clone(), mappedPolyPatch::clone(), mappedPolyPatch::clone(), oversetPolyPatch::clone(), oversetPolyPatch::clone(), oversetPolyPatch::clone(), clone(), clone(), clone(), symmetryPlanePolyPatch::clone(), symmetryPlanePolyPatch::clone(), symmetryPlanePolyPatch::clone(), symmetryPolyPatch::clone(), symmetryPolyPatch::clone(), symmetryPolyPatch::clone(), wallPolyPatch::clone(), wallPolyPatch::clone(), wallPolyPatch::clone(), wedgePolyPatch::clone(), wedgePolyPatch::clone(), wedgePolyPatch::clone(), coupledPolyPatch::coupledPolyPatch(), coupledPolyPatch::coupledPolyPatch(), coupledPolyPatch::coupledPolyPatch(), coupledPolyPatch::coupledPolyPatch(), coupledPolyPatch::coupledPolyPatch(), declareRunTimeSelectionTable(), declareRunTimeSelectionTable(), emptyPolyPatch::emptyPolyPatch(), emptyPolyPatch::emptyPolyPatch(), emptyPolyPatch::emptyPolyPatch(), emptyPolyPatch::emptyPolyPatch(), emptyPolyPatch::emptyPolyPatch(), genericPolyPatch::genericPolyPatch(), genericPolyPatch::genericPolyPatch(), genericPolyPatch::genericPolyPatch(), genericPolyPatch::genericPolyPatch(), genericPolyPatch::genericPolyPatch(), mappedPolyPatch::mappedPolyPatch(), mappedPolyPatch::mappedPolyPatch(), mappedPolyPatch::mappedPolyPatch(), mappedPolyPatch::mappedPolyPatch(), mappedPolyPatch::mappedPolyPatch(), mappedPolyPatch::mappedPolyPatch(), mappedPolyPatch::mappedPolyPatch(), oversetPolyPatch::master(), New(), New(), New(), oversetPolyPatch::oversetPolyPatch(), oversetPolyPatch::oversetPolyPatch(), oversetPolyPatch::oversetPolyPatch(), oversetPolyPatch::oversetPolyPatch(), oversetPolyPatch::oversetPolyPatch(), polyBoundaryMesh, polyPatch(), polyPatch(), polyPatch(), polyPatch(), polyPatch(), polyPatch(), symmetryPlanePolyPatch::symmetryPlanePolyPatch(), symmetryPlanePolyPatch::symmetryPlanePolyPatch(), symmetryPlanePolyPatch::symmetryPlanePolyPatch(), symmetryPlanePolyPatch::symmetryPlanePolyPatch(), symmetryPlanePolyPatch::symmetryPlanePolyPatch(), symmetryPolyPatch::symmetryPolyPatch(), symmetryPolyPatch::symmetryPolyPatch(), symmetryPolyPatch::symmetryPolyPatch(), symmetryPolyPatch::symmetryPolyPatch(), symmetryPolyPatch::symmetryPolyPatch(), coupledPolyPatch::TypeName(), emptyPolyPatch::TypeName(), genericPolyPatch::TypeName(), mappedPolyPatch::TypeName(), oversetPolyPatch::TypeName(), symmetryPlanePolyPatch::TypeName(), symmetryPolyPatch::TypeName(), wallPolyPatch::TypeName(), wedgePolyPatch::TypeName(), wallPolyPatch::wallPolyPatch(), wallPolyPatch::wallPolyPatch(), wallPolyPatch::wallPolyPatch(), wallPolyPatch::wallPolyPatch(), wallPolyPatch::wallPolyPatch(), wedgePolyPatch::wedgePolyPatch(), wedgePolyPatch::wedgePolyPatch(), wedgePolyPatch::wedgePolyPatch(), wedgePolyPatch::wedgePolyPatch(), and wedgePolyPatch::wedgePolyPatch().

operator<<

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

friend

References polyPatch().

Member Data Documentation

disallowGenericPolyPatch

int disallowGenericPolyPatch

static

Debug switch to disallow the use of genericPolyPatch.

Definition at line 164 of file polyPatch.H.

Referenced by New().

---

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

• src/OpenFOAM/meshes/polyMesh/polyPatches/polyPatch/polyPatch.H
• src/OpenFOAM/meshes/polyMesh/polyPatches/polyPatch/polyPatch.C
• src/OpenFOAM/meshes/polyMesh/polyPatches/polyPatch/polyPatchNew.C