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

Inheritance diagram for coupledFvPatch:

[legend]

Collaboration diagram for coupledFvPatch:

[legend]

Public Member Functions
	TypeName (coupledPolyPatch::typeName_())
	Runtime type information. More...

	coupledFvPatch (const polyPatch &patch, const fvBoundaryMesh &bm)
	Construct from polyPatch. More...

virtual	~coupledFvPatch ()
	Destructor. More...

virtual bool	coupled () const
	Return true because this patch is coupled. More...

virtual bool	parallel () const =0
	Are the cyclic planes parallel. More...

virtual const tensorField &	forwardT () const =0
	Return face transformation tensor. More...

virtual const tensorField &	reverseT () const =0
	Return neighbour-cell transformation tensor. More...

virtual const labelUList &	faceCells () const
	Return faceCell addressing. More...

virtual tmp< vectorField >	delta () const =0
	Return delta (P to N) vectors across coupled patch. More...

virtual tmp< labelField >	interfaceInternalField (const labelUList &internalData) const =0

virtual tmp< labelField >	interfaceInternalField (const labelUList &internalData, const labelUList &faceCell) const =0

virtual void	initInternalFieldTransfer (const Pstream::commsTypes commsType, labelUList &iF) const
	Initialise neighbour field transfer. More...

virtual void	initInternalFieldTransfer (const Pstream::commsTypes commsType, labelUList &iF, const labelUList &faceCell) const
	Initialise neighbour field transfer using faceCells map. More...

virtual tmp< labelField >	internalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF) const =0
	Return neighbour field. More...

virtual void	initInternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF) const
	Inherit initInternalFieldTransfer from lduInterface. More...

virtual void	initInternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF, const labelUList &faceCells) const
	Inherit initInternalFieldTransfer from lduInterface. More...

Public Member Functions inherited from lduInterface
	TypeName ("lduInterface")
	Runtime type information. More...

	lduInterface ()=default
	Construct null. More...

virtual	~lduInterface ()=default
	Destructor. More...

virtual void	initInternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF) const
	Initialise transfer of internal field adjacent to the interface. More...

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

Public Member Functions inherited from fvPatch
virtual void	makeDeltaCoeffs (scalarField &) const
	Correct patch deltaCoeffs. More...

virtual void	makeNonOrthoDeltaCoeffs (scalarField &) const
	Correct patch non-ortho deltaCoeffs. More...

virtual void	makeNonOrthoCorrVectors (vectorField &) const
	Correct patch non-ortho correction vectors. More...

virtual void	initMovePoints ()
	Initialise the patches for moving points. More...

virtual void	movePoints ()
	Correct patches after moving points. More...

	TypeName (polyPatch::typeName_())
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, fvPatch, polyPatch,(const polyPatch &patch, const fvBoundaryMesh &bm),(patch, bm))

	fvPatch (const polyPatch &, const fvBoundaryMesh &)
	Construct from polyPatch and fvBoundaryMesh. More...

virtual	~fvPatch ()
	Destructor. More...

const polyPatch &	patch () const
	Return the polyPatch. More...

virtual const word &	name () const
	Return name. More...

virtual label	start () const
	Return start label of this patch in the polyMesh face list. More...

virtual label	size () const
	Return size. More...

label	index () const
	Return the index of this patch in the fvBoundaryMesh. More...

const fvBoundaryMesh &	boundaryMesh () const
	Return boundaryMesh reference. More...

template<class T >
const List< T >::subList	patchSlice (const List< T > &l) const
	Slice list to patch. More...

const vectorField &	Cf () const
	Return face centres. More...

tmp< vectorField >	Cn () const
	Return neighbour cell centres. More...

const vectorField &	Sf () const
	Return face area vectors. More...

const scalarField &	magSf () const
	Return face area magnitudes. More...

tmp< vectorField >	nf () const
	Return face normals. More...

const scalarField &	weights () const
	Return patch weighting factors. More...

const scalarField &	deltaCoeffs () const

template<class Type >
tmp< Field< Type > >	patchInternalField (const UList< Type > &) const
	Return given internal field next to patch as patch field. More...

template<class Type >
tmp< Field< Type > >	patchInternalField (const UList< Type > &, const labelUList &faceCells) const

template<class Type >
void	patchInternalField (const UList< Type > &, Field< Type > &) const
	Return given internal field next to patch as patch field. More...

template<class GeometricField , class Type >
const GeometricField::Patch &	patchField (const GeometricField &) const
	Return the corresponding patchField of the named field. More...

template<class GeometricField , class Type >
const GeometricField::Patch &	lookupPatchField (const word &name, const GeometricField =nullptr, const Type =nullptr) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	patchInternalField (const UList< Type > &f) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	patchInternalField (const UList< Type > &f, const labelUList &faceCells) const

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

Friends
class	surfaceInterpolation

Additional Inherited Members
Public Types inherited from fvPatch
typedef fvBoundaryMesh	BoundaryMesh

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. More...

static const fvPatch &	lookupPatch (const polyPatch &p)
	Lookup the polyPatch index on corresponding fvMesh. More...

static bool	constraintType (const word &pt)
	Return true if the given type is a constraint type. More...

static wordList	constraintTypes ()
	Return a list of all the constraint patch types. More...

Detailed Description

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

Source files

Definition at line 53 of file coupledFvPatch.H.

Constructor & Destructor Documentation

◆ coupledFvPatch()

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

inline

Construct from polyPatch.

Definition at line 83 of file coupledFvPatch.H.

◆ ~coupledFvPatch()

~coupledFvPatch ( )

virtual

Destructor.

Definition at line 40 of file coupledFvPatch.C.

Member Function Documentation

◆ makeWeights()

virtual void makeWeights ( scalarField & ) const

protectedpure virtual

Make patch weighting factors.

Reimplemented from fvPatch.

Implemented in cyclicACMIFvPatch, cyclicFvPatch, cyclicAMIFvPatch, and processorFvPatch.

◆ TypeName()

TypeName ( coupledPolyPatch::typeName_() )

Runtime type information.

◆ coupled()

virtual bool coupled ( ) const

inlinevirtual

Return true because this patch is coupled.

Reimplemented from fvPatch.

Reimplemented in cyclicAMIFvPatch, cyclicACMIFvPatch, and processorFvPatch.

Definition at line 99 of file coupledFvPatch.H.

References coupledPolyPatch::coupled().

Here is the call graph for this function:

◆ parallel()

virtual bool parallel ( ) const

pure virtual

Are the cyclic planes parallel.

Implemented in cyclicAMIFvPatch, cyclicACMIFvPatch, processorFvPatch, cyclicFvPatch, and processorCyclicFvPatch.

◆ forwardT()

virtual const tensorField& forwardT ( ) const

pure virtual

Return face transformation tensor.

Implemented in cyclicAMIFvPatch, cyclicACMIFvPatch, processorFvPatch, cyclicFvPatch, and processorCyclicFvPatch.

◆ reverseT()

virtual const tensorField& reverseT ( ) const

pure virtual

Return neighbour-cell transformation tensor.

Implemented in cyclicAMIFvPatch, cyclicACMIFvPatch, processorFvPatch, cyclicFvPatch, and processorCyclicFvPatch.

◆ faceCells()

virtual const labelUList& faceCells ( ) const

inlinevirtual

Return faceCell addressing.

Reimplemented from fvPatch.

Definition at line 114 of file coupledFvPatch.H.

References fvPatch::faceCells().

Referenced by cyclicAMIFvPatchField< scalar >::patchNeighbourField(), and cyclicACMIFvPatchField< Type >::patchNeighbourField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delta()

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

pure virtual

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

Reimplemented from fvPatch.

Implemented in cyclicAMIFvPatch, cyclicACMIFvPatch, cyclicFvPatch, and processorFvPatch.

Definition at line 46 of file coupledFvPatch.C.

Referenced by processorFvPatch::delta(), cyclicFvPatch::delta(), cyclicACMIFvPatch::delta(), cyclicAMIFvPatch::delta(), processorFvPatch::makeWeights(), cyclicFvPatch::makeWeights(), cyclicAMIFvPatch::makeWeights(), and cyclicACMIFvPatch::makeWeights().

Here is the caller graph for this function:

◆ interfaceInternalField() [1/2]

virtual tmp<labelField> interfaceInternalField ( const labelUList & internalData ) const

pure virtual

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

Implements lduInterface.

Implemented in cyclicAMIFvPatch, cyclicACMIFvPatch, cyclicFvPatch, and processorFvPatch.

◆ interfaceInternalField() [2/2]

virtual tmp<labelField> interfaceInternalField	(	const labelUList &	internalData,
		const labelUList &	faceCell
	)		const

pure virtual

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

Implements lduInterface.

Implemented in cyclicAMIFvPatch, cyclicACMIFvPatch, processorFvPatch, and cyclicFvPatch.

◆ initInternalFieldTransfer() [1/4]

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

inlinevirtual

Initialise neighbour field transfer.

Definition at line 146 of file coupledFvPatch.H.

◆ initInternalFieldTransfer() [2/4]

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

inlinevirtual

Initialise neighbour field transfer using faceCells map.

Definition at line 154 of file coupledFvPatch.H.

◆ internalFieldTransfer()

virtual tmp<labelField> internalFieldTransfer	(	const Pstream::commsTypes	commsType,
		const labelUList &	iF
	)		const

pure virtual

Return neighbour field.

Implements lduInterface.

Implemented in cyclicAMIFvPatch, cyclicACMIFvPatch, processorFvPatch, and cyclicFvPatch.

◆ initInternalFieldTransfer() [3/4]

virtual void initInternalFieldTransfer

inline

Inherit initInternalFieldTransfer from lduInterface.

Definition at line 100 of file lduInterface.H.

◆ initInternalFieldTransfer() [4/4]

virtual void initInternalFieldTransfer

inline

Inherit initInternalFieldTransfer from lduInterface.

Definition at line 109 of file lduInterface.H.

Friends And Related Function Documentation

◆ surfaceInterpolation

friend class surfaceInterpolation

friend

Definition at line 73 of file coupledFvPatch.H.

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

src/finiteVolume/fvMesh/fvPatches/basic/coupled/coupledFvPatch.H
src/finiteVolume/fvMesh/fvPatches/basic/coupled/coupledFvPatch.C

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ coupledFvPatch()

◆ ~coupledFvPatch()

Member Function Documentation

◆ makeWeights()

◆ TypeName()

◆ coupled()

◆ parallel()

◆ forwardT()

◆ reverseT()

◆ faceCells()

◆ delta()

◆ interfaceInternalField() [1/2]

◆ interfaceInternalField() [2/2]

◆ initInternalFieldTransfer() [1/4]

◆ initInternalFieldTransfer() [2/4]

◆ internalFieldTransfer()

◆ initInternalFieldTransfer() [3/4]

◆ initInternalFieldTransfer() [4/4]

Friends And Related Function Documentation

◆ surfaceInterpolation