FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

Foam::fvPatch. More...

#include <finiteVolume/fvPatch.H>


Detailed Description

Foam::fvPatch.

Source files

Definition at line 62 of file fvPatch.H.

Inheritance diagram for fvPatch:
Collaboration diagram for fvPatch:

List of all members.

Public Types

typedef fvBoundaryMesh  BoundaryMesh

Public Member Functions

 TypeName (polyPatch::typeName_())
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, fvPatch, polyPatch,(const polyPatch &patch, const fvBoundaryMesh &bm),(patch, bm))
 fvPatch (const polyPatch &, const fvBoundaryMesh &)
 Construct from polyPatch.
virtual  ~fvPatch ()
const polyPatch &  patch () const
 Return the polyPatch.
const word &  name () const
 Return name.
virtual label  size () const
 Return size.
bool  coupled () const
 Return true if this patch is coupled.
label  index () const
 Return the index of this patch in the fvBoundaryMesh.
const fvBoundaryMesh &  boundaryMesh () const
 Return boundaryMesh reference.
template<class T >
const List< T >::subList  patchSlice (const List< T > &l) const
 Slice list to patch.
virtual const unallocLabelList &  faceCells () const
 Return faceCells.
const vectorField &  Cf () const
 Return face centres.
tmp< vectorField >  Cn () const
 Return neighbour cell centres.
const vectorField &  Sf () const
 Return face area vectors.
const scalarField &  magSf () const
 Return face area magnitudes.
tmp< vectorField >  nf () const
 Return face normals.
virtual tmp< vectorField >  delta () const
 Return cell-centre to face-centre vector.
const scalarField &  weights () const
 Return patch weighting factors.
const scalarField &  deltaCoeffs () const
 Return the face - cell distance coeffient.
template<class Type >
tmp< Field< Type > >  patchInternalField (const UList< Type > &) const
 Return given internal field next to patch as patch field.
template<class GeometricField , class Type >
const
GeometricField::PatchFieldType &  
patchField (const GeometricField &) const
 Return the corresponding patchField of the named field.
template<class GeometricField , class Type >
const
GeometricField::PatchFieldType &  
lookupPatchField (const word &name, const GeometricField *=NULL, const Type *=NULL) const
 Lookup and return the patchField of the named field from the.

Static Public Member Functions

static autoPtr< fvPatch >  New (const polyPatch &, const fvBoundaryMesh &)
 Return a pointer to a new patch created on freestore from polyPatch.
static bool  constraintType (const word &pt)
 Return true if the given type is a constraint type.
static wordList  constraintTypes ()
 Return a list of all the constraint patch types.

Protected Member Functions

virtual void  makeWeights (scalarField &) const
 Make patch weighting factors.
virtual void  makeDeltaCoeffs (scalarField &) const
 Make patch face - neighbour cell distances.
virtual void  initMovePoints ()
 Initialise the patches for moving points.
virtual void  movePoints ()
 Correct patches after moving points.

Friends

class  fvBoundaryMesh
class  surfaceInterpolation

Member Typedef Documentation

Definition at line 101 of file fvPatch.H.


Constructor & Destructor Documentation

fvPatch ( const polyPatch &   p,
const fvBoundaryMesh &   bm  
)

Construct from polyPatch.

Definition at line 48 of file fvPatch.C.

~fvPatch (  ) [virtual]

Definition at line 57 of file fvPatch.C.


Member Function Documentation

void makeWeights ( scalarField &   w  ) const [protected, virtual]

Make patch weighting factors.

Reimplemented in coupledFvPatch, cyclicFvPatch, and processorFvPatch.

Definition at line 150 of file fvPatch.C.

void makeDeltaCoeffs ( scalarField &   dc  ) const [protected, virtual]

Make patch face - neighbour cell distances.

Reimplemented in coupledFvPatch, cyclicFvPatch, and processorFvPatch.

Definition at line 156 of file fvPatch.C.

References fvPatch::delta(), and fvPatch::nf().

void initMovePoints (  ) [protected, virtual]

Initialise the patches for moving points.

Definition at line 162 of file fvPatch.C.

void movePoints (  ) [protected, virtual]

Correct patches after moving points.

Definition at line 166 of file fvPatch.C.

TypeName ( polyPatch::   typeName_()  )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr   ,
fvPatch   ,
polyPatch   ,
(const polyPatch &patch, const fvBoundaryMesh &bm)   ,
(patch, bm)    
)
Foam::autoPtr< Foam::fvPatch > New ( const polyPatch &   patch,
const fvBoundaryMesh &   bm  
) [static]

Return a pointer to a new patch created on freestore from polyPatch.

Definition at line 32 of file newFvPatch.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, and Foam::Info.

Referenced by fvMeshAdder::add(), and meshRefinement::addPatch().

virtual label size (  ) const [inline, virtual]

Return size.

Reimplemented in emptyFvPatch.

Definition at line 156 of file fvPatch.H.

Referenced by advectiveFvPatchField< Type >::advectiveFvPatchField(), alphaContactAngleFvPatchScalarField::alphaContactAngleFvPatchScalarField(), alphaFixedPressureFvPatchScalarField::alphaFixedPressureFvPatchScalarField(), cellMotionFvPatchField< Type >::cellMotionFvPatchField(), fvPatch::Cn(), fanFvPatchField< Type >::fanFvPatchField(), fixedFluxPressureFvPatchScalarField::fixedFluxPressureFvPatchScalarField(), freestreamFvPatchField< Type >::freestreamFvPatchField(), fvPatchField< Type >::fvPatchField(), fvsPatchField< Type >::fvsPatchField(), greyDiffusiveRadiationMixedFvPatchScalarField::greyDiffusiveRadiationMixedFvPatchScalarField(), inletOutletFvPatchField< Type >::inletOutletFvPatchField(), inletOutletTotalTemperatureFvPatchScalarField::inletOutletTotalTemperatureFvPatchScalarField(), fvMeshSubset::interpolate(), MarshakRadiationFixedTMixedFvPatchScalarField::MarshakRadiationFixedTMixedFvPatchScalarField(), MarshakRadiationFvPatchScalarField::MarshakRadiationFvPatchScalarField(), movingWallVelocityFvPatchVectorField::movingWallVelocityFvPatchVectorField(), oscillatingFixedValueFvPatchField< Type >::oscillatingFixedValueFvPatchField(), outletInletFvPatchField< Type >::outletInletFvPatchField(), fvPatch::patchSlice(), pressureDirectedInletOutletVelocityFvPatchVectorField::pressureDirectedInletOutletVelocityFvPatchVectorField(), pressureDirectedInletVelocityFvPatchVectorField::pressureDirectedInletVelocityFvPatchVectorField(), pressureInletOutletVelocityFvPatchVectorField::pressureInletOutletVelocityFvPatchVectorField(), pressureInletVelocityFvPatchVectorField::pressureInletVelocityFvPatchVectorField(), pressureNormalInletOutletVelocityFvPatchVectorField::pressureNormalInletOutletVelocityFvPatchVectorField(), fvPatchMapper::size(), SRFFreestreamVelocityFvPatchVectorField::SRFFreestreamVelocityFvPatchVectorField(), SRFVelocityFvPatchVectorField::SRFVelocityFvPatchVectorField(), supersonicFreestreamFvPatchVectorField::supersonicFreestreamFvPatchVectorField(), timeVaryingMappedFixedValueFvPatchField< Type >::timeVaryingMappedFixedValueFvPatchField(), timeVaryingMappedPressureDirectedInletVelocityFvPatchVectorField::timeVaryingMappedPressureDirectedInletVelocityFvPatchVectorField(), timeVaryingUniformTotalPressureFvPatchScalarField::timeVaryingUniformTotalPressureFvPatchScalarField(), totalPressureFvPatchScalarField::totalPressureFvPatchScalarField(), totalTemperatureFvPatchScalarField::totalTemperatureFvPatchScalarField(), turbulentInletFvPatchField< Type >::turbulentInletFvPatchField(), turbulentIntensityKineticEnergyInletFvPatchScalarField::turbulentIntensityKineticEnergyInletFvPatchScalarField(), incompressible::turbulentMixingLengthDissipationRateInletFvPatchScalarField::turbulentMixingLengthDissipationRateInletFvPatchScalarField(), turbulentMixingLengthDissipationRateInletFvPatchScalarField::turbulentMixingLengthDissipationRateInletFvPatchScalarField(), incompressible::turbulentMixingLengthFrequencyInletFvPatchScalarField::turbulentMixingLengthFrequencyInletFvPatchScalarField(), turbulentMixingLengthFrequencyInletFvPatchScalarField::turbulentMixingLengthFrequencyInletFvPatchScalarField(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::turbulentTemperatureCoupledBaffleMixedFvPatchScalarField(), uniformDensityHydrostaticPressureFvPatchScalarField::uniformDensityHydrostaticPressureFvPatchScalarField(), wallHeatTransferFvPatchScalarField::wallHeatTransferFvPatchScalarField(), wideBandDiffusiveRadiationMixedFvPatchScalarField::wideBandDiffusiveRadiationMixedFvPatchScalarField(), incompressible::RASModel::yPlus(), and RASModel::yPlus().

bool coupled (  ) const [inline]

Return true if this patch is coupled.

Reimplemented in coupledFvPatch, and processorFvPatch.

Definition at line 162 of file fvPatch.H.

References polyPatch::coupled().

bool constraintType ( const word &   pt  ) [static]

Return true if the given type is a constraint type.

Definition at line 63 of file fvPatch.C.

Referenced by fvPatch::constraintTypes().

wordList constraintTypes (  ) [static]

Return a list of all the constraint patch types.

Definition at line 69 of file fvPatch.C.

References fvPatch::constraintType(), and List< T >::setSize().

const List<T>::subList patchSlice ( const List< T > &   l  ) const [inline]
tmp< vectorField > Cn (  ) const

Return neighbour cell centres.

Definition at line 107 of file fvPatch.C.

References fvPatch::boundaryMesh(), primitiveMesh::cellCentres(), fvPatch::faceCells(), forAll, fvBoundaryMesh::mesh(), and fvPatch::size().

Referenced by fvPatch::delta().

const vectorField & Sf (  ) const
tmp< vectorField > delta (  ) const [virtual]

Return cell-centre to face-centre vector.

except for coupled patches for which the cell-centre to coupled-cell-centre vector is returned

Reimplemented in coupledFvPatch, cyclicFvPatch, and processorFvPatch.

Definition at line 144 of file fvPatch.C.

References fvPatch::Cf(), and fvPatch::Cn().

Referenced by fvPatch::makeDeltaCoeffs().

const scalarField & deltaCoeffs (  ) const

Return the face - cell distance coeffient.

except for coupled patches for which the cell-centre to coupled-cell-centre distance coeffient is returned

Definition at line 170 of file fvPatch.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), fvPatch::boundaryMesh(), surfaceInterpolation::deltaCoeffs(), fvPatch::index(), and fvBoundaryMesh::mesh().

Referenced by turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::updateCoeffs(), and turbulentTemperatureCoupledBaffleFvPatchScalarField::updateCoeffs().

Foam::tmp< Foam::Field< Type > > patchInternalField ( const UList< Type > &   f  ) const

Return given internal field next to patch as patch field.

Definition at line 32 of file fvPatchTemplates.C.

References forAll.

const GeometricField::PatchFieldType & patchField ( const GeometricField &   gf  ) const

Return the corresponding patchField of the named field.

Definition at line 52 of file fvPatchTemplates.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField().

Referenced by movingWallVelocityFvPatchVectorField::updateCoeffs().

const GeometricField::PatchFieldType & lookupPatchField ( const word &   name,
const GeometricField *   = NULL,
const Type *   = 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

Definition at line 32 of file fvPatchFvMeshTemplates.C.

References boundaryMesh::mesh(), and name().

Referenced by omegaWallFunctionFvPatchScalarField::updateCoeffs(), epsilonWallFunctionFvPatchScalarField::updateCoeffs(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::updateCoeffs(), and turbulentTemperatureCoupledBaffleFvPatchScalarField::updateCoeffs().


Friends And Related Function Documentation

friend class fvBoundaryMesh [friend]

Definition at line 103 of file fvPatch.H.

friend class surfaceInterpolation [friend]

Reimplemented in coupledFvPatch.

Definition at line 104 of file fvPatch.H.


The documentation for this class was generated from the following files: