OpenFOAM logo
Open Source CFD Toolkit

fvPatchField Class Template Reference

Inheritance diagram for fvPatchField:

Inheritance graph
[legend]
Collaboration diagram for fvPatchField:

Collaboration graph
[legend]
List of all members.

template<class Type>
class Foam::fvPatchField< Type >


Public Types

typedef fvPatch Patch

Public Member Functions

 TypeName ("fvPatchField")
 Runtime type information.
 declareRunTimeSelectionTable (tmp, fvPatchField, patch,(const fvPatch &p, const Field< Type > &iF),(p, iF))
 declareRunTimeSelectionTable (tmp, fvPatchField, patchMapper,(const fvPatchField< Type > &ptf, const fvPatch &p, const Field< Type > &iF, const fvPatchFieldMapper &m),(dynamic_cast< const fvPatchFieldType & >(ptf), p, iF, m))
 declareRunTimeSelectionTable (tmp, fvPatchField, dictionary,(const fvPatch &p, const Field< Type > &iF, const dictionary &dict),(p, iF, dict))
 fvPatchField (const fvPatch &, const Field< Type > &)
 Construct from patch and internal field.
 fvPatchField (const fvPatch &, const Field< Type > &, const Field< Type > &)
 Construct from patch and internal field and patch field.
 fvPatchField (const fvPatch &, const Field< Type > &, const dictionary &)
 Construct from patch, internal field and dictionary.
 fvPatchField (const fvPatchField< Type > &, const fvPatch &, const Field< Type > &, const fvPatchFieldMapper &)
 Construct by mapping the given fvPatchField onto a new patch.
 fvPatchField (const fvPatchField< Type > &)
 Construct as copy.
virtual tmp< fvPatchField<
Type > > 
clone () const
 Construct and return a clone.
 fvPatchField (const fvPatchField< Type > &, const Field< Type > &)
 Construct as copy setting internal field reference.
virtual tmp< fvPatchField<
Type > > 
clone (const Field< Type > &iF) const
 Construct and return a clone setting internal field reference.
virtual ~fvPatchField ()
const objectRegistrydb () const
 Return local objectRegistry.
const fvPatchpatch () 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 isVolField () const
 Does this patchField correspond to a volTypeField.
void checkVolField () const
 Check that this patchField corresponds to a volTypeField,.
template<class GeometricField, class Type2>
const fvPatchField< Type2 > & patchField (const GeometricField &) const
 Return the corresponding patchField of the named field.
template<class GeometricField, class Type2>
const fvPatchField< Type2 > & lookupPatchField (const word &name, const GeometricField *=NULL, const Type2 *=NULL) const
 Lookup and return the patchField of the named field from the.
virtual void autoMap (const fvPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object.
virtual void rmap (const fvPatchField< Type > &, const labelList &)
 Reverse map the given fvPatchField onto this fvPatchField.
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=false)
 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 fvPatchField< Type > &) const
 Check fvPatchField<Type> against given fvPatchField<Type>.
virtual void operator= (const UList< Type > &)
 Assignment from UList operator. Takes linear time.
virtual void operator= (const fvPatchField< Type > &)
virtual void operator+= (const fvPatchField< Type > &)
virtual void operator-= (const fvPatchField< Type > &)
virtual void operator *= (const fvPatchField< scalar > &)
virtual void operator/= (const fvPatchField< 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 fvPatchField< Type > &)
virtual void operator== (const Field< Type > &)
virtual void operator== (const Type &)

Static Public Member Functions

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

Static Public Attributes

int disallowDefaultFvPatchField
 Debug switch to disallow the use of.

Friends

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

Member Typedef Documentation

typedef fvPatch Patch
 

Definition at line 105 of file fvPatchField.H.


Constructor & Destructor Documentation

fvPatchField const fvPatch ,
const Field< Type > & 
 

Construct from patch and internal field.

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

Construct from patch and internal field and patch field.

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

Construct from patch, internal field and dictionary.

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

Construct by mapping the given fvPatchField onto a new patch.

fvPatchField const fvPatchField< Type > &   ) 
 

Construct as copy.

fvPatchField const fvPatchField< Type > &  ,
const Field< Type > & 
 

Construct as copy setting internal field reference.

virtual ~fvPatchField  )  [inline, virtual]
 


Member Function Documentation

virtual void autoMap const fvPatchFieldMapper  )  [virtual]
 

Map (and resize as needed) from self given a mapping object.

Reimplemented in emptyFvPatchField, fixedGradientFvPatchField, mixedFvPatchField, directionMixedFvPatchField, expDirectionMixedFvPatchField, oscillatingFixedValueFvPatchField, partialSlipFvPatchField, turbulentInletFvPatchField, and uniformFixedValueFvPatchField.

const word& calculatedType  )  [static]
 

Return the type of the calculated for of fvPatchField.

void check const fvPatchField< Type > &   )  const
 

Check fvPatchField<Type> against given fvPatchField<Type>.

void checkVolField  )  const
 

Check that this patchField corresponds to a volTypeField,.

if not abort!

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

Construct and return a clone setting internal field reference.

Reimplemented in basicSymmetryFvPatchField, calculatedFvPatchField, coupledFvPatchField, defaultFvPatchField, emptyFvPatchField, fixedGradientFvPatchField, fixedValueFvPatchField, mixedFvPatchField, slicedFvPatchField, transformFvPatchField, zeroGradientFvPatchField, cyclicFvPatchField, directionMixedFvPatchField, expDirectionMixedFvPatchField, freestreamFvPatchField, inletOutletFvPatchField, oscillatingFixedValueFvPatchField, outletInletFvPatchField, partialSlipFvPatchField, processorFvPatchField, slipFvPatchField, symmetryFvPatchField, timeVaryingUniformFixedValueFvPatchField, turbulentInletFvPatchField, uniformFixedValueFvPatchField, and wedgeFvPatchField.

Definition at line 197 of file fvPatchField.H.

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

Construct and return a clone.

Reimplemented from Field.

Reimplemented in basicSymmetryFvPatchField, calculatedFvPatchField, coupledFvPatchField, defaultFvPatchField, emptyFvPatchField, fixedGradientFvPatchField, fixedValueFvPatchField, mixedFvPatchField, slicedFvPatchField, transformFvPatchField, zeroGradientFvPatchField, cyclicFvPatchField, directionMixedFvPatchField, expDirectionMixedFvPatchField, freestreamFvPatchField, inletOutletFvPatchField, oscillatingFixedValueFvPatchField, outletInletFvPatchField, partialSlipFvPatchField, processorFvPatchField, slipFvPatchField, symmetryFvPatchField, timeVaryingUniformFixedValueFvPatchField, turbulentInletFvPatchField, uniformFixedValueFvPatchField, and wedgeFvPatchField.

Definition at line 188 of file fvPatchField.H.

const objectRegistry& db  )  const
 

Return local objectRegistry.

declareRunTimeSelectionTable tmp  ,
fvPatchField< Type >  ,
dictionary  ,
(const fvPatch &p, const Field< Type > &iF, const dictionary &dict)  ,
(p, iF, dict) 
 

declareRunTimeSelectionTable tmp  ,
fvPatchField< Type >  ,
patchMapper  ,
(const fvPatchField< Type > &ptf, const fvPatch &p, const Field< Type > &iF, const fvPatchFieldMapper &m)  ,
(dynamic_cast< const fvPatchFieldType & >(ptf), p, iF, m) 
 

declareRunTimeSelectionTable tmp  ,
fvPatchField< Type >  ,
patch  ,
(const fvPatch &p, const Field< Type > &iF)  ,
(p, iF) 
 

virtual void evaluate  )  [virtual]
 

Evaluate the patch field, sets Updated to false.

Reimplemented in basicSymmetryFvPatchField, coupledFvPatchField, fixedGradientFvPatchField, mixedFvPatchField, slicedFvPatchField, zeroGradientFvPatchField, directionMixedFvPatchField, expDirectionMixedFvPatchField, partialSlipFvPatchField, processorFvPatchField, wedgeFvPatchField, basicSymmetryFvPatchField, and wedgeFvPatchField.

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 calculatedFvPatchField, fixedValueFvPatchField, mixedFvPatchField, slicedFvPatchField, and directionMixedFvPatchField.

Definition at line 284 of file fvPatchField.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 calculatedFvPatchField, coupledFvPatchField, defaultFvPatchField, emptyFvPatchField, fixedGradientFvPatchField, fixedValueFvPatchField, mixedFvPatchField, slicedFvPatchField, transformFvPatchField, zeroGradientFvPatchField, and expDirectionMixedFvPatchField.

Definition at line 441 of file fvPatchField.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 calculatedFvPatchField, coupledFvPatchField, defaultFvPatchField, emptyFvPatchField, fixedGradientFvPatchField, fixedValueFvPatchField, mixedFvPatchField, slicedFvPatchField, transformFvPatchField, zeroGradientFvPatchField, expDirectionMixedFvPatchField, and transformFvPatchField.

Definition at line 431 of file fvPatchField.H.

virtual void initEvaluate const   bool = false  )  [inline, virtual]
 

Initialise the evaluation of the patch field.

Reimplemented in slicedFvPatchField.

Definition at line 386 of file fvPatchField.H.

References notImplemented.

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

Return internal field reference.

Definition at line 271 of file fvPatchField.H.

bool isVolField  )  const
 

Does this patchField correspond to a volTypeField.

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

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

local objectRegistry. N.B. The dummy pointer arguments are used if this function is instantiated within a templated function to avoid a bug in gcc. See inletOutletFvPatchField.C and outletInletFvPatchField.C

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

Return neighbour colouring.

Needed for AMG solver agglomeration

Implements lduCoupledInterface.

Reimplemented in coupledFvPatchField, slicedFvPatchField, cyclicFvPatchField, and processorFvPatchField.

tmp<fvPatchField<Type> > New const fvPatch ,
const Field< Type > &  ,
const dictionary
[static]
 

Return a pointer to a new patchField created on freestore.

from dictionary

tmp<fvPatchField<Type> > New const fvPatchField< Type > &  ,
const fvPatch ,
const Field< Type > &  ,
const fvPatchFieldMapper
[static]
 

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

a given fvPatchField mapped onto a new patch

tmp<fvPatchField<Type> > New const word ,
const fvPatch ,
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<fvPatchField<Type> > NewCalculatedType const fvPatchField< Type2 > &   )  [static]
 

Return a pointer to a new calculatedFvPatchField created on.

freestore without setting patchField values

virtual void operator *= const   scalar  )  [virtual]
 

Reimplemented in fixedValueFvPatchField, mixedFvPatchField, slicedFvPatchField, directionMixedFvPatchField, expDirectionMixedFvPatchField, and partialSlipFvPatchField.

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

Reimplemented in fixedValueFvPatchField, mixedFvPatchField, slicedFvPatchField, directionMixedFvPatchField, expDirectionMixedFvPatchField, and partialSlipFvPatchField.

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

Reimplemented in fixedValueFvPatchField, mixedFvPatchField, slicedFvPatchField, expDirectionMixedFvPatchField, and partialSlipFvPatchField.

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

Reimplemented from Field.

Reimplemented in fixedValueFvPatchField, mixedFvPatchField, slicedFvPatchField, directionMixedFvPatchField, expDirectionMixedFvPatchField, and partialSlipFvPatchField.

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

Reimplemented in fixedValueFvPatchField, mixedFvPatchField, slicedFvPatchField, directionMixedFvPatchField, expDirectionMixedFvPatchField, and partialSlipFvPatchField.

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

Reimplemented in fixedValueFvPatchField, mixedFvPatchField, slicedFvPatchField, directionMixedFvPatchField, expDirectionMixedFvPatchField, and partialSlipFvPatchField.

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

Reimplemented from Field.

Reimplemented in fixedValueFvPatchField, mixedFvPatchField, slicedFvPatchField, directionMixedFvPatchField, expDirectionMixedFvPatchField, and partialSlipFvPatchField.

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

Reimplemented in fixedValueFvPatchField, mixedFvPatchField, slicedFvPatchField, directionMixedFvPatchField, expDirectionMixedFvPatchField, and partialSlipFvPatchField.

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

Reimplemented in fixedValueFvPatchField, mixedFvPatchField, slicedFvPatchField, directionMixedFvPatchField, expDirectionMixedFvPatchField, and partialSlipFvPatchField.

virtual void operator/= const   scalar  )  [virtual]
 

