Cyclic plane patch. More...

Inheritance diagram for cyclicPolyPatch:

Collaboration diagram for cyclicPolyPatch:

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

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

	cyclicPolyPatch (const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType, const word &nbrPatchName)
	Construct from components. More...

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

	cyclicPolyPatch (const cyclicPolyPatch &, const polyBoundaryMesh &)
	Construct as copy, resetting the boundary mesh. More...

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

	cyclicPolyPatch (const cyclicPolyPatch &pp, const polyBoundaryMesh &bm, const label index, const labelUList &mapAddressing, const label newStart)
	Construct given the original patch and a map. 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	~cyclicPolyPatch ()
	Destructor. More...

const word &	nbrPatchName () const
	Neighbour patch name. More...

virtual label	nbrPatchID () const
	Neighbour patchID. More...

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

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

const cyclicPolyPatch &	nbrPatch () const

const edgeList &	coupledPoints () const
	Return connected points (from patch local to neighbour patch local) More...

const edgeList &	coupledEdges () const
	Return connected edges (from patch local to neighbour patch local). More...

virtual const transformer &	transform () const
	Return transformation between the coupled patches. More...

label	transformGlobalFace (const label facei) const
	For a given patch face index, return the corresponding index of the. More...

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

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

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

Public Member Functions inherited from coupledPolyPatch
	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...

scalar	matchTolerance () const
	Return the matching tolerance. 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	~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...

word &	name ()
	Return name for modification. 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...

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

label &	index ()
	Return the index of this patch in the boundaryMesh 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, List< 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...

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

	PrimitivePatch (Istream &, const Field< PointType > &points)
	Construct from Istream. More...

virtual	~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 ()

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

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

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

	cyclicTransform (const bool defaultIsNone)

	cyclicTransform (const dictionary &dict, const bool defaultIsNone)

	cyclicTransform (const word &name, const vectorField &areas, const cyclicTransform &transform, const word &nbrName, const cyclicTransform &nbrTransform, const scalar matchTolerance)
	Construct from coupled patch data. Copies from the supplied. More...

	cyclicTransform (const word &name, const pointField &ctrs, const vectorField &areas, const cyclicTransform &transform, const word &nbrName, const pointField &nbrCtrs, const vectorField &nbrAreas, const cyclicTransform &nbrTransform, const scalar matchTolerance)
	Construct from coupled patch data. Copies from the supplied. More...

virtual	~cyclicTransform ()

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

bool	transformComplete () const
	Is the transform fully specified? More...

const transformer &	transform () const
	Return transformation between the coupled patches. More...

void	write (Ostream &os) const
	Write the data to a dictionary. More...

Protected Member Functions
virtual void	initCalcGeometry (PstreamBuffers &)
	Initialise the calculation of the patch geometry. More...

virtual void	initCalcGeometry (const primitivePatch &referPatch, pointField &nbrCtrs, vectorField &nbrAreas, pointField &nbrCc)
	Initialise the calculation of the patch geometry. More...

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

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

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

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

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

Protected Member Functions inherited from coupledPolyPatch
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	clearGeom ()
	Clear geometry. More...

Friends
class	processorCyclicPolyPatch
	Declare friendship with processorCyclicPolyPatch. More...

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

Public Types inherited from cyclicTransform
enum	transformTypes { UNSPECIFIED, NONE, ROTATIONAL, TRANSLATIONAL }

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

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

Static Public Attributes inherited from cyclicTransform
static const NamedEnum< transformTypes, 4 >	transformTypeNames

Static Protected Member Functions inherited from coupledPolyPatch
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 inherited from coupledPolyPatch
const scalar	matchTolerance_
	Local matching tolerance. More...

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

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

Detailed Description

Cyclic plane patch.

Note: morph patch face ordering uses geometric matching so with the following restrictions: -coupled patches should be flat planes. -no rotation in patch plane

Uses coupledPolyPatch::calcFaceTol to calculate tolerance per face which might need tweaking.

Switch on 'cyclicPolyPatch' debug flag to write .obj files to show the matching.

Source files

Definition at line 64 of file cyclicPolyPatch.H.

Constructor & Destructor Documentation

◆ cyclicPolyPatch() [1/6]

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

Construct from components.

Definition at line 123 of file cyclicPolyPatch.C.

Referenced by cyclicPolyPatch::clone(), cyclicPolyPatch::cyclicPolyPatch(), and cyclicPolyPatch::updateMesh().

Here is the caller graph for this function:

◆ cyclicPolyPatch() [2/6]

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

Construct from components.

