OpenFOAM logo
Open Source CFD Toolkit

coupledFvPatchField Class Template Reference

Inheritance diagram for coupledFvPatchField:

Inheritance graph
[legend]
Collaboration diagram for coupledFvPatchField:

Collaboration graph
[legend]
List of all members.

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


Public Member Functions

 TypeName (coupledFvPatch::typeName_())
 Runtime type information.
 coupledFvPatchField (const fvPatch &, const Field< Type > &)
 Construct from patch and internal field.
 coupledFvPatchField (const fvPatch &, const Field< Type > &, const Field< Type > &)
 Construct from patch and internal field and patch field.
 coupledFvPatchField (const fvPatch &, const Field< Type > &, const dictionary &)
 Construct from patch, internal field and dictionary.
 coupledFvPatchField (const coupledFvPatchField< Type > &, const fvPatch &, const Field< Type > &, const fvPatchFieldMapper &)
 Construct by mapping the given coupledFvPatchField onto a new patch.
virtual tmp< fvPatchField<
Type > > 
clone () const =0
 Construct and return a clone.
 coupledFvPatchField (const coupledFvPatchField< Type > &, const Field< Type > &)
 Construct as copy setting internal field reference.
virtual tmp< fvPatchField<
Type > > 
clone (const Field< Type > &) const =0
 Construct and return a clone.
virtual bool coupled () const
 Return true if this patch field is derived from.
virtual tmp< Field< Type > > patchNeighbourField () const =0
 Return neighbour field given internal field.
virtual tmp< Field< Type > > snGrad () const
 Return patch-normal gradient.
virtual void initEvaluate (const bool bufferdTransfer)
 Initialise the evaluation of the patch field.
virtual void evaluate ()
 Evaluate the patch field.
virtual tmp< Field< Type > > valueInternalCoeffs (const tmp< scalarField > &) const
 Return the matrix diagonal coefficients corresponding to the.
virtual tmp< Field< Type > > valueBoundaryCoeffs (const tmp< scalarField > &) const
 Return the matrix source coefficients corresponding to the.
virtual tmp< Field< Type > > gradientInternalCoeffs () const
 Return the matrix diagonal coefficients corresponding to the.
virtual tmp< Field< Type > > gradientBoundaryCoeffs () const
 Return the matrix source coefficients corresponding to the.
virtual tmp< labelFieldnbrColour (const labelField &) const =0
 Return neighbour colouring.
virtual void updateInterfaceMatrix (const scalarField &psiInternal, scalarField &result, const lduMatrix &, const scalarField &coeffs, const direction) const =0
 Update result field based on interface functionality.
virtual void write (Ostream &) const
 Write.

Constructor & Destructor Documentation

coupledFvPatchField const fvPatch ,
const Field< Type > & 
 

Construct from patch and internal field.

coupledFvPatchField const fvPatch ,
const Field< Type > &  ,
const Field< Type > & 
 

Construct from patch and internal field and patch field.

coupledFvPatchField const fvPatch ,
const Field< Type > &  ,
const dictionary
 

Construct from patch, internal field and dictionary.

coupledFvPatchField const coupledFvPatchField< Type > &  ,
const fvPatch ,
const Field< Type > &  ,
const fvPatchFieldMapper
 

Construct by mapping the given coupledFvPatchField onto a new patch.

coupledFvPatchField const coupledFvPatchField< Type > &  ,
const Field< Type > & 
 

Construct as copy setting internal field reference.


Member Function Documentation

virtual tmp<fvPatchField<Type> > clone const Field< Type > &   )  const [pure virtual]
 

Construct and return a clone.

Reimplemented from fvPatchField.

Implemented in cyclicFvPatchField, and processorFvPatchField.

virtual tmp<fvPatchField<Type> > clone  )  const [pure virtual]
 

Construct and return a clone.

Reimplemented from fvPatchField.

Implemented in cyclicFvPatchField, and processorFvPatchField.

virtual bool coupled  )  const [inline, virtual]
 

Return true if this patch field is derived from.

coupledFvPatchField<Type>.

Reimplemented from lduCoupledInterface.

Reimplemented in processorFvPatchField.

Definition at line 125 of file coupledFvPatchField.H.

References Foam::direction, Foam::labelField, and Foam::scalarField.

virtual void evaluate  )  [virtual]
 

Evaluate the patch field.

Reimplemented from fvPatchField.

Reimplemented in processorFvPatchField.

virtual tmp<Field<Type> > gradientBoundaryCoeffs  )  const [virtual]
 

Return the matrix source coefficients corresponding to the.

evaluation of the gradient of this patchField

Reimplemented from fvPatchField.

virtual tmp<Field<Type> > gradientInternalCoeffs  )  const [virtual]
 

Return the matrix diagonal coefficients corresponding to the.

evaluation of the gradient of this patchField

Reimplemented from fvPatchField.

virtual void initEvaluate const bool  bufferdTransfer  )  [virtual]
 

Initialise the evaluation of the patch field.

Reimplemented in processorFvPatchField.

virtual tmp<labelField> nbrColour const labelField  )  const [pure virtual]
 

Return neighbour colouring.

Reimplemented from fvPatchField.

Implemented in cyclicFvPatchField, and processorFvPatchField.

virtual tmp<Field<Type> > patchNeighbourField  )  const [pure virtual]
 

Return neighbour field given internal field.

Reimplemented from fvPatchField.

Implemented in cyclicFvPatchField, and processorFvPatchField.

virtual tmp<Field<Type> > snGrad  )  const [virtual]
 

Return patch-normal gradient.

Reimplemented from fvPatchField.

TypeName coupledFvPatch::  typeName_()  ) 
 

Runtime type information.

virtual void updateInterfaceMatrix const scalarField psiInternal,
scalarField result,
const lduMatrix ,
const scalarField coeffs,
const   direction
const [pure virtual]
 

Update result field based on interface functionality.

Reimplemented from lduCoupledInterface.

Implemented in processorFvPatchField.

virtual tmp<Field<Type> > valueBoundaryCoeffs const tmp< scalarField > &   )  const [virtual]
 

Return the matrix source coefficients corresponding to the.

evaluation of the value of this patchField with given weights

virtual tmp<Field<Type> > valueInternalCoeffs const tmp< scalarField > &   )  const [virtual]
 

Return the matrix diagonal coefficients corresponding to the.

evaluation of the value of this patchField with given weights

virtual void write Ostream  )  const [virtual]
 

Write.

Reimplemented from fvPatchField.


The documentation for this class was generated from the following file:
For further information go to www.openfoam.org