mappedExtrudedPatchBase Class Reference

Engine which provides mapping between two patches and which offsets the geometry to account for the extrusion thickness. More...

Inheritance diagram for mappedExtrudedPatchBase:
Collaboration diagram for mappedExtrudedPatchBase:

Public Member Functions

 TypeName ("mappedExtrudedPatchBase")
 Runtime type information. More...
 
 mappedExtrudedPatchBase (const polyPatch &)
 Construct from patch. More...
 
 mappedExtrudedPatchBase (const polyPatch &pp, const word &nbrRegionName, const word &nbrPatchName, const bool isExtrudedRegion, const cyclicTransform &transform)
 Construct from components. More...
 
 mappedExtrudedPatchBase (const polyPatch &pp, const dictionary &dict, const bool defaultTransformIsNone)
 Construct from dictionary. More...
 
 mappedExtrudedPatchBase (const polyPatch &, const mappedExtrudedPatchBase &)
 Construct as copy, resetting the boundary mesh. More...
 
virtual ~mappedExtrudedPatchBase ()
 Destructor. More...
 
virtual void clearOut ()
 Clear out data on mesh change. More...
 
virtual void write (Ostream &) const
 Write the polyPatch data as a dictionary. More...
 
- Public Member Functions inherited from mappedPatchBase
 TypeName ("mappedPatchBase")
 Runtime type information. More...
 
 mappedPatchBase (const polyPatch &)
 Construct from patch. More...
 
 mappedPatchBase (const polyPatch &pp, const word &nbrRegionName, const word &nbrPatchName, const cyclicTransform &transform)
 Construct from components. More...
 
 mappedPatchBase (const polyPatch &pp, const dictionary &dict, const bool defaultTransformIsNone)
 Construct from dictionary. More...
 
 mappedPatchBase (const polyPatch &, const mappedPatchBase &)
 Construct as copy, resetting patch. More...
 
virtual ~mappedPatchBase ()
 Destructor. More...
 
template<class Type >
tmp< Field< Type > > fromNeighbour (const Field< Type > &nbrFld) const
 Map/interpolate the neighbour patch field to this patch. More...
 
template<class Type >
tmp< Field< Type > > fromNeighbour (const tmp< Field< Type >> &nbrFld) const
 Map/interpolate the neighbour patch field to this patch. More...
 
template<class Type >
tmp< Field< Type > > toNeighbour (const Field< Type > &fld) const
 Map/interpolate patch field to the neighbour patch. More...
 
template<class Type >
tmp< Field< Type > > toNeighbour (const tmp< Field< Type >> &fld) const
 Map/interpolate patch field to the neighbour patch. More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > fromNeighbour (const Field< Type > &nbrFld) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > fromNeighbour (const tmp< Field< Type >> &nbrFld) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > toNeighbour (const Field< Type > &fld) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > toNeighbour (const tmp< Field< Type >> &fld) const
 
- Public Member Functions inherited from mappedPatchBaseBase
 TypeName ("mappedPatchBaseBase")
 Runtime type information. More...
 
 mappedPatchBaseBase (const polyPatch &)
 Construct from patch. More...
 
 mappedPatchBaseBase (const polyPatch &pp, const word &nbrRegionName, const word &nbrPatchName, const cyclicTransform &transform)
 Construct from components. More...
 
 mappedPatchBaseBase (const polyPatch &pp, const dictionary &dict, const bool transformisNone)
 Construct from dictionary. More...
 
 mappedPatchBaseBase (const polyPatch &, const mappedPatchBaseBase &)
 Construct as copy, resetting patch. More...
 
virtual ~mappedPatchBaseBase ()
 Destructor. More...
 
const wordnbrRegionName () const
 Name of the region to map from. More...
 
const wordnbrPatchName () const
 Name of the patch to map from. More...
 
const transformertransform () const
 The transformation between the patches. More...
 
bool sameRegion () const
 Is the neighbour region the same as for this patch? More...
 
bool samePatch () const
 Is the neighbour patch the same as this patch? More...
 
bool sameUntransformedPatch () const
 Is the neighbour patch the same as this patch with no transform? More...
 
bool haveNbr () const
 Is the neighbour available? More...
 
const polyMeshnbrMesh () const
 Get the mesh for the region to map from. More...
 
const polyPatchnbrPolyPatch () const
 Get the patch to map from. More...
 
template<class PatchField , class FieldType >
void validateForField (const PatchField &field, const FieldType &iF, const dictionary &context, const label froms=from::any) const
 Validate that the map is appropriate for the given. More...
 
template<class PatchFieldType , class FieldType >
void validateMapForField (const PatchFieldType &field, const FieldType &iF, const dictionary &context, const label froms)
 
template<class PatchFieldType , class FieldType >
void validateForField (const PatchFieldType &field, const FieldType &iF, const dictionary &context, const label froms) const
 

Protected Member Functions

virtual tmp< vectorFieldpatchFaceAreas () const
 Get the face-areas for the patch. More...
 
virtual tmp< pointFieldpatchFaceCentres () const
 Get the face-centres for the patch. More...
 
virtual tmp< pointFieldpatchLocalPoints () const
 Get the local points for the patch. More...
 
- Protected Member Functions inherited from mappedPatchBase
tmp< vectorFieldnbrPatchFaceAreas () const
 Get the face-areas for the neighbour patch. More...
 
tmp< pointFieldnbrPatchFaceCentres () const
 Get the face-centres for the neighbour patch. More...
 
tmp< pointFieldnbrPatchLocalPoints () const
 Get the local points for the neighbour patch. More...
 
void calcMapping () const
 Calculate mapping. More...
 
bool nbrPatchIsMapped () const
 Return whether or not the neighbour patch is of mapped type. More...
 
const mappedPatchBasenbrMappedPatch () const
 Get the mapped neighbouring patch. More...
 
bool symmetric () const
 Determine whether the neighbouring patch maps from this patch in. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from mappedPatchBase
static const mappedPatchBasegetMap (const polyPatch &patch)
 Cast the given polyPatch to a mappedPatchBase. Handle errors. More...
 
- Static Public Member Functions inherited from mappedPatchBaseBase
template<class PatchField , class FieldType >
static void validateMapForField (const PatchField &field, const FieldType &iF, const dictionary &context, const label froms=from::any)
 Validate that the map exists and is appropriate for the given. More...
 
static bool specified (const dictionary &dict)
 Return whether or not the given dictionary contains a. More...
 
- Protected Attributes inherited from mappedPatchBase
const bool usingTree_
 Are we using the tree mapping method, or a patch-to-patch. More...
 
autoPtr< distributionMaptreeMapPtr_
 Distributor (if using tree) More...
 
labelList treeNbrPatchFaceIndices_
 Indices of the neighbouring patch faces who's values. More...
 
bool patchToPatchIsValid_
 Is the patch-to-patch intersection engine up to date? (if using. More...
 
autoPtr< patchToPatchpatchToPatchPtr_
 Patch-to-patch intersection engine (if using patch-to-patch) More...
 
const scalar matchTol_
 Matching tolerance. More...
 
const bool reMapAfterMove_
 Do we need to re-calculate the mapping if mesh motion takes place? More...
 
bool reMapNbr_
 Do we need to re-map the neighbour because this patch moved? More...
 
- Protected Attributes inherited from mappedPatchBaseBase
const polyPatchpatch_
 Patch to map to. More...
 
const coupleGroupIdentifier coupleGroup_
 Couple group for the region/patch to map from. More...
 
word nbrRegionName_
 Name of the region to map from. More...
 
word nbrPatchName_
 Name of the patch to map from. More...
 
cyclicTransform transform_
 The transformation between the patches. More...
 
- Static Protected Attributes inherited from mappedPatchBase
static const scalar defaultMatchTol_ = 1e-4
 Default Matching tolerance. More...
 

Detailed Description

Engine which provides mapping between two patches and which offsets the geometry to account for the extrusion thickness.

Source files

Definition at line 49 of file mappedExtrudedPatchBase.H.

Constructor & Destructor Documentation

◆ mappedExtrudedPatchBase() [1/4]

Construct from patch.

Definition at line 347 of file mappedExtrudedPatchBase.C.

◆ mappedExtrudedPatchBase() [2/4]

mappedExtrudedPatchBase ( const polyPatch pp,
const word nbrRegionName,
const word nbrPatchName,
const bool  isExtrudedRegion,
const cyclicTransform transform 
)

Construct from components.

Definition at line 354 of file mappedExtrudedPatchBase.C.

◆ mappedExtrudedPatchBase() [3/4]

mappedExtrudedPatchBase ( const polyPatch pp,
const dictionary dict,
const bool  defaultTransformIsNone 
)

Construct from dictionary.

Definition at line 368 of file mappedExtrudedPatchBase.C.

◆ mappedExtrudedPatchBase() [4/4]

mappedExtrudedPatchBase ( const polyPatch pp,
const mappedExtrudedPatchBase mepb 
)

Construct as copy, resetting the boundary mesh.

Definition at line 380 of file mappedExtrudedPatchBase.C.

◆ ~mappedExtrudedPatchBase()

Destructor.

Definition at line 393 of file mappedExtrudedPatchBase.C.

Member Function Documentation

◆ patchFaceAreas()

◆ patchFaceCentres()

Foam::tmp< Foam::pointField > patchFaceCentres ( ) const
protectedvirtual

Get the face-centres for the patch.

Reimplemented from mappedPatchBase.

Definition at line 177 of file mappedExtrudedPatchBase.C.

References mappedPatchBase::patchFaceCentres().

Here is the call graph for this function:

◆ patchLocalPoints()

◆ TypeName()

TypeName ( "mappedExtrudedPatchBase"  )

Runtime type information.

◆ clearOut()

void clearOut ( )
virtual

Clear out data on mesh change.

Reimplemented from mappedPatchBase.

Definition at line 399 of file mappedExtrudedPatchBase.C.

References mappedPatchBase::clearOut().

Referenced by mappedFilmSurfacePolyPatch::calcGeometry(), mappedExtrudedWallPolyPatch::calcGeometry(), mappedFilmSurfacePolyPatch::movePoints(), mappedExtrudedWallPolyPatch::movePoints(), mappedFilmSurfacePolyPatch::topoChange(), and mappedExtrudedWallPolyPatch::topoChange().

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

Reimplemented in mappedExtrudedWallPolyPatch, and mappedFilmSurfacePolyPatch.

Definition at line 409 of file mappedExtrudedPatchBase.C.

References mappedPatchBase::write(), and Foam::writeEntry().

Referenced by mappedFilmSurfacePolyPatch::write(), and mappedExtrudedWallPolyPatch::write().

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

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