calculatedProcessorFvPatchField< Type > Class Template Reference

A processorFvPatchField type bypassing fvPatch. More...

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

Public Member Functions

 TypeName ("calculatedProcessor")
 Runtime type information. More...
 
 calculatedProcessorFvPatchField (const lduInterface &interface, const fvPatch &, const DimensionedField< Type, volMesh > &)
 Construct from patch and internal field. More...
 
 calculatedProcessorFvPatchField (const calculatedProcessorFvPatchField< Type > &)
 Construct as copy. More...
 
virtual tmp< fvPatchField< Type > > clone () const
 Construct and return a clone. More...
 
 calculatedProcessorFvPatchField (const calculatedProcessorFvPatchField< 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...
 
virtual ~calculatedProcessorFvPatchField ()=default
 Destructor. More...
 
virtual label comm () const
 Return communicator used for comms. More...
 
virtual int myProcNo () const
 Return processor number. More...
 
virtual int neighbProcNo () const
 Return neighbour processor number. More...
 
virtual bool doTransform () const
 Is the transform required. More...
 
virtual const tensorFieldforwardT () const
 Return face transformation tensor. More...
 
virtual int rank () const
 Return rank of component for transform. More...
 
virtual bool coupled () const
 Return true if this patch field is coupled. More...
 
virtual tmp< Field< Type > > patchNeighbourField () const
 Return neighbour field of internal field. More...
 
virtual bool ready () const
 Is all data available. 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 void initInterfaceMatrixUpdate (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
 Initialise neighbour matrix update. 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 initInterfaceMatrixUpdate (Field< Type > &result, const bool add, const lduAddressing &lduAddr, const label patchId, const Field< Type > &psiInternal, const scalarField &coeffs, const Pstream::commsTypes commsType) const
 Initialise neighbour matrix update. More...
 
virtual 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
 Update result field based on interface functionality. More...
 
- Public Member Functions inherited from processorLduInterfaceField
 TypeName ("processorLduInterfaceField")
 Runtime type information. More...
 
 processorLduInterfaceField ()=default
 Construct null. More...
 
virtual ~processorLduInterfaceField ()=default
 Destructor. More...
 
template<class Type >
void transformCoupleField (Field< Type > &f) const
 Transform given patch field. More...
 
void transformCoupleField (solveScalarField &f, const direction cmpt) const
 Transform given patch component 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 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...
 
virtual void write (Ostream &) const
 Write. 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 (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...
 
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 fixesValue () const
 Return true if this patch field fixes a value. 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 updateCoeffs ()
 Update the coefficients associated with the patch field. 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)
 Manipulate matrix. More...
 
virtual void manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)
 Manipulate matrix with given weights. More...
 
virtual void manipulateMatrix (fvMatrix< Type > &matrix, const label iMatrix, const direction cmp)
 Manipulate fvMatrix. 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)
 

Protected Member Functions

void addToInternalField (solveScalarField &result, const bool add, const scalarField &coeffs, const solveScalarField &vals) const
 

Protected Attributes

const lduPrimitiveProcessorInterfaceprocInterface_
 Local reference cast into the interface. More...
 
Field< Type > sendBuf_
 Send buffer. More...
 
Field< Type > receiveBuf_
 Receive buffer. More...
 
solveScalarField scalarSendBuf_
 Scalar send buffer. More...
 
solveScalarField scalarReceiveBuf_
 Scalar receive buffer. More...
 
label outstandingSendRequest_
 Outstanding request. More...
 
label outstandingRecvRequest_
 Outstanding request. More...
 

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::calculatedProcessorFvPatchField< Type >

A processorFvPatchField type bypassing fvPatch.

Used to temporarily add updateInterfaceMatrix capabilities to a matrix during overset solving. Supplies:

  • patchNeighbourField functionality (cached in *this as per processorFvPatchField)
  • initEvaluate/evaluate: caching of patchNeighbourField (see above)
  • initInterfaceMatrixUpdate etc: adding of neighbouring data
Source files

Definition at line 63 of file calculatedProcessorFvPatchField.H.

Constructor & Destructor Documentation

◆ calculatedProcessorFvPatchField() [1/3]

calculatedProcessorFvPatchField ( const lduInterface interface,
const fvPatch p,
const DimensionedField< Type, volMesh > &  iF 
)

Construct from patch and internal field.

Definition at line 34 of file calculatedProcessorFvPatchField.C.

◆ calculatedProcessorFvPatchField() [2/3]

Construct as copy.

Definition at line 53 of file calculatedProcessorFvPatchField.C.

◆ calculatedProcessorFvPatchField() [3/3]

Construct as copy setting internal field reference.

Definition at line 71 of file calculatedProcessorFvPatchField.C.

◆ ~calculatedProcessorFvPatchField()

virtual ~calculatedProcessorFvPatchField ( )
virtualdefault

Destructor.

Member Function Documentation

◆ addToInternalField()

void addToInternalField ( solveScalarField result,
const bool  add,
const scalarField coeffs,
const solveScalarField vals 
) const
protected

Definition at line 282 of file calculatedProcessorFvPatchField.C.

References Foam::add(), and forAll.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "calculatedProcessor"  )

Runtime type information.

◆ clone() [1/2]

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

Construct and return a clone.

Implements coupledFvPatchField< Type >.

Definition at line 130 of file calculatedProcessorFvPatchField.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 147 of file calculatedProcessorFvPatchField.H.

◆ comm()

virtual label comm ( ) const
inlinevirtual

Return communicator used for comms.

Implements processorLduInterfaceField.

Definition at line 167 of file calculatedProcessorFvPatchField.H.

References lduPrimitiveProcessorInterface::comm(), and calculatedProcessorFvPatchField< Type >::procInterface_.

Here is the call graph for this function:

◆ myProcNo()

virtual int myProcNo ( ) const
inlinevirtual

Return processor number.

Implements processorLduInterfaceField.

Definition at line 173 of file calculatedProcessorFvPatchField.H.

References lduPrimitiveProcessorInterface::myProcNo(), and calculatedProcessorFvPatchField< Type >::procInterface_.

Here is the call graph for this function:

◆ neighbProcNo()

virtual int neighbProcNo ( ) const
inlinevirtual

Return neighbour processor number.

Implements processorLduInterfaceField.

Definition at line 180 of file calculatedProcessorFvPatchField.H.

References lduPrimitiveProcessorInterface::myProcNo(), and calculatedProcessorFvPatchField< Type >::procInterface_.

Here is the call graph for this function:

◆ doTransform()

virtual bool doTransform ( ) const
inlinevirtual

Is the transform required.

Implements processorLduInterfaceField.

Definition at line 186 of file calculatedProcessorFvPatchField.H.

◆ forwardT()

virtual const tensorField& forwardT ( ) const
inlinevirtual

Return face transformation tensor.

Implements processorLduInterfaceField.

Definition at line 192 of file calculatedProcessorFvPatchField.H.

References lduPrimitiveProcessorInterface::forwardT(), and calculatedProcessorFvPatchField< Type >::procInterface_.

Here is the call graph for this function:

◆ rank()

virtual int rank ( ) const
inlinevirtual

Return rank of component for transform.

Implements processorLduInterfaceField.

Definition at line 198 of file calculatedProcessorFvPatchField.H.

◆ coupled()

virtual bool coupled ( ) const
inlinevirtual

Return true if this patch field is coupled.

Our field supplies coefficients to the fvMatrix so should behave as a processorFvPatchField (in addBoundarySource it should not add to the source)

Reimplemented from coupledFvPatchField< Type >.

Definition at line 210 of file calculatedProcessorFvPatchField.H.

◆ patchNeighbourField()

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

Return neighbour field of internal field.

Implements coupledFvPatchField< Type >.

Definition at line 124 of file calculatedProcessorFvPatchField.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ ready()

bool ready ( ) const
virtual

Is all data available.

Reimplemented from lduInterfaceField.

Definition at line 90 of file calculatedProcessorFvPatchField.C.

◆ initEvaluate()

void initEvaluate ( const Pstream::commsTypes  commsType)
virtual

Initialise the evaluation of the patch field.

Reimplemented from coupledFvPatchField< Type >.

Definition at line 141 of file calculatedProcessorFvPatchField.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::blockMeshTools::read(), List< T >::setSize(), setSize(), and Foam::vtk::write().

Here is the call graph for this function:

◆ evaluate()

void evaluate ( const Pstream::commsTypes  commsType)
virtual

Evaluate the patch field.

Reimplemented from coupledFvPatchField< Type >.

Definition at line 195 of file calculatedProcessorFvPatchField.C.

◆ initInterfaceMatrixUpdate() [1/2]

void initInterfaceMatrixUpdate ( 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

Initialise neighbour matrix update.

Reimplemented from lduInterfaceField.

Definition at line 217 of file calculatedProcessorFvPatchField.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, forAll, lduAddressing::patchAddr(), patchId(), Foam::blockMeshTools::read(), and Foam::vtk::write().

Here is the call graph for this function:

◆ 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 310 of file calculatedProcessorFvPatchField.C.

References Foam::add().

Here is the call graph for this function:

◆ initInterfaceMatrixUpdate() [2/2]

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

Initialise neighbour matrix update.

Reimplemented from LduInterfaceField< Type >.

Definition at line 258 of file calculatedProcessorFvPatchField.H.

References NotImplemented.

◆ updateInterfaceMatrix() [2/2]

virtual 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
inlinevirtual

Update result field based on interface functionality.

Implements coupledFvPatchField< Type >.

Definition at line 273 of file calculatedProcessorFvPatchField.H.

References NotImplemented.

Member Data Documentation

◆ procInterface_

◆ sendBuf_

Field<Type> sendBuf_
mutableprotected

Send buffer.

Definition at line 78 of file calculatedProcessorFvPatchField.H.

◆ receiveBuf_

Field<Type> receiveBuf_
mutableprotected

Receive buffer.

Definition at line 81 of file calculatedProcessorFvPatchField.H.

◆ scalarSendBuf_

solveScalarField scalarSendBuf_
mutableprotected

Scalar send buffer.

Definition at line 84 of file calculatedProcessorFvPatchField.H.

◆ scalarReceiveBuf_

solveScalarField scalarReceiveBuf_
mutableprotected

Scalar receive buffer.

Definition at line 87 of file calculatedProcessorFvPatchField.H.

◆ outstandingSendRequest_

label outstandingSendRequest_
mutableprotected

Outstanding request.

Definition at line 90 of file calculatedProcessorFvPatchField.H.

◆ outstandingRecvRequest_

label outstandingRecvRequest_
mutableprotected

Outstanding request.

Definition at line 93 of file calculatedProcessorFvPatchField.H.


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