Cyclic patch for Arbitrary Mesh Interface (AMI) More...

Inheritance diagram for cyclicAMIPolyPatch:

Collaboration diagram for cyclicAMIPolyPatch:

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

	cyclicAMIPolyPatch (const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType, const transformType transform=UNKNOWN, const word &defaultAMIMethod=faceAreaWeightAMI::typeName)
	Construct from (base coupled patch) components. More...

	cyclicAMIPolyPatch (const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm, const word &patchType, const word &defaultAMIMethod=faceAreaWeightAMI::typeName)
	Construct from dictionary. More...

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

	cyclicAMIPolyPatch (const cyclicAMIPolyPatch &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...

	cyclicAMIPolyPatch (const cyclicAMIPolyPatch &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	~cyclicAMIPolyPatch ()=default
	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 patch ID. More...

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

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

bool	canResetAMI () const
	Flag to indicate whether the AMI can be reset. More...

bool	createAMIFaces () const
	Return access to the createAMIFaces flag. More...

bool	updatingAMI () const
	Return access to the updated flag. More...

virtual bool	changeTopology () const
	Return true if this patch changes the mesh topology. More...

virtual bool	setTopology (polyTopoChange &topoChange)
	Set topology changes in the polyTopoChange object. More...

virtual bool	coupled () const

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

virtual label	neighbPatchID () const
	Neighbour patch ID. More...

scalar	fraction () const
	Particle fraction increase between AMI pathces. More...

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

virtual const cyclicAMIPolyPatch &	neighbPatch () const
	Return a reference to the neighbour patch. More...

label	periodicPatchID () const
	Periodic patch ID (or -1) More...

const AMIPatchToPatchInterpolation &	AMI () const
	Return a reference to the AMI interpolator. More...

const scalarListList &	weights () const
	Helper function to return the weights. More...

const scalarField &	weightsSum () const
	Helper function to return the weights sum. More...

bool	applyLowWeightCorrection () const
	Return true if applying the low weight correction. More...

vectorField &	faceAreas0 () const
	Return access to the initial face areas. More...

vectorField &	faceCentres0 () const
	Return access to the initial face centres. More...

const vector &	rotationAxis () const
	Axis of rotation for rotational cyclic AMI. More...

const point &	rotationCentre () const
	Point on axis of rotation for rotational cyclic AMI. More...

const vector &	separationVector () const
	Translation vector for translational cyclic AMI. More...

virtual void	transformPosition (pointField &) const
	Transform patch-based positions from nbr side to this side. More...

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

virtual void	reverseTransformPosition (point &l, const label facei) const
	Transform a patch-based position from this side to nbr side. More...

virtual void	reverseTransformDirection (vector &d, const label facei) const
	Transform a patch-based direction from this side to. More...

template<class Type >
tmp< Field< Type > >	interpolate (const Field< Type > &fld, const UList< Type > &defaultValues=UList< Type >()) const
	Interpolate field. More...

template<class Type >
tmp< Field< Type > >	interpolate (const tmp< Field< Type > > &tFld, const UList< Type > &defaultValues=UList< Type >()) const
	Interpolate tmp field. More...

template<class Type >
tmp< Field< Type > >	interpolateUntransformed (const Field< Type > &fld, const UList< Type > &defaultValues) const
	Interpolate without periodic. More...

template<class Type , class CombineOp >
void	interpolate (const UList< Type > &fld, const CombineOp &cop, List< Type > &result, const UList< Type > &defaultValues=UList< Type >()) const
	Low-level interpolate List. More...

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

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

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

label	pointFace (const label facei, const vector &n, point &p) const

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

template<class Type >
Foam::tmp< Foam::Field< Type > >	interpolateUntransformed (const Field< Type > &fld, const UList< Type > &defaultValues) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	interpolate (const Field< Type > &fld, const UList< Type > &defaultValues) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	interpolate (const tmp< Field< Type > > &tFld, const UList< Type > &defaultValues) const

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

virtual bool	coupled () const
	Return true if this patch is geometrically coupled (i.e. faces and. 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...

virtual void	write (Ostream &os) const
	Write the polyPatch data as a dictionary. 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 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 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	hasEdges () 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 Attributes
static const scalar	tolerance_ = 1e-10
	Tolerance used e.g. for area calculations/limits. More...

Static Public Attributes inherited from coupledPolyPatch
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
virtual bool	removeAMIFaces (polyTopoChange &topoChange)
	Collect faces to remove in the topoChange container. More...

virtual bool	addAMIFaces (polyTopoChange &topoChange)
	Collect faces to add in the topoChange container. More...

virtual void	setAMIFaces ()
	Set properties of newly inserted faces after topological changes. More...

virtual void	restoreScaledGeometry ()

const autoPtr< searchableSurface > &	surfPtr () const
	Create and return pointer to the projection surface. More...

autoPtr< coordSystem::cylindrical >	cylindricalCS () const
	Create a coordinate system from the periodic patch (or nullptr) More...

virtual void	resetAMI (const UList< point > &points) const
	Reset the AMI interpolator, supply patch points. More...

virtual void	resetAMI () const
	Reset the AMI interpolator, use current patch points. More...

virtual void	calcTransforms ()
	Recalculate the transformation tensors. More...

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

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

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

virtual void	movePoints (PstreamBuffers &pBufs, 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...

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

Protected Member Functions inherited from coupledPolyPatch
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	initGeometry (PstreamBuffers &)
	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 &p)
	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...

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

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

Protected Attributes
word	nbrPatchName_
	Name of other half. More...

const coupleGroupIdentifier	coupleGroup_
	Optional patchGroup to find neighbPatch. More...

label	nbrPatchID_
	Index of other half. More...

const scalar	fraction_
	Particle displacement fraction accross AMI. More...

vector	rotationAxis_
	Axis of rotation for rotational cyclics. More...

point	rotationCentre_
	Point on axis of rotation for rotational cyclics. More...

bool	rotationAngleDefined_
	Flag to show whether the rotation angle is defined. More...

scalar	rotationAngle_
	Rotation angle. More...

vector	separationVector_
	Translation vector. More...

word	periodicPatchName_
	Periodic patch name. More...

label	periodicPatchID_
	Periodic patch. More...

autoPtr< AMIPatchToPatchInterpolation >	AMIPtr_
	AMI interpolation class. More...

const dictionary	surfDict_
	Dictionary used during projection surface construction. More...

autoPtr< searchableSurface >	surfPtr_
	Projection surface. More...

bool	createAMIFaces_
	Flag to indicate that new AMI faces will created. More...

bool	moveFaceCentres_
	Move face centres (default = no) More...

bool	updatingAMI_

labelListList	srcFaceIDs_

labelListList	tgtFaceIDs_

vectorField	faceAreas0_
	Temporary storage for AMI face areas. More...

vectorField	faceCentres0_
	Temporary storage for AMI face centres. More...

Additional Inherited Members
Public Types inherited from coupledPolyPatch
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...

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

Cyclic patch for Arbitrary Mesh Interface (AMI)

Includes provision for updating the patch topology to enforce a 1-to-1 face match across the interface, based on the createAMIFaces flag.

The manipulations are based on the reference:

H.J. Aguerre, S. Márquez Damián, J.M. Gimenez, N.M.Nigro, Conservative
handling of arbitrary non-conformal interfaces using an efficient
supermesh, Journal of Computational Physics 335(15) 21-49. 2017.
https://doi.org/10.1016/j.jcp.2017.01.018.

Source files

Definition at line 68 of file cyclicAMIPolyPatch.H.

Constructor & Destructor Documentation

◆ cyclicAMIPolyPatch() [1/5]

cyclicAMIPolyPatch	(	const word &	name,
		const label	size,
		const label	start,
		const label	index,
		const polyBoundaryMesh &	bm,
		const word &	patchType,
		const transformType	transform = `UNKNOWN`,
		const word &	defaultAMIMethod = `faceAreaWeightAMI::typeName`
	)

Construct from (base coupled patch) components.

Definition at line 603 of file cyclicAMIPolyPatch.C.

◆ cyclicAMIPolyPatch() [2/5]

cyclicAMIPolyPatch	(	const word &	name,
		const dictionary &	dict,
		const label	index,
		const polyBoundaryMesh &	bm,
		const word &	patchType,
		const word &	defaultAMIMethod = `faceAreaWeightAMI::typeName`
	)

Construct from dictionary.

Definition at line 642 of file cyclicAMIPolyPatch.C.

Here is the call graph for this function:

◆ cyclicAMIPolyPatch() [3/5]

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

Construct as copy, resetting the boundary mesh.

Definition at line 753 of file cyclicAMIPolyPatch.C.

◆ cyclicAMIPolyPatch() [4/5]

cyclicAMIPolyPatch	(	const cyclicAMIPolyPatch &	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 787 of file cyclicAMIPolyPatch.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, patchIdentifier::name(), and cyclicAMIPolyPatch::nbrPatchName_.

Here is the call graph for this function:

◆ cyclicAMIPolyPatch() [5/5]

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

Construct given the original patch and a map.

Definition at line 833 of file cyclicAMIPolyPatch.C.

◆ ~cyclicAMIPolyPatch()

virtual ~cyclicAMIPolyPatch ( )

virtualdefault

Destructor.

Member Function Documentation

◆ removeAMIFaces()

bool removeAMIFaces ( polyTopoChange & topoChange )

protectedvirtual

Collect faces to remove in the topoChange container.

Definition at line 82 of file cyclicAMIPolyPatchTopologyChange.C.

References Foam::abort(), DebugInFunction, Foam::endl(), Foam::FatalError, FatalErrorInFunction, polyTopoChange::removeFace(), and polyPatch::start().

Here is the call graph for this function:

◆ addAMIFaces()

bool addAMIFaces ( polyTopoChange & topoChange )

protectedvirtual

Collect faces to add in the topoChange container.

Definition at line 137 of file cyclicAMIPolyPatchTopologyChange.C.

References Foam::abort(), polyTopoChange::addFace(), DebugInFunction, UList< T >::empty(), Foam::endl(), polyMesh::faceOwner(), polyMesh::faces(), polyMesh::faceZones(), Foam::FatalError, FatalErrorInFunction, forAll, patchIdentifier::index(), Foam::Info, mesh, boundaryMesh::mesh(), patchIdentifier::name(), Foam::name(), Foam::nl, Foam::Pout, Foam::returnReduce(), List< T >::setSize(), UList< T >::size(), polyPatch::start(), and ZoneMesh< ZoneType, MeshType >::whichZone().

Here is the call graph for this function:

◆ setAMIFaces()

void setAMIFaces ( )

protectedvirtual

Set properties of newly inserted faces after topological changes.

Definition at line 261 of file cyclicAMIPolyPatchTopologyChange.C.

References Foam::abort(), DebugInFunction, Foam::endl(), polyPatch::faceAreas(), cyclicAMIPolyPatch::faceAreas0(), polyPatch::faceCentres(), cyclicAMIPolyPatch::faceCentres0(), Foam::FatalError, FatalErrorInFunction, UList< T >::find(), forAll, Foam::identity(), globalIndex::inplaceToGlobal(), Foam::mag(), Foam::name(), Foam::nl, Foam::Pout, autoPtr< T >::reset(), and UList< T >::size().

Here is the call graph for this function:

◆ restoreScaledGeometry()

void restoreScaledGeometry ( )

protectedvirtual

Helper to re-apply the geometric scaling lost during mesh updates

Definition at line 35 of file cyclicAMIPolyPatchTopologyChange.C.

References Foam::abort(), List< T >::clear(), cyclicAMIPolyPatch::createAMIFaces_, DebugInfo, DebugInFunction, Foam::endl(), polyPatch::faceAreas(), cyclicAMIPolyPatch::faceAreas0_, polyPatch::faceCentres(), cyclicAMIPolyPatch::faceCentres0_, Foam::FatalError, FatalErrorInFunction, Foam::gSum(), Foam::mag(), mesh, cyclicAMIPolyPatch::moveFaceCentres_, patchIdentifier::name(), Foam::nl, and WarningInFunction.

Here is the call graph for this function:

◆ surfPtr()

const Foam::autoPtr< Foam::searchableSurface > & surfPtr ( ) const

protected

Create and return pointer to the projection surface.

Definition at line 339 of file cyclicAMIPolyPatch.C.

References TimePaths::constant(), mesh, boundaryMesh::mesh(), IOobject::MUST_READ, Foam::name(), Time::New(), IOobject::NO_WRITE, and fvMesh::time().

Here is the call graph for this function:

◆ cylindricalCS()

Foam::autoPtr< Foam::coordSystem::cylindrical > cylindricalCS ( ) const

protected

Create a coordinate system from the periodic patch (or nullptr)

Definition at line 291 of file cyclicAMIPolyPatch.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, patchIdentifier::name(), Foam::name(), Time::New(), coupledPolyPatch::parallel(), and Foam::Zero.

Here is the call graph for this function:

◆ resetAMI() [1/2]

void resetAMI ( const UList< point > & points ) const

protectedvirtual

Reset the AMI interpolator, supply patch points.

Reimplemented in cyclicACMIPolyPatch.

Definition at line 376 of file cyclicAMIPolyPatch.C.

References DebugInFunction, Foam::endl(), PrimitivePatch< FaceList, PointField >::localFaces(), PrimitivePatch< FaceList, PointField >::localPoints(), boundaryMesh::mesh(), Foam::name(), os(), Time::path(), and Foam::meshTools::writeOBJ().

Here is the call graph for this function:

◆ resetAMI() [2/2]

void resetAMI ( ) const

protectedvirtual

Reset the AMI interpolator, use current patch points.

Reimplemented in cyclicACMIPolyPatch.

Definition at line 370 of file cyclicAMIPolyPatch.C.

References mesh, and points.

Referenced by cyclicACMIPolyPatch::resetAMI().

Here is the caller graph for this function:

◆ calcTransforms()

void calcTransforms ( )

protectedvirtual

Recalculate the transformation tensors.

Definition at line 447 of file cyclicAMIPolyPatch.C.

References DebugInFunction, DebugPout, Foam::endl(), polyPatch::faceCentres(), forAll, Foam::name(), Foam::nl, and PrimitivePatch< FaceList, PointField >::points().

Here is the call graph for this function:

◆ initGeometry()

void initGeometry ( PstreamBuffers & pBufs )

protectedvirtual

Initialise the calculation of the patch geometry.

Implements coupledPolyPatch.

Reimplemented in cyclicACMIPolyPatch.

Definition at line 483 of file cyclicAMIPolyPatch.C.

References DebugInFunction, Foam::endl(), and polyPatch::initGeometry().

Referenced by cyclicACMIPolyPatch::initGeometry().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calcGeometry() [1/2]

void calcGeometry ( PstreamBuffers & pBufs )

protectedvirtual

Calculate the patch geometry.

Implements coupledPolyPatch.

Reimplemented in cyclicACMIPolyPatch.

Definition at line 500 of file cyclicAMIPolyPatch.C.

References DebugInFunction, and Foam::endl().

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.

Reimplemented in cyclicACMIPolyPatch.

Definition at line 506 of file cyclicAMIPolyPatch.C.

References DebugInFunction, Foam::endl(), motionSmootherAlgo::movePoints(), and p.

Here is the call graph for this function:

◆ movePoints()

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

protectedvirtual

Correct patches after moving points.

Implements coupledPolyPatch.

Reimplemented in cyclicACMIPolyPatch.

Definition at line 542 of file cyclicAMIPolyPatch.C.

References DebugInFunction, and Foam::endl().

Here is the call graph for this function:

◆ initUpdateMesh()

void initUpdateMesh ( PstreamBuffers & pBufs )

protectedvirtual

Initialise the update of the patch topology.

Implements coupledPolyPatch.

Reimplemented in cyclicACMIPolyPatch.

Definition at line 566 of file cyclicAMIPolyPatch.C.

References DebugInFunction, Foam::endl(), polyPatch::initUpdateMesh(), and mesh.

Referenced by cyclicACMIPolyPatch::initUpdateMesh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateMesh()

void updateMesh ( PstreamBuffers & pBufs )

protectedvirtual

Update of the patch topology.

Implements coupledPolyPatch.

Reimplemented in cyclicACMIPolyPatch.

Definition at line 579 of file cyclicAMIPolyPatch.C.

References DebugInFunction, Foam::endl(), and motionSmootherAlgo::updateMesh().

Here is the call graph for this function:

◆ clearGeom()

void clearGeom ( )

protectedvirtual

Clear geometry.

Reimplemented from polyPatch.

Reimplemented in cyclicACMIPolyPatch.

Definition at line 588 of file cyclicAMIPolyPatch.C.

References polyPatch::clearGeom(), DebugInFunction, and Foam::endl().

Referenced by cyclicACMIPolyPatch::clearGeom().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "cyclicAMI" )

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 cyclicACMIPolyPatch, and cyclicPeriodicAMIPolyPatch.

Definition at line 282 of file cyclicAMIPolyPatch.H.

◆ 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 cyclicACMIPolyPatch, and cyclicPeriodicAMIPolyPatch.

Definition at line 289 of file cyclicAMIPolyPatch.H.

◆ 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 cyclicACMIPolyPatch, and cyclicPeriodicAMIPolyPatch.

Definition at line 313 of file cyclicAMIPolyPatch.H.

◆ newInternalProcFaces()

void newInternalProcFaces	(	label &	newFaces,
		label &	newProcFaces
	)		const

virtual

Return number of new internal of this polyPatch faces.

Reimplemented from polyPatch.

Reimplemented in cyclicACMIPolyPatch.

Definition at line 868 of file cyclicAMIPolyPatch.C.

References forAll.

◆ nbrCells()

virtual const labelUList & nbrCells ( ) const

inlinevirtual

Return nbrCells.

Reimplemented from polyPatch.

Definition at line 348 of file cyclicAMIPolyPatch.H.

References polyPatch::faceCells(), and cyclicAMIPolyPatch::neighbPatch().

Here is the call graph for this function:

◆ neighbPolyPatchID()

virtual label neighbPolyPatchID ( ) const

inlinevirtual

Return nbr patch ID.

Reimplemented from polyPatch.

Definition at line 354 of file cyclicAMIPolyPatch.H.

References patchIdentifier::index(), and cyclicAMIPolyPatch::neighbPatch().

Here is the call graph for this function:

◆ mapCollocatedFaces()

virtual refPtr< labelListList > mapCollocatedFaces ( ) const

inlinevirtual

Return collocated faces map.

Reimplemented from polyPatch.

Reimplemented in cyclicACMIPolyPatch.

Definition at line 360 of file cyclicAMIPolyPatch.H.

References cyclicAMIPolyPatch::AMI(), and AMIInterpolation::srcAddress().

Here is the call graph for this function:

◆ masterImplicit()

virtual bool masterImplicit ( ) const

inlinevirtual

Return implicit master.

Reimplemented from polyPatch.

Definition at line 367 of file cyclicAMIPolyPatch.H.

References cyclicAMIPolyPatch::owner().

Here is the call graph for this function:

◆ canResetAMI()

bool canResetAMI ( ) const

inline

Flag to indicate whether the AMI can be reset.

Definition at line 31 of file cyclicAMIPolyPatchI.H.

References boundaryMesh::mesh(), and UPstream::parRun().

Here is the call graph for this function:

◆ createAMIFaces()

bool createAMIFaces ( ) const

inline

Return access to the createAMIFaces flag.

Definition at line 37 of file cyclicAMIPolyPatchI.H.

◆ updatingAMI()

bool updatingAMI ( ) const

inline

Return access to the updated flag.

Definition at line 43 of file cyclicAMIPolyPatchI.H.

◆ changeTopology()

bool changeTopology ( ) const

virtual

Return true if this patch changes the mesh topology.

True when createAMIFaces is true

Reimplemented from polyPatch.

Definition at line 647 of file cyclicAMIPolyPatchTopologyChange.C.

References DebugInFunction, and Foam::endl().

Here is the call graph for this function:

◆ setTopology()

bool setTopology ( polyTopoChange & topoChange )

virtual

Set topology changes in the polyTopoChange object.

Reimplemented from polyPatch.

Definition at line 657 of file cyclicAMIPolyPatchTopologyChange.C.

References DebugInFunction, Foam::endl(), and polyTopoChange::points().

Here is the call graph for this function:

◆ coupled()

virtual bool coupled ( ) const

inlinevirtual

Is patch 'coupled'. Note that on AMI the geometry is not coupled but the fields are!

Reimplemented from coupledPolyPatch.

Definition at line 396 of file cyclicAMIPolyPatch.H.

◆ neighbPatchName()

const Foam::word & neighbPatchName ( ) const

inline

Neighbour patch name.

Definition at line 49 of file cyclicAMIPolyPatchI.H.

References patchID.

Referenced by cyclicAMIPolyPatch::neighbPatchID(), and AMIWeights::reportPatch().

Here is the caller graph for this function:

◆ neighbPatchID()

Foam::label neighbPatchID ( ) const

virtual

Neighbour patch ID.

Definition at line 900 of file cyclicAMIPolyPatch.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::name(), cyclicAMIPolyPatch::neighbPatchName(), Foam::nl, and WarningInFunction.

Referenced by cyclicACMIFvPatch::neighbFvPatch(), cyclicAMIFvPatch::neighbFvPatch(), cyclicACMIFvPatch::neighbPatch(), cyclicAMIFvPatch::neighbPatch(), cyclicACMIPointPatch::neighbPatch(), cyclicAMIPointPatch::neighbPatch(), cyclicACMIFvPatch::neighbPatchID(), and cyclicAMIFvPatch::neighbPatchID().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fraction()

Foam::scalar fraction ( ) const

inline

Particle fraction increase between AMI pathces.

Definition at line 62 of file cyclicAMIPolyPatchI.H.

Referenced by particle< Type >::hitCyclicAMIPatch().

Here is the caller graph for this function:

◆ owner()

bool owner ( ) const

virtual

Does this side own the patch?

Implements coupledPolyPatch.

Definition at line 962 of file cyclicAMIPolyPatch.C.

Referenced by cyclicAMIPolyPatch::interpolateUntransformed(), cyclicAMIPolyPatch::masterImplicit(), combine< Type, TrackingData >::operator()(), cyclicACMIFvPatch::owner(), cyclicAMIFvPatch::owner(), cyclicACMIFvPatch::updateAreas(), cyclicACMIPolyPatch::updateAreas(), and AMIWeights::writeWeightFields().

Here is the caller graph for this function:

◆ neighbPatch()

const Foam::cyclicAMIPolyPatch & neighbPatch ( ) const

virtual

Return a reference to the neighbour patch.

Reimplemented in cyclicACMIPolyPatch.

Definition at line 968 of file cyclicAMIPolyPatch.C.

Referenced by particle< Type >::hitCyclicAMIPatch(), cyclicAMIPolyPatch::interpolateUntransformed(), cyclicAMIPolyPatch::nbrCells(), cyclicAMIPolyPatch::neighbPolyPatchID(), combine< Type, TrackingData >::operator()(), cyclicACMIPointPatchField< Type >::swapAddSeparated(), and AMIWeights::writeWeightFields().

Here is the caller graph for this function:

◆ periodicPatchID()

Foam::label periodicPatchID ( ) const

Periodic patch ID (or -1)

Definition at line 936 of file cyclicAMIPolyPatch.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::nl.

Here is the call graph for this function:

◆ AMI()

const Foam::AMIPatchToPatchInterpolation & AMI ( ) const

Return a reference to the AMI interpolator.

Definition at line 975 of file cyclicAMIPolyPatch.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Referenced by cyclicACMIFvPatch::AMI(), cyclicAMIFvPatch::AMI(), assemblyFaceAreaPairGAMGAgglomeration::assemblyFaceAreaPairGAMGAgglomeration(), cyclicAMIPolyPatch::interpolateUntransformed(), cyclicAMIPolyPatch::mapCollocatedFaces(), AMIWeights::reportPatch(), and AMIWeights::writeWeightFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ weights()

const Foam::scalarListList & weights ( ) const

inline

Helper function to return the weights.

Definition at line 68 of file cyclicAMIPolyPatchI.H.

Referenced by cyclicACMIPolyPatch::scalePatchFaceAreas().

Here is the caller graph for this function:

◆ weightsSum()

const Foam::scalarField & weightsSum ( ) const

inline

Helper function to return the weights sum.

Definition at line 79 of file cyclicAMIPolyPatchI.H.

Referenced by cyclicACMIPolyPatch::scalePatchFaceAreas().

Here is the caller graph for this function:

◆ applyLowWeightCorrection()

bool applyLowWeightCorrection ( ) const

Return true if applying the low weight correction.

Definition at line 993 of file cyclicAMIPolyPatch.C.

Referenced by cyclicAMIFvPatch::applyLowWeightCorrection().

Here is the caller graph for this function:

◆ faceAreas0()

Foam::vectorField & faceAreas0 ( ) const

inline

Return access to the initial face areas.

Used for topology change

Definition at line 90 of file cyclicAMIPolyPatchI.H.

Referenced by cyclicAMIPolyPatch::setAMIFaces().

Here is the caller graph for this function:

◆ faceCentres0()

Foam::vectorField & faceCentres0 ( ) const

inline

Return access to the initial face centres.

Used for topology change

Definition at line 96 of file cyclicAMIPolyPatchI.H.

Referenced by cyclicAMIPolyPatch::setAMIFaces().

Here is the caller graph for this function:

◆ rotationAxis()

const Foam::vector & rotationAxis ( ) const

inline

Axis of rotation for rotational cyclic AMI.

Definition at line 101 of file cyclicAMIPolyPatchI.H.

◆ rotationCentre()

const Foam::point & rotationCentre ( ) const

inline

Point on axis of rotation for rotational cyclic AMI.

Definition at line 107 of file cyclicAMIPolyPatchI.H.

◆ separationVector()

const Foam::vector & separationVector ( ) const

inline

Translation vector for translational cyclic AMI.

Definition at line 113 of file cyclicAMIPolyPatchI.H.

◆ transformPosition() [1/2]

void transformPosition ( pointField & l ) const

virtual

Transform patch-based positions from nbr side to this side.

Implements coupledPolyPatch.

Definition at line 1006 of file cyclicAMIPolyPatch.C.

References forAll, s(), and Foam::transform().

Here is the call graph for this function:

◆ transformPosition() [2/2]

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

virtual

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

Implements coupledPolyPatch.

Definition at line 1041 of file cyclicAMIPolyPatch.C.

References s(), T, and Foam::transform().

Here is the call graph for this function:

◆ reverseTransformPosition()

void reverseTransformPosition	(	point &	l,
		const label	facei
	)		const

virtual

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

Definition at line 1079 of file cyclicAMIPolyPatch.C.

References s(), T, and Foam::transform().

Here is the call graph for this function:

◆ reverseTransformDirection()

void reverseTransformDirection	(	vector &	d,
		const label	facei
	)		const

virtual

Transform a patch-based direction from this side to.

nbr side

Definition at line 1117 of file cyclicAMIPolyPatch.C.

References T, and Foam::transform().

Referenced by particle< Type >::hitCyclicAMIPatch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ interpolate() [1/5]

tmp< Field< Type > > interpolate	(	const Field< Type > &	fld,
		const UList< Type > &	defaultValues = `UList< Type >()`
	)		const

Interpolate field.

Referenced by cyclicAMIFvPatch::interpolate(), and cyclicACMIPointPatchField< Type >::swapAddSeparated().

Here is the caller graph for this function:

◆ interpolate() [2/5]

tmp< Field< Type > > interpolate	(	const tmp< Field< Type > > &	tFld,
		const UList< Type > &	defaultValues = `UList< Type >()`
	)		const

Interpolate tmp field.

◆ interpolateUntransformed() [1/2]

tmp< Field< Type > > interpolateUntransformed	(	const Field< Type > &	fld,
		const UList< Type > &	defaultValues
	)		const

Interpolate without periodic.

◆ interpolate() [3/5]

void interpolate	(	const UList< Type > &	fld,
		const CombineOp &	cop,
		List< Type > &	result,
		const UList< Type > &	defaultValues = `UList<Type>()`
	)		const

Low-level interpolate List.

Commented out for now since called with non-primitives (e.g. wallPoint

from FaceCellWave) - these are missing the pTraits<Type>::rank and Foam::transform

Definition at line 162 of file cyclicAMIPolyPatchTemplates.C.

References fld().

Here is the call graph for this function:

◆ calcGeometry() [2/2]

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

virtual

Calculate the patch geometry.

Implements coupledPolyPatch.

Definition at line 1137 of file cyclicAMIPolyPatch.C.

◆ initOrder()

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

virtual

Initialize ordering for primitivePatch. Does not refer to *this (except for name() and type() etc.)

Implements coupledPolyPatch.

Reimplemented in cyclicACMIPolyPatch.

Definition at line 1150 of file cyclicAMIPolyPatch.C.

Referenced by cyclicACMIPolyPatch::initOrder().

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.

Reimplemented in cyclicACMIPolyPatch.

Definition at line 1158 of file cyclicAMIPolyPatch.C.

References Foam::faceMap(), and List< T >::setSize().

Here is the call graph for this function:

◆ pointFace()

Foam::label pointFace	(	const label	facei,
		const vector &	n,
		point &	p
	)		const

Return face index on neighbour patch which shares point p following trajectory vector n

Definition at line 1176 of file cyclicAMIPolyPatch.C.

References n, and p.

Referenced by particle< Type >::hitCyclicACMIPatch(), and particle< Type >::hitCyclicAMIPatch().

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.

Reimplemented in cyclicACMIPolyPatch, and cyclicPeriodicAMIPolyPatch.

Definition at line 1223 of file cyclicAMIPolyPatch.C.

References os(), Foam::radToDeg(), Foam::transform(), ObukhovLength::write(), Ostream::write(), Ostream::writeEntry(), Ostream::writeEntryIfDifferent(), and Foam::Zero.

Here is the call graph for this function:

◆ interpolateUntransformed() [2/2]

Foam::tmp< Foam::Field< Type > > interpolateUntransformed	(	const Field< Type > &	fld,
		const UList< Type > &	defaultValues
	)		const

Definition at line 32 of file cyclicAMIPolyPatchTemplates.C.

References cyclicAMIPolyPatch::AMI(), fld(), AMIInterpolation::interpolateToSource(), AMIInterpolation::interpolateToTarget(), cyclicAMIPolyPatch::neighbPatch(), and cyclicAMIPolyPatch::owner().

Here is the call graph for this function:

◆ interpolate() [4/5]

Foam::tmp< Foam::Field< Type > > interpolate	(	const Field< Type > &	fld,
		const UList< Type > &	defaultValues
	)		const

Definition at line 50 of file cyclicAMIPolyPatchTemplates.C.

References Foam::endl(), Foam::exit(), polyPatch::faceCentres(), Foam::FatalError, FatalErrorInFunction, fld(), forAll, Foam::gAverage(), Foam::invTransform(), patchIdentifier::name(), Foam::name(), Foam::New(), Foam::nl, Foam::Pout, R, UList< T >::size(), T, and Foam::transform().

Here is the call graph for this function:

◆ interpolate() [5/5]

Foam::tmp< Foam::Field< Type > > interpolate	(	const tmp< Field< Type > > &	tFld,
		const UList< Type > &	defaultValues
	)		const

Definition at line 151 of file cyclicAMIPolyPatchTemplates.C.

References Foam::interpolate().

Here is the call graph for this function:

Member Data Documentation

◆ nbrPatchName_

word nbrPatchName_

mutableprotected

Name of other half.

Definition at line 92 of file cyclicAMIPolyPatch.H.

Referenced by cyclicAMIPolyPatch::cyclicAMIPolyPatch().

◆ coupleGroup_

const coupleGroupIdentifier coupleGroup_

protected

Optional patchGroup to find neighbPatch.

Definition at line 95 of file cyclicAMIPolyPatch.H.

Referenced by cyclicAMIPolyPatch::cyclicAMIPolyPatch().

◆ nbrPatchID_

label nbrPatchID_

mutableprotected

Index of other half.

Definition at line 98 of file cyclicAMIPolyPatch.H.

◆ fraction_

const scalar fraction_

protected

Particle displacement fraction accross AMI.

Definition at line 101 of file cyclicAMIPolyPatch.H.

◆ rotationAxis_

vector rotationAxis_

protected

Axis of rotation for rotational cyclics.

Definition at line 109 of file cyclicAMIPolyPatch.H.

Referenced by cyclicAMIPolyPatch::cyclicAMIPolyPatch().

◆ rotationCentre_

point rotationCentre_

protected

Point on axis of rotation for rotational cyclics.

Definition at line 112 of file cyclicAMIPolyPatch.H.

Referenced by cyclicAMIPolyPatch::cyclicAMIPolyPatch().

◆ rotationAngleDefined_

bool rotationAngleDefined_

protected

Flag to show whether the rotation angle is defined.

Definition at line 115 of file cyclicAMIPolyPatch.H.

Referenced by cyclicAMIPolyPatch::cyclicAMIPolyPatch().

◆ rotationAngle_

scalar rotationAngle_

protected

Rotation angle.

Definition at line 118 of file cyclicAMIPolyPatch.H.

Referenced by cyclicAMIPolyPatch::cyclicAMIPolyPatch().

◆ separationVector_

vector separationVector_

protected

Translation vector.

Definition at line 124 of file cyclicAMIPolyPatch.H.

Referenced by cyclicAMIPolyPatch::cyclicAMIPolyPatch().

◆ periodicPatchName_

word periodicPatchName_

protected

Periodic patch name.

Definition at line 130 of file cyclicAMIPolyPatch.H.

◆ periodicPatchID_

label periodicPatchID_

mutableprotected

Periodic patch.

Definition at line 133 of file cyclicAMIPolyPatch.H.

◆ AMIPtr_

autoPtr<AMIPatchToPatchInterpolation> AMIPtr_

mutableprotected

AMI interpolation class.

Definition at line 137 of file cyclicAMIPolyPatch.H.

Referenced by cyclicACMIPolyPatch::cyclicACMIPolyPatch(), and cyclicPeriodicAMIPolyPatch::cyclicPeriodicAMIPolyPatch().

◆ surfDict_

const dictionary surfDict_

protected

Dictionary used during projection surface construction.

Definition at line 140 of file cyclicAMIPolyPatch.H.

◆ surfPtr_

autoPtr<searchableSurface> surfPtr_

mutableprotected

Projection surface.

Definition at line 143 of file cyclicAMIPolyPatch.H.

◆ createAMIFaces_

bool createAMIFaces_

mutableprotected

Flag to indicate that new AMI faces will created.

Set by the call to changeTopology

Definition at line 150 of file cyclicAMIPolyPatch.H.

Referenced by cyclicAMIPolyPatch::cyclicAMIPolyPatch(), cyclicAMIPolyPatch::restoreScaledGeometry(), and cyclicACMIPolyPatch::updateAreas().

◆ moveFaceCentres_

bool moveFaceCentres_

protected

Move face centres (default = no)

Definition at line 153 of file cyclicAMIPolyPatch.H.

Referenced by cyclicAMIPolyPatch::cyclicAMIPolyPatch(), and cyclicAMIPolyPatch::restoreScaledGeometry().

◆ updatingAMI_

bool updatingAMI_

mutableprotected

Definition at line 155 of file cyclicAMIPolyPatch.H.

◆ srcFaceIDs_

labelListList srcFaceIDs_

protected

Definition at line 157 of file cyclicAMIPolyPatch.H.

Referenced by cyclicAMIPolyPatch::cyclicAMIPolyPatch().

◆ tgtFaceIDs_

labelListList tgtFaceIDs_

protected

Definition at line 159 of file cyclicAMIPolyPatch.H.

Referenced by cyclicAMIPolyPatch::cyclicAMIPolyPatch().

◆ faceAreas0_

vectorField faceAreas0_

mutableprotected

Temporary storage for AMI face areas.

Definition at line 162 of file cyclicAMIPolyPatch.H.

Referenced by cyclicAMIPolyPatch::restoreScaledGeometry().

◆ faceCentres0_

vectorField faceCentres0_

mutableprotected

Temporary storage for AMI face centres.

Definition at line 165 of file cyclicAMIPolyPatch.H.

Referenced by cyclicAMIPolyPatch::restoreScaledGeometry().

◆ tolerance_

const Foam::scalar tolerance_ = 1e-10

static

Tolerance used e.g. for area calculations/limits.

Definition at line 376 of file cyclicAMIPolyPatch.H.

Referenced by cyclicACMIPolyPatch::updateAreas().

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

src/meshTools/AMIInterpolation/patches/cyclicAMI/cyclicAMIPolyPatch/cyclicAMIPolyPatch.H
src/meshTools/AMIInterpolation/patches/cyclicAMI/cyclicAMIPolyPatch/cyclicAMIPolyPatch.C
src/meshTools/AMIInterpolation/patches/cyclicAMI/cyclicAMIPolyPatch/cyclicAMIPolyPatchI.H
src/meshTools/AMIInterpolation/patches/cyclicAMI/cyclicAMIPolyPatch/cyclicAMIPolyPatchTemplates.C
src/meshTools/AMIInterpolation/patches/cyclicAMI/cyclicAMIPolyPatch/cyclicAMIPolyPatchTopologyChange.C

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ cyclicAMIPolyPatch() [1/5]

◆ cyclicAMIPolyPatch() [2/5]

◆ cyclicAMIPolyPatch() [3/5]

◆ cyclicAMIPolyPatch() [4/5]

◆ cyclicAMIPolyPatch() [5/5]

◆ ~cyclicAMIPolyPatch()

Member Function Documentation

◆ removeAMIFaces()

◆ addAMIFaces()

◆ setAMIFaces()

◆ restoreScaledGeometry()

◆ surfPtr()

◆ cylindricalCS()

◆ resetAMI() [1/2]

◆ resetAMI() [2/2]

◆ calcTransforms()

◆ initGeometry()

◆ calcGeometry() [1/2]

◆ initMovePoints()

◆ movePoints()

◆ initUpdateMesh()

◆ updateMesh()

◆ clearGeom()

◆ TypeName()

◆ clone() [1/3]

◆ clone() [2/3]

◆ clone() [3/3]

◆ newInternalProcFaces()

◆ nbrCells()

◆ neighbPolyPatchID()

◆ mapCollocatedFaces()

◆ masterImplicit()

◆ canResetAMI()

◆ createAMIFaces()

◆ updatingAMI()

◆ changeTopology()

◆ setTopology()

◆ coupled()

◆ neighbPatchName()

◆ neighbPatchID()

◆ fraction()

◆ owner()

◆ neighbPatch()

◆ periodicPatchID()

◆ AMI()

◆ weights()

◆ weightsSum()

◆ applyLowWeightCorrection()

◆ faceAreas0()

◆ faceCentres0()

◆ rotationAxis()

◆ rotationCentre()

◆ separationVector()

◆ transformPosition() [1/2]

◆ transformPosition() [2/2]

◆ reverseTransformPosition()

◆ reverseTransformDirection()

◆ interpolate() [1/5]

◆ interpolate() [2/5]

◆ interpolateUntransformed() [1/2]

◆ interpolate() [3/5]

◆ calcGeometry() [2/2]

◆ initOrder()

◆ order()

◆ pointFace()

◆ write()

◆ interpolateUntransformed() [2/2]

◆ interpolate() [4/5]

◆ interpolate() [5/5]

Member Data Documentation

◆ nbrPatchName_

◆ coupleGroup_

◆ nbrPatchID_