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

Inheritance diagram for cyclicAMIPolyPatch:

[legend]

Collaboration diagram for cyclicAMIPolyPatch:

[legend]

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

	cyclicAMIPolyPatch (const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType, const bool AMIRequireMatch=true, const AMIInterpolation::interpolationMethod AMIMethod=AMIInterpolation::imFaceAreaWeight)
	Construct from (base couped patch) components. More...

	cyclicAMIPolyPatch (const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm, const word &patchType, const bool AMIRequireMatch=true, const AMIInterpolation::interpolationMethod AMIMethod=AMIInterpolation::imFaceAreaWeight)
	Construct from dictionary. More...

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

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

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

virtual autoPtr< polyPatch >	clone (const polyBoundaryMesh &bm) const
	Construct and return a clone, resetting the boundary mesh. More...

virtual autoPtr< polyPatch >	clone (const polyBoundaryMesh &bm, const label index, const label newSize, const label newStart) const
	Construct and return a clone, resetting the face list. More...

virtual autoPtr< polyPatch >	clone (const polyBoundaryMesh &bm, const label index, const labelUList &mapAddressing, const label newStart) const
	Construct and return a clone, resetting the face list. More...

virtual	~cyclicAMIPolyPatch ()
	Destructor. More...

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

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

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

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

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

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

const PtrList< AMIInterpolation > &	AMIs () const
	Return a reference to the AMI interpolators. More...

const List< transformer > &	AMITransforms () const
	Return a reference to the AMI transforms. More...

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

virtual const scalarField &	weightsSum () const
	Return the weights sum for this patch. More...

virtual const scalarField &	nbrWeightsSum () const
	Return the weights sum for the neighbour patch. More...

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

tmp< scalarField >	interpolate (const scalarField &field, const direction cmpt, const direction rank, const scalarUList &defaultValues=scalarUList()) const
	Interpolate field component. More...

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

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

labelPair	pointAMIAndFace (const label facei, const vector &n, point &p) const
	Return the transform and face indices on neighbour patch which. More...

label	singlePatchProc () const
	Index of processor that holds all of both sides, or -1 if. 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 > &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)
	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...

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

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

	declareRunTimeSelectionTable (autoPtr, polyPatch, word,(const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType),(name, size, start, index, bm, patchType))

	declareRunTimeSelectionTable (autoPtr, polyPatch, dictionary,(const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm, const word &patchType),(name, dict, index, bm, patchType))

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

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

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

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

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

	polyPatch (const polyPatch &)
	Copy constructor. More...

virtual	~polyPatch ()
	Destructor. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual	~patchIdentifier ()
	Destructor. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual	~PrimitivePatch ()
	Destructor. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

const labelListList &	edgeLoops () const
	Return list of closed loops of boundary vertices. More...

surfaceTopo	surfaceType () const
	Calculate surface type formed by patch. More...

bool	checkTopology (const bool report=false, labelHashSet *setPtr=nullptr) const
	Check surface formed by patch for manifoldness (see above). More...

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

void	clearOut ()

void	clearGeom ()

void	clearTopology ()

void	clearPatchMeshAddr ()

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

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

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

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

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

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

	cyclicTransform (const bool defaultIsNone)

	cyclicTransform (const dictionary &dict, const bool defaultIsNone)

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

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

virtual	~cyclicTransform ()

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

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

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

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

Protected Member Functions
virtual void	resetAMI () const
	Reset the AMI interpolator. More...

virtual void	initCalcGeometry (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 void	rename (const wordList &newNames)
	Reset the patch name. More...

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

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

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

Protected Attributes
word	nbrPatchName_
	Name of cyclic neighbour patch. More...

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

label	nbrPatchID_
	Index of cyclic neighbour patch. More...

PtrList< AMIInterpolation >	AMIs_
	AMI interpolation classes. More...

List< transformer >	AMITransforms_
	AMI transforms (from source to target) More...

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

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

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

const AMIInterpolation::interpolationMethod	AMIMethod_
	AMI Method. More...

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

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

Protected Attributes inherited from coupledPolyPatch
const scalar	matchTolerance_
	Local matching tolerance. More...

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

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

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

word	physicalType_
	Optional physical type. More...

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

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

typedef FaceList	FaceListType

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

typedef PointField	PointFieldType

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Detailed Description

Cyclic patch for Arbitrary Mesh Interface (AMI)

Source files

Definition at line 52 of file cyclicAMIPolyPatch.H.

Constructor & Destructor Documentation

◆ cyclicAMIPolyPatch() [1/5]

cyclicAMIPolyPatch	(	const word &	name,
		const label	size,
		const label	start,
		const label	index,
		const polyBoundaryMesh &	bm,
		const word &	patchType,
		const bool	AMIRequireMatch = `true`,
		const AMIInterpolation::interpolationMethod	AMIMethod = `AMIInterpolation::imFaceAreaWeight`
	)

Construct from (base couped patch) components.

Definition at line 240 of file cyclicAMIPolyPatch.C.

Referenced by cyclicAMIPolyPatch::clone(), cyclicAMIPolyPatch::cyclicAMIPolyPatch(), and cyclicAMIPolyPatch::reorder().

Here is the caller graph for this function:

◆ cyclicAMIPolyPatch() [2/5]

cyclicAMIPolyPatch	(	const word &	name,
		const dictionary &	dict,
		const label	index,
		const polyBoundaryMesh &	bm,
		const word &	patchType,
		const bool	AMIRequireMatch = `true`,
		const AMIInterpolation::interpolationMethod	AMIMethod = `AMIInterpolation::imFaceAreaWeight`
	)

Construct from dictionary.

Definition at line 270 of file cyclicAMIPolyPatch.C.

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

Here is the call graph for this function:

◆ cyclicAMIPolyPatch() [3/5]

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

Construct as copy, resetting the boundary mesh.

Definition at line 327 of file cyclicAMIPolyPatch.C.

References cyclicAMIPolyPatch::cyclicAMIPolyPatch().

Here is the call graph for this function:

◆ cyclicAMIPolyPatch() [4/5]

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

Construct given the original patch and resetting the.

face list and boundary mesh information

Definition at line 352 of file cyclicAMIPolyPatch.C.

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

Here is the call graph for this function:

◆ cyclicAMIPolyPatch() [5/5]

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

Construct given the original patch and a map.

Definition at line 389 of file cyclicAMIPolyPatch.C.

◆ ~cyclicAMIPolyPatch()

~cyclicAMIPolyPatch ( )

virtual

Destructor.

Definition at line 415 of file cyclicAMIPolyPatch.C.

Referenced by cyclicAMIPolyPatch::clone().

Here is the caller graph for this function:

Member Function Documentation

◆ resetAMI()

void resetAMI ( ) const

protectedvirtual

Reset the AMI interpolator.

Reimplemented in cyclicACMIPolyPatch, and cyclicRepeatAMIPolyPatch.

Definition at line 45 of file cyclicAMIPolyPatch.C.

References Foam::endl(), transformer::I, PrimitivePatch< FaceList, PointField >::localFaces(), mesh, Foam::name(), Foam::nl, TimePaths::path(), points, Foam::Pout, objectRegistry::time(), faceAreaIntersect::tmMesh, Foam::transform(), and Foam::meshTools::writeOBJ().

Referenced by cyclicACMIPolyPatch::resetAMI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initCalcGeometry()

void initCalcGeometry ( PstreamBuffers & pBufs )

protectedvirtual

Initialise the calculation of the patch geometry.

Implements coupledPolyPatch.

Reimplemented in cyclicACMIPolyPatch.

Definition at line 119 of file cyclicAMIPolyPatch.C.

References polyPatch::initCalcGeometry().

Referenced by cyclicACMIPolyPatch::initCalcGeometry().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calcGeometry()

void calcGeometry ( PstreamBuffers & pBufs )

protectedvirtual

Calculate the patch geometry.

Implements coupledPolyPatch.

Reimplemented in cyclicACMIPolyPatch, and cyclicRepeatAMIPolyPatch.

Definition at line 129 of file cyclicAMIPolyPatch.C.

References cyclicAMIPolyPatch::initMovePoints(), mesh, Foam::name(), and UPstream::parRun().

Here is the call graph for this function:

◆ initMovePoints()

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

protectedvirtual

Initialise the patches for moving points.

Implements coupledPolyPatch.

Reimplemented in cyclicACMIPolyPatch.

Definition at line 168 of file cyclicAMIPolyPatch.C.

References polyPatch::initMovePoints(), cyclicAMIPolyPatch::movePoints(), and PrimitivePatch< FaceList, PointField >::movePoints().

Referenced by cyclicAMIPolyPatch::calcGeometry(), and cyclicACMIPolyPatch::initMovePoints().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ movePoints()

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

protectedvirtual

Correct patches after moving points.

Implements coupledPolyPatch.

Definition at line 185 of file cyclicAMIPolyPatch.C.

References polyPatch::movePoints().

Referenced by cyclicAMIPolyPatch::initMovePoints().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initUpdateMesh()

void initUpdateMesh ( PstreamBuffers & pBufs )

protectedvirtual

Initialise the update of the patch topology.

Implements coupledPolyPatch.

Definition at line 194 of file cyclicAMIPolyPatch.C.

References polyPatch::initUpdateMesh().

Here is the call graph for this function:

◆ updateMesh()

void updateMesh ( PstreamBuffers & pBufs )

protectedvirtual

Update of the patch topology.

Implements coupledPolyPatch.

Definition at line 204 of file cyclicAMIPolyPatch.C.

References polyPatch::updateMesh().

Here is the call graph for this function:

◆ clearGeom()

void clearGeom ( )

protectedvirtual

Clear geometry.

Reimplemented from polyPatch.

Definition at line 210 of file cyclicAMIPolyPatch.C.

References polyPatch::clearGeom().

Here is the call graph for this function:

◆ rename()

void rename ( const wordList & newNames )

protectedvirtual

Reset the patch name.

Reimplemented from polyPatch.

Definition at line 220 of file cyclicAMIPolyPatch.C.

References polyPatch::rename().

Here is the call graph for this function:

◆ reorder()

void reorder ( const labelUList & newToOldIndex )

protectedvirtual

Reset the patch index.

Reimplemented from polyPatch.

Definition at line 227 of file cyclicAMIPolyPatch.C.

References cyclicAMIPolyPatch::cyclicAMIPolyPatch(), Foam::findIndex(), and polyPatch::reorder().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "cyclicAMI" )

Runtime type information.

◆ clone() [1/3]

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

inlinevirtual

Construct and return a clone, resetting the boundary mesh.

Reimplemented from polyPatch.

Reimplemented in cyclicACMIPolyPatch, and cyclicRepeatAMIPolyPatch.

Definition at line 190 of file cyclicAMIPolyPatch.H.

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

Here is the call graph for this function:

◆ clone() [2/3]

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

inlinevirtual

Construct and return a clone, resetting the face list.

and boundary mesh

Reimplemented from polyPatch.

Reimplemented in cyclicACMIPolyPatch, and cyclicRepeatAMIPolyPatch.

Definition at line 198 of file cyclicAMIPolyPatch.H.

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

Here is the call graph for this function:

◆ clone() [3/3]

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

inlinevirtual

Construct and return a clone, resetting the face list.

and boundary mesh

Reimplemented from polyPatch.

Reimplemented in cyclicACMIPolyPatch, and cyclicRepeatAMIPolyPatch.

Definition at line 222 of file cyclicAMIPolyPatch.H.

References cyclicAMIPolyPatch::AMIs(), cyclicAMIPolyPatch::AMITransforms(), cyclicAMIPolyPatch::applyLowWeightCorrection(), cyclicAMIPolyPatch::coupled(), cyclicAMIPolyPatch::cyclicAMIPolyPatch(), cyclicAMIPolyPatch::nbrPatch(), cyclicAMIPolyPatch::nbrPatchID(), cyclicAMIPolyPatch::nbrPatchName(), cyclicAMIPolyPatch::nbrWeightsSum(), cyclicAMIPolyPatch::owner(), cyclicAMIPolyPatch::surfPtr(), cyclicAMIPolyPatch::weightsSum(), and cyclicAMIPolyPatch::~cyclicAMIPolyPatch().

Here is the call graph for this function:

◆ coupled()

virtual bool coupled ( ) const

inlinevirtual

Is patch 'coupled'. Note that on AMI the geometry is not.

coupled but the fields are!

Reimplemented from coupledPolyPatch.

Definition at line 253 of file cyclicAMIPolyPatch.H.

Referenced by cyclicAMIPolyPatch::clone().

Here is the caller graph for this function:

◆ nbrPatchName()

const Foam::word & nbrPatchName ( ) const

inline

Neighbour patch name.

Definition at line 28 of file cyclicAMIPolyPatchI.H.

