diff --git a/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H index 7c475c1111..77dba4ada8 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H @@ -57,7 +57,7 @@ Description refGrad | patch normal gradient | yes | \endtable - \note +Note This condition is not usually applied directly; instead, use a derived mixed condition such as \c inletOutlet diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H index 85a03380f0..ded4696854 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H @@ -31,11 +31,6 @@ Description This boundary condition enforces a cyclic condition between a pair of boundaries. - \note - The patches must be topologically similar, i.e. if the owner patch is - transformed to the neighbour patch, the patches should be identical (or - very similar). - \heading Patch usage Example of the boundary condition specification: @@ -46,6 +41,11 @@ Description } \endverbatim +Note + The patches must be topologically similar, i.e. if the owner patch is + transformed to the neighbour patch, the patches should be identical (or + very similar). + SourceFiles cyclicFvPatchField.C diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H index cef14ae106..c9ad16c6c9 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H @@ -32,11 +32,6 @@ Description boundaries, whereby communication between the patches is performed using an arbitrary mesh interface (AMI) interpolation. - \note - The outer boundary of the patch pairs must be similar, i.e. if the owner - patch is transformed to the neighbour patch, the outer perimiter of each - patch should be identical (or very similar). - \heading Patch usage Example of the boundary condition specification: @@ -47,6 +42,11 @@ Description } \endverbatim +Note + The outer boundary of the patch pairs must be similar, i.e. if the owner + patch is transformed to the neighbour patch, the outer perimiter of each + patch should be identical (or very similar). + SeeAlso Foam::AMIInterpolation diff --git a/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H index 305beeaced..5c62df1049 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H @@ -58,22 +58,19 @@ Description lInf | distance beyond patch for \c fieldInf | no | \endtable - \note - If \c lInf is specified, \c fieldInf will be required; \c rho is only - required in the case of a mass-based flux. - Example of the boundary condition specification: \verbatim myPatch { type advective; phi phi; - // rho rho; // Not needed for volumetric-based flux - // fieldInf 1e5; // Optional - // lInf 0.1; // Optional } \endverbatim +Note + If \c lInf is specified, \c fieldInf will be required; \c rho is only + required in the case of a mass-based flux. + SourceFiles advectiveFvPatchField.C diff --git a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H index 482b365f2a..4e3db2fdff 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H @@ -56,7 +56,7 @@ Description } \endverbatim - \note +Note The \c axialVelocity, \c radialVelocity and \c rpm entries are DataEntry types, able to describe time varying functions. The example above gives the usage for supplying constant values. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H index 9306796d79..3eea1382f3 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H @@ -66,7 +66,7 @@ Description The above example shows the use of a comma separated (CSV) file to specify the jump condition. - \note +Note The underlying \c patchType should be set to \c cyclic SeeAlso diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H index 2fdd5f71b4..75a9742240 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H @@ -43,7 +43,7 @@ Description } \endverbatim - \note +Note This is used as a base for conditions such as the turbulence \c epsilon wall function, which applies a near-wall constraint for high Reynolds number flows. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H index 983edbfa92..30ec57fc54 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H @@ -30,7 +30,7 @@ Group Description Base class for "jump" of a field - \note +Note not used directly SeeAlso diff --git a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H index f15d4e666a..0b78dddc22 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H @@ -64,7 +64,7 @@ Description The \c flowRate entry is a \c DataEntry type, meaning that it can be specified as constant, a polynomial fuction of time, and ... - \note +Note - the value is positive into the domain (as an inlet) - may not work correctly for transonic inlets - strange behaviour with potentialFoam since the U equation is not solved diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H index 059c3addfd..4519a5ed9d 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H @@ -64,7 +64,7 @@ Description } \endverbatim - \note +Note If reverse flow is possible or expected use the pressureInletOutletVelocity condition instead. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H index ae082c5da3..fa5233308c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H @@ -42,7 +42,7 @@ Description } \endverbatim - \note +Note This condition is designed to operate with a freestream velocity condition SeeAlso diff --git a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H index d97e6eb817..21aea3aa91 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H @@ -53,7 +53,7 @@ Description The mode of operation is determined by the sign of the flux across the patch faces. - \note +Note Sign conventions: - positive flux (out of domain): apply zero-gradient condition - negative flux (into of domain): apply the user-specified fixed value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H index bb413a141c..6dd9f3efb5 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H @@ -53,7 +53,7 @@ Description } \endverbatim - \note +Note Since this condition can be applied on a per-field and per-patch basis, it is possible to duplicate the mapping information. If possible, employ the \c mapped condition in preference to avoid this situation, and only diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H index dbf6595879..a4b48fce8f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H @@ -51,7 +51,7 @@ Description } \endverbatim - \note +Note This boundary condition can only be applied to patches that are of the \c mappedPolyPatch type. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H index 04ec0c4ef7..2f9ecedd66 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H @@ -52,7 +52,7 @@ Description } \endverbatim - \note +Note This boundary condition can only be applied to patches that are of the \c mappedPolyPatch type. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H index 672889d325..dd52f2a2b6 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H @@ -65,7 +65,7 @@ Description boundary faces and both faces sample into the cell, both faces will get the same value. - \note +Note It is not possible to sample internal faces since volume fields are not defined on faces. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H index 8dac3f6f56..409154eaff 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H @@ -51,7 +51,7 @@ Description The underlying sample mode should be set to \c nearestPatchFace or \c nearestFace - \note +Note This boundary condition can only be applied to patches that are of the \c mappedPolyPatch type. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H index af8ac75a74..c4d9066696 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H @@ -68,7 +68,7 @@ Description } \endverbatim - \note +Note The amplitude and frequency entries are DataEntry types, able to describe time varying functions. The example above gives the usage for supplying constant values. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H index 53d47a3592..d843815a5f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H @@ -53,7 +53,7 @@ Description The mode of operation is determined by the sign of the flux across the patch faces. - \note +Note Sign conventions: - positive flux (out of domain): apply the user-specified fixed value - negative flux (into of domain): apply zero-gradient condition diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H index d12d390ea1..b6e24c73c7 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H @@ -54,7 +54,7 @@ Description } \endverbatim - \note +Note Sign conventions: - positive flux (out of domain): apply zero-gradient condition - negative flux (into of domain): derive from the flux with specified diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H index a7ea670a9b..c98ad304da 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H @@ -53,7 +53,7 @@ Description } \endverbatim - \note +Note If reverse flow is possible or expected use the pressureDirectedInletOutletVelocityFvPatchVectorField condition instead. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H index 7fbb307d04..f1f2f3a9d3 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H @@ -54,7 +54,7 @@ Description } \endverbatim - \note +Note Sign conventions: - positive flux (out of domain): apply zero-gradient condition - negative flux (into of domain): derive from the flux with specified diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H index 36680dd7d8..1ed301b191 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H @@ -54,7 +54,7 @@ Description } \endverbatim - \note +Note Sign conventions: - positive flux (out of domain): apply zero-gradient condition - negative flux (into of domain): derive from the flux in the patch-normal diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H index 2ea77ceeff..12b7d8bec5 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H @@ -45,7 +45,7 @@ Description } \endverbatim - \note +Note If reverse flow is possible or expected use the pressureInletOutletVelocityFvPatchVectorField condition instead. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H index 3df7b5ed9a..c138b18f69 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H @@ -52,7 +52,7 @@ Description } \endverbatim - \note +Note Sign conventions: - positive flux (out of domain): apply zero-gradient condition - negative flux (into of domain): derive from the flux and patch-normal diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H index 5a95fa75bf..cc114d7c6b 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H @@ -56,7 +56,7 @@ Description The \c omega entry is a DataEntry type, able to describe time varying functions. - \note +Note Sign conventions: - positive flux (out of domain): apply zero-gradient condition - negative flux (into of domain): derive from the flux in the patch-normal diff --git a/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H index ca013bb04c..402fc365f3 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H @@ -58,7 +58,7 @@ Description } \endverbatim - \note +Note This boundary condition is ill-posed if the free-stream flow is normal to the boundary. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H index 2b6242a42d..e0068654fd 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H @@ -47,7 +47,7 @@ Description } \endverbatim - \note +Note Sign conventions: - the value is positive for outward-pointing vectors diff --git a/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H index 307d9486a6..a53dd0ca12 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H @@ -57,7 +57,7 @@ Description } \endverbatim - \note +Note - the \c flowRate and \c rpm entries are DataEntry types, able to describe time varying functions. The example above gives the usage for supplying constant values. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H index d788f543be..0663a1cb86 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H @@ -56,7 +56,7 @@ Description The above example shows the use of a constant jump condition. - \note +Note The underlying \c patchType should be set to \c cyclic SeeAlso diff --git a/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H index 86a8029cdf..61228fe07c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H @@ -61,7 +61,7 @@ Description } /endverbatim - \note +Note Switch on debug flag to have it dump the triangulation (in transformed space) and transform face centres. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H index dd49014a32..05bd6b1800 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H @@ -101,9 +101,6 @@ Description p0 | static pressure reference | yes | \endtable - \note - The default boundary behaviour is for subsonic, incompressible flow. - Example of the boundary condition specification: \verbatim myPatch @@ -118,6 +115,9 @@ Description } \endverbatim +Note + The default boundary behaviour is for subsonic, incompressible flow. + SeeAlso Foam::fixedValueFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H index 3b09b75a4c..072d02f1b6 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H @@ -46,7 +46,7 @@ Description } \endverbatim - \note +Note The uniformValue entry is a DataEntry type, able to describe time varying functions. The example above gives the usage for supplying a constant value. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H index 46f81be514..0dca30f8ff 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H @@ -44,9 +44,6 @@ Description pressure | total pressure as a function of time | yes | \endtable - \note - The default boundary behaviour is for subsonic, incompressible flow. - Example of the boundary condition specification: \verbatim myPatch @@ -62,10 +59,13 @@ Description } \endverbatim - The \c pressure entry is specified as a DataEntry type, able to describe time varying functions. +Note + The default boundary behaviour is for subsonic, incompressible flow. + + SeeAlso Foam::DataEntry Foam::uniformFixedValueFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H index c4322d6a57..10e6a2c889 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H @@ -51,7 +51,7 @@ Description } \endverbatim - \note +Note - the value is positive into the domain - may not work correctly for transonic inlets - strange behaviour with potentialFoam since the momentum equation is diff --git a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H index 1b5abb7644..db35e35d5c 100644 --- a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H +++ b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H @@ -44,9 +44,6 @@ Description - base: average over 'time', or 'iteration' (\f$N\f$ in the above) - window: optional averaging window, specified in 'base' units - \note - To employ the \c prime2Mean option, the \c mean option must be selecetd. - Average field names are constructed by concatenating the base field with the averaging type, e.g. when averaging field 'U', the resultant fields are: @@ -99,6 +96,9 @@ Description } \endverbatim +Note + To employ the \c prime2Mean option, the \c mean option must be selecetd. + SourceFiles fieldAverage.C fieldAverageTemplates.C diff --git a/src/postProcessing/functionObjects/field/fieldValues/faceSource/faceSource.H b/src/postProcessing/functionObjects/field/fieldValues/faceSource/faceSource.H index 786cd0caaf..f9199f451a 100644 --- a/src/postProcessing/functionObjects/field/fieldValues/faceSource/faceSource.H +++ b/src/postProcessing/functionObjects/field/fieldValues/faceSource/faceSource.H @@ -74,7 +74,7 @@ Description For example, to calculate the volumetric or mass flux across a patch, apply the 'sum' operator to the flux field (typically \c phi) - \note +Note - faces on empty patches get ignored - if the field is a volField the \c faceZone can only consist of boundary faces diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H index a55997915c..2031e2a808 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H @@ -46,9 +46,6 @@ Description L | length scale \endvartable - \note - In the event of reverse flow, a zero-gradient condition is applied - \heading Patch usage \table @@ -68,6 +65,9 @@ Description } \endverbatim +Note + In the event of reverse flow, a zero-gradient condition is applied + SeeAlso Foam::inletOutletFvPatchField diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H index 68f2a00884..9aaeb71db0 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H @@ -45,9 +45,6 @@ Description L | length scale \endvartable - \note - In the event of reverse flow, a zero-gradient condition is applied - \heading Patch usage \table @@ -67,6 +64,9 @@ Description } \endverbatim +Note + In the event of reverse flow, a zero-gradient condition is applied + SeeAlso Foam::inletOutletFvPatchField diff --git a/src/turbulenceModels/compressible/turbulenceModel/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H b/src/turbulenceModels/compressible/turbulenceModel/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H index 1230136b73..44e96635ba 100644 --- a/src/turbulenceModels/compressible/turbulenceModel/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/turbulenceModel/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H @@ -55,8 +55,8 @@ Description } \endverbatim - \note - Only supply \h an \c Ta, or \c q in the dictionary (see above) +Note + Only supply \c h and \c Ta, or \c q in the dictionary (see above) SourceFiles externalWallHeatFluxTemperatureFvPatchScalarField.C diff --git a/src/turbulenceModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H b/src/turbulenceModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H index b45b7a330c..a52e8e5b34 100644 --- a/src/turbulenceModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H +++ b/src/turbulenceModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H @@ -73,7 +73,7 @@ Description } \endverbatim - \note +Note The underlying \c patchType should be set to \c cyclic SourceFiles diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H index 0b1e2002f8..b37c40a3da 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H @@ -64,12 +64,6 @@ Description layer", Journal of Wind Engineering and Industrial Aerodynamics 95(2007), pp 355-369. - \note - D.M. Hargreaves and N.G. Wright recommend Gamma epsilon in the - k-epsilon model should be changed from 1.3 to 1.11 for consistency. - The roughness height (Er) is given by Er = 20 z0 following the same - reference. - \heading Patch usage \table @@ -98,6 +92,12 @@ Description } \endverbatim +Note + D.M. Hargreaves and N.G. Wright recommend Gamma epsilon in the + k-epsilon model should be changed from 1.3 to 1.11 for consistency. + The roughness height (Er) is given by Er = 20 z0 following the same + reference. + SourceFiles atmBoundaryLayerInletVelocityFvPatchVectorField.C diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H index 60d150deb0..59b8106d15 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H @@ -41,11 +41,6 @@ Description alphaEff | turbulent thermal diffusivity field name | yes | \endtable - \note - - it is assumed that the units of \c alphaEff are [kg/m/s] - - the specific heat capcaity is read from the transport dictionary entry - \c Cp0 - Example of the boundary condition specification: \verbatim myPatch @@ -58,6 +53,11 @@ Description } \endverbatim +Note + - it is assumed that the units of \c alphaEff are [kg/m/s] + - the specific heat capcaity is read from the transport dictionary entry + \c Cp0 + SourceFiles turbulentHeatFluxTemperatureFvPatchScalarField.C diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H index 6f812db1e6..7a74a83849 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H @@ -46,9 +46,6 @@ Description L | length scale \endvartable - \note - In the event of reverse flow, a zero-gradient condition is applied - \heading Patch usage \table @@ -68,6 +65,9 @@ Description } \endverbatim +Note + In the event of reverse flow, a zero-gradient condition is applied + SeeAlso Foam::inletOutletFvPatchField diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H index 602c382b9f..e39e13845f 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H @@ -45,9 +45,6 @@ Description L | length scale \endvartable - \note - In the event of reverse flow, a zero-gradient condition is applied - \heading Patch usage \table @@ -67,6 +64,9 @@ Description } \endverbatim +Note + In the event of reverse flow, a zero-gradient condition is applied + SeeAlso Foam::inletOutletFvPatchField 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 aaa71c3f47..c26d9a41ec 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kappatWallFunctions/kappatJayatillekeWallFunction/kappatJayatillekeWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kappatWallFunctions/kappatJayatillekeWallFunction/kappatJayatillekeWallFunctionFvPatchScalarField.H @@ -32,9 +32,6 @@ Description This boundary condition provides a kinematic turbulent thermal conductivity for using wall functions, using the Jayatilleke 'P' function. - \note - The units of kinematic turbulent thermal conductivity are m2/s - \heading Patch usage \table @@ -53,6 +50,9 @@ Description } \endverbatim +Note + The units of kinematic turbulent thermal conductivity are [m2/s] + SeeAlso Foam::fixedValueFvPatchField 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 591cf8da77..95bde3ba03 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H @@ -33,10 +33,6 @@ Description of U+ as a function of near-wall Reynolds number. The table should be located in the $FOAM_CASE/constant folder. - \note - the tables are not registered since the same table object may be used for - more than one patch. - \heading Patch usage \table @@ -53,6 +49,10 @@ Description } \endverbatim +Note + The tables are not registered since the same table object may be used for + more than one patch. + SeeAlso Foam::nutWallFunctionFvPatchScalarField