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
virtual void	makeWeights (scalarField &) const
virtual void	makeDeltaCoeffs (scalarField &) const
virtual void	makeNonOrthoDeltaCoeffs (scalarField &) const
virtual void	makeNonOrthoCorrVectors (vectorField &) const
virtual void	initMovePoints ()
virtual void	movePoints ()
	TypeName (polyPatch::typeName_())
	declareRunTimeSelectionTable (autoPtr, fvPatch, polyPatch,(const polyPatch &patch, const fvBoundaryMesh &bm),(patch, bm))
	fvPatch (const polyPatch &, const fvBoundaryMesh &)
virtual	~fvPatch ()
const polyPatch &	patch () const
virtual const word &	name () const
virtual label	start () const
virtual label	size () const
virtual bool	coupled () const
label	index () const
const fvBoundaryMesh &	boundaryMesh () const
template<class T >
const List< T >::subList	patchSlice (const List< T > &l) const
virtual const labelUList &	faceCells () const
const vectorField &	Cf () const
tmp< vectorField >	Cn () const
const vectorField &	Sf () const
const scalarField &	magSf () const
tmp< vectorField >	nf () const
virtual tmp< vectorField >	delta () const
const scalarField &	weights () const
const scalarField &	deltaCoeffs () const
template<class Type >
tmp< Field< Type > >	patchInternalField (const UList< Type > &) const
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
template<class GeometricField , class Type >
const GeometricField::Patch &	patchField (const GeometricField &) const
template<class GeometricField , class Type >
const GeometricField::Patch &	lookupPatchField (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< fvPatch >	New (const polyPatch &, const fvBoundaryMesh &)
static const fvPatch &	lookupPatch (const polyPatch &p)
static bool	constraintType (const word &pt)
static wordList	constraintTypes ()

Friends
class	fvBoundaryMesh
class	surfaceInterpolation

Detailed Description

A finiteVolume patch using a polyPatch and a fvBoundaryMesh.

Source files

• fvPatch.H
• fvPatch.C
• fvPatchNew.C

Definition at line 61 of file fvPatch.H.

Member Typedef Documentation

BoundaryMesh

typedef fvBoundaryMesh BoundaryMesh

Definition at line 106 of file fvPatch.H.

Constructor & Destructor Documentation

fvPatch()

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

Definition at line 59 of file fvPatch.C.

~fvPatch()

~fvPatch ( )

virtual

Definition at line 68 of file fvPatch.C.

Member Function Documentation

makeWeights()

void makeWeights ( scalarField &  w ) const

virtual

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

Definition at line 163 of file fvPatch.C.

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

Here is the caller graph for this function:

makeDeltaCoeffs()

void makeDeltaCoeffs ( scalarField &  w ) const

virtual

Reimplemented in mappedVariableThicknessWallFvPatch, and cyclicAMIFvPatch.

Definition at line 169 of file fvPatch.C.

makeNonOrthoDeltaCoeffs()

void makeNonOrthoDeltaCoeffs ( scalarField &  w ) const

virtual

Reimplemented in cyclicAMIFvPatch.

Definition at line 173 of file fvPatch.C.

makeNonOrthoCorrVectors()

void makeNonOrthoCorrVectors ( vectorField &  w ) const

virtual

Reimplemented in cyclicAMIFvPatch.

Definition at line 177 of file fvPatch.C.

initMovePoints()

void initMovePoints ( )

virtual

Definition at line 181 of file fvPatch.C.

movePoints()

void movePoints ( )

virtual

Reimplemented in cyclicACMIFvPatch, and cyclicAMIFvPatch.

Definition at line 185 of file fvPatch.C.

TypeName()

TypeName

(

polyPatch::typeName_()

)

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

Definition at line 28 of file fvPatchNew.C.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

lookupPatch()

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

static

Definition at line 42 of file fvPatch.C.

References fvMesh::boundary(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::nl, and p.

Here is the call graph for this function:

patch()

const polyPatch& patch ( ) const

inline

Definition at line 157 of file fvPatch.H.

Referenced by reconstructedDistanceFunction::constructRDF(), Foam::evaluateConstraintTypes(), mappedVariableThicknessWallFvPatch::makeDeltaCoeffs(), trackingInverseDistance::markBoundaries(), inverseDistance::markBoundaries(), cyclicACMIFvPatch::movePoints(), parseDriver::pointSize(), cyclicACMIFvPatch::resetPatchAreas(), parseDriver::size(), outletMappedUniformInletHeatAdditionFvPatchField::updateCoeffs(), activeBaffleVelocityFvPatchVectorField::updateCoeffs(), activePressureForceBaffleVelocityFvPatchVectorField::updateCoeffs(), and regionSizeDistribution::write().

Here is the caller graph for this function:

name()

virtual const word& name ( ) const

inlinevirtual

Definition at line 163 of file fvPatch.H.

References patchIdentifier::name().

Referenced by fieldExtents::calcFieldExtents(), wallHeatFlux::execute(), meshToMesh0::interpolate(), fvMeshDistribute::testField(), cyclicACMIFvPatch::updateAreas(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), mappedFlowRateFvPatchVectorField::updateCoeffs(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), thermalBaffle1DFvPatchScalarField< solidType >::updateCoeffs(), porousBafflePressureFvPatchField< Type >::updateCoeffs(), humidityTemperatureCoupledMixedFvPatchScalarField::updateCoeffs(), and wallShearStress::write().

Here is the call graph for this function:

Here is the caller graph for this function:

start()

virtual label start ( ) const

inlinevirtual

Definition at line 169 of file fvPatch.H.

References polyPatch::start().

Referenced by CentredFitSnGradData< Polynomial >::calcFit(), extendedFaceToCellStencil::collectData(), extendedCellToFaceStencil::collectData(), inverseFaceDistanceDiffusivity::correct(), inversePointDistanceDiffusivity::correct(), pointLinear< Type >::correction(), dynamicRefineFvMesh::mapFields(), fvMeshAdder::MapSurfaceField(), Foam::oversetAdjustPhi(), fvPatch::patchSlice(), fvMeshDistribute::testField(), mappedVelocityFluxFixedValueFvPatchField::updateCoeffs(), mappedFixedInternalValueFvPatchField< Type >::updateCoeffs(), extendedUpwindCellToFaceStencil::weightedSum(), and extendedCellToFaceStencil::weightedSum().

Here is the call graph for this function:

Here is the caller graph for this function:

size()

virtual label size ( ) const

inlinevirtual

Reimplemented in emptyFvPatch.

Definition at line 175 of file fvPatch.H.

Referenced by boundaryAdjointContribution::adjointTMVariable1Source(), boundaryAdjointContribution::adjointTMVariable2Source(), boundaryAdjointContributionIncompressible::laminarDiffusivity(), boundaryAdjointContributionIncompressible::momentumDiffusion(), fvPatch::patchSlice(), fvPatchMapper::size(), boundaryAdjointContributionIncompressible::thermalDiffusion(), boundaryAdjointContributionIncompressible::TMVariable1(), boundaryAdjointContribution::TMVariable1(), boundaryAdjointContribution::TMVariable1Diffusion(), boundaryAdjointContribution::TMVariable2(), boundaryAdjointContributionIncompressible::TMVariable2(), boundaryAdjointContribution::TMVariable2Diffusion(), liquidFilmBase::Up(), and boundaryAdjointContributionIncompressible::wallDistance().

Here is the caller graph for this function:

coupled()

virtual bool coupled ( ) const

inlinevirtual

Reimplemented in cyclicAMIFvPatch, cyclicACMIFvPatch, processorFvPatch, and coupledFvPatch.

Definition at line 181 of file fvPatch.H.

References polyPatch::coupled().

Here is the call graph for this function:

constraintType()

bool constraintType ( const word &  pt )

static

Definition at line 74 of file fvPatch.C.

References found.

constraintTypes()

Foam::wordList constraintTypes ( )

static

Definition at line 84 of file fvPatch.C.

References forAllConstIters(), and List::setSize().

Here is the call graph for this function:

index()

label index ( ) const

inline

Definition at line 193 of file fvPatch.H.

References patchIdentifier::index().

Referenced by boundaryAdjointContributionIncompressible::laminarDiffusivity(), boundaryAdjointContributionIncompressible::momentumDiffusion(), cyclicAMIFvPatch::movePoints(), boundaryAdjointContributionIncompressible::pab(), boundaryAdjointContributionIncompressible::pb(), boundaryAdjointContributionIncompressible::phiab(), boundaryAdjointContributionIncompressible::phib(), boundaryAdjointContributionIncompressible::pressureSource(), boundaryAdjointContributionIncompressible::tangentVelocitySource(), boundaryAdjointContributionIncompressible::TMVariable1(), boundaryAdjointContributionIncompressible::TMVariable1Diffusion(), boundaryAdjointContributionIncompressible::TMVariable2(), boundaryAdjointContributionIncompressible::TMVariable2Diffusion(), boundaryAdjointContributionIncompressible::turbulentDiffusivity(), boundaryAdjointContributionIncompressible::Uab(), boundaryAdjointContributionIncompressible::Ub(), liquidFilmBase::Up(), energyJumpAMIFvPatchScalarField::updateCoeffs(), energyJumpFvPatchScalarField::updateCoeffs(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), kLowReWallFunctionFvPatchScalarField::updateCoeffs(), velocityFilmShellFvPatchVectorField::updateCoeffs(), liquidFilmBase::Uw(), boundaryAdjointContributionIncompressible::velocitySource(), and boundaryAdjointContributionIncompressible::wallDistance().

Here is the call graph for this function:

Here is the caller graph for this function:

boundaryMesh()

const fvBoundaryMesh& boundaryMesh ( ) const

inline

Definition at line 199 of file fvPatch.H.

Referenced by cyclicAMIFvPatch::coupled(), parseDriver::mesh(), cyclicFvPatch::neighbFvPatch(), cyclicACMIFvPatch::neighbFvPatch(), cyclicAMIFvPatch::neighbFvPatch(), cyclicFvPatch::neighbPatch(), cyclicACMIFvPatch::neighbPatch(), cyclicAMIFvPatch::neighbPatch(), cyclicACMIFvPatch::nonOverlapPatch(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), outletMappedUniformInletHeatAdditionFvPatchField::updateCoeffs(), and porousBafflePressureFvPatchField< Type >::updateCoeffs().

Here is the caller graph for this function:

patchSlice()

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

inline

Definition at line 206 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()

const Foam::labelUList & faceCells ( ) const

virtual

Reimplemented in coupledFvPatch, oversetFvPatch, and emptyFvPatch.

Definition at line 106 of file fvPatch.C.

Referenced by curvatureSeparation::calcCosAngle(), epsilonWallFunctionFvPatchScalarField::calculateTurbulenceFields(), omegaWallFunctionFvPatchScalarField::calculateTurbulenceFields(), inverseFaceDistanceDiffusivity::correct(), inversePointDistanceDiffusivity::correct(), contactAngleForce::correct(), SSG< BasicTurbulenceModel >::correct(), LRR< BasicTurbulenceModel >::correct(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), pointLinear< Type >::correction(), coupledFvPatch::faceCells(), cellVolumeWeight::findHoles(), inverseDistance::findHoles(), trackingInverseDistance::markBoundaries(), inverseDistance::markBoundaries(), cellVolumeWeight::markPatchCells(), Foam::oversetAdjustPhi(), energyJumpAMIFvPatchScalarField::updateCoeffs(), energyJumpFvPatchScalarField::updateCoeffs(), and kLowReWallFunctionFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

Cf()

const Foam::vectorField & Cf

(

)

const

Definition at line 112 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

Definition at line 118 of file fvPatch.C.

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

Here is the call graph for this function:

Sf()

const Foam::vectorField & Sf

(

)

const

Definition at line 143 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

Definition at line 149 of file fvPatch.C.

References boundaryMesh::mesh().

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

Here is the call graph for this function:

Here is the caller graph for this function:

nf()

Foam::tmp< Foam::vectorField > nf

(

)

const

Definition at line 137 of file fvPatch.C.

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

Here is the caller graph for this function:

delta()

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

virtual

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

Definition at line 155 of file fvPatch.C.

weights()

const Foam::scalarField & weights

(

)

const

Definition at line 195 of file fvPatch.C.

References boundaryMesh::mesh().

Here is the call graph for this function:

deltaCoeffs()

const Foam::scalarField & deltaCoeffs

(

)

const

Definition at line 189 of file fvPatch.C.

References boundaryMesh::mesh().

Referenced by contactAngleForce::correct(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::updateCoeffs(), and humidityTemperatureCoupledMixedFvPatchScalarField::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

patchInternalField() [2/5]

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

patchInternalField() [3/5]

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

Definition at line 57 of file fvPatchTemplates.C.

References f(), and forAll.

Here is the call graph for this function:

patchField()

const GeometricField::Patch & patchField

(

const GeometricField &

gf

)

const

Definition at line 75 of file fvPatchTemplates.C.

References GeometricField::boundaryField().

Referenced by porousBafflePressureFvPatchField< Type >::updateCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

lookupPatchField()

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

Definition at line 27 of file fvPatchFvMeshTemplates.C.

References mesh, and Foam::name().

Referenced by semiPermeableBaffleMassFractionFvPatchScalarField::phiY(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), mappedFlowRateFvPatchVectorField::updateCoeffs(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), porousBafflePressureFvPatchField< Type >::updateCoeffs(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::updateCoeffs(), and humidityTemperatureCoupledMixedFvPatchScalarField::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 28 of file fvPatchTemplates.C.

References f().

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 38 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 108 of file fvPatch.H.

surfaceInterpolation

friend class surfaceInterpolation

friend

Definition at line 109 of file fvPatch.H.

---

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

• src/finiteVolume/fvMesh/fvPatches/fvPatch/fvPatch.H
• src/finiteVolume/fvMesh/fvPatches/fvPatch/fvPatch.C
• src/finiteVolume/fvMesh/fvPatches/fvPatch/fvPatchFvMeshTemplates.C
• src/finiteVolume/fvMesh/fvPatches/fvPatch/fvPatchNew.C
• src/finiteVolume/fvMesh/fvPatches/fvPatch/fvPatchTemplates.C