Cyclic patch for Arbitrarily Coupled Mesh Interface (ACMI). More...

#include <cyclicACMIPolyPatch.H>

Inheritance diagram for cyclicACMIPolyPatch:

Collaboration diagram for cyclicACMIPolyPatch:

Public Member Functions
	TypeName ("cyclicACMI")
	Runtime type information.
	cyclicACMIPolyPatch (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.
	cyclicACMIPolyPatch (const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm, const word &patchType, const word &defaultAMIMethod=faceAreaWeightAMI::typeName)
	Construct from dictionary.
	cyclicACMIPolyPatch (const cyclicACMIPolyPatch &, const polyBoundaryMesh &)
	Construct as copy, resetting the boundary mesh.
	cyclicACMIPolyPatch (const cyclicACMIPolyPatch &pp, const polyBoundaryMesh &bm, const label index, const label newSize, const label newStart, const word &nbrPatchName, const word &nonOverlapPatchName)
	Construct given the original patch and resetting the.
	cyclicACMIPolyPatch (const cyclicACMIPolyPatch &pp, const polyBoundaryMesh &bm, const label index, const labelUList &mapAddressing, const label newStart)
	Construct given the original patch and a map.
virtual autoPtr< polyPatch >	clone (const polyBoundaryMesh &bm) const
	Construct and return a clone, resetting the boundary mesh.
virtual autoPtr< polyPatch >	clone (const polyBoundaryMesh &bm, const label index, const label newSize, const label newStart) const
	Construct and return a clone, resetting the face list.
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.
virtual	~cyclicACMIPolyPatch ()=default
	Destructor.
virtual void	newInternalProcFaces (label &, label &) const
	Return number of new internal sub-faces and new proc faces.
virtual refPtr< labelListList >	mapCollocatedFaces () const
	Return collocated faces.
virtual const cyclicACMIPolyPatch &	neighbPatch () const
	Return a reference to the neighbour patch.
const word &	nonOverlapPatchName () const
	Non-overlapping patch name.
virtual label	nonOverlapPatchID () const
	Non-overlapping patch ID.
const polyPatch &	nonOverlapPatch () const
	Return a const reference to the non-overlapping patch.
polyPatch &	nonOverlapPatch ()
	Return a reference to the non-overlapping patch.
const scalarField &	mask () const
	Mask field where 1 = overlap(coupled), 0 = no-overlap.
virtual const scalarField &	srcMask () const
	Return the mask/weighting for the source patch.
virtual const scalarField &	tgtMask () const
	Return the mask/weighting for the target patch.
virtual void	initOrder (PstreamBuffers &, const primitivePatch &) const
	Initialize ordering for primitivePatch. Does not.
virtual bool	order (PstreamBuffers &, const primitivePatch &, labelList &faceMap, labelList &rotation) const
	Return new ordering for primitivePatch.
virtual void	write (Ostream &) const
	Write the polyPatch data as a dictionary.
virtual bool	updateAreas () const
	Update the AMI and patch areas. Return true if anything.
bool	upToDate (const regIOobject &) const
	Return true if given object is up to date with *this.
void	setUpToDate (regIOobject &) const
	Set object up to date with *this.
Public Member Functions inherited from cyclicAMIPolyPatch
	TypeName ("cyclicAMI")
	Runtime type information.
	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.
	cyclicAMIPolyPatch (const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm, const word &patchType, const word &defaultAMIMethod=faceAreaWeightAMI::typeName)
	Construct from dictionary.
	cyclicAMIPolyPatch (const cyclicAMIPolyPatch &, const polyBoundaryMesh &)
	Construct as copy, resetting the boundary mesh.
	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.
	cyclicAMIPolyPatch (const cyclicAMIPolyPatch &pp, const polyBoundaryMesh &bm, const label index, const labelUList &mapAddressing, const label newStart)
	Construct given the original patch and a map.
virtual	~cyclicAMIPolyPatch ()=default
	Destructor.
virtual const labelUList &	nbrCells () const
	Return nbrCells.
virtual label	neighbPolyPatchID () const
	Return nbr patch ID.
virtual bool	masterImplicit () const
	Return implicit master.
bool	canResetAMI () const
	Flag to indicate whether the AMI can be reset.
bool	createAMIFaces () const
	Return access to the createAMIFaces flag.
bool	updatingAMI () const
	Return access to the updated flag.
virtual bool	changeTopology () const
	Return true if this patch changes the mesh topology.
virtual bool	setTopology (polyTopoChange &topoChange)
	Set topology changes in the polyTopoChange object.
virtual bool	coupled () const
	Is patch 'coupled'. Note that on AMI the geometry is not coupled but the fields are!
const word &	neighbPatchName () const
	Neighbour patch name.
virtual label	neighbPatchID () const
	Neighbour patch ID.
scalar	fraction () const
	Particle fraction increase between AMI pathces.
virtual bool	owner () const
	Does this side own the patch?
label	periodicPatchID () const
	Periodic patch ID (or -1).
const AMIPatchToPatchInterpolation &	AMI () const
	Return a reference to the AMI interpolator.
const scalarListList &	weights () const
	Helper function to return the weights.
const scalarField &	weightsSum () const
	Helper function to return the weights sum.
bool	applyLowWeightCorrection () const
	Return true if applying the low weight correction.
vectorField &	faceAreas0 () const
	Return access to the initial face areas.
vectorField &	faceCentres0 () const
	Return access to the initial face centres.
const vector &	rotationAxis () const
	Axis of rotation for rotational cyclic AMI.
const point &	rotationCentre () const
	Point on axis of rotation for rotational cyclic AMI.
const vector &	separationVector () const
	Translation vector for translational cyclic AMI.
virtual void	transformPosition (pointField &) const
	Transform patch-based positions from nbr side to this side.
virtual void	transformPosition (point &l, const label facei) const
	Transform a patch-based position from nbr side to this side.
virtual void	reverseTransformPosition (point &l, const label facei) const
	Transform a patch-based position from this side to nbr side.
virtual void	reverseTransformDirection (vector &d, const label facei) const
	Transform a patch-based direction from this side to nbr side.
template<class Type>
tmp< Field< Type > >	interpolate (const Field< Type > &fld, const UList< Type > &defaultValues=UList< Type >()) const
	Interpolate field.
template<class Type>
tmp< Field< Type > >	interpolate (const tmp< Field< Type > > &tFld, const UList< Type > &defaultValues=UList< Type >()) const
	Interpolate tmp field.
template<class Type>
tmp< Field< Type > >	interpolateUntransformed (const Field< Type > &fld, const UList< Type > &defaultValues) const
	Interpolate without periodic.
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.
template<class Type>
void	initInterpolateUntransformed (const Field< Type > &fld, labelRange &sendRequests, labelRange &recvRequests, PtrList< List< Type > > &sendBuffers, PtrList< List< Type > > &recvBuffers, labelRange &sendRequests1, labelRange &recvRequests1, PtrList< List< Type > > &sendBuffers1, PtrList< List< Type > > &recvBuffers1) const
template<class Type>
void	initInterpolate (const Field< Type > &fld, labelRange &sendRequests, labelRange &recvRequests, PtrList< List< Type > > &sendBuffers, PtrList< List< Type > > &recvBuffers, labelRange &sendRequests1, labelRange &recvRequests1, PtrList< List< Type > > &sendBuffers1, PtrList< List< Type > > &recvBuffers1) const
template<class Type>
tmp< Field< Type > >	interpolate (const Field< Type > &localFld, const labelRange &requests, const PtrList< List< Type > > &recvBuffers, const labelRange &requests1, const PtrList< List< Type > > &recvBuffers1, const UList< Type > &defaultValues) 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)
	Calculate the patch geometry.
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.
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
template<class Type>
Foam::tmp< Foam::Field< Type > >	interpolate (const Field< Type > &localFld, const labelRange &requests, const PtrList< List< Type > > &recvBuffers, const labelRange &requests1, const PtrList< List< Type > > &recvBuffers1, const UList< Type > &defaultValues) const
Public Member Functions inherited from coupledPolyPatch
	TypeName ("coupled")
	Runtime type information.
	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.
	coupledPolyPatch (const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm, const word &patchType)
	Construct from dictionary.
	coupledPolyPatch (const coupledPolyPatch &, const polyBoundaryMesh &bm)
	Copy construct, resetting the boundary mesh.
	coupledPolyPatch (const coupledPolyPatch &, const labelList &faceCells)
	Copy construct, resetting the faceCells.
	coupledPolyPatch (const coupledPolyPatch &pp, const polyBoundaryMesh &bm, const label index, const label newSize, const label newStart)
	Construct given the original patch and resetting the face list and boundary mesh information.
	coupledPolyPatch (const coupledPolyPatch &pp, const polyBoundaryMesh &bm, const label index, const labelUList &mapAddressing, const label newStart)
	Construct given the original patch and a map.
virtual	~coupledPolyPatch ()
	Destructor.
virtual bool	neighbour () const
	Does the coupled side own the patch ?
virtual label	referPatchID () const
	The referring patchID (eg, for cyclics).
virtual transformType	transform () const
	Type of transform.
virtual transformType &	transform ()
	Type of transform.
virtual bool	separated () const
	Are the planes separated.
virtual const vectorField &	separation () const
	If the planes are separated the separation vector.
virtual bool	parallel () const
	Are the cyclic planes parallel.
virtual const tensorField &	forwardT () const
	Return face transformation tensor.
virtual const tensorField &	reverseT () const
	Return neighbour-cell transformation tensor.
virtual const boolList &	collocated () const
	Are faces collocated. Either size 0,1 or length of patch.
scalar	matchTolerance () const
Public Member Functions inherited from polyPatch
	TypeName ("patch")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, polyPatch, word,(const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType),(name, size, start, index, bm, patchType))
	declareRunTimeSelectionTable (autoPtr, polyPatch, dictionary,(const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm, const word &patchType),(name, dict, index, bm, patchType))
	polyPatch (const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType)
	Construct from components.
	polyPatch (const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &physicalType, const wordList &inGroups)
	Construct from components.
	polyPatch (const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm, const word &patchType)
	Construct from dictionary.
	polyPatch (const polyPatch &, const polyBoundaryMesh &)
	Copy construct, resetting the boundary mesh.
	polyPatch (const polyPatch &pp, const polyBoundaryMesh &bm, const label index, const label newSize, const label newStart)
	Construct given the original patch and resetting the face list and boundary mesh information.
	polyPatch (const polyPatch &pp, const polyBoundaryMesh &bm, const label index, const labelUList &mapAddressing, const label newStart)
	Construct given the original patch and a map.
	polyPatch (const polyPatch &p)
	Copy construct.
	polyPatch (const polyPatch &p, const labelList &faceCells)
	Copy construct, setting faceCells.
virtual autoPtr< polyPatch >	clone (const labelList &faceCells) const
	Construct and return a clone, setting faceCells.
virtual	~polyPatch ()
	Destructor.
virtual word	neighbRegionID () const
	Return neighbour region name.
label	offset () const noexcept
	The offset where this patch starts in the boundary face list.
label	start () const noexcept
	Return start label of this patch in the polyMesh face list.
labelRange	range () const
	Return start/size range of this patch.
const polyBoundaryMesh &	boundaryMesh () const noexcept
	Return boundaryMesh reference.
template<class T>
const UIndirectList< T >	patchInternalList (const UList< T > &internalValues) const
	Extract face cell data.
template<class T>
const List< T >::subList	patchSlice (const UList< T > &values) const
	This patch slice from the complete list, which has size mesh::nFaces(), using the number of patch faces.
template<class T>
const Field< T >::subField	patchSlice (const Field< T > &values) const
	Slice Field to patch, using the number of patch faces.
template<class T>
const List< T >::subList	boundarySlice (const UList< T > &values) const
	This patch slice from the list of boundary values, which has size mesh::nBoundaryFaces(), using the number of patch faces.
const faceList::subList	faces () const
	Return mesh faces for the patch.
const labelList::subList	faceOwner () const
	Return face owner for the patch.
const vectorField::subField	faceCentres () const
	Return face centres.
const vectorField::subField	faceAreas () const
	Return face normals.
tmp< vectorField >	faceCellCentres () const
	Return face cell centres.
tmp< scalarField >	areaFraction (const pointField &points) const
	Calculate the area fraction as the ratio of the stored face area and the area given by the face points.
tmp< scalarField >	areaFraction () const
	Return the cached area fraction. Usually only set for the non-overlap patches on ACMI.
void	areaFraction (const scalar fraction)
	Set uniform cached area fraction.
void	areaFraction (const tmp< scalarField > &fraction)
	Set cached area fraction (non-uniform).
const labelUList &	faceCells () const
	Return face-cell addressing.
const labelList &	meshEdges () const
	Return global edge index for local edges.
virtual void	clearAddressing ()
	Clear addressing.
label	whichFace (const label facei) const noexcept
	Return label of face in patch from global face label.
void	operator= (const polyPatch &p)
	Copy assignment.
Public Member Functions inherited from patchIdentifier
	patchIdentifier (const patchIdentifier &)=default
	Copy construct.
	patchIdentifier (patchIdentifier &&)=default
	Move construct.
patchIdentifier &	operator= (const patchIdentifier &)=default
	Copy assignment.
patchIdentifier &	operator= (patchIdentifier &&)=default
	Move assignment.
virtual	~patchIdentifier ()=default
	Destructor.
	patchIdentifier ()
	Default construct: name="", index=0.
	patchIdentifier (const word &name, const label index)
	Construct from mandatory components.
	patchIdentifier (const word &name, const label index, const word &physicalType, const wordList &inGroups=wordList())
	Construct from components.
	patchIdentifier (const word &name, const dictionary &dict, const label index)
	Construct from dictionary.
	patchIdentifier (const patchIdentifier &ident, const label newIndex)
	Copy construct, resetting the index (if non-negative).
	patchIdentifier (patchIdentifier &&ident, const label newIndex)
	Move construct, resetting the index (if non-negative).
const word &	name () const noexcept
	The patch name.
word &	name () noexcept
	Modifiable patch name.
label	index () const noexcept
	The index of this patch in the boundaryMesh.
label &	index () noexcept
	Modifiable index of this patch in the boundaryMesh.
const word &	physicalType () const noexcept
	The (optional) physical type of the patch.
word &	physicalType () noexcept
	Modifiable (optional) physical type of the patch.
const wordList &	inGroups () const noexcept
	The (optional) groups that the patch belongs to.
wordList &	inGroups () noexcept
	Modifiable (optional) groups that the patch belongs to.
bool	inGroup (const word &name) const
	True if given name is in a group.
void	addGroup (const word &name)
	Add (unique) group for the patch.
void	removeGroup (const word &name)
	Remove group for the patch.
void	write (Ostream &os) const
	Write (physicalType, inGroups) dictionary entries (without surrounding braces).
Public Member Functions inherited from PrimitivePatch< SubList< face >, const pointField & >
	PrimitivePatch (const SubList< face > &faces, const const pointField &&points)
	Construct from components.
	PrimitivePatch (SubList< face > &&faces, const const pointField &&points)
	Construct from components, transferring faces.
	PrimitivePatch (SubList< face > &faces, const pointField &&points, const bool reuse)
	Construct from components, reuse storage.
	PrimitivePatch (const PrimitivePatch< SubList< face >, const pointField & > &pp)
	Copy construct.
virtual	~PrimitivePatch ()
	Destructor.
void	clearOut ()
void	clearGeom ()
void	clearTopology ()
void	clearPatchMeshAddr ()
void	swap (PrimitivePatch &)=delete
	Suppress direct swapping, since storage containers may be const.
const Field< point_type > &	points () const noexcept
	Return reference to global points.
label	nFaces () const noexcept
	Number of faces in the patch.
label	nPoints () const
	Number of points supporting patch faces.
label	nEdges () const
	Number of edges in patch.
const edgeList &	edges () const
	Return list of edges, address into LOCAL point list.
const edgeList::subList	internalEdges () const
	Return sub-list of internal edges, address into LOCAL point list.
const edgeList::subList	boundaryEdges () const
	Return sub-list of boundary edges, address into LOCAL point list.
label	nInternalEdges () const
	Number of internal edges.
label	nBoundaryEdges () const
	Number of boundary edges == (nEdges() - nInternalEdges()).
bool	isInternalEdge (const label edgei) const
	Is internal edge?
const labelList &	boundaryPoints () const
	Return list of boundary points, address into LOCAL point list.
const labelListList &	faceFaces () const
	Return face-face addressing.
const labelListList &	edgeFaces () const
	Return edge-face addressing.
const labelListList &	faceEdges () const
	Return face-edge addressing.
const labelListList &	pointEdges () const
	Return point-edge addressing.
const labelListList &	pointFaces () const
	Return point-face addressing.
const List< face_type > &	localFaces () const
	Return patch faces addressing into local point list.
labelList	boundaryFaces () const
	Extract list of local faces corresponding to the boundary edges.
labelList	uniqBoundaryFaces () const
	Extract sorted list of unique local faces associated with the boundary edges.
const labelList &	meshPoints () const
	Return labelList of mesh points in patch.
const Map< label > &	meshPointMap () const
	Mesh point map.
const Field< point_type > &	localPoints () const
	Return pointField of points in patch.
const labelList &	localPointOrder () const
	Return orders the local points for most efficient search.
label	whichPoint (const label gp) const
	Given a global point index, return the local point index.
edge	meshEdge (const label edgei) const
	From patch edge to global edge using meshPoints.
edge	meshEdge (const edge &e) const
	From patch edge to global edge using meshPoints.
label	findEdge (const edge &e) const
	Search for edge (local point labels) and return its index in the edge list or -1 if not found.
labelList	meshEdges (const edgeList &allEdges, const labelListList &cellEdges, const labelList &faceCells) const
	Return labels of patch edges in the global edge list using cell addressing.
labelList	meshEdges (const edgeList &allEdges, const labelListList &pointEdges) const
	Return labels of patch edges into the global edge list using basic edge addressing.
label	meshEdge (const label edgei, const edgeList &allEdges, const labelListList &pointEdges) const
	Return label of the local patch edge into the global edge list using basic edge addressing.
labelList	meshEdges (const labelUList &edgeLabels, const edgeList &allEdges, const labelListList &pointEdges) const
	Return labels of specified patch edges into the global edge list using basic edge addressing.
const Field< point_type > &	faceCentres () const
	Return face centres for patch.
const Field< point_type > &	faceAreas () const
	Return face area vectors for patch.
const Field< scalar > &	magFaceAreas () const
	Return face area magnitudes for patch.
const Field< point_type > &	faceNormals () const
	Return face unit normals for patch.
const Field< point_type > &	pointNormals () const
	Return point normals for patch.
Pair< point_type >	box () const
	The enclosing (bounding) box for the patch points.
scalar	sphere (const label facei) const
	The enclosing (bounding) sphere radius^2 for specified face.
bool	hasFaceAreas () const
bool	hasFaceCentres () const
bool	hasFaceNormals () const
bool	hasPointNormals () const
bool	hasBoundaryPoints () const
bool	hasEdges () const
bool	hasFaceFaces () const
bool	hasEdgeFaces () const
bool	hasFaceEdges () const
bool	hasPointEdges () const
bool	hasPointFaces () const
bool	hasMeshPoints () const
bool	hasMeshPointMap () const
List< objectHit >	projectPoints (const ToPatch &targetPatch, const Field< point_type > &projectionDirection, const intersection::algorithm=intersection::FULL_RAY, const intersection::direction=intersection::VECTOR) const
	Project vertices of patch onto another patch.
List< objectHit >	projectFaceCentres (const ToPatch &targetPatch, const Field< point_type > &projectionDirection, const intersection::algorithm=intersection::FULL_RAY, const intersection::direction=intersection::VECTOR) const
	Project vertices of patch onto another patch.
const labelListList &	edgeLoops () const
	Return list of closed loops of boundary vertices.
surfaceTopo	surfaceType (labelHashSet *badEdgesPtr=nullptr) const
	Calculate surface type formed by patch, optionally recording the indices of illegal edges.
bool	checkTopology (const bool report=false, labelHashSet *pointSetPtr=nullptr) const
	Check surface formed by patch for manifoldness (see above).
bool	checkPointManifold (const bool report=false, labelHashSet *pointSetPtr=nullptr) const
	Checks primitivePatch for faces sharing point but not edge.
void	operator= (const PrimitivePatch< SubList< face >, const pointField & > &rhs)
	Copy assign faces. Leave points alone (could be a reference).
void	operator= (PrimitivePatch< SubList< face >, const pointField & > &&rhs)
	Move assign faces. Leave points alone (could be a reference).
label	whichEdge (const edge &e) const
	Identical to findEdge.
Foam::List< Foam::objectHit >	projectPoints (const ToPatch &targetPatch, const Field< typename Foam::PrimitivePatch< SubList< face >, const pointField & >::point_type > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const
Foam::List< Foam::objectHit >	projectFaceCentres (const ToPatch &targetPatch, const Field< typename Foam::PrimitivePatch< SubList< face >, const pointField & >::point_type > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const
Public Member Functions inherited from PrimitivePatchBase
	ClassName ("PrimitivePatch")
	Runtime type information.
	PrimitivePatchBase ()=default
	Default construct.
Public Member Functions inherited from SubList< face >
	SubList () noexcept=default
	Default construct, zero-sized and nullptr.
	SubList (const SubList< face > &) noexcept=default
	Copy construct, shallow copy.
	SubList (const UList< face > &list) noexcept
	Construct from UList, the entire size.
	SubList (const FixedList< face, N > &list) noexcept
	Construct from FixedList, the entire size.
	SubList (const UList< face > &list, const label len)
	Construct from UList and sub-list size, start at 0.
	SubList (const UList< face > &list, const label len, const label start)
	Construct from UList, sub-list size and start index.
	SubList (const UList< face > &list, const labelRange &range)
	Construct from UList and a (start,size) range.
	SubList (const labelRange &range, const UList< face > &list)
	Construct from UList and a (start,size) range, but bypassing run-time range checking.
UList< face > &	reset (std::nullptr_t) noexcept
	Reset to zero-sized and nullptr.
UList< face > &	reset (const UList< face > &list) noexcept
	Reset to use entire UList.
UList< face > &	reset (const UList< face > &list, const label len)
	Reset to use UList with sub-list size, start at 0.
UList< face > &	reset (const UList< face > &list, const label len, const label start)
	Reset to use UList with sub-list size and start index.
UList< face > &	reset (const UList< face > &list, const labelRange &range)
	Reset to use UList with a (start,size) range.
UList< face > &	reset (const labelRange &range, const UList< face > &list)
	Reset to use UList with a (start,size) range, but bypassing run-time range checking.
	operator const Foam::List< face > & () const
	Allow cast to a const List<T>&.
void	operator= (const SubList< face > &list)
	Copy assign entries (deep copy) from given sub-list. Sizes must match!
void	operator= (const UList< face > &list)
	Copy assign entries (deep copy) from given list. Sizes must match!
void	operator= (const IndirectListBase< face, Addr > &list)
	Copy assign entries from given indirect list. Sizes must match!
void	operator= (const face &val)
	Assign all entries to the given value.
void	operator= (Foam::zero)
	Assign all entries to zero.
	operator const Foam::List< face > & () const
	Allow cast to a const List<T>&.
Public Member Functions inherited from UList< face >
	UList (const UList< face > &) noexcept=default
	Copy construct, shallow copy.
	UList (UList< face > &&) noexcept=default
	Move construct, shallow copy.
UList< face > &	operator= (const UList< face > &)=delete
	No copy assignment (default: shallow copy).
UList< face > &	operator= (UList< face > &&) noexcept=default
	Move assignment, shallow copy.
constexpr	UList () noexcept
	Default construct, zero-sized and nullptr.
	UList (face *__restrict__ ptr, const label len) noexcept
	Construct from components.
	UList (SubList< face > &&) noexcept
	Move construct from a SubList, shallow copy.
label	fcIndex (const label i) const noexcept
	The forward circular index. The next index in the list which returns to the first at the end of the list.
label	rcIndex (const label i) const noexcept
	The reverse circular index. The previous index in the list which returns to the last at the beginning of the list.
const face &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list).
face &	fcValue (const label i)
	Return forward circular value (ie, next value in the list).
const face &	rcValue (const label i) const
	Return reverse circular value (ie, previous value in the list).
face &	rcValue (const label i)
	Return reverse circular value (ie, previous value in the list).
const face *	cdata () const noexcept
	Return pointer to the underlying array serving as data storage.
face *	data () noexcept
	Return pointer to the underlying array serving as data storage.
const char *	cdata_bytes () const noexcept
	Return pointer to the underlying array serving as data storage,.
char *	data_bytes () noexcept
	Return pointer to the underlying array serving as data storage,.
face &	front ()
	Access first element of the list, position [0].
const face &	front () const
	Access first element of the list.
face &	back ()
	Access last element of the list, position [size()-1].
const face &	back () const
	Access last element of the list, position [size()-1].
std::streamsize	size_bytes () const noexcept
	Number of contiguous bytes for the List data.
std::streamsize	byteSize () const
	Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous.
void	checkStart (const label start) const
	Check start is within valid range [0,size).
void	checkSize (const label size) const
	Check size is within valid range [0,size].
void	checkRange (const label start, const label len) const
	Check that start and length define a valid range.
void	checkIndex (const label i) const
	Check index is within valid range [0,size).
bool	uniform () const
	True if all entries have identical values, and list is non-empty.
bool	contains (const face &val) const
	True if the value is contained in the list.
bool	contains (const face &val, label pos, label len=-1) const
	Is the value contained in the list?
label	find (const face &val) const
	Find index of the first occurrence of the value.
label	find (const face &val, label pos, label len=-1) const
	Find index of the first occurrence of the value.
label	rfind (const face &val, label pos=-1) const
	Find index of the last occurrence of the value.
void	moveFirst (const label i)
	Move element to the first position.
void	moveLast (const label i)
	Move element to the last position.
void	swapFirst (const label i)
	Swap element with the first element. Fatal on an empty list.
void	swapLast (const label i)
	Swap element with the last element. Fatal on an empty list.
void	shallowCopy (face *__restrict__ ptr, const label len) noexcept
	Copy the pointer and size.
void	shallowCopy (std::nullptr_t) noexcept
	Copy nullptr and zero size.
void	shallowCopy (const UList< face > &list) noexcept
	Copy the pointer and size held by the given UList.
void	deepCopy (const UList< face > &list)
	Copy elements of the given UList. Sizes must match!
void	deepCopy (const IndirectListBase< face, Addr > &list)
	Copy elements of the given indirect list. Sizes must match!
SubList< face >	slice (const label pos, label len=-1)
	Return SubList slice (non-const access) - no range checking.
const SubList< face >	slice (const label pos, label len=-1) const
	Return SubList slice (const access) - no range checking.
SubList< face >	slice (const labelRange &range)
	Return SubList slice (non-const access) - with range checking.
const SubList< face >	slice (const labelRange &range) const
	Return SubList slice (const access) - with range checking.
face &	operator[] (const label i)
	Return element of UList.
const face &	operator[] (const label i) const
	Return element of constant UList.
	operator const Foam::List< face > & () const
	Allow cast to a const List<T>&.
void	operator= (const face &val)
	Assignment of all entries to the given value.
void	operator= (Foam::zero)
	Assignment of all entries to zero.
iterator	begin () noexcept
	Return an iterator to begin traversing the UList.
iterator	end () noexcept
	Return an iterator to end traversing the UList.
iterator	begin (const label i) noexcept
	Return iterator at offset i from begin, clamped to [0,size] range.
const_iterator	cbegin () const noexcept
	Return const_iterator to begin traversing the constant UList.
const_iterator	cend () const noexcept
	Return const_iterator to end traversing the constant UList.
const_iterator	begin () const noexcept
	Return const_iterator to begin traversing the constant UList.
const_iterator	end () const noexcept
	Return const_iterator to end traversing the constant UList.
const_iterator	cbegin (const label i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,size] range.
const_iterator	begin (const label i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,size] range.
reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the UList.
reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the UList.
const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing the UList.
const_reverse_iterator	rbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator	rend () const
	Return const_reverse_iterator to end reverse traversing the UList.
bool	empty () const noexcept
	True if List is empty (ie, size() is zero).
label	size () const noexcept
	The number of elements in the container.
label	capacity () const noexcept
	Size of the underlying storage.
void	swap (UList< face > &list) noexcept
	Swap content with another UList of the same type in constant time.
bool	operator== (const UList< face > &list) const
	Equality operation on ULists of the same type.
bool	operator!= (const UList< face > &list) const
	The opposite of the equality operation. Takes linear time.
bool	operator< (const UList< face > &list) const
	Compare two ULists lexicographically. Takes linear time.
bool	operator> (const UList< face > &list) const
	Compare two ULists lexicographically. Takes linear time.
bool	operator<= (const UList< face > &list) const
	Return true if !(a > b). Takes linear time.
bool	operator>= (const UList< face > &list) const
	Return true if !(a < b). Takes linear time.
Istream &	readList (Istream &is)
	Read List contents from Istream.
void	writeEntry (const word &keyword, Ostream &os) const
	Write the List as a dictionary entry with keyword.
Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen.
bool	all () const
	True if all entries are 'true' or if the list is empty.
bool	any () const
	True if any entries are 'true'.
bool	none () const
	True if no entries are 'true'.
bool	test (const label i) const
	Test `bool` value at specified position, always false for out-of-range access.
bool	get (const label i) const
	Return `bool` value at specified position, always false for out-of-range access.
bool	unset (const label i)
	Unset the `bool` entry at specified position, always false for out-of-range access.
std::string_view	view () const
	Return a string_view of the charList. Content is non-modifiable.
face &	first ()
	Access first element of the list, position [0].
const face &	first () const
	Access first element of the list.
face &	last ()
	Access last element of the list, position [size()-1].
const face &	last () const
	Access last element of the list, position [size()-1].
bool	found (const face &val, label pos=0) const
	Same as contains().
auto	expr () const
	Wrap value as expression.
void	operator= (const Expression::ListExpression< E > &expr)
	Assign values from expression.
	operator const Foam::List< face > & () const
	Allow cast to a const List<T>&.

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

Protected Member Functions
void	reportCoverage (const word &name, const scalarField &weightSum) const
	Report coverage statics, e.g. number of uncovered/blended/covered faces.
virtual void	resetAMI (const UList< point > &points) const
	Reset the AMI interpolator, supply patch points.
virtual void	resetAMI () const
	Reset the AMI interpolator, use current patch points.
virtual void	scalePatchFaceAreas ()
	Scale patch face areas to maintain physical area.
virtual void	scalePatchFaceAreas (const cyclicACMIPolyPatch &acmipp, const scalarField &mask, const vectorList &faceArea, const vectorList &noFaceArea)
	Scale patch face areas to maintain physical area.
virtual void	initGeometry (PstreamBuffers &)
	Initialise the calculation of the patch geometry.
virtual void	calcGeometry (PstreamBuffers &)
	Calculate the patch geometry.
virtual void	initMovePoints (PstreamBuffers &pBufs, const pointField &)
	Initialise the patches for moving points.
virtual void	movePoints (PstreamBuffers &pBufs, const pointField &)
	Correct patches after moving points.
virtual void	initUpdateMesh (PstreamBuffers &)
	Initialise the update of the patch topology.
virtual void	updateMesh (PstreamBuffers &)
	Update of the patch topology.
virtual void	clearGeom ()
	Clear geometry.
Protected Member Functions inherited from cyclicAMIPolyPatch
virtual bool	removeAMIFaces (polyTopoChange &topoChange)
	Collect faces to remove in the topoChange container.
virtual bool	addAMIFaces (polyTopoChange &topoChange)
	Collect faces to add in the topoChange container.
virtual void	setAMIFaces ()
	Set properties of newly inserted faces after topological changes.
virtual void	restoreScaledGeometry ()
	Helper to re-apply the geometric scaling lost during mesh updates.
const autoPtr< searchableSurface > &	surfPtr () const
	Create and return pointer to the projection surface.
autoPtr< coordSystem::cylindrical >	cylindricalCS () const
	Create a coordinate system from the periodic patch (or nullptr).
virtual void	calcTransforms ()
	Recalculate the transformation tensors.
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.
Protected Member Functions inherited from polyPatch
virtual void	movePoints (const Field< point_type > &)
	Inherit movePoints from primitivePatch.
Protected Member Functions inherited from UList< face >
void	setAddressableSize (const label n) noexcept
	Set addressed size to be inconsistent with allocated storage.
void	size (const label n)
	Older name for setAddressableSize.
void	writeEntry (Ostream &os) const
	Write the UList with its compound type.
labelRange	validateRange (const labelRange &requestedRange) const
	Return a validated (start,size) subset range, which means that it always addresses a valid section of the list.
void	fill_uniform (const face &val)
	Assign all entries to the given value.
void	fill_uniform (Foam::zero)
	Assign all entries to zero.

Additional Inherited Members
Public Types inherited from coupledPolyPatch
enum	transformType { UNKNOWN , ROTATIONAL , TRANSLATIONAL , COINCIDENTFULLMATCH , NOORDERING }
Public Types inherited from PrimitivePatch< SubList< face >, const pointField & >
enum	surfaceTopo
	Enumeration defining the surface type. Used in check routines. More...
typedef std::remove_reference< SubList< face > >::type::value_type	face_type
	The face type.
typedef std::remove_reference< const pointField & >::type::value_type	point_type
	The point type.
typedef SubList< face >	FaceListType
	The face list type.
typedef const pointField &	PointFieldType
	The point field type.
typedef face_type	FaceType
	Deprecated(2020-03) prefer face_type typedef.
Public Types inherited from UList< face >
typedef face	value_type
	The value type the list contains.
typedef face *	pointer
	The pointer type for non-const access to value_type items.
typedef const face *	const_pointer
	The pointer type for const access to value_type items.
typedef face &	reference
	The type used for storing into value_type objects.
typedef const face &	const_reference
	The type used for reading from constant value_type objects.
typedef face *	iterator
	Random access iterator for traversing a UList.
typedef const face *	const_iterator
	Random access iterator for traversing a UList.
typedef label	size_type
	The type to represent the size of a UList.
typedef label	difference_type
	The difference between iterator objects.
typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator (non-const access).
typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator (const access).
using	is_List
	Have unique tag.
Static Public Attributes inherited from cyclicAMIPolyPatch
static const scalar	tolerance_ = 1e-10
	Tolerance used e.g. for area calculations/limits.
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.
Static Protected Member Functions inherited from coupledPolyPatch
static void	writeOBJ (Ostream &os, const point &pt)
	Write point in OBJ format.
static void	writeOBJ (Ostream &, const pointField &, const labelList &)
	Write selected points in OBJ format.
static void	writeOBJ (const fileName &, const UList< face > &, const pointField &)
	Write patch.
static void	writeOBJ (Ostream &os, const point &p0, const point &p1, label &vertI)
	Write edge in OBJ format.
static pointField	getAnchorPoints (const UList< face > &, const pointField &, const transformType)
	Get a unique anchor point for all faces.
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.
Protected Attributes inherited from cyclicAMIPolyPatch
word	nbrPatchName_
	Name of other half.
const coupleGroupIdentifier	coupleGroup_
	Optional patchGroup to find neighbPatch.
label	nbrPatchID_
	Index of other half.
const scalar	fraction_
	Particle displacement fraction across AMI.
vector	rotationAxis_
	Axis of rotation for rotational cyclics.
point	rotationCentre_
	Point on axis of rotation for rotational cyclics.
bool	rotationAngleDefined_
	Flag to show whether the rotation angle is defined.
scalar	rotationAngle_
	Rotation angle.
vector	separationVector_
	Translation vector.
word	periodicPatchName_
	Periodic patch name.
label	periodicPatchID_
	Periodic patch.
autoPtr< AMIPatchToPatchInterpolation >	AMIPtr_
	AMI interpolation class.
const dictionary	surfDict_
	Dictionary used during projection surface construction.
autoPtr< searchableSurface >	surfPtr_
	Projection surface.
bool	createAMIFaces_
	Flag to indicate that new AMI faces will created.
bool	moveFaceCentres_
	Move face centres (default = no).
bool	updatingAMI_
labelListList	srcFaceIDs_
labelListList	tgtFaceIDs_
vectorField	faceAreas0_
	Temporary storage for AMI face areas.
vectorField	faceCentres0_
	Temporary storage for AMI face centres.
bool	cacheAMI_

Detailed Description

Cyclic patch for Arbitrarily Coupled Mesh Interface (ACMI).

Mixes cyclicAMI behaviour with non-coupled patch behaviour using the overlap area fraction. The non-coupled patch is specified through the nonOverlapPatch keyword.

Usage: Example of the patch specification:

type cyclicACMI; neighbourPatch ACMI2_couple; // cyclicAMI neighbour patch nonOverlapPatch ACMI1_blockage; // patch for uncoupled faces

Optional time-dependent scaling (PatchFunction1) scale table ( (0.00 1.0) (0.02 1.0) (0.0201 0.0) );

See also: cyclicAMIPolyPatch.C

Source files

Definition at line 74 of file cyclicACMIPolyPatch.H.

Constructor & Destructor Documentation

◆ cyclicACMIPolyPatch() [1/5]

cyclicACMIPolyPatch	(	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 601 of file cyclicACMIPolyPatch.C.

References cyclicAMIPolyPatch::AMIPtr_, cyclicAMIPolyPatch::cyclicAMIPolyPatch(), Foam::dimTime, patchIdentifier::index(), mesh, Foam::name(), UList< face >::size(), polyPatch::start(), and Foam::transform().

Referenced by clone(), clone(), cyclicACMIPolyPatch(), cyclicACMIPolyPatch(), cyclicACMIPolyPatch(), resetAMI(), scalePatchFaceAreas(), scalePatchFaceAreas(), TypeName(), updateAreas(), and ~cyclicACMIPolyPatch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cyclicACMIPolyPatch() [2/5]

cyclicACMIPolyPatch	(	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 650 of file cyclicACMIPolyPatch.C.

References cyclicAMIPolyPatch::AMIPtr_, cyclicAMIPolyPatch::cyclicAMIPolyPatch(), dict, Foam::dimTime, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, UList< face >::get(), patchIdentifier::index(), mesh, and Foam::name().

Here is the call graph for this function:

◆ cyclicACMIPolyPatch() [3/5]

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

Construct as copy, resetting the boundary mesh.

Definition at line 696 of file cyclicACMIPolyPatch.C.

References cyclicAMIPolyPatch::AMIPtr_, clone(), cyclicACMIPolyPatch(), cyclicAMIPolyPatch::cyclicAMIPolyPatch(), Foam::dimTime, mesh, and pp().

Here is the call graph for this function:

◆ cyclicACMIPolyPatch() [4/5]

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

Construct given the original patch and resetting the.

face list and boundary mesh information

Definition at line 730 of file cyclicACMIPolyPatch.C.

References cyclicAMIPolyPatch::AMIPtr_, clone(), cyclicACMIPolyPatch(), cyclicAMIPolyPatch::cyclicAMIPolyPatch(), Foam::dimTime, Foam::exit(), Foam::FatalError, FatalErrorInFunction, patchIdentifier::index(), mesh, name, nonOverlapPatchName(), and pp().

Here is the call graph for this function:

◆ cyclicACMIPolyPatch() [5/5]

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

Construct given the original patch and a map.

Definition at line 777 of file cyclicACMIPolyPatch.C.

References cyclicAMIPolyPatch::AMIPtr_, clone(), cyclicACMIPolyPatch(), cyclicAMIPolyPatch::cyclicAMIPolyPatch(), Foam::dimTime, patchIdentifier::index(), mesh, and pp().

Here is the call graph for this function:

◆ ~cyclicACMIPolyPatch()

virtual ~cyclicACMIPolyPatch ( )

virtualdefault

Destructor.

References cyclicACMIPolyPatch(), and Foam::faceMap().

Here is the call graph for this function:

Member Function Documentation

◆ reportCoverage()

void reportCoverage	(	const word &	name,
		const scalarField &	weightSum ) const

protected

Report coverage statics, e.g. number of uncovered/blended/covered faces.

Definition at line 151 of file cyclicACMIPolyPatch.C.

References Foam::endl(), Foam::Info, Foam::name(), Foam::reduce(), Foam::returnReduce(), UList< T >::size(), Foam::sum(), and cyclicAMIPolyPatch::tolerance_.

Referenced by resetAMI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetAMI() [1/2]

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

protectedvirtual

Reset the AMI interpolator, supply patch points.

Reimplemented from cyclicAMIPolyPatch.

Definition at line 300 of file cyclicACMIPolyPatch.C.

References Foam::abort(), cyclicAMIPolyPatch::AMI(), Foam::clamp(), cyclicACMIPolyPatch(), DebugPout, Foam::endl(), Foam::FatalError, FatalErrorInFunction, boundaryMesh::mesh(), mesh, name, neighbPatch(), nonOverlapPatch(), cyclicAMIPolyPatch::owner(), points, Foam::Pout, reportCoverage(), and cyclicAMIPolyPatch::resetAMI().

Referenced by initGeometry(), initMovePoints(), and resetAMI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetAMI() [2/2]

void resetAMI ( ) const

protectedvirtual

Reset the AMI interpolator, use current patch points.

Reimplemented from cyclicAMIPolyPatch.

Definition at line 294 of file cyclicACMIPolyPatch.C.

References mesh, points, and resetAMI().

Here is the call graph for this function:

◆ scalePatchFaceAreas() [1/2]

void scalePatchFaceAreas ( )

protectedvirtual

Scale patch face areas to maintain physical area.

Definition at line 412 of file cyclicACMIPolyPatch.C.

References cyclicAMIPolyPatch::canResetAMI(), cyclicACMIPolyPatch(), Foam::endl(), polyPatch::faceAreas(), PrimitivePatch< SubList< face >, const pointField & >::faceAreas(), polyPatch::faceCells(), Foam::Info, boundaryMesh::mesh(), mesh, patchIdentifier::name(), neighbPatch(), Foam::nl, nonOverlapPatch(), cyclicAMIPolyPatch::owner(), scalePatchFaceAreas(), and Foam::sum().

Referenced by initGeometry(), initMovePoints(), scalePatchFaceAreas(), and updateAreas().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ scalePatchFaceAreas() [2/2]

void scalePatchFaceAreas	(	const cyclicACMIPolyPatch &	acmipp,
		const scalarField &	mask,
		const vectorList &	faceArea,
		const vectorList &	noFaceArea )

protectedvirtual

Scale patch face areas to maintain physical area.

Definition at line 180 of file cyclicACMIPolyPatch.C.

References polyPatch::areaFraction(), cyclicAMIPolyPatch::createAMIFaces_, cyclicACMIPolyPatch(), DebugPout, Foam::endl(), polyPatch::faceAreas(), polyPatch::faceCells(), forAll, mask(), Foam::max(), boundaryMesh::mesh(), mesh, Foam::min(), patchIdentifier::name(), Foam::nl, nonOverlapPatch(), UList< T >::size(), UList< face >::size(), Foam::sum(), cyclicAMIPolyPatch::tolerance_, Foam::uniqueSort(), primitiveMeshTools::updateCellCentresAndVols(), WarningInFunction, cyclicAMIPolyPatch::weights(), and cyclicAMIPolyPatch::weightsSum().

Here is the call graph for this function:

◆ initGeometry()

void initGeometry ( PstreamBuffers & pBufs )

protectedvirtual

Initialise the calculation of the patch geometry.

Reimplemented from cyclicAMIPolyPatch.

Definition at line 484 of file cyclicACMIPolyPatch.C.

References cyclicAMIPolyPatch::canResetAMI(), cyclicAMIPolyPatch::createAMIFaces_, DebugPout, Foam::endl(), cyclicAMIPolyPatch::initGeometry(), name, resetAMI(), and scalePatchFaceAreas().

Here is the call graph for this function:

◆ calcGeometry()

void calcGeometry ( PstreamBuffers & pBufs )

protectedvirtual

Calculate the patch geometry.

Reimplemented from cyclicAMIPolyPatch.

Definition at line 502 of file cyclicACMIPolyPatch.C.

References cyclicAMIPolyPatch::calcGeometry(), DebugPout, Foam::endl(), and name.

Here is the call graph for this function:

◆ initMovePoints()

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

protectedvirtual

Initialise the patches for moving points.

Reimplemented from cyclicAMIPolyPatch.

Definition at line 510 of file cyclicACMIPolyPatch.C.

References cyclicAMIPolyPatch::canResetAMI(), cyclicAMIPolyPatch::createAMIFaces_, DebugPout, Foam::endl(), cyclicAMIPolyPatch::initMovePoints(), name, p, resetAMI(), and scalePatchFaceAreas().

Here is the call graph for this function:

◆ movePoints()

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

protectedvirtual

Correct patches after moving points.

Reimplemented from cyclicAMIPolyPatch.

Definition at line 530 of file cyclicACMIPolyPatch.C.

References DebugPout, Foam::endl(), cyclicAMIPolyPatch::movePoints(), name, and p.

Here is the call graph for this function:

◆ initUpdateMesh()

void initUpdateMesh ( PstreamBuffers & pBufs )

protectedvirtual

Initialise the update of the patch topology.

Reimplemented from cyclicAMIPolyPatch.

Definition at line 543 of file cyclicACMIPolyPatch.C.

References DebugPout, Foam::endl(), cyclicAMIPolyPatch::initUpdateMesh(), and name.

Here is the call graph for this function:

◆ updateMesh()

void updateMesh ( PstreamBuffers & pBufs )

protectedvirtual

Update of the patch topology.

Reimplemented from cyclicAMIPolyPatch.

Definition at line 551 of file cyclicACMIPolyPatch.C.

References DebugPout, Foam::endl(), name, and cyclicAMIPolyPatch::updateMesh().

Here is the call graph for this function:

◆ clearGeom()

void clearGeom ( )

protectedvirtual

Clear geometry.

Reimplemented from cyclicAMIPolyPatch.

Definition at line 559 of file cyclicACMIPolyPatch.C.

References cyclicAMIPolyPatch::clearGeom(), DebugPout, Foam::endl(), and name.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "cyclicACMI" )

Runtime type information.

References cyclicACMIPolyPatch(), dict, patchIdentifier::index(), Foam::name(), nonOverlapPatchName(), pp(), UList< face >::size(), polyPatch::start(), Foam::transform(), and coupledPolyPatch::UNKNOWN.

Here is the call graph for this function:

◆ clone() [1/3]

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

inlinevirtual

Construct and return a clone, resetting the boundary mesh.

Reimplemented from cyclicAMIPolyPatch.

Definition at line 302 of file cyclicACMIPolyPatch.H.

References autoPtr< T >::NewFrom().

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

Here is the call graph for this function:

Here is the caller 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 cyclicAMIPolyPatch.

Definition at line 312 of file cyclicACMIPolyPatch.H.

References cyclicACMIPolyPatch(), patchIdentifier::index(), and cyclicAMIPolyPatch::neighbPatchName().

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

Definition at line 340 of file cyclicACMIPolyPatch.H.

References cyclicACMIPolyPatch(), and patchIdentifier::index().

Here is the call graph for this function:

◆ newInternalProcFaces()

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

virtual

Return number of new internal sub-faces and new proc faces.

Reimplemented from cyclicAMIPolyPatch.

Definition at line 813 of file cyclicACMIPolyPatch.C.

References cyclicAMIPolyPatch::AMI(), forAll, neighbPatch(), UList< face >::size(), srcMask(), and cyclicAMIPolyPatch::tolerance_.

Here is the call graph for this function:

◆ mapCollocatedFaces()

Foam::refPtr< Foam::labelListList > mapCollocatedFaces ( ) const

virtual

Return collocated faces.

Reimplemented from cyclicAMIPolyPatch.

Definition at line 850 of file cyclicACMIPolyPatch.C.

References cyclicAMIPolyPatch::AMI(), forAll, List< T >::setSize(), UList< T >::size(), UList< face >::size(), srcMask(), and cyclicAMIPolyPatch::tolerance_.

Here is the call graph for this function:

◆ neighbPatch()

const Foam::cyclicACMIPolyPatch & neighbPatch ( ) const

virtual

Return a reference to the neighbour patch.

Reimplemented from cyclicAMIPolyPatch.

Definition at line 873 of file cyclicACMIPolyPatch.C.

References Foam::endl(), name, cyclicAMIPolyPatch::neighbPatchID(), cyclicAMIPolyPatch::owner(), pp(), Foam::refCast(), and WarningInFunction.

Referenced by mask(), newInternalProcFaces(), resetAMI(), scalePatchFaceAreas(), and updateAreas().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nonOverlapPatchName()

const Foam::word & nonOverlapPatchName ( ) const

inline

Non-overlapping patch name.

Definition at line 23 of file cyclicACMIPolyPatchI.H.

Referenced by cyclicACMIPolyPatch(), and TypeName().

Here is the caller graph for this function:

◆ nonOverlapPatchID()

Foam::label nonOverlapPatchID ( ) const

virtual

Non-overlapping patch ID.

Definition at line 891 of file cyclicACMIPolyPatch.C.

References Foam::exit(), polyPatch::faceAreas(), Foam::FatalError, FatalErrorInFunction, forAll, patchIdentifier::index(), Foam::mag(), patchIdentifier::name(), name, Foam::nl, UList< T >::size(), UList< face >::size(), cyclicAMIPolyPatch::tolerance_, and Foam::type().

Referenced by nonOverlapPatch(), and nonOverlapPatch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nonOverlapPatch() [1/2]

const Foam::polyPatch & nonOverlapPatch ( ) const

inline

Return a const reference to the non-overlapping patch.

Definition at line 29 of file cyclicACMIPolyPatchI.H.

References nonOverlapPatchID().

Referenced by particle< Type >::hitCyclicACMIPatch(), resetAMI(), scalePatchFaceAreas(), scalePatchFaceAreas(), and updateAreas().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nonOverlapPatch() [2/2]

Foam::polyPatch & nonOverlapPatch ( )

inline

Return a reference to the non-overlapping patch.

Definition at line 38 of file cyclicACMIPolyPatchI.H.

References nonOverlapPatchID().

Here is the call graph for this function:

◆ mask()

const Foam::scalarField & mask ( ) const

inline

Mask field where 1 = overlap(coupled), 0 = no-overlap.

Definition at line 47 of file cyclicACMIPolyPatchI.H.

References neighbPatch(), cyclicAMIPolyPatch::owner(), and srcMask().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ srcMask()

const Foam::scalarField & srcMask ( ) const

virtual

Return the mask/weighting for the source patch.

Definition at line 567 of file cyclicACMIPolyPatch.C.

References updateAreas().

Referenced by mapCollocatedFaces(), mask(), and newInternalProcFaces().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ tgtMask()

const Foam::scalarField & tgtMask ( ) const

virtual

Return the mask/weighting for the target patch.

Definition at line 583 of file cyclicACMIPolyPatch.C.

References updateAreas().

Here is the call graph for this function:

◆ tolerance()

Foam::scalar tolerance ( )

inlinestatic

Overlap tolerance.

Definition at line 58 of file cyclicACMIPolyPatchI.H.

References cyclicAMIPolyPatch::tolerance_.

Referenced by assemblyFaceAreaPairGAMGAgglomeration::assemblyFaceAreaPairGAMGAgglomeration(), particle< Type >::hitCyclicACMIPatch(), and cyclicACMIFvPatch::makeWeights().

Here is the caller graph for this function:

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

Reimplemented from cyclicAMIPolyPatch.

Definition at line 957 of file cyclicACMIPolyPatch.C.

References cyclicAMIPolyPatch::initOrder(), and pp().

Here is the call 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.

Reimplemented from cyclicAMIPolyPatch.

Definition at line 967 of file cyclicACMIPolyPatch.C.

References Foam::faceMap(), cyclicAMIPolyPatch::order(), and pp().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write the polyPatch data as a dictionary.

Reimplemented from cyclicAMIPolyPatch.

Definition at line 979 of file cyclicACMIPolyPatch.C.

References os(), cyclicAMIPolyPatch::owner(), and cyclicAMIPolyPatch::write().

Here is the call graph for this function:

◆ updateAreas()

bool updateAreas ( ) const

virtual

Update the AMI and patch areas. Return true if anything.

updated

Definition at line 40 of file cyclicACMIPolyPatch.C.

References polyPatch::boundaryMesh(), cyclicAMIPolyPatch::createAMIFaces_, cyclicACMIPolyPatch(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::gAverage(), Foam::max(), polyBoundaryMesh::mesh(), mesh, Foam::min(), patchIdentifier::name(), name, neighbPatch(), nonOverlapPatch(), cyclicAMIPolyPatch::owner(), Foam::Pout, scalePatchFaceAreas(), cyclicAMIPolyPatch::tolerance_, and WarningInFunction.

Referenced by srcMask(), and tgtMask().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ upToDate()

bool upToDate ( const regIOobject & io ) const

Return true if given object is up to date with *this.

(note : like regIOobject::upToDate but operates on object)

Definition at line 136 of file cyclicACMIPolyPatch.C.

References io.

◆ setUpToDate()

void setUpToDate ( regIOobject & io ) const

Set object up to date with *this.

(note : like regIOobject::setUpToDate but operates on object)

Definition at line 145 of file cyclicACMIPolyPatch.C.

References io.

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

src/meshTools/AMIInterpolation/patches/cyclicACMI/cyclicACMIPolyPatch/cyclicACMIPolyPatch.H
src/meshTools/AMIInterpolation/patches/cyclicACMI/cyclicACMIPolyPatch/cyclicACMIPolyPatch.C
src/meshTools/AMIInterpolation/patches/cyclicACMI/cyclicACMIPolyPatch/cyclicACMIPolyPatchI.H

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ cyclicACMIPolyPatch() [1/5]

◆ cyclicACMIPolyPatch() [2/5]

◆ cyclicACMIPolyPatch() [3/5]

◆ cyclicACMIPolyPatch() [4/5]

◆ cyclicACMIPolyPatch() [5/5]

◆ ~cyclicACMIPolyPatch()

Member Function Documentation

◆ reportCoverage()

◆ resetAMI() [1/2]

◆ resetAMI() [2/2]

◆ scalePatchFaceAreas() [1/2]

◆ scalePatchFaceAreas() [2/2]

◆ initGeometry()

◆ calcGeometry()

◆ initMovePoints()

◆ movePoints()

◆ initUpdateMesh()

◆ updateMesh()

◆ clearGeom()

◆ TypeName()

◆ clone() [1/3]

◆ clone() [2/3]

◆ clone() [3/3]

◆ newInternalProcFaces()

◆ mapCollocatedFaces()

◆ neighbPatch()

◆ nonOverlapPatchName()

◆ nonOverlapPatchID()

◆ nonOverlapPatch() [1/2]

◆ nonOverlapPatch() [2/2]

◆ mask()

◆ srcMask()

◆ tgtMask()

◆ tolerance()

◆ initOrder()

◆ order()

◆ write()

◆ updateAreas()

◆ upToDate()

◆ setUpToDate()