The coupledPolyPatch is an abstract base class for patches that couple regions of the computational domain e.g. cyclic and processor-processor links. More...

Inheritance diagram for coupledPolyPatch:

[legend]

Collaboration diagram for coupledPolyPatch:

[legend]

Public Types
enum	transformType { UNKNOWN, ROTATIONAL, TRANSLATIONAL, COINCIDENTFULLMATCH, NOORDERING }

Public Types inherited from PrimitivePatch< FaceList, PointField >
enum	surfaceTopo { MANIFOLD, OPEN, ILLEGAL }
	Enumeration defining the surface type. Used in check routines. More...

typedef std::remove_reference< FaceList >::type::value_type	face_type
	The face type. More...

typedef std::remove_reference< PointField >::type::value_type	point_type
	The point type. More...

typedef FaceList	FaceListType
	The face list type. More...

typedef PointField	PointFieldType
	The point field type. More...

typedef face_type	FaceType
	Deprecated(2020-03) prefer face_type typedef. More...

Public Member Functions
	TypeName ("coupled")
	Runtime type information. More...

	coupledPolyPatch (const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType, const transformType transform)
	Construct from components. More...

	coupledPolyPatch (const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm, const word &patchType)
	Construct from dictionary. More...

	coupledPolyPatch (const coupledPolyPatch &, const polyBoundaryMesh &bm)
	Copy construct, resetting the boundary mesh. More...

	coupledPolyPatch (const coupledPolyPatch &, const labelList &faceCells)
	Copy construct, resetting the faceCells. More...

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

	coupledPolyPatch (const coupledPolyPatch &pp, const polyBoundaryMesh &bm, const label index, const labelUList &mapAddressing, const label newStart)
	Construct given the original patch and a map. More...

virtual	~coupledPolyPatch ()
	Destructor. More...

virtual bool	coupled () const
	Return true because this patch is coupled. More...

virtual bool	owner () const =0
	Does this side own the patch ? More...

virtual bool	neighbour () const
	Does the coupled side own the patch ? More...

virtual transformType	transform () const
	Type of transform. More...

virtual transformType &	transform ()
	Type of transform. More...

virtual void	transformPosition (pointField &) const =0
	Transform a patch-based position from other side to this side. More...

virtual void	transformPosition (point &, const label facei) const =0
	Transform a patch-based position from other side to this side. More...

virtual bool	separated () const
	Are the planes separated. More...

virtual const vectorField &	separation () const
	If the planes are separated the separation vector. More...

virtual bool	parallel () const
	Are the cyclic planes parallel. More...

virtual const tensorField &	forwardT () const
	Return face transformation tensor. More...

virtual const tensorField &	reverseT () const
	Return neighbour-cell transformation tensor. More...

virtual const boolList &	collocated () const
	Are faces collocated. Either size 0,1 or length of patch. More...

scalar	matchTolerance () const

virtual void	calcGeometry (const primitivePatch &referPatch, const pointField &thisCtrs, const vectorField &thisAreas, const pointField &thisCc, const pointField &nbrCtrs, const vectorField &nbrAreas, const pointField &nbrCc)=0
	Calculate the patch geometry. More...

virtual void	initOrder (PstreamBuffers &, const primitivePatch &) const =0
	Initialize ordering for primitivePatch. Does not. More...

virtual bool	order (PstreamBuffers &, const primitivePatch &, labelList &faceMap, labelList &rotation) const =0
	Return new ordering for primitivePatch. More...

virtual void	write (Ostream &os) const
	Write the polyPatch data as a dictionary. More...

Public Member Functions inherited from polyPatch
	TypeName ("patch")
	Runtime type information. More...

	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. More...

	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. More...

	polyPatch (const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm, const word &patchType)
	Construct from dictionary. More...

	polyPatch (const polyPatch &, const polyBoundaryMesh &)
	Copy construct, resetting the boundary mesh. More...

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

	polyPatch (const polyPatch &pp, const polyBoundaryMesh &bm, const label index, const labelUList &mapAddressing, const label newStart)
	Construct given the original patch and a map. More...

	polyPatch (const polyPatch &p)
	Copy construct. More...

	polyPatch (const polyPatch &p, const labelList &faceCells)
	Copy construct, setting faceCells. More...

virtual autoPtr< polyPatch >	clone (const labelList &faceCells) const
	Construct and return a clone, setting faceCells. More...

virtual autoPtr< polyPatch >	clone (const polyBoundaryMesh &bm) const
	Construct and return a clone, resetting the boundary mesh. More...

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

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

virtual	~polyPatch ()
	Destructor. More...

virtual void	newInternalProcFaces (label &, label &) const
	Return number of new internal of this polyPatch faces. More...

virtual const labelUList &	nbrCells () const
	Return nbrCells. More...

virtual label	neighbPolyPatchID () const
	Return nbr patchID. More...

virtual refPtr< labelListList >	mapCollocatedFaces () const
	Return mapped collocated faces. More...

virtual bool	masterImplicit () const
	Return implicit master. More...

virtual word	neighbRegionID () const
	Return neighbour region name. More...

label	offset () const
	The offset where this patch starts in the boundary face list. More...

label	start () const
	Return start label of this patch in the polyMesh face list. More...

labelRange	range () const
	Return start/size range of this patch. More...

const polyBoundaryMesh &	boundaryMesh () const
	Return boundaryMesh reference. More...

template<class T >
const UIndirectList< T >	patchInternalList (const UList< T > &internalValues) const
	Extract face cell data. More...

template<class T >
const List< T >::subList	patchSlice (const UList< T > &l) const
	Slice list to patch. More...

template<class T >
const Field< T >::subField	patchSlice (const Field< T > &l) const
	Slice Field to patch. More...

const vectorField::subField	faceCentres () const
	Return face centres. More...

const vectorField::subField	faceAreas () const
	Return face normals. More...

tmp< vectorField >	faceCellCentres () const
	Return face cell centres. More...

tmp< scalarField >	areaFraction () const

const labelUList &	faceCells () const
	Return face-cell addressing. More...

const labelList &	meshEdges () const
	Return global edge index for local edges. More...

virtual void	clearAddressing ()
	Clear addressing. More...

label	whichFace (const label l) const
	Return label of face in patch from global face label. More...

virtual bool	changeTopology () const

virtual bool	setTopology (polyTopoChange &)
	Collect topology changes in a polyTopoChange object. More...

void	operator= (const polyPatch &)
	Assignment. More...

Public Member Functions inherited from patchIdentifier
	patchIdentifier (const patchIdentifier &)=default
	Copy construct. More...

patchIdentifier &	operator= (const patchIdentifier &)=default
	Copy assignment. More...

virtual	~patchIdentifier ()=default
	Destructor. More...

	patchIdentifier ()
	Default construct. Uses name="", index=0. More...

	patchIdentifier (const word &name, const label index)
	Construct from mandatory components. More...

	patchIdentifier (const word &name, const label index, const word &physicalType, const wordList &inGroups=wordList())
	Construct from components. More...

	patchIdentifier (const word &name, const dictionary &dict, const label index)
	Construct from dictionary. More...

	patchIdentifier (const patchIdentifier &ident, const label index)
	Copy construct, resetting the index. More...

const word &	name () const noexcept
	The patch name. More...

word &	name () noexcept
	Modifiable patch name. More...

label	index () const noexcept
	The index of this patch in the boundaryMesh. More...

label &	index () noexcept
	Modifiable index of this patch in the boundaryMesh. More...

const word &	physicalType () const noexcept
	The (optional) physical type of the patch. More...

word &	physicalType () noexcept
	Modifiable (optional) physical type of the patch. More...

const wordList &	inGroups () const noexcept
	The (optional) groups that the patch belongs to. More...

wordList &	inGroups () noexcept
	Modifiable (optional) groups that the patch belongs to. More...

bool	inGroup (const word &name) const
	True if given name is in a group. More...

void	write (Ostream &os) const

Public Member Functions inherited from PrimitivePatch< FaceList, PointField >
	PrimitivePatch (const FaceList &faces, const PointField &points)
	Construct from components. More...

	PrimitivePatch (FaceList &&faces, const PointField &points)
	Construct from components, transferring faces. More...

	PrimitivePatch (FaceList &faces, PointField &points, const bool reuse)
	Construct from components, reuse storage. More...

	PrimitivePatch (const PrimitivePatch< FaceList, PointField > &pp)
	Copy construct. More...

virtual	~PrimitivePatch ()
	Destructor. More...

void	clearOut ()

void	clearGeom ()

void	clearTopology ()

void	clearPatchMeshAddr ()

void	swap (PrimitivePatch &)=delete
	Suppress direct swapping, since storage containers may be const. More...

const Field< point_type > &	points () const noexcept
	Return reference to global points. More...

label	nFaces () const noexcept
	Number of faces in the patch. More...

label	nPoints () const
	Number of points supporting patch faces. More...

label	nEdges () const
	Number of edges in patch. More...

const edgeList &	edges () const
	Return list of edges, address into LOCAL point list. More...

const edgeList::subList	internalEdges () const
	Return sub-list of internal edges, address into LOCAL point list. More...

const edgeList::subList	boundaryEdges () const
	Return sub-list of boundary edges, address into LOCAL point list. More...

label	nInternalEdges () const
	Number of internal edges. More...

label	nBoundaryEdges () const
	Number of boundary edges == (nEdges() - nInternalEdges()) More...

bool	isInternalEdge (const label edgei) const
	Is internal edge? More...

const labelList &	boundaryPoints () const
	Return list of boundary points, address into LOCAL point list. More...

const labelListList &	faceFaces () const
	Return face-face addressing. More...

const labelListList &	edgeFaces () const
	Return edge-face addressing. More...

const labelListList &	faceEdges () const
	Return face-edge addressing. More...

const labelListList &	pointEdges () const
	Return point-edge addressing. More...

const labelListList &	pointFaces () const
	Return point-face addressing. More...

const List< face_type > &	localFaces () const
	Return patch faces addressing into local point list. More...

labelList	boundaryFaces () const

labelList	uniqBoundaryFaces () const

const labelList &	meshPoints () const
	Return labelList of mesh points in patch. More...

const Map< label > &	meshPointMap () const
	Mesh point map. More...

const Field< point_type > &	localPoints () const
	Return pointField of points in patch. More...

const labelList &	localPointOrder () const
	Return orders the local points for most efficient search. More...

label	whichPoint (const label gp) const
	Given a global point index, return the local point index. More...

edge	meshEdge (const label edgei) const
	From patch edge to global edge using meshPoints. More...

edge	meshEdge (const edge &e) const
	From patch edge to global edge using meshPoints. More...

label	findEdge (const edge &e) const

labelList	meshEdges (const edgeList &allEdges, const labelListList &cellEdges, const labelList &faceCells) const

labelList	meshEdges (const edgeList &allEdges, const labelListList &pointEdges) const

label	meshEdge (const label edgei, const edgeList &allEdges, const labelListList &pointEdges) const

labelList	meshEdges (const labelUList &edgeLabels, const edgeList &allEdges, const labelListList &pointEdges) const

const Field< point_type > &	faceCentres () const
	Return face centres for patch. More...

const Field< point_type > &	faceAreas () const
	Return face area vectors for patch. More...

const Field< scalar > &	magFaceAreas () const
	Return face area magnitudes for patch. More...

const Field< point_type > &	faceNormals () const
	Return face unit normals for patch. More...

const Field< point_type > &	pointNormals () const
	Return point normals for patch. More...

bool	hasFaceAreas () const

bool	hasFaceCentres () const

bool	hasFaceNormals () const

bool	hasPointNormals () const

bool	hasBoundaryPoints () const

bool	hasFaceFaces () const

bool	hasEdgeFaces () const

bool	hasFaceEdges () const

bool	hasPointEdges () const

bool	hasPointFaces () const

bool	hasMeshPointMap () const

template<class ToPatch >
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. More...

template<class ToPatch >
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. More...

const labelListList &	edgeLoops () const
	Return list of closed loops of boundary vertices. More...

surfaceTopo	surfaceType () const
	Calculate surface type formed by patch. More...

bool	checkTopology (const bool report=false, labelHashSet *setPtr=nullptr) const
	Check surface formed by patch for manifoldness (see above). More...

bool	checkPointManifold (const bool report=false, labelHashSet *setPtr=nullptr) const
	Checks primitivePatch for faces sharing point but not edge. More...

virtual void	movePoints (const Field< point_type > &)
	Correct patch after moving points. More...

void	operator= (const PrimitivePatch< FaceList, PointField > &rhs)
	Copy assign faces. Leave points alone (could be a reference). More...

void	operator= (PrimitivePatch< FaceList, PointField > &&rhs)
	Move assign faces. Leave points alone (could be a reference). More...

label	whichEdge (const edge &e) const
	Identical to findEdge. More...

template<class ToPatch >
Foam::List< Foam::objectHit >	projectPoints (const ToPatch &targetPatch, const Field< typename Foam::PrimitivePatch< FaceList, PointField >::point_type > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const

template<class ToPatch >
Foam::List< Foam::objectHit >	projectFaceCentres (const ToPatch &targetPatch, const Field< typename Foam::PrimitivePatch< FaceList, PointField >::point_type > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const

Public Member Functions inherited from PrimitivePatchBase
	ClassName ("PrimitivePatch")
	Runtime type information. More...

	PrimitivePatchBase ()=default
	Default construct. More...

Static Public Member Functions
static scalarField	calcFaceTol (const UList< face > &faces, const pointField &points, const pointField &faceCentres)
	Calculate typical tolerance per face. Is currently max distance. More...

Static Public Member Functions inherited from polyPatch
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. More...

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. More...

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. More...

static bool	constraintType (const word &pt)
	Return true if the given type is a constraint type. More...

static wordList	constraintTypes ()
	Return a list of all the constraint patch types. More...

Static Public Member Functions inherited from patchIdentifier
static word	defaultName (const label n=-1)
	Default patch name: "patch" or "patchN". More...

Static Public Attributes
static const Enum< transformType >	transformTypeNames

Static Public Attributes inherited from polyPatch
static int	disallowGenericPolyPatch
	Debug switch to disallow the use of genericPolyPatch. More...

Protected Member Functions
void	calcTransformTensors (const vectorField &Cf, const vectorField &Cr, const vectorField &nf, const vectorField &nr, const scalarField &smallDist, const scalar absTol, const transformType=UNKNOWN) const
	Calculate the transformation tensors. More...

virtual void	initGeometry (PstreamBuffers &)=0
	Initialise the calculation of the patch geometry. More...

virtual void	calcGeometry (PstreamBuffers &)=0
	Calculate the patch geometry. More...

virtual void	initMovePoints (PstreamBuffers &, const pointField &)=0
	Initialise the patches for moving points. More...

virtual void	movePoints (PstreamBuffers &, const pointField &)=0
	Correct patches after moving points. More...

virtual void	initUpdateMesh (PstreamBuffers &)=0
	Initialise the update of the patch topology. More...

virtual void	updateMesh (PstreamBuffers &)=0
	Update of the patch topology. More...

Protected Member Functions inherited from polyPatch
virtual void	clearGeom ()
	Clear geometry. More...

virtual void	movePoints (const Field< point_type > &)
	Inherit movePoints from primitivePatch. More...

Static Protected Member Functions
static void	writeOBJ (Ostream &os, const point &pt)
	Write point in OBJ format. More...

static void	writeOBJ (Ostream &, const pointField &, const labelList &)
	Write selected points in OBJ format. More...

static void	writeOBJ (const fileName &, const UList< face > &, const pointField &)
	Write patch. More...

static void	writeOBJ (Ostream &os, const point &p0, const point &p1, label &vertI)
	Write edge in OBJ format. More...

static pointField	getAnchorPoints (const UList< face > &, const pointField &, const transformType)
	Get a unique anchor point for all faces. More...

static label	getRotation (const pointField &points, const face &f, const point &anchor, const scalar tol)
	Get the number of vertices face f needs to be rotated such that. More...

Detailed Description

The coupledPolyPatch is an abstract base class for patches that couple regions of the computational domain e.g. cyclic and processor-processor links.

Source files

Definition at line 54 of file coupledPolyPatch.H.

Member Enumeration Documentation

◆ transformType

enum transformType

Enumerator
UNKNOWN
ROTATIONAL
TRANSLATIONAL
COINCIDENTFULLMATCH
NOORDERING

Definition at line 60 of file coupledPolyPatch.H.

Constructor & Destructor Documentation

◆ coupledPolyPatch() [1/6]

coupledPolyPatch	(	const word &	name,
		const label	size,
		const label	start,
		const label	index,
		const polyBoundaryMesh &	bm,
		const word &	patchType,
		const transformType	transform
	)

Construct from components.

Definition at line 476 of file coupledPolyPatch.C.

◆ coupledPolyPatch() [2/6]

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

Construct from dictionary.

Definition at line 493 of file coupledPolyPatch.C.

◆ coupledPolyPatch() [3/6]

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

Copy construct, resetting the boundary mesh.

Definition at line 516 of file coupledPolyPatch.C.

◆ coupledPolyPatch() [4/6]

coupledPolyPatch	(	const coupledPolyPatch &	pp,
		const labelList &	faceCells
	)

Copy construct, resetting the faceCells.

Definition at line 528 of file coupledPolyPatch.C.

◆ coupledPolyPatch() [5/6]

coupledPolyPatch	(	const coupledPolyPatch &	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 540 of file coupledPolyPatch.C.

◆ coupledPolyPatch() [6/6]

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

Construct given the original patch and a map.

Definition at line 555 of file coupledPolyPatch.C.

◆ ~coupledPolyPatch()

~coupledPolyPatch ( )

virtual

Destructor.

Definition at line 571 of file coupledPolyPatch.C.

Member Function Documentation

◆ calcTransformTensors()

void calcTransformTensors	(	const vectorField &	Cf,
		const vectorField &	Cr,
		const vectorField &	nf,
		const vectorField &	nr,
		const scalarField &	smallDist,
		const scalar	absTol,
		const transformType	transform = `UNKNOWN`
	)		const

protected

Calculate the transformation tensors.

smallDist : matching distance per face absTol : absolute error in normal if transformType = unknown it first tries rotational, then translational transform

Definition at line 295 of file coupledPolyPatch.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), forAll, Foam::mag(), Foam::magSqr(), Foam::max(), Foam::min(), Foam::name(), Foam::nl, Foam::Pout, Foam::rotationTensor(), Foam::sqr(), Foam::sqrt(), Foam::sum(), and Foam::transform().

Here is the call graph for this function:

◆ initGeometry()

virtual void initGeometry ( PstreamBuffers & )

protectedpure virtual

Initialise the calculation of the patch geometry.

Reimplemented from polyPatch.

Implemented in cyclicAMIPolyPatch, cyclicACMIPolyPatch, oldCyclicPolyPatch, cyclicPolyPatch, processorPolyPatch, and processorCyclicPolyPatch.

◆ calcGeometry() [1/2]

virtual void calcGeometry ( PstreamBuffers & )

protectedpure virtual

Calculate the patch geometry.

Reimplemented from polyPatch.

Implemented in cyclicAMIPolyPatch, cyclicACMIPolyPatch, cyclicPolyPatch, oldCyclicPolyPatch, processorPolyPatch, and processorCyclicPolyPatch.

Referenced by processorCyclicPolyPatch::calcGeometry().

Here is the caller graph for this function:

◆ initMovePoints()

virtual void initMovePoints	(	PstreamBuffers &	,
		const pointField &
	)

protectedpure virtual

Initialise the patches for moving points.

Reimplemented from polyPatch.

Implemented in cyclicAMIPolyPatch, cyclicACMIPolyPatch, cyclicPolyPatch, oldCyclicPolyPatch, processorPolyPatch, and processorCyclicPolyPatch.

◆ movePoints()

virtual void movePoints	(	PstreamBuffers &	,
		const pointField &
	)

protectedpure virtual

Correct patches after moving points.

Reimplemented from polyPatch.

Implemented in cyclicAMIPolyPatch, cyclicACMIPolyPatch, cyclicPolyPatch, oldCyclicPolyPatch, processorPolyPatch, and processorCyclicPolyPatch.

◆ initUpdateMesh()

virtual void initUpdateMesh ( PstreamBuffers & )

protectedpure virtual

Initialise the update of the patch topology.

Reimplemented from polyPatch.

Implemented in cyclicAMIPolyPatch, cyclicPolyPatch, cyclicACMIPolyPatch, oldCyclicPolyPatch, processorPolyPatch, and processorCyclicPolyPatch.

◆ updateMesh()

virtual void updateMesh ( PstreamBuffers & )

protectedpure virtual

Update of the patch topology.

Reimplemented from polyPatch.

Implemented in cyclicAMIPolyPatch, cyclicPolyPatch, cyclicACMIPolyPatch, oldCyclicPolyPatch, processorPolyPatch, and processorCyclicPolyPatch.

◆ writeOBJ() [1/4]

void writeOBJ	(	Ostream &	os,
		const point &	pt
	)

staticprotected

Write point in OBJ format.

Definition at line 60 of file coupledPolyPatch.C.

References Foam::endl(), os(), Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().

Here is the call graph for this function:

◆ writeOBJ() [2/4]

void writeOBJ	(	Ostream &	os,
		const pointField &	points,
		const labelList &	pointLabels
	)

staticprotected

Write selected points in OBJ format.

Definition at line 67 of file coupledPolyPatch.C.

References os(), pointLabels(), points, and Foam::meshTools::writeOBJ().

Here is the call graph for this function:

◆ writeOBJ() [3/4]

void writeOBJ	(	const fileName &	fName,
		const UList< face > &	faces,
		const pointField &	points
	)

staticprotected

Write patch.

Definition at line 99 of file coupledPolyPatch.C.

References f(), forAll, Foam::nl, os(), points, UList< T >::size(), and Foam::meshTools::writeOBJ().

Here is the call graph for this function:

◆ writeOBJ() [4/4]

void writeOBJ	(	Ostream &	os,
		const point &	p0,
		const point &	p1,
		label &	vertI
	)

staticprotected

Write edge in OBJ format.

Definition at line 81 of file coupledPolyPatch.C.

References Foam::nl, os(), p0, and Foam::meshTools::writeOBJ().

Here is the call graph for this function:

◆ getAnchorPoints()

Foam::pointField getAnchorPoints	(	const UList< face > &	faces,
		const pointField &	points,
		const transformType	transform
	)

staticprotected

Get a unique anchor point for all faces.

Definition at line 133 of file coupledPolyPatch.C.

References f(), forAll, points, UList< T >::size(), and Foam::transform().

Here is the call graph for this function:

◆ getRotation()

Foam::label getRotation	(	const pointField &	points,
		const face &	f,
		const point &	anchor,
		const scalar	tol
	)

staticprotected

Get the number of vertices face f needs to be rotated such that.

its f[0] point aligns with given anchor (within tol).

Definition at line 241 of file coupledPolyPatch.C.

References Foam::endl(), f(), forAll, Foam::magSqr(), Foam::nl, points, Foam::sqrt(), and WarningInFunction.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "coupled" )

Runtime type information.

◆ coupled()

virtual bool coupled ( ) const

inlinevirtual

Return true because this patch is coupled.

Reimplemented from polyPatch.

Reimplemented in cyclicAMIPolyPatch, and processorPolyPatch.

Definition at line 248 of file coupledPolyPatch.H.

Referenced by coupledFvPatch::coupled().

Here is the caller graph for this function:

◆ owner()

virtual bool owner ( ) const

pure virtual

Does this side own the patch ?

Implemented in cyclicAMIPolyPatch, cyclicPolyPatch, processorCyclicPolyPatch, processorPolyPatch, and oldCyclicPolyPatch.

Referenced by polyMeshTetDecomposition::findFaceBasePts(), coupledPolyPatch::neighbour(), and processorCyclicPolyPatch::owner().

Here is the caller graph for this function:

◆ neighbour()

virtual bool neighbour ( ) const

inlinevirtual

Does the coupled side own the patch ?

Reimplemented in cyclicPolyPatch, and processorPolyPatch.

Definition at line 257 of file coupledPolyPatch.H.

References coupledPolyPatch::owner().

Here is the call graph for this function:

◆ transform() [1/2]

virtual transformType transform ( ) const

inlinevirtual

Type of transform.

Reimplemented in processorCyclicPolyPatch.

Definition at line 263 of file coupledPolyPatch.H.

Referenced by processorCyclicPolyPatch::transform().

Here is the caller graph for this function:

◆ transform() [2/2]

virtual transformType& transform ( )

inlinevirtual

Type of transform.

This is currently only for use when collapsing generated meshes that can have zero area faces.

Reimplemented in processorCyclicPolyPatch.

Definition at line 271 of file coupledPolyPatch.H.

◆ transformPosition() [1/2]

virtual void transformPosition ( pointField & ) const

pure virtual

Transform a patch-based position from other side to this side.

Implemented in cyclicPolyPatch, processorCyclicPolyPatch, processorPolyPatch, oldCyclicPolyPatch, and cyclicAMIPolyPatch.

Referenced by weightedPosition::operator()(), mapDistribute::transformPosition::operator()(), and processorCyclicPolyPatch::transformPosition().

Here is the caller graph for this function:

◆ transformPosition() [2/2]

virtual void transformPosition	(	point &	,
		const label	facei
	)		const

pure virtual

Transform a patch-based position from other side to this side.

Implemented in cyclicAMIPolyPatch, processorCyclicPolyPatch, cyclicPolyPatch, processorPolyPatch, and oldCyclicPolyPatch.

◆ separated()

virtual bool separated ( ) const

inlinevirtual

Are the planes separated.

Reimplemented in processorCyclicPolyPatch.

Definition at line 283 of file coupledPolyPatch.H.

Referenced by particle< Type >::correctAfterParallelTransfer(), extendedCellToCellStencil::extendedCellToCellStencil(), extendedCellToFaceStencil::extendedCellToFaceStencil(), extendedFaceToCellStencil::extendedFaceToCellStencil(), particle< Type >::hitCyclicAMIPatch(), particle< Type >::hitCyclicPatch(), motionSmootherAlgo::scaleMesh(), and processorCyclicPolyPatch::separated().

Here is the caller graph for this function:

◆ separation()

virtual const vectorField& separation ( ) const

inlinevirtual

If the planes are separated the separation vector.

Reimplemented in processorCyclicPolyPatch.

Definition at line 289 of file coupledPolyPatch.H.

Referenced by particle< Type >::correctAfterParallelTransfer(), particle< Type >::hitCyclicAMIPatch(), particle< Type >::hitCyclicPatch(), and processorCyclicPolyPatch::separation().

Here is the caller graph for this function:

◆ parallel()

virtual bool parallel ( ) const

inlinevirtual

Are the cyclic planes parallel.

Reimplemented in processorCyclicPolyPatch.

Definition at line 295 of file coupledPolyPatch.H.

Referenced by particle< Type >::correctAfterParallelTransfer(), cyclicAMIPolyPatch::cylindricalCS(), processorPointPatchField< Type >::doTransform(), processorCyclicPointPatchField< Type >::doTransform(), extendedCellToCellStencil::extendedCellToCellStencil(), extendedCellToFaceStencil::extendedCellToFaceStencil(), extendedFaceToCellStencil::extendedFaceToCellStencil(), FaceCellWave< Type, TrackingData >::handleProcPatches(), particle< Type >::hitCyclicAMIPatch(), particle< Type >::hitCyclicPatch(), mapDistribute::transform::operator()(), cyclicFvPatch::parallel(), processorFvPatch::parallel(), cyclicPointPatch::parallel(), cyclicAMIPointPatch::parallel(), cyclicACMIPointPatch::parallel(), cyclicACMIFvPatch::parallel(), cyclicAMIFvPatch::parallel(), processorCyclicPolyPatch::parallel(), and motionSmootherAlgo::scaleMesh().

Here is the caller graph for this function:

◆ forwardT()

virtual const tensorField& forwardT ( ) const

inlinevirtual

Return face transformation tensor.

Reimplemented in processorCyclicPolyPatch.

Definition at line 301 of file coupledPolyPatch.H.

Referenced by particle< Type >::correctAfterParallelTransfer(), cyclicFvPatch::forwardT(), processorFvPatch::forwardT(), cyclicPointPatch::forwardT(), cyclicAMIPointPatch::forwardT(), cyclicACMIPointPatch::forwardT(), cyclicACMIFvPatch::forwardT(), cyclicAMIFvPatch::forwardT(), processorCyclicPolyPatch::forwardT(), FaceCellWave< Type, TrackingData >::handleProcPatches(), particle< Type >::hitCyclicAMIPatch(), particle< Type >::hitCyclicPatch(), mapDistribute::transform::operator()(), and motionSmootherAlgo::scaleMesh().

Here is the caller graph for this function:

◆ reverseT()

virtual const tensorField& reverseT ( ) const

inlinevirtual

Return neighbour-cell transformation tensor.

Reimplemented in processorCyclicPolyPatch.

Definition at line 307 of file coupledPolyPatch.H.

Referenced by cyclicFvPatch::reverseT(), processorFvPatch::reverseT(), cyclicPointPatch::reverseT(), cyclicAMIPointPatch::reverseT(), cyclicACMIPointPatch::reverseT(), cyclicACMIFvPatch::reverseT(), cyclicAMIFvPatch::reverseT(), and processorCyclicPolyPatch::reverseT().

Here is the caller graph for this function:

◆ collocated()

virtual const boolList& collocated ( ) const

inlinevirtual

Are faces collocated. Either size 0,1 or length of patch.

Reimplemented in processorCyclicPolyPatch.

Definition at line 313 of file coupledPolyPatch.H.

Referenced by processorCyclicPolyPatch::collocated().

Here is the caller graph for this function:

◆ matchTolerance()

scalar matchTolerance ( ) const

inline

Definition at line 318 of file coupledPolyPatch.H.

◆ calcGeometry() [2/2]

virtual void calcGeometry	(	const primitivePatch &	referPatch,
		const pointField &	thisCtrs,
		const vectorField &	thisAreas,
		const pointField &	thisCc,
		const pointField &	nbrCtrs,
		const vectorField &	nbrAreas,
		const pointField &	nbrCc
	)

pure virtual

Calculate the patch geometry.

Implemented in cyclicAMIPolyPatch, oldCyclicPolyPatch, cyclicPolyPatch, processorPolyPatch, and processorCyclicPolyPatch.

◆ initOrder()

virtual void initOrder	(	PstreamBuffers &	,
		const primitivePatch &
	)		const

pure virtual

Initialize ordering for primitivePatch. Does not.

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

Reimplemented from polyPatch.

Implemented in cyclicAMIPolyPatch, cyclicPolyPatch, processorCyclicPolyPatch, cyclicACMIPolyPatch, processorPolyPatch, and oldCyclicPolyPatch.

◆ order()

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

pure 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 from polyPatch.

Implemented in cyclicAMIPolyPatch, cyclicPolyPatch, processorCyclicPolyPatch, processorPolyPatch, cyclicACMIPolyPatch, and oldCyclicPolyPatch.

◆ calcFaceTol()

Foam::scalarField calcFaceTol	(	const UList< face > &	faces,
		const pointField &	points,
		const pointField &	faceCentres
	)

static

Calculate typical tolerance per face. Is currently max distance.

from face centre to any of the face vertices.

Definition at line 201 of file coupledPolyPatch.C.

References Foam::cmptMag(), Foam::cmptMax(), f(), forAll, Foam::magSqr(), Foam::max(), points, UList< T >::size(), and Foam::sqrt().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write the polyPatch data as a dictionary.

Reimplemented from polyPatch.

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

Definition at line 577 of file coupledPolyPatch.C.

References os(), polyPatch::write(), and Ostream::writeEntry().

Referenced by processorPolyPatch::write(), cyclicPolyPatch::write(), and cyclicAMIPolyPatch::write().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ transformTypeNames

const Foam::Enum< Foam::coupledPolyPatch::transformType > transformTypeNames

static

Definition at line 70 of file coupledPolyPatch.H.

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

src/OpenFOAM/meshes/polyMesh/polyPatches/basic/coupled/coupledPolyPatch.H
src/OpenFOAM/meshes/polyMesh/polyPatches/basic/coupled/coupledPolyPatch.C

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ transformType

Constructor & Destructor Documentation

◆ coupledPolyPatch() [1/6]

◆ coupledPolyPatch() [2/6]

◆ coupledPolyPatch() [3/6]

◆ coupledPolyPatch() [4/6]

◆ coupledPolyPatch() [5/6]

◆ coupledPolyPatch() [6/6]

◆ ~coupledPolyPatch()

Member Function Documentation

◆ calcTransformTensors()

◆ initGeometry()

◆ calcGeometry() [1/2]

◆ initMovePoints()

◆ movePoints()

◆ initUpdateMesh()

◆ updateMesh()

◆ writeOBJ() [1/4]

◆ writeOBJ() [2/4]

◆ writeOBJ() [3/4]

◆ writeOBJ() [4/4]

◆ getAnchorPoints()

◆ getRotation()

◆ TypeName()

◆ coupled()

◆ owner()

◆ neighbour()

◆ transform() [1/2]

◆ transform() [2/2]

◆ transformPosition() [1/2]

◆ transformPosition() [2/2]

◆ separated()

◆ separation()

◆ parallel()

◆ forwardT()

◆ reverseT()

◆ collocated()

◆ matchTolerance()

◆ calcGeometry() [2/2]

◆ initOrder()

◆ order()

◆ calcFaceTol()

◆ write()

Member Data Documentation

◆ transformTypeNames