diff --git a/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H
index 2231e93051a2c47ab861a617d5c9599633aef46f..e5fc8c3c15d6b4c6309871920801da3bccd06563 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::activeBaffleVelocityFvPatchVectorField
+\ingroup grpCoupledBoundaryConditions
+
Description
This velocity boundary condition simulates the opening of a baffle due
to local flow conditions, by merging the behaviours of wall and cyclic
@@ -87,8 +86,6 @@ SeeAlso
SourceFiles
activeBaffleVelocityFvPatchVectorField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef activeBaffleVelocityFvPatchVectorField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H
index 09dd71dd7ede45acf3695fda607191358b83b112..350f2113a11e793acee58a512c23c3885aa86279 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::activePressureForceBaffleVelocityFvPatchVectorField
+\ingroup grpCoupledBoundaryConditions
+
Description
This boundary condition is applied to the flow velocity, to simulate the
opening of a baffle due to local flow conditions, by merging the behaviours
@@ -86,8 +85,6 @@ Description
SourceFiles
activePressureForceBaffleVelocityFvPatchVectorField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef activePressureForceBaffleVelocityFvPatchVectorField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H
index f567eaf3e080ab208c47d0576fb0a742b3c2dd1a..9a87eaf77d7631c27c314544fbecdcc21fcd1bbe 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::advectiveFvPatchField
+\ingroup grpOutletBoundaryConditions
+
Description
This boundary condition provides an advective outflow condition, based on
solving DDt(psi, U) = 0 at the boundary.
@@ -77,8 +76,6 @@ Description
SourceFiles
advectiveFvPatchField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef advectiveFvPatchField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H
index 11b848dfeacb35db6043b3c5d3ea20ac2923faa4..05e88b18cdfb76f3fb468151e52c86f21de54d0c 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::buoyantPressureFvPatchScalarField
+\ingroup grpGenericBoundaryConditions grpWallBoundaryConditions
+
Description
This boundary condition sets the pressure gradient appropriately for
buoyant flow.
@@ -81,8 +80,6 @@ Description
SourceFiles
buoyantPressureFvPatchScalarField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef buoyantPressureFvPatchScalarFields_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H
index 5faa817c58c2620111da35c0ad199ca50ebcf529..8bda7a79524a0e4804fed27f3e919c01428226e7 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::codedFixedValueFvPatchField
+\ingroup grpGenericBoundaryConditions
+
Description
Constructs on-the-fly a new boundary condition (derived from
fixedValueFvPatchField) which is then used to evaluate.
@@ -79,8 +78,6 @@ SeeAlso
SourceFiles
codedFixedValueFvPatchField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef codedFixedValueFvPatchField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H
index 6e7fa87ff24e1991840b7c4f3799094eb1e021d7..1d9ce49b8c9fb6ee7fb309760a6c517c6073058e 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::codedMixedFvPatchField
+\ingroup grpGenericBoundaryConditions
+
Description
Constructs on-the-fly a new boundary condition (derived from
mixedFvPatchField) which is then used to evaluate.
@@ -83,8 +82,6 @@ SeeAlso
SourceFiles
codedMixedFvPatchField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef codedMixedFvPatchField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H
index 94206e5afc87254dee1859c05196d18d02023ee0..e9d2a3455b04e7f98c469a90295840ceae71dde6 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::cylindricalInletVelocityFvPatchVectorField
+\ingroup grpInletBoundaryConditions
+
Description
This boundary condition describes an inlet vector boundary condition in
cylindrical co-ordinates given a central axis, central point, rpm, axial
@@ -68,8 +67,6 @@ SeeAlso
SourceFiles
cylindricalInletVelocityFvPatchVectorField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef cylindricalInletVelocityFvPatchVectorField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H
index 1cc2835a9a07e64ae1b4dd5a3456f609d8492f39..86d52ed1f0689644ab25ecc45cfe3a5f8f76fc4a 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::fanFvPatchField
+\ingroup grpCoupledBoundaryConditions
+
Description
This boundary condition supplies a jump condition, using the \c cyclic
condition as a base.
@@ -77,7 +76,6 @@ SourceFiles
fanFvPatchFields.H
fanFvPatchFields.C
fanFvPatchFieldsFwd.H
-@}
\*---------------------------------------------------------------------------*/
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H
index ed3b1c0237ef870f33d218fc843698201d2464ac..ad25e082ff57447673825b5d0ffaf6dcf87e7081 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H
@@ -24,6 +24,8 @@ License
Class
Foam::fanPressureFvPatchScalarField
+\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions
+
Description
This boundary condition can be applied to assign either a pressure inlet
or outlet total pressure condition for a fan.
@@ -35,25 +37,25 @@ Description
Example of the boundary condition specification:
\verbatim
- inlet
- {
- type fanPressure;
- fileName "fanCurve"; // Fan curve file name
- outOfBounds clamp; // (error|warn|clamp|repeat)
- direction in; // Direction of flow through fan
- p0 uniform 0; // Environmental total pressure
- value uniform 0; // Initial pressure
- }
-
- outlet
- {
- type fanPressure;
- fileName "fanCurve"; // Fan curve file name
- outOfBounds clamp; // (error|warn|clamp|repeat)
- direction out; // Direction of flow through fan
- p0 uniform 0; // Environmental total pressure
- value uniform 0; // Initial pressure
- }
+ inlet
+ {
+ type fanPressure;
+ fileName "fanCurve"; // Fan curve file name
+ outOfBounds clamp; // (error|warn|clamp|repeat)
+ direction in; // Direction of flow through fan
+ p0 uniform 0; // Environmental total pressure
+ value uniform 0; // Initial pressure
+ }
+
+ outlet
+ {
+ type fanPressure;
+ fileName "fanCurve"; // Fan curve file name
+ outOfBounds clamp; // (error|warn|clamp|repeat)
+ direction out; // Direction of flow through fan
+ p0 uniform 0; // Environmental total pressure
+ value uniform 0; // Initial pressure
+ }
\endverbatim
See Also
@@ -62,7 +64,7 @@ See Also
Foam::interpolationTable
SourceFiles
- fanPressureFvPatchScalarField.C
+ fanPressureFvPatchScalarField.C
\*---------------------------------------------------------------------------*/
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H
index 0c748853093ae85158de07770f1500e0e6edd4e9..52768875e6588294be57f74eb4fd96fff994cca0 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::fixedFluxPressureFvPatchScalarField
+\ingroup grpBoundaryConditions
+
Description
This boundary condition adjusts the pressure gradient such that the flux
on the boundary is that specified by the velocity boundary condition.
@@ -73,8 +72,6 @@ SeeAlso
SourceFiles
fixedFluxPressureFvPatchScalarField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef fixedFluxPressureFvPatchScalarFields_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H
index 5ab621f8b7c3f072ddf20fc3897d1ebbb8070c9a..14103353587faa25bb6179688358088829bcaea2 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::fixedInternalValueFvPatchField
+\ingroup grpGenericBoundaryConditions
+
Description
This boundary condition provides a mechanism to set boundary (cell) values
directly into a matrix, i.e. to set a constraint condition. Default
@@ -54,8 +53,6 @@ SeeAlso
SourceFiles
fixedInternalValueFvPatchField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef fixedInternalValueFvPatchField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H
index 35617d9c77cc20ce94444f648fbc42e9d479b721..caaa8663067a22a787a6c029a85a15bd5d809750 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::fixedJumpFvPatchField
+\ingroup grpCoupledBoundaryConditions
+
Description
Base class for "jump" of a field<type>
@@ -40,8 +39,6 @@ SeeAlso
SourceFiles
fixedJumpFvPatchField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef fixedJumpFvPatchField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H
index c18cc48d172a0e7d377ad6a08b0e5c2730ff17ae..7fd5c515a9f6bfb86a2a6017439d291fa976a568 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::fixedMeanFvPatchField
+\ingroup grpGenericBoundaryConditions
+
Description
This boundary condition extrapolates field to the patch using the near-cell
values and adjusts the distribution to match the specified mean value.
@@ -53,8 +52,6 @@ SeeAlso
SourceFiles
fixedMeanFvPatchField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef fixedMeanFvPatchField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H
index 5b1b6e9f15e33088e0f713af5c27e2e5ad13bb79..1c387e48a513ea835005cb879dd381246e9c269a 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::fixedNormalSlipFvPatchField
+\ingroup grpGenericBoundaryConditions grpWallBoundaryConditions
+
Description
This boundary condition sets the patch-normal component to a fixed value.
@@ -52,8 +51,6 @@ SeeAlso
SourceFiles
fixedNormalSlipFvPatchField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef fixedNormalSlipFvPatchField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H
index 4ebbcc08087916a4fe0f0e6c29818e80d4d598ae..af16f8e2706cb8eab55f8a4d8b6d914cafd260ec 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::fixedPressureCompressibleDensityFvPatchScalarField
+\ingroup grpInletBoundaryConditions
+
Description
This boundary condition calculates a (liquid) compressible density as a
function of pressure and fluid properties:
@@ -71,8 +70,6 @@ SeeAlso
SourceFiles
fixedPressureCompressibleDensityFvPatchScalarField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef fixedPressureCompressibleDensityFvPatchScalarField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H
index 14aa62c538efe5329960beb63c62ea43fd5c3a63..9875120c182bad5777e4407adcbe33e558717480 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::flowRateInletVelocityFvPatchVectorField
+\ingroup grpInletBoundaryConditions
+
Description
This boundary condition provides a velocity boundary condition, derived
from the flux (volumetric or mass-based), whose direction is assumed
@@ -76,8 +75,6 @@ SeeAlso
SourceFiles
flowRateInletVelocityFvPatchVectorField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef flowRateInletVelocityFvPatchVectorField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H
index 00960b163bf21d734ddcb62c8160d625dbb1df55..37a508e5ef7981cdd51911b051b29ec3d842ba68 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::fluxCorrectedVelocityFvPatchVectorField
+\ingroup grpOutletBoundaryConditions
+
Description
This boundary condition provides a velocity outlet boundary condition for
patches where the pressure is specified. The outflow velocity is obtained
@@ -75,8 +74,6 @@ SeeAlso
SourceFiles
fluxCorrectedVelocityFvPatchVectorField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef fluxCorrectedVelocityFvPatchVectorField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H
index db0eb9175460d3f65984d8751fc4e912328f14f2..90fae4911b2a493d10c32a4e33ad8fc71761ee63 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::freestreamFvPatchField
+\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions
+
Description
This boundary condition provides a free-stream condition. It is a 'mixed'
condition derived from the \c inletOutlet condition, whereby the mode of
@@ -56,8 +55,6 @@ SeeAlso
SourceFiles
freestreamFvPatchField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef freestreamFvPatchField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H
index 609325cfa45b4ba6be770ceb2ef6e134cf8a0a70..d1f8214bc3220b8a8d821384a08304088b214d85 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::freestreamPressureFvPatchScalarField
+\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions
+
Description
This boundary condition provides a free-stream condition for pressure.
It is a zero-gradient condition that constrains the flux across the patch
@@ -52,8 +51,6 @@ SeeAlso
SourceFiles
freestreamPressureFvPatchScalarField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef freestreamPressureFvPatchScalarFields_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H
index 9a39ea3a73a9f1dae6ff6acbe1313fe384e1eaa4..1ba72744df6a5bc1b9a2d95821cc83f541dc0f94 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::inletOutletFvPatchField
+\ingroup grpOutletBoundaryConditions
+
Description
This boundary condition provides a generic outflow condition, with
specified inflow for the case of return flow.
@@ -65,8 +64,6 @@ SeeAlso
SourceFiles
inletOutletFvPatchField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef inletOutletFvPatchField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H
index 1e8eb0a15e3e72c4af24b2262930e77178db64ad..ef2f279e2403657c61957e9d668dc7c9e8520fc2 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::inletOutletTotalTemperatureFvPatchScalarField
+\ingroup grpOutletBoundaryConditions
+
Description
This boundary condition provides an outflow condition for total
temperature for use with supersonic cases, where a user-specified
@@ -65,8 +64,6 @@ SeeAlso
SourceFiles
inletOutletTotalTemperatureFvPatchScalarField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef inletOutletTotalTemperatureFvPatchScalarField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H
index d9bb992e29b7081fd3e09aa8b03fcc61b6b915f9..8c9c39b9d5daf335d886211bd7b3a1e4867b814f 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::mappedFieldFvPatchField
+\ingroup grpGenericBoundaryConditions grpCoupledBoundaryConditions
+
Description
This boundary condition provides a self-contained version of the \c mapped
condition. It does not use information on the patch; instead it holds
@@ -69,8 +68,6 @@ SeeAlso
SourceFiles
mappedFieldFvPatchField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef mappedFieldFvPatchField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H
index 7dbb2b7f43093e5a757602bbad299aed232f1efc..f5f2a5b167257bfeb8e2c6079c229f609b93792c 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::mappedFixedInternalValueFvPatchField
+\ingroup grpGenericBoundaryConditions grpCoupledBoundaryConditions
+
Description
This boundary condition maps the boundary and internal values of a
neighbour patch field to the boundary and internal values of *this.
@@ -64,8 +63,6 @@ SeeAlso
SourceFiles
mappedFixedInternalValueFvPatchField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef mappedFixedInternalValueFvPatchField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H
index a39e9f41cc217aa99d478c5bce74bc5172a43fda..12aa98c6b81591b208f94d28193021322ea0cb66 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::mappedFixedPushedInternalValueFvPatchField
+\ingroup grpGenericBoundaryConditions grpCoupledBoundaryConditions
+
Description
This boundary condition maps the boundary values of a neighbour patch
field to the boundary and internal cell values of *this.
@@ -65,8 +64,6 @@ SeeAlso
SourceFiles
mappedFixedPushedInternalValueFvPatchField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef mappedFixedPushedInternalValueFvPatchField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H
index b618dd6d123a47e9d95e2a380d10e685d64b5397..0a7e597e9a8bfeebb8902461edcdd68c9e926a02 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::mappedFixedValueFvPatchField
+\ingroup grpGenericBoundaryConditions grpCoupledBoundaryConditions
+
Description
This boundary condition maps the value at a set of cells or patch faces
back to *this.
@@ -77,8 +76,6 @@ SeeAlso
SourceFiles
mappedFixedValueFvPatchField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef mappedFixedValueFvPatchField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H
index 27f7d1ff025d15189eebbe0ef08e0bf7342eb435..253294c0cd787de00becaa83e2bd10dc167ec12f 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::mappedFlowRateFvPatchVectorField
+\ingroup grpInletBoundaryConditions grpCoupledBoundaryConditions
+
Description
Describes a volumetric/mass flow normal vector boundary condition by its
magnitude as an integral over its area.
@@ -47,7 +46,7 @@ Description
/endtable
Example of the boundary condition specification:
- @verbatim
+ /verbatim
inlet
{
type mappedFlowRate;
@@ -56,13 +55,11 @@ Description
neigPhi phi;
value uniform (0 0 0); // placeholder
}
- @endverbatim
+ /endverbatim
SourceFiles
mappedFlowRateFvPatchVectorField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef mappedFlowRateFvPatchVectorField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H
index e12867472e267f6ec99d2f7ea4fb93aeebef81d6..0dea9e1ed1509fff90b3dc29e3050ce05464c587 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::mappedVelocityFluxFixedValueFvPatchField
+\ingroup grpInletBoundaryConditions grpCoupledBoundaryConditions
+
Description
This boundary condition maps the velocity and flux from a neighbour patch
to this patch
@@ -64,8 +63,6 @@ SeeAlso
SourceFiles
mappedVelocityFluxFixedValueFvPatchField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef mappedVelocityFluxFixedValueFvPatchField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H
index b785a732a7d17a04a14acbce5e804ba13724b4d4..daf1a77df4f991dc0fe60e34d96c3b570aa6f082 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::movingWallVelocityFvPatchVectorField
+\ingroup grpWallBoundaryConditions
+
Description
This boundary condition provides a velocity condition for cases with
moving walls. In addition, it should also be applied to 'moving' walls
@@ -57,8 +56,6 @@ SeeAlso
SourceFiles
movingWallVelocityFvPatchVectorField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef movingWallVelocityFvPatchVectorField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H
index 71d9edaeb127eaa2a0724531d25bb51d2d200a78..a03bf05439535e7fbcdd5cb3b0a423dfdb4d8bb6 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::multiphaseFixedFluxPressureFvPatchScalarField
+\ingroup grpWallBoundaryConditions grpGenericBoundaryConditions
+
Description
This boundary condition adjusts the pressure gradient such that the flux
on the boundary is that specified by the velocity boundary condition.
@@ -70,8 +69,6 @@ Description
SourceFiles
multiphaseFixedFluxPressureFvPatchScalarField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef multiphaseFixedFluxPressureFvPatchScalarFields_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H
index 6021aa7f56827faadb0208f57541836905fbd4e5..4cb745fad53a9a333f73031d48c61a2b3cbe3264 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::oscillatingFixedValueFvPatchField
+\ingroup grpGenericBoundaryConditions
+
Description
This boundary condition provides an oscillating condition in terms of
amplitude and frequency.
@@ -79,8 +78,6 @@ SeeAlso
SourceFiles
oscillatingFixedValueFvPatchField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef oscillatingFixedValueFvPatchField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H
index 7a3841d5fe2f2f6e9ffa0b005e50ac08fd3a449a..13973910b10060f21632c767a212047e11c73fa3 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::outletInletFvPatchField
+\ingroup grpInletBoundaryConditions
+
Description
This boundary condition provides a generic inflow condition, with
specified outflow for the case of return flow.
@@ -61,8 +60,6 @@ Description
SourceFiles
outletInletFvPatchField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef outletInletFvPatchField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H
index 611bc2ca091974c989f8accc4e554aa8c74d3bb0..4e5c3ff062d066c8d41e8556ea12427cd2866bba 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::outletMappedUniformInletFvPatchField
+\ingroup grpInletBoundaryConditions
+
Description
This boundary conditon averages the field over the "outlet" patch specified
by name "outletPatchName" and applies this as the uniform value of the
@@ -57,8 +56,6 @@ SeeAlso
SourceFiles
outletMappedUniformInletFvPatchField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef outletMappedUniformInletFvPatchField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H
index 2255dd51f09a43b550157e17d8de06ab5970f057..eb883458f702ee8c129d840b09c4fed5949866fd 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::partialSlipFvPatchField
+\ingroup grpWallBoundaryConditions grpGenericBoundaryConditions
+
Description
This boundary condition provides a partial slip condition. The amount of
slip is controlled by a user-supplied field.
@@ -54,8 +53,6 @@ SeeAlso
SourceFiles
partialSlipFvPatchField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef partialSlipFvPatchField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H
index 7fe32be4068d76f73ecbd946d1cfd69ffd72ab63..673e51c072f2803ad32c37bc61a373d1a4573151 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::phaseHydrostaticPressureFvPatchScalarField
+\ingroup grpGenericBoundaryConditions
+
Description
This boundary condition provides a phase-based hydrostatic pressure
condition, calculated as:
@@ -77,8 +76,6 @@ SeeAlso
SourceFiles
phaseHydrostaticPressureFvPatchScalarField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef phaseHydrostaticPressureFvPatchScalarField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H
index 1d6c3f00d859389e6227d7d9f5dff3dc6545fd6c..bfe5aab9f5a2e93c1104c4c92e946a2733a6bafd 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::pressureDirectedInletOutletVelocityFvPatchVectorField
+\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions
+
Description
This velocity inlet/outlet boundary condition is applied to pressure
boundaries where the pressure is specified. A zero-gradient condtion is
@@ -66,8 +65,6 @@ SeeAlso
SourceFiles
pressureDirectedInletOutletVelocityFvPatchVectorField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef pressureDirectedInletOutletVelocityFvPatchVectorField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H
index d400e23b54efbff9ddfb317b315a085f66315076..c4c0a57092bae0147f475898fdf3bd89ee759760 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::pressureDirectedInletVelocityFvPatchVectorField
+\ingroup grpInletBoundaryConditions
+
Description
This velocity inlet boundary condition is applied to patches where the
pressure is specified. The inflow velocity is obtained from the flux with
@@ -65,8 +64,6 @@ SeeAlso
SourceFiles
pressureDirectedInletVelocityFvPatchVectorField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef pressureDirectedInletVelocityFvPatchVectorField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H
index befe8b69a9f6f6426005b5159e8a3650838dace1..dab033544bcd513b45c6323e5f15685b4d18c9c6 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::pressureInletOutletParSlipVelocityFvPatchVectorField
+\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions
+
Description
This velocity inlet/outlet boundary condition for pressure boundary where
the pressure is specified. A zero-gradient is applied for outflow (as
@@ -67,8 +66,6 @@ SeeAlso
SourceFiles
pressureInletOutletParSlipVelocityFvPatchVectorField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef pressureInletOutletParSlipVelocityFvPatchVectorField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H
index 4c7819530b6f18196019841fb18eaf34ff0ec37a..71b4ce42381b38598ecf713cb638258bc6dd150a 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::pressureInletOutletVelocityFvPatchVectorField
+\ingroup grpInletletBoundaryConditions grpOutletBoundaryConditions
+
Description
This velocity inlet/outlet boundary condition is applied to pressure
boundaries where the pressure is specified. A zero-gradient condtion is
@@ -63,8 +62,6 @@ Description
SourceFiles
pressureInletOutletVelocityFvPatchVectorField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef pressureInletOutletVelocityFvPatchVectorField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H
index 998618e70ebc7820ed2366e8e687e3b2b8ad57cb..ed9cf681886a0bf5cf2429c6af30d76a50e87709 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::pressureInletUniformVelocityFvPatchVectorField
+\ingroup grpInletBoundaryConditions
+
Description
This velocity inlet boundary condition is applied to patches where the
pressure is specified. The uniform inflow velocity is obtained by
@@ -47,8 +46,6 @@ Description
SourceFiles
pressureInletUniformVelocityFvPatchVectorField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef pressureInletUniformVelocityFvPatchVectorField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H
index f80907d44e426efb9138f3e8c428dd4ad64867e0..3acb22984be878a960d6b157295c557c8a748a04 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::pressureInletVelocityFvPatchVectorField
+\ingroup grpInletBoundaryConditions
+
Description
This velocity inlet boundary condition is applied to patches where the
pressure is specified. The inflow velocity is obtained from the flux with
@@ -56,8 +55,6 @@ SeeAlso
SourceFiles
pressureInletVelocityFvPatchVectorField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef pressureInletVelocityFvPatchVectorField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H
index c98432a91c1760d38ab0539b856bd16d1bd331b8..7cfb0c639af0f6eea827b14dcd4631f636e6d4a1 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::pressureNormalInletOutletVelocityFvPatchVectorField
+\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions
+
Description
This velocity inlet/outlet boundary condition is applied to patches where
the pressure is specified. A zero-gradient condition is applied for
@@ -64,8 +63,6 @@ SeeAlso
SourceFiles
pressureNormalInletOutletVelocityFvPatchVectorField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef pressureNormalInletOutletVelocityFvPatchVectorField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H
index 177cf183678105b96f6e5c0849596aaa6d96de31..2a5254195d0f248e99342e2cf6c529b481cb10fe 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::rotatingPressureInletOutletVelocityFvPatchVectorField
+\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions
+
Description
This velocity inlet/outlet boundary condition is applied to patches in a
rotating frame where the pressure is specified. A zero-gradient is applied
@@ -68,8 +67,6 @@ SeeAlso
SourceFiles
rotatingPressureInletOutletVelocityFvPatchVectorField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef rotatingPressureInletOutletVelocityFvPatchVectorField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H
index 88c248287a09beed935b924985dd9b6966abcded..29c9eb822cd1d28577d731729f0c1bde2d8d6aa1 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::rotatingTotalPressureFvPatchScalarField
+\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions
+
Description
This boundary condition provides a total pressure condition for patches
in a rotating frame.
@@ -68,8 +67,6 @@ SeeAlso
SourceFiles
rotatingTotalPressureFvPatchScalarField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef rotatingTotalPressureFvPatchScalarField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H
index 4ace034757f92f201efc2225b0050ff595405de0..bfdce14ba719e68b3dfa309c75368d2245faef34 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::rotatingWallVelocityFvPatchVectorField
+\ingroup grpWallBoundaryConditions grpGenericBoundaryConditions
+
Description
This boundary condition provides a rotational velocity condition.
@@ -60,8 +59,6 @@ SeeAlso
SourceFiles
rotatingWallVelocityFvPatchVectorField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef rotatingWallVelocityFvPatchVectorField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H
index 74e40224c1898905acf4f592515d7a0ffff8f1c9..f216b358edd54b19018ed39032b48cafd354c136 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::slipFvPatchField
+\ingroup grpWallBoundaryConditions grpGenericBoundaryConditions
+
Description
This boundary condition provides a slip constraint.
@@ -43,8 +42,6 @@ Description
SourceFiles
slipFvPatchField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef slipFvPatchField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H
index 9b1bfdf2f1f8d88b0ac5c6f02d2c6870c5076f45..fca7044c7801f7f8677ea6af5655da4746685445 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::supersonicFreestreamFvPatchVectorField
+\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions
+
Description
This boundary condition provides a supersonic free-stream condition.
@@ -65,8 +64,6 @@ Description
SourceFiles
supersonicFreestreamFvPatchVectorField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef supersonicFreestreamFvPatchVectorFields_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H
index 20d5db217049b927048e912e8569b0e6e3863629..5f223d6dbc6a80100951dc9a06314355774b9e6e 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::surfaceNormalFixedValueFvPatchVectorField
+\ingroup grpGenericBoundaryConditions grpInletBoundaryConditions
+
Description
This boundary condition provides a surface-normal vector boundary condition
by its magnitude.
@@ -57,8 +56,6 @@ SeeAlso
SourceFiles
surfaceNormalFixedValueFvPatchVectorField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef surfaceNormalFixedValueFvPatchVectorField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H
index 6f36c8276a9f977bcaf82bdd5a749c466e6eb24f..1be1e1ca923efc9e7404a7b0f736d3f58a08591f 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::swirlFlowRateInletVelocityFvPatchVectorField
+\ingroup grpInletBoundaryConditions
+
Description
This boundary condition provides a volumetric- OR mass-flow normal vector
boundary condition by its magnitude as an integral over its area with a
@@ -69,8 +68,6 @@ SeeAlso
SourceFiles
swirlFlowRateInletVelocityFvPatchVectorField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef swirlFlowRateInletVelocityFvPatchVectorField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H
index 5ca3c7006fac144a6f42e7779148bf24ccdbd2a6..8e40b42d9a27f08fab847af7561222c90cef8429 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::syringePressureFvPatchScalarField
+\ingroup grpInletBoundaryConditions
+
Description
This boundary condition provides a pressure condition, obtained from a
zero-D model of the cylinder of a syringe.
@@ -78,8 +77,6 @@ SeeAlso
SourceFiles
syringePressureFvPatchScalarField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef syringePressureFvPatchScalarField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H
index 4be80e9d15c0e875f8579b9906d4aff8cb51ef53..8433ddfa2142c2143bf53c157561ec70b363aac2 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::temperatureJumpFvPatchScalarField
+\ingroup grpCoupledBoundaryConditions
+
Description
This boundary condition provides a temperature jump condition across a
coupled pair of cyclic patches.
@@ -65,8 +64,6 @@ SeeAlso
SourceFiles
temperatureJumpFvPatchScalarField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef temperatureJumpFvPatchScalarField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H
index 916d3364e7ed3979fd1c3a6a45dc9066960e58ac..9566c298b45e62b08b3a196c3d83525168286182 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::timeVaryingMappedFixedValueFvPatchField
+\ingroup grpInletBoundaryConditions grpCoupledBoundaryConditions
+
Description
This boundary conditions interpolates the values from a set of supplied
points in space and time. Supplied data should be specified in
@@ -70,7 +69,6 @@ SeeAlso
SourceFiles
timeVaryingMappedFixedValueFvPatchField.C
-@}
\*---------------------------------------------------------------------------*/
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H
index 3b2af53cb2ec753b2cac76e693d72b53712c8f70..715c993cf4efbfe7bbc70554034a921c935a3cef 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::totalPressureFvPatchScalarField
+\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions
+
Description
This boundary condition provides a total pressure condition. Four
variants are possible:
@@ -122,7 +121,6 @@ SeeAlso
SourceFiles
totalPressureFvPatchScalarField.C
-@}
\*---------------------------------------------------------------------------*/
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H
index 7f6137709b98b2ca044a666b260ef4439bcd3020..c095b2fbd0f86d8875ee81fb1f8706473bffb029 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H
@@ -24,12 +24,37 @@ License
Class
Foam::totalTemperatureFvPatchScalarField
+\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions
+
Description
- Foam::totalTemperatureFvPatchScalarField
+ This boundary condition provides a total temperature condition.
+
+ /heading Patch usage
+
+ /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
+
+ Example of the boundary condition specification:
+ \verbatim
+ myPatch
+ {
+ type totalTemperature;
+ T0 uniform 300;
+ }
+ \endverbatim
SourceFiles
totalTemperatureFvPatchScalarField.C
+SeeAlso
+ Foam::fixedValueFvPatchField
+
\*---------------------------------------------------------------------------*/
#ifndef totalTemperatureFvPatchScalarField_H
@@ -43,7 +68,7 @@ namespace Foam
{
/*---------------------------------------------------------------------------*\
- Class totalTemperatureFvPatch Declaration
+ Class totalTemperatureFvPatchScalarField Declaration
\*---------------------------------------------------------------------------*/
class totalTemperatureFvPatchScalarField
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H
index 43c7d4624146741c2a9c274cb619b1c42c9dbb0b..bff3ffeccb791dabe754a0ab27ddd7982f25c46b 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::translatingWallVelocityFvPatchVectorField
+\ingroup grpWallBoundaryConditions grpGenericBoundaryConditions
+
Description
This boundary condition provides a velocity condition for translational
motion on walls.
@@ -54,8 +53,6 @@ SeeAlso
SourceFiles
translatingWallVelocityFvPatchVectorField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef translatingWallVelocityFvPatchVectorField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H
index b076c6d3a703f1ca739ffbcafc5926963a395845..2d61ae94d34caf5b27bdea8bfc6b9946294c1aad 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::turbulentInletFvPatchField
+\ingroup grpInletBoundaryConditions
+
Description
This boundary condition generates a fluctuating inlet condition by adding
a random component to a reference (mean) field.
@@ -72,8 +71,6 @@ SeeAlso
SourceFiles
turbulentInletFvPatchField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef turbulentInletFvPatchField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H
index 5f527974e63c15d25f0ebf04b7a42a1ca4d6c425..1774e06f02a8c7e60439bcdc5703ddd532c65215 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::turbulentIntensityKineticEnergyInletFvPatchScalarField
+\ingroup grpInletBoundaryConditions
+
Description
This boundary condition provides a turbulent kinetic energy condition,
based on user-supplied turbulence intensity, defined as a fraction of the
@@ -71,8 +70,6 @@ SeeAlso
SourceFiles
turbulentIntensityKineticEnergyInletFvPatchScalarField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef turbulentIntensityKineticEnergyInletFvPatchScalarField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H
index f83063259985b4aa93ee4ec4fdef0f8e786a7521..a8002088a22a7f20aa722af5ae4b80d3f6b7f86c 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::uniformDensityHydrostaticPressureFvPatchScalarField
+\ingroup grpGenericBoundaryConditions
+
Description
This boundary condition provides a hydrostatic pressure condition,
calculated as:
@@ -68,8 +67,6 @@ Description
SourceFiles
uniformDensityHydrostaticPressureFvPatchScalarField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef uniformDensityHydrostaticPressureFvPatchScalarField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H
index cee5ce1a983d2c803e56284942bfea92e4ac21a5..4953b2ef2c2ee0988ba0139b68435a014e9d798f 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::uniformFixedValueFvPatchField
+\ingroup grpGenericBoundaryConditions
+
Description
This boundary condition provides a uniform fixed value condition.
@@ -58,8 +57,6 @@ SeeAlso
SourceFiles
uniformFixedValueFvPatchField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef uniformFixedValueFvPatchField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H
index c1df5d16b6ba56eceeaf8151fae936e4c95e68ea..4aab5f54fe665dad4116c3b66d320303242f2295 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::uniformTotalPressureFvPatchScalarField
+\ingroup grpInletBoundaryConditions grpOutletBoundaryConditions
+
Description
This boundary condition provides a time-varying form of the uniform total
pressure boundary condition.
@@ -74,8 +73,6 @@ SeeAlso
SourceFiles
uniformTotalPressureFvPatchScalarField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef uniformTotalPressureFvPatchScalarField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H
index 7ddf30d829d481eecc6e1571d1faaf4666d89b20..e9b764fe5364497d8b62ffe586615ba6d2e82fe0 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::variableHeightFlowRateFvPatchScalarField
+\ingroup grpInletBoundaryConditions
+
Description
This boundary condition provides a phase fraction condition based on the
local flow conditions, whereby the values are constrained to lay between
@@ -64,8 +63,6 @@ Description
SourceFiles
variableHeightFlowRateFvPatchScalarField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef variableHeightFlowRateFvPatchScalarField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H
index e4ec5f276378bc6455762dbf7390735c2758f7a4..cef322e614526729930d201fa15214cad1c6ae1b 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::variableHeightFlowRateInletVelocityFvPatchVectorField
+\ingroup grpInletBoundaryConditions
+
Description
This boundary condition provides a velocity boundary condition for
multphase flow based on a user-specified volumetric flow rate.
@@ -63,8 +62,6 @@ SeeAlso
SourceFiles
variableHeightFlowRateInletVelocityFvPatchVectorField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef variableHeightFlowRateInletVelocityFvPatchVectorField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H
index 6e620dcc4db00e77941cba113853f7b4901d692f..feab7a21c0d5c1207098ba187b4bf53c81487adf 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::waveSurfacePressureFvPatchScalarField
+\ingroup grpInletBoundaryConditions
+
Description
This is a pressure boundary condition, whose value is calculated as
the hydrostatic pressure based on a given displacement:
@@ -74,8 +73,6 @@ SeeAlso
SourceFiles
waveSurfacePressureFvPatchScalarField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef waveSurfacePressureFvPatchScalarField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H
index fedeed77077a785e989a69f90a8cd9beacf79cf7..9e30f3701b3aec893f4d19a57e7ed5a08ae244dc 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H
@@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\addtogroup grpBoundaryConditions
-@{
-
Class
Foam::waveTransmissiveFvPatchField
+\ingroup grpOutletBoundaryConditions
+
Description
This boundary condition provides a wave transmissive outflow condition,
based onsolving DDt(psi, U) = 0 at the boundary.
@@ -74,8 +73,6 @@ SeeAlso
SourceFiles
waveTransmissiveFvPatchField.C
-@}
-
\*---------------------------------------------------------------------------*/
#ifndef waveTransmissiveFvPatchField_H
diff --git a/src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchField.H b/src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchField.H
index 90a1b9ef98735ba6248757714d50812ab0e0cdab..4dc1041ffcba443bd3539f7b5e238217c5f76b6d 100644
--- a/src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchField.H
@@ -21,11 +21,6 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-\defgroup grpBoundaryConditions Boundary Conditions
-@{
- This group contains OpenFOAM boundary condition types
-@}
-
Class
Foam::fvPatchField
diff --git a/src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchFieldDoc.H b/src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchFieldDoc.H
new file mode 100644
index 0000000000000000000000000000000000000000..4918858612110fa4797734509babb5c96ba0c78e
--- /dev/null
+++ b/src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchFieldDoc.H
@@ -0,0 +1,67 @@
+/*---------------------------------------------------------------------------*\
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Copyright (C) 2012 OpenFOAM Foundation
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+License
+ This file is part of OpenFOAM.
+
+ OpenFOAM is free software: you can redistribute it and/or modify it
+ under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
+ ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+\defgroup grpBoundaryConditions Boundary Conditions
+@{
+ This group contains OpenFOAM boundary condition types
+@}
+
+\defgroup grpConstraintBoundaryConditions Constraint boundary Conditions
+@{
+ \ingroup grpBoundaryConditions
+ This group contains constraint boundary condition types
+@}
+
+\defgroup grpInletBoundaryConditions Inlet boundary Conditions
+@{
+ \ingroup grpBoundaryConditions
+ This group contains inlet boundary condition types
+@}
+
+\defgroup grpOutletBoundaryConditions Outlet boundary Conditions
+@{
+ \ingroup grpBoundaryConditions
+ This group contains outlet boundary condition types
+@}
+
+\defgroup grpGenericBoundaryConditions Generic boundary Conditions
+@{
+ \ingroup grpBoundaryConditions
+ This group contains generic boundary condition types
+@}
+
+\defgroup grpGenericBoundaryConditions Coupled boundary Conditions
+@{
+ \ingroup grpBoundaryConditions
+ This group contains coupled boundary condition types
+@}
+
+\defgroup grpWallBoundaryConditions Wall boundary Conditions
+@{
+ \ingroup grpBoundaryConditions
+ This group contains wall boundary condition types
+@}
+
+// ************************************************************************* //