Definition at line 148 of file cyclicPolyPatch.C.

References cyclicPolyPatch::cyclicPolyPatch().

Here is the call graph for this function:

◆ cyclicPolyPatch() [3/6]

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

Construct from dictionary.

Definition at line 174 of file cyclicPolyPatch.C.

References cyclicPolyPatch::cyclicPolyPatch(), Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, word::null, and word::valid().

Here is the call graph for this function:

◆ cyclicPolyPatch() [4/6]

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

Construct as copy, resetting the boundary mesh.

Definition at line 216 of file cyclicPolyPatch.C.

References cyclicPolyPatch::cyclicPolyPatch().

Here is the call graph for this function:

◆ cyclicPolyPatch() [5/6]

cyclicPolyPatch	(	const cyclicPolyPatch &	pp,
		const polyBoundaryMesh &	bm,
		const label	index,
		const label	newSize,
		const label	newStart,
		const word &	nbrPatchName
	)

Construct given the original patch and resetting the.

face list and boundary mesh information

Definition at line 238 of file cyclicPolyPatch.C.

References cyclicPolyPatch::cyclicPolyPatch(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::name().

Here is the call graph for this function:

◆ cyclicPolyPatch() [6/6]

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

Construct given the original patch and a map.

Definition at line 272 of file cyclicPolyPatch.C.

◆ ~cyclicPolyPatch()

~cyclicPolyPatch ( )

virtual

Destructor.

Definition at line 295 of file cyclicPolyPatch.C.

References Foam::deleteDemandDrivenData().

Referenced by cyclicPolyPatch::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ initCalcGeometry() [1/2]

void initCalcGeometry ( PstreamBuffers & pBufs )

protectedvirtual

Initialise the calculation of the patch geometry.

Implements coupledPolyPatch.

Definition at line 52 of file cyclicPolyPatch.C.

References polyPatch::initCalcGeometry().

Here is the call graph for this function:

◆ initCalcGeometry() [2/2]

void initCalcGeometry	(	const primitivePatch &	referPatch,
		pointField &	nbrCtrs,
		vectorField &	nbrAreas,
		pointField &	nbrCc
	)

protectedvirtual

Initialise the calculation of the patch geometry.

Definition at line 59 of file cyclicPolyPatch.C.

◆ calcGeometry()

void calcGeometry ( PstreamBuffers & pBufs )

protectedvirtual

Calculate the patch geometry.

Implements coupledPolyPatch.

Definition at line 68 of file cyclicPolyPatch.C.

References cyclicPolyPatch::initMovePoints(), and Foam::name().

Here is the call graph for this function:

◆ initMovePoints()

void initMovePoints	(	PstreamBuffers &	pBufs,
		const pointField &	p
	)

protectedvirtual

Initialise the patches for moving points.

Implements coupledPolyPatch.

Definition at line 87 of file cyclicPolyPatch.C.

References polyPatch::initMovePoints(), and cyclicPolyPatch::movePoints().

Referenced by cyclicPolyPatch::calcGeometry().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ movePoints()

void movePoints	(	PstreamBuffers &	pBufs,
		const pointField &	p
	)

protectedvirtual

Correct patches after moving points.

Implements coupledPolyPatch.

Definition at line 97 of file cyclicPolyPatch.C.

References polyPatch::movePoints().

Referenced by cyclicPolyPatch::initMovePoints().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initUpdateMesh()

void initUpdateMesh ( PstreamBuffers & pBufs )

protectedvirtual

Initialise the update of the patch topology.

Implements coupledPolyPatch.

Definition at line 106 of file cyclicPolyPatch.C.

References polyPatch::initUpdateMesh().

Here is the call graph for this function:

◆ updateMesh()

void updateMesh ( PstreamBuffers & pBufs )

protectedvirtual

Update of the patch topology.

Implements coupledPolyPatch.

Definition at line 112 of file cyclicPolyPatch.C.

References cyclicPolyPatch::cyclicPolyPatch(), Foam::deleteDemandDrivenData(), and polyPatch::updateMesh().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "cyclic" )

Runtime type information.

◆ clone() [1/3]

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

inlinevirtual

Construct and return a clone, resetting the boundary mesh.

Reimplemented from polyPatch.

Reimplemented in cyclicSlipPolyPatch.

Definition at line 210 of file cyclicPolyPatch.H.

References PrimitivePatch< FaceList, PointField >::clone(), and cyclicPolyPatch::cyclicPolyPatch().

Here is the call graph for this function:

◆ clone() [2/3]

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

Reimplemented in cyclicSlipPolyPatch.

Definition at line 218 of file cyclicPolyPatch.H.

References PrimitivePatch< FaceList, PointField >::clone(), and cyclicPolyPatch::cyclicPolyPatch().

Here is the call graph for this function:

◆ clone() [3/3]

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

Reimplemented in cyclicSlipPolyPatch.

Definition at line 242 of file cyclicPolyPatch.H.

References cyclicPolyPatch::cyclicPolyPatch(), cyclicPolyPatch::nbrPatchID(), cyclicPolyPatch::nbrPatchName(), and cyclicPolyPatch::~cyclicPolyPatch().

Here is the call graph for this function:

◆ nbrPatchName()

const Foam::word & nbrPatchName ( ) const

Neighbour patch name.

Definition at line 304 of file cyclicPolyPatch.C.

Referenced by cyclicSlipPolyPatch::clone(), cyclicPolyPatch::clone(), and cyclicPolyPatch::nbrPatchID().

Here is the caller graph for this function:

◆ nbrPatchID()

Foam::label nbrPatchID ( ) const

virtual

Neighbour patchID.

Definition at line 317 of file cyclicPolyPatch.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::name(), cyclicPolyPatch::nbrPatchName(), and WarningInFunction.

Referenced by cyclicPolyPatch::clone(), cyclicFvPatch::nbrPatch(), cyclicPointPatch::nbrPatch(), cyclicPolyPatch::nbrPatch(), cyclicFvPatch::nbrPatchID(), cyclicFvPatch::neighbFvPatch(), and cyclicPolyPatch::owner().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ owner()

virtual bool owner ( ) const

inlinevirtual

Does this side own the patch ?

Implements coupledPolyPatch.

Definition at line 268 of file cyclicPolyPatch.H.

References patchIdentifier::index(), and cyclicPolyPatch::nbrPatchID().

Referenced by cyclicPolyPatch::neighbour(), cyclicFvPatch::owner(), processorCyclicPolyPatch::owner(), fvMeshDistribute::printCoupleInfo(), syncTools::syncBoundaryFaceList(), syncTools::syncEdgeMap(), syncTools::syncFaceList(), and syncTools::syncPointMap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ neighbour()

virtual bool neighbour ( ) const

inlinevirtual

Does the coupled side own the patch ?

Reimplemented from coupledPolyPatch.

Definition at line 273 of file cyclicPolyPatch.H.

References cyclicPolyPatch::owner().

Here is the call graph for this function:

◆ nbrPatch()

const cyclicPolyPatch& nbrPatch ( ) const

inline

Definition at line 278 of file cyclicPolyPatch.H.

References polyPatch::boundaryMesh(), cyclicPolyPatch::coupledEdges(), cyclicPolyPatch::coupledPoints(), and cyclicPolyPatch::nbrPatchID().

Referenced by PointEdgeWave< Type, TrackingData >::countPatchType(), particle< Type >::hitCyclicPatch(), syncTools::syncBoundaryFaceList(), syncTools::syncEdgeMap(), syncTools::syncFaceList(), syncTools::syncPointMap(), processorCyclicPolyPatch::tag(), and cyclicPolyPatch::transform().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coupledPoints()

const Foam::edgeList & coupledPoints ( ) const

Return connected points (from patch local to neighbour patch local)

Demand driven calculation. Does primitivePatch::clearOut after calculation!

Definition at line 352 of file cyclicPolyPatch.C.

References Foam::constant::physicoChemical::b, Foam::endl(), forAll, mesh, OFstream::name(), Foam::name(), Foam::nl, nPoints, path(), points, Foam::Pout, List< T >::setSize(), List< T >::size(), Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().

Referenced by PointEdgeWave< Type, TrackingData >::countPatchType(), cyclicPolyPatch::nbrPatch(), and syncTools::syncPointMap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coupledEdges()

const Foam::edgeList & coupledEdges ( ) const

Return connected edges (from patch local to neighbour patch local).

Demand driven calculation. Does primitivePatch::clearOut after calculation!

Definition at line 433 of file cyclicPolyPatch.C.

References Foam::abort(), Foam::constant::physicoChemical::b, Vector< Cmpt >::centre(), Foam::e, PrimitivePatch< FaceList, PointField >::edges(), HashTableCore::end(), Foam::endl(), HashTable< T, Key, Hash >::erase(), PrimitivePatch< FaceList, PointField >::faceEdges(), Foam::FatalError, FatalErrorInFunction, HashTable< T, Key, Hash >::find(), forAll, cyclicPolyPatch::initOrder(), HashTable< T, Key, Hash >::insert(), PrimitivePatch< FaceList, PointField >::localPoints(), mesh, PrimitivePatch< FaceList, PointField >::meshPoints(), Foam::constant::atomic::mp, OFstream::name(), Foam::name(), Foam::nl, path(), Foam::Pout, List< T >::size(), HashTable< T, Key, Hash >::size(), Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().

Referenced by cyclicPolyPatch::nbrPatch(), and syncTools::syncEdgeMap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ transform()

virtual const transformer& transform ( ) const

inlinevirtual

Return transformation between the coupled patches.

Implements coupledPolyPatch.

Definition at line 295 of file cyclicPolyPatch.H.

References Foam::exit(), Foam::faceMap(), Foam::FatalError, FatalErrorInFunction, cyclicPolyPatch::initOrder(), patchIdentifier::name(), cyclicPolyPatch::nbrPatch(), cyclicPolyPatch::order(), polyPatch::start(), cyclicTransform::transform(), cyclicPolyPatch::transformGlobalFace(), and cyclicPolyPatch::write().

Referenced by PointEdgeWave< Type, TrackingData >::countPatchType(), FaceCellWave< Type, TrackingData >::handleCyclicPatches(), particle< Type >::hitCyclicPatch(), cyclicFvPatch::transform(), cyclicPointPatch::transform(), and processorCyclicPolyPatch::transform().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ transformGlobalFace()

label transformGlobalFace ( const label facei ) const

inline

For a given patch face index, return the corresponding index of the.

face on the neighbour

Definition at line 302 of file cyclicPolyPatch.H.

Referenced by particle< Type >::hitCyclicPatch(), and cyclicPolyPatch::transform().

Here is the caller graph for this function:

◆ initOrder()

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

virtual

Initialize ordering for primitivePatch. Does not.

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

Implements coupledPolyPatch.

Definition at line 573 of file cyclicPolyPatch.C.

References PrimitivePatch< FaceList, PointField >::faceAreas(), PrimitivePatch< FaceList, PointField >::faceCentres(), coupledPolyPatch::initOrder(), Foam::mag(), cyclicPolyPatch::order(), and Foam::sum().

Referenced by cyclicPolyPatch::coupledEdges(), and cyclicPolyPatch::transform().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ order()

bool order	(	PstreamBuffers &	pBufs,
		const primitivePatch &	pp,
		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.

Implements coupledPolyPatch.

Definition at line 609 of file cyclicPolyPatch.C.

References PrimitivePatch< FaceList, PointField >::faceAreas(), PrimitivePatch< FaceList, PointField >::faceCentres(), Foam::name(), coupledPolyPatch::order(), coupledPolyPatch::ownToNbrOrderData::transform(), and autoPtr< T >::valid().

Referenced by cyclicPolyPatch::initOrder(), and cyclicPolyPatch::transform().

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

Definition at line 661 of file cyclicPolyPatch.C.

References cyclicTransform::write(), coupledPolyPatch::write(), and Foam::writeEntry().

Referenced by cyclicPolyPatch::transform().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ processorCyclicPolyPatch

friend class processorCyclicPolyPatch

friend

Declare friendship with processorCyclicPolyPatch.

Definition at line 142 of file cyclicPolyPatch.H.

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

src/OpenFOAM/meshes/polyMesh/polyPatches/constraint/cyclic/cyclicPolyPatch.H
src/OpenFOAM/meshes/polyMesh/polyPatches/constraint/cyclic/cyclicPolyPatch.C

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ cyclicPolyPatch() [1/6]

◆ cyclicPolyPatch() [2/6]

◆ cyclicPolyPatch() [3/6]

◆ cyclicPolyPatch() [4/6]

◆ cyclicPolyPatch() [5/6]

◆ cyclicPolyPatch() [6/6]

◆ ~cyclicPolyPatch()

Member Function Documentation

◆ initCalcGeometry() [1/2]

◆ initCalcGeometry() [2/2]

◆ calcGeometry()

◆ initMovePoints()

◆ movePoints()

◆ initUpdateMesh()

◆ updateMesh()

◆ TypeName()

◆ clone() [1/3]

◆ clone() [2/3]

◆ clone() [3/3]

◆ nbrPatchName()

◆ nbrPatchID()

◆ owner()

◆ neighbour()

◆ nbrPatch()

◆ coupledPoints()

◆ coupledEdges()

◆ transform()

◆ transformGlobalFace()

◆ initOrder()

◆ order()

◆ write()

Friends And Related Function Documentation

◆ processorCyclicPolyPatch