From 9cfccd209329a7b43ff136e12ab2a03836295864 Mon Sep 17 00:00:00 2001
From: Henry Weller <http://cfd.direct>
Date: Thu, 16 Jun 2016 20:10:39 +0100
Subject: [PATCH] Simplify and correct Doxygen lists using '-' rather than '\li
\c'
---
...allHeatFluxTemperatureFvPatchScalarField.H | 10 +++---
...tureCoupledBaffleMixedFvPatchScalarField.H | 9 +++--
...eratureRadCoupledMixedFvPatchScalarField.H | 3 +-
.../utilities/writeObjects/writeObjects.H | 19 +++++-----
.../CellZoneInjection/CellZoneInjection.H | 16 ++++-----
.../ConeInjection/ConeInjection.H | 17 ++++-----
.../ConeNozzleInjection/ConeNozzleInjection.H | 35 ++++++++++---------
.../FieldActivatedInjection.H | 12 +++----
.../ManualInjection/ManualInjection.H | 16 ++++-----
.../PatchFlowRateInjection.H | 18 +++++-----
.../PatchInjection/PatchInjection.H | 18 +++++-----
.../StandardWallInteraction.H | 9 ++---
.../coordinateRotation/coordinateRotation.H | 9 +++--
.../coordinateRotation/cylindrical.H | 28 +++++++--------
.../coordinateSystems/coordinateSystem.H | 12 +++----
.../surfaceLocation/surfaceLocation.H | 12 +++----
.../decompose/ptscotchDecomp/ptscotchDecomp.H | 5 ++-
...sRadiativeCoupledMixedFvPatchScalarField.H | 4 +--
...ysisTemperatureCoupledFvPatchScalarField.H | 4 +--
...rolysisVelocityCoupledFvPatchVectorField.H | 11 +++---
.../thermalBaffleFvPatchScalarField.H | 16 ++++-----
.../alphaContactAngleFvPatchScalarField.H | 9 +++--
22 files changed, 145 insertions(+), 147 deletions(-)
diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H
index 241f673ad75..2f9b112d2eb 100644
--- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H
+++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H
@@ -34,8 +34,8 @@ Description
fixed heat transfer coefficient mode.
The condition can operate in two modes:
- - fixed heat transfer coefficient: supply h and Ta
- - fixed heat flux: supply q
+ - fixed heat transfer coefficient: supply h and Ta
+ - fixed heat flux: supply q
where:
\vartable
@@ -48,7 +48,6 @@ Description
mesh database using the \c lookup option, or from a \c solidThermo
thermophysical package.
-
\heading Patch usage
\table
@@ -83,9 +82,8 @@ Description
\endverbatim
Note:
-
- \li Only supply \c h and \c Ta, or \c q in the dictionary (see above)
- \li \c kappa and \c kappaName are inherited from temperatureCoupledBase.
+ - Only supply \c h and \c Ta, or \c q in the dictionary (see above)
+ - \c kappa and \c kappaName are inherited from temperatureCoupledBase.
SeeAlso
Foam::temperatureCoupledBase
diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureCoupledBaffleMixed/turbulentTemperatureCoupledBaffleMixedFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureCoupledBaffleMixed/turbulentTemperatureCoupledBaffleMixedFvPatchScalarField.H
index ffe99ac734e..a786c74babc 100644
--- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureCoupledBaffleMixed/turbulentTemperatureCoupledBaffleMixedFvPatchScalarField.H
+++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureCoupledBaffleMixed/turbulentTemperatureCoupledBaffleMixedFvPatchScalarField.H
@@ -36,9 +36,9 @@ Description
Specifies gradient and temperature such that the equations are the same
on both sides:
- - refGradient = zero gradient
- - refValue = neighbour value
- - mixFraction = nbrKDelta / (nbrKDelta + myKDelta())
+ - refGradient = zero gradient
+ - refValue = neighbour value
+ - mixFraction = nbrKDelta / (nbrKDelta + myKDelta())
where KDelta is heat-transfer coefficient K * deltaCoeffs
@@ -70,8 +70,7 @@ Description
Needs to be on underlying mapped(Wall)FvPatch.
Note:
-
- \li \c kappa and \c kappaName are inherited from temperatureCoupledBase.
+ - \c kappa and \c kappaName are inherited from temperatureCoupledBase.
SeeAlso
diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureRadCoupledMixed/turbulentTemperatureRadCoupledMixedFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureRadCoupledMixed/turbulentTemperatureRadCoupledMixedFvPatchScalarField.H
index 9a221014054..64290d47419 100644
--- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureRadCoupledMixed/turbulentTemperatureRadCoupledMixedFvPatchScalarField.H
+++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureRadCoupledMixed/turbulentTemperatureRadCoupledMixedFvPatchScalarField.H
@@ -67,8 +67,7 @@ Description
Needs to be on underlying mapped(Wall)FvPatch.
Note:
-
- \li \c kappa and \c kappaName are inherited from temperatureCoupledBase.
+ - \c kappa and \c kappaName are inherited from temperatureCoupledBase.
SeeAlso
diff --git a/src/functionObjects/utilities/writeObjects/writeObjects.H b/src/functionObjects/utilities/writeObjects/writeObjects.H
index db39de97db8..baae5bb5700 100644
--- a/src/functionObjects/utilities/writeObjects/writeObjects.H
+++ b/src/functionObjects/utilities/writeObjects/writeObjects.H
@@ -29,22 +29,23 @@ Group
Description
This function object allows specification of different writing frequency
- of objects registered to the database. It has similar functionality
- as the main time database through the writeControl setting:
+ of objects registered to the database.
- \li \c timeStep
- \li \c writeTime
- \li \c adjustableRunTime
- \li \c runTime
- \li \c clockTime
- \li \c cpuTime
+ It has similar functionality as the main time database through the
+ writeControl setting:
+ - timeStep
+ - writeTime
+ - adjustableRunTime
+ - runTime
+ - clockTime
+ - cpuTime
Example of function object specification:
\verbatim
writeObjects1
{
type writeObjects;
- libs ("libutilityFunctionObjects.so");
+ libs ("libutilityFunctionObjects.so");
exclusiveWriting true;
...
objectNames (obj1 obj2);
diff --git a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/CellZoneInjection/CellZoneInjection.H b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/CellZoneInjection/CellZoneInjection.H
index c5cb05a957c..9213037ee9f 100644
--- a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/CellZoneInjection/CellZoneInjection.H
+++ b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/CellZoneInjection/CellZoneInjection.H
@@ -28,14 +28,14 @@ Description
Injection positions specified by a particle number density within a cell
set.
- \li User specifies:
- - Number density of particles in cell set (effective)
- - Total mass to inject
- - Initial parcel velocity
-
- \li Parcel diameters obtained by PDF model
-
- \li All parcels introduced at SOI
+ User specifies:
+ - Number density of particles in cell set (effective)
+ - Total mass to inject
+ - Initial parcel velocity
+
+ Properties:
+ - Parcel diameters obtained by PDF model
+ - All parcels introduced at SOI
SourceFiles
CellZoneInjection.C
diff --git a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeInjection/ConeInjection.H b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeInjection/ConeInjection.H
index bacfaaa9977..a482be6af8a 100644
--- a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeInjection/ConeInjection.H
+++ b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeInjection/ConeInjection.H
@@ -27,14 +27,15 @@ Class
Description
Multi-point cone injection model.
- \li User specifies:
- - time of start of injection
- - list of injector positions and directions (along injection axes)
- - number of parcels to inject per injector
- - parcel velocities
- - inner and outer half-cone angles
-
- \li Parcel diameters obtained by distribution model
+ User specifies:
+ - time of start of injection
+ - list of injector positions and directions (along injection axes)
+ - number of parcels to inject per injector
+ - parcel velocities
+ - inner and outer half-cone angles
+
+ Properties:
+ - Parcel diameters obtained by distribution model
SourceFiles
ConeInjection.C
diff --git a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeNozzleInjection/ConeNozzleInjection.H b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeNozzleInjection/ConeNozzleInjection.H
index 6a29c1cc1d4..5d7e34f1180 100644
--- a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeNozzleInjection/ConeNozzleInjection.H
+++ b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeNozzleInjection/ConeNozzleInjection.H
@@ -27,30 +27,31 @@ Class
Description
Cone injection.
- \li User specifies:
- - time of start of injection
- - injector position
- - direction (along injection axis)
- - parcel flow rate
- - inner and outer half-cone angles
+ User specifies:
+ - time of start of injection
+ - injector position
+ - direction (along injection axis)
+ - parcel flow rate
+ - inner and outer half-cone angles
- \li Parcel diameters obtained by size distribution model
+ Properties:
+ - Parcel diameters obtained by size distribution model.
- \li Parcel velocity is calculated as:
+ - Parcel velocity is calculated as:
- Constant velocity:
- \verbatim
- U = \<specified by user\>
- \endverbatim
+ \verbatim
+ U = \<specified by user\>
+ \endverbatim
- Pressure driven velocity:
- \verbatim
- U = sqrt(2*(Pinj - Pamb)/rho)
- \endverbatim
+ \verbatim
+ U = sqrt(2*(Pinj - Pamb)/rho)
+ \endverbatim
- Flow rate and discharge:
- \verbatim
- U = V_dot/(A*Cd)
- \endverbatim
+ \verbatim
+ U = V_dot/(A*Cd)
+ \endverbatim
SourceFiles
ConeNozzleInjection.C
diff --git a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/FieldActivatedInjection/FieldActivatedInjection.H b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/FieldActivatedInjection/FieldActivatedInjection.H
index 986f1b46b80..c55ebc829b6 100644
--- a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/FieldActivatedInjection/FieldActivatedInjection.H
+++ b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/FieldActivatedInjection/FieldActivatedInjection.H
@@ -27,16 +27,16 @@ Class
Description
Injection at specified positions, with the conditions:
- \li for injection to be allowed
- \verbatim
- factor*referenceField[celli] >= thresholdField[celli]
- \endverbatim
- where:
+ For injection to be allowed
+ \verbatim
+ factor*referenceField[celli] >= thresholdField[celli]
+ \endverbatim
+ where:
- \c referenceField is the field used to supply the look-up values
- \c thresholdField supplies the values beyond which the injection is
permitted.
- \li limited to a user-supllied number of injections per injector location
+ Limited to a user-supplied number of injections per injector location
SourceFiles
FieldActivatedInjection.C
diff --git a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ManualInjection/ManualInjection.H b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ManualInjection/ManualInjection.H
index b3e78f8c456..01ecf0d5c6a 100644
--- a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ManualInjection/ManualInjection.H
+++ b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ManualInjection/ManualInjection.H
@@ -27,14 +27,14 @@ Class
Description
Manual injection.
- \li User specifies:
- - Total mass to inject
- - Parcel positions in file \c positionsFile
- - Initial parcel velocity
-
- \li Parcel diameters obtained by distribution model
-
- \li All parcels introduced at SOI
+ User specifies:
+ - Total mass to inject
+ - Parcel positions in file \c positionsFile
+ - Initial parcel velocity
+
+ Properties:
+ - Parcel diameters obtained by distribution model
+ - All parcels introduced at SOI
SourceFiles
ManualInjection.C
diff --git a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/PatchFlowRateInjection/PatchFlowRateInjection.H b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/PatchFlowRateInjection/PatchFlowRateInjection.H
index d4c3ee15219..df767d2fd66 100644
--- a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/PatchFlowRateInjection/PatchFlowRateInjection.H
+++ b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/PatchFlowRateInjection/PatchFlowRateInjection.H
@@ -28,14 +28,16 @@ Description
Patch injection, by using patch flow rate to determine concentration and
velocity.
- \li User specifies
- - Total mass to inject
- - Name of patch
- - Injection duration
- - Injection target concentration/carrier volume flow rate
- \li Initial parcel velocity given by local flow velocity
- \li Parcel diameters obtained by distribution model
- \li Parcels injected randomly across the patch
+ User specifies:
+ - Total mass to inject
+ - Name of patch
+ - Injection duration
+ - Injection target concentration/carrier volume flow rate
+
+ Properties:
+ - Initial parcel velocity given by local flow velocity
+ - Parcel diameters obtained by distribution model
+ - Parcels injected randomly across the patch
SourceFiles
PatchFlowRateInjection.C
diff --git a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/PatchInjection/PatchInjection.H b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/PatchInjection/PatchInjection.H
index 7c02e416387..b1c0825ecf8 100644
--- a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/PatchInjection/PatchInjection.H
+++ b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/PatchInjection/PatchInjection.H
@@ -27,14 +27,16 @@ Class
Description
Patch injection.
- \li User specifies:
- - Total mass to inject
- - Name of patch
- - Injection duration
- - Initial parcel velocity
- - Injection volume flow rate
- \li Parcel diameters obtained by distribution model
- \li Parcels injected randomly across the patch
+ User specifies:
+ - Total mass to inject
+ - Name of patch
+ - Injection duration
+ - Initial parcel velocity
+ - Injection volume flow rate
+
+ Properties:
+ - Parcel diameters obtained by distribution model
+ - Parcels injected randomly across the patch
SourceFiles
PatchInjection.C
diff --git a/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/StandardWallInteraction/StandardWallInteraction.H b/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/StandardWallInteraction/StandardWallInteraction.H
index a5abf354a66..b2aeb491c8d 100644
--- a/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/StandardWallInteraction/StandardWallInteraction.H
+++ b/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/StandardWallInteraction/StandardWallInteraction.H
@@ -25,11 +25,12 @@ Class
Foam::StandardWallInteraction
Description
- Wall interaction model. Three choices:
+ Wall interaction model.
- \li \c rebound - optionally specify elasticity and restitution coefficients
- \li \c stick - particles assigned zero velocity
- \li \c escape - remove particle from the domain
+ Three choices:
+ - rebound - optionally specify elasticity and restitution coefficients
+ - stick - particles assigned zero velocity
+ - escape - remove particle from the domain
Example usage:
\verbatim
diff --git a/src/meshTools/coordinateSystems/coordinateRotation/coordinateRotation.H b/src/meshTools/coordinateSystems/coordinateRotation/coordinateRotation.H
index cfee8caf4a5..085fff4f324 100644
--- a/src/meshTools/coordinateSystems/coordinateRotation/coordinateRotation.H
+++ b/src/meshTools/coordinateSystems/coordinateRotation/coordinateRotation.H
@@ -37,11 +37,10 @@ Description
\endverbatim
Types of coordinateRotation:
-
- \li 1. axesRotation
- \li 2. STARCDRotation
- \li 3. cylindrical
- \li 4. EulerCoordinateRotation
+ -# axesRotation
+ -# STARCDRotation
+ -# cylindrical
+ -# EulerCoordinateRotation
SourceFiles
coordinateRotation.C
diff --git a/src/meshTools/coordinateSystems/coordinateRotation/cylindrical.H b/src/meshTools/coordinateSystems/coordinateRotation/cylindrical.H
index 0a846ad0019..60e837006da 100644
--- a/src/meshTools/coordinateSystems/coordinateRotation/cylindrical.H
+++ b/src/meshTools/coordinateSystems/coordinateRotation/cylindrical.H
@@ -26,21 +26,21 @@ Class
Description
A local coordinate rotation.
- The cell based rotational field can be created in two ways:
-
- \li 1. Each rotational tensor is defined with two vectors (\c dir and \c e3)
- where <tt>dir = cellC - origin</tt> and \c e3 is the rotation axis.
- Per each cell an axesRotation type of rotation is created
- (cylindrical coordinates). For example:
- \verbatim
- cylindrical
- {
- type localAxes;
- e3 (0 0 1);
- }
- \endverbatim
- \li 2. The rotational tensor field is provided at construction.
+ The cell based rotational field can be created in two ways:
+ -# Each rotational tensor is defined with two vectors (\c dir and \c e3)
+ where <tt>dir = cellC - origin</tt> and \c e3 is the rotation axis.
+ Per each cell an axesRotation type of rotation is created
+ (cylindrical coordinates). For example:
+ \verbatim
+ cylindrical
+ {
+ type localAxes;
+ e3 (0 0 1);
+ }
+ \endverbatim
+
+ -# The rotational tensor field is provided at construction.
SourceFiles
cylindrical.C
diff --git a/src/meshTools/coordinateSystems/coordinateSystem.H b/src/meshTools/coordinateSystems/coordinateSystem.H
index be719150b7d..bc1d9003cc1 100644
--- a/src/meshTools/coordinateSystems/coordinateSystem.H
+++ b/src/meshTools/coordinateSystems/coordinateSystem.H
@@ -43,15 +43,13 @@ Description
\endverbatim
Types of coordinateRotation:
-
- \li 1. axesRotation
- \li 2. STARCDRotation
- \li 3. cylindrical
- \li 4. EulerCoordinateRotation
+ -# axesRotation
+ -# \link STARCDCoordinateRotation STARCDRotation \endlink
+ -# cylindricalCS cylindrical
+ -# EulerCoordinateRotation
Type of co-ordinates:
-
- \li 1. cartesian
+ -# \link cartesianCS cartesian \endlink
SourceFiles
diff --git a/src/meshTools/triSurface/surfaceLocation/surfaceLocation.H b/src/meshTools/triSurface/surfaceLocation/surfaceLocation.H
index 7bc2263f6b4..e0c7dc45495 100644
--- a/src/meshTools/triSurface/surfaceLocation/surfaceLocation.H
+++ b/src/meshTools/triSurface/surfaceLocation/surfaceLocation.H
@@ -25,20 +25,18 @@ Class
Foam::surfaceLocation
Description
- Contains information about location on a triSurface:
+ Contains information about location on a triSurface
- \li pointIndexHit:
+ Access to data:
+ - pointIndexHit provides
- location
- bool: hit/miss
- index (of triangle/point/edge)
-
- \li elementType():
+ - elementType() provides
- what index above relates to. In triangle::proxType
-
- \li triangle():
+ - triangle() provides
- last known triangle
-
SourceFiles
surfaceLocation.C
diff --git a/src/parallel/decompose/ptscotchDecomp/ptscotchDecomp.H b/src/parallel/decompose/ptscotchDecomp/ptscotchDecomp.H
index 5cb64e4be6d..1465ff2daab 100644
--- a/src/parallel/decompose/ptscotchDecomp/ptscotchDecomp.H
+++ b/src/parallel/decompose/ptscotchDecomp/ptscotchDecomp.H
@@ -37,9 +37,8 @@ Description
\endverbatim
where:
-
- \li \c %r gets replaced by current processor rank
- \li it will decompose into 2 domains
+ - %r gets replaced by current processor rank
+ - it will decompose into 2 domains
SeeAlso
Foam::scotchDecomp
diff --git a/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisRadiativeCoupledMixed/filmPyrolysisRadiativeCoupledMixedFvPatchScalarField.H b/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisRadiativeCoupledMixed/filmPyrolysisRadiativeCoupledMixedFvPatchScalarField.H
index 16f7e9ff6ba..9e1ed0f978d 100644
--- a/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisRadiativeCoupledMixed/filmPyrolysisRadiativeCoupledMixedFvPatchScalarField.H
+++ b/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisRadiativeCoupledMixed/filmPyrolysisRadiativeCoupledMixedFvPatchScalarField.H
@@ -66,8 +66,8 @@ Description
Notes:
- \li \c kappa and \c kappaName are inherited from temperatureCoupledBase.
- \li \c Qr is the radiative flux defined in the radiation model.
+ - kappa and \c kappaName are inherited from temperatureCoupledBase.
+ - Qr is the radiative flux defined in the radiation model.
SeeAlso
diff --git a/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisTemperatureCoupled/filmPyrolysisTemperatureCoupledFvPatchScalarField.H b/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisTemperatureCoupled/filmPyrolysisTemperatureCoupledFvPatchScalarField.H
index 84c7932d72f..2e068ccf4e9 100644
--- a/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisTemperatureCoupled/filmPyrolysisTemperatureCoupledFvPatchScalarField.H
+++ b/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisTemperatureCoupled/filmPyrolysisTemperatureCoupledFvPatchScalarField.H
@@ -30,8 +30,8 @@ Description
for patches on the primary region based on whether the patch is seen to
be 'wet', retrieved from the film alpha field.
- \li if the patch is wet, the temperature is set using the film temperature
- \li otherwise, it is set using pyrolysis temperature
+ - if the patch is wet, the temperature is set using the film temperature
+ - otherwise, it is set using pyrolysis temperature
Example of the boundary condition specification:
\verbatim
diff --git a/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisVelocityCoupled/filmPyrolysisVelocityCoupledFvPatchVectorField.H b/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisVelocityCoupled/filmPyrolysisVelocityCoupledFvPatchVectorField.H
index f4566b23252..df19b8fbdd5 100644
--- a/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisVelocityCoupled/filmPyrolysisVelocityCoupledFvPatchVectorField.H
+++ b/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisVelocityCoupled/filmPyrolysisVelocityCoupledFvPatchVectorField.H
@@ -26,12 +26,13 @@ Class
Description
This boundary condition is designed to be used in conjunction with surface
- film and pyrolysis modelling. It provides a velocity boundary condition
- for patches on the primary region based on whether the patch is seen to
- be 'wet', retrieved from the film alpha field.
+ film and pyrolysis modelling.
- \li if the patch is wet, the velocity is set using the film velocity
- \li otherwise, it is set using pyrolysis out-gassing velocity
+ It provides a velocity boundary condition for patches on the primary region
+ based on whether the patch is seen to be 'wet', retrieved from the film
+ alpha field.
+ - if the patch is wet, the velocity is set using the film velocity
+ - otherwise, it is set using pyrolysis out-gassing velocity
Example of the boundary condition specification:
\verbatim
diff --git a/src/regionModels/thermalBaffleModels/derivedFvPatchFields/thermalBaffle/thermalBaffleFvPatchScalarField.H b/src/regionModels/thermalBaffleModels/derivedFvPatchFields/thermalBaffle/thermalBaffleFvPatchScalarField.H
index 389672e74fc..d5f15aa003d 100644
--- a/src/regionModels/thermalBaffleModels/derivedFvPatchFields/thermalBaffle/thermalBaffleFvPatchScalarField.H
+++ b/src/regionModels/thermalBaffleModels/derivedFvPatchFields/thermalBaffle/thermalBaffleFvPatchScalarField.H
@@ -29,16 +29,16 @@ Group
Description
This boundary condition provides a coupled temperature condition between
- multiple mesh regions. The regions are generally referred to as the:
+ multiple mesh regions.
- \li primary region,
- \li and baffle region.
+ The regions are generally referred to as the:
+ - primary region,
+ - and baffle region.
The primary region creates the baffle region and evolves its energy
equation either:
-
- - 1-D, normal to each patch face
- - 2-D, normal and tangential components
+ - 1-D, normal to each patch face
+ - 2-D, normal and tangential components
The thermodynamic properties of the baffle material are specified via
dictionary entries on the master patch.
@@ -118,7 +118,7 @@ Description
}
\endverbatim
- \li Slave patch on primary region
+ Slave patch on primary region:
\verbatim
myPatch_slave
{
@@ -129,7 +129,7 @@ Description
\endverbatim
- \li Patches on baffle region
+ Patches on baffle region:
\verbatim
bottom
{
diff --git a/src/transportModels/twoPhaseProperties/alphaContactAngle/alphaContactAngle/alphaContactAngleFvPatchScalarField.H b/src/transportModels/twoPhaseProperties/alphaContactAngle/alphaContactAngle/alphaContactAngleFvPatchScalarField.H
index 550868bf457..d1af35cd78d 100644
--- a/src/transportModels/twoPhaseProperties/alphaContactAngle/alphaContactAngle/alphaContactAngleFvPatchScalarField.H
+++ b/src/transportModels/twoPhaseProperties/alphaContactAngle/alphaContactAngle/alphaContactAngleFvPatchScalarField.H
@@ -34,12 +34,11 @@ Description
wall contact angle field.
The essential entry "limit" controls the gradient of alpha1 on the wall:
-
- \li \c none - Calculate the gradient from the contact-angle without limiter
- \li \c gradient - Limit the wall-gradient such that alpha1 remains bounded
+ - none - Calculate the gradient from the contact-angle without limiter
+ - gradient - Limit the wall-gradient such that alpha1 remains bounded
on the wall
- \li \c alpha - Bound the calculated alpha1 on the wall
- \li \c zeroGradient - Set the gradient of alpha1 to 0 on the wall, i.e.
+ - alpha - Bound the calculated alpha1 on the wall
+ - zeroGradient - Set the gradient of alpha1 to 0 on the wall, i.e.
reproduce previous behaviour, the pressure BCs can be left as before.
Note that if any of the first three options are used the boundary condition
--
GitLab