fvPatch Class Reference

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

Inheritance diagram for fvPatch:

Public Types

typedef fvBoundaryMesh BoundaryMesh
 

Public Member Functions

 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...
 
 fvPatch (const fvPatch &)
 Disallow default bitwise copy construction. 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
 Return cell-centre to face-centre vector. More...
 
const scalarFieldweights () const
 Return patch weighting factors. More...
 
const scalarFielddeltaCoeffs () const
 Return the face - cell distance coeffient. More...
 
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 >
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 >
GeometricField::PatchpatchField (GeometricField &) const
 Return the corresponding patchField reference of the named field. More...
 
template<class GeometricField , class Type >
const GeometricField::PatchlookupPatchField (const word &name, const GeometricField *=nullptr, const Type *=nullptr) const
 Lookup and return the patchField of the named field from the. More...
 
void operator= (const fvPatch &)
 Disallow default bitwise assignment. More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > patchInternalField (const UList< Type > &f) 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 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...
 

Protected Member Functions

virtual void makeWeights (scalarField &) const
 Make patch weighting factors. More...
 
virtual void initMovePoints ()
 Initialise the patches for moving points. More...
 
virtual void movePoints ()
 Correct patches after moving points. More...
 

Friends

class fvBoundaryMesh
 
class surfaceInterpolation
 

Detailed Description

A finiteVolume patch using a polyPatch and a fvBoundaryMesh.

Source files

Definition at line 61 of file fvPatch.H.

Member Typedef Documentation

◆ BoundaryMesh

Definition at line 88 of file fvPatch.H.

Constructor & Destructor Documentation

◆ fvPatch() [1/2]

fvPatch ( const polyPatch p,
const fvBoundaryMesh bm 
)

Construct from polyPatch and fvBoundaryMesh.

Definition at line 46 of file fvPatch.C.

◆ fvPatch() [2/2]

fvPatch ( const fvPatch )

Disallow default bitwise copy construction.

◆ ~fvPatch()

~fvPatch ( )
virtual

Destructor.

Definition at line 55 of file fvPatch.C.

Member Function Documentation

◆ makeWeights()

void makeWeights ( scalarField w) const
protectedvirtual

Make patch weighting factors.

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

Definition at line 150 of file fvPatch.C.

Referenced by cyclicACMIFvPatch::makeWeights(), and cyclicAMIFvPatch::makeWeights().

Here is the caller graph for this function:

◆ initMovePoints()

void initMovePoints ( )
protectedvirtual

Initialise the patches for moving points.

Definition at line 156 of file fvPatch.C.

Referenced by fvBoundaryMesh::movePoints().

Here is the caller graph for this function:

◆ movePoints()

void movePoints ( )
protectedvirtual

Correct patches after moving points.

Definition at line 160 of file fvPatch.C.

Referenced by fvBoundaryMesh::movePoints().

Here is the caller graph for this function:

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

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, InfoInFunction, and Foam::nl.

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

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

◆ patch()

◆ name()

◆ start()

◆ size()

virtual label size ( ) const
inlinevirtual

Return size.

Reimplemented in emptyFvPatch.

Definition at line 155 of file fvPatch.H.

Referenced by activePressureForceBaffleVelocityFvPatchVectorField::activePressureForceBaffleVelocityFvPatchVectorField(), alphaContactAngleFvPatchScalarField::alphaContactAngleFvPatchScalarField(), alphaFixedPressureFvPatchScalarField::alphaFixedPressureFvPatchScalarField(), atmBoundaryLayerInletEpsilonFvPatchScalarField::atmBoundaryLayerInletEpsilonFvPatchScalarField(), atmBoundaryLayerInletKFvPatchScalarField::atmBoundaryLayerInletKFvPatchScalarField(), atmBoundaryLayerInletVelocityFvPatchVectorField::atmBoundaryLayerInletVelocityFvPatchVectorField(), fvPatch::Cn(), externalWallHeatFluxTemperatureFvPatchScalarField::externalWallHeatFluxTemperatureFvPatchScalarField(), fanPressureJumpFvPatchScalarField::fanPressureJumpFvPatchScalarField(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::filmPyrolysisRadiativeCoupledMixedFvPatchScalarField(), fixedFluxPressureFvPatchScalarField::fixedFluxPressureFvPatchScalarField(), fixedNormalInletOutletVelocityFvPatchVectorField::fixedNormalInletOutletVelocityFvPatchVectorField(), freestreamPressureFvPatchScalarField::freestreamPressureFvPatchScalarField(), freestreamVelocityFvPatchVectorField::freestreamVelocityFvPatchVectorField(), fvPatchField< Type >::fvPatchField(), fvsPatchField< Type >::fvsPatchField(), greyDiffusiveRadiationMixedFvPatchScalarField::greyDiffusiveRadiationMixedFvPatchScalarField(), greyDiffusiveViewFactorFixedValueFvPatchScalarField::greyDiffusiveViewFactorFixedValueFvPatchScalarField(), inletOutletTotalTemperatureFvPatchScalarField::inletOutletTotalTemperatureFvPatchScalarField(), fvMeshSubset::interpolate(), Foam::levelSetFraction(), epsilonWallFunctionFvPatchScalarField::manipulateMatrix(), omegaWallFunctionFvPatchScalarField::manipulateMatrix(), MarshakRadiationFvPatchScalarField::MarshakRadiationFvPatchScalarField(), fvPatch::patchSlice(), phaseHydrostaticPressureFvPatchScalarField::phaseHydrostaticPressureFvPatchScalarField(), pressureDirectedInletOutletVelocityFvPatchVectorField::pressureDirectedInletOutletVelocityFvPatchVectorField(), pressureFvPatchScalarField::pressureFvPatchScalarField(), pressureInletOutletParSlipVelocityFvPatchVectorField::pressureInletOutletParSlipVelocityFvPatchVectorField(), pressureInletOutletVelocityFvPatchVectorField::pressureInletOutletVelocityFvPatchVectorField(), pressureNormalInletOutletVelocityFvPatchVectorField::pressureNormalInletOutletVelocityFvPatchVectorField(), semiPermeableBaffleMassFractionFvPatchScalarField::semiPermeableBaffleMassFractionFvPatchScalarField(), semiPermeableBaffleVelocityFvPatchVectorField::semiPermeableBaffleVelocityFvPatchVectorField(), SRFFreestreamVelocityFvPatchVectorField::SRFFreestreamVelocityFvPatchVectorField(), supersonicFreestreamFvPatchVectorField::supersonicFreestreamFvPatchVectorField(), thermalBaffle1DFvPatchScalarField< solidType >::thermalBaffle1DFvPatchScalarField(), totalPressureFvPatchScalarField::totalPressureFvPatchScalarField(), totalTemperatureFvPatchScalarField::totalTemperatureFvPatchScalarField(), turbulentIntensityKineticEnergyInletFvPatchScalarField::turbulentIntensityKineticEnergyInletFvPatchScalarField(), turbulentMixingLengthDissipationRateInletFvPatchScalarField::turbulentMixingLengthDissipationRateInletFvPatchScalarField(), turbulentMixingLengthFrequencyInletFvPatchScalarField::turbulentMixingLengthFrequencyInletFvPatchScalarField(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::turbulentTemperatureCoupledBaffleMixedFvPatchScalarField(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::turbulentTemperatureRadCoupledMixedFvPatchScalarField(), uniformDensityHydrostaticPressureFvPatchScalarField::uniformDensityHydrostaticPressureFvPatchScalarField(), uniformTotalPressureFvPatchScalarField::uniformTotalPressureFvPatchScalarField(), variableHeightFlowRateFvPatchScalarField::variableHeightFlowRateFvPatchScalarField(), wallHeatTransferFvPatchScalarField::wallHeatTransferFvPatchScalarField(), waveAlphaFvPatchScalarField::waveAlphaFvPatchScalarField(), wavePressureFvPatchScalarField::wavePressureFvPatchScalarField(), waveVelocityFvPatchVectorField::waveVelocityFvPatchVectorField(), and wideBandDiffusiveRadiationMixedFvPatchScalarField::wideBandDiffusiveRadiationMixedFvPatchScalarField().

◆ coupled()

virtual bool coupled ( ) const
inlinevirtual

Return true if this patch is coupled.

Reimplemented in cyclicAMIFvPatch, regionCoupledWallFvPatch, regionCoupledFvPatch, processorFvPatch, and coupledFvPatch.

Definition at line 161 of file fvPatch.H.

References fvPatch::constraintType(), fvPatch::constraintTypes(), and 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 61 of file fvPatch.C.

Referenced by fvPatch::constraintTypes(), and fvPatch::coupled().

Here is the caller graph for this function:

◆ constraintTypes()

Foam::wordList constraintTypes ( )
static

Return a list of all the constraint patch types.

Definition at line 67 of file fvPatch.C.

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

Referenced by fvPatch::coupled().

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

◆ index()

◆ boundaryMesh()

◆ patchSlice()

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

◆ faceCells()

const Foam::labelUList & faceCells ( ) const
virtual

Return faceCells.

Reimplemented in regionCoupledWallFvPatch, regionCoupledFvPatch, coupledFvPatch, and emptyFvPatch.

Definition at line 93 of file fvPatch.C.

References polyPatch::faceCells().

Referenced by nearWallFields::calcAddressing(), curvatureSeparation::calcCosAngle(), epsilonWallFunctionFvPatchScalarField::calculate(), omegaWallFunctionFvPatchScalarField::calculate(), epsilonWallFunctionFvPatchScalarField::calculateTurbulenceFields(), omegaWallFunctionFvPatchScalarField::calculateTurbulenceFields(), fvPatch::Cn(), SSG< BasicTurbulenceModel >::correct(), LRR< BasicTurbulenceModel >::correct(), pointLinear< Type >::correction(), coupledFvPatch::faceCells(), regionCoupledFvPatch::faceCells(), regionCoupledWallFvPatch::faceCells(), epsilonWallFunctionFvPatchScalarField::manipulateMatrix(), omegaWallFunctionFvPatchScalarField::manipulateMatrix(), inverseFaceDistanceDiffusivity::operator()(), inversePointDistanceDiffusivity::operator()(), energyRegionCoupledFvPatchScalarField::patchNeighbourField(), fvPatch::patchSlice(), energyJumpFvPatchScalarField::updateCoeffs(), energyJumpAMIFvPatchScalarField::updateCoeffs(), fWallFunctionFvPatchScalarField::updateCoeffs(), v2WallFunctionFvPatchScalarField::updateCoeffs(), kLowReWallFunctionFvPatchScalarField::updateCoeffs(), epsilonWallFunctionFvPatchScalarField::updateCoeffs(), omegaWallFunctionFvPatchScalarField::updateCoeffs(), epsilonWallFunctionFvPatchScalarField::updateWeightedCoeffs(), omegaWallFunctionFvPatchScalarField::updateWeightedCoeffs(), leastSquaresVectors::~leastSquaresVectors(), and skewCorrectionVectors::~skewCorrectionVectors().

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

◆ Cf()

const Foam::vectorField & Cf ( ) const

Return face centres.

Definition at line 99 of file fvPatch.C.

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

Referenced by nearWallFields::calcAddressing(), fvPatch::delta(), meshToMesh0::interpolate(), and fvPatch::patchSlice().

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 105 of file fvPatch.C.

References fvPatch::boundaryMesh(), primitiveMesh::cellCentres(), fvPatch::faceCells(), forAll, fvBoundaryMesh::mesh(), tmp< T >::ref(), and fvPatch::size().

Referenced by fvPatch::delta(), and fvPatch::patchSlice().

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

◆ Sf()

◆ magSf()

◆ nf()

◆ 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 cyclicAMIFvPatch, processorFvPatch, cyclicFvPatch, and coupledFvPatch.

Definition at line 142 of file fvPatch.C.

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

Referenced by NamedEnum< directionType, 3 >::names(), fvPatch::patchSlice(), leastSquaresVectors::~leastSquaresVectors(), and skewCorrectionVectors::~skewCorrectionVectors().

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

◆ weights()

const Foam::scalarField & weights ( ) const

Return patch weighting factors.

Definition at line 170 of file fvPatch.C.

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

Referenced by fvPatch::patchSlice().

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

◆ deltaCoeffs()

const Foam::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 164 of file fvPatch.C.

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

Referenced by fvPatch::patchSlice(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::updateCoeffs(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), and turbulentTemperatureRadCoupledMixedFvPatchScalarField::updateCoeffs().

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

◆ patchInternalField() [1/3]

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

Return given internal field next to patch as patch field.

Referenced by fvPatch::patchInternalField(), and fvPatch::patchSlice().

Here is the caller graph for this function:

◆ patchInternalField() [2/3]

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

Return given internal field next to patch as patch field.

Definition at line 52 of file fvPatchTemplates.C.

References forAll, fvPatch::patchField(), and List< Type >::setSize().

Here is the call graph for this function:

◆ patchField() [1/2]

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

Return the corresponding patchField of the named field.

Definition at line 70 of file fvPatchTemplates.C.

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

Referenced by fvPatch::patchInternalField(), fvPatch::patchSlice(), movingWallVelocityFvPatchVectorField::updateCoeffs(), and porousBafflePressureFvPatchField< Type >::updateCoeffs().

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

◆ patchField() [2/2]

GeometricField::Patch & patchField ( GeometricField gf) const

Return the corresponding patchField reference of the named field.

Definition at line 80 of file fvPatchTemplates.C.

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

Here is the call graph for this function:

◆ lookupPatchField()

const GeometricField::Patch & lookupPatchField ( const word name,
const GeometricField = nullptr,
const Type *  = nullptr 
) const

◆ operator=()

void operator= ( const fvPatch )

Disallow default bitwise assignment.

Referenced by fvPatch::patchSlice().

Here is the caller graph for this function:

◆ patchInternalField() [3/3]

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

Definition at line 32 of file fvPatchTemplates.C.

References forAll, fvPatch::patchInternalField(), and tmp< T >::ref().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ fvBoundaryMesh

friend class fvBoundaryMesh
friend

Definition at line 90 of file fvPatch.H.

◆ surfaceInterpolation

friend class surfaceInterpolation
friend

Definition at line 91 of file fvPatch.H.


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