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

Inheritance diagram for cyclicACMIPolyPatch:

Collaboration diagram for cyclicACMIPolyPatch:

[legend]

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

	cyclicACMIPolyPatch (const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType, const transformType transform=UNKNOWN)
	Construct from (base couped patch) components. More...

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

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

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

	cyclicACMIPolyPatch (const cyclicACMIPolyPatch &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	~cyclicACMIPolyPatch ()
	Destructor. More...

void	setUpdated (bool flag) const
	Reset the updated flag. More...

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

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

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

const word &	nonOverlapPatchName () const
	Non-overlapping patch name. More...

virtual label	nonOverlapPatchID () const
	Non-overlapping patch ID. More...

const polyPatch &	nonOverlapPatch () const
	Return a const reference to the non-overlapping patch. More...

polyPatch &	nonOverlapPatch ()
	Return a reference to the non-overlapping patch. More...

const scalarField &	mask () const
	Mask field where 1 = overlap, 0 = no-overlap. More...

template<class Type >
tmp< Field< Type > >	interpolate (const Field< Type > &fldCouple, const Field< Type > &fldNonOverlap) const
	Interpolate field. More...

template<class Type >
tmp< Field< Type > >	interpolate (const tmp< Field< Type > > &tFldCouple, const tmp< Field< Type > > &tFldNonOverlap) const
	Interpolate tmp field. More...

template<class Type , class CombineOp >
void	interpolate (const UList< Type > &fldCouple, const UList< Type > &fldNonOverlap, const CombineOp &cop, List< Type > &result) 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
	Initialize ordering for primitivePatch. Does not. More...

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

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

template<class Type >
Foam::tmp< Foam::Field< Type > >	interpolate (const Field< Type > &fldCouple, const Field< Type > &fldNonOverlap) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	interpolate (const tmp< Field< Type > > &tFldCouple, const tmp< Field< Type > > &tFldNonOverlap) const

Public Member Functions inherited from cyclicAMIPolyPatch
	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)
	Construct from (base couped patch) components. More...

	cyclicAMIPolyPatch (const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm, const word &patchType)
	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	~cyclicAMIPolyPatch ()
	Destructor. More...

virtual bool	coupled () const
	Is patch 'coupled'. Note that on AMI the geometry is not. More...

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

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

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

const autoPtr< searchableSurface > &	surfPtr () const
	Return a reference to the projection surface. More...

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

bool	applyLowWeightCorrection () const
	Return true if applying the low weight correction. 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 nbr side. 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 , 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...

label	pointFace (const label faceI, const vector &n, point &p) const
	Return face index on neighbour patch which shares point p. More...

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 &)
	Construct as copy, resetting the boundary mesh. More...

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

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

virtual	~coupledPolyPatch ()
	Destructor. More...

virtual bool	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 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

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 &)
	Construct as copy, resetting the boundary mesh. More...

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

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

	polyPatch (const polyPatch &)
	Construct as copy. More...

virtual	~polyPatch ()
	Destructor. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual	~patchIdentifier ()
	Destructor. More...

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

word &	name ()
	Return name for modification. More...

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

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

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

label &	index ()
	Return the index of this patch in the boundaryMesh for modification. More...

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

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

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

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

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

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

	PrimitivePatch (const PrimitivePatch< Face, FaceList, PointField, PointType > &)
	Construct as copy. More...

virtual	~PrimitivePatch ()

void	clearOut ()

void	clearGeom ()

void	clearTopology ()

void	clearPatchMeshAddr ()

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

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

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

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

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

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

const labelList &	boundaryPoints () const
	Return list of boundary points,. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

template<class ToPatch >
List< objectHit >	projectFaceCentres (const ToPatch &targetPatch, const Field< PointType > &projectionDirection, const intersection::algorithm alg=intersection::FULL_RAY, const intersection::direction dir=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=NULL) const
	Check surface formed by patch for manifoldness (see above). More...

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

void	writeVTK (const fileName &name) const
	Write VTK patch. More...

