Cyclic patch for Arbitrary Mesh Interface (AMI). More...

#include <cyclicAMIFvPatch.H>

Inheritance diagram for cyclicAMIFvPatch:

[legend]

Collaboration diagram for cyclicAMIFvPatch:

[legend]

Public Member Functions
	TypeName (cyclicAMIPolyPatch::typeName_())
	Runtime type information.
	cyclicAMIFvPatch (const polyPatch &patch, const fvBoundaryMesh &bm)
	Construct from polyPatch.
const cyclicAMIPolyPatch &	cyclicAMIPatch () const
	Return local reference cast into the cyclic patch.
virtual bool	owner () const
	Does this side own the patch?
virtual label	neighbPatchID () const
	Return neighbour patch ID.
virtual const cyclicAMIFvPatch &	neighbPatch () const
	Return a reference to the neighbour patch.
virtual const AMIPatchToPatchInterpolation &	AMI () const
	Return a reference to the AMI interpolator.
virtual bool	applyLowWeightCorrection () const
	Return true if applying the low weight correction.
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.
const cyclicAMIFvPatch &	neighbFvPatch () const
virtual bool	coupled () const
	Return true if this patch is coupled. This is equivalent to the coupledPolyPatch::coupled() if parallel running or both sides present, false otherwise.
virtual tmp< vectorField >	delta () const
	Return delta (P to N) vectors across coupled patch.
template<class Type>
tmp< Field< Type > >	interpolate (const Field< Type > &fld, const UList< Type > &defaultValues=UList< Type >()) const
template<class Type>
tmp< Field< Type > >	interpolate (const tmp< Field< Type > > &tFld, const UList< Type > &defaultValues=UList< Type >()) const
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 tmp< labelField >	internalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &internalData) const
	Return neighbour field.
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.
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 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	initMovePoints ()
	Initialise the patches for 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 cyclicAMILduInterface
	TypeNameNoDebug ("cyclicAMILduInterface")
	Runtime type information.
	cyclicAMILduInterface () noexcept=default
	Default construct.
virtual	~cyclicAMILduInterface ()=default
	Destructor.

Protected Member Functions
void	makeWeights (scalarField &) const
	Make patch weighting factors.
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	movePoints ()
	Correct patches after moving points.

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

Cyclic patch for Arbitrary Mesh Interface (AMI).

Source files

Definition at line 50 of file cyclicAMIFvPatch.H.

Constructor & Destructor Documentation

◆ cyclicAMIFvPatch()

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

inline

Construct from polyPatch.

Definition at line 103 of file cyclicAMIFvPatch.H.

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

Referenced by delta(), makeWeights(), movePoints(), neighbFvPatch(), and neighbPatch().

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 87 of file cyclicAMIFvPatch.C.

References applyLowWeightCorrection(), coupled, cyclicAMIFvPatch(), coupledFvPatch::delta(), forAll, Foam::interpolate(), Foam::mag(), fvPatch::makeWeights(), neighbFvPatch(), fvPatch::nf(), and fvPatch::size().

Here is the call graph for this function:

◆ makeDeltaCoeffs()

void makeDeltaCoeffs ( scalarField & coeffs ) const

protectedvirtual

Correct patch deltaCoeffs.

Reimplemented from fvPatch.

Definition at line 130 of file cyclicAMIFvPatch.C.

◆ makeNonOrthoDeltaCoeffs()

void makeNonOrthoDeltaCoeffs ( scalarField & coeffs ) const

protectedvirtual

Correct patch non-ortho deltaCoeffs.

Reimplemented from fvPatch.

Definition at line 136 of file cyclicAMIFvPatch.C.

◆ makeNonOrthoCorrVectors()

void makeNonOrthoCorrVectors ( vectorField & vecs ) const

protectedvirtual

Correct patch non-ortho correction vectors.

Reimplemented from fvPatch.

Definition at line 143 of file cyclicAMIFvPatch.C.

◆ movePoints()

void movePoints ( )

protectedvirtual

Correct patches after moving points.

Reimplemented from fvPatch.

Definition at line 240 of file cyclicAMIFvPatch.C.

References AMI(), fvPatch::Cf(), cyclicAMIFvPatch(), cyclicAMIPatch(), DebugInfo, Foam::endl(), f(), polyPatch::faceAreas(), polyPatch::faceCentres(), forAll, Foam::gMin(), Foam::gSum(), fvPatch::index(), Foam::mag(), fvPatch::magSf(), boundaryMesh::mesh(), mesh, neighbPatch(), Foam::nl, owner(), fvPatch::patch(), and fvPatch::Sf().

Here is the call graph for this function:

◆ TypeName()

TypeName ( cyclicAMIPolyPatch::typeName_() )

Runtime type information.

◆ cyclicAMIPatch()

const cyclicAMIPolyPatch & cyclicAMIPatch ( ) const

inline

Return local reference cast into the cyclic patch.

Definition at line 153 of file cyclicAMIFvPatch.H.

Referenced by movePoints().

Here is the caller graph for this function:

◆ owner()

virtual bool owner ( ) const

inlinevirtual

Does this side own the patch?

Implements cyclicAMILduInterface.

Definition at line 161 of file cyclicAMIFvPatch.H.

Referenced by movePoints().

Here is the caller graph for this function:

◆ neighbPatchID()

virtual label neighbPatchID ( ) const

inlinevirtual

Return neighbour patch ID.

Implements cyclicAMILduInterface.

Definition at line 169 of file cyclicAMIFvPatch.H.

◆ neighbPatch()

virtual const cyclicAMIFvPatch & neighbPatch ( ) const

inlinevirtual

Return a reference to the neighbour patch.

Implements cyclicAMILduInterface.

Definition at line 177 of file cyclicAMIFvPatch.H.

References fvPatch::boundaryMesh(), cyclicAMIFvPatch(), cyclicAMIPolyPatch::neighbPatchID(), and Foam::refCast().

Referenced by movePoints().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AMI()

virtual const AMIPatchToPatchInterpolation & AMI ( ) const

inlinevirtual

Return a reference to the AMI interpolator.

Implements cyclicAMILduInterface.

Definition at line 188 of file cyclicAMIFvPatch.H.

Referenced by movePoints().

Here is the caller graph for this function:

◆ applyLowWeightCorrection()

virtual bool applyLowWeightCorrection ( ) const

inlinevirtual

Return true if applying the low weight correction.

Definition at line 196 of file cyclicAMIFvPatch.H.

Referenced by delta(), and makeWeights().

Here is the caller graph for this function:

◆ parallel()

virtual bool parallel ( ) const

inlinevirtual

Are the cyclic planes parallel.

Implements coupledFvPatch.

Definition at line 205 of file cyclicAMIFvPatch.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.

Definition at line 213 of file cyclicAMIFvPatch.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.

Definition at line 221 of file cyclicAMIFvPatch.H.

◆ neighbFvPatch()

const cyclicAMIFvPatch & neighbFvPatch ( ) const

inline

Definition at line 226 of file cyclicAMIFvPatch.H.

References fvPatch::boundaryMesh(), cyclicAMIFvPatch(), cyclicAMIPolyPatch::neighbPatchID(), and Foam::refCast().

Referenced by delta(), internalFieldTransfer(), and makeWeights().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coupled()

bool coupled ( ) const

virtual

Return true if this patch is coupled. This is equivalent to the coupledPolyPatch::coupled() if parallel running or both sides present, false otherwise.

Reimplemented from coupledFvPatch.

Definition at line 79 of file cyclicAMIFvPatch.C.

References fvPatch::boundaryMesh(), fvBoundaryMesh::mesh(), UPstream::parRun(), TimePaths::processorCase(), and fvMesh::time().

Here is the call graph for this function: