Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | List of all members
coupledPolyPatch Class Referenceabstract

The coupledPolyPatch is an abstract base class for patches that couple regions of the computational domain e.g. cyclic and processor-processor links. More...

Inheritance diagram for coupledPolyPatch:
Inheritance graph
[legend]
Collaboration diagram for coupledPolyPatch:
Collaboration graph
[legend]

Public Types

enum  transformType {
  UNKNOWN, ROTATIONAL, TRANSLATIONAL, COINCIDENTFULLMATCH,
  NOORDERING
}
 
- Public Types inherited from PrimitivePatch< Face, FaceList, PointField, PointType >
enum  surfaceTopo { MANIFOLD, OPEN, ILLEGAL }
 Enumeration defining the surface type. Used in check routines. More...
 
typedef Face FaceType
 
typedef FaceList< Face > FaceListType
 
typedef PointField PointFieldType
 

Public Member Functions

 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 coupled () const
 Return true because this patch is coupled. More...
 
virtual bool owner () const =0
 Does this side own the patch ? More...
 
virtual bool neighbour () const
 Does the coupled side own the patch ? More...
 
virtual transformType transform () const
 Type of transform. More...
 
virtual transformTypetransform ()
 Type of transform. More...
 
virtual void transformPosition (pointField &) const =0
 Transform a patch-based position from other side to this side. More...
 
virtual void transformPosition (point &, const label facei) const =0
 Transform a patch-based position from other side to this side. More...
 
virtual bool separated () const
 Are the planes separated. More...
 
virtual const vectorFieldseparation () const
 If the planes are separated the separation vector. More...
 
virtual bool parallel () const
 Are the cyclic planes parallel. More...
 
virtual const tensorFieldforwardT () const
 Return face transformation tensor. More...
 
virtual const tensorFieldreverseT () const
 Return neighbour-cell transformation tensor. More...
 
virtual const boolListcollocated () const
 Are faces collocated. Either size 0,1 or length of patch. More...
 
scalar matchTolerance () const
 
virtual void calcGeometry (const primitivePatch &referPatch, const pointField &thisCtrs, const vectorField &thisAreas, const pointField &thisCc, const pointField &nbrCtrs, const vectorField &nbrAreas, const pointField &nbrCc)=0
 Calculate the patch geometry. More...
 
virtual void initOrder (PstreamBuffers &, const primitivePatch &) const =0
 Initialize ordering for primitivePatch. Does not. More...
 
virtual bool order (PstreamBuffers &, const primitivePatch &, labelList &faceMap, labelList &rotation) const =0
 Return new ordering for primitivePatch. More...
 
virtual void write (Ostream &) const
 Write the polyPatch data as a dictionary. More...
 
- Public Member Functions inherited from polyPatch
 TypeName ("patch")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, polyPatch, word,(const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType),(name, size, start, index, bm, patchType))
 
 declareRunTimeSelectionTable (autoPtr, polyPatch, dictionary,(const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm, const word &patchType),(name, dict, index, bm, patchType))
 
 polyPatch (const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType)
 Construct from components. More...
 
 polyPatch (const word &name, const 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 autoPtr< polyPatchclone (const polyBoundaryMesh &bm) const
 Construct and return a clone, resetting the boundary mesh. More...
 
virtual autoPtr< polyPatchclone (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< polyPatchclone (const polyBoundaryMesh &bm, const label index, const labelUList &mapAddressing, const label newStart) const
 Construct and return a clone, resetting the face list. More...
 
virtual ~polyPatch ()
 Destructor. More...
 
label start () const
 Return start label of this patch in the polyMesh face list. More...
 
const polyBoundaryMeshboundaryMesh () const
 Return boundaryMesh reference. More...
 
template<class T >
const UIndirectList< TpatchInternalList (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< vectorFieldfaceCellCentres () const
 Return face cell centres. More...
 
const labelUListfaceCells () const
 Return face-cell addressing. More...
 
const labelListmeshEdges () 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 wordname () const
 Return name. More...
 
wordname ()
 Return name for modification. More...
 
const wordphysicalType () const
 Return the optional physical type of the patch. More...
 
wordphysicalType ()
 Return the optional physical type of the patch for modification. More...
 
label index () const
 Return the index of this patch in the boundaryMesh. More...
 
labelindex ()
 Return the index of this patch in the boundaryMesh for modification. More...
 
const wordListinGroups () const
 Return the optional groups patch belongs to. More...
 
wordListinGroups ()
 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 (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 edgeListedges () 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 labelListboundaryPoints () const
 Return list of boundary points,. More...
 
const labelListListfaceFaces () const
 Return face-face addressing. More...
 
const labelListListedgeFaces () const
 Return edge-face addressing. More...
 
const labelListListfaceEdges () const
 Return face-edge addressing. More...
 
const labelListListpointEdges () const
 Return point-edge addressing. More...
 
const labelListListpointFaces () const
 Return point-face addressing. More...
 
const List< Face > & localFaces () const
 Return patch faces addressing into local point list. More...
 
const labelListmeshPoints () 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 labelListlocalPointOrder () 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< objectHitprojectPoints (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< objectHitprojectFaceCentres (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 labelListListedgeLoops () const
 Return list of closed loops of boundary vertices. More...
 
surfaceTopo surfaceType () const
 Calculate surface type formed by patch. More...
 
bool checkTopology (const bool report=false, labelHashSet *setPtr=nullptr) const
 Check surface formed by patch for manifoldness (see above). More...
 
bool checkPointManifold (const bool report=false, labelHashSet *setPtr=nullptr) const
 Checks primitivePatch for faces sharing point but not edge. More...
 
virtual void movePoints (const Field< PointType > &)
 Correct patch after moving points. More...
 
void operator= (const PrimitivePatch< Face, FaceList, PointField, PointType > &)
 Assignment. More...
 
template<class ToPatch >
Foam::List< Foam::objectHitprojectPoints (const ToPatch &targetPatch, const Field< PointType > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const
 
template<class ToPatch >
Foam::List< Foam::objectHitprojectFaceCentres (const ToPatch &targetPatch, const Field< PointType > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const
 

Static Public Member Functions

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< polyPatchNew (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< polyPatchNew (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< polyPatchNew (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

static const NamedEnum< transformType, 5 > transformTypeNames
 
- Static Public Attributes inherited from polyPatch
static int disallowGenericPolyPatch
 Debug switch to disallow the use of genericPolyPatch. More...
 

Protected Member Functions

void calcTransformTensors (const vectorField &Cf, const vectorField &Cr, const vectorField &nf, const vectorField &nr, const scalarField &smallDist, const scalar absTol, const transformType=UNKNOWN) const
 Calculate the transformation tensors. More...
 
virtual void initGeometry (PstreamBuffers &)=0
 Initialise the calculation of the patch geometry. More...
 
virtual void calcGeometry (PstreamBuffers &)=0
 Calculate the patch geometry. More...
 
virtual void initMovePoints (PstreamBuffers &, const pointField &)=0
 Initialise the patches for moving points. More...
 
virtual void movePoints (PstreamBuffers &, const pointField &)=0
 Correct patches after moving points. More...
 
virtual void initUpdateMesh (PstreamBuffers &)=0
 Initialise the update of the patch topology. More...
 
virtual void updateMesh (PstreamBuffers &)=0
 Update of the patch topology. More...
 
- Protected Member Functions inherited from polyPatch
virtual void clearGeom ()
 Clear geometry. More...
 

Static Protected Member Functions

static void writeOBJ (Ostream &os, const point &pt)
 Write point in OBJ format. More...
 
static void writeOBJ (Ostream &, const pointField &, const labelList &)
 Write selected points in OBJ format. More...
 
static void writeOBJ (const fileName &, const UList< face > &, const pointField &)
 Write patch. More...
 
static void writeOBJ (Ostream &os, const point &p0, const point &p1, label &vertI)
 Write edge in OBJ format. More...
 
static pointField getAnchorPoints (const UList< face > &, const pointField &, const transformType)
 Get a unique anchor point for all faces. More...
 
static label getRotation (const pointField &points, const face &f, const point &anchor, const scalar tol)
 Get the number of vertices face f needs to be rotated such that. More...
 

Detailed Description

The coupledPolyPatch is an abstract base class for patches that couple regions of the computational domain e.g. cyclic and processor-processor links.

Source files

Definition at line 51 of file coupledPolyPatch.H.

Member Enumeration Documentation

◆ transformType

Enumerator
UNKNOWN 
ROTATIONAL 
TRANSLATIONAL 
COINCIDENTFULLMATCH 
NOORDERING 

Definition at line 57 of file coupledPolyPatch.H.

Constructor & Destructor Documentation

◆ coupledPolyPatch() [1/5]

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.

Definition at line 474 of file coupledPolyPatch.C.

Referenced by coupledPolyPatch::calcTransformTensors(), and coupledPolyPatch::coupledPolyPatch().

Here is the caller graph for this function:

◆ coupledPolyPatch() [2/5]

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

Construct from dictionary.

Definition at line 491 of file coupledPolyPatch.C.

References coupledPolyPatch::coupledPolyPatch().

Here is the call graph for this function:

◆ coupledPolyPatch() [3/5]

coupledPolyPatch ( const coupledPolyPatch pp,
const polyBoundaryMesh bm 
)

Construct as copy, resetting the boundary mesh.

Definition at line 511 of file coupledPolyPatch.C.

References coupledPolyPatch::coupledPolyPatch().

Here is the call graph for this function:

◆ coupledPolyPatch() [4/5]

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

Definition at line 523 of file coupledPolyPatch.C.

References coupledPolyPatch::coupledPolyPatch().

Here is the call graph for this function:

◆ coupledPolyPatch() [5/5]

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

Construct given the original patch and a map.

Definition at line 538 of file coupledPolyPatch.C.

◆ ~coupledPolyPatch()

~coupledPolyPatch ( )
virtual

Destructor.

Definition at line 554 of file coupledPolyPatch.C.

Member Function Documentation

◆ calcTransformTensors()

void calcTransformTensors ( const vectorField Cf,
const vectorField Cr,
const vectorField nf,
const vectorField nr,
const scalarField smallDist,
const scalar  absTol,
const transformType  transform = UNKNOWN 
) const
protected

Calculate the transformation tensors.

smallDist : matching distance per face absTol : absolute error in normal if transformType = unknown it first tries rotational, then translational transform

Definition at line 293 of file coupledPolyPatch.C.

References coupledPolyPatch::coupledPolyPatch(), Foam::endl(), forAll, Foam::mag(), Foam::magSqr(), Foam::max(), Foam::min(), Foam::name(), Foam::nl, Foam::Pout, Foam::rotationTensor(), List< T >::setSize(), List< T >::size(), Foam::sqr(), Foam::sqrt(), Foam::sum(), and Foam::transform().

Referenced by coupledPolyPatch::getRotation().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ initGeometry()

virtual void initGeometry ( PstreamBuffers )
protectedpure virtual

Initialise the calculation of the patch geometry.

Reimplemented from polyPatch.

Implemented in oldCyclicPolyPatch, cyclicPolyPatch, cyclicAMIPolyPatch, processorPolyPatch, cyclicACMIPolyPatch, and processorCyclicPolyPatch.

◆ calcGeometry() [1/2]

virtual void calcGeometry ( PstreamBuffers )
protectedpure virtual

Calculate the patch geometry.

Reimplemented from polyPatch.

Implemented in cyclicPolyPatch, oldCyclicPolyPatch, cyclicAMIPolyPatch, processorPolyPatch, and processorCyclicPolyPatch.

Referenced by processorCyclicPolyPatch::calcGeometry(), and coupledPolyPatch::matchTolerance().

Here is the caller graph for this function:

◆ initMovePoints()

virtual void initMovePoints ( PstreamBuffers ,
const pointField  
)
protectedpure virtual

Initialise the patches for moving points.

Reimplemented from polyPatch.

Implemented in cyclicPolyPatch, oldCyclicPolyPatch, cyclicAMIPolyPatch, processorPolyPatch, processorCyclicPolyPatch, and cyclicACMIPolyPatch.

◆ movePoints()

virtual void movePoints ( PstreamBuffers ,
const pointField  
)
protectedpure virtual

Correct patches after moving points.

Reimplemented from polyPatch.

Implemented in cyclicPolyPatch, oldCyclicPolyPatch, cyclicAMIPolyPatch, processorPolyPatch, and processorCyclicPolyPatch.

◆ initUpdateMesh()

virtual void initUpdateMesh ( PstreamBuffers )
protectedpure virtual

Initialise the update of the patch topology.

Reimplemented from polyPatch.

Implemented in cyclicPolyPatch, oldCyclicPolyPatch, cyclicAMIPolyPatch, processorPolyPatch, and processorCyclicPolyPatch.

◆ updateMesh()

virtual void updateMesh ( PstreamBuffers )
protectedpure virtual

Update of the patch topology.

Reimplemented from polyPatch.

Implemented in cyclicPolyPatch, oldCyclicPolyPatch, cyclicAMIPolyPatch, processorPolyPatch, and processorCyclicPolyPatch.

◆ writeOBJ() [1/4]

void writeOBJ ( Ostream os,
const point pt 
)
staticprotected

Write point in OBJ format.

Definition at line 56 of file coupledPolyPatch.C.

References Foam::endl(), Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().

Referenced by coupledPolyPatch::writeOBJ().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ writeOBJ() [2/4]

void writeOBJ ( Ostream os,
const pointField points,
const labelList pointLabels 
)
staticprotected

Write selected points in OBJ format.

Definition at line 63 of file coupledPolyPatch.C.

References forAll, Foam::meshTools::writeOBJ(), and coupledPolyPatch::writeOBJ().

Here is the call graph for this function:

◆ writeOBJ() [3/4]

void writeOBJ ( const fileName fName,
const UList< face > &  faces,
const pointField points 
)
staticprotected

Write patch.

Definition at line 95 of file coupledPolyPatch.C.

References f(), forAll, coupledPolyPatch::getAnchorPoints(), Foam::nl, UList< T >::size(), and Foam::meshTools::writeOBJ().

Here is the call graph for this function:

◆ writeOBJ() [4/4]

void writeOBJ ( Ostream os,
const point p0,
const point p1,
label vertI 
)
staticprotected

Write edge in OBJ format.

Definition at line 77 of file coupledPolyPatch.C.

References Foam::nl, Foam::meshTools::writeOBJ(), and coupledPolyPatch::writeOBJ().

Here is the call graph for this function:

◆ getAnchorPoints()

Foam::pointField getAnchorPoints ( const UList< face > &  faces,
const pointField points,
const transformType  transform 
)
staticprotected

Get a unique anchor point for all faces.

Definition at line 131 of file coupledPolyPatch.C.

References coupledPolyPatch::calcFaceTol(), f(), forAll, and UList< T >::size().

Referenced by coupledPolyPatch::writeOBJ().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getRotation()

Foam::label getRotation ( const pointField points,
const face f,
const point anchor,
const scalar  tol 
)
staticprotected

Get the number of vertices face f needs to be rotated such that.

its f[0] point aligns with given anchor (within tol).

Definition at line 239 of file coupledPolyPatch.C.

References coupledPolyPatch::calcTransformTensors(), Foam::endl(), f(), forAll, Foam::magSqr(), Foam::nl, points, List< T >::size(), Foam::sqrt(), and WarningInFunction.

Referenced by coupledPolyPatch::calcFaceTol().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ TypeName()

TypeName ( "coupled"  )

Runtime type information.

◆ coupled()

virtual bool coupled ( ) const
inlinevirtual

Return true because this patch is coupled.

Reimplemented from polyPatch.

Reimplemented in cyclicAMIPolyPatch, and processorPolyPatch.

Definition at line 241 of file coupledPolyPatch.H.

References coupledPolyPatch::owner().

Referenced by coupledFvPatch::coupled().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ owner()

virtual bool owner ( ) const
pure virtual

◆ neighbour()

virtual bool neighbour ( ) const
inlinevirtual

Does the coupled side own the patch ?

Reimplemented in cyclicPolyPatch, and processorPolyPatch.

Definition at line 250 of file coupledPolyPatch.H.

References coupledPolyPatch::owner().

Here is the call graph for this function:

◆ transform() [1/2]

virtual transformType transform ( ) const
inlinevirtual

Type of transform.

Reimplemented in processorCyclicPolyPatch.

Definition at line 256 of file coupledPolyPatch.H.

References coupledPolyPatch::transformPosition().

Referenced by processorPolyPatch::calcGeometry(), fvMeshDistribute::printCoupleInfo(), and processorCyclicPolyPatch::transform().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ transform() [2/2]

virtual transformType& transform ( )
inlinevirtual

Type of transform.

This is currently only for use when collapsing generated meshes that can have zero area faces.

Reimplemented in processorCyclicPolyPatch.

Definition at line 264 of file coupledPolyPatch.H.

◆ transformPosition() [1/2]

virtual void transformPosition ( pointField ) const
pure virtual

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

Implemented in cyclicPolyPatch, cyclicAMIPolyPatch, processorCyclicPolyPatch, processorPolyPatch, and oldCyclicPolyPatch.

Referenced by mapDistribute::transformPosition::operator()(), coupledPolyPatch::transform(), and processorCyclicPolyPatch::transformPosition().

Here is the caller graph for this function:

◆ transformPosition() [2/2]

virtual void transformPosition ( point ,
const label  facei 
) const
pure virtual

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

Implemented in cyclicPolyPatch, processorCyclicPolyPatch, cyclicAMIPolyPatch, processorPolyPatch, and oldCyclicPolyPatch.

◆ separated()

virtual bool separated ( ) const
inlinevirtual

◆ separation()

virtual const vectorField& separation ( ) const
inlinevirtual

If the planes are separated the separation vector.

Reimplemented in processorCyclicPolyPatch.

Definition at line 282 of file coupledPolyPatch.H.

Referenced by particle< Type >::correctAfterParallelTransfer(), particle< Type >::hitCyclicAMIPatch(), particle< Type >::hitCyclicPatch(), cyclicRepeatAMIPolyPatch::resetAMI(), and processorCyclicPolyPatch::separation().

Here is the caller graph for this function:

◆ parallel()

virtual bool parallel ( ) const
inlinevirtual

◆ forwardT()

virtual const tensorField& forwardT ( ) const
inlinevirtual

◆ reverseT()

virtual const tensorField& reverseT ( ) const
inlinevirtual

Return neighbour-cell transformation tensor.

Reimplemented in processorCyclicPolyPatch.

Definition at line 300 of file coupledPolyPatch.H.

Referenced by cyclicFvPatch::reverseT(), processorFvPatch::reverseT(), cyclicPointPatch::reverseT(), cyclicAMIPointPatch::reverseT(), cyclicAMIFvPatch::reverseT(), and processorCyclicPolyPatch::reverseT().

Here is the caller graph for this function:

◆ collocated()

virtual const boolList& collocated ( ) const
inlinevirtual

Are faces collocated. Either size 0,1 or length of patch.

Reimplemented in processorCyclicPolyPatch.

Definition at line 306 of file coupledPolyPatch.H.

Referenced by processorCyclicPolyPatch::collocated().

Here is the caller graph for this function:

◆ matchTolerance()

scalar matchTolerance ( ) const
inline

◆ calcGeometry() [2/2]

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

◆ initOrder()

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

Initialize ordering for primitivePatch. Does not.

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

Reimplemented from polyPatch.

Implemented in cyclicAMIPolyPatch, cyclicPolyPatch, processorCyclicPolyPatch, processorPolyPatch, oldCyclicPolyPatch, and cyclicACMIPolyPatch.

Referenced by coupledPolyPatch::matchTolerance().

Here is the caller graph for this function:

◆ order()

virtual bool order ( PstreamBuffers ,
const primitivePatch ,
labelList faceMap,
labelList rotation 
) const
pure 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 polyPatch.

Implemented in cyclicAMIPolyPatch, cyclicPolyPatch, processorCyclicPolyPatch, processorPolyPatch, oldCyclicPolyPatch, and cyclicACMIPolyPatch.

Referenced by coupledPolyPatch::matchTolerance().

Here is the caller graph for this function:

◆ calcFaceTol()

Foam::scalarField calcFaceTol ( const UList< face > &  faces,
const pointField points,
const pointField faceCentres 
)
static

Calculate typical tolerance per face. Is currently max distance.

from face centre to any of the face vertices.

Definition at line 199 of file coupledPolyPatch.C.

References Foam::cmptMag(), Foam::cmptMax(), f(), forAll, coupledPolyPatch::getRotation(), Foam::magSqr(), Foam::max(), UList< T >::size(), and Foam::sqrt().

Referenced by coupledPolyPatch::getAnchorPoints(), and coupledPolyPatch::matchTolerance().

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

Reimplemented in cyclicAMIPolyPatch, cyclicPolyPatch, processorCyclicPolyPatch, processorPolyPatch, oldCyclicPolyPatch, cyclicACMIPolyPatch, and cyclicRepeatAMIPolyPatch.

Definition at line 560 of file coupledPolyPatch.C.

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

Referenced by coupledPolyPatch::matchTolerance(), processorPolyPatch::write(), cyclicPolyPatch::write(), and cyclicAMIPolyPatch::write().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ transformTypeNames

const NamedEnum< coupledPolyPatch::transformType, 5 > transformTypeNames
static

Definition at line 67 of file coupledPolyPatch.H.

Referenced by NamedEnum< directionType, 3 >::names().


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