References polyPatch::boundaryMesh(), cyclicAMIPolyPatch::coupleGroup_, IOobject::name(), and cyclicAMIPolyPatch::nbrPatchName_.

Referenced by cyclicACMIPolyPatch::clone(), cyclicAMIPolyPatch::clone(), and cyclicAMIPolyPatch::nbrPatchID().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nbrPatchID()

Foam::label nbrPatchID ( ) const

virtual

Neighbour patch ID.

Definition at line 421 of file cyclicAMIPolyPatch.C.

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

Referenced by cyclicAMIPolyPatch::clone(), cyclicAMIFvPatch::nbrPatch(), cyclicAMIPointPatch::nbrPatch(), cyclicAMIFvPatch::nbrPatchID(), cyclicACMIFvPatch::neighbFvPatch(), and cyclicAMIFvPatch::neighbFvPatch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ owner()

bool owner ( ) const

virtual

Does this side own the patch?

Implements coupledPolyPatch.

Definition at line 457 of file cyclicAMIPolyPatch.C.

Referenced by cyclicAMIPolyPatch::clone(), FaceCellWave< Type, TrackingData >::handleAMICyclicPatches(), particle< Type >::hitCyclicAMIPatch(), cyclicACMIPolyPatch::mask(), combine< Type, TrackingData >::operator()(), and cyclicAMIFvPatch::owner().

Here is the caller graph for this function:

◆ nbrPatch()

const Foam::cyclicAMIPolyPatch & nbrPatch ( ) const

virtual

Return a reference to the neighbour patch.

Reimplemented in cyclicACMIPolyPatch, and cyclicRepeatAMIPolyPatch.

Definition at line 463 of file cyclicAMIPolyPatch.C.

Referenced by cyclicAMIPolyPatch::clone(), FaceCellWave< Type, TrackingData >::handleAMICyclicPatches(), particle< Type >::hitCyclicAMIPatch(), and combine< Type, TrackingData >::operator()().

Here is the caller graph for this function:

◆ surfPtr()

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

Return a reference to the projection surface.

Definition at line 471 of file cyclicAMIPolyPatch.C.

References searchableSurface::geometryDir(), mesh, IOobject::MUST_READ, searchableSurface::New(), and IOobject::NO_WRITE.

Referenced by cyclicAMIPolyPatch::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AMIs()

const Foam::PtrList< Foam::AMIInterpolation > & AMIs ( ) const

Return a reference to the AMI interpolators.

Definition at line 503 of file cyclicAMIPolyPatch.C.

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

Referenced by cyclicAMIFvPatch::AMIs(), cyclicAMIPolyPatch::clone(), FaceCellWave< Type, TrackingData >::handleAMICyclicPatches(), cyclicAMIPolyPatch::interpolate(), and cyclicAMIPolyPatch::singlePatchProc().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AMITransforms()

const Foam::List< Foam::transformer > & AMITransforms ( ) const

Return a reference to the AMI transforms.

Definition at line 522 of file cyclicAMIPolyPatch.C.

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

Referenced by cyclicAMIFvPatch::AMITransforms(), cyclicAMIPolyPatch::clone(), FaceCellWave< Type, TrackingData >::handleAMICyclicPatches(), particle< Type >::hitCyclicAMIPatch(), and cyclicAMIPolyPatch::interpolate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ applyLowWeightCorrection()

bool applyLowWeightCorrection ( ) const

Return true if applying the low weight correction.

Definition at line 540 of file cyclicAMIPolyPatch.C.

Referenced by cyclicAMIFvPatch::applyLowWeightCorrection(), cyclicAMIPolyPatch::clone(), and FaceCellWave< Type, TrackingData >::handleAMICyclicPatches().

Here is the caller graph for this function:

◆ weightsSum()

const Foam::scalarField & weightsSum ( ) const

virtual

Return the weights sum for this patch.

Reimplemented in cyclicRepeatAMIPolyPatch.

Definition at line 553 of file cyclicAMIPolyPatch.C.

Referenced by cyclicAMIPolyPatch::clone(), and cyclicRepeatAMIPolyPatch::weightsSum().

Here is the caller graph for this function:

◆ nbrWeightsSum()

const Foam::scalarField & nbrWeightsSum ( ) const

virtual

Return the weights sum for the neighbour patch.

Reimplemented in cyclicRepeatAMIPolyPatch.

Definition at line 566 of file cyclicAMIPolyPatch.C.

References cyclicAMIPolyPatch::interpolate().

Referenced by cyclicAMIPolyPatch::clone(), and cyclicRepeatAMIPolyPatch::nbrWeightsSum().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ transform()

virtual const transformer& transform ( ) const

inlinevirtual

Return transformation between the coupled patches.

Implements coupledPolyPatch.

Definition at line 292 of file cyclicAMIPolyPatch.H.

References Foam::faceMap(), field(), fld(), cyclicAMIPolyPatch::initOrder(), cyclicAMIPolyPatch::interpolate(), n, cyclicAMIPolyPatch::order(), p, cyclicAMIPolyPatch::pointAMIAndFace(), cyclicAMIPolyPatch::singlePatchProc(), cyclicTransform::transform(), and cyclicAMIPolyPatch::write().

Referenced by FaceCellWave< Type, TrackingData >::handleAMICyclicPatches(), particle< Type >::hitCyclicAMIPatch(), cyclicAMIPointPatch::transform(), and cyclicAMIFvPatch::transform().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ interpolate() [1/5]

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

Interpolate field.

Referenced by cyclicAMIPolyPatch::interpolate(), cyclicAMIFvPatch::interpolate(), cyclicAMIPolyPatch::nbrWeightsSum(), and cyclicAMIPolyPatch::transform().

Here is the caller graph for this function:

◆ interpolate() [2/5]

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

Interpolate tmp field.

◆ interpolate() [3/5]

Foam::tmp< Foam::scalarField > interpolate	(	const scalarField &	field,
		const direction	cmpt,
		const direction	rank,
		const scalarUList &	defaultValues = `scalarUList()`
	)		const

Interpolate field component.

Definition at line 580 of file cyclicAMIPolyPatch.C.

References cyclicAMIPolyPatch::AMIs(), cyclicAMIPolyPatch::AMITransforms(), forAll, cyclicAMIPolyPatch::initOrder(), Foam::inv(), Foam::pow(), tmp< T >::ref(), Foam::T(), and Foam::Zero.

Here is the call graph for this function:

◆ initOrder()

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

virtual

Initialise ordering for primitivePatch. Does not.

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

Implements coupledPolyPatch.

Reimplemented in cyclicACMIPolyPatch.

Definition at line 619 of file cyclicAMIPolyPatch.C.

References cyclicAMIPolyPatch::order().

Referenced by cyclicACMIPolyPatch::initOrder(), cyclicAMIPolyPatch::interpolate(), and cyclicAMIPolyPatch::transform().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ order()

bool order	(	PstreamBuffers &	pBufs,
		const primitivePatch &	pp,
		labelList &	faceMap,
		labelList &	rotation
	)		const

virtual

Return new ordering for primitivePatch.

Ordering is -faceMap: for every face index of the new face -rotation:for every new face the clockwise shift of the original face. Return false if nothing changes (faceMap is identity, rotation is 0), true otherwise.

Implements coupledPolyPatch.

Reimplemented in cyclicACMIPolyPatch.

Definition at line 627 of file cyclicAMIPolyPatch.C.

References cyclicAMIPolyPatch::pointAMIAndFace(), and List< T >::setSize().

Referenced by cyclicAMIPolyPatch::initOrder(), cyclicACMIPolyPatch::order(), and cyclicAMIPolyPatch::transform().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pointAMIAndFace()

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

Return the transform and face indices on neighbour patch which.

shares point p following trajectory vector n

Definition at line 645 of file cyclicAMIPolyPatch.C.

References forAll, and Foam::transform().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ singlePatchProc()

Foam::label singlePatchProc ( ) const

Index of processor that holds all of both sides, or -1 if.

distributed

Definition at line 702 of file cyclicAMIPolyPatch.C.

References cyclicAMIPolyPatch::AMIs().

Referenced by cyclicAMIPolyPatch::transform().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write the polyPatch data as a dictionary.

Reimplemented from coupledPolyPatch.

Reimplemented in cyclicACMIPolyPatch, and cyclicRepeatAMIPolyPatch.

Definition at line 720 of file cyclicAMIPolyPatch.C.

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

Referenced by cyclicAMIPolyPatch::transform(), cyclicRepeatAMIPolyPatch::write(), and cyclicACMIPolyPatch::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ interpolate() [4/5]

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

Definition at line 30 of file cyclicAMIPolyPatchTemplates.C.

References cyclicAMIPolyPatch::AMIs(), cyclicAMIPolyPatch::AMITransforms(), forAll, cyclicAMIPolyPatch::interpolate(), tmp< T >::ref(), and Foam::Zero.

Here is the call graph for this function:

◆ interpolate() [5/5]

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

Definition at line 70 of file cyclicAMIPolyPatchTemplates.C.

References Foam::fvc::interpolate().

Here is the call graph for this function:

Member Data Documentation

◆ nbrPatchName_

word nbrPatchName_

mutableprotected

Name of cyclic neighbour patch.

Definition at line 62 of file cyclicAMIPolyPatch.H.

Referenced by cyclicRepeatAMIPolyPatch::clone(), and cyclicAMIPolyPatch::nbrPatchName().

◆ coupleGroup_

const coupleGroupIdentifier coupleGroup_

protected

Optional patchGroup to find nbrPatch.

Definition at line 65 of file cyclicAMIPolyPatch.H.

Referenced by cyclicAMIPolyPatch::nbrPatchName().

◆ nbrPatchID_

label nbrPatchID_

mutableprotected

Index of cyclic neighbour patch.

Definition at line 68 of file cyclicAMIPolyPatch.H.

◆ AMIs_

PtrList<AMIInterpolation> AMIs_

mutableprotected

AMI interpolation classes.

Definition at line 71 of file cyclicAMIPolyPatch.H.

◆ AMITransforms_

List<transformer> AMITransforms_

mutableprotected

AMI transforms (from source to target)

Definition at line 74 of file cyclicAMIPolyPatch.H.

◆ AMIReverse_

const bool AMIReverse_

protected

Flag to indicate that slave patch should be reversed for AMI.

Definition at line 77 of file cyclicAMIPolyPatch.H.

◆ AMIRequireMatch_

const bool AMIRequireMatch_

protected

Flag to indicate that patches should match/overlap.

Definition at line 80 of file cyclicAMIPolyPatch.H.

◆ AMILowWeightCorrection_

const scalar AMILowWeightCorrection_

protected

Low weight correction threshold for AMI.

Definition at line 83 of file cyclicAMIPolyPatch.H.

◆ AMIMethod_

const AMIInterpolation::interpolationMethod AMIMethod_

protected

AMI Method.

Definition at line 86 of file cyclicAMIPolyPatch.H.

◆ surfPtr_

autoPtr<searchableSurface> surfPtr_

mutableprotected

Projection surface.

Definition at line 89 of file cyclicAMIPolyPatch.H.

◆ surfDict_

const dictionary surfDict_

protected

Dictionary used during projection surface construction.

Definition at line 92 of file cyclicAMIPolyPatch.H.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ cyclicAMIPolyPatch() [1/5]

◆ cyclicAMIPolyPatch() [2/5]

◆ cyclicAMIPolyPatch() [3/5]

◆ cyclicAMIPolyPatch() [4/5]

◆ cyclicAMIPolyPatch() [5/5]

◆ ~cyclicAMIPolyPatch()

Member Function Documentation

◆ resetAMI()

◆ initCalcGeometry()

◆ calcGeometry()

◆ initMovePoints()

◆ movePoints()

◆ initUpdateMesh()

◆ updateMesh()

◆ clearGeom()

◆ rename()

◆ reorder()

◆ TypeName()

◆ clone() [1/3]

◆ clone() [2/3]

◆ clone() [3/3]

◆ coupled()

◆ nbrPatchName()

◆ nbrPatchID()

◆ owner()

◆ nbrPatch()

◆ surfPtr()

◆ AMIs()

◆ AMITransforms()

◆ applyLowWeightCorrection()

◆ weightsSum()

◆ nbrWeightsSum()

◆ transform()

◆ interpolate() [1/5]

◆ interpolate() [2/5]

◆ interpolate() [3/5]

◆ initOrder()

◆ order()

◆ pointAMIAndFace()

◆ singlePatchProc()

◆ write()

◆ interpolate() [4/5]

◆ interpolate() [5/5]

Member Data Documentation

◆ nbrPatchName_

◆ coupleGroup_

◆ nbrPatchID_

◆ AMIs_

◆ AMITransforms_

◆ AMIReverse_

◆ AMIRequireMatch_

◆ AMILowWeightCorrection_

◆ AMIMethod_

◆ surfPtr_

◆ surfDict_