void	writeVTKNormals (const fileName &name) const
	Write VTK patch normals. More...

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

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

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

	PrimitivePatch (const Xfer< FaceList< Face > > &faces, const Xfer< List< PointType > > &points)
	Construct from components. More...

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

	PrimitivePatch (const PrimitivePatch< Face, FaceList, PointField, PointType > &)
	Construct as copy. More...

virtual	~PrimitivePatch ()
	Destructor. More...

void	clearOut ()

void	clearGeom ()

void	clearTopology ()

void	clearPatchMeshAddr ()

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

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

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

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

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

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

const labelList &	boundaryPoints () const
	Return list of boundary points,. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

template<class ToPatch >
List< objectHit >	projectPoints (const ToPatch &targetPatch, const Field< PointType > &projectionDirection, const intersection::algorithm=intersection::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< PointType > &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=NULL) const
	Check surface formed by patch for manifoldness (see above). More...

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

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

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

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

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

Protected Member Functions
virtual void	initPatchFaceAreas () const
	Initialise patch face areas. More...

virtual void	resetAMI (const AMIPatchToPatchInterpolation::interpolationMethod &AMIMethod=AMIPatchToPatchInterpolation::imFaceAreaWeight) const
	Reset the AMI interpolator. More...

virtual void	setNeighbourFaceAreas () const
	Set neighbour ACMI patch areas. 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...

virtual const scalarField &	srcMask () const
	Return the mask/weighting for the source patch. More...

virtual const scalarField &	tgtMask () const
	Return the mask/weighting for the target patch. More...

Protected Member Functions inherited from cyclicAMIPolyPatch
virtual void	calcTransforms ()
	Recalculate the transformation tensors. 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...

Protected Member Functions inherited from polyPatch
virtual void	movePoints (const Field< PointType > &)
	Inherit movePoints from primitivePatch. More...

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

Static Protected Attributes
static const scalar	tolerance_ = 1e-6

Private Attributes
vectorField	faceAreas0_
	Copy of the original patch face areas. More...

const word	nonOverlapPatchName_
	Name of non-overlapping patch. More...

label	nonOverlapPatchID_
	Index of non-overlapping patch. More...

scalarField	srcMask_
	Mask/weighting for source patch. More...

scalarField	tgtMask_
	Mask/weighting for target patch. More...

bool	updated_
	Flag to indicate that AMI has been updated. More...

Additional Inherited Members
Public Types inherited from coupledPolyPatch
enum	transformType { UNKNOWN, ROTATIONAL, TRANSLATIONAL, COINCIDENTFULLMATCH, NOORDERING }

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

enum	surfaceTopo { MANIFOLD, OPEN, ILLEGAL, MANIFOLD, OPEN, ILLEGAL }
	Enumeration defining the surface type. Used in check routines. More...

typedef Face	FaceType

typedef FaceList< Face >	FaceListType

typedef PointField	PointFieldType

typedef Face	FaceType

typedef FaceList< Face >	FaceListType

typedef PointField	PointFieldType

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

Static Public Member Functions inherited from polyPatch
static autoPtr< polyPatch >	New (const word &patchType, const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm)
	Return a pointer to a new patch created on freestore from. More...

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

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

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

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

Static Public Member Functions inherited from PrimitivePatch< Face, FaceList, PointField, PointType >
static void	writeVTK (const fileName &name, const FaceListType &faces, const Field< PointType > &points)
	Write generic VTK patch, HJ, 14/Jan/2009. More...

static void	writeVTKNormals (const fileName &name, const FaceListType &faces, const Field< PointType > &points)
	Write generic VTK patch normals, HJ, 14/Jan/2009. More...

Static Public Attributes inherited from coupledPolyPatch
static const NamedEnum< transformType, 5 >	transformTypeNames

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

Protected Attributes inherited from cyclicAMIPolyPatch
word	nbrPatchName_
	Name of other half. More...

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

label	nbrPatchID_
	Index of other half. 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...

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

const bool	AMIReverse_
	Flag to indicate that slave patch should be reversed for AMI. More...

