Commit 19ef3974 authored by Henry Weller's avatar Henry Weller
Browse files

Simplify and correct Doxygen lists using '-' rather than '\li \c'

parent 2fc8911d
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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);
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment