cyclicACMIFvPatchField< Type > Class Template Reference

This boundary condition enforces a cyclic condition between a pair of boundaries, whereby communication between the patches is performed using an arbitrarily coupled mesh interface (ACMI) interpolation. More...

Inheritance diagram for cyclicACMIFvPatchField< Type >:
[legend]
Collaboration diagram for cyclicACMIFvPatchField< Type >:
[legend]

Public Member Functions

 TypeName (cyclicACMIFvPatch::typeName_())
 Runtime type information. More...
 
 cyclicACMIFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 Construct from patch and internal field. More...
 
 cyclicACMIFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 cyclicACMIFvPatchField (const cyclicACMIFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given cyclicACMIFvPatchField onto a new patch. More...
 
 cyclicACMIFvPatchField (const cyclicACMIFvPatchField< Type > &)
 Construct as copy. More...
 
virtual tmp< fvPatchField< Type > > clone () const
 Construct and return a clone. More...
 
 cyclicACMIFvPatchField (const cyclicACMIFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchField< Type > > clone (const DimensionedField< Type, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
const cyclicACMIFvPatchcyclicACMIPatch () const
 Return local reference cast into the cyclic AMI patch. More...
 
virtual bool coupled () const
 Return true if coupled. Note that the underlying patch. More...
 
virtual bool fixesValue () const
 Return true if this patch field fixes a value. More...
 
virtual tmp< Field< Type > > patchNeighbourField () const
 Return neighbour coupled internal cell data. More...
 
const cyclicACMIFvPatchField< Type > & neighbourPatchField () const
 Return reference to neighbour patchField. More...
 
const fvPatchField< Type > & nonOverlapPatchField () const
 Return reference to non-overlapping patchField. More...
 
virtual void updateInterfaceMatrix (solveScalarField &result, const bool add, const lduAddressing &lduAddr, const label patchId, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
 Update result field based on interface functionality. More...
 
virtual void updateInterfaceMatrix (Field< Type > &, const bool add, const lduAddressing &lduAddr, const label patchId, const Field< Type > &, const scalarField &, const Pstream::commsTypes commsType) const
 Update result field based on interface functionality. More...
 
virtual void manipulateMatrix (fvMatrix< Type > &matrix)
 Manipulate matrix. More...
 
virtual void manipulateMatrix (fvMatrix< Type > &m, const label iMatrix, const direction cmpt)
 Manipulate matrix. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual bool doTransform () const
 Does the patch field perform the transformation. More...
 
virtual const tensorFieldforwardT () const
 Return face transformation tensor. More...
 
virtual const tensorFieldreverseT () const
 Return neighbour-cell transformation tensor. More...
 
virtual int rank () const
 Return rank of component for transform. More...
 
virtual void write (Ostream &os) const
 Write. More...
 
- Public Member Functions inherited from cyclicACMILduInterfaceField
 TypeName ("cyclicACMILduInterfaceField")
 Runtime type information. More...
 
 cyclicACMILduInterfaceField ()
 Construct null. More...
 
virtual ~cyclicACMILduInterfaceField ()
 Destructor. More...
 
template<class Type >
void transformCoupleField (Field< Type > &f) const
 Transform given patch field. More...
 
void transformCoupleField (solveScalarField &psiInternal, const direction cmpt) const
 Transform given patch internal field. More...
 
- Public Member Functions inherited from cyclicAMILduInterfaceField
 TypeName ("cyclicAMILduInterfaceField")
 Runtime type information. More...
 
 cyclicAMILduInterfaceField ()
 Construct null. More...
 
virtual ~cyclicAMILduInterfaceField ()
 Destructor. More...
 
template<class Type >
void transformCoupleField (Field< Type > &f) const
 Transform given patch field. More...
 
void transformCoupleField (solveScalarField &psiInternal, const direction cmpt) const
 Transform given patch internal field. More...
 
- Public Member Functions inherited from coupledFvPatchField< Type >
 TypeName (coupledFvPatch::typeName_())
 Runtime type information. More...
 
 coupledFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 Construct from patch and internal field. More...
 
 coupledFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
 Construct from patch and internal field and patch field. More...
 
 coupledFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)
 Construct from patch, internal field and dictionary. More...
 
 coupledFvPatchField (const coupledFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping the given coupledFvPatchField onto a new patch. More...
 
 coupledFvPatchField (const coupledFvPatchField< Type > &)
 Construct as copy. More...
 
 coupledFvPatchField (const coupledFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< Field< Type > > snGrad (const scalarField &deltaCoeffs) const
 Return patch-normal gradient. More...
 
virtual tmp< Field< Type > > snGrad () const
 Return patch-normal gradient. More...
 
virtual void initEvaluate (const Pstream::commsTypes commsType)
 Initialise the evaluation of the patch field. More...
 
virtual void evaluate (const Pstream::commsTypes commsType)
 Evaluate the patch field. More...
 
virtual tmp< Field< Type > > valueInternalCoeffs (const tmp< scalarField > &) const
 Return the matrix diagonal coefficients corresponding to the. More...
 
virtual tmp< Field< Type > > valueBoundaryCoeffs (const tmp< scalarField > &) const
 Return the matrix source coefficients corresponding to the. More...
 
virtual tmp< Field< Type > > gradientInternalCoeffs (const scalarField &deltaCoeffs) const
 Return the matrix diagonal coefficients corresponding to the. More...
 
virtual tmp< Field< Type > > gradientInternalCoeffs () const
 Return the matrix diagonal coefficients corresponding to the. More...
 
virtual tmp< Field< Type > > gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const
 Return the matrix source coefficients corresponding to the. More...
 
virtual tmp< Field< Type > > gradientBoundaryCoeffs () const
 Return the matrix source coefficients corresponding to the. More...
 
- Public Member Functions inherited from LduInterfaceField< Type >
 TypeName ("LduInterfaceField")
 Runtime type information. More...
 
 LduInterfaceField (const lduInterface &patch)
 Construct given coupled patch. More...
 
virtual ~LduInterfaceField ()=default
 Destructor. More...
 
virtual void initInterfaceMatrixUpdate (Field< Type > &, const bool add, const lduAddressing &, const label interfacei, const Field< Type > &, const scalarField &, const Pstream::commsTypes commsType) const
 Initialise neighbour matrix update. More...
 
virtual void initInterfaceMatrixUpdate (solveScalarField &result, const bool add, const lduAddressing &, const label interfacei, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
 Inherit initInterfaceMatrixUpdate from lduInterfaceField. More...
 
virtual void updateInterfaceMatrix (solveScalarField &result, const bool add, const lduAddressing &, const label interfacei, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const=0
 Inherit updateInterfaceMatrix from lduInterfaceField. More...
 
- Public Member Functions inherited from lduInterfaceField
 TypeName ("lduInterfaceField")
 Runtime type information. More...
 
 lduInterfaceField (const lduInterface &patch)
 Construct given coupled patch. More...
 
virtual ~lduInterfaceField ()=default
 Destructor. More...
 
const lduInterfaceinterface () const
 Return the interface. More...
 
virtual const wordinterfaceFieldType () const
 Return the interface type. More...
 
bool updatedMatrix () const
 Whether matrix has been updated. More...
 
boolupdatedMatrix ()
 Whether matrix has been updated. More...
 
virtual bool ready () const
 Is all data available. More...
 
virtual void initInterfaceMatrixUpdate (solveScalarField &result, const bool add, const lduAddressing &, const label interfacei, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
 
template<class Type >
void addToInternalField (Field< Type > &result, const bool add, const labelUList &faceCells, const scalarField &coeffs, const Field< Type > &vals) const
 Add/subtract weighted contributions to internal field. More...
 
- Public Member Functions inherited from fvPatchField< Type >
 TypeName ("fvPatchField")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (tmp, fvPatchField, patch,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF),(p, iF))
 
 declareRunTimeSelectionTable (tmp, fvPatchField, patchMapper,(const fvPatchField< Type > &ptf, const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const fvPatchFieldMapper &m),(dynamic_cast< const fvPatchFieldType & >(ptf), p, iF, m))
 
 declareRunTimeSelectionTable (tmp, fvPatchField, dictionary,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const dictionary &dict),(p, iF, dict))
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 Construct from patch and internal field. More...
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Type &value)
 Construct from patch, internal field and value. More...
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType)
 Construct from patch and internal field and patch type. More...
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
 Construct from patch and internal field and patch field. More...
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)
 Construct from patch, internal field and dictionary. More...
 
 fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping the given fvPatchField onto a new patch. More...
 
 fvPatchField (const fvPatchField< Type > &)
 Construct as copy. More...
 
 fvPatchField (const fvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual ~fvPatchField ()=default
 Destructor. More...
 
bool useImplicit () const noexcept
 Use implicit formulation for coupled patches only. More...
 
bool useImplicit (bool on) noexcept
 Set useImplicit on/off. More...
 
virtual bool assignable () const
 Return true if the value of the patch field. More...
 
const objectRegistrydb () const
 Return local objectRegistry. More...
 
const fvPatchpatch () const
 Return patch. More...
 
const DimensionedField< Type, volMesh > & internalField () const
 Return dimensioned internal field reference. More...
 
const Field< Type > & primitiveField () const
 Return internal field reference. More...
 
const wordpatchType () const
 Optional patch type. More...
 
wordpatchType ()
 Optional patch type. More...
 
bool updated () const
 Return true if the boundary condition has already been updated. More...
 
bool manipulatedMatrix () const
 Return true if the matrix has already been manipulated. More...
 
virtual void autoMap (const fvPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object. More...
 
virtual void rmap (const fvPatchField< Type > &, const labelList &)
 Reverse map the given fvPatchField onto this fvPatchField. More...
 
virtual void updateWeightedCoeffs (const scalarField &weights)
 Update the coefficients associated with the patch field. More...
 
virtual tmp< Field< Type > > patchInternalField () const
 Return internal field next to patch as patch field. More...
 
virtual void patchInternalField (Field< Type > &) const
 Return internal field next to patch as patch field. More...
 
virtual tmp< Field< Type > > valueInternalCoeffs (const tmp< Field< scalar >> &) const
 Return the matrix diagonal coefficients corresponding to the. More...
 
virtual tmp< Field< Type > > valueBoundaryCoeffs (const tmp< Field< scalar >> &) const
 Return the matrix source coefficients corresponding to the. More...
 
virtual void manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)
 Manipulate matrix with given weights. More...
 
void check (const fvPatchField< Type > &) const
 Check fvPatchField<Type> against given fvPatchField<Type> More...
 
virtual void operator= (const UList< Type > &)
 
virtual void operator= (const fvPatchField< Type > &)
 
virtual void operator+= (const fvPatchField< Type > &)
 
virtual void operator-= (const fvPatchField< Type > &)
 
virtual void operator*= (const fvPatchField< scalar > &)
 
virtual void operator/= (const fvPatchField< scalar > &)
 
virtual void operator+= (const Field< Type > &)
 
virtual void operator-= (const Field< Type > &)
 
virtual void operator*= (const Field< scalar > &)
 
virtual void operator/= (const Field< scalar > &)
 
virtual void operator= (const Type &)
 
virtual void operator+= (const Type &)
 
virtual void operator-= (const Type &)
 
virtual void operator*= (const scalar)
 
virtual void operator/= (const scalar)
 
virtual void operator== (const fvPatchField< Type > &)
 
virtual void operator== (const Field< Type > &)
 
virtual void operator== (const Type &)
 
template<class Type2 >
Foam::tmp< Foam::fvPatchField< Type > > NewCalculatedType (const fvPatchField< Type2 > &pf)
 

Additional Inherited Members

- Public Types inherited from fvPatchField< Type >
typedef fvPatch Patch
 
typedef calculatedFvPatchField< Type > Calculated
 
- Static Public Member Functions inherited from fvPatchField< Type >
static tmp< fvPatchField< Type > > New (const word &, const fvPatch &, const DimensionedField< Type, volMesh > &)
 Return a pointer to a new patchField created on freestore given. More...
 
static tmp< fvPatchField< Type > > New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, volMesh > &)
 Return a pointer to a new patchField created on freestore given. More...
 
static tmp< fvPatchField< Type > > New (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 Return a pointer to a new patchField created on freestore from. More...
 
static tmp< fvPatchField< Type > > New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 Return a pointer to a new patchField created on freestore. More...
 
static tmp< fvPatchField< Type > > NewCalculatedType (const fvPatch &)
 Return a pointer to a new calculatedFvPatchField created on. More...
 
template<class Type2 >
static tmp< fvPatchField< Type > > NewCalculatedType (const fvPatchField< Type2 > &)
 Return a pointer to a new calculatedFvPatchField created on. More...
 
static const wordcalculatedType ()
 Return the type of the calculated for of fvPatchField. More...
 
- Static Public Attributes inherited from fvPatchField< Type >
static int disallowGenericFvPatchField
 Debug switch to disallow the use of genericFvPatchField. More...
 

Detailed Description

template<class Type>
class Foam::cyclicACMIFvPatchField< Type >

This boundary condition enforces a cyclic condition between a pair of boundaries, whereby communication between the patches is performed using an arbitrarily coupled mesh interface (ACMI) interpolation.

Usage
Example of the boundary condition specification:
<patchName>
{
    type            cyclicACMI;
}
See also
Foam::AMIInterpolation
Source files

Definition at line 71 of file cyclicACMIFvPatchField.H.

Constructor & Destructor Documentation

◆ cyclicACMIFvPatchField() [1/5]

cyclicACMIFvPatchField ( const fvPatch p,
const DimensionedField< Type, volMesh > &  iF 
)

Construct from patch and internal field.

Definition at line 37 of file cyclicACMIFvPatchField.C.

◆ cyclicACMIFvPatchField() [2/5]

cyclicACMIFvPatchField ( const fvPatch p,
const DimensionedField< Type, volMesh > &  iF,
const dictionary dict 
)

Construct from patch, internal field and dictionary.

Definition at line 50 of file cyclicACMIFvPatchField.C.

References coupled(), dict, Foam::stringOps::evaluate(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, fld, Foam::nl, and p.

Here is the call graph for this function:

◆ cyclicACMIFvPatchField() [3/5]

cyclicACMIFvPatchField ( const cyclicACMIFvPatchField< Type > &  ptf,
const fvPatch p,
const DimensionedField< Type, volMesh > &  iF,
const fvPatchFieldMapper mapper 
)

Construct by mapping given cyclicACMIFvPatchField onto a new patch.

Definition at line 101 of file cyclicACMIFvPatchField.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, p, and Foam::foamVersion::patch.

Here is the call graph for this function:

◆ cyclicACMIFvPatchField() [4/5]

Construct as copy.

Definition at line 127 of file cyclicACMIFvPatchField.C.

◆ cyclicACMIFvPatchField() [5/5]

cyclicACMIFvPatchField ( const cyclicACMIFvPatchField< Type > &  ptf,
const DimensionedField< Type, volMesh > &  iF 
)

Construct as copy setting internal field reference.

Definition at line 139 of file cyclicACMIFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( cyclicACMIFvPatch::typeName_()  )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchField<Type> > clone ( ) const
inlinevirtual

Construct and return a clone.

Implements coupledFvPatchField< Type >.

Definition at line 137 of file cyclicACMIFvPatchField.H.

◆ clone() [2/2]

virtual tmp<fvPatchField<Type> > clone ( const DimensionedField< Type, volMesh > &  iF) const
inlinevirtual

Construct and return a clone setting internal field reference.

Implements coupledFvPatchField< Type >.

Definition at line 154 of file cyclicACMIFvPatchField.H.

◆ cyclicACMIPatch()

const cyclicACMIFvPatch& cyclicACMIPatch ( ) const
inline

Return local reference cast into the cyclic AMI patch.

Definition at line 170 of file cyclicACMIFvPatchField.H.

◆ coupled()

bool coupled ( ) const
virtual

Return true if coupled. Note that the underlying patch.

is not coupled() - the points don't align

Reimplemented from coupledFvPatchField< Type >.

Definition at line 153 of file cyclicACMIFvPatchField.C.

◆ fixesValue()

virtual bool fixesValue ( ) const
inlinevirtual

Return true if this patch field fixes a value.

Needed to check if a level has to be specified while solving Poisson equations

Reimplemented from fvPatchField< Type >.

Definition at line 185 of file cyclicACMIFvPatchField.H.

◆ patchNeighbourField()

Foam::tmp< Foam::Field< Type > > patchNeighbourField ( ) const
virtual

Return neighbour coupled internal cell data.

Implements coupledFvPatchField< Type >.

Definition at line 161 of file cyclicACMIFvPatchField.C.

References coupledFvPatch::faceCells(), cyclicACMIFvPatch::neighbPatch(), tmp< T >::ref(), and Foam::transform().

Here is the call graph for this function:

◆ neighbourPatchField()

const Foam::cyclicACMIFvPatchField< Type > & neighbourPatchField ( ) const

Return reference to neighbour patchField.

Definition at line 195 of file cyclicACMIFvPatchField.C.

References fld.

◆ nonOverlapPatchField()

const Foam::fvPatchField< Type > & nonOverlapPatchField ( ) const

Return reference to non-overlapping patchField.

Definition at line 212 of file cyclicACMIFvPatchField.C.

References fld.

◆ updateInterfaceMatrix() [1/2]

void updateInterfaceMatrix ( solveScalarField result,
const bool  add,
const lduAddressing lduAddr,
const label  patchId,
const solveScalarField psiInternal,
const scalarField coeffs,
const direction  cmpt,
const Pstream::commsTypes  commsType 
) const
virtual

Update result field based on interface functionality.

Implements coupledFvPatchField< Type >.

Definition at line 227 of file cyclicACMIFvPatchField.C.

References Foam::add(), lduAddressing::patchAddr(), and patchId().

Here is the call graph for this function:

◆ updateInterfaceMatrix() [2/2]

void updateInterfaceMatrix ( Field< Type > &  result,
const bool  add,
const lduAddressing lduAddr,
const label  patchId,
const Field< Type > &  psiInternal,
const scalarField coeffs,
const Pstream::commsTypes  commsType 
) const
virtual

Update result field based on interface functionality.

Implements coupledFvPatchField< Type >.

Definition at line 264 of file cyclicACMIFvPatchField.C.

References Foam::add(), lduAddressing::patchAddr(), and patchId().

Here is the call graph for this function:

◆ manipulateMatrix() [1/2]

void manipulateMatrix ( fvMatrix< Type > &  matrix)
virtual

Manipulate matrix.

Reimplemented from fvPatchField< Type >.

Definition at line 294 of file cyclicACMIFvPatchField.C.

◆ manipulateMatrix() [2/2]

void manipulateMatrix ( fvMatrix< Type > &  m,
const label  iMatrix,
const direction  cmpt 
)
virtual

Manipulate matrix.

Reimplemented from fvPatchField< Type >.

Definition at line 310 of file cyclicACMIFvPatchField.C.

References fvMatrix< Type >::boundaryCoeffs(), Foam::faceMap(), forAll, fvMatrix< Type >::internalCoeffs(), fvMatrix< Type >::lduMeshAssembly(), Foam::name(), Foam::foamVersion::patch, fvMatrix< Type >::psi(), and tmp< T >::ref().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Reimplemented from fvPatchField< Type >.

Definition at line 444 of file cyclicACMIFvPatchField.C.

◆ doTransform()

virtual bool doTransform ( ) const
inlinevirtual

Does the patch field perform the transformation.

Implements cyclicAMILduInterfaceField.

Definition at line 255 of file cyclicACMIFvPatchField.H.

References cyclicACMIFvPatch::parallel().

Here is the call graph for this function:

◆ forwardT()

virtual const tensorField& forwardT ( ) const
inlinevirtual

Return face transformation tensor.

Implements cyclicAMILduInterfaceField.

Definition at line 262 of file cyclicACMIFvPatchField.H.

References cyclicACMIFvPatch::forwardT().

Here is the call graph for this function:

◆ reverseT()

virtual const tensorField& reverseT ( ) const
inlinevirtual

Return neighbour-cell transformation tensor.

Implements cyclicAMILduInterfaceField.

Definition at line 268 of file cyclicACMIFvPatchField.H.

References cyclicACMIFvPatch::reverseT().

Here is the call graph for this function:

◆ rank()

virtual int rank ( ) const
inlinevirtual

Return rank of component for transform.

Implements cyclicAMILduInterfaceField.

Definition at line 274 of file cyclicACMIFvPatchField.H.

◆ write()

void write ( Ostream os) const
virtual

Write.

Reimplemented from coupledFvPatchField< Type >.

Definition at line 459 of file cyclicACMIFvPatchField.C.

References os(), and Foam::vtk::write().

Here is the call graph for this function:

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