bool	AMIRequireMatch_
	Flag to indicate that patches should match/overlap. More...

const scalar	AMILowWeightCorrection_
	Low weight correction threshold for AMI. More...

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

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

Detailed Description

Cyclic patch for Arbitrarily Coupled Mesh Interface (ACMI)

Source files

Definition at line 50 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`
	)

Construct from (base couped patch) components.

Definition at line 222 of file cyclicACMIPolyPatch.C.

Referenced by cyclicACMIPolyPatch::clone().

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
	)

Construct from dictionary.

Definition at line 248 of file cyclicACMIPolyPatch.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, 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 282 of file cyclicACMIPolyPatch.C.

◆ 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 303 of file cyclicACMIPolyPatch.C.

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

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

◆ ~cyclicACMIPolyPatch()

~cyclicACMIPolyPatch ( )

virtual

Destructor.

Definition at line 359 of file cyclicACMIPolyPatch.C.

Member Function Documentation

◆ initPatchFaceAreas()

void initPatchFaceAreas ( ) const

protectedvirtual

Initialise patch face areas.

Definition at line 45 of file cyclicACMIPolyPatch.C.

References polyPatch::faceAreas(), cyclicACMIPolyPatch::faceAreas0(), cyclicACMIPolyPatch::faceAreas0_, mesh, and cyclicACMIPolyPatch::neighbPatch().

Here is the call graph for this function:

◆ resetAMI()

void resetAMI ( const AMIPatchToPatchInterpolation::interpolationMethod & AMIMethod = AMIPatchToPatchInterpolation::imFaceAreaWeight ) const

protectedvirtual

Reset the AMI interpolator.

Reimplemented from cyclicAMIPolyPatch.

Definition at line 71 of file cyclicACMIPolyPatch.C.

References polyPatch::faceAreas(), forAll, AMIInterpolation< SourcePatch, TargetPatch >::imPartialFaceAreaWeight, Foam::max(), Foam::min(), and cyclicAMIPolyPatch::resetAMI().

Here is the call graph for this function:

◆ setNeighbourFaceAreas()

void setNeighbourFaceAreas ( ) const

protectedvirtual

Set neighbour ACMI patch areas.

Definition at line 117 of file cyclicACMIPolyPatch.C.

References Foam::cp(), Foam::endl(), polyPatch::faceAreas(), forAll, and WarningInFunction.

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

References cyclicAMIPolyPatch::initGeometry().

Here is the call graph for this function:

◆ calcGeometry() [1/2]

void calcGeometry ( PstreamBuffers & pBufs )

protectedvirtual

Calculate the patch geometry.

Reimplemented from cyclicAMIPolyPatch.

Definition at line 157 of file cyclicACMIPolyPatch.C.

References cyclicAMIPolyPatch::calcGeometry().

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

References cyclicAMIPolyPatch::initMovePoints(), and p.

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

References cyclicAMIPolyPatch::movePoints(), 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 189 of file cyclicACMIPolyPatch.C.

References cyclicAMIPolyPatch::initUpdateMesh().

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

References cyclicAMIPolyPatch::updateMesh().

Here is the call graph for this function:

◆ clearGeom()

void clearGeom ( )

protectedvirtual

Clear geometry.

Reimplemented from cyclicAMIPolyPatch.

Definition at line 201 of file cyclicACMIPolyPatch.C.

References cyclicAMIPolyPatch::clearGeom().

Here is the call graph for this function:

◆ srcMask()

const Foam::scalarField & srcMask ( ) const

protectedvirtual

Return the mask/weighting for the source patch.

Definition at line 207 of file cyclicACMIPolyPatch.C.

◆ tgtMask()

const Foam::scalarField & tgtMask ( ) const

protectedvirtual

Return the mask/weighting for the target patch.

Definition at line 213 of file cyclicACMIPolyPatch.C.

◆ TypeName()

TypeName ( "cyclicACMI" )

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

Definition at line 188 of file cyclicACMIPolyPatch.H.

References cyclicACMIPolyPatch::cyclicACMIPolyPatch().

Here is the call graph for this function:

◆ clone() [2/3]

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

inlinevirtual

Construct and return a clone, resetting the face list.

and boundary mesh

Reimplemented from cyclicAMIPolyPatch.

Definition at line 196 of file cyclicACMIPolyPatch.H.

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

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 221 of file cyclicACMIPolyPatch.H.

References patchIdentifier::index().

Here is the call graph for this function:

◆ setUpdated()

void setUpdated ( bool flag ) const

inline

Reset the updated flag.

Definition at line 28 of file cyclicACMIPolyPatchI.H.

References cyclicACMIPolyPatch::updated_.

Referenced by cyclicACMIFvPatch::updateAreas().

Here is the caller graph for this function:

◆ updated()

bool updated ( ) const

inline

Return access to the updated flag.

Definition at line 34 of file cyclicACMIPolyPatchI.H.

Referenced by cyclicACMIFvPatch::updateAreas().

Here is the caller graph for this function:

◆ faceAreas0()

const Foam::vectorField & faceAreas0 ( ) const

inline

Return access to the original patch face areas.

Definition at line 40 of file cyclicACMIPolyPatchI.H.

Referenced by cyclicACMIPolyPatch::initPatchFaceAreas().

Here is the caller graph for this function:

◆ neighbPatch()

const Foam::cyclicACMIPolyPatch & neighbPatch ( ) const

virtual

Return a reference to the neighbour patch.

Reimplemented from cyclicAMIPolyPatch.

Definition at line 365 of file cyclicACMIPolyPatch.C.

Referenced by cyclicACMIPolyPatch::initPatchFaceAreas(), and cyclicACMIPointPatchField< Type >::nbrPpi().

Here is the caller graph for this function:

◆ nonOverlapPatchName()

const Foam::word & nonOverlapPatchName ( ) const

inline

Non-overlapping patch name.

Definition at line 46 of file cyclicACMIPolyPatchI.H.

◆ nonOverlapPatchID()

Foam::label nonOverlapPatchID ( ) const

virtual

Non-overlapping patch ID.

Definition at line 372 of file cyclicACMIPolyPatch.C.

References Foam::exit(), polyPatch::faceAreas(), Foam::FatalError, FatalErrorInFunction, boundaryMesh::findPatchID(), forAll, Foam::mag(), patchIdentifier::name(), Foam::name(), Foam::nl, and Foam::type().

Referenced by cyclicACMIFvPatch::nonOverlapPatchID().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nonOverlapPatch() [1/2]

Foam::polyPatch & nonOverlapPatch ( ) const

inline

Return a const reference to the non-overlapping patch.

Definition at line 52 of file cyclicACMIPolyPatchI.H.

◆ nonOverlapPatch() [2/2]

polyPatch& nonOverlapPatch ( )

inline

Return a reference to the non-overlapping patch.

◆ mask()

const Foam::scalarField & mask ( ) const

inline

Mask field where 1 = overlap, 0 = no-overlap.

Definition at line 70 of file cyclicACMIPolyPatchI.H.

◆ interpolate() [1/5]

tmp<Field<Type> > interpolate	(	const Field< Type > &	fldCouple,
		const Field< Type > &	fldNonOverlap
	)		const

Interpolate field.

Referenced by cyclicACMIFvPatch::interpolate().

Here is the caller graph for this function:

◆ interpolate() [2/5]

tmp<Field<Type> > interpolate	(	const tmp< Field< Type > > &	tFldCouple,
		const tmp< Field< Type > > &	tFldNonOverlap
	)		const

Interpolate tmp field.

◆ interpolate() [3/5]

void interpolate	(	const UList< Type > &	fldCouple,
		const UList< Type > &	fldNonOverlap,
		const CombineOp &	cop,
		List< Type > &	result
	)		const

Low-level interpolate List.

Definition at line 73 of file cyclicACMIPolyPatchTemplates.C.

References w().

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.

Reimplemented from cyclicAMIPolyPatch.

Definition at line 439 of file cyclicACMIPolyPatch.C.

References cyclicAMIPolyPatch::calcGeometry().

Here is the call 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 463 of file cyclicACMIPolyPatch.C.

References cyclicAMIPolyPatch::initOrder().

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

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

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

References token::END_STATEMENT, Foam::nl, cyclicAMIPolyPatch::write(), and Ostream::writeKeyword().

Here is the call graph for this function:

◆ interpolate() [4/5]

Foam::tmp<Foam::Field<Type> > interpolate	(	const Field< Type > &	fldCouple,
		const Field< Type > &	fldNonOverlap
	)		const

Definition at line 30 of file cyclicACMIPolyPatchTemplates.C.

References w().

Here is the call graph for this function:

◆ interpolate() [5/5]

Foam::tmp<Foam::Field<Type> > interpolate	(	const tmp< Field< Type > > &	tFldCouple,
		const tmp< Field< Type > > &	tFldNonOverlap
	)		const

Definition at line 62 of file cyclicACMIPolyPatchTemplates.C.

References Foam::MULES::interpolate().

Here is the call graph for this function:

Field Documentation

◆ faceAreas0_

vectorField faceAreas0_

mutableprivate

Copy of the original patch face areas.

Definition at line 60 of file cyclicACMIPolyPatch.H.

Referenced by cyclicACMIPolyPatch::initPatchFaceAreas().

◆ nonOverlapPatchName_

const word nonOverlapPatchName_

private

Name of non-overlapping patch.

Definition at line 63 of file cyclicACMIPolyPatch.H.

Referenced by cyclicACMIPolyPatch::clone().

◆ nonOverlapPatchID_

label nonOverlapPatchID_

mutableprivate

Index of non-overlapping patch.

Definition at line 66 of file cyclicACMIPolyPatch.H.

◆ srcMask_

scalarField srcMask_

mutableprivate

Mask/weighting for source patch.

Definition at line 69 of file cyclicACMIPolyPatch.H.

◆ tgtMask_

scalarField tgtMask_

mutableprivate

Mask/weighting for target patch.

Definition at line 72 of file cyclicACMIPolyPatch.H.

◆ updated_

bool updated_

mutableprivate

Flag to indicate that AMI has been updated.

Definition at line 75 of file cyclicACMIPolyPatch.H.

Referenced by cyclicACMIPolyPatch::setUpdated().

◆ tolerance_

const Foam::scalar tolerance_ = 1e-6

staticprotected

Definition at line 80 of file cyclicACMIPolyPatch.H.

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
src/meshTools/AMIInterpolation/patches/cyclicACMI/cyclicACMIPolyPatch/cyclicACMIPolyPatchTemplates.C

Public Member Functions

Protected Member Functions

Static Protected Attributes

Private Attributes

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

◆ initPatchFaceAreas()

◆ resetAMI()

◆ setNeighbourFaceAreas()

◆ initGeometry()

◆ calcGeometry() [1/2]

◆ initMovePoints()

◆ movePoints()

◆ initUpdateMesh()

◆ updateMesh()

◆ clearGeom()

◆ srcMask()

◆ tgtMask()

◆ TypeName()

◆ clone() [1/3]

◆ clone() [2/3]

◆ clone() [3/3]

◆ setUpdated()

◆ updated()

◆ faceAreas0()

◆ neighbPatch()

◆ nonOverlapPatchName()

◆ nonOverlapPatchID()

◆ nonOverlapPatch() [1/2]

◆ nonOverlapPatch() [2/2]

◆ mask()

◆ interpolate() [1/5]

◆ interpolate() [2/5]

◆ interpolate() [3/5]

◆ calcGeometry() [2/2]

◆ initOrder()

◆ order()

◆ write()

◆ interpolate() [4/5]

◆ interpolate() [5/5]

Field Documentation

◆ faceAreas0_

◆ nonOverlapPatchName_

◆ nonOverlapPatchID_

◆ srcMask_

◆ tgtMask_

◆ updated_

◆ tolerance_