coupledFaPatchField< Type > Class Template Referenceabstract

Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd. More...

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

Public Member Functions

 TypeName (coupledFaPatch::typeName_())
 Runtime type information. More...
 
 coupledFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &)
 Construct from patch and internal field. More...
 
 coupledFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const Field< Type > &)
 Construct from patch and internal field and patch field. More...
 
 coupledFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 coupledFaPatchField (const coupledFaPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
 Construct by mapping the given coupledFaPatchField onto a new patch. More...
 
 coupledFaPatchField (const coupledFaPatchField< Type > &)
 Construct as copy. More...
 
virtual tmp< faPatchField< Type > > clone () const =0
 Construct and return a clone. More...
 
 coupledFaPatchField (const coupledFaPatchField< Type > &, const DimensionedField< Type, areaMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< faPatchField< Type > > clone (const DimensionedField< Type, areaMesh > &) const =0
 Construct and return a clone. More...
 
virtual bool coupled () const
 Return true if this patch field is derived from. More...
 
virtual tmp< Field< Type > > patchNeighbourField () const =0
 Return neighbour field of internal field. 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
 Return the matrix diagonal coefficients corresponding to the. More...
 
virtual tmp< Field< Type > > gradientBoundaryCoeffs () const
 Return the matrix source coefficients corresponding to the. More...
 
virtual void transformCoupleField (solveScalarField &f, const direction cmpt) const =0
 Transform given patch component field. More...
 
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
 Update result field based on interface functionality. More...
 
virtual void updateInterfaceMatrix (Field< Type > &result, const bool add, const lduAddressing &lduAddr, const label patchId, const Field< Type > &, const scalarField &coeffs, const Pstream::commsTypes commsType) const =0
 Update result field based on interface functionality. More...
 
virtual void write (Ostream &) const
 Write. 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 faPatchField< Type >
 TypeName ("faPatchField")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (tmp, faPatchField, patch,(const faPatch &p, const DimensionedField< Type, areaMesh > &iF),(p, iF))
 
 declareRunTimeSelectionTable (tmp, faPatchField, patchMapper,(const faPatchField< Type > &ptf, const faPatch &p, const DimensionedField< Type, areaMesh > &iF, const faPatchFieldMapper &m),(dynamic_cast< const faPatchFieldType & >(ptf), p, iF, m))
 
 declareRunTimeSelectionTable (tmp, faPatchField, dictionary,(const faPatch &p, const DimensionedField< Type, areaMesh > &iF, const dictionary &dict),(p, iF, dict))
 
 faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &)
 Construct from patch and internal field. More...
 
 faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const Field< Type > &)
 Construct from patch and internal field and patch field. More...
 
 faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 faPatchField (const faPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
 Construct by mapping the given faPatchField onto a new patch. More...
 
 faPatchField (const faPatchField< Type > &)
 Construct as copy. More...
 
 faPatchField (const faPatchField< Type > &, const DimensionedField< Type, areaMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual ~faPatchField ()=default
 Destructor. More...
 
const objectRegistrydb () const
 Return local objectRegistry. More...
 
const faPatchpatch () const
 Return patch. More...
 
const DimensionedField< Type, areaMesh > & 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...
 
virtual bool fixesValue () const
 Return true if this patch field fixes a value. More...
 
bool updated () const
 Return true if the boundary condition has already been updated. More...
 
virtual void autoMap (const faPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object. More...
 
virtual void rmap (const faPatchField< Type > &, const labelList &)
 Reverse map the given faPatchField onto this faPatchField. More...
 
virtual void updateCoeffs ()
 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 tmp< Field< Type > > valueInternalCoeffs (const tmp< Field< scalar >> &) const
 
virtual tmp< Field< Type > > valueBoundaryCoeffs (const tmp< Field< scalar >> &) const
 
void check (const faPatchField< Type > &) const
 Check faPatchField<Type> against given faPatchField<Type> More...
 
virtual void operator= (const UList< Type > &)
 
virtual void operator= (const faPatchField< Type > &)
 
virtual void operator+= (const faPatchField< Type > &)
 
virtual void operator-= (const faPatchField< Type > &)
 
virtual void operator*= (const faPatchField< scalar > &)
 
virtual void operator/= (const faPatchField< 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 faPatchField< Type > &)
 
virtual void operator== (const Field< Type > &)
 
virtual void operator== (const Type &)
 
template<class Type2 >
Foam::tmp< Foam::faPatchField< Type > > NewCalculatedType (const faPatchField< Type2 > &pf)
 

Additional Inherited Members

- Public Types inherited from faPatchField< Type >
typedef faPatch Patch
 
typedef calculatedFaPatchField< Type > Calculated
 
- Static Public Member Functions inherited from faPatchField< Type >
static tmp< faPatchField< Type > > New (const word &patchFieldType, const word &actualPatchType, const faPatch &, const DimensionedField< Type, areaMesh > &)
 
static tmp< faPatchField< Type > > New (const word &patchFieldType, const faPatch &, const DimensionedField< Type, areaMesh > &)
 
static tmp< faPatchField< Type > > New (const faPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
 
static tmp< faPatchField< Type > > New (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)
 
template<class Type2 >
static tmp< faPatchField< Type > > NewCalculatedType (const faPatchField< Type2 > &)
 
static const wordcalculatedType ()
 Return the type of the calculated for of faPatchField. More...
 
- Static Public Attributes inherited from faPatchField< Type >
static int disallowGenericFaPatchField
 Debug switch to disallow the use of. More...
 

Detailed Description

template<class Type>
class Foam::coupledFaPatchField< Type >

Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.

Source files

Definition at line 57 of file coupledFaPatchField.H.

Constructor & Destructor Documentation

◆ coupledFaPatchField() [1/6]

coupledFaPatchField ( const faPatch p,
const DimensionedField< Type, areaMesh > &  iF 
)

Construct from patch and internal field.

Definition at line 34 of file coupledFaPatchField.C.

◆ coupledFaPatchField() [2/6]

coupledFaPatchField ( const faPatch p,
const DimensionedField< Type, areaMesh > &  iF,
const Field< Type > &  f 
)

Construct from patch and internal field and patch field.

Definition at line 46 of file coupledFaPatchField.C.

◆ coupledFaPatchField() [3/6]

coupledFaPatchField ( const faPatch p,
const DimensionedField< Type, areaMesh > &  iF,
const dictionary dict 
)

Construct from patch, internal field and dictionary.

Definition at line 73 of file coupledFaPatchField.C.

◆ coupledFaPatchField() [4/6]

coupledFaPatchField ( const coupledFaPatchField< Type > &  ptf,
const faPatch p,
const DimensionedField< Type, areaMesh > &  iF,
const faPatchFieldMapper mapper 
)

Construct by mapping the given coupledFaPatchField onto a new patch.

Definition at line 59 of file coupledFaPatchField.C.

◆ coupledFaPatchField() [5/6]

coupledFaPatchField ( const coupledFaPatchField< Type > &  ptf)

Construct as copy.

Definition at line 86 of file coupledFaPatchField.C.

◆ coupledFaPatchField() [6/6]

coupledFaPatchField ( const coupledFaPatchField< Type > &  ptf,
const DimensionedField< Type, areaMesh > &  iF 
)

Construct as copy setting internal field reference.

Definition at line 97 of file coupledFaPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( coupledFaPatch::typeName_()  )

Runtime type information.

◆ clone() [1/2]

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

Construct and return a clone.

Reimplemented from faPatchField< Type >.

Implemented in cyclicFaPatchField< Type >, and processorFaPatchField< Type >.

◆ clone() [2/2]

virtual tmp<faPatchField<Type> > clone ( const DimensionedField< Type, areaMesh > &  ) const
pure virtual

Construct and return a clone.

Reimplemented from faPatchField< Type >.

Implemented in cyclicFaPatchField< Type >, and processorFaPatchField< Type >.

◆ coupled()

virtual bool coupled ( ) const
inlinevirtual

Return true if this patch field is derived from.

coupledFaPatchField<Type>.

Reimplemented from faPatchField< Type >.

Reimplemented in processorFaPatchField< Type >.

Definition at line 132 of file coupledFaPatchField.H.

◆ patchNeighbourField()

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

Return neighbour field of internal field.

Reimplemented from faPatchField< Type >.

Implemented in processorFaPatchField< Type >, and cyclicFaPatchField< Type >.

◆ snGrad()

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

Return patch-normal gradient.

Reimplemented from faPatchField< Type >.

Reimplemented in processorFaPatchField< Type >.

Definition at line 110 of file coupledFaPatchField.C.

References Foam::foamVersion::patch.

◆ initEvaluate()

void initEvaluate ( const Pstream::commsTypes  commsType)
virtual

Initialise the evaluation of the patch field.

Reimplemented from faPatchField< Type >.

Reimplemented in processorFaPatchField< Type >.

Definition at line 119 of file coupledFaPatchField.C.

◆ evaluate()

void evaluate ( const Pstream::commsTypes  commsType)
virtual

Evaluate the patch field.

Reimplemented from faPatchField< Type >.

Reimplemented in processorFaPatchField< Type >.

Definition at line 129 of file coupledFaPatchField.C.

References Foam::foamVersion::patch.

◆ valueInternalCoeffs()

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

Return the matrix diagonal coefficients corresponding to the.

evaluation of the value of this patchField with given weights

Definition at line 142 of file coupledFaPatchField.C.

◆ valueBoundaryCoeffs()

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

Return the matrix source coefficients corresponding to the.

evaluation of the value of this patchField with given weights

Definition at line 153 of file coupledFaPatchField.C.

◆ gradientInternalCoeffs()

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

Return the matrix diagonal coefficients corresponding to the.

evaluation of the gradient of this patchField

Reimplemented from faPatchField< Type >.

Definition at line 163 of file coupledFaPatchField.C.

References Foam::foamVersion::patch.

◆ gradientBoundaryCoeffs()

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

Return the matrix source coefficients corresponding to the.

evaluation of the gradient of this patchField

Reimplemented from faPatchField< Type >.

Definition at line 171 of file coupledFaPatchField.C.

◆ transformCoupleField()

virtual void transformCoupleField ( solveScalarField f,
const direction  cmpt 
) const
pure virtual

◆ 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

Update result field based on interface functionality.

Implements lduInterfaceField.

Implemented in processorFaPatchField< Type >, cyclicFaPatchField< Type >, processorFaPatchField< Type >, and processorFaPatchField< Type >.

◆ updateInterfaceMatrix() [2/2]

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

Update result field based on interface functionality.

Implemented in processorFaPatchField< Type >, and cyclicFaPatchField< Type >.

◆ write()

void write ( Ostream os) const
virtual

Write.

Reimplemented from faPatchField< Type >.

Definition at line 178 of file coupledFaPatchField.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: