Public Member Functions | List of all members
coupledFvPatchField< Type > Class Template Referenceabstract
Boundary conditions » Coupled

Abstract base class for coupled patches. More...

Inheritance diagram for coupledFvPatchField< Type >:
Inheritance graph
[legend]
Collaboration diagram for coupledFvPatchField< Type >:
Collaboration graph
[legend]

Public Member Functions

 TypeName (coupledFvPatch::typeName_())
 
 coupledFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 
 coupledFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
 
 coupledFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)
 
 coupledFvPatchField (const coupledFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 
 coupledFvPatchField (const coupledFvPatchField< Type > &)
 
virtual tmp< fvPatchField< Type > > clone () const =0
 
 coupledFvPatchField (const coupledFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 
virtual tmp< fvPatchField< Type > > clone (const DimensionedField< Type, volMesh > &) const =0
 
virtual bool coupled () const
 
virtual tmp< Field< Type > > patchNeighbourField () const =0
 
virtual tmp< Field< Type > > snGrad (const scalarField &deltaCoeffs) const
 
virtual tmp< Field< Type > > snGrad () const
 
virtual void initEvaluate (const Pstream::commsTypes commsType)
 
virtual void evaluate (const Pstream::commsTypes commsType)
 
virtual tmp< Field< Type > > valueInternalCoeffs (const tmp< scalarField > &) const
 
virtual tmp< Field< Type > > valueBoundaryCoeffs (const tmp< scalarField > &) const
 
virtual tmp< Field< Type > > gradientInternalCoeffs (const scalarField &deltaCoeffs) const
 
virtual tmp< Field< Type > > gradientInternalCoeffs () const
 
virtual tmp< Field< Type > > gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const
 
virtual tmp< Field< Type > > gradientBoundaryCoeffs () const
 
virtual void updateInterfaceMatrix (solveScalarField &result, const bool add, const lduAddressing &lduAddr, const label patchId, const solveScalarField &psiInternal, const scalarField &coeffs, const direction, const Pstream::commsTypes commsType) const =0
 
virtual void updateInterfaceMatrix (Field< Type > &, const bool add, const lduAddressing &lduAddr, const label patchId, const Field< Type > &, const scalarField &, const Pstream::commsTypes commsType) const =0
 
virtual void write (Ostream &) const
 
- Public Member Functions inherited from LduInterfaceField< Type >
 TypeName ("LduInterfaceField")
 
 LduInterfaceField (const lduInterface &patch)
 
virtual ~LduInterfaceField ()=default
 
virtual void initInterfaceMatrixUpdate (Field< Type > &, const bool add, const lduAddressing &, const label interfacei, const Field< Type > &, const scalarField &, const Pstream::commsTypes commsType) const
 
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
 
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
 
- Public Member Functions inherited from lduInterfaceField
 TypeName ("lduInterfaceField")
 
 lduInterfaceField (const lduInterface &patch)
 
virtual ~lduInterfaceField ()=default
 
const lduInterface & interface () const
 
virtual const word & interfaceFieldType () const
 
bool updatedMatrix () const
 
bool & updatedMatrix ()
 
virtual bool ready () const
 
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
 
- Public Member Functions inherited from fvPatchField< Type >
 TypeName ("fvPatchField")
 
 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 > &)
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Type &value)
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType)
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)
 
 fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 
 fvPatchField (const fvPatchField< Type > &)
 
 fvPatchField (const fvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 
virtual tmp< fvPatchField< Type > > clone () const
 
Foam::tmp< Foam::fvPatchField< Type > > NewCalculatedType (const fvPatch &p)
 
Foam::tmp< Foam::fvPatchField< Type > > NewCalculatedType (const fvPatchField< Type2 > &pf)
 
virtual ~fvPatchField ()=default
 
bool useImplicit () const noexcept
 
bool useImplicit (bool on) noexcept
 
virtual bool fixesValue () const
 
virtual bool assignable () const
 
virtual bool coupled () const
 
const objectRegistry & db () const
 
const fvPatch & patch () const
 
const DimensionedField< Type, volMesh > & internalField () const
 
const Field< Type > & primitiveField () const
 
const word & patchType () const
 
word & patchType ()
 
bool updated () const
 
bool manipulatedMatrix () const
 
virtual void autoMap (const fvPatchFieldMapper &)
 
virtual void rmap (const fvPatchField< Type > &, const labelList &)
 
virtual tmp< Field< Type > > snGrad () const
 
virtual void updateCoeffs ()
 
virtual void updateWeightedCoeffs (const scalarField &weights)
 
virtual tmp< Field< Type > > patchInternalField () const
 
virtual void patchInternalField (Field< Type > &) const
 
virtual tmp< Field< Type > > patchNeighbourField () const
 
virtual tmp< Field< Type > > valueInternalCoeffs (const tmp< Field< scalar >> &) const
 
virtual tmp< Field< Type > > valueBoundaryCoeffs (const tmp< Field< scalar >> &) const
 
virtual tmp< Field< Type > > gradientInternalCoeffs () const
 
virtual tmp< Field< Type > > gradientBoundaryCoeffs () const
 
virtual void manipulateMatrix (fvMatrix< Type > &matrix)
 
virtual void manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)
 
virtual void manipulateMatrix (fvMatrix< Type > &matrix, const label iMatrix, const direction cmp)
 
void check (const fvPatchField< Type > &) const
 
virtual void operator= (const UList< Type > &)
 
virtual void operator= (const fvPatchField< Type > &)
 
virtual void operator= (const Type &)
 
virtual void operator+= (const fvPatchField< Type > &)
 
virtual void operator+= (const Field< Type > &)
 
virtual void operator+= (const Type &)
 
virtual void operator-= (const fvPatchField< Type > &)
 
virtual void operator-= (const Field< Type > &)
 
virtual void operator-= (const Type &)
 
virtual void operator*= (const fvPatchField< scalar > &)
 
virtual void operator*= (const Field< scalar > &)
 
virtual void operator*= (const scalar)
 
virtual void operator/= (const fvPatchField< scalar > &)
 
virtual void operator/= (const Field< scalar > &)
 
virtual void operator/= (const scalar)
 
virtual void operator== (const fvPatchField< Type > &)
 
virtual void operator== (const Field< Type > &)
 
virtual void operator== (const Type &)
 

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 > &)
 
static tmp< fvPatchField< Type > > New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, volMesh > &)
 
static tmp< fvPatchField< Type > > New (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 
static tmp< fvPatchField< Type > > New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 
static tmp< fvPatchField< Type > > NewCalculatedType (const fvPatch &)
 
static tmp< fvPatchField< Type > > NewCalculatedType (const fvPatchField< Type2 > &)
 
static const word & calculatedType ()
 
- Static Public Attributes inherited from fvPatchField< Type >
static int disallowGenericFvPatchField
 

Detailed Description

template<class Type>
class Foam::coupledFvPatchField< Type >

Abstract base class for coupled patches.

Source files

Definition at line 53 of file coupledFvPatchField.H.

Constructor & Destructor Documentation

◆ coupledFvPatchField() [1/6]

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

Definition at line 27 of file coupledFvPatchField.C.

◆ coupledFvPatchField() [2/6]

coupledFvPatchField ( const fvPatch &  p,
const DimensionedField< Type, volMesh > &  iF,
const Field< Type > &  f 
)

Definition at line 39 of file coupledFvPatchField.C.

◆ coupledFvPatchField() [3/6]

coupledFvPatchField ( const fvPatch &  p,
const DimensionedField< Type, volMesh > &  iF,
const dictionary &  dict,
const bool  valueRequired = true 
)

Definition at line 66 of file coupledFvPatchField.C.

◆ coupledFvPatchField() [4/6]

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

Definition at line 52 of file coupledFvPatchField.C.

◆ coupledFvPatchField() [5/6]

coupledFvPatchField ( const coupledFvPatchField< Type > &  ptf)

Definition at line 80 of file coupledFvPatchField.C.

◆ coupledFvPatchField() [6/6]

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

Definition at line 91 of file coupledFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( coupledFvPatch::typeName_()  )

◆ clone() [1/2]

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

Implemented in fanFvPatchField< Type >, fixedJumpFvPatchField< Type >, fixedJumpFvPatchField< scalar >, fixedJumpFvPatchField< vector >, uniformJumpFvPatchField< Type >, uniformJumpAMIFvPatchField< Type >, cyclicAMIFvPatchField< Type >, cyclicAMIFvPatchField< scalar >, fixedJumpAMIFvPatchField< Type >, fixedJumpAMIFvPatchField< scalar >, processorFvPatchField< Type >, cyclicACMIFvPatchField< Type >, cyclicFvPatchField< Type >, cyclicFvPatchField< scalar >, cyclicFvPatchField< vector >, calculatedProcessorFvPatchField< Type >, processorCyclicFvPatchField< Type >, cyclicSlipFvPatchField< Type >, and nonuniformTransformCyclicFvPatchField< Type >.

◆ clone() [2/2]

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

Reimplemented from fvPatchField< Type >.

Implemented in swirlFanVelocityFvPatchField, fixedJumpFvPatchField< vector >, cyclicFvPatchField< vector >, fanFvPatchField< Type >, fixedJumpFvPatchField< Type >, uniformJumpFvPatchField< Type >, uniformJumpAMIFvPatchField< Type >, cyclicAMIFvPatchField< Type >, fixedJumpAMIFvPatchField< Type >, processorFvPatchField< Type >, cyclicACMIFvPatchField< Type >, cyclicFvPatchField< Type >, calculatedProcessorFvPatchField< Type >, processorCyclicFvPatchField< Type >, cyclicSlipFvPatchField< Type >, nonuniformTransformCyclicFvPatchField< Type >, porousBafflePressureFvPatchField< Type >, fixedJumpFvPatchField< scalar >, cyclicAMIFvPatchField< scalar >, fixedJumpAMIFvPatchField< scalar >, cyclicFvPatchField< scalar >, energyJumpFvPatchScalarField, and energyJumpAMIFvPatchScalarField.

◆ coupled()

virtual bool coupled ( ) const
inlinevirtual

Reimplemented in calculatedProcessorFvPatchField< Type >, cyclicAMIFvPatchField< Type >, cyclicAMIFvPatchField< scalar >, cyclicACMIFvPatchField< Type >, and processorFvPatchField< Type >.

Definition at line 129 of file coupledFvPatchField.H.

◆ patchNeighbourField()

virtual tmp<Field<Type> > patchNeighbourField ( ) const
pure virtual

Implemented in calculatedProcessorFvPatchField< Type >, cyclicACMIFvPatchField< Type >, cyclicAMIFvPatchField< Type >, cyclicAMIFvPatchField< scalar >, processorFvPatchField< Type >, cyclicFvPatchField< Type >, cyclicFvPatchField< scalar >, cyclicFvPatchField< vector >, jumpCyclicAMIFvPatchField< Type >, jumpCyclicAMIFvPatchField< scalar >, jumpCyclicFvPatchField< Type >, jumpCyclicFvPatchField< scalar >, and jumpCyclicFvPatchField< vector >.

◆ snGrad() [1/2]

Foam::tmp< Foam::Field< Type > > snGrad ( const scalarField &  deltaCoeffs) const
virtual

Reimplemented from fvPatchField< Type >.

Reimplemented in processorFvPatchField< Type >.

Definition at line 105 of file coupledFvPatchField.C.

◆ snGrad() [2/2]

virtual tmp<Field<Type> > snGrad ( ) const
inlinevirtual

Definition at line 147 of file coupledFvPatchField.H.

◆ initEvaluate()

void initEvaluate ( const Pstream::commsTypes  commsType)
virtual

Reimplemented from fvPatchField< Type >.

Reimplemented in calculatedProcessorFvPatchField< Type >, and processorFvPatchField< Type >.

Definition at line 116 of file coupledFvPatchField.C.

◆ evaluate()

void evaluate ( const Pstream::commsTypes  commsType)
virtual

Reimplemented from fvPatchField< Type >.

Reimplemented in calculatedProcessorFvPatchField< Type >, and processorFvPatchField< Type >.

Definition at line 126 of file coupledFvPatchField.C.

◆ valueInternalCoeffs()

Foam::tmp< Foam::Field< Type > > valueInternalCoeffs ( const tmp< scalarField > &  w) const
virtual

Definition at line 146 of file coupledFvPatchField.C.

◆ valueBoundaryCoeffs()

Foam::tmp< Foam::Field< Type > > valueBoundaryCoeffs ( const tmp< scalarField > &  w) const
virtual

Definition at line 157 of file coupledFvPatchField.C.

◆ gradientInternalCoeffs() [1/2]

Foam::tmp< Foam::Field< Type > > gradientInternalCoeffs ( const scalarField &  deltaCoeffs) const
virtual

Reimplemented from fvPatchField< Type >.

Definition at line 168 of file coupledFvPatchField.C.

◆ gradientInternalCoeffs() [2/2]

Foam::tmp< Foam::Field< Type > > gradientInternalCoeffs
virtual

Definition at line 178 of file coupledFvPatchField.C.

◆ gradientBoundaryCoeffs() [1/2]

Foam::tmp< Foam::Field< Type > > gradientBoundaryCoeffs ( const scalarField &  deltaCoeffs) const
virtual

Reimplemented from fvPatchField< Type >.

Definition at line 188 of file coupledFvPatchField.C.

◆ gradientBoundaryCoeffs() [2/2]

Foam::tmp< Foam::Field< Type > > gradientBoundaryCoeffs
virtual

Definition at line 198 of file coupledFvPatchField.C.

◆ updateInterfaceMatrix() [1/2]

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

Implements lduInterfaceField.

Implemented in jumpCyclicFvPatchField< Type >, jumpCyclicFvPatchField< scalar >, jumpCyclicFvPatchField< vector >, jumpCyclicAMIFvPatchField< Type >, jumpCyclicAMIFvPatchField< scalar >, jumpCyclicFvPatchField< Type >, jumpCyclicFvPatchField< scalar >, jumpCyclicFvPatchField< vector >, calculatedProcessorFvPatchField< Type >, processorFvPatchField< Type >, cyclicACMIFvPatchField< Type >, cyclicAMIFvPatchField< Type >, cyclicAMIFvPatchField< scalar >, cyclicFvPatchField< Type >, cyclicFvPatchField< scalar >, cyclicFvPatchField< vector >, jumpCyclicFvPatchField< Type >, jumpCyclicFvPatchField< scalar >, jumpCyclicFvPatchField< vector >, jumpCyclicAMIFvPatchField< Type >, jumpCyclicAMIFvPatchField< scalar >, jumpCyclicFvPatchField< Type >, jumpCyclicFvPatchField< scalar >, jumpCyclicFvPatchField< vector >, jumpCyclicAMIFvPatchField< Type >, jumpCyclicAMIFvPatchField< scalar >, jumpCyclicFvPatchField< Type >, jumpCyclicFvPatchField< scalar >, and jumpCyclicFvPatchField< vector >.

◆ updateInterfaceMatrix() [2/2]

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

Implements LduInterfaceField< Type >.

Implemented in cyclicFvPatchField< vector >, jumpCyclicFvPatchField< vector >, calculatedProcessorFvPatchField< Type >, processorFvPatchField< Type >, cyclicFvPatchField< Type >, cyclicACMIFvPatchField< Type >, cyclicAMIFvPatchField< Type >, jumpCyclicAMIFvPatchField< Type >, jumpCyclicFvPatchField< Type >, cyclicFvPatchField< scalar >, cyclicAMIFvPatchField< scalar >, jumpCyclicAMIFvPatchField< scalar >, and jumpCyclicFvPatchField< scalar >.

◆ write()

void write ( Ostream &  os) const
virtual

Reimplemented from fvPatchField< Type >.

Reimplemented in swirlFanVelocityFvPatchField, cyclicACMIFvPatchField< Type >, fanFvPatchField< Type >, cyclicAMIFvPatchField< Type >, cyclicAMIFvPatchField< scalar >, cyclicFvPatchField< Type >, cyclicFvPatchField< scalar >, cyclicFvPatchField< vector >, uniformJumpFvPatchField< Type >, porousBafflePressureFvPatchField< Type >, fixedJumpFvPatchField< Type >, fixedJumpFvPatchField< scalar >, fixedJumpFvPatchField< vector >, fixedJumpAMIFvPatchField< Type >, fixedJumpAMIFvPatchField< scalar >, uniformJumpAMIFvPatchField< Type >, energyJumpFvPatchScalarField, and energyJumpAMIFvPatchScalarField.

Definition at line 206 of file coupledFvPatchField.C.

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17