Base class with common functinality for regionCoupled polyPatch. It includes AMI. More...

Inheritance diagram for regionCoupledBase:

Collaboration diagram for regionCoupledBase:

[legend]

Public Member Functions
	TypeName ("regionCoupledBase")
	Runtime type information. More...

	regionCoupledBase (const polyPatch &)
	Construct from patch. More...

	regionCoupledBase (const polyPatch &, const dictionary &)
	Construct from dictionary. More...

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

virtual	~regionCoupledBase ()
	Destructor. More...

const word &	nbrPatchName () const
	Neighbour patch name. More...

const word &	nbrRegionName () const
	Neighbour region name. More...

bool	sameRegion () const
	Cached sampleRegion != mesh.name() More...

label	neighbPatchID () const
	Neighbour patch ID. More...

bool	owner () const
	Does this side own the patch? More...

const regionCoupledBase &	neighbPatch () const
	Return a reference to the neighbour patch. More...

const autoPtr< searchableSurface > &	surfPtr () const
	Return a reference to the projection surface. More...

const AMIPatchToPatchInterpolation &	AMI () const
	Return a reference to the AMI interpolator. More...

template<class Type >
tmp< Field< Type > >	interpolate (const Field< Type > &fld) const
	Interpolate field. More...

template<class Type >
tmp< Field< Type > >	interpolate (const tmp< Field< Type > > &tFld) const
	Interpolate tmp field. More...

template<class Type , class BinaryOp >
void	interpolate (const UList< Type > &fld, const BinaryOp &bop, List< Type > &result) const
	Low-level interpolate List. More...

virtual bool	order (PstreamBuffers &, const primitivePatch &, labelList &faceMap, labelList &rotation) const
	Return new ordering for primitivePatch. More...

virtual const word &	regionCoupleType () const =0
	Return the type. More...

virtual void	write (Ostream &) const
	Write the polyPatch data as a dictionary. More...

template<class Type >
Foam::tmp< Foam::Field< Type > >	interpolate (const Field< Type > &fld) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	interpolate (const tmp< Field< Type > > &tFld) const

Protected Member Functions
virtual void	clearGeom ()
	Clear geometry. More...

Private Member Functions
void	resetAMI () const
	Reset the AMI interpolator. More...

Private Attributes
const polyPatch &	patch_
	Patch to sample. More...

const word	nbrPatchName_
	Name of other half. More...

label	nbrPatchID_
	Index of other half. More...

const word	nbrRegionName_
	Name of other region. More...

const bool	sameRegion_
	Same region. More...

autoPtr< AMIPatchToPatchInterpolation >	AMIPtr_
	AMI interpolation class. More...

const bool	AMIReverse_
	Flag to indicate that slave patch should be reversed for AMI. More...

autoPtr< searchableSurface >	surfPtr_
	Projection surface. More...

const dictionary	surfDict_
	Dictionary used during projection surface construction. More...

Detailed Description

Base class with common functinality for regionCoupled polyPatch. It includes AMI.

Source files

Definition at line 51 of file regionCoupledBase.H.

Constructor & Destructor Documentation

◆ regionCoupledBase() [1/3]

regionCoupledBase ( const polyPatch & pp )

Construct from patch.

Definition at line 126 of file regionCoupledBase.C.

◆ regionCoupledBase() [2/3]

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

Construct from dictionary.

Definition at line 143 of file regionCoupledBase.C.

◆ regionCoupledBase() [3/3]

regionCoupledBase	(	const polyPatch &	pp,
		const regionCoupledBase &	mpb
	)

Construct as copy, resetting patch.

Definition at line 161 of file regionCoupledBase.C.

◆ ~regionCoupledBase()

~regionCoupledBase ( )

virtual

Destructor.

Definition at line 180 of file regionCoupledBase.C.

Member Function Documentation

◆ resetAMI()

void resetAMI ( ) const

private

Reset the AMI interpolator.

Definition at line 42 of file regionCoupledBase.C.

References regionCoupledBase::AMIPtr_, regionCoupledBase::AMIReverse_, polyPatch::boundaryMesh(), Foam::endl(), AMIInterpolation< SourcePatch, TargetPatch >::imFaceAreaWeight, PrimitivePatch< Face, FaceList, PointField, PointType >::localFaces(), PrimitivePatch< Face, FaceList, PointField, PointType >::localPoints(), polyBoundaryMesh::mesh(), patchIdentifier::name(), regionCoupledBase::neighbPatch(), Foam::nl, regionCoupledBase::owner(), regionCoupledBase::patch_, Time::path(), Foam::Pout, regionCoupledBase::surfPtr(), objectRegistry::time(), faceAreaIntersect::tmMesh, and Foam::meshTools::writeOBJ().

