mappedInternalPolyPatch Class Reference

Patch which holds a mapping engine to map cell values onto the patch. More...

Inheritance diagram for mappedInternalPolyPatch:
Collaboration diagram for mappedInternalPolyPatch:

Public Member Functions

 TypeName ("mappedInternal")
 Runtime type information. More...
 
 mappedInternalPolyPatch (const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType)
 Construct from components. More...
 
 mappedInternalPolyPatch (const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm, const word &patchType)
 Construct from dictionary. More...
 
 mappedInternalPolyPatch (const mappedInternalPolyPatch &, const polyBoundaryMesh &)
 Construct as copy, resetting the boundary mesh. More...
 
 mappedInternalPolyPatch (const mappedInternalPolyPatch &pp, const polyBoundaryMesh &bm, const label index, const label newSize, const label newStart)
 Construct given the original patch and resetting the. 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 ~mappedInternalPolyPatch ()
 Destructor. 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 &)
 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 &)
 Copy constructor. 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...
 
virtual bool coupled () const
 Return true if this patch is geometrically coupled (i.e. faces and. 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 areas. More...
 
const scalarField::subField magFaceAreas () const
 Return face area magnitudes. 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...
 
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...
 
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...
 
label index () const
 Return the index of this patch in the boundaryMesh. 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...
 
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< 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, 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...
 
autoPtr< PrimitivePatch< FaceList, PointField > > clone () const
 Construct and return a clone. More...
 
 ~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 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< FaceType > & 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 > & 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< objectHitprojectPoints (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< objectHitprojectFaceCentres (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 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...
 
void clearOut ()
 
void clearGeom ()
 
void clearTopology ()
 
void clearPatchMeshAddr ()
 
void operator= (const PrimitivePatch< FaceList, PointField > &)
 Assignment operator. More...
 
void operator= (PrimitivePatch< FaceList, PointField > &&)
 Move assignment operator. 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
 
- Public Member Functions inherited from mappedInternalPatchBase
 TypeName ("mappedInternalPatchBase")
 Runtime type information. More...
 
 mappedInternalPatchBase (const polyPatch &)
 Construct from patch. More...
 
 mappedInternalPatchBase (const polyPatch &pp, const word &nbrRegion)
 Construct with no offset. More...
 
 mappedInternalPatchBase (const polyPatch &, const dictionary &)
 Construct from dictionary. More...
 
 mappedInternalPatchBase (const polyPatch &, const mappedInternalPatchBase &)
 Construct as copy, resetting patch. More...
 
virtual ~mappedInternalPatchBase ()
 Destructor. More...
 
const wordnbrRegionName () const
 Name of the region to map from. More...
 
bool sameRegion () const
 Is the neighbour region the same as for this patch? More...
 
const distributionMapmap () const
 Return reference to the parallel distribution map. More...
 
const labelListcellIndices () const
 Return the indices of the cells who's values have to be. More...
 
const polyMeshnbrMesh () const
 Get the region mesh. More...
 
tmp< pointFieldsamplePoints () const
 Get the sample points. More...
 
void clearOut ()
 Clear out data on mesh change. More...
 
template<class Type >
tmp< Field< Type > > distribute (const Field< Type > &fld) const
 Wrapper around map/interpolate data distribution. More...
 
template<class Type >
tmp< Field< Type > > distribute (const tmp< Field< Type >> &fld) const
 Wrapper around map/interpolate data distribution. More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > distribute (const Field< Type > &fld) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > distribute (const tmp< Field< Type >> &fld) const
 

Protected Member Functions

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 &, const pointField &)
 Initialise the patches for moving points. More...
 
virtual void movePoints (PstreamBuffers &, const pointField &)
 Correct patches after moving points. More...
 
virtual void initTopoChange (PstreamBuffers &)
 Initialise the update of the patch topology. More...
 
virtual void topoChange (PstreamBuffers &)
 Update of the patch topology. More...
 
- Protected Member Functions inherited from polyPatch
virtual void movePoints (const pointField &p)
 Correct patches after moving points. 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 mappedInternalPatchBase
offsetMode readOffsetMode (const dictionary &dict) const
 Read the offset mode from a dictionary. More...
 
void calcMapping () const
 Calculate mapping. 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 mappedInternalPatchBase
enum  offsetMode { NORMAL , DIRECTION }
 How to project face centres. 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 Member Functions inherited from mappedInternalPatchBase
static bool specified (const dictionary &dict)
 Return whether or not the given dictionary contains a. More...
 
- Static Public Attributes inherited from polyPatch
static int disallowGenericPolyPatch
 Debug switch to disallow the use of genericPolyPatch. More...
 
- Static Public Attributes inherited from mappedInternalPatchBase
static const NamedEnum< offsetMode, 2 > offsetModeNames_
 
- 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...
 
- Protected Attributes inherited from mappedInternalPatchBase
const polyPatchpatch_
 Patch to map to. More...
 
word nbrRegionName_
 Name of the region to map from. More...
 
offsetMode offsetMode_
 How to offset the patch face centres to the sampling locations. More...
 
scalar distance_
 Offset distance. More...
 
vector offset_
 Offset vector. More...
 
autoPtr< distributionMapmapPtr_
 Distributor. More...
 
labelList cellIndices_
 Indices of the cells who's values have to be supplied to the. More...
 

Detailed Description

Patch which holds a mapping engine to map cell values onto the patch.

Source files

Definition at line 52 of file mappedInternalPolyPatch.H.

Constructor & Destructor Documentation

◆ mappedInternalPolyPatch() [1/4]

mappedInternalPolyPatch ( const word name,
const label  size,
const label  start,
const label  index,
const polyBoundaryMesh bm,
const word patchType 
)

Construct from components.

Definition at line 92 of file mappedInternalPolyPatch.C.

References List< T >::append(), Foam::findIndex(), and patchIdentifier::inGroups().

Referenced by mappedInternalPolyPatch::clone().

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

◆ mappedInternalPolyPatch() [2/4]

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

Construct from dictionary.

Definition at line 112 of file mappedInternalPolyPatch.C.

References List< T >::append(), Foam::findIndex(), and patchIdentifier::inGroups().

Here is the call graph for this function:

◆ mappedInternalPolyPatch() [3/4]

Construct as copy, resetting the boundary mesh.

Definition at line 131 of file mappedInternalPolyPatch.C.

◆ mappedInternalPolyPatch() [4/4]

mappedInternalPolyPatch ( const mappedInternalPolyPatch 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 142 of file mappedInternalPolyPatch.C.

◆ ~mappedInternalPolyPatch()

Destructor.

Definition at line 158 of file mappedInternalPolyPatch.C.

Member Function Documentation

◆ initCalcGeometry()

void initCalcGeometry ( PstreamBuffers pBufs)
protectedvirtual

Initialise the calculation of the patch geometry.

Reimplemented from polyPatch.

Definition at line 42 of file mappedInternalPolyPatch.C.

References polyPatch::initCalcGeometry().

Here is the call graph for this function:

◆ calcGeometry()

void calcGeometry ( PstreamBuffers pBufs)
protectedvirtual

Calculate the patch geometry.

Reimplemented from polyPatch.

Definition at line 48 of file mappedInternalPolyPatch.C.

References polyPatch::calcGeometry(), and mappedInternalPatchBase::clearOut().

Here is the call graph for this function:

◆ initMovePoints()

void initMovePoints ( PstreamBuffers pBufs,
const pointField p 
)
protectedvirtual

Initialise the patches for moving points.

Reimplemented from polyPatch.

Definition at line 55 of file mappedInternalPolyPatch.C.

References polyPatch::initMovePoints(), and p.

Here is the call graph for this function:

◆ movePoints()

void movePoints ( PstreamBuffers pBufs,
const pointField p 
)
protectedvirtual

Correct patches after moving points.

Reimplemented from polyPatch.

Definition at line 65 of file mappedInternalPolyPatch.C.

References mappedInternalPatchBase::clearOut(), polyPatch::movePoints(), and p.

Here is the call graph for this function:

◆ initTopoChange()

void initTopoChange ( PstreamBuffers pBufs)
protectedvirtual

Initialise the update of the patch topology.

Reimplemented from polyPatch.

Definition at line 76 of file mappedInternalPolyPatch.C.

References polyPatch::initTopoChange().

Here is the call graph for this function:

◆ topoChange()

void topoChange ( PstreamBuffers pBufs)
protectedvirtual

Update of the patch topology.

Reimplemented from polyPatch.

Definition at line 82 of file mappedInternalPolyPatch.C.

References mappedInternalPatchBase::clearOut(), and polyPatch::topoChange().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "mappedInternal"  )

Runtime type information.

◆ clone() [1/2]

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

Construct and return a clone, resetting the boundary mesh.

Reimplemented from polyPatch.

Definition at line 127 of file mappedInternalPolyPatch.H.

References mappedInternalPolyPatch::mappedInternalPolyPatch().

Here is the call graph for this function:

◆ clone() [2/2]

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.

Definition at line 134 of file mappedInternalPolyPatch.H.

◆ write()

void write ( Ostream os) const
virtual

Write the polyPatch data as a dictionary.

Reimplemented from mappedInternalPatchBase.

Definition at line 164 of file mappedInternalPolyPatch.C.

References mappedInternalPatchBase::write(), and polyPatch::write().

Here is the call graph for this function:

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