Public Member Functions | List of all members
cyclicSlipPolyPatch Class Reference

Copy of cyclicSlip - used to be able to instantiate cyclicSlip pointPatch which is cyclicSlip with slip constraints. More...

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

Public Member Functions

 TypeName ("cyclicSlip")
 Runtime type information. More...
 
 cyclicSlipPolyPatch (const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType, const transformType transform=UNKNOWN)
 Construct from components. More...
 
 cyclicSlipPolyPatch (const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm, const word &patchType)
 Construct from dictionary. More...
 
 cyclicSlipPolyPatch (const cyclicSlipPolyPatch &pp, const polyBoundaryMesh &bm)
 Construct as copy, resetting the boundary mesh. More...
 
 cyclicSlipPolyPatch (const cyclicSlipPolyPatch &pp, const polyBoundaryMesh &bm, const label index, const label newSize, const label newStart, const word &neighbPatchName)
 Construct given the original patch and resetting the. More...
 
 cyclicSlipPolyPatch (const cyclicPolyPatch &pp, const polyBoundaryMesh &bm, const label index, const labelUList &mapAddressing, const label newStart)
 Construct given the original patch and a map. 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 ~cyclicSlipPolyPatch ()
 
- Public Member Functions inherited from cyclicPolyPatch
 TypeName ("cyclic")
 Runtime type information. More...
 
 cyclicPolyPatch (const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType, const transformType transform=UNKNOWN)
 Construct from components. More...
 
 cyclicPolyPatch (const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &neighbPatchName, const transformType transform, const vector &rotationAxis, const point &rotationCentre, const vector &separationVector)
 Construct from components. More...
 
 cyclicPolyPatch (const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm, const word &patchType)
 Construct from dictionary. More...
 
 cyclicPolyPatch (const cyclicPolyPatch &, const polyBoundaryMesh &)
 Construct as copy, resetting the boundary mesh. More...
 
 cyclicPolyPatch (const cyclicPolyPatch &pp, const polyBoundaryMesh &bm, const label index, const label newSize, const label newStart, const word &neighbPatchName)
 Construct given the original patch and resetting the. More...
 
 cyclicPolyPatch (const cyclicPolyPatch &pp, const polyBoundaryMesh &bm, const label index, const labelUList &mapAddressing, const label newStart)
 Construct given the original patch and a map. More...
 
virtual ~cyclicPolyPatch ()
 Destructor. More...
 
const wordneighbPatchName () const
 Neighbour patch name. More...
 
virtual label neighbPatchID () const
 Neighbour patchID. More...
 
virtual bool owner () const
 Does this side own the patch ? More...
 
virtual bool neighbour () const
 Does the coupled side own the patch ? More...
 
const cyclicPolyPatchneighbPatch () const
 
const edgeListcoupledPoints () const
 Return connected points (from patch local to neighbour patch local) More...
 
const edgeListcoupledEdges () const
 Return connected edges (from patch local to neighbour patch local). More...
 
virtual void transformPosition (pointField &l) const
 Transform a patch-based position from other side to this side. More...
 
virtual void transformPosition (point &, const label facei) const
 Transform a patch-based position from other side to this side. More...
 
label transformGlobalFace (const label facei) const
 
const vectorrotationAxis () const
 Axis of rotation for rotational cyclics. More...
 
const pointrotationCentre () const
 Point on axis of rotation for rotational cyclics. More...
 
const vectorseparationVector () const
 Translation vector for translational cyclics. 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...
 
- 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 coupled () const
 Return true because this patch is coupled. More...
 
virtual transformType transform () const
 Type of transform. More...
 
virtual transformTypetransform ()
 Type of transform. 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
 
- 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 ~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=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::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
 

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 }
 Enumeration defining the surface type. Used in check routines. More...
 
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< 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 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...
 
- Protected Member Functions inherited from cyclicPolyPatch
virtual void calcTransforms ()
 Recalculate the transformation tensors. More...
 
virtual void initGeometry (PstreamBuffers &)
 Initialise the calculation of the patch geometry. More...
 
virtual void initGeometry (const primitivePatch &referPatch, pointField &nbrCtrs, vectorField &nbrAreas, pointField &nbrCc)
 Initialise the calculation of the patch geometry. More...
 
virtual void calcGeometry (PstreamBuffers &)
 Calculate the patch geometry. 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 initMovePoints (PstreamBuffers &, const pointField &)
 Initialise the patches for moving points. More...
 
virtual void movePoints (PstreamBuffers &, 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...
 
- 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 clearGeom ()
 Clear geometry. More...
 
- Static Protected Member Functions inherited from coupledPolyPatch
static void writeOBJ (Ostream &os, const point &pt)
 Write point in OBJ format. More...
 
static void writeOBJ (Ostream &, const pointField &, const labelList &)
 Write selected points in OBJ format. More...
 
static void writeOBJ (const fileName &, const UList< face > &, const pointField &)
 Write patch. More...
 
static void writeOBJ (Ostream &os, const point &p0, const point &p1, label &vertI)
 Write edge in OBJ format. More...
 
static pointField getAnchorPoints (const UList< face > &, const pointField &, const transformType)
 Get a unique anchor point for all faces. More...
 
static label getRotation (const pointField &points, const face &f, const point &anchor, const scalar tol)
 Get the number of vertices face f needs to be rotated such that. More...
 

Detailed Description

Copy of cyclicSlip - used to be able to instantiate cyclicSlip pointPatch which is cyclicSlip with slip constraints.

Source files

Definition at line 49 of file cyclicSlipPolyPatch.H.

Constructor & Destructor Documentation

cyclicSlipPolyPatch ( const word name,
const label  size,
const label  start,
const label  index,
const polyBoundaryMesh bm,
const word patchType,
const transformType  transform = UNKNOWN 
)
inline

Construct from components.

Definition at line 64 of file cyclicSlipPolyPatch.H.

Referenced by cyclicSlipPolyPatch::clone(), and cyclicSlipPolyPatch::cyclicSlipPolyPatch().

Here is the caller graph for this function:

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

Construct from dictionary.

Definition at line 79 of file cyclicSlipPolyPatch.H.

References cyclicSlipPolyPatch::cyclicSlipPolyPatch().

Here is the call graph for this function:

cyclicSlipPolyPatch ( const cyclicSlipPolyPatch pp,
const polyBoundaryMesh bm 
)
inline

Construct as copy, resetting the boundary mesh.

Definition at line 92 of file cyclicSlipPolyPatch.H.

References cyclicSlipPolyPatch::cyclicSlipPolyPatch().

Here is the call graph for this function:

cyclicSlipPolyPatch ( const cyclicSlipPolyPatch pp,
const polyBoundaryMesh bm,
const label  index,
const label  newSize,
const label  newStart,
const word neighbPatchName 
)
inline

Construct given the original patch and resetting the.

face list and boundary mesh information

Definition at line 103 of file cyclicSlipPolyPatch.H.

References cyclicSlipPolyPatch::cyclicSlipPolyPatch().

Here is the call graph for this function:

cyclicSlipPolyPatch ( const cyclicPolyPatch pp,
const polyBoundaryMesh bm,
const label  index,
const labelUList mapAddressing,
const label  newStart 
)
inline

Construct given the original patch and a map.

Definition at line 118 of file cyclicSlipPolyPatch.H.

virtual ~cyclicSlipPolyPatch ( )
inlinevirtual

Definition at line 186 of file cyclicSlipPolyPatch.H.

Member Function Documentation

TypeName ( "cyclicSlip"  )

Runtime type information.

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

Construct and return a clone, resetting the boundary mesh.

Reimplemented from cyclicPolyPatch.

Definition at line 131 of file cyclicSlipPolyPatch.H.

References cyclicSlipPolyPatch::cyclicSlipPolyPatch().

Referenced by cyclicSlipPolyPatch::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Definition at line 139 of file cyclicSlipPolyPatch.H.

References cyclicSlipPolyPatch::clone(), cyclicSlipPolyPatch::cyclicSlipPolyPatch(), and cyclicPolyPatch::neighbPatchName().

Here is the call graph for this function:

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

Definition at line 163 of file cyclicSlipPolyPatch.H.

References cyclicSlipPolyPatch::cyclicSlipPolyPatch().

Here is the call graph for this function:


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