Reimplemented in fixedValueFvPatchField, mixedFvPatchField, slicedFvPatchField, directionMixedFvPatchField, expDirectionMixedFvPatchField, and partialSlipFvPatchField.

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

Reimplemented in fixedValueFvPatchField, mixedFvPatchField, slicedFvPatchField, directionMixedFvPatchField, expDirectionMixedFvPatchField, and partialSlipFvPatchField.

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

Reimplemented in fixedValueFvPatchField, mixedFvPatchField, slicedFvPatchField, expDirectionMixedFvPatchField, and partialSlipFvPatchField.

virtual void operator= const Type &   )  [virtual]
 

Assignment of all entries to the given value.

Reimplemented from Field.

Reimplemented in fixedValueFvPatchField, mixedFvPatchField, slicedFvPatchField, directionMixedFvPatchField, expDirectionMixedFvPatchField, and partialSlipFvPatchField.

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

Reimplemented in fixedValueFvPatchField, mixedFvPatchField, slicedFvPatchField, transformFvPatchField, directionMixedFvPatchField, expDirectionMixedFvPatchField, and partialSlipFvPatchField.

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

Assignment from UList operator. Takes linear time.

Reimplemented from Field.

Reimplemented in fixedValueFvPatchField, mixedFvPatchField, slicedFvPatchField, and partialSlipFvPatchField.

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

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

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

const fvPatch& patch  )  const [inline]
 

Return patch.

Definition at line 265 of file fvPatchField.H.

const fvPatchField<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.

Reimplemented in slicedFvPatchField.

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 coupledFvPatchField, slicedFvPatchField, cyclicFvPatchField, and processorFvPatchField.

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

Return neighbour coupled given internal cell data.

Reimplemented in slicedFvPatchField.

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

Reverse map the given fvPatchField onto this fvPatchField.

Reimplemented in emptyFvPatchField, fixedGradientFvPatchField, mixedFvPatchField, directionMixedFvPatchField, expDirectionMixedFvPatchField, oscillatingFixedValueFvPatchField, partialSlipFvPatchField, and turbulentInletFvPatchField.

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

Return patch-normal gradient.

Reimplemented in basicSymmetryFvPatchField, coupledFvPatchField, fixedGradientFvPatchField, mixedFvPatchField, slicedFvPatchField, transformFvPatchField, zeroGradientFvPatchField, directionMixedFvPatchField, expDirectionMixedFvPatchField, partialSlipFvPatchField, wedgeFvPatchField, basicSymmetryFvPatchField, and wedgeFvPatchField.

TypeName "fvPatchField< Type >"   ) 
 

Runtime type information.

virtual void updateCoeffs  )  [inline, virtual]
 

Update the coefficients associated with the patch field.

Sets Updated to true

Reimplemented in emptyFvPatchField, slicedFvPatchField, inletOutletFvPatchField, oscillatingFixedValueFvPatchField, outletInletFvPatchField, timeVaryingUniformFixedValueFvPatchField, turbulentInletFvPatchField, timeVaryingUniformFixedValueFvPatchField, timeVaryingUniformFixedValueFvPatchField, timeVaryingUniformFixedValueFvPatchField, and timeVaryingUniformFixedValueFvPatchField.

Definition at line 349 of file fvPatchField.H.

References Foam::labelField.

bool updated  )  const [inline]
 

Return true if the boundary condition has already been updated.

Definition at line 290 of file fvPatchField.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 415 of file fvPatchField.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 398 of file fvPatchField.H.

virtual void write Ostream  )  const [virtual]
 

Write.

Reimplemented in calculatedFvPatchField, coupledFvPatchField, defaultFvPatchField, fixedGradientFvPatchField, fixedValueFvPatchField, mixedFvPatchField, slicedFvPatchField, directionMixedFvPatchField, expDirectionMixedFvPatchField, freestreamFvPatchField, inletOutletFvPatchField, oscillatingFixedValueFvPatchField, outletInletFvPatchField, partialSlipFvPatchField, timeVaryingUniformFixedValueFvPatchField, turbulentInletFvPatchField, and uniformFixedValueFvPatchField.


Friends And Related Function Documentation

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


Member Data Documentation

int disallowDefaultFvPatchField [static]
 

Debug switch to disallow the use of.

Definition at line 112 of file fvPatchField.H.


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