diff --git a/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H
index 7c475c1111e0dfeaa645c21c391ddd5f887df11f..77dba4ada89c626699bbf8d1605e517d40adb75d 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 85a03380f018106dbec88867fc750c5ce928d51e..ded4696854e3520dd9938dd934c97444f4117b01 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 cef14ae106f08781acf037e3837acbbfd18ecd96..c9ad16c6c951b83c3013715a0dd494626b90ac1f 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 305beeaced89a4d07e055cdaf71adc67442c425c..5c62df1049fee116021c0d744b2751ab70533425 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 482b365f2a94ea6b731850b24f3a0f88e62930bc..4e3db2fdfffd9905329be552615d50986c8a7e90 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 9306796d799c61f073f56c93a0fcf49bb6da7a4e..3eea1382f39400ec5f98a6b1ed4e3109459d87df 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 2fdd5f71b4eac55e81c1fffbb100270f25ea6fa5..75a9742240f757ddefce2e4f1b64e4ecf6b1e1f7 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 983edbfa92eb512401158ff262be22a6122d93c1..30ec57fc54eb35c11df20a7f18fcfdde72f659be 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<type>
- \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 f15d4e666a5cfd40bd5880b274e0e03b5b4bf4b3..0b78dddc225797cc74508f6495510e9acab1e46d 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 059c3addfd6c7844a0e48f205d24a2581d5b6af7..4519a5ed9d2f1063ff3466a52b83a28375536620 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 ae082c5da33b1d302159cb115fbcae3b6f36357d..fa5233308c8ac7c3e4f24c3f85c29a5e680a9c0e 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 d97e6eb8173880c22bd580ab0cd1e68e5e74d79d..21aea3aa9137b8da785676805c0239fa03d92478 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 bb413a141c228ab3d9a3c3521349e924ef6ac531..6dd9f3efb5c8579b8c9c966394d4aa34a5e8685a 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 dbf659587948622ffc013934d3105831bd35fe99..a4b48fce8faa69d99c7087d5a11b2562aac6d9a7 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 04ec0c4ef7e7731f60ff22d6583e81ba23fd4785..2f9ecedd66db14332ef11e55141232c91a9d9bfd 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 672889d3256b238b609ead36bdb72b370c37c76e..dd52f2a2b635b725368edc81cf7654ccdeab7485 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 8dac3f6f56d35b55786211418cd0c4279e5e6c01..409154eaffd5d0b68a1858c27cc63f7dbcd9a04d 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 af8ac75a74ed16a544acdb55a8c51f1471404b9f..c4d906669633525af6f63fc64c833d4ea6a1c592 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 53d47a3592f3a773d18409056e14f61c8d13fa6f..d843815a5f44e2530b4694272f782ca515c4d2c4 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 d12d390ea1c56e08160aa40062c58a085e660c71..b6e24c73c7ba1bf0c607a493878a0c443ea370b4 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 a7ea670a9bbe7e8f64d40bf2f5c5160f34c89f47..c98ad304dad165baa2474d07606af357849222b9 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 7fbb307d0471a390e48b71930c404733b04f76c4..f1f2f3a9d3325ad0bf989a056ec46999a0660756 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 36680dd7d8668c4cbb3d776295348a39fa41dba2..1ed301b191ea185db943a58de71215682d509370 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 2ea77ceeffaccfb365cbd4e7b391931466db15d2..12b7d8bec538d6baac09b14317e9d7c9f508bc80 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 3df7b5ed9a4f3fbcf5083660613b87e9fe9c6560..c138b18f6959352e53be8b471aef6294a09317a2 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 5a95fa75bf7a4a474c7bf4849a7b72fef92e856e..cc114d7c6b8110adc0eed599ae2abc17bc646b65 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 ca013bb04c226b6e99aa925b97d3f9c5bd3c5b1b..402fc365f34fd746309db74c192931938c140603 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 2b6242a42d384411f3f893230c4ecf17e15ab9c6..e0068654fd04922c54584f6127e7b2730bd9ea59 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 307d9486a6ec1a329073b817225509e0a19aaa82..a53dd0ca12b4213ef72f37f7798e9766279b7b44 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 d788f543beead60c270bae45b604b652a94a4735..0663a1cb86745144c31881f95d2629d0f130c169 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 86a8029cdf16d706dfe7d8964895dfde928ea8c5..61228fe07c4b06db225843de425bcda10710335a 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 dd49014a3226e8a9cdfbb8a3709f26db792459e4..05bd6b180045533d77f4109d60599fa18a56021d 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 3b09b75a4ccab16d4ddef8ec0884584bb2a5baca..072d02f1b6d94024a54ad85618a1c241cb059e6b 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 46f81be514370e0aaed46f401ff089f9e54f5398..0dca30f8ff271161200f23de11b4e22fd5ffa87e 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 c4322d6a5705e05e57eda4d653d966f9166d1287..10e6a2c88993741da7567025b845de155dcc2247 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 1b5abb7644bb30b63fb7f6be7bfad2b9902c071b..db35e35d5c41c85c6b9404bc703f9569f8c32875 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 786cd0caaf0baa2d68d2d9cc20da4664aab42ea7..f9199f451a48947f85f8dab945b079ec3570e173 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 a55997915cc2064372fbab3d4277591da9970151..2031e2a808ac4692580927c0ee9d82485b093fbb 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 68f2a0088473a141fb05e31f4740665e1a30dffd..9aaeb71db0a5d0ef46df8b03080b489ebfb3a6ed 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 1230136b7393c20d30e5dadc7843e50ffdb71ac4..44e96635bacdf6056c9b724dff868e8660977e9a 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 b45b7a330c2f01bbad0ca1c6eb34454fe6e7f582..a52e8e5b34fa2731631459a4be58c037d0a30fad 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 0b1e2002f82109de12f10127ee3dbf6cc6a9537f..b37c40a3da6d37849f6653708f08388677f52359 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 60d150deb0e32d40d42d4a43bd8f90292b4cd4a2..59b8106d151bc72f91b692708d9d0e04047755ce 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 6f812db1e6437cd33ba27a30c54c002b7c2cc0f2..7a74a838496833a460e917438c7cffae9342dfa1 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 602c382b9fd4abcca55fa9c116f6ddbcb7462cdd..e39e13845f464066d08ba247f94d0a1efbc9c156 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 aaa71c3f4714ca4132a4ca11bcc91f1460eb5506..c26d9a41ecbfadfe77b83ca340892a814034f7e0 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 591cf8da779570cd3a3227c5c9e92ae35da93f3e..95bde3ba032d724ebb8c5628af4a7155ff6632bc 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