OpenFOAM logo
Open Source CFD Toolkit

coupledFaPatchField Class Template Reference

Inheritance diagram for coupledFaPatchField:

Inheritance graph
[legend]
Collaboration diagram for coupledFaPatchField:

Collaboration graph
[legend]
List of all members.

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


Public Member Functions

 TypeName ("coupled")
 Runtime type information.
 coupledFaPatchField (const faPatch &, const Field< Type > &)
 Construct from patch and internal field.
 coupledFaPatchField (const faPatch &, const Field< Type > &, const Field< Type > &)
 Construct from patch and internal field and patch field.
 coupledFaPatchField (const faPatch &, const Field< Type > &, const dictionary &)
 Construct from patch, internal field and dictionary.
 coupledFaPatchField (const coupledFaPatchField< Type > &, const faPatch &, const Field< Type > &, const faPatchFieldMapper &)
 Construct by mapping the given coupledFaPatchField onto a new patch.
virtual tmp< faPatchField<
Type > > 
clone () const =0
 Construct and return a clone.
 coupledFaPatchField (const coupledFaPatchField< Type > &, const Field< Type > &)
 Construct as copy setting internal field reference.
virtual tmp< faPatchField<
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 void initPatchNeighbourField (const Field< Type > &) const
 Initialise neighbour field transfer of given internal field.
virtual tmp< Field< Type > > patchNeighbourField (const Field< Type > &) const =0
 Return neighbour field given internal field.
virtual tmp< Field< Type > > snGrad () const
 Return patch-normal gradient.
virtual void initPatchNeighbourField () const
 Initialise neighbour field transfer of internal field.
virtual tmp< Field< Type > > patchNeighbourField () const
 Return neighbour field of the internal field.
virtual void initEvaluate (const bool)
 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

coupledFaPatchField const faPatch ,
const Field< Type > & 
 

Construct from patch and internal field.

coupledFaPatchField const faPatch ,
const Field< Type > &  ,
const Field< Type > & 
 

Construct from patch and internal field and patch field.

coupledFaPatchField const faPatch ,
const Field< Type > &  ,
const dictionary
 

Construct from patch, internal field and dictionary.

coupledFaPatchField const coupledFaPatchField< Type > &  ,
const faPatch ,
const Field< Type > &  ,
const faPatchFieldMapper
 

Construct by mapping the given coupledFaPatchField onto a new patch.

coupledFaPatchField const coupledFaPatchField< Type > &  ,
const Field< Type > & 
 

Construct as copy setting internal field reference.


Member Function Documentation

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

Construct and return a clone.

Reimplemented from faPatchField.

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

Construct and return a clone.

Reimplemented from faPatchField.

virtual bool coupled  )  const [inline, virtual]
 

Return true if this patch field is derived from.

coupledFaPatchField<Type>.

Reimplemented from lduCoupledInterface.

Definition at line 126 of file coupledFaPatchField.H.

virtual void evaluate  )  [virtual]
 

Evaluate the patch field.

Reimplemented from faPatchField.

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

Return the matrix source coefficients corresponding to the.

evaluation of the gradient of this patchField

Reimplemented from faPatchField.

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

Return the matrix diagonal coefficients corresponding to the.

evaluation of the gradient of this patchField

Reimplemented from faPatchField.

virtual void initEvaluate const   bool  )  [virtual]
 

Initialise the evaluation of the patch field.

Reimplemented from faPatchField.

virtual void initPatchNeighbourField  )  const [virtual]
 

Initialise neighbour field transfer of internal field.

virtual void initPatchNeighbourField const Field< Type > &   )  const [inline, virtual]
 

Initialise neighbour field transfer of given internal field.

Definition at line 132 of file coupledFaPatchField.H.

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

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

Return neighbour colouring.

Reimplemented from faPatchField.

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

Return neighbour field of the internal field.

Reimplemented from faPatchField.

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

Return neighbour field given internal field.

Reimplemented from faPatchField.

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

Return patch-normal gradient.

Reimplemented from faPatchField.

TypeName "coupled"   ) 
 

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.

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 faPatchField.


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