nonConformalMappedPatchBase Class Reference

Base class for poly patches which provides non-conformal mapping between two potentially non-globally conforming poly patches. More...

Inheritance diagram for nonConformalMappedPatchBase:
Collaboration diagram for nonConformalMappedPatchBase:

Public Member Functions

 TypeName ("nonConformalMappedPatchBase")
 Runtime type information. More...
 
 nonConformalMappedPatchBase (const nonConformalPolyPatch &ncPp)
 Construct from non-conformal patch. More...
 
 nonConformalMappedPatchBase (const nonConformalPolyPatch &ncPp, const word &nbrRegionName, const word &nbrPatchName, const cyclicTransform &transform, const bool owner)
 Construct from components. More...
 
 nonConformalMappedPatchBase (const nonConformalPolyPatch &ncPp, const dictionary &dict, const transformType tt)
 Construct from dictionary. More...
 
 nonConformalMappedPatchBase (const nonConformalPolyPatch &ncPp, const nonConformalMappedPatchBase &)
 Construct as copy, resetting patch. More...
 
virtual ~nonConformalMappedPatchBase ()
 Destructor. More...
 
bool owner () const
 Does this side own the patch? More...
 
const patchToPatches::intersectionintersection () const
 Access the intersection engine. More...
 
void clearOut (const bool move)
 Clear out data on mesh change. More...
 
virtual void write (Ostream &) const
 Write as a dictionary. More...
 
- 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 transformType tt)
 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

bool calcOwner () const
 Constructor helper for owner. More...
 
const nonConformalMappedPatchBasenbrMappedPatch () const
 Neighbour patch. More...
 

Protected Attributes

const nonConformalPolyPatchpatch_
 Non-conformal patch to map to. More...
 
const bool owner_
 Does this side own the patch? More...
 
label intersectionIsValid_
 Is the intersection engine up to date? Zero if out of date. One if. More...
 
patchToPatches::intersection intersection_
 Patch-to-patch intersection engine. 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...
 
const moveUpdate moveUpdate_
 The condition that triggers re-calculation following motion. More...
 

Additional Inherited Members

- Public Types inherited from mappedPatchBaseBase
enum class  transformType { none , defaultNone , specified }
 The type of the transformation permitted/required by this patch. More...
 
enum class  moveUpdate { always , detect , never }
 Enumeration for the condition that triggers re-calculation of the. 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 moving (const polyPatch &patch, const polyPatch &nbrPatch)
 Return whether or not the patches have moved. More...
 
static bool specified (const dictionary &dict)
 Return whether or not the given dictionary contains a. More...
 
- Static Public Attributes inherited from mappedPatchBaseBase
static const NamedEnum< moveUpdate, 3 > moveUpdateNames_ {"always", "detect", "never"}
 Names of the move-update conditions. More...
 

Detailed Description

Base class for poly patches which provides non-conformal mapping between two potentially non-globally conforming poly patches.

Source files

Definition at line 51 of file nonConformalMappedPatchBase.H.

Constructor & Destructor Documentation

◆ nonConformalMappedPatchBase() [1/4]

Construct from non-conformal patch.

Definition at line 67 of file nonConformalMappedPatchBase.C.

◆ nonConformalMappedPatchBase() [2/4]

nonConformalMappedPatchBase ( const nonConformalPolyPatch ncPp,
const word nbrRegionName,
const word nbrPatchName,
const cyclicTransform transform,
const bool  owner 
)

Construct from components.

Definition at line 80 of file nonConformalMappedPatchBase.C.

◆ nonConformalMappedPatchBase() [3/4]

nonConformalMappedPatchBase ( const nonConformalPolyPatch ncPp,
const dictionary dict,
const transformType  tt 
)

Construct from dictionary.

Definition at line 97 of file nonConformalMappedPatchBase.C.

◆ nonConformalMappedPatchBase() [4/4]

Construct as copy, resetting patch.

Definition at line 112 of file nonConformalMappedPatchBase.C.

◆ ~nonConformalMappedPatchBase()

Destructor.

Definition at line 128 of file nonConformalMappedPatchBase.C.

Member Function Documentation

◆ calcOwner()

◆ nbrMappedPatch()

◆ TypeName()

TypeName ( "nonConformalMappedPatchBase"  )

Runtime type information.

◆ owner()

bool owner ( ) const

Does this side own the patch?

Definition at line 134 of file nonConformalMappedPatchBase.C.

◆ intersection()

◆ clearOut()

void clearOut ( const bool  move)

Clear out data on mesh change.

Definition at line 197 of file nonConformalMappedPatchBase.C.

References Foam::min().

Referenced by nonConformalMappedWallPolyPatch::clearGeom(), nonConformalMappedWallPolyPatch::initCalcGeometry(), nonConformalMappedWallPolyPatch::initMovePoints(), and nonConformalMappedWallPolyPatch::initTopoChange().

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

◆ write()

void write ( Ostream os) const
virtual

Write as a dictionary.

Reimplemented from mappedPatchBaseBase.

Reimplemented in nonConformalMappedWallPolyPatch.

Definition at line 214 of file nonConformalMappedPatchBase.C.

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

Referenced by nonConformalMappedWallPolyPatch::write().

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

Member Data Documentation

◆ patch_

const nonConformalPolyPatch& patch_
protected

Non-conformal patch to map to.

Definition at line 60 of file nonConformalMappedPatchBase.H.

Referenced by nonConformalMappedPatchBase::calcOwner().

◆ owner_

const bool owner_
protected

Does this side own the patch?

Definition at line 63 of file nonConformalMappedPatchBase.H.

◆ intersectionIsValid_

label intersectionIsValid_
mutableprotected

Is the intersection engine up to date? Zero if out of date. One if.

out of date (or potentially not out of date) because of motion. Two if up to date.

Definition at line 68 of file nonConformalMappedPatchBase.H.

◆ intersection_

patchToPatches::intersection intersection_
mutableprotected

Patch-to-patch intersection engine.

Definition at line 71 of file nonConformalMappedPatchBase.H.


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