cyclicAMIFvPatch Class Reference

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

Inheritance diagram for cyclicAMIFvPatch:
Collaboration diagram for cyclicAMIFvPatch:

Public Member Functions

 TypeName (cyclicAMIPolyPatch::typeName_())
 Runtime type information. More...
 
 cyclicAMIFvPatch (const polyPatch &patch, const fvBoundaryMesh &bm)
 Construct from polyPatch. More...
 
const cyclicAMIPolyPatchcyclicAMIPatch () const
 Return local reference cast into the cyclic patch. More...
 
virtual label nbrPatchID () const
 Return the neighbour patch ID. More...
 
virtual bool owner () const
 Is this side the owner? More...
 
virtual const cyclicAMIFvPatchnbrPatch () const
 Return the neighbour patch. More...
 
virtual const PtrList< AMIInterpolation > & AMIs () const
 Return a reference to the AMI interpolators. More...
 
virtual const List< transformer > & AMITransforms () const
 Return a reference to the AMI transforms. More...
 
virtual bool applyLowWeightCorrection () const
 Return true if applying the low weight correction. More...
 
virtual const transformertransform () const
 Return transformation between the coupled patches. More...
 
const cyclicAMIFvPatchneighbFvPatch () const
 
virtual bool coupled () const
 Return true if this patch is coupled. This is equivalent. More...
 
virtual tmp< vectorFielddelta () const
 Return delta (P to N) vectors across coupled patch. More...
 
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< labelFieldinterfaceInternalField (const labelUList &internalData) const
 Return the values of the given internal data adjacent to. More...
 
virtual tmp< labelFieldinternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &internalData) const
 Return neighbour field. More...
 
- Public Member Functions inherited from coupledFvPatch
 TypeName (coupledPolyPatch::typeName_())
 Runtime type information. More...
 
 coupledFvPatch (const polyPatch &patch, const fvBoundaryMesh &bm)
 Construct from polyPatch. More...
 
virtual ~coupledFvPatch ()
 Destructor. More...
 
virtual const labelUListfaceCells () const
 Return faceCell addressing. More...
 
virtual void initInternalFieldTransfer (const Pstream::commsTypes commsType, labelUList &iF) const
 Initialise neighbour field transfer. More...
 
- Public Member Functions inherited from lduInterface
 TypeName ("lduInterface")
 Runtime type information. More...
 
 lduInterface ()
 Construct null. More...
 
 lduInterface (const lduInterface &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~lduInterface ()
 Destructor. More...
 
virtual void initInternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF) const
 Initialise transfer of internal field adjacent to the interface. More...
 
void operator= (const lduInterface &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from fvPatch
 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...
 
 fvPatch (const fvPatch &)
 Disallow default bitwise copy construction. More...
 
virtual ~fvPatch ()
 Destructor. More...
 
const polyPatchpatch () const
 Return the polyPatch. More...
 
virtual const wordname () 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 fvBoundaryMeshboundaryMesh () const
 Return boundaryMesh reference. More...
 
const objectRegistrydb () const
 Return the local object registry. More...
 
template<class T >
const List< T >::subList patchSlice (const List< T > &l) const
 Slice list to patch. More...
 
const vectorFieldCf () const
 Return face centres. More...
 
tmp< vectorFieldCn () const
 Return neighbour cell centres. More...
 
const vectorFieldSf () const
 Return face area vectors. More...
 
const scalarFieldmagSf () const
 Return face area magnitudes. More...
 
tmp< vectorFieldnf () const
 Return face normals. More...
 
const scalarFieldweights () const
 Return patch weighting factors. More...
 
const scalarFielddeltaCoeffs () const
 Return the face - cell distance coeffient. More...
 
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 >
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::PatchpatchField (const GeometricField &) const
 Return the corresponding patchField of the named field. More...
 
template<class GeometricField , class Type >
GeometricField::PatchpatchField (GeometricField &) const
 Return the corresponding patchField reference of the named field. More...
 
template<class GeometricField , class Type >
const GeometricField::PatchlookupPatchField (const word &name) const
 Lookup and return the patchField of the named field from the. More...
 
void operator= (const fvPatch &)
 Disallow default bitwise assignment. More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > patchInternalField (const UList< Type > &f) const
 
- Public Member Functions inherited from cyclicAMILduInterface
 TypeName ("cyclicAMILduInterface")
 Runtime type information. More...
 
 cyclicAMILduInterface ()
 Construct null. More...
 
virtual ~cyclicAMILduInterface ()
 Destructor. More...
 

Protected Member Functions

tmp< scalarFielddeltan () const
 Return the patch-normal component of the deltas. More...
 
tmp< scalarFieldnbrDeltan () const
 Return the neighbour patch-normal component of the deltas. More...
 
virtual void makeWeights (scalarField &) const
 Make patch weighting factors. More...
 
- Protected Member Functions inherited from fvPatch
virtual void initMovePoints ()
 Initialise the patches for moving points. More...
 
virtual void movePoints ()
 Correct patches after moving points. More...
 

Additional Inherited Members

- Public Types inherited from fvPatch
typedef fvBoundaryMesh BoundaryMesh
 
- Static Public Member Functions inherited from fvPatch
static autoPtr< fvPatchNew (const polyPatch &, const fvBoundaryMesh &)
 Return a pointer to a new patch created on freestore from polyPatch. 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

Cyclic patch for Arbitrary Mesh Interface (AMI)

Source files

Definition at line 51 of file cyclicAMIFvPatch.H.

Constructor & Destructor Documentation

◆ cyclicAMIFvPatch()

cyclicAMIFvPatch ( const polyPatch patch,
const fvBoundaryMesh bm 
)
inline

Construct from polyPatch.

Definition at line 84 of file cyclicAMIFvPatch.H.

Member Function Documentation

◆ deltan()

Foam::tmp< Foam::scalarField > deltan ( ) const
protected

Return the patch-normal component of the deltas.

Definition at line 43 of file cyclicAMIFvPatch.C.

References coupledFvPatch::delta().

Here is the call graph for this function:

◆ nbrDeltan()

Foam::tmp< Foam::scalarField > nbrDeltan ( ) const
protected

Return the neighbour patch-normal component of the deltas.

Definition at line 49 of file cyclicAMIFvPatch.C.

References Foam::interpolate(), and fvPatch::nf().

Here is the call graph for this function:

◆ makeWeights()

void makeWeights ( scalarField w) const
protectedvirtual

Make patch weighting factors.

Implements coupledFvPatch.

Reimplemented in cyclicACMIFvPatch.

Definition at line 80 of file cyclicAMIFvPatch.C.

References forAll, and fvPatch::makeWeights().

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 97 of file cyclicAMIFvPatch.H.

Referenced by cyclicACMIFvPatch::neighbFvPatch().

Here is the caller graph for this function:

◆ nbrPatchID()

virtual label nbrPatchID ( ) const
inlinevirtual

Return the neighbour patch ID.

Implements cyclicAMILduInterface.

Definition at line 103 of file cyclicAMIFvPatch.H.

References cyclicAMIPolyPatch::nbrPatchID().

Here is the call graph for this function:

◆ owner()

virtual bool owner ( ) const
inlinevirtual

Is this side the owner?

Implements cyclicAMILduInterface.

Definition at line 109 of file cyclicAMIFvPatch.H.

References cyclicAMIPolyPatch::owner().

Here is the call graph for this function:

◆ nbrPatch()

virtual const cyclicAMIFvPatch& nbrPatch ( ) const
inlinevirtual

Return the neighbour patch.

Implements cyclicAMILduInterface.

Definition at line 115 of file cyclicAMIFvPatch.H.

References fvPatch::boundaryMesh(), and cyclicAMIPolyPatch::nbrPatchID().

Here is the call graph for this function:

◆ AMIs()

virtual const PtrList<AMIInterpolation>& AMIs ( ) const
inlinevirtual

Return a reference to the AMI interpolators.

Implements cyclicAMILduInterface.

Reimplemented in cyclicACMIFvPatch.

Definition at line 124 of file cyclicAMIFvPatch.H.

References cyclicAMIPolyPatch::AMIs().

Referenced by cyclicACMIFvPatch::AMIs().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ AMITransforms()

virtual const List<transformer>& AMITransforms ( ) const
inlinevirtual

Return a reference to the AMI transforms.

Implements cyclicAMILduInterface.

Reimplemented in cyclicACMIFvPatch.

Definition at line 130 of file cyclicAMIFvPatch.H.

References cyclicAMIPolyPatch::AMITransforms().

Referenced by cyclicACMIFvPatch::AMITransforms().

Here is the call graph for this function:
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 136 of file cyclicAMIFvPatch.H.

References cyclicAMIPolyPatch::applyLowWeightCorrection().

Here is the call graph for this function:

◆ transform()

virtual const transformer& transform ( ) const
inlinevirtual

Return transformation between the coupled patches.

Implements coupledFvPatch.

Definition at line 142 of file cyclicAMIFvPatch.H.

References cyclicAMIPolyPatch::transform().

Referenced by cyclicAMIFvPatchField< Type >::transform().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ neighbFvPatch()

const cyclicAMIFvPatch& neighbFvPatch ( ) const
inline

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

References UPstream::parRun().

Referenced by cyclicAMIFvPatch::neighbFvPatch().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ delta()

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

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

Implements coupledFvPatch.

Definition at line 113 of file cyclicAMIFvPatch.C.

References coupledFvPatch::delta(), forAll, cyclicAMIFvPatch::interfaceInternalField(), Foam::interpolate(), tmp< T >::ref(), List< T >::size(), Foam::transform(), dimensionSet::transform, transforms, and Foam::Zero.

Referenced by cyclicAMIFvPatch::neighbFvPatch().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ interpolate() [1/2]

tmp<Field<Type> > interpolate ( const Field< Type > &  fld,
const UList< Type > &  defaultValues = UList<Type>() 
) const
inline

Definition at line 165 of file cyclicAMIFvPatch.H.

References cyclicAMIPolyPatch::interpolate().

Referenced by cyclicAMIFvPatch::neighbFvPatch().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ interpolate() [2/2]

tmp<Field<Type> > interpolate ( const tmp< Field< Type >> &  tFld,
const UList< Type > &  defaultValues = UList<Type>() 
) const
inline

Definition at line 175 of file cyclicAMIFvPatch.H.

References cyclicAMIFvPatch::interfaceInternalField(), cyclicAMIFvPatch::internalFieldTransfer(), and cyclicAMIPolyPatch::interpolate().

Here is the call graph for this function:

◆ interfaceInternalField()

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

References cyclicAMIFvPatch::internalFieldTransfer().

Referenced by cyclicAMIFvPatch::delta(), and cyclicAMIFvPatch::interpolate().

Here is the call graph for this function:
Here is the caller 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 182 of file cyclicAMIFvPatch.C.

Referenced by cyclicAMIFvPatch::interfaceInternalField(), and cyclicAMIFvPatch::interpolate().

Here is the caller graph for this function:

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