An abstract base class for patches that couple regions of the computational domain e.g. cyclic and processor-processor links. More...

#include <coupledFvPatch.H>

Inheritance diagram for coupledFvPatch:

[legend]

Collaboration diagram for coupledFvPatch:

[legend]

Public Member Functions
	TypeNameNoDebug (coupledPolyPatch::typeName_())
	Runtime type information.
	coupledFvPatch (const polyPatch &patch, const fvBoundaryMesh &bm)
	Construct from polyPatch.
virtual	~coupledFvPatch ()=default
	Destructor.
virtual bool	coupled () const
	Return true because this patch is coupled.
virtual bool	parallel () const =0
	Are the cyclic planes parallel.
virtual const tensorField &	forwardT () const =0
	Return face transformation tensor.
virtual const tensorField &	reverseT () const =0
	Return neighbour-cell transformation tensor.
virtual const labelUList &	faceCells () const
	Return faceCell addressing.
virtual tmp< vectorField >	delta () const =0
	Return delta (P to N) vectors across coupled patch.
virtual tmp< labelField >	interfaceInternalField (const labelUList &internalData) const =0
	Return the values of the given internal data adjacent to the interface as a field.
virtual tmp< labelField >	interfaceInternalField (const labelUList &internalData, const labelUList &faceCell) const =0
	Return the values of the given internal data adjacent to the interface as a field using a mapping faceCell.
virtual void	initInternalFieldTransfer (const Pstream::commsTypes commsType, labelUList &iF) const
	Initialise neighbour field transfer.
virtual void	initInternalFieldTransfer (const Pstream::commsTypes commsType, labelUList &iF, const labelUList &faceCell) const
	Initialise neighbour field transfer using faceCells map.
virtual tmp< labelField >	internalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF) const =0
	Return neighbour field.
virtual void	initInternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF) const
	Inherit initInternalFieldTransfer from lduInterface.
virtual void	initInternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF, const labelUList &faceCells) const
	Inherit initInternalFieldTransfer from lduInterface.
Public Member Functions inherited from lduInterface
	TypeNameNoDebug ("lduInterface")
	Runtime type information.
	lduInterface () noexcept=default
	Default construct.
virtual	~lduInterface ()=default
	Destructor.
Public Member Functions inherited from fvPatch
virtual void	makeDeltaCoeffs (scalarField &) const
	Correct patch deltaCoeffs.
virtual void	makeNonOrthoDeltaCoeffs (scalarField &) const
	Correct patch non-ortho deltaCoeffs.
virtual void	makeNonOrthoCorrVectors (vectorField &) const
	Correct patch non-ortho correction vectors.
virtual void	initMovePoints ()
	Initialise the patches for moving points.
virtual void	movePoints ()
	Correct patches after moving points.
	TypeName (polyPatch::typeName_())
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, fvPatch, polyPatch,(const polyPatch &patch, const fvBoundaryMesh &bm),(patch, bm))
	fvPatch (const polyPatch &, const fvBoundaryMesh &)
	Construct from polyPatch and fvBoundaryMesh.
virtual	~fvPatch ()
	Destructor.
const polyPatch &	patch () const noexcept
	Return the polyPatch.
virtual const word &	name () const
	Return name.
label	index () const noexcept
	The index of this patch in the boundary mesh.
label	start () const noexcept
	The patch start within the polyMesh face list.
label	offset () const noexcept
	The offset of this patch within the boundary face list.
virtual label	size () const
	Patch size is the number of faces, but can be overloaded.
const fvBoundaryMesh &	boundaryMesh () const noexcept
	Return boundaryMesh reference.
template<class T>
const List< T >::subList	patchSlice (const UList< T > &values) const
	This patch slice from the complete list, which has size mesh::nFaces(), using the virtual patch size.
template<class T>
const List< T >::subList	boundarySlice (const UList< T > &values) const
	This patch slice from the list of boundary values, which has size mesh::nBoundaryFaces(), using the virtual patch size.
const vectorField &	Cf () const
	Return face centres.
tmp< vectorField >	Cn () const
	Return neighbour cell centres.
const vectorField &	Sf () const
	Return face area vectors, like the fvMesh::Sf() method.
const scalarField &	magSf () const
	Return face area magnitudes, like the fvMesh::magSf() method.
tmp< vectorField >	unitSf () const
	Return face unit normals, like the fvMesh::unitSf() method. Same as nf().
tmp< vectorField >	nf () const
	Return face unit normals, like the fvMesh::unitSf() method Same as unitSf().
const scalarField &	weights () const
	Return patch weighting factors.
const scalarField &	deltaCoeffs () const
	Return the face - cell distance coefficient except for coupled patches for which the cell-centre to coupled-cell-centre distance coefficient is returned.
template<class Type>
void	patchInternalField (const UList< Type > &internalData, const labelUList &addressing, UList< Type > &pfld) const
	Extract internal field next to patch using specified addressing.
template<class Type>
void	patchInternalField (const UList< Type > &internalData, UList< Type > &pfld) const
	Extract internal field next to patch as patch field using faceCells() mapping.
template<class Type>
tmp< Field< Type > >	patchInternalField (const UList< Type > &internalData) const
	Return given internal field next to patch as patch field using faceCells() mapping.
template<class GeometricField, class AnyType = bool>
const GeometricField::Patch &	patchField (const GeometricField &gf) const
	Return the patch field of the GeometricField corresponding to this patch.
template<class GeometricField, class AnyType = bool>
const GeometricField::Patch &	lookupPatchField (const word &name) const
	Lookup the named field from the local registry and return the patch field corresponding to this patch.
template<class GeometricField>
const GeometricField::Patch *	cfindPatchField (const word &name) const
	Find the named field (if any) from the local registry and return the patch field corresponding to this patch.
template<class Type>
Foam::tmp< Foam::Field< Type > >	patchInternalField (const UList< Type > &internalData) const

Protected Member Functions
virtual void	makeWeights (scalarField &) const =0
	Make patch weighting factors.

Friends
class	surfaceInterpolation

Additional Inherited Members
Public Types inherited from fvPatch
typedef fvBoundaryMesh	BoundaryMesh
	The boundary type associated with the patch.
Static Public Member Functions inherited from fvPatch
static autoPtr< fvPatch >	New (const polyPatch &, const fvBoundaryMesh &)
	Return a pointer to a new patch created on freestore from polyPatch.
static const fvPatch &	lookupPatch (const polyPatch &p)
	Lookup the polyPatch index on corresponding fvMesh.
static bool	constraintType (const word &patchType)
	Return true if the given type is a constraint type.
static wordList	constraintTypes ()
	Return a list of all the constraint patch types.