fvPatch Class Reference

A finiteVolume patch using a polyPatch and a fvBoundaryMesh. More...

Inheritance diagram for fvPatch:
[legend]

Public Types

typedef fvBoundaryMesh BoundaryMesh
 The boundary type associated with the patch. More...
 

Public Member Functions

virtual void makeWeights (scalarField &) const
 Make patch weighting factors. More...
 
virtual void makeDeltaCoeffs (scalarField &) const
 Correct patch deltaCoeffs. More...
 
virtual void makeNonOrthoDeltaCoeffs (scalarField &) const
 Correct patch non-ortho deltaCoeffs. More...
 
virtual void makeNonOrthoCorrVectors (vectorField &) const
 Correct patch non-ortho correction vectors. More...
 
virtual void initMovePoints ()
 Initialise the patches for moving points. More...
 
virtual void movePoints ()
 Correct patches after moving points. More...
 
 TypeName (polyPatch::typeName_())
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, fvPatch, polyPatch,(const polyPatch &patch, const fvBoundaryMesh &bm),(patch, bm))
 
 fvPatch (const polyPatch &, const fvBoundaryMesh &)
 Construct from polyPatch and fvBoundaryMesh. More...
 
virtual ~fvPatch ()
 Destructor. More...
 
const polyPatchpatch () const
 Return the polyPatch. More...
 
virtual const wordname () const
 Return name. More...
 
virtual label start () const
 Return start label of this patch in the polyMesh face list. More...
 
virtual label size () const
 Return size. More...
 
virtual bool coupled () const
 Return true if this patch is coupled. More...
 
label index () const
 Return the index of this patch in the fvBoundaryMesh. More...
 
const fvBoundaryMeshboundaryMesh () const
 Return boundaryMesh reference. More...
 
template<class T >
const List< T >::subList patchSlice (const List< T > &l) const
 Slice list to patch. More...
 
virtual const labelUListfaceCells () const
 Return faceCells. More...
 
const vectorFieldCf () const
 Return face centres. More...
 
tmp< vectorFieldCn () const
 Return neighbour cell centres. More...
 
const vectorFieldSf () const
 Return face area vectors. More...
 
const scalarFieldmagSf () const
 Return face area magnitudes. More...
 
tmp< vectorFieldnf () const
 Return face normals. More...
 
virtual tmp< vectorFielddelta () const
 
const scalarFieldweights () const
 Return patch weighting factors. More...
 
const scalarFielddeltaCoeffs () const
 
template<class Type >
tmp< Field< Type > > patchInternalField (const UList< Type > &) const
 Return given internal field next to patch as patch field. More...
 
template<class Type >
tmp< Field< Type > > patchInternalField (const UList< Type > &, const labelUList &faceCells) const
 
template<class Type >
void patchInternalField (const UList< Type > &, Field< Type > &) const
 Return given internal field next to patch as patch field. More...
 
template<class GeometricField , class Type >
const GeometricField::PatchpatchField (const GeometricField &) const
 Return the corresponding patchField of the named field. More...
 
template<class GeometricField , class Type >
const GeometricField::PatchlookupPatchField (const word &name, const GeometricField *=nullptr, const Type *=nullptr) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > patchInternalField (const UList< Type > &f) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > patchInternalField (const UList< Type > &f, const labelUList &faceCells) const
 

Static Public Member Functions

static autoPtr< fvPatchNew (const polyPatch &, const fvBoundaryMesh &)
 Return a pointer to a new patch created on freestore from polyPatch. More...
 
static const fvPatchlookupPatch (const polyPatch &p)
 Lookup the polyPatch index on corresponding fvMesh. More...
 
static bool constraintType (const word &pt)
 Return true if the given type is a constraint type. More...
 
static wordList constraintTypes ()
 Return a list of all the constraint patch types. More...
 

Friends

class fvBoundaryMesh
 
class surfaceInterpolation
 

Detailed Description

A finiteVolume patch using a polyPatch and a fvBoundaryMesh.

Source files

Definition at line 70 of file fvPatch.H.

Member Typedef Documentation

◆ BoundaryMesh

The boundary type associated with the patch.

Definition at line 116 of file fvPatch.H.

Constructor & Destructor Documentation

◆ fvPatch()

fvPatch ( const polyPatch p,
const fvBoundaryMesh bm 
)

Construct from polyPatch and fvBoundaryMesh.

Definition at line 66 of file fvPatch.C.

◆ ~fvPatch()

~fvPatch ( )
virtual

Destructor.

Definition at line 75 of file fvPatch.C.

Member Function Documentation

◆ makeWeights()

void makeWeights ( scalarField w) const
virtual

Make patch weighting factors.

Reimplemented in cyclicFvPatch, cyclicACMIFvPatch, cyclicAMIFvPatch, processorFvPatch, and coupledFvPatch.

Definition at line 170 of file fvPatch.C.

References fvPatch::makeWeights().

Referenced by fvPatch::makeWeights().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ makeDeltaCoeffs()

void makeDeltaCoeffs ( scalarField w) const
virtual

Correct patch deltaCoeffs.

Reimplemented in cyclicAMIFvPatch, and mappedVariableThicknessWallFvPatch.

Definition at line 176 of file fvPatch.C.

References fvPatch::makeDeltaCoeffs().

Referenced by fvPatch::makeDeltaCoeffs().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ makeNonOrthoDeltaCoeffs()

void makeNonOrthoDeltaCoeffs ( scalarField w) const
virtual

Correct patch non-ortho deltaCoeffs.

Reimplemented in cyclicAMIFvPatch.

Definition at line 180 of file fvPatch.C.

◆ makeNonOrthoCorrVectors()

void makeNonOrthoCorrVectors ( vectorField w) const
virtual

Correct patch non-ortho correction vectors.

Reimplemented in cyclicAMIFvPatch.

Definition at line 184 of file fvPatch.C.

◆ initMovePoints()

void initMovePoints ( )
virtual

Initialise the patches for moving points.

Definition at line 188 of file fvPatch.C.

Referenced by cyclicFaPatch::initMovePoints(), mappedPolyPatch::initMovePoints(), mappedWallPolyPatch::initMovePoints(), cyclicPolyPatch::initMovePoints(), oldCyclicPolyPatch::initMovePoints(), and cyclicACMIPolyPatch::initMovePoints().

Here is the caller graph for this function:

◆ movePoints()

void movePoints ( )
virtual

Correct patches after moving points.

Reimplemented in cyclicACMIFvPatch, and cyclicAMIFvPatch.

Definition at line 192 of file fvPatch.C.

◆ TypeName()

TypeName ( polyPatch::typeName_()  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
fvPatch  ,
polyPatch  ,
(const polyPatch &patch, const fvBoundaryMesh &bm)  ,
(patch, bm)   
)

◆ New()

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 34 of file fvPatchNew.C.

References DebugInFunction, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInLookup, and fvPatch::patch().

Here is the call graph for this function:

◆ lookupPatch()

const Foam::fvPatch & lookupPatch ( const polyPatch p)
static

Lookup the polyPatch index on corresponding fvMesh.

Note
Fatal if the polyPatch is not associated with a fvMesh

Definition at line 49 of file fvPatch.C.

References fvMesh::boundary(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, DimensionedField< Type, GeoMesh >::mesh(), Foam::nl, and p.

Here is the call graph for this function:

◆ patch()

◆ name()

virtual const word & name ( ) const
inlinevirtual

◆ start()

◆ size()

◆ coupled()

virtual bool coupled ( ) const
inlinevirtual

Return true if this patch is coupled.

Reimplemented in coupledFvPatch, cyclicACMIFvPatch, cyclicAMIFvPatch, and processorFvPatch.

Definition at line 191 of file fvPatch.H.

References polyPatch::coupled().

Here is the call graph for this function:

◆ constraintType()

bool constraintType ( const word pt)
static

Return true if the given type is a constraint type.

Definition at line 81 of file fvPatch.C.

References found.

◆ constraintTypes()

Foam::wordList constraintTypes ( )
static

Return a list of all the constraint patch types.

Definition at line 91 of file fvPatch.C.

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

Here is the call graph for this function:

◆ index()

label index ( ) const
inline

Return the index of this patch in the fvBoundaryMesh.

Definition at line 203 of file fvPatch.H.

References patchIdentifier::index().

Referenced by atmEpsilonWallFunctionFvPatchScalarField::calculate(), atmOmegaWallFunctionFvPatchScalarField::calculate(), cyclicACMIFvsPatchField< Type >::cyclicACMIFvsPatchField(), cyclicAMIFvsPatchField< Type >::cyclicAMIFvsPatchField(), cyclicFvsPatchField< Type >::cyclicFvsPatchField(), emptyFvsPatchField< Type >::emptyFvsPatchField(), boundaryAdjointContributionIncompressible::laminarDiffusivity(), boundaryAdjointContributionIncompressible::momentumDiffusion(), cyclicAMIFvPatch::movePoints(), boundaryAdjointContributionIncompressible::pab(), boundaryAdjointContributionIncompressible::pb(), boundaryAdjointContributionIncompressible::phiab(), boundaryAdjointContributionIncompressible::phib(), boundaryAdjointContributionIncompressible::pressureSource(), processorCyclicFvsPatchField< Type >::processorCyclicFvsPatchField(), processorFvsPatchField< Type >::processorFvsPatchField(), boundaryAdjointContributionIncompressible::sumContributions(), symmetryFvsPatchField< Type >::symmetryFvsPatchField(), symmetryPlaneFvsPatchField< Type >::symmetryPlaneFvsPatchField(), boundaryAdjointContributionIncompressible::tangentVelocitySource(), boundaryAdjointContributionIncompressible::TMVariable1(), boundaryAdjointContributionIncompressible::TMVariable1Diffusion(), boundaryAdjointContributionIncompressible::TMVariable2(), boundaryAdjointContributionIncompressible::TMVariable2Diffusion(), boundaryAdjointContributionIncompressible::turbulentDiffusivity(), boundaryAdjointContributionIncompressible::Uab(), boundaryAdjointContributionIncompressible::Ub(), liquidFilmBase::Up(), velocityFilmShellFvPatchVectorField::updateCoeffs(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), liquidFilmBase::Uw(), boundaryAdjointContributionIncompressible::velocitySource(), boundaryAdjointContributionIncompressible::wallDistance(), and wedgeFvsPatchField< Type >::wedgeFvsPatchField().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ boundaryMesh()

const fvBoundaryMesh & boundaryMesh ( ) const
inline

Return boundaryMesh reference.

Definition at line 209 of file fvPatch.H.

Referenced by fvPatch::lookupPatchField(), waWallFunctionFvPatchScalarField::manipulateMatrix(), parseDriver::mesh(), parseDriver::parseDriver(), and outletMappedUniformInletHeatAdditionFvPatchField::updateCoeffs().

Here is the caller graph for this function:

◆ patchSlice()

const List< T >::subList patchSlice ( const List< T > &  l) const
inline

Slice list to patch.

Definition at line 216 of file fvPatch.H.

References fvPatch::size(), and fvPatch::start().

Referenced by fvFieldDecomposer::reset().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ faceCells()

◆ Cf()

const Foam::vectorField & Cf ( ) const

Return face centres.

Definition at line 119 of file fvPatch.C.

References boundaryMesh::mesh().

Referenced by fieldExtents::calcFieldExtents(), meshToMesh0::interpolate(), cyclicAMIFvPatch::movePoints(), and cyclicACMIFvPatch::resetPatchAreas().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Cn()

Foam::tmp< Foam::vectorField > Cn ( ) const

Return neighbour cell centres.

Definition at line 125 of file fvPatch.C.

References forAll, boundaryMesh::mesh(), and Time::New().

Here is the call graph for this function:

◆ Sf()

const Foam::vectorField & Sf ( ) const

Return face area vectors.

Definition at line 150 of file fvPatch.C.

References boundaryMesh::mesh().

Referenced by cyclicAMIFvPatch::movePoints(), cyclicACMIFvPatch::resetPatchAreas(), activeBaffleVelocityFvPatchVectorField::updateCoeffs(), and activePressureForceBaffleVelocityFvPatchVectorField::updateCoeffs().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ magSf()

const Foam::scalarField & magSf ( ) const

Return face area magnitudes.

Definition at line 156 of file fvPatch.C.

References boundaryMesh::mesh().

Referenced by parseDriver::areaAverage(), parseDriver::areaSum(), cyclicACMIFvPatch::movePoints(), cyclicAMIFvPatch::movePoints(), cyclicACMIFvPatch::resetPatchAreas(), activeBaffleVelocityFvPatchVectorField::updateCoeffs(), activePressureForceBaffleVelocityFvPatchVectorField::updateCoeffs(), outletMappedUniformInletFvPatchField< Type >::updateCoeffs(), and outletMappedUniformInletHeatAdditionFvPatchField::updateCoeffs().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ nf()

Foam::tmp< Foam::vectorField > nf ( ) const

Return face normals.

Definition at line 144 of file fvPatch.C.

Referenced by curvatureSeparation::calcCosAngle(), ReynoldsAnalogy::Cf(), cyclicFvPatch::makeWeights(), cyclicACMIFvPatch::makeWeights(), cyclicAMIFvPatch::makeWeights(), processorFvPatch::makeWeights(), boundaryAdjointContributionIncompressible::pressureSource(), and boundaryAdjointContributionIncompressible::tangentVelocitySource().

Here is the caller graph for this function:

◆ delta()

Foam::tmp< Foam::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 cyclicFvPatch, cyclicACMIFvPatch, cyclicAMIFvPatch, processorFvPatch, and coupledFvPatch.

Definition at line 162 of file fvPatch.C.

◆ weights()

const Foam::scalarField & weights ( ) const

Return patch weighting factors.

Definition at line 202 of file fvPatch.C.

References boundaryMesh::mesh().

Here is the call graph for this function:

◆ deltaCoeffs()

const Foam::scalarField & deltaCoeffs ( ) const

Return the face - cell distance coefficient except for coupled patches for which the cell-centre to coupled-cell-centre distance coefficient is returned

Definition at line 196 of file fvPatch.C.

References boundaryMesh::mesh().

Referenced by contactAngleForce::correct(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), humidityTemperatureCoupledMixedFvPatchScalarField::updateCoeffs(), and turbulentTemperatureRadCoupledMixedFvPatchScalarField::updateCoeffs().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ patchInternalField() [1/5]

tmp< Field< Type > > patchInternalField ( const UList< Type > &  ) const

Return given internal field next to patch as patch field.

Referenced by fvPatch::patchInternalField().

Here is the caller graph for this function:

◆ patchInternalField() [2/5]

tmp< Field< Type > > patchInternalField ( const UList< Type > &  ,
const labelUList faceCells 
) const

Return given internal field next to patch as patch field using faceCells mapping

◆ patchInternalField() [3/5]

void patchInternalField ( const UList< Type > &  f,
Field< Type > &  pif 
) const

Return given internal field next to patch as patch field.

Definition at line 63 of file fvPatchTemplates.C.

References f(), forAll, and List< T >::resize().

Here is the call graph for this function:

◆ patchField()

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

Return the corresponding patchField of the named field.

Definition at line 81 of file fvPatchTemplates.C.

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

Here is the call graph for this function:

◆ lookupPatchField()

const GeometricField::Patch & lookupPatchField ( const word name,
const GeometricField = nullptr,
const Type *  = nullptr 
) 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 33 of file fvPatchFvMeshTemplates.C.

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

Referenced by semiPermeableBaffleMassFractionFvPatchScalarField::phiY(), mappedFlowRateFvPatchVectorField::updateCoeffs(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), humidityTemperatureCoupledMixedFvPatchScalarField::updateCoeffs(), and turbulentTemperatureRadCoupledMixedFvPatchScalarField::updateCoeffs().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ patchInternalField() [4/5]

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

Definition at line 34 of file fvPatchTemplates.C.

References f(), fvPatch::faceCells(), and fvPatch::patchInternalField().

Here is the call graph for this function:

◆ patchInternalField() [5/5]

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

Definition at line 44 of file fvPatchTemplates.C.

References f(), forAll, and Foam::New().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ fvBoundaryMesh

friend class fvBoundaryMesh
friend

Definition at line 118 of file fvPatch.H.

◆ surfaceInterpolation

friend class surfaceInterpolation
friend

Definition at line 119 of file fvPatch.H.


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