Processor patch. More...

#include <processorFvPatch.H>

Inheritance diagram for processorFvPatch:

[legend]

Collaboration diagram for processorFvPatch:

[legend]

Public Member Functions
	TypeName (processorPolyPatch::typeName_())
	Runtime type information.
	processorFvPatch (const polyPatch &patch, const fvBoundaryMesh &bm)
	Construct from components.
virtual label	comm () const
	Return communicator used for comms.
virtual int	myProcNo () const
	Return processor number.
virtual int	neighbProcNo () const
	Return neighbour processor number.
virtual int	tag () const
	Return message tag used for sending.
virtual bool	coupled () const
	Return true if running parallel.
const processorPolyPatch &	procPolyPatch () const
virtual bool	parallel () const
	Are the cyclic planes parallel.
virtual const tensorField &	forwardT () const
	Return face transformation tensor.
virtual const tensorField &	reverseT () const
	Return neighbour-cell transformation tensor.
virtual tmp< vectorField >	delta () const
	Return delta (P to N) vectors across coupled patch.
virtual tmp< labelField >	interfaceInternalField (const labelUList &internalData) const
	Return the values of the given internal data adjacent to the interface as a field.
virtual tmp< labelField >	interfaceInternalField (const labelUList &internalData, const labelUList &faceCells) const
	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, const labelUList &internalData) const
	Initialise neighbour field transfer.
virtual void	initInternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF, const labelUList &faceCells) const
	Initialise neighbour field transfer using faceCells map.
virtual tmp< labelField >	internalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &internalData) const
	Return neighbour field.
virtual void	initInternalFieldTransfer (const Pstream::commsTypes commsType, labelUList &iF) const
	Inherit initInternalFieldTransfer from coupledFvPatch.
virtual void	initInternalFieldTransfer (const Pstream::commsTypes commsType, labelUList &iF, const labelUList &faceCell) const
	Inherit initInternalFieldTransfer from coupledFvPatch.
Public Member Functions inherited from coupledFvPatch
	TypeNameNoDebug (coupledPolyPatch::typeName_())
	Runtime type information.
	coupledFvPatch (const polyPatch &patch, const fvBoundaryMesh &bm)
	Construct from polyPatch.
virtual	~coupledFvPatch ()=default
	Destructor.
virtual const labelUList &	faceCells () const
	Return faceCell addressing.
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
Public Member Functions inherited from processorLduInterface
	TypeNameNoDebug ("processorLduInterface")
	Runtime type information.
	processorLduInterface () noexcept=default
	Default construct.
virtual	~processorLduInterface ()=default
	Destructor.
template<class Type>
void	send (const UPstream::commsTypes commsType, const UList< Type > &f) const
	Raw send function.
template<class Type>
void	receive (const UPstream::commsTypes commsType, UList< Type > &f) const
	Raw receive function.
template<class Type>
tmp< Field< Type > >	receive (const UPstream::commsTypes commsType, const label size) const
	Raw receive function returning field.
template<class Type>
void	compressedSend (const UPstream::commsTypes commsType, const UList< Type > &f) const
	Raw send function with data compression.
template<class Type>
void	compressedReceive (const UPstream::commsTypes commsType, UList< Type > &f) const
	Raw receive function with data compression.
template<class Type>
tmp< Field< Type > >	compressedReceive (const UPstream::commsTypes commsType, const label size) const
	Raw receive function with data compression returning field.
template<class Type>
Foam::tmp< Foam::Field< Type > >	receive (const UPstream::commsTypes commsType, const label size) const
template<class Type>
Foam::tmp< Foam::Field< Type > >	compressedReceive (const UPstream::commsTypes commsType, const label size) const

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

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.

Detailed Description

Processor patch.

Source files

Definition at line 49 of file processorFvPatch.H.

Constructor & Destructor Documentation

◆ processorFvPatch()

processorFvPatch	(	const polyPatch &	patch,
		const fvBoundaryMesh &	bm )

inline

Construct from components.

Definition at line 82 of file processorFvPatch.H.

References coupledFvPatch::coupledFvPatch(), fvPatch::patch(), and Foam::refCast().

Referenced by processorCyclicFvPatch::processorCyclicFvPatch().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ makeWeights()

void makeWeights ( scalarField & w ) const

protectedvirtual

Make patch weighting factors.

Implements coupledFvPatch.

Definition at line 37 of file processorFvPatch.C.

References coupledFvPatch::delta(), Foam::mag(), fvPatch::nf(), and UPstream::parRun().

Here is the call graph for this function:

◆ TypeName()

TypeName ( processorPolyPatch::typeName_() )

Runtime type information.

◆ comm()

virtual label comm ( ) const

inlinevirtual

Return communicator used for comms.

Implements processorLduInterface.

Definition at line 94 of file processorFvPatch.H.

◆ myProcNo()

virtual int myProcNo ( ) const

inlinevirtual

Return processor number.

Implements processorLduInterface.

Definition at line 102 of file processorFvPatch.H.

◆ neighbProcNo()

virtual int neighbProcNo ( ) const

inlinevirtual

Return neighbour processor number.

Implements processorLduInterface.

Definition at line 110 of file processorFvPatch.H.

◆ tag()

virtual int tag ( ) const

inlinevirtual

Return message tag used for sending.

Implements processorLduInterface.

Reimplemented in processorCyclicFvPatch.

Definition at line 118 of file processorFvPatch.H.

References UPstream::msgType().

Here is the call graph for this function:

◆ coupled()

virtual bool coupled ( ) const

inlinevirtual

Return true if running parallel.

Reimplemented from coupledFvPatch.

Definition at line 126 of file processorFvPatch.H.

References UPstream::parRun().

Here is the call graph for this function:

◆ procPolyPatch()

const processorPolyPatch & procPolyPatch ( ) const

inline

Definition at line 131 of file processorFvPatch.H.

◆ parallel()

virtual bool parallel ( ) const

inlinevirtual

Are the cyclic planes parallel.

Implements coupledFvPatch.

Reimplemented in processorCyclicFvPatch.

Definition at line 139 of file processorFvPatch.H.

Referenced by delta().

Here is the caller graph for this function:

◆ forwardT()

virtual const tensorField & forwardT ( ) const

inlinevirtual

Return face transformation tensor.

Implements coupledFvPatch.

Reimplemented in processorCyclicFvPatch.

Definition at line 147 of file processorFvPatch.H.

Referenced by delta().

Here is the caller graph for this function:

◆ reverseT()

virtual const tensorField & reverseT ( ) const

inlinevirtual

Return neighbour-cell transformation tensor.

Implements coupledFvPatch.

Reimplemented in processorCyclicFvPatch.

Definition at line 155 of file processorFvPatch.H.

◆ delta()

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

virtual

Return delta (P to N) vectors across coupled patch.

Implements coupledFvPatch.

Definition at line 63 of file processorFvPatch.C.

References coupledFvPatch::delta(), forwardT(), parallel(), UPstream::parRun(), and Foam::transform().

Here is the call graph for this function:

◆ interfaceInternalField() [1/2]

Foam::tmp< Foam::labelField > interfaceInternalField ( const labelUList & internalData ) const

virtual

Return the values of the given internal data adjacent to the interface as a field.

Implements coupledFvPatch.

Definition at line 98 of file processorFvPatch.C.

References fvPatch::patchInternalField().

Referenced by initInternalFieldTransfer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ interfaceInternalField() [2/2]

Foam::tmp< Foam::labelField > interfaceInternalField	(	const labelUList &	internalData,
		const labelUList &	faceCells ) const

virtual

Return the values of the given internal data adjacent to the interface as a field using a mapping faceCell.

Implements coupledFvPatch.

Definition at line 107 of file processorFvPatch.C.

References coupledFvPatch::faceCells(), tmp< T >::New(), fvPatch::patchInternalField(), and fvPatch::size().

Here is the call graph for this function:

◆ initInternalFieldTransfer() [1/4]

void initInternalFieldTransfer	(	const Pstream::commsTypes	commsType,
		const labelUList &	internalData ) const

virtual

Initialise neighbour field transfer.

Reimplemented from coupledFvPatch.

Definition at line 119 of file processorFvPatch.C.

References fvPatch::patchInternalField(), and processorLduInterface::send().

Here is the call graph for this function:

◆ initInternalFieldTransfer() [2/4]

void initInternalFieldTransfer	(	const Pstream::commsTypes	commsType,
		const labelUList &	iF,
		const labelUList &	faceCells ) const

virtual

Initialise neighbour field transfer using faceCells map.

Reimplemented from coupledFvPatch.

Definition at line 129 of file processorFvPatch.C.

References coupledFvPatch::faceCells(), interfaceInternalField(), and processorLduInterface::send().

Here is the call graph for this function:

◆ internalFieldTransfer()

Foam::tmp< Foam::labelField > internalFieldTransfer	(	const Pstream::commsTypes	commsType,
		const labelUList &	internalData ) const

virtual

Return neighbour field.

Implements coupledFvPatch.

Definition at line 140 of file processorFvPatch.C.

References processorLduInterface::receive(), and fvPatch::size().

Here is the call graph for this function:

◆ initInternalFieldTransfer() [3/4]

virtual void initInternalFieldTransfer	(	const Pstream::commsTypes	commsType,
		labelUList &	iF ) const

inlinevirtual

Inherit initInternalFieldTransfer from coupledFvPatch.

Reimplemented from coupledFvPatch.

Definition at line 169 of file coupledFvPatch.H.

◆ initInternalFieldTransfer() [4/4]

virtual void initInternalFieldTransfer	(	const Pstream::commsTypes	commsType,
		labelUList &	iF,
		const labelUList &	faceCell ) const

inlinevirtual

Inherit initInternalFieldTransfer from coupledFvPatch.

Reimplemented from coupledFvPatch.

Definition at line 179 of file coupledFvPatch.H.

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

src/finiteVolume/fvMesh/fvPatches/constraint/processor/processorFvPatch.H
src/finiteVolume/fvMesh/fvPatches/constraint/processor/processorFvPatch.C

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ processorFvPatch()

Member Function Documentation

◆ makeWeights()

◆ TypeName()

◆ comm()

◆ myProcNo()

◆ neighbProcNo()

◆ tag()

◆ coupled()

◆ procPolyPatch()

◆ parallel()

◆ forwardT()

◆ reverseT()

◆ delta()

◆ interfaceInternalField() [1/2]

◆ interfaceInternalField() [2/2]

◆ initInternalFieldTransfer() [1/4]

◆ initInternalFieldTransfer() [2/4]

◆ internalFieldTransfer()

◆ initInternalFieldTransfer() [3/4]

◆ initInternalFieldTransfer() [4/4]