diff --git a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H index b51f472c71..fe50e35cac 100644 --- a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H +++ b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H @@ -37,16 +37,16 @@ Description \f] where - /vartable + \vartable U_p = patch velocity [m/s] U_{Inf} = free stream velocity in the absolute frame [m/s] theta = swept angle [rad] n = axis direction of the SRF U_{p,srf} = SRF velocity of the patch - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H index 890744bc41..71bb989bcd 100644 --- a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H +++ b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H @@ -50,7 +50,7 @@ Description Up = U_in - U_srf \f] - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H index b7163e5bc0..7caa505a8d 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H @@ -32,7 +32,7 @@ Description that the value is assigned via field assignment, and not via a call to e.g. \c updateCoeffs or \c evaluate. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H index 6290d8f5a5..3d00735453 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H @@ -36,19 +36,19 @@ Description \f] where - /vartable + \vartable x_p | patch values x_c | internal field values \nabla(x)| gradient (user-specified) \Delta | inverse distance from patch face centre to cell centre - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value gradient | gradient | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H index 50b986a760..3540c9254c 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H @@ -31,12 +31,12 @@ Description This boundary condition supplies a fixed value constraint, and is the base class for a number of other boundary conditions. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value value | values | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H index 193dd6cb4d..3b1bc57c27 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H @@ -39,14 +39,14 @@ Description \f] where - /vartable + \vartable x_p | patch values x_c | patch internal cell values w | weight field, \c valueFraction_ A | fixed value, \c refValue_ B | patch normal gradient, \c refGrad_ \Delta| inverse distance from face centre to internal cell centre - /endvartable + \endvartable \note This condition is not usually applied directly; instead, use a derived diff --git a/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H index 90f1dc25c6..99038a1240 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H @@ -31,7 +31,7 @@ Description This boundary condition appies a zero-gradient condition from the patch internal field onto the patch faces. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H index 073f5015a4..85a03380f0 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H @@ -36,7 +36,7 @@ Description transformed to the neighbour patch, the patches should be identical (or very similar). - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H index ac2e442921..cef14ae106 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H @@ -37,7 +37,7 @@ Description patch is transformed to the neighbour patch, the outer perimiter of each patch should be identical (or very similar). - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H index 3f77c1f8fc..3c68fe2b36 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H @@ -31,7 +31,7 @@ Description This boundary condition is a light wrapper around the cyclicFvPatchField condition, providing no new functionality. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H index 9f1e8caf01..7b88714619 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H @@ -33,7 +33,7 @@ Description patches whose normal is aligned to geometric directions that do not constitue solution directions. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H index 6278a3567f..a913aaf606 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H @@ -30,7 +30,7 @@ Group Description This boundary condition enables processor communication across patches. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H index 12ad60fcbc..c03236b0da 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H @@ -31,7 +31,7 @@ Description This boundary condition enables processor communication across cyclic patches. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.H index 26fa081eb7..a5812c09b4 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.H @@ -30,7 +30,7 @@ Group Description This boundary condition enforces a symmetry constraint - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H index de4072625b..6ab1a7f081 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H @@ -31,7 +31,7 @@ Description This boundary condition is similar to the cyclic condition, except that it is applied to 2-D geometries. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H index 08423e848f..1c3dfa4dd4 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H @@ -44,19 +44,19 @@ Description where - /vartable + \vartable x | baffle open fraction [0-1] x_{old} | baffle open fraction on previous evaluation dt | simulation time step DT | time taken to open the baffle F_{net} | net force across the baffle - /endvartable + \endvartable The open fraction is then applied to scale the patch areas. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value p | pressure field name | no | p cyclicPatch | cylclic patch name | yes | @@ -64,7 +64,7 @@ Description openFraction | current opatch open fraction [0-1]| yes | openingTime | time taken to open the baffle | yes | maxOpenFractionDelta | max open fraction change per timestep | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H index 0957852428..c313f296fe 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H @@ -44,18 +44,18 @@ Description where - /vartable + \vartable x | baffle open fraction [0-1] x_{old} | baffle open fraction on previous evaluation dt | simulation time step DT | time taken to open the baffle - /endvartable + \endvartable The open fraction is then applied to scale the patch areas. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value p | pressure field name | no | p cyclicPatch | cylclic patch name | yes | @@ -65,7 +65,7 @@ Description maxOpenFractionDelta | max open fraction change per timestep | yes | minThresholdValue | minimum open fraction for activation | yes | forceBased | force (true) or pressure-based (false) activation | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H index b5f143acac..305beeaced 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H @@ -48,15 +48,15 @@ Description the flow-speed plus the acoustic wave speed creating an acoustic wave transmissive boundary condition. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi rho | density field name | no | rho fieldInf | value of field beyond patch | no | lInf | distance beyond patch for \c fieldInf | no | - /endtable + \endtable \note If \c lInf is specified, \c fieldInf will be required; \c rho is only diff --git a/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H index 39e59bfcc6..19b7930b86 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H @@ -43,11 +43,11 @@ Description where - /vartable + \vartable \rho | density [kg/m3] g | acceleration due to gravity [m/s2] h | patch face centres [m] - /endvartable + \endvartable Otherwise we assume that it is the static pressure, and the gradient calculated using: @@ -56,16 +56,16 @@ Description \f] where - /vartable + \vartable n | patch face normal vectors - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value rho | density field name | no | rho - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H index 04c2562f49..ba32afbd63 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H @@ -31,7 +31,7 @@ Description Constructs on-the-fly a new boundary condition (derived from fixedValueFvPatchField) which is then used to evaluate. - /heading Patch usage + \heading Patch usage Example: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H index e35c4af2c3..c631b20b86 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H @@ -31,7 +31,7 @@ Description Constructs on-the-fly a new boundary condition (derived from mixedFvPatchField) which is then used to evaluate. - /heading Patch usage + \heading Patch usage Example: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H index 6ffa995cde..482b365f2a 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H @@ -32,16 +32,16 @@ Description cylindrical co-ordinates given a central axis, central point, rpm, axial and radial velocity. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value axis | axis of rotation | yes | centre | centre of rotation | yes | axialVelocity | axial velocity profile [m/s] | yes | radialVelocity | radial velocity profile [m/s] | yes | rpm | rotational speed (revolutions per minute) | yes| - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H index bb0f3574c7..be28d24448 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H @@ -34,14 +34,14 @@ Description The jump is specified as a \c DataEntry type, to enable the use of, e.g. contant, polynomial, table values. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value patchType | underlying patch type should be \c cyclic| yes | jump | current jump value | yes | jumpTable | jump data, e.g. \c csvFile | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H index 5bc8a2281c..de9f6fb701 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H @@ -41,21 +41,21 @@ Description where - /vartable + \vartable phi | flux D_p | pressure diffusivity Sf | patch face areas [m2] - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phiHbyA | name of predicted flux field | no | phiHbyA phi | name of flux field | no | phi rho | name of density field | no | rho Dp | name of pressure diffusivity field | no | Dp - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H index 868a333565..2fdd5f71b4 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H @@ -32,7 +32,7 @@ Description directly into a matrix, i.e. to set a constraint condition. Default behaviour is to act as a zero gradient condition. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H index bce30465cd..ed31cfb998 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H @@ -31,12 +31,12 @@ Description This boundary condition extrapolates field to the patch using the near-cell values and adjusts the distribution to match the specified mean value. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value meanValue | mean value | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H index 21e4ae88ea..bbaf0a257b 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H @@ -30,12 +30,12 @@ Group Description This boundary condition sets the patch-normal component to a fixed value. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value fixedValue | fixed value | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H index 5f0cf8c403..47aab74d5c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H @@ -37,23 +37,23 @@ Description where - /vartable + \vartable \rho | density [kg/m3] \rho_{l,sat} | saturation liquid density [kg/m3] \psi_l | liquid compressibility p | pressure [Pa] p_{sat} | saturation pressure [Pa] - /endvartable + \endvartable The variables \c rholSat, \c pSat and \c psil are retrieved from the \c thermodynamicProperties dictionary. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value p | pressure field name | no | p - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H index dac06b8ba8..f15d4e666a 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H @@ -43,12 +43,12 @@ Description For a volumetric-based flux: - the flow rate is in m3/s - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value flowRate | volumetric [m3/s] OR mass flow rate [kg/s] | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H index 9e9e6b638e..059c3addfd 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H @@ -38,21 +38,21 @@ Description where - /vartable + \vartable U_p | velocity at the patch [m/s] U_c | velocity in cells adjacent to the patch [m/s] n | patch normal vectors \phi_p | flux at the patch [m3/s or kg/s] Sf | patch face area vectors [m2] - /endvartable + \endvartable where - /table + \table Property | Description | Required | Default value phi | name of flux field | no | phi rho | name of density field | no | rho - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H index 57373b69cb..adcb570f93 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H @@ -33,12 +33,12 @@ Description operation switches between fixed (free stream) value and zero gradient based on the sign of the flux. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H index 28eedd1752..ae082c5da3 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H @@ -32,7 +32,7 @@ Description It is a zero-gradient condition that constrains the flux across the patch based on the free-stream velocity. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H index 449f4e8631..d97e6eb817 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H @@ -31,13 +31,13 @@ Description This boundary condition provides a generic outflow condition, with specified inflow for the case of return flow. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi inletValue | inlet value for reverse flow | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H index d6487efc93..430ee1e51f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H @@ -32,9 +32,9 @@ Description temperature for use with supersonic cases, where a user-specified value is applied in the case of reverse flow. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value U | velocity field name | no | U phi | flux field name | no | phi @@ -42,7 +42,7 @@ Description gamma | heat capacity ration (Cp/Cv) | yes | inletValue | reverse flow (inlet) value | yes | T0 | static temperature [K] | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H index 554f4ef868..bb413a141c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H @@ -32,14 +32,14 @@ Description condition. It does not use information on the patch; instead it holds thr data locally. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value fieldName | name of field to be mapped | no | this field name setAverage | flag to activate setting of average value | yes | average | average value to apply if \c setAverage = yes | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H index 30dd2f27b9..dbf6595879 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H @@ -31,14 +31,14 @@ Description This boundary condition maps the boundary and internal values of a neighbour patch field to the boundary and internal values of *this. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value fieldName | name of field to be mapped | no | this field name setAverage | flag to activate setting of average value | yes | average | average value to apply if \c setAverage = yes | yes | - /endtable + \endtable \verbatim myPatch diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H index 45ee30032d..18884da980 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H @@ -31,14 +31,14 @@ Description This boundary condition maps the boundary values of a neighbour patch field to the boundary and internal cell values of *this. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value fieldName | name of field to be mapped | no | this field name setAverage | flag to activate setting of average value | yes | average | average value to apply if \c setAverage = yes | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H index 4fc5f332dd..672889d325 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H @@ -34,15 +34,15 @@ Description The sample mode is set by the underlying mapping engine, provided by the mappedPatchBase class. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value fieldName | name of field to be mapped | no | this field name setAverage | flag to activate setting of average value | yes | average | average value to apply if \c setAverage = yes | yes | interpolationScheme | type of interpolation scheme | no | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H index 76b5726e6e..cb06375c10 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H @@ -37,14 +37,14 @@ Description dimensions of the flux, phi. The current density is used to correct the velocity when applying the mass basis. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi rho | density field name | no | rho neigPhi | name of flux field on neighbour mesh | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H index 175d2cd386..a160e2c292 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H @@ -31,12 +31,12 @@ Description This boundary condition maps the velocity and flux from a neighbour patch to this patch - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H index e4706c3d37..be5b50e6f8 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H @@ -33,12 +33,12 @@ Description for moving reference frame (MRF) calculations. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value U | velociy field name | no | U - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H index cf2b0c95b4..f71feaa1e3 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H @@ -41,21 +41,21 @@ Description where - /vartable + \vartable \phi | flux Dp | pressure diffusivity Sf | patch face areas [m2] - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phiHbyA | name of predicted flux field | no | phiHbyA phi | name of flux field | no | phi rho | name of density field | no | rho Dp | name of pressure diffusivity field | no | Dp - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H index e134124954..af8ac75a74 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H @@ -37,24 +37,24 @@ Description where - /vartable + \vartable x_p | patch values x_{ref} | patch reference values x_o | patch offset values a | amplitude f | frequency [1/s] t | time [s] - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value refValue | reference value | yes | offset | offset value | no | 0.0; // optional amplitude | oscillation amplitude | yes | frequency | oscillation frequency | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H index a26db47e41..53d47a3592 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H @@ -31,13 +31,13 @@ Description This boundary condition provides a generic inflow condition, with specified outflow for the case of return flow. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi inletValue | inlet value | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H index 8098a68b7e..059faeab09 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H @@ -32,13 +32,13 @@ Description by name "outletPatchName" and applies this as the uniform value of the field over this patch. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value outletPatchName | name of outlet patch | yes | phi | flux field name | no | phi - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H index 8d081efa06..b4fd5e7ce7 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H @@ -31,12 +31,12 @@ Description This boundary condition provides a partial slip condition. The amount of slip is controlled by a user-supplied field. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value valueFraction | fraction od value used for boundary [0-1] | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H index 0cdc4650f5..cb0c472da4 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H @@ -36,27 +36,27 @@ Description \f] where - /vartable + \vartable p_{hyd} | hyrostatic pressure [Pa] p_{ref} | reference pressure [Pa] x_{ref} | reference point in Cartesian co-ordinates \rho | density (assumed uniform) g | acceleration due to gravity [m/s2] - /endtable + \endtable The values are assigned according to the phase-fraction field: - 1: apply \$fp_{hyd}\$f - 0: apply a zero-gradient condition - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phaseName | phase field name | no | alpha rho | density field name | no | rho pRefValue | reference pressure [Pa] | yes | pRefPoint | reference pressure location | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H index c6e2a8c0c5..d12d390ea1 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H @@ -33,14 +33,14 @@ Description applied for outflow (as defined by the flux); for inflow, the velocity is obtained from the flux with the specified inlet direction. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi rho | density field name | no | rho inletDirection | inlet direction per patch face | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H index 47cfd0e22a..a7ea670a9b 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H @@ -32,14 +32,14 @@ Description pressure is specified. The inflow velocity is obtained from the flux with the specified inlet direction" direction. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi rho | density field name | no | rho inletDirection | inlet direction per patch face | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H index 128dc1ec26..7fbb307d04 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H @@ -35,13 +35,13 @@ Description A slip condition is applied tangential to the patch. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi rho | density field name | no | rho - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H index a162c6d254..36680dd7d8 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H @@ -35,13 +35,13 @@ Description The tangential patch velocity can be optionally specified. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi tangentialVelocity | tangential velocity field | no | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H index 56750ed091..d22757c672 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H @@ -33,7 +33,7 @@ Description averaging the flux over the patch, and then applying it in the direction normal to the patch faces. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H index 13bc501b21..2ea77ceeff 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H @@ -32,7 +32,7 @@ Description pressure is specified. The inflow velocity is obtained from the flux with a direction normal to the patch faces. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H index 86ef8bc4e4..3df7b5ed9a 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H @@ -33,13 +33,13 @@ Description outflow (as defined by the flux); for inflow, the velocity is obtained from the flux with a direction normal to the patch faces. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi rho | density field name | no | rho - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H index a48f2c3782..5a95fa75bf 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H @@ -33,14 +33,14 @@ Description for outflow (as defined by the flux); for inflow, the velocity is obtained from the flux with a direction normal to the patch faces. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi tangentialVelocity | tangential velocity field | no | omega | angular velocty of the frame [rad/s] | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H index c3000b4f15..22d806c377 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H @@ -31,9 +31,9 @@ Description This boundary condition provides a total pressure condition for patches in a rotating frame. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value U | velocity field name | no | U phi | flux field name | no | phi @@ -42,7 +42,7 @@ Description gamma | ratio of specific heats (Cp/Cv) | yes | p0 | static pressure reference | yes | omega | angular velocty of the frame [rad/s] | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H index 5d7ae1dd7d..a3d5d5686e 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H @@ -30,14 +30,14 @@ Group Description This boundary condition provides a rotational velocity condition. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value origin | origin of rotation in Cartesian co-ordinates | yes| axis | axis of rotation | yes | omega | angular velocty of the frame [rad/s] | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H index 1d936aa811..ee50d19881 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H @@ -30,7 +30,7 @@ Group Description This boundary condition provides a slip constraint. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H index e614212296..ca013bb04c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H @@ -36,15 +36,15 @@ Description - subsonic outflow is applied via a zero-gradient condition from inside the domain. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value UInf | free-stream velocity | yes | pInf | free-stream pressure | yes | TInf | free-stream temperature | yes | gamma | heat capacity ratio (cp/Cv) | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H index 71200d9512..5906f790a6 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H @@ -31,12 +31,12 @@ Description This boundary condition provides a surface-normal vector boundary condition by its magnitude. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value refValue | reference value | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H index d827e8cd46..307d9486a6 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H @@ -37,15 +37,15 @@ Description dimensions of the flux, phi. The current density is used to correct the velocity when applying the mass basis. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi rho | density field name | no | rho flowRate | flow rate profile | yes | rpm | rotational speed profile | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H index 8fe219d412..c4dc0a1e4f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H @@ -37,9 +37,9 @@ Description pressure and compressibility which is assumed constant, i.e. isothermal expansion/compression. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value Ap | syringe piston area [m2] | yes | Sp | syringe piston speed [m/s] | yes | @@ -51,7 +51,7 @@ Description psI | initial syringe pressure [Pa] | yes | psi | gas compressibility [m2/s2] | yes | ams | added (or removed) gas mass [kg] | yes | - /endtable + \endtable Example of the BC specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H index 28719fd964..d788f543be 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H @@ -34,14 +34,14 @@ Description The jump is specified as a \c DataEntry type, to enable the use of, e.g. contant, polynomial, table values. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value patchType | underlying patch type should be \c cyclic| yes | jump | current jump value | yes | jumpTable | jump data, e.g. \c csvFile | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H index e6dc3fdc2b..86a8029cdf 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H @@ -42,14 +42,14 @@ Description Values are interpolated linearly between times. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value setAverage | flag to activate setting of average value | yes | perturb | perturb points for regular geometries | no | 1e-5 fieldTableName | alternative field name to sample | no| this field name - /endtable + \endtable /verbatim myPatch diff --git a/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H index a98adc9910..dd49014a32 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H @@ -36,62 +36,62 @@ Description p_T = p_0 + 0.5 |U|^2 \f] where - /vartable + \vartable p_T | incompressible total pressure [m2/s2] p_0 | incompressible reference pressure [m2/s2] U | velocity - /endvartable + \endvartable 2. compressible subsonic: \f[ p_T = p_0 + 0.5 \rho |U|^2 \f] where - /vartable + \vartable p_T | total pressure [Pa] p_0 | reference pressure [Pa] \rho | density [kg/m3] U | velocity - /endvartable + \endvartable 3. compressible transonic (\gamma <= 1): \f[ p_T = \frac{p_0}{1 + 0.5 \psi |U|^2} \f] where - /vartable + \vartable p_T | total pressure [Pa] p_0 | reference pressure [Pa] G | coefficient given by \f$\frac{\gamma}{1-\gamma}\f$ - /endvartable + \endvartable 4. compressible supersonic (\gamma > 1): \f[ p_T = \frac{p_0}{(1 + 0.5 \psi G)^{\frac{1}{G}}} \f] where - /vartable + \vartable \gamma | ratio of specific heats (Cp/Cv) p_T | total pressure [Pa] p_0 | reference pressure [Pa] \psi | compressibility [m2/s2] G | coefficient given by \f$\frac{\gamma}{1-\gamma}\f$ - /endvartable + \endvartable The modes of operation are set via the combination of \c phi, \c rho, and \c psi entries: - /table + \table Mode | phi | rho | psi incompressible subsonic | phi | none | none compressible subsonic | phi | rho | none compressible transonic | phi | none | psi compressible supersonic | phi | none | psi - /endtable + \endtable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value U | velocity field name | no | U phi | flux field name | no | phi @@ -99,7 +99,7 @@ Description psi | compressibility field name | no | none gamma | ratio of specific heats (Cp/Cv) | yes | p0 | static pressure reference | yes | - /endtable + \endtable \note The default boundary behaviour is for subsonic, incompressible flow. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H index 465b02d370..d793696ade 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H @@ -30,16 +30,16 @@ Group Description This boundary condition provides a total temperature condition. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value U | Velocity field name | no | U phi | Flux field name | no | phi psi | Compressibility field name | no | psi gamma | ratio of specific heats (Cp/Cv) | yes | T0 | reference temperature | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H index 821a6e36b5..d32a1ba460 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H @@ -31,12 +31,12 @@ Description This boundary condition provides a velocity condition for translational motion on walls. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value U | translational velocity | yes| - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H index 8f30d3a6cc..3917d167bd 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H @@ -37,23 +37,23 @@ Description where - /vartable + \vartable x_p | patch values x_{ref} | refernce patch values n | time level \alpha | fraction of new random component added to previous time value C_{RMS} | RMS coefficient s | fluctuation scale - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value fluctuationScale | RMS fluctuation scale (fraction of mean) | yes | referenceField | reference (mean) field | yes | alpha | fraction of new random component added to previous| no| 0.1 - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H index b7acbae470..b2d1f2123e 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H @@ -38,22 +38,22 @@ Description where - /vartable + \vartable k_p | kinetic energy at the patch I | turbulence intensity U | velocity field - /endvartable + \endvartable In the event of reverse flow, a zero-gradient condition is applied. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value intensity | fraction of mean field [0-1] | yes | U | velocity field name | no | U phi | flux field name | no | phi - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H index 4c162ec16a..ff3c925863 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H @@ -36,22 +36,22 @@ Description \f] where - /vartable + \vartable p_{hyd} | hyrostatic pressure [Pa] p_{ref} | reference pressure [Pa] x_{ref} | reference point in Cartesian co-ordinates \rho | density (assumed uniform) g | acceleration due to gravity [m/s2] - /endtable + \endtable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value rho | uniform density [kg/m3] | yes | pRefValue | reference pressure [Pa] | yes | pRefPoint | reference pressure location | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H index 38a13d398d..3b09b75a4c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H @@ -30,12 +30,12 @@ Group Description This boundary condition provides a uniform fixed value condition. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value uniformValue | uniform value | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H index a23db5daa2..46f81be514 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H @@ -31,9 +31,9 @@ Description This boundary condition provides a time-varying form of the uniform total pressure boundary condition. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value U | velocity field name | no | U phi | flux field name | no | phi @@ -42,7 +42,7 @@ Description gamma | ratio of specific heats (Cp/Cv) | yes | p0 | static pressure reference | yes | pressure | total pressure as a function of time | yes | - /endtable + \endtable \note The default boundary behaviour is for subsonic, incompressible flow. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H index 67faf746de..858dd6c1ce 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H @@ -41,14 +41,14 @@ Description if alpha < lowerBound: - apply a fixed value condition, with a uniform level of the lower bound - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi lowerBound | lower bound for clipping | yes | upperBound | upper bound for clipping | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H index f14dc5c1b5..c4322d6a57 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H @@ -34,12 +34,12 @@ Description The flow rate is made proportional to the phase fraction alpha at each face of the patch and alpha is ensured to be bound between 0 and 1. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value flowRate | volumetric flow rate [m3/s] | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H index 1687542e49..3babe28eff 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H @@ -35,23 +35,23 @@ Description p = -\rho*g*\zeta \f] - /vartable + \vartable \rho | density [kg/m3] g | acceleration due to gravity [m/s2] \zeta | wave amplitude [m] - /endvartable + \endvartable The wave amplitude is updated as part of the calculation, derived from the local volumetric flux. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi rho | density field name | no | rho zeta | wave amplitude field name | no | zeta - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H index 9940415bce..9ff79884d6 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H @@ -39,23 +39,23 @@ Description where - /vartable + \vartable x_p | patch values \phi_p | patch face flux \psi_p | patch compressibility Sf | patch face area vector \gamma | ratio of specific heats - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | flux field name | no | phi rho | density field name | no | rho psi | compressibility field name | no | psi gamma | ratio of specific heats (Cp/Cv) | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox b/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox index d89698dc9a..72a3078da4 100644 --- a/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox +++ b/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox @@ -58,31 +58,31 @@ Wall functions for compressible flow \section secBoundaryConditions Typical usage for pressure-velocity systems subsonic inlet (flow specified): -/table +\table Variable | Symbol | Type pressure | p | \link Foam::zeroGradientFvPatchField zeroGradient\endlink velocity | U | \link Foam::fixedValueFvPatchField fixedValue\endlink transported property | - | \link Foam::fixedValueFvPatchField fixedValue\endlink derived property | - | \link Foam::calculatedFvPatchField calculated\endlink or \link Foam::zeroGradientFvPatchField zeroGradient\endlink -/endtable +\endtable subsonic outlet: -/table +\table Variable | Symbol | Type pressure | p | \link Foam::fixedValueFvPatchField fixedValue\endlink velocity | U | \link Foam::inletOutletFvPatchField inletOutlet\endlink or \link Foam::pressureInletOutletVelocityFvPatchVectorField pressureInletOutletVelocity\endlink transported property | - | \link Foam::inletOutletFvPatchField inletOutlet\endlink derived property | - | \link Foam::calculatedFvPatchField calculated\endlink or \link Foam::zeroGradientFvPatchField zeroGradient\endlink -/endtable +\endtable wall: -/table +\table Variable | Symbol | Type pressure | p | \link Foam::zeroGradientFvPatchField zeroGradient\endlink velocity | U | \link Foam::fixedValueFvPatchField fixedValue\endlink transported property | - | \link Foam::fixedValueFvPatchField fixedValue\endlink derived property | - | \link Foam::calculatedFvPatchField calculated\endlink or \link Foam::zeroGradientFvPatchField zeroGradient\endlink -/endtable +\endtable \*---------------------------------------------------------------------------*/ diff --git a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H index 16e7e0db1f..98b8f49808 100644 --- a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H +++ b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H @@ -38,23 +38,23 @@ Description \f] where - /vartable + \vartable U_p | patch velocity [m/s] n | patch normal vector \phi | mass flux [kg/s] \rho | density [kg/m3] Sf | patch face area vectors [m2] \delta | film height [m] - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value phi | Flux field name | no | phi rho | density field name | no | rho deltaf | height field name | no | deltaf - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H index fd8ef90041..de61d62b94 100644 --- a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H +++ b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H @@ -33,16 +33,16 @@ Description condition varies from the standard wall function by taking into account any mass released from the film model. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value B | model coefficient | no | 5.5 yPlusCrit | critical y+ for transition to turbulent flow | no|11.05 Cmu | model coefficient | no | 0.09 kappa | Von-Karman constant | no | 0.41 Prt | turbulent Prandtl number | no | 0.85 - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/mutkFilmWallFunction/mutkFilmWallFunctionFvPatchScalarField.H b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/mutkFilmWallFunction/mutkFilmWallFunctionFvPatchScalarField.H index 1370214146..7e7a2a99f8 100644 --- a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/mutkFilmWallFunction/mutkFilmWallFunctionFvPatchScalarField.H +++ b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/mutkFilmWallFunction/mutkFilmWallFunctionFvPatchScalarField.H @@ -32,7 +32,7 @@ Description using wall functions, based on turbulence kinetic energy, for use with surface film models. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJumpFvPatchScalarField.H b/src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJumpFvPatchScalarField.H index 806c33e6c3..aae2d9597b 100644 --- a/src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJumpFvPatchScalarField.H +++ b/src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJumpFvPatchScalarField.H @@ -31,12 +31,12 @@ Description This boundary condition provides an energy jump condition across a pair of coupled patches. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value jump | energy jump values | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/fixedEnergy/fixedEnergyFvPatchScalarField.H b/src/thermophysicalModels/basic/derivedFvPatchFields/fixedEnergy/fixedEnergyFvPatchScalarField.H index a86577d02a..b37cb57e49 100644 --- a/src/thermophysicalModels/basic/derivedFvPatchFields/fixedEnergy/fixedEnergyFvPatchScalarField.H +++ b/src/thermophysicalModels/basic/derivedFvPatchFields/fixedEnergy/fixedEnergyFvPatchScalarField.H @@ -30,7 +30,7 @@ Group Description This boundary condition provides a fixed condition for internal energy - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H b/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H index 074a8b2f80..2ee94c08cc 100644 --- a/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H +++ b/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H @@ -30,7 +30,7 @@ Group Description This boundary condition provides a gradient condition for internal energy - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim myPatch diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/wallHeatTransfer/wallHeatTransferFvPatchScalarField.H b/src/thermophysicalModels/basic/derivedFvPatchFields/wallHeatTransfer/wallHeatTransferFvPatchScalarField.H index 8661df5c61..da2ab661ef 100644 --- a/src/thermophysicalModels/basic/derivedFvPatchFields/wallHeatTransfer/wallHeatTransferFvPatchScalarField.H +++ b/src/thermophysicalModels/basic/derivedFvPatchFields/wallHeatTransfer/wallHeatTransferFvPatchScalarField.H @@ -31,13 +31,13 @@ Description This boundary condition provides an enthalpy condition for wall heat transfer - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value Tinf | wall temperature | yes | alphaWall | thermal diffusivity | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H index 5d9de5c213..53506a5ed4 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H @@ -34,12 +34,12 @@ Description The radiation temperature is retrieved from the mesh database, using a user specified temperature field name. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value T | temperature field name | no | T - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H index b2b913c763..646b0ca267 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H @@ -34,12 +34,12 @@ Description The radiation temperature field across the patch is supplied by the user using the \c Trad entry. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value T | temperature field name | no | T - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H index cdd4b09a05..f1a38077e0 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H @@ -33,13 +33,13 @@ Description (fvDOM), in which the radiation temperature is retrieved from the temperature field boundary condition. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value T | temperature field name | no | T emissivityMode | emissivity mode: solidThermo or lookup | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveViewFactor/greyDiffusiveViewFactorFixedValueFvPatchScalarField.H b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveViewFactor/greyDiffusiveViewFactorFixedValueFvPatchScalarField.H index 3197e50c2e..3dff551ee7 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveViewFactor/greyDiffusiveViewFactorFixedValueFvPatchScalarField.H +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveViewFactor/greyDiffusiveViewFactorFixedValueFvPatchScalarField.H @@ -31,13 +31,13 @@ Description This boundary condition provides a grey-diffuse condition for radiative heat flux, \c Qr, for use with the view factor model - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value Qro | external radiative heat flux | yes | emissivityMode | emissivity mode: solidThermo or lookup | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H index f23cd3e6e2..8019e61017 100644 --- a/src/thermophysicalModels/radiationModels/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H +++ b/src/thermophysicalModels/radiationModels/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H @@ -31,7 +31,7 @@ Description This boundary condition provides a wide-band, diffusive radiation condition, where the patch temperature is specified. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H index e2dedbb2f5..aaaee1c650 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H @@ -42,20 +42,20 @@ Description where - /vartable + \vartable htc_p | patch convective heat transfer coefficient Re | Reynolds number Pr | Prandtl number \kappa_p | thermal conductivity L | length scale - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value L | Length scale [m] | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H index 9f827b8745..a55997915c 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H @@ -39,24 +39,24 @@ Description where - /vartable + \vartable \epsilon_p | patch epsilon values C_{\mu} | Model coefficient, set to 0.09 k | turbulence kinetic energy L | length scale - /endvartable + \endvartable \note In the event of reverse flow, a zero-gradient condition is applied - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value mixingLength | Length scale [m] | yes | phi | flux field name | no | phi k | turbulence kinetic energy field name | no | k - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H index 539d5f892d..68f2a00884 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H @@ -38,24 +38,24 @@ Description where - /vartable + \vartable \omega_p | patch omega values C_{\mu} | Model coefficient, set to 0.09 k | turbulence kinetic energy L | length scale - /endvartable + \endvartable \note In the event of reverse flow, a zero-gradient condition is applied - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value mixingLength | Length scale [m] | yes | phi | flux field name | no | phi k | turbulence kinetic energy field name | no | k - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H index b098ffca89..0998193046 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H @@ -31,15 +31,15 @@ Description This boundary condition provides a thermal wall function for turbulent thermal diffusivity (usually\c alphat) based on the Jayatilleke model. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value Prt | turbulent Prandtl number | no | 0.85 Cmu | model coefficient | no | 0.09 kappa | Von Karman constant | no | 0.41 E | model coefficient | no | 9.8 - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H index 41d9abbfd3..c9031e53ed 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H @@ -40,19 +40,19 @@ Description where - /vartable + \vartable \alpha_t| turblence thermal diffusivity \mu_t | turblence viscosity Pr_t | turblent Prandtl number - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value mut | turbulence viscosity field name | no | mut Prt | turbulent Prandtl number | no | 0.85 - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H index 515b605403..24172ea21e 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H @@ -38,20 +38,20 @@ Description where - /vartable + \vartable epsilon | turblence dissipation field G | turblence generation field - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value G | turbulence generation field name | no | G Cmu | model coefficient | no | 0.09 kappa | Von Karman constant | no | 0.41 E | model coefficient | no | 9.8 - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H index 95953977da..3ce69d19c0 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H @@ -31,7 +31,7 @@ Description This boundary condition is applied to turbulence \c k, \c q, and \c R when using wall functions, and simply enforces a zero-gradient condition. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutLowReWallFunction/mutLowReWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutLowReWallFunction/mutLowReWallFunctionFvPatchScalarField.H index 886eb0ef7c..2cbbef359c 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutLowReWallFunction/mutLowReWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutLowReWallFunction/mutLowReWallFunctionFvPatchScalarField.H @@ -32,7 +32,7 @@ Description with low Reynolds number models. It sets \c nut to zero, and provides an access function to calculate y+. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutURoughWallFunction/mutURoughWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutURoughWallFunction/mutURoughWallFunctionFvPatchScalarField.H index 8174270466..ee89a45f6c 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutURoughWallFunction/mutURoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutURoughWallFunction/mutURoughWallFunctionFvPatchScalarField.H @@ -31,14 +31,14 @@ Description This boundary condition provides a turbulent viscosity condition when using wall functions for rough walls, based on velocity. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value roughnessHeight | roughness height | yes | roughnessConstant | roughness constanr | yes | roughnessFactor | scaling factor | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUSpaldingWallFunction/mutUSpaldingWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUSpaldingWallFunction/mutUSpaldingWallFunctionFvPatchScalarField.H index 0060806b6b..4eeefb74cc 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUSpaldingWallFunction/mutUSpaldingWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUSpaldingWallFunction/mutUSpaldingWallFunctionFvPatchScalarField.H @@ -32,7 +32,7 @@ Description using wall functions for rough walls, based on velocity, using Spaldings law to give a continuous nut profile to the wall (y+ = 0) - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUWallFunction/mutUWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUWallFunction/mutUWallFunctionFvPatchScalarField.H index 8f9d1becf4..08a938b52c 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUWallFunction/mutUWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUWallFunction/mutUWallFunctionFvPatchScalarField.H @@ -31,7 +31,7 @@ Description This boundary condition provides a turbulent viscosity condition when using wall functions, based on velocity. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutWallFunction/mutWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutWallFunction/mutWallFunctionFvPatchScalarField.H index a3f1f6db2f..9228b60924 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutWallFunction/mutWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutWallFunction/mutWallFunctionFvPatchScalarField.H @@ -32,7 +32,7 @@ Description using wall functions, based on turbulence kinetic energy. - replicates OpenFOAM v1.5 (and earlier) behaviour - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkRoughWallFunction/mutkRoughWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkRoughWallFunction/mutkRoughWallFunctionFvPatchScalarField.H index 13dbc72121..8daa978a22 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkRoughWallFunction/mutkRoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkRoughWallFunction/mutkRoughWallFunctionFvPatchScalarField.H @@ -37,13 +37,13 @@ Description - roughness height = sand-grain roughness (0 for smooth walls) - roughness constant = 0.5-1.0 - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value Ks | sand-grain roughness height | yes | Cs | roughness constant | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkWallFunction/mutkWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkWallFunction/mutkWallFunctionFvPatchScalarField.H index 400a300a55..8d952a6428 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkWallFunction/mutkWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkWallFunction/mutkWallFunctionFvPatchScalarField.H @@ -32,7 +32,7 @@ Description using wall functions, based on turbulence kinetic energy. - replicates OpenFOAM v1.5 (and earlier) behaviour - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H index 63fd4823e8..d6516c5449 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H @@ -37,10 +37,10 @@ Description where - /vartable + \vartable \omega_{vis} | omega in viscous region \omega_{log} | omega in logarithmic region - /endvartable + \endvartable Model described by Eq.(15) of: \verbatim @@ -50,16 +50,16 @@ Description Nov. 2001 \endverbatim - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value G | turbulence generation field name | no | G Cmu | model coefficient | no | 0.09 kappa | Von Karman constant | no | 0.41 E | model coefficient | no | 9.8 beta1 | model coefficient | no | 0.075 - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.H b/src/turbulenceModels/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.H index 13b16e86d2..e8d9cc0376 100644 --- a/src/turbulenceModels/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.H +++ b/src/turbulenceModels/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.H @@ -25,6 +25,8 @@ License Class Foam::fixedShearStressFvPatchVectorField +Group grpWallBoundaryConditions + Description Set a constant shear stress as tau0 = -nuEff dU/dn. diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H index 2dc42c3f02..10e6691933 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H @@ -38,13 +38,13 @@ Description \f] where - /vartable + \vartable U^* | frictional velocity K | Karman's constant z | vertical co-ordinate [m] z_0 | surface roughness length [m] z_g | minimum vlaue in z direction [m] - /endvartable + \endvartable and: @@ -53,14 +53,14 @@ Description \f] where: - /vartable + \vartable U_{ref} | reference velocity at \f$Z_{ref}\f$ [m/s] Z_{ref} | reference height [m] - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value z | vertical co-ordinate [m] | yes | kappa | Karman's constanat | no | 0.41 @@ -68,7 +68,7 @@ Description Href | reference height [m] | yes | z0 | surface roughness length [m] | yes | zGround | minimum z co-ordinate [m] | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H index 327e68d3bd..79b3dc08b6 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H @@ -38,13 +38,13 @@ Description \f] where - /vartable + \vartable U^* | frictional velocity K | Karman's constant z | vertical co-ordinate [m] z_0 | surface roughness length [m] z_g | minimum vlaue in z direction [m] - /endvartable + \endvartable and: @@ -53,10 +53,10 @@ Description \f] where: - /vartable + \vartable U_{ref} | reference velocity at \f$Z_{ref}\f$ [m/s] Z_{ref} | reference height [m] - /endvartable + \endvartable Reference: D.M. Hargreaves and N.G. Wright, "On the use of the k-epsilon model @@ -70,9 +70,9 @@ Description The roughness height (Er) is given by Er = 20 z0 following the same reference. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value n | flow direction | yes | z | vertical co-ordinate [m] | yes | @@ -81,7 +81,7 @@ Description Href | reference height [m] | yes | z0 | surface roughness length [m] | yes | zGround | minimum z co-ordinate [m] | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H index cde69f91f0..6e686dfbdd 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H @@ -32,14 +32,14 @@ Description heat source either specified in terms of an absolute power [W], or as a flux [W/m2]. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value heatSource | heat source type: \c flux [W/m2] or \c power [W]| yes | q | heat source value | yea | alphaEff | turbulent thermal diffusivity field name | yes | - /endtable + \endtable \note - it is assumed that the units of \c alphaEff are [kg/m/s] diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H index a9cce6cbd8..6f812db1e6 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H @@ -39,24 +39,24 @@ Description where - /vartable + \vartable \epsilon_p | patch epsilon values C_{\mu} | Model coefficient, set to 0.09 k | turbulence kinetic energy L | length scale - /endvartable + \endvartable \note In the event of reverse flow, a zero-gradient condition is applied - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value mixingLength | Length scale [m] | yes | phi | flux field name | no | phi k | turbulence kinetic energy field name | no | k - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H index 59b56dbd36..602c382b9f 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H @@ -38,24 +38,24 @@ Description where - /vartable + \vartable \omega_p | patch omega values C_{\mu} | Model coefficient, set to 0.09 k | turbulence kinetic energy L | length scale - /endvartable + \endvartable \note In the event of reverse flow, a zero-gradient condition is applied - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value mixingLength | Length scale [m] | yes | phi | flux field name | no | phi k | turbulence kinetic energy field name | no | k - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H index a8979e059d..abd360cba4 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H @@ -38,20 +38,20 @@ Description where - /vartable + \vartable epsilon | turblence dissipation field G | turblence generation field - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value G | turbulence generation field name | no | G Cmu | model coefficient | no | 0.09 kappa | Von Karman constant | no | 0.41 E | model coefficient | no | 9.8 - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kappatWallFunctions/kappatJayatillekeWallFunction/kappatJayatillekeWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kappatWallFunctions/kappatJayatillekeWallFunction/kappatJayatillekeWallFunctionFvPatchScalarField.H index 601fbda71c..aaa71c3f47 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kappatWallFunctions/kappatJayatillekeWallFunction/kappatJayatillekeWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kappatWallFunctions/kappatJayatillekeWallFunction/kappatJayatillekeWallFunctionFvPatchScalarField.H @@ -35,15 +35,15 @@ Description \note The units of kinematic turbulent thermal conductivity are m2/s - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value Prt | turbulent Prandtl number | no | 0.85 Cmu | model coefficient | no | 0.09 kappa | Von Karman constant | no | 0.41 E | model coefficient | no | 9.8 - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H index 6ec6b7270b..0626b3c1b9 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H @@ -31,7 +31,7 @@ Description This boundary condition is applied to turbulence \c k, \c q, and \c R when using wall functions, and simply enforces a zero-gradient condition. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H index 3f14f07338..008fe9c96c 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H @@ -32,7 +32,7 @@ Description for use with low Reynolds number models. It sets \c nut to zero, and provides an access function to calculate y+. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H index 97d70cf3bc..c0f8066e97 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H @@ -31,14 +31,14 @@ Description This boundary condition provides a turbulent kinematic viscosity condition when using wall functions for rough walls, based on velocity. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value roughnessHeight | roughness height | yes | roughnessConstant | roughness constanr | yes | roughnessFactor | scaling factor | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H index 5ae948a614..ba1dde4514 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H @@ -32,7 +32,7 @@ Description when using wall functions for rough walls, based on velocity, using Spaldings law to give a continuous nut profile to the wall (y+ = 0) - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H index 7c43c75319..591cf8da77 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H @@ -37,12 +37,12 @@ Description the tables are not registered since the same table object may be used for more than one patch. - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value uPlusTable | U+ as a function of Re table name | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H index d39142bc26..6f32734149 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H @@ -31,7 +31,7 @@ Description This boundary condition provides a turbulent kinematic viscosity condition when using wall functions, based on velocity. - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H index ecd2959720..01355ec454 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H @@ -32,7 +32,7 @@ Description when using wall functions, based on turbulence kinetic energy. - replicates OpenFOAM v1.5 (and earlier) behaviour - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H index 3ba2b450a8..3e0f67a4fc 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H @@ -40,19 +40,19 @@ Description where - /vartable + \vartable U_f | frictional velocity K | Von Karman's constant z_0 | surface roughness length z | vertical co-ordinate - /endvartable + \endvartable - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value z0 | surface roughness length| yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H index 0682defc2d..8bbe8b16b8 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H @@ -36,13 +36,13 @@ Description - roughness height = sand-grain roughness (0 for smooth walls) - roughness constant = 0.5-1.0 - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value Ks | sand-grain roughness height | yes | Cs | roughness constant | yes | - /endtable + \endtable Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H index 91156935d0..49a2257e09 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H @@ -32,7 +32,7 @@ Description when using wall functions, based on turbulence kinetic energy. - replicates OpenFOAM v1.5 (and earlier) behaviour - /heading Patch usage + \heading Patch usage Example of the boundary condition specification: \verbatim diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H index ece53d3b1d..9c03a85f25 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H @@ -37,10 +37,10 @@ Description where - /vartable + \vartable \omega_{vis} | omega in viscous region \omega_{log} | omega in logarithmic region - /endvartable + \endvartable Model described by Eq.(15) of: \verbatim @@ -50,16 +50,16 @@ Description Nov. 2001 \endverbatim - /heading Patch usage + \heading Patch usage - /table + \table Property | Description | Required | Default value G | turbulence generation field name | no | G Cmu | model coefficient | no | 0.09 kappa | Von Karman constant | no | 0.41 E | model coefficient | no | 9.8 beta1 | model coefficient | no | 0.075 - /endtable + \endtable Example of the boundary condition specification: \verbatim