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]

Classes
struct	ownToNbrDebugOrderData
	Data to pass from owner.initOrder to nbr.order if debugging. More...

struct	ownToNbrOrderData
	Data to pass from owner.initOrder to nbr.order. More...

struct	ownToOwnOrderData
	Data to pass from owner.initOrder to owner.order. 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)
	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 &)
	Construct as copy, resetting the boundary mesh. More...

	coupledPolyPatch (const coupledPolyPatch &pp, const polyBoundaryMesh &bm, const label index, const label newSize, const label newStart)
	Construct given the original patch and resetting the. More...

	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 const transformer &	transform () const =0
	Return transformation between the coupled patches. More...

scalar	matchTolerance () const
	Return the matching tolerance. More...

virtual void	initOrder (PstreamBuffers &, const primitivePatch &) const =0
	Initialise 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 &) 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 dictionary &dict, const label index, const polyBoundaryMesh &bm, const word &patchType)
	Construct from dictionary. More...

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

	polyPatch (const polyPatch &pp, const polyBoundaryMesh &bm, const label index, const label newSize, const label newStart)
	Construct given the original patch and resetting the. More...

	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 &)
	Copy constructor. 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
	Construct and return a clone, resetting the face list. More...

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

virtual	~polyPatch ()
	Destructor. More...

label	start () const
	Return start label of this patch in the polyMesh face list. 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 areas. More...

const scalarField::subField	magFaceAreas () const
	Return face area magnitudes. More...

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

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

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

Public Member Functions inherited from patchIdentifier
	patchIdentifier (const word &name, const label index, const word &physicalType=word::null, const wordList &inGroups=wordList())
	Construct from components. More...

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

	patchIdentifier (const patchIdentifier &, const label index)
	Construct from geometric patch, resetting the index. More...

virtual	~patchIdentifier ()
	Destructor. More...

const word &	name () const
	Return name. More...

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

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

word &	physicalType ()
	Return the optional physical type of the patch for modification. More...

const wordList &	inGroups () const
	Return the optional groups patch belongs to. More...

wordList &	inGroups ()
	Return the optional groups patch belongs to for modification. More...

bool	inGroup (const word &) const
	Test if in group. More...

void	write (Ostream &) const
	Write patchIdentifier as a dictionary. More...

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

	PrimitivePatch (FaceList &&faces, Field< PointType > &&points)
	Move constructor from components. More...

	PrimitivePatch (FaceList &faces, Field< PointType > &points, const bool reuse)
	Construct from components, reuse storage. More...

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

	PrimitivePatch (PrimitivePatch< FaceList, PointField > &&)
	Move constructor. More...

autoPtr< PrimitivePatch< FaceList, PointField > >	clone () const
	Construct and return a clone. More...

	~PrimitivePatch ()
	Destructor. More...

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

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

label	nEdges () const
	Return number of edges in patch. More...

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

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

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

const labelList &	boundaryPoints () const
	Return list of boundary points,. 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< FaceType > &	localFaces () const
	Return patch faces addressing into local point list. More...

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

const Map< label > &	meshPointMap () const
	Mesh point map. Given the global point index find its. More...

const Field< PointType > &	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...

label	whichEdge (const edge &) const
	Given an edge in local point labels, return its. More...

labelList	meshEdges (const edgeList &allEdges, const labelListList &cellEdges, const labelList &faceCells) const
	Return labels of patch edges in the global edge list using. More...

labelList	meshEdges (const edgeList &allEdges, const labelListList &pointEdges) const
	Return labels of patch edges in the global edge list using. More...

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

const Field< PointType > &	faceAreas () const
	Return face areas for patch. More...

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

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

template<class ToPatch >
List< objectHit >	projectPoints (const ToPatch &targetPatch, const Field< PointType > &projectionDirection, const intersection::algorithm=intersection::algorithm::fullRay, const intersection::direction=intersection::direction::vector) const
	Project vertices of patch onto another patch. More...

template<class ToPatch >
List< objectHit >	projectFaceCentres (const ToPatch &targetPatch, const Field< PointType > &projectionDirection, const intersection::algorithm=intersection::algorithm::fullRay, const intersection::direction=intersection::direction::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...

void	clearOut ()

void	clearGeom ()

void	clearTopology ()

void	clearPatchMeshAddr ()

void	operator= (const PrimitivePatch< FaceList, PointField > &)
	Assignment operator. More...

void	operator= (PrimitivePatch< FaceList, PointField > &&)
	Move assignment operator. More...

template<class ToPatch >
Foam::List< Foam::objectHit >	projectPoints (const ToPatch &targetPatch, const Field< PointType > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const

template<class ToPatch >
Foam::List< Foam::objectHit >	projectFaceCentres (const ToPatch &targetPatch, const Field< PointType > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const

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 a pointer to a new patch created on freestore from. More...

static autoPtr< polyPatch >	New (const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm)
	Return a pointer to a new patch created on freestore from. More...

static autoPtr< polyPatch >	New (const word &patchType, const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm)
	Return a pointer to a new patch created on freestore from. 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...

Protected Member Functions
virtual void	initCalcGeometry (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	initTopoChange (PstreamBuffers &)=0
	Initialise the update of the patch topology. More...

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

virtual void	initOrder (ownToNbrOrderData &ownToNbr, autoPtr< ownToNbrDebugOrderData > &ownToNbrDebugPtr, const primitivePatch &) const
	Initialise ordering for the given primitivePatch. Fills the. More...

virtual bool	order (const ownToNbrOrderData &ownToNbr, const autoPtr< ownToNbrDebugOrderData > &ownToNbrDebugPtr, const primitivePatch &, labelList &faceMap, labelList &rotation) const
	Return new ordering for the given primitivePatch. More...

Protected Member Functions inherited from polyPatch
virtual void	movePoints (const pointField &p)
	Correct patches after moving points. More...

virtual void	clearGeom ()
	Clear geometry. More...

virtual void	rename (const wordList &newNames)
	Reset the patch name. More...

virtual void	reorder (const labelUList &newToOldIndex)
	Reset the patch index. More...

Static Protected Member Functions
static void	writeOBJ (const fileName &, const primitivePatch &)
	Write a patch in OBJ format. More...

static void	writeOBJ (const fileName &, const pointField &, const pointField &)
	Write lines between two lists of points in OBJ format. More...

static void	writeOBJ (const fileName &, const pointField &, const labelListList &)
	Write a set of paths in OBJ format. More...

Protected Attributes
const scalar	matchTolerance_
	Local matching tolerance. More...

autoPtr< ownToOwnOrderData >	ownToOwnOrderDataPtr_
	Data to pass from owner.initOrder to owner.order. More...

Protected Attributes inherited from patchIdentifier
word	name_
	Name of patch. More...

label	index_
	Index of patch in boundary. More...

word	physicalType_
	Optional physical type. More...

wordList	inGroups_
	Optional groups patch belongs to. More...

Static Protected Attributes
static const scalar	defaultMatchTol_ = 1e-4
	Default matching tolerance. More...

Friends
Istream &	operator>> (Istream &, ownToNbrOrderData &)

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

Istream &	operator>> (Istream &, ownToNbrDebugOrderData &)

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

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

typedef FaceList	FaceListType

typedef std::remove_reference< FaceList >::type::value_type	FaceType

typedef PointField	PointFieldType

typedef std::remove_reference< PointField >::type::value_type	PointType

Static Public Attributes inherited from polyPatch
static int	disallowGenericPolyPatch
	Debug switch to disallow the use of genericPolyPatch. 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 52 of file coupledPolyPatch.H.

Constructor & Destructor Documentation

◆ coupledPolyPatch() [1/5]

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

Construct from components.

Definition at line 527 of file coupledPolyPatch.C.

Referenced by coupledPolyPatch::coupledPolyPatch(), and coupledPolyPatch::order().

Here is the caller graph for this function:

◆ coupledPolyPatch() [2/5]

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

Construct from dictionary.

Definition at line 543 of file coupledPolyPatch.C.

References coupledPolyPatch::coupledPolyPatch().

Here is the call graph for this function:

◆ coupledPolyPatch() [3/5]

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

Construct as copy, resetting the boundary mesh.

Definition at line 558 of file coupledPolyPatch.C.

References coupledPolyPatch::coupledPolyPatch().

Here is the call graph for this function:

◆ coupledPolyPatch() [4/5]

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 570 of file coupledPolyPatch.C.

References coupledPolyPatch::coupledPolyPatch().

Here is the call graph for this function:

◆ coupledPolyPatch() [5/5]

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 585 of file coupledPolyPatch.C.

◆ ~coupledPolyPatch()

~coupledPolyPatch ( )

virtual

Destructor.

Definition at line 601 of file coupledPolyPatch.C.

References coupledPolyPatch::calcFaceTol().

Here is the call graph for this function:

Member Function Documentation

◆ initCalcGeometry()

virtual void initCalcGeometry ( PstreamBuffers & )

protectedpure virtual

Initialise the calculation of the patch geometry.

Reimplemented from polyPatch.

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

◆ calcGeometry()

virtual void calcGeometry ( PstreamBuffers & )

protectedpure virtual

Calculate the patch geometry.

Reimplemented from polyPatch.

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

◆ initMovePoints()

virtual void initMovePoints	(	PstreamBuffers &	,
		const pointField &
	)

protectedpure virtual

Initialise the patches for moving points.

Reimplemented from polyPatch.

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

◆ movePoints()

virtual void movePoints	(	PstreamBuffers &	,
		const pointField &
	)

protectedpure virtual

Correct patches after moving points.

Reimplemented from polyPatch.

Implemented in cyclicPolyPatch, processorCyclicPolyPatch, cyclicAMIPolyPatch, and processorPolyPatch.

◆ initTopoChange()

virtual void initTopoChange ( PstreamBuffers & )

protectedpure virtual

Initialise the update of the patch topology.

Reimplemented from polyPatch.

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

◆ topoChange()

virtual void topoChange ( PstreamBuffers & )

protectedpure virtual

Update of the patch topology.

Reimplemented from polyPatch.

Implemented in cyclicPolyPatch, processorCyclicPolyPatch, cyclicAMIPolyPatch, and processorPolyPatch.

◆ writeOBJ() [1/3]

void writeOBJ	(	const fileName &	name,
		const primitivePatch &	pp
	)

staticprotected

Write a patch in OBJ format.

Definition at line 155 of file coupledPolyPatch.C.

References Foam::endl(), f(), forAll, PrimitivePatch< FaceList, PointField >::localFaces(), PrimitivePatch< FaceList, PointField >::localPoints(), p, Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().

Referenced by coupledPolyPatch::writeOBJ().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeOBJ() [2/3]

void writeOBJ	(	const fileName &	name,
		const pointField &	points0,
		const pointField &	points1
	)

staticprotected

Write lines between two lists of points in OBJ format.

Definition at line 181 of file coupledPolyPatch.C.

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

Here is the call graph for this function:

◆ writeOBJ() [3/3]

void writeOBJ	(	const fileName &	name,
		const pointField &	points,
		const labelListList &	paths
	)

staticprotected

Write a set of paths in OBJ format.

Definition at line 201 of file coupledPolyPatch.C.

References Foam::constant::universal::c, Foam::endl(), forAll, coupledPolyPatch::initOrder(), List< T >::size(), Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().

Here is the call graph for this function:

◆ initOrder() [1/2]

void initOrder	(	ownToNbrOrderData &	ownToNbr,
		autoPtr< ownToNbrDebugOrderData > &	ownToNbrDebugPtr,
		const primitivePatch &	pp
	)		const

protectedvirtual

Initialise ordering for the given primitivePatch. Fills the.

referenced data structures, but leaves transferring them to the opposite patch to the caller.

Definition at line 227 of file coupledPolyPatch.C.

References f(), PrimitivePatch< FaceList, PointField >::faceCentres(), Foam::faceMap(), forAll, PrimitivePatch< FaceList, PointField >::nEdges(), PrimitivePatch< FaceList, PointField >::nInternalEdges(), PrimitivePatch< FaceList, PointField >::nPoints(), coupledPolyPatch::order(), face::points(), PrimitivePatch< FaceList, PointField >::points(), coupledPolyPatch::ownToNbrOrderData::seedFacePoints, and autoPtr< T >::valid().

Referenced by processorPolyPatch::initOrder(), cyclicPolyPatch::initOrder(), coupledPolyPatch::matchTolerance(), and coupledPolyPatch::writeOBJ().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ order() [1/2]

bool order	(	const ownToNbrOrderData &	ownToNbr,
		const autoPtr< ownToNbrDebugOrderData > &	ownToNbrDebugPtr,
		const primitivePatch &	pp,
		labelList &	faceMap,
		labelList &	rotation
	)		const

protectedvirtual

Return new ordering for the given 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.

Definition at line 327 of file coupledPolyPatch.C.

References List< T >::clear(), coupledPolyPatch::coupledPolyPatch(), Foam::endl(), Foam::exit(), PrimitivePatch< FaceList, PointField >::faceCentres(), Foam::faceMap(), Foam::FatalError, FatalErrorInFunction, UList< T >::first(), forAll, Foam::magSqr(), Foam::name(), PrimitivePatch< FaceList, PointField >::nEdges(), PrimitivePatch< FaceList, PointField >::nInternalEdges(), Foam::nl, PrimitivePatch< FaceList, PointField >::nPoints(), PrimitivePatch< FaceList, PointField >::points(), Foam::Pout, List< T >::resize(), Foam::reverseList(), Foam::rotateList(), coupledPolyPatch::ownToNbrOrderData::seedFacePoints, SeriousErrorInFunction, List< T >::size(), Foam::sqrt(), Foam::sum(), autoPtr< T >::valid(), and Foam::meshTools::writeOBJ().

Referenced by coupledPolyPatch::initOrder(), coupledPolyPatch::matchTolerance(), processorPolyPatch::order(), and cyclicPolyPatch::order().

Here is the call graph for this function:

Here is the caller 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 nonConformalCyclicPolyPatch, cyclicAMIPolyPatch, processorPolyPatch, and nonConformalProcessorCyclicPolyPatch.

Definition at line 266 of file coupledPolyPatch.H.

References coupledPolyPatch::owner().

Referenced by coupledFvPatch::coupled().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ owner()

virtual bool owner ( ) const

pure virtual

Does this side own the patch ?

Implemented in processorCyclicPolyPatch, cyclicPolyPatch, cyclicAMIPolyPatch, and processorPolyPatch.

Referenced by coupledPolyPatch::coupled(), polyMeshTetDecomposition::findFaceBasePts(), syncTools::getMasterFaces(), coupledPolyPatch::neighbour(), and coupledFvPatch::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 275 of file coupledPolyPatch.H.

References coupledPolyPatch::owner(), and coupledPolyPatch::transform().

Here is the call graph for this function:

◆ transform()

virtual const transformer& transform ( ) const

pure virtual

Return transformation between the coupled patches.

Implemented in processorPolyPatch, processorCyclicPolyPatch, cyclicPolyPatch, and cyclicAMIPolyPatch.

Referenced by extendedCellToCellStencil::extendedCellToCellStencil(), extendedCellToFaceStencil::extendedCellToFaceStencil(), extendedFaceToCellStencil::extendedFaceToCellStencil(), coupledPolyPatch::neighbour(), distributionMap::transform::operator()(), distributionMap::transformPosition::operator()(), motionSmootherAlgo::scaleMesh(), and meshRefinement::selectSeparatedCoupledFaces().

Here is the caller graph for this function:

◆ matchTolerance()

scalar matchTolerance ( ) const

inline

Return the matching tolerance.

Definition at line 284 of file coupledPolyPatch.H.

References coupledPolyPatch::calcFaceTol(), polyPatch::faceCentres(), coupledPolyPatch::initOrder(), coupledPolyPatch::matchTolerance_, coupledPolyPatch::operator<<, coupledPolyPatch::operator>>, coupledPolyPatch::order(), PrimitivePatch< FaceList, PointField >::points(), and coupledPolyPatch::write().

Here is the call graph for this function:

◆ initOrder() [2/2]

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

pure virtual

Initialise ordering for primitivePatch. Does not.

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

Reimplemented from polyPatch.

Implemented in cyclicPolyPatch, cyclicAMIPolyPatch, processorPolyPatch, and processorCyclicPolyPatch.

◆ order() [2/2]

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, processorPolyPatch, and processorCyclicPolyPatch.

◆ 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 608 of file coupledPolyPatch.C.

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

Referenced by coupledPolyPatch::matchTolerance(), and coupledPolyPatch::~coupledPolyPatch().

Here is the call graph for this function:

Here is the caller 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, processorPolyPatch, processorCyclicPolyPatch, nonConformalCyclicPolyPatch, and nonConformalProcessorCyclicPolyPatch.

Definition at line 647 of file coupledPolyPatch.C.

References polyPatch::write(), and Foam::writeEntry().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator>> [1/2]

Istream& operator>>	(	Istream &	,
		ownToNbrOrderData &
	)

friend

Referenced by coupledPolyPatch::matchTolerance().

◆ operator<< [1/2]

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

friend

Referenced by coupledPolyPatch::matchTolerance().

◆ operator>> [2/2]

Istream& operator>>	(	Istream &	,
		ownToNbrDebugOrderData &
	)

friend

◆ operator<< [2/2]

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

friend

Member Data Documentation

◆ defaultMatchTol_

const scalar defaultMatchTol_ = 1e-4

staticprotected

Default matching tolerance.

Definition at line 126 of file coupledPolyPatch.H.

◆ matchTolerance_

const scalar matchTolerance_

protected

Local matching tolerance.

Definition at line 129 of file coupledPolyPatch.H.

Referenced by coupledPolyPatch::matchTolerance().

◆ ownToOwnOrderDataPtr_

autoPtr<ownToOwnOrderData> ownToOwnOrderDataPtr_

mutableprotected

Data to pass from owner.initOrder to owner.order.

Definition at line 132 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

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ coupledPolyPatch() [1/5]

◆ coupledPolyPatch() [2/5]

◆ coupledPolyPatch() [3/5]

◆ coupledPolyPatch() [4/5]

◆ coupledPolyPatch() [5/5]

◆ ~coupledPolyPatch()

Member Function Documentation

◆ initCalcGeometry()

◆ calcGeometry()

◆ initMovePoints()

◆ movePoints()

◆ initTopoChange()

◆ topoChange()

◆ writeOBJ() [1/3]

◆ writeOBJ() [2/3]

◆ writeOBJ() [3/3]

◆ initOrder() [1/2]

◆ order() [1/2]

◆ TypeName()

◆ coupled()

◆ owner()

◆ neighbour()

◆ transform()

◆ matchTolerance()

◆ initOrder() [2/2]

◆ order() [2/2]

◆ calcFaceTol()

◆ write()

Friends And Related Function Documentation

◆ operator>> [1/2]

◆ operator<< [1/2]

◆ operator>> [2/2]

◆ operator<< [2/2]

Member Data Documentation

◆ defaultMatchTol_

◆ matchTolerance_

◆ ownToOwnOrderDataPtr_