Here is the call graph for this function:

◆ clearGeom()

void clearGeom ( )

protectedvirtual

Clear geometry.

Definition at line 116 of file regionCoupledBase.C.

Referenced by regionCoupledWallPolyPatch::calcGeometry(), regionCoupledPolyPatch::movePoints(), regionCoupledWallPolyPatch::movePoints(), regionCoupledPolyPatch::updateMesh(), regionCoupledWallPolyPatch::updateMesh(), regionCoupledPolyPatch::~regionCoupledPolyPatch(), and regionCoupledWallPolyPatch::~regionCoupledWallPolyPatch().

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "regionCoupledBase" )

Runtime type information.

◆ nbrPatchName()

const word& nbrPatchName ( ) const

inline

Neighbour patch name.

Definition at line 126 of file regionCoupledBase.H.

References regionCoupledBase::nbrPatchName_.

Referenced by regionCoupledBase::neighbPatchID().

Here is the caller graph for this function:

◆ nbrRegionName()

const word& nbrRegionName ( ) const

inline

Neighbour region name.

Definition at line 132 of file regionCoupledBase.H.

References regionCoupledBase::nbrRegionName_.

Referenced by regionCoupledBaseFvPatch::nbrFvMesh(), and regionCoupledBaseFvPatch::nbrMesh().

Here is the caller graph for this function:

◆ sameRegion()

bool sameRegion ( ) const

inline

Cached sampleRegion != mesh.name()

Definition at line 138 of file regionCoupledBase.H.

References regionCoupledBase::sameRegion_.

Referenced by regionCoupledBaseFvPatch::sameRegion().

Here is the caller graph for this function:

◆ neighbPatchID()

Foam::label neighbPatchID ( ) const

Neighbour patch ID.

Definition at line 186 of file regionCoupledBase.C.

References polyMesh::boundaryMesh(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, polyBoundaryMesh::findPatchID(), objectRegistry::lookupObject(), mesh, polyBoundaryMesh::mesh(), polyBoundaryMesh::names(), regionCoupledBase::nbrPatchName(), Foam::nl, objectRegistry::time(), and WarningInFunction.

Referenced by regionCoupledBaseFvPatch::neighbFvPatch(), regionCoupledBaseFvPatch::neighbPatch(), and regionCoupledBaseFvPatch::neighbPatchID().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ owner()

bool owner ( ) const

Does this side own the patch?

Definition at line 237 of file regionCoupledBase.C.

Referenced by regionCoupledBaseFvPatch::owner(), and regionCoupledBase::resetAMI().

Here is the caller graph for this function:

◆ neighbPatch()

const Foam::regionCoupledBase & neighbPatch ( ) const

Return a reference to the neighbour patch.

Definition at line 301 of file regionCoupledBase.C.

References polyMesh::boundaryMesh(), objectRegistry::lookupObject(), mesh, polyBoundaryMesh::mesh(), and objectRegistry::time().

Referenced by regionCoupledBase::resetAMI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ surfPtr()

const Foam::autoPtr< Foam::searchableSurface > & surfPtr ( ) const

Return a reference to the projection surface.

Definition at line 251 of file regionCoupledBase.C.

References polyMesh::boundaryMesh(), TimePaths::constant(), mesh, polyBoundaryMesh::mesh(), IOobject::MUST_READ, searchableSurface::New(), IOobject::NO_WRITE, and fvMesh::time().

Referenced by regionCoupledBase::resetAMI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AMI()

const Foam::AMIPatchToPatchInterpolation & AMI ( ) const

Return a reference to the AMI interpolator.

Definition at line 282 of file regionCoupledBase.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Referenced by regionCoupledBaseFvPatch::AMI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ interpolate() [1/5]

tmp<Field<Type> > interpolate ( const Field< Type > & fld ) const

Interpolate field.

◆ interpolate() [2/5]

tmp<Field<Type> > interpolate ( const tmp< Field< Type > > & tFld ) const

Interpolate tmp field.

◆ interpolate() [3/5]

void interpolate	(	const UList< Type > &	fld,
		const BinaryOp &	bop,
		List< Type > &	result
	)		const

Low-level interpolate List.

Definition at line 64 of file regionCoupledBaseTemplates.C.

References fld().

Here is the call graph for this function:

◆ order()

bool order	(	PstreamBuffers &	pBufs,
		const primitivePatch &	pp,
		labelList &	faceMap,
		labelList &	rotation
	)		const

virtual

Return new ordering for primitivePatch.

Ordering is -faceMap: for every face index of the new face -rotation:for every new face the clockwise shift of the original face. Return false if nothing changes (faceMap is identity, rotation is 0), true otherwise.

Definition at line 315 of file regionCoupledBase.C.

References Foam::faceMap(), and List::setSize().

Here is the call graph for this function:

◆ regionCoupleType()

virtual const word& regionCoupleType ( ) const

pure virtual

Return the type.

Implemented in regionCoupledPolyPatch, and regionCoupledWallPolyPatch.

Referenced by regionCoupledBaseFvPatch::regionCoupleType().

Here is the caller graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write the polyPatch data as a dictionary.

Reimplemented in regionCoupledPolyPatch, and regionCoupledWallPolyPatch.

Definition at line 333 of file regionCoupledBase.C.

References token::END_STATEMENT, Foam::nl, and Ostream::writeKeyword().

Referenced by regionCoupledWallPolyPatch::write(), and regionCoupledPolyPatch::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ interpolate() [4/5]

Foam::tmp<Foam::Field<Type> > interpolate ( const Field< Type > & fld ) const

Definition at line 30 of file regionCoupledBaseTemplates.C.

References fld().

Here is the call graph for this function:

◆ interpolate() [5/5]

Foam::tmp<Foam::Field<Type> > interpolate ( const tmp< Field< Type > > & tFld ) const

Definition at line 47 of file regionCoupledBaseTemplates.C.

Field Documentation

◆ patch_

const polyPatch& patch_

private

Patch to sample.

Definition at line 58 of file regionCoupledBase.H.

Referenced by regionCoupledBase::resetAMI().

◆ nbrPatchName_

const word nbrPatchName_

private

Name of other half.

Definition at line 61 of file regionCoupledBase.H.

Referenced by regionCoupledBase::nbrPatchName().

◆ nbrPatchID_

label nbrPatchID_

mutableprivate

Index of other half.

Definition at line 64 of file regionCoupledBase.H.

◆ nbrRegionName_

const word nbrRegionName_

private

Name of other region.

Definition at line 67 of file regionCoupledBase.H.

Referenced by regionCoupledBase::nbrRegionName().

◆ sameRegion_

const bool sameRegion_

private

Same region.

Definition at line 70 of file regionCoupledBase.H.

Referenced by regionCoupledBase::sameRegion().

◆ AMIPtr_

autoPtr<AMIPatchToPatchInterpolation> AMIPtr_

mutableprivate

AMI interpolation class.

Definition at line 73 of file regionCoupledBase.H.

Referenced by regionCoupledBase::resetAMI().

◆ AMIReverse_

const bool AMIReverse_

private

Flag to indicate that slave patch should be reversed for AMI.

Definition at line 76 of file regionCoupledBase.H.

Referenced by regionCoupledBase::resetAMI().

◆ surfPtr_

autoPtr<searchableSurface> surfPtr_

mutableprivate

Projection surface.

Definition at line 79 of file regionCoupledBase.H.

◆ surfDict_

const dictionary surfDict_

private

Dictionary used during projection surface construction.

Definition at line 82 of file regionCoupledBase.H.

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

src/meshTools/regionCoupled/patches/regionCoupledPolyPatch/regionCoupledBase.H
src/meshTools/regionCoupled/patches/regionCoupledPolyPatch/regionCoupledBase.C
src/meshTools/regionCoupled/patches/regionCoupledPolyPatch/regionCoupledBaseTemplates.C

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ regionCoupledBase() [1/3]

◆ regionCoupledBase() [2/3]

◆ regionCoupledBase() [3/3]

◆ ~regionCoupledBase()

Member Function Documentation

◆ resetAMI()

◆ clearGeom()

◆ TypeName()

◆ nbrPatchName()

◆ nbrRegionName()

◆ sameRegion()

◆ neighbPatchID()

◆ owner()

◆ neighbPatch()

◆ surfPtr()

◆ AMI()

◆ interpolate() [1/5]

◆ interpolate() [2/5]

◆ interpolate() [3/5]

◆ order()

◆ regionCoupleType()

◆ write()

◆ interpolate() [4/5]

◆ interpolate() [5/5]

Field Documentation

◆ patch_

◆ nbrPatchName_

◆ nbrPatchID_

◆ nbrRegionName_

◆ sameRegion_

◆ AMIPtr_

◆ AMIReverse_

◆ surfPtr_

◆ surfDict_