All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
cyclicACMIFvPatch Class Reference

Cyclic patch for Arbitrarily Coupled Mesh Interface (ACMI) More...

Inheritance diagram for cyclicACMIFvPatch:
Collaboration diagram for cyclicACMIFvPatch:

Public Member Functions

 TypeName (cyclicACMIPolyPatch::typeName_())
 Runtime type information. More...
 
 cyclicACMIFvPatch (const polyPatch &patch, const fvBoundaryMesh &bm)
 Construct from polyPatch. 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 transformations. More...
 
const cyclicACMIPolyPatchcyclicACMIPatch () const
 Return the poly patch. More...
 
const cyclicACMIFvPatchneighbFvPatch () const
 Return the neighbour patch. More...
 
const fvPatchnonOverlapFvPatch () const
 Return the non-overlap patch. More...
 
- Public Member Functions inherited from cyclicAMIFvPatch
 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 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...
 
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 GeometricField *=nullptr, const Type *=nullptr) 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

virtual void makeWeights (scalarField &) const
 Make patch weighting factors. More...
 
- Protected Member Functions inherited from cyclicAMIFvPatch
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...
 
- 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 Arbitrarily Coupled Mesh Interface (ACMI)

Source files

Definition at line 49 of file cyclicACMIFvPatch.H.

Constructor & Destructor Documentation

◆ cyclicACMIFvPatch()

cyclicACMIFvPatch ( const polyPatch patch,
const fvBoundaryMesh bm 
)
inline

Construct from polyPatch.

Definition at line 76 of file cyclicACMIFvPatch.H.

Member Function Documentation

◆ makeWeights()

void makeWeights ( scalarField w) const
protectedvirtual

Make patch weighting factors.

Reimplemented from cyclicAMIFvPatch.

Definition at line 86 of file cyclicACMIFvPatch.C.

References forAll, fvPatch::makeWeights(), and cyclicACMIPolyPatch::tolerance().

Here is the call graph for this function:

◆ TypeName()

TypeName ( cyclicACMIPolyPatch::typeName_()  )

Runtime type information.

◆ AMIs()

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

Return a reference to the AMI interpolators.

Reimplemented from cyclicAMIFvPatch.

Definition at line 87 of file cyclicACMIFvPatch.H.

References cyclicAMIFvPatch::AMIs().

Here is the call graph for this function:

◆ AMITransforms()

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

Return a reference to the AMI transformations.

Reimplemented from cyclicAMIFvPatch.

Definition at line 98 of file cyclicACMIFvPatch.H.

References cyclicAMIFvPatch::AMITransforms().

Here is the call graph for this function:

◆ cyclicACMIPatch()

const cyclicACMIPolyPatch& cyclicACMIPatch ( ) const
inline

Return the poly patch.

Definition at line 109 of file cyclicACMIFvPatch.H.

References fvPatch::patch().

Referenced by cyclicACMIFvPatchField< Type >::cyclicACMIPatch(), and cyclicACMIFvPatch::nonOverlapFvPatch().

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

◆ neighbFvPatch()

const cyclicACMIFvPatch& neighbFvPatch ( ) const
inline

Return the neighbour patch.

Definition at line 115 of file cyclicACMIFvPatch.H.

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

Here is the call graph for this function:

◆ nonOverlapFvPatch()

const fvPatch& nonOverlapFvPatch ( ) const
inline

Return the non-overlap patch.

Definition at line 124 of file cyclicACMIFvPatch.H.

References fvPatch::boundaryMesh(), cyclicACMIFvPatch::cyclicACMIPatch(), and cyclicACMIPolyPatch::nonOverlapPatchID().

Here is the call graph for this function:

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