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

Inheritance diagram for mappedExtrudedPatchBase:

[legend]

Collaboration diagram for mappedExtrudedPatchBase:

[legend]

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)
	Construct from dictionary. More...

	mappedExtrudedPatchBase (const polyPatch &, const mappedExtrudedPatchBase &)
	Construct as copy, resetting the boundary mesh. More...

virtual	~mappedExtrudedPatchBase ()
	Destructor. 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 transformType tt)
	Construct from dictionary. More...

	mappedPatchBase (const polyPatch &, const mappedPatchBase &)
	Construct as copy, resetting patch. More...

virtual	~mappedPatchBase ()
	Destructor. More...

void	clearOut (const bool move)
	Clear out data on mesh change. 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 transformType tt)
	Construct from dictionary. More...

	mappedPatchBaseBase (const polyPatch &, const mappedPatchBaseBase &)
	Construct as copy, resetting patch. More...

virtual	~mappedPatchBaseBase ()
	Destructor. More...

const word &	nbrRegionName () const
	Name of the region to map from. More...

const word &	nbrPatchName () const
	Name of the patch to map from. More...

const transformer &	transform () 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 polyMesh &	nbrMesh () const
	Get the mesh for the region to map from. More...

const polyPatch &	nbrPolyPatch () 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< vectorField >	patchFaceAreas () const
	Get the face-areas for the patch. More...

virtual tmp< pointField >	patchFaceCentres () const
	Get the face-centres for the patch. More...

virtual tmp< pointField >	patchLocalPoints () const
	Get the local points for the patch. More...

virtual void	clearOut () const
	Clear out data on mesh change. More...

Protected Member Functions inherited from mappedPatchBase
tmp< vectorField >	nbrPatchFaceAreas () const
	Get the face-areas for the neighbour patch. More...

tmp< pointField >	nbrPatchFaceCentres () const
	Get the face-centres for the neighbour patch. More...

tmp< pointField >	nbrPatchLocalPoints () const
	Get the local points for the neighbour patch. More...

bool	mappingIsValid () const
	Return whether or not the mapping is valid. More...

void	calcMapping () const
	Calculate mapping. More...

bool	nbrPatchIsMapped () const
	Return whether or not the neighbour patch is of mapped type. More...

const mappedPatchBase &	nbrMappedPatch () const
	Get the mapped neighbouring patch. More...

bool	symmetric () const
	Determine whether the neighbouring patch maps from this patch in. 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 mappedPatchBase
static const mappedPatchBase &	getMap (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	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...

Protected Attributes inherited from mappedPatchBase
const bool	usingTree_
	Are we using the tree mapping method, or a patch-to-patch. More...

autoPtr< distributionMap >	treeMapPtr_
	Distributor (if using tree) More...

labelList	treeNbrPatchFaceIndices_
	Indices of the neighbouring patch faces who's values. More...

autoPtr< patchToPatch >	patchToPatchPtr_
	Patch-to-patch intersection engine (if using patch-to-patch) More...

const scalar	matchTol_
	Matching tolerance. More...

label	mappingIsValid_
	Is the mapping engine up to date? Zero if out of date. One if out. More...

label	nbrMappingIsValid_
	If the neighbour's mapping engine (if there is one) up to date? More...

Protected Attributes inherited from mappedPatchBaseBase
const polyPatch &	patch_
	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...

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]

mappedExtrudedPatchBase ( const polyPatch & pp )

Construct from patch.

Definition at line 356 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 363 of file mappedExtrudedPatchBase.C.

◆ mappedExtrudedPatchBase() [3/4]

mappedExtrudedPatchBase	(	const polyPatch &	pp,
		const dictionary &	dict
	)

Construct from dictionary.

Definition at line 377 of file mappedExtrudedPatchBase.C.

◆ mappedExtrudedPatchBase() [4/4]

mappedExtrudedPatchBase	(	const polyPatch &	pp,
		const mappedExtrudedPatchBase &	mepb
	)

Construct as copy, resetting the boundary mesh.

Definition at line 388 of file mappedExtrudedPatchBase.C.

◆ ~mappedExtrudedPatchBase()

~mappedExtrudedPatchBase ( )

virtual

Destructor.

Definition at line 401 of file mappedExtrudedPatchBase.C.

Member Function Documentation

◆ patchFaceAreas()

Foam::tmp< Foam::vectorField > patchFaceAreas ( ) const

protectedvirtual

Get the face-areas for the patch.

Reimplemented from mappedPatchBase.

Definition at line 49 of file mappedExtrudedPatchBase.C.

References polyPatch::boundaryMesh(), FaceCellWave< Type, TrackingData >::data(), LayerInfoData< Type >::data(), Foam::exit(), primitiveMesh::faceAreas(), primitiveMesh::faceCentres(), Foam::FatalError, FatalErrorInFunction, forAll, polyMesh::globalData(), FaceCellWave< Type, TrackingData >::iterate(), polyBoundaryMesh::mesh(), mesh, fvMesh::name(), patchIdentifier::name(), primitiveMesh::nCells(), primitiveMesh::nFaces(), primitiveMesh::nInternalFaces(), globalMeshData::nTotalCells(), mappedPatchBaseBase::patch_, mappedPatchBase::patchFaceAreas(), FaceCellWave< Type, TrackingData >::setFaceInfo(), UList< T >::size(), polyPatch::start(), Foam::blendedInterfacialModel::valid(), and layerInfo::valid().

Here is the call graph for this function:

◆ 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()

Foam::tmp< Foam::pointField > patchLocalPoints ( ) const

protectedvirtual

Get the local points for the patch.

Reimplemented from mappedPatchBase.

Definition at line 194 of file mappedExtrudedPatchBase.C.

References polyMesh::boundaryMesh(), PointEdgeWave< Type, TrackingData >::data(), PointEdgeLayerInfoData< Type >::data(), Foam::dimLength, Foam::dimless, Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, polyMesh::globalData(), PointEdgeWave< Type, TrackingData >::iterate(), PrimitivePatch< FaceList, PointField >::localPoints(), polyBoundaryMesh::mesh(), mesh, PrimitivePatch< FaceList, PointField >::meshPoints(), fvMesh::name(), patchIdentifier::name(), primitiveMesh::nEdges(), GeometricField< Type, pointMesh, Field >::New(), DemandDrivenMeshObject< polyMesh, RepatchableMeshObject, pointMesh >::New(), primitiveMesh::nPoints(), PrimitivePatch< FaceList, PointField >::nPoints(), globalMeshData::nTotalCells(), globalMeshData::nTotalPoints(), mappedPatchBase::patchLocalPoints(), polyMesh::points(), PointEdgeWave< Type, TrackingData >::setPointInfo(), Foam::typedName(), Foam::blendedInterfacialModel::valid(), pointEdgeLayerInfo::valid(), regIOobject::write(), and Foam::Zero.

Here is the call graph for this function:

◆ clearOut()

void clearOut ( ) const

protectedvirtual

Clear out data on mesh change.

Reimplemented from mappedPatchBase.

Definition at line 345 of file mappedExtrudedPatchBase.C.

References mappedPatchBase::clearOut().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "mappedExtrudedPatchBase" )

Runtime type information.

◆ 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 407 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:

src/meshTools/mappedPatches/mappedExtrudedPatchBase/mappedExtrudedPatchBase.H
src/meshTools/mappedPatches/mappedExtrudedPatchBase/mappedExtrudedPatchBase.C

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ mappedExtrudedPatchBase() [1/4]

◆ mappedExtrudedPatchBase() [2/4]

◆ mappedExtrudedPatchBase() [3/4]

◆ mappedExtrudedPatchBase() [4/4]

◆ ~mappedExtrudedPatchBase()

Member Function Documentation

◆ patchFaceAreas()

◆ patchFaceCentres()

◆ patchLocalPoints()

◆ clearOut()

◆ TypeName()

◆ write()