OpenFOAM logo
Open Source CFD Toolkit

faPatchField Class Template Reference

Inheritance diagram for faPatchField:

Inheritance graph
[legend]
Collaboration diagram for faPatchField:

Collaboration graph
[legend]
List of all members.

template<class Type>
class Foam::faPatchField< Type >


Public Types

typedef faPatch Patch

Public Member Functions

 TypeName ("faPatchField")
 Runtime type information.
 declareRunTimeSelectionTable (tmp, faPatchField, patch,(const faPatch &p, const Field< Type > &iF),(p, iF))
 declareRunTimeSelectionTable (tmp, faPatchField, patchMapper,(const faPatchField< Type > &ptf, const faPatch &p, const Field< Type > &iF, const faPatchFieldMapper &m),(dynamic_cast< const faPatchFieldType & >(ptf), p, iF, m))
 declareRunTimeSelectionTable (tmp, faPatchField, dictionary,(const faPatch &p, const Field< Type > &iF, const dictionary &dict),(p, iF, dict))
 faPatchField (const faPatch &, const Field< Type > &)
 Construct from patch and internal field.
 faPatchField (const faPatch &, const Field< Type > &, const Field< Type > &)
 Construct from patch and internal field and patch field.
 faPatchField (const faPatch &, const Field< Type > &, const dictionary &)
 Construct from patch, internal field and dictionary.
 faPatchField (const faPatchField< Type > &, const faPatch &, const Field< Type > &, const faPatchFieldMapper &)
 Construct by mapping the given faPatchField onto a new patch.
 faPatchField (const faPatchField< Type > &)
 Construct as copy.
virtual tmp< faPatchField<
Type > > 
clone () const
 Construct and return a clone.
 faPatchField (const faPatchField< Type > &, const Field< Type > &)
 Construct as copy setting internal field reference.
virtual tmp< faPatchField<
Type > > 
clone (const Field< Type > &iF) const
 Construct and return a clone setting internal field reference.
virtual ~faPatchField ()
const objectRegistrydb () const
 Return database.
const faPatchpatch () const
 Return patch.
const Field< Type > & internalField () const
 Return internal field reference.
virtual bool fixesValue () const
 Return true if this patch field fixes a value.
bool updated () const
 Return true if the boundary condition has already been updated.
bool areaPatchField () const
 Does this patchField correspond to a areaTypeField.
void checkAreaField () const
 Check that this patchField corresponds to a areaTypeField,.
template<class GeometricField, class Type2>
const faPatchField< Type2 > & patchField (const GeometricField &) const
 Return the corresponding patchField of the named field.
template<class GeometricField, class Type2>
const faPatchField< Type2 > & lookupPatchField (const word &name, const GeometricField *=NULL, const Type2 *=NULL) const
 Lookup and return the patchField of the named field from the DB.
virtual void rmap (const faPatchField< Type > &, const labelList &)
 Reverse map the given faPatchField onto this faPatchField.
virtual tmp< Field< Type > > snGrad () const
 Return patch-normal gradient.
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field.
template<class Type2>
tmp< Field< Type2 > > patchInternalField (const Field< Type2 > &) const
 Return given internal field next to patch as patch field.
virtual tmp< Field< Type > > patchInternalField () const
 Return internal field next to patch as patch field.
virtual tmp< Field< Type > > patchNeighbourField (const Field< Type > &iField) const
 Return neighbour coupled given internal cell data.
virtual tmp< labelFieldnbrColour (const labelField &iColour) const
 Return neighbour colouring.
virtual tmp< Field< Type > > patchNeighbourField () const
 Return patchField of the values on the patch or on the.
virtual void initEvaluate (const bool)
 Initialise the evaluation of the patch field.
virtual void evaluate ()
 Evaluate the patch field, sets Updated to false.
virtual tmp< Field< Type > > valueInternalCoeffs (const tmp< Field< scalar > > &) const
 Return the matrix diagonal coefficients corresponding to the.
virtual tmp< Field< Type > > valueBoundaryCoeffs (const tmp< Field< scalar > > &) 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 void write (Ostream &) const
 Write.
void check (const faPatchField< Type > &) const
 Check faPatchField<Type> against given faPatchField<Type>.
virtual void operator= (const UList< Type > &)
 Assignment from UList operator. Takes linear time.
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 &)
 Assignment of all entries to the given value.
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 &)

Static Public Member Functions

tmp< faPatchField< Type > > New (const word &, const faPatch &, const Field< Type > &)
 Return a pointer to a new patchField created on freestore given.
tmp< faPatchField< Type > > New (const faPatchField< Type > &, const faPatch &, const Field< Type > &, const faPatchFieldMapper &)
 Return a pointer to a new patchField created on freestore from.
tmp< faPatchField< Type > > New (const faPatch &, const Field< Type > &, const dictionary &)
 Return a pointer to a new patchField created on freestore.
template<class Type2>
tmp< calculatedFaPatchField<
Type > > 
NewCalculatedType (const faPatchField< Type2 > &)
 Return a pointer to a new calculatedFaPatchField created on.
const wordcalculatedType ()
 Return the type of the calculated for of faPatchField.

Friends

Ostreamoperator (Ostream &, const faPatchField< Type > &)

Member Typedef Documentation

typedef faPatch Patch
 

Definition at line 107 of file faPatchField.H.


Constructor & Destructor Documentation

faPatchField const faPatch ,
const Field< Type > & 
 

Construct from patch and internal field.

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

Construct from patch and internal field and patch field.

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

Construct from patch, internal field and dictionary.

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

Construct by mapping the given faPatchField onto a new patch.

faPatchField const faPatchField< Type > &   ) 
 

Construct as copy.

faPatchField const faPatchField< Type > &  ,
const Field< Type > & 
 

Construct as copy setting internal field reference.

virtual ~faPatchField  )  [inline, virtual]
 


Member Function Documentation

bool areaPatchField  )  const
 

Does this patchField correspond to a areaTypeField.

const word& calculatedType  )  [static]
 

Return the type of the calculated for of faPatchField.

void check const faPatchField< Type > &   )  const
 

Check faPatchField<Type> against given faPatchField<Type>.

void checkAreaField  )  const
 

Check that this patchField corresponds to a areaTypeField,.

if not abort!

virtual tmp<faPatchField<Type> > clone const Field< Type > &  iF  )  const [inline, virtual]
 

Construct and return a clone setting internal field reference.

Reimplemented in calculatedFaPatchField, coupledFaPatchField, emptyFaPatchField, fixedGradientFaPatchField, fixedValueFaPatchField, zeroGradientFaPatchField, and fixedValueOutflowFaPatchField.

Definition at line 196 of file faPatchField.H.

virtual tmp<faPatchField<Type> > clone  )  const [inline, virtual]
 

Construct and return a clone.

Reimplemented from Field.

Reimplemented in calculatedFaPatchField, coupledFaPatchField, emptyFaPatchField, fixedGradientFaPatchField, fixedValueFaPatchField, zeroGradientFaPatchField, and fixedValueOutflowFaPatchField.

Definition at line 187 of file faPatchField.H.

const objectRegistry& db  )  const
 

Return database.

declareRunTimeSelectionTable tmp  ,
faPatchField< Type >  ,
dictionary  ,
(const faPatch &p, const Field< Type > &iF, const dictionary &dict)  ,
(p, iF, dict) 
 

declareRunTimeSelectionTable tmp  ,
faPatchField< Type >  ,
patchMapper  ,
(const faPatchField< Type > &ptf, const faPatch &p, const Field< Type > &iF, const faPatchFieldMapper &m)  ,
(dynamic_cast< const faPatchFieldType & >(ptf), p, iF, m) 
 

declareRunTimeSelectionTable tmp  ,
faPatchField< Type >  ,
patch  ,
(const faPatch &p, const Field< Type > &iF)  ,
(p, iF) 
 

virtual void evaluate  )  [virtual]
 

Evaluate the patch field, sets Updated to false.

Reimplemented in coupledFaPatchField, fixedGradientFaPatchField, and zeroGradientFaPatchField.

virtual bool fixesValue  )  const [inline, virtual]
 

Return true if this patch field fixes a value.

Needed to check if a level has to be specified while solving Poissons equations.

Reimplemented in calculatedFaPatchField, fixedValueFaPatchField, and fixedValueOutflowFaPatchField.

Definition at line 283 of file faPatchField.H.

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

Return the matrix source coefficients corresponding to the.

evaluation of the gradient of this patchField

Reimplemented in calculatedFaPatchField, coupledFaPatchField, emptyFaPatchField, fixedGradientFaPatchField, fixedValueFaPatchField, zeroGradientFaPatchField, and fixedValueOutflowFaPatchField.

Definition at line 428 of file faPatchField.H.

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

Return the matrix diagonal coefficients corresponding to the.

evaluation of the gradient of this patchField

Reimplemented in calculatedFaPatchField, coupledFaPatchField, emptyFaPatchField, fixedGradientFaPatchField, fixedValueFaPatchField, zeroGradientFaPatchField, and fixedValueOutflowFaPatchField.

Definition at line 418 of file faPatchField.H.

virtual void initEvaluate const   bool  )  [inline, virtual]
 

Initialise the evaluation of the patch field.

Reimplemented in coupledFaPatchField.

Definition at line 373 of file faPatchField.H.

References notImplemented, and Foam::type().

Here is the call graph for this function:

const Field<Type>& internalField  )  const [inline]
 

Return internal field reference.

Definition at line 270 of file faPatchField.H.

const faPatchField<Type2>& lookupPatchField const word name,
const GeometricField = NULL,
const Type2 *  = NULL
const
 

Lookup and return the patchField of the named field from the DB.

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

Return neighbour colouring.

Needed for AMG solver agglomeration

Implements lduCoupledInterface.

Reimplemented in coupledFaPatchField.

tmp<faPatchField<Type> > New const faPatch ,
const Field< Type > &  ,
const dictionary
[static]
 

Return a pointer to a new patchField created on freestore.

from dictionary

tmp<faPatchField<Type> > New const faPatchField< Type > &  ,
const faPatch ,
const Field< Type > &  ,
const faPatchFieldMapper
[static]
 

Return a pointer to a new patchField created on freestore from.

a given faPatchField mapped onto a new patch

tmp<faPatchField<Type> > New const word ,
const faPatch ,
const Field< Type > & 
[static]
 

Return a pointer to a new patchField created on freestore given.

patch and internal field (does not set the patch field values)

tmp<calculatedFaPatchField<Type> > NewCalculatedType const faPatchField< Type2 > &   )  [static]
 

Return a pointer to a new calculatedFaPatchField created on.

freestore without setting patchField values

virtual void operator *= const   scalar  )  [virtual]
 

Reimplemented in fixedGradientFaPatchField, fixedValueFaPatchField, and fixedValueOutflowFaPatchField.

virtual void operator *= const Field< scalar > &   )  [virtual]
 

Reimplemented in fixedGradientFaPatchField, fixedValueFaPatchField, and fixedValueOutflowFaPatchField.

virtual void operator *= const faPatchField< scalar > &   )  [virtual]
 

Reimplemented in fixedGradientFaPatchField, fixedValueFaPatchField, and fixedValueOutflowFaPatchField.

virtual void operator+= const Type &   )  [virtual]
 

Reimplemented from Field.

Reimplemented in fixedGradientFaPatchField, fixedValueFaPatchField, and fixedValueOutflowFaPatchField.

virtual void operator+= const Field< Type > &   )  [virtual]
 

Reimplemented in fixedGradientFaPatchField, fixedValueFaPatchField, and fixedValueOutflowFaPatchField.

virtual void operator+= const faPatchField< Type > &   )  [virtual]
 

Reimplemented in fixedGradientFaPatchField, fixedValueFaPatchField, and fixedValueOutflowFaPatchField.

virtual void operator-= const Type &   )  [virtual]
 

Reimplemented from Field.

Reimplemented in fixedGradientFaPatchField, fixedValueFaPatchField, and fixedValueOutflowFaPatchField.

virtual void operator-= const Field< Type > &   )  [virtual]
 

Reimplemented in fixedGradientFaPatchField, fixedValueFaPatchField, and fixedValueOutflowFaPatchField.

virtual void operator-= const faPatchField< Type > &   )  [virtual]
 

Reimplemented in fixedGradientFaPatchField, fixedValueFaPatchField, and fixedValueOutflowFaPatchField.

virtual void operator/= const   scalar  )  [virtual]
 

Reimplemented in fixedGradientFaPatchField, fixedValueFaPatchField, and fixedValueOutflowFaPatchField.

virtual void operator/= const Field< scalar > &   )  [virtual]
 

Reimplemented in fixedGradientFaPatchField, fixedValueFaPatchField, and fixedValueOutflowFaPatchField.

virtual void operator/= const faPatchField< scalar > &   )  [virtual]
 

Reimplemented in fixedGradientFaPatchField, fixedValueFaPatchField, and fixedValueOutflowFaPatchField.

virtual void operator= const Type &   )  [virtual]
 

Assignment of all entries to the given value.

Reimplemented from Field.

Reimplemented in fixedGradientFaPatchField, fixedValueFaPatchField, and fixedValueOutflowFaPatchField.

virtual void operator= const faPatchField< Type > &   )  [virtual]
 

Reimplemented in fixedGradientFaPatchField, fixedValueFaPatchField, and fixedValueOutflowFaPatchField.

virtual void operator= const UList< Type > &   )  [virtual]
 

Assignment from UList operator. Takes linear time.

Reimplemented from Field.

Reimplemented in fixedGradientFaPatchField, fixedValueFaPatchField, and fixedValueOutflowFaPatchField.

virtual void operator== const Type &   )  [virtual]
 

virtual void operator== const Field< Type > &   )  [virtual]
 

virtual void operator== const faPatchField< Type > &   )  [virtual]
 

const faPatch& patch  )  const [inline]
 

Return patch.

Definition at line 264 of file faPatchField.H.

const faPatchField<Type2>& patchField const GeometricField  )  const
 

Return the corresponding patchField of the named field.

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

Return internal field next to patch as patch field.

tmp<Field<Type2> > patchInternalField const Field< Type2 > &   )  const
 

Return given internal field next to patch as patch field.

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

Return patchField of the values on the patch or on the.

opposite patch

Reimplemented in coupledFaPatchField.

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

Return neighbour coupled given internal cell data.

Reimplemented in coupledFaPatchField.

virtual void rmap const faPatchField< Type > &  ,
const labelList
[virtual]
 

Reverse map the given faPatchField onto this faPatchField.

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

Return patch-normal gradient.

Reimplemented in coupledFaPatchField, fixedGradientFaPatchField, and zeroGradientFaPatchField.

TypeName "faPatchField< Type >"   ) 
 

Runtime type information.

virtual void updateCoeffs  )  [inline, virtual]
 

Update the coefficients associated with the patch field.

Sets Updated to true

Definition at line 336 of file faPatchField.H.

References Foam::labelField.

bool updated  )  const [inline]
 

Return true if the boundary condition has already been updated.

Definition at line 289 of file faPatchField.H.

References Foam::labelList.

virtual tmp<Field<Type> > valueBoundaryCoeffs const tmp< Field< scalar > > &   )  const [inline, virtual]
 

Return the matrix source coefficients corresponding to the.

evaluation of the value of this patchField with given weights

Definition at line 402 of file faPatchField.H.

virtual tmp<Field<Type> > valueInternalCoeffs const tmp< Field< scalar > > &   )  const [inline, virtual]
 

Return the matrix diagonal coefficients corresponding to the.

evaluation of the value of this patchField with given weights

Definition at line 385 of file faPatchField.H.

References notImplemented, and Foam::type().

Here is the call graph for this function:

virtual void write Ostream  )  const [virtual]
 

Write.

Reimplemented in calculatedFaPatchField, coupledFaPatchField, fixedGradientFaPatchField, fixedValueFaPatchField, and fixedValueOutflowFaPatchField.


Friends And Related Function Documentation

Ostream& operator Ostream ,
const faPatchField< Type > & 
[friend]
 


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