ENH: Lagrangian injection models - updated header documentation for Doxygen

src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/CellZoneInjection/CellZoneInjection.H

@@ -27,10 +27,12 @@ Class
 Description
     Injection positions specified by a particle number density within a cell set
 
-    - User specifies
-      - Number density of particles in cell set (effective)
-      - Total mass to inject
-      - Initial parcel velocity
+    User specifies
+    - Number density of particles in cell set (effective)
+    - Total mass to inject
+    - Initial parcel velocity
+
+    Additional
     - Parcel diameters obtained by PDF model
     - All parcels introduced at SOI
 

src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeInjection/ConeInjection.H

@@ -26,12 +26,15 @@ Class
 
 Description
     Multi-point cone injection 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
+
+    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
+
+    Additional
     - Parcel diameters obtained by distribution model
 
 SourceFiles

src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeNozzleInjection/ConeNozzleInjection.H

@@ -27,22 +27,21 @@ Class
 Description
     Cone injection
 
-    - 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
+
+    Additional
     - Parcel diameters obtained by size distribution model
-
     - Parcel velocity is calculated as:
-
-        - Constant velocity
-            U = <specified by user>
-        - Pressure driven velocity
-            U = sqrt(2*(Pinj - Pamb)/rho)
-        - Flow rate and discharge
+       - Constant velocity
+           U = \<specified by user\>
+       - Pressure driven velocity
+           U = sqrt(2*(Pinj - Pamb)/rho)
+       - Flow rate and discharge
             U = V_dot/(A*Cd)
 
 SourceFiles

src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/FieldActivatedInjection/FieldActivatedInjection.H

@@ -25,18 +25,19 @@ Class
     Foam::FieldActivatedInjection
 
 Description
-    Injection at specified positions, with the conditions:
+    Conditional injection at specified positions.
 
-    - for injection to be allowed
+    For injection to be allowed, the equality must be satisfied:
 
         factor*referenceField[cellI] >= thresholdField[cellI]
 
-        where:
-          - referenceField is the field used to supply the look-up values
-          - thresholdField supplies the values beyond which the injection is
+        Where:
+        - referenceField is the field used to supply the look-up values
+        - thresholdField supplies the values beyond which the injection is
             permitted
 
-    - limited to a user-supllied number of injections per injector location
+    Note:
+    - Limited to a user-supplied number of injections per injector location
 
 SourceFiles
     FieldActivatedInjection.C
@@ -56,7 +57,7 @@ namespace Foam
 {
 
 /*---------------------------------------------------------------------------*\
-                    Class FieldActivatedInjection Declaration
+                   Class FieldActivatedInjection Declaration
 \*---------------------------------------------------------------------------*/
 
 template<class CloudType>

src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ManualInjection/ManualInjection.H

@@ -26,10 +26,13 @@ Class
 
 Description
     Manual injection
-    - User specifies
-      - Total mass to inject
-      - Parcel positions in file \c positionsFile
-      - Initial parcel velocity
+
+    User specifies
+    - Total mass to inject
+    - Parcel positions in file \c positionsFile
+    - Initial parcel velocity
+
+    Additional
     - Parcel diameters obtained by distribution model
     - All parcels introduced at SOI
 

src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/PatchInjection/PatchInjection.H

@@ -26,12 +26,15 @@ Class
 
 Description
     Patch injection
-    - User specifies
-      - Total mass to inject
-      - Name of patch
-      - Injection duration
-      - Initial parcel velocity
-      - Injection volume flow rate
+
+    User specifies
+    - Total mass to inject
+    - Name of patch
+    - Injection duration
+    - Initial parcel velocity
+    - Injection volume flow rate
+
+    Additional
     - Parcel diameters obtained by distribution model
     - Parcels injected randomly across the patch