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

This commit is contained in:
Henry Weller
2016-06-16 20:10:39 +01:00
parent c2dcd18887
commit 9cfccd2093
22 changed files with 141 additions and 143 deletions

View File

@ -34,8 +34,8 @@ Description
fixed heat transfer coefficient mode. fixed heat transfer coefficient mode.
The condition can operate in two modes: The condition can operate in two modes:
- fixed heat transfer coefficient: supply h and Ta - fixed heat transfer coefficient: supply h and Ta
- fixed heat flux: supply q - fixed heat flux: supply q
where: where:
\vartable \vartable
@ -48,7 +48,6 @@ Description
mesh database using the \c lookup option, or from a \c solidThermo mesh database using the \c lookup option, or from a \c solidThermo
thermophysical package. thermophysical package.
\heading Patch usage \heading Patch usage
\table \table
@ -83,9 +82,8 @@ Description
\endverbatim \endverbatim
Note: Note:
- Only supply \c h and \c Ta, or \c q in the dictionary (see above)
\li Only supply \c h and \c Ta, or \c q in the dictionary (see above) - \c kappa and \c kappaName are inherited from temperatureCoupledBase.
\li \c kappa and \c kappaName are inherited from temperatureCoupledBase.
SeeAlso SeeAlso
Foam::temperatureCoupledBase Foam::temperatureCoupledBase

View File

@ -36,9 +36,9 @@ Description
Specifies gradient and temperature such that the equations are the same Specifies gradient and temperature such that the equations are the same
on both sides: on both sides:
- refGradient = zero gradient - refGradient = zero gradient
- refValue = neighbour value - refValue = neighbour value
- mixFraction = nbrKDelta / (nbrKDelta + myKDelta()) - mixFraction = nbrKDelta / (nbrKDelta + myKDelta())
where KDelta is heat-transfer coefficient K * deltaCoeffs where KDelta is heat-transfer coefficient K * deltaCoeffs
@ -70,8 +70,7 @@ Description
Needs to be on underlying mapped(Wall)FvPatch. Needs to be on underlying mapped(Wall)FvPatch.
Note: Note:
- \c kappa and \c kappaName are inherited from temperatureCoupledBase.
\li \c kappa and \c kappaName are inherited from temperatureCoupledBase.
SeeAlso SeeAlso

View File

@ -67,8 +67,7 @@ Description
Needs to be on underlying mapped(Wall)FvPatch. Needs to be on underlying mapped(Wall)FvPatch.
Note: Note:
- \c kappa and \c kappaName are inherited from temperatureCoupledBase.
\li \c kappa and \c kappaName are inherited from temperatureCoupledBase.
SeeAlso SeeAlso

View File

@ -29,22 +29,23 @@ Group
Description Description
This function object allows specification of different writing frequency This function object allows specification of different writing frequency
of objects registered to the database. It has similar functionality of objects registered to the database.
as the main time database through the writeControl setting:
\li \c timeStep It has similar functionality as the main time database through the
\li \c writeTime writeControl setting:
\li \c adjustableRunTime - timeStep
\li \c runTime - writeTime
\li \c clockTime - adjustableRunTime
\li \c cpuTime - runTime
- clockTime
- cpuTime
Example of function object specification: Example of function object specification:
\verbatim \verbatim
writeObjects1 writeObjects1
{ {
type writeObjects; type writeObjects;
libs ("libutilityFunctionObjects.so"); libs ("libutilityFunctionObjects.so");
exclusiveWriting true; exclusiveWriting true;
... ...
objectNames (obj1 obj2); objectNames (obj1 obj2);

View File

@ -28,14 +28,14 @@ Description
Injection positions specified by a particle number density within a cell Injection positions specified by a particle number density within a cell
set. set.
\li User specifies: User specifies:
- Number density of particles in cell set (effective) - Number density of particles in cell set (effective)
- Total mass to inject - Total mass to inject
- Initial parcel velocity - Initial parcel velocity
\li Parcel diameters obtained by PDF model Properties:
- Parcel diameters obtained by PDF model
\li All parcels introduced at SOI - All parcels introduced at SOI
SourceFiles SourceFiles
CellZoneInjection.C CellZoneInjection.C

View File

@ -27,14 +27,15 @@ Class
Description Description
Multi-point cone injection model. Multi-point cone injection model.
\li User specifies: User specifies:
- time of start of injection - time of start of injection
- list of injector positions and directions (along injection axes) - list of injector positions and directions (along injection axes)
- number of parcels to inject per injector - number of parcels to inject per injector
- parcel velocities - parcel velocities
- inner and outer half-cone angles - inner and outer half-cone angles
\li Parcel diameters obtained by distribution model Properties:
- Parcel diameters obtained by distribution model
SourceFiles SourceFiles
ConeInjection.C ConeInjection.C

View File

@ -27,30 +27,31 @@ Class
Description Description
Cone injection. Cone injection.
\li User specifies: User specifies:
- time of start of injection - time of start of injection
- injector position - injector position
- direction (along injection axis) - direction (along injection axis)
- parcel flow rate - parcel flow rate
- inner and outer half-cone angles - 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: - Constant velocity:
\verbatim \verbatim
U = \<specified by user\> U = \<specified by user\>
\endverbatim \endverbatim
- Pressure driven velocity: - Pressure driven velocity:
\verbatim \verbatim
U = sqrt(2*(Pinj - Pamb)/rho) U = sqrt(2*(Pinj - Pamb)/rho)
\endverbatim \endverbatim
- Flow rate and discharge: - Flow rate and discharge:
\verbatim \verbatim
U = V_dot/(A*Cd) U = V_dot/(A*Cd)
\endverbatim \endverbatim
SourceFiles SourceFiles
ConeNozzleInjection.C ConeNozzleInjection.C

View File

@ -27,16 +27,16 @@ Class
Description Description
Injection at specified positions, with the conditions: Injection at specified positions, with the conditions:
\li for injection to be allowed For injection to be allowed
\verbatim \verbatim
factor*referenceField[celli] >= thresholdField[celli] factor*referenceField[celli] >= thresholdField[celli]
\endverbatim \endverbatim
where: where:
- \c referenceField is the field used to supply the look-up values - \c referenceField is the field used to supply the look-up values
- \c thresholdField supplies the values beyond which the injection is - \c thresholdField supplies the values beyond which the injection is
permitted. 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 SourceFiles
FieldActivatedInjection.C FieldActivatedInjection.C

View File

@ -27,14 +27,14 @@ Class
Description Description
Manual injection. Manual injection.
\li User specifies: User specifies:
- Total mass to inject - Total mass to inject
- Parcel positions in file \c positionsFile - Parcel positions in file \c positionsFile
- Initial parcel velocity - Initial parcel velocity
\li Parcel diameters obtained by distribution model Properties:
- Parcel diameters obtained by distribution model
\li All parcels introduced at SOI - All parcels introduced at SOI
SourceFiles SourceFiles
ManualInjection.C ManualInjection.C

View File

@ -28,14 +28,16 @@ Description
Patch injection, by using patch flow rate to determine concentration and Patch injection, by using patch flow rate to determine concentration and
velocity. velocity.
\li User specifies User specifies:
- Total mass to inject - Total mass to inject
- Name of patch - Name of patch
- Injection duration - Injection duration
- Injection target concentration/carrier volume flow rate - Injection target concentration/carrier volume flow rate
\li Initial parcel velocity given by local flow velocity
\li Parcel diameters obtained by distribution model Properties:
\li Parcels injected randomly across the patch - Initial parcel velocity given by local flow velocity
- Parcel diameters obtained by distribution model
- Parcels injected randomly across the patch
SourceFiles SourceFiles
PatchFlowRateInjection.C PatchFlowRateInjection.C

View File

@ -27,14 +27,16 @@ Class
Description Description
Patch injection. Patch injection.
\li User specifies: User specifies:
- Total mass to inject - Total mass to inject
- Name of patch - Name of patch
- Injection duration - Injection duration
- Initial parcel velocity - Initial parcel velocity
- Injection volume flow rate - Injection volume flow rate
\li Parcel diameters obtained by distribution model
\li Parcels injected randomly across the patch Properties:
- Parcel diameters obtained by distribution model
- Parcels injected randomly across the patch
SourceFiles SourceFiles
PatchInjection.C PatchInjection.C

View File

@ -25,11 +25,12 @@ Class
Foam::StandardWallInteraction Foam::StandardWallInteraction
Description Description
Wall interaction model. Three choices: Wall interaction model.
\li \c rebound - optionally specify elasticity and restitution coefficients Three choices:
\li \c stick - particles assigned zero velocity - rebound - optionally specify elasticity and restitution coefficients
\li \c escape - remove particle from the domain - stick - particles assigned zero velocity
- escape - remove particle from the domain
Example usage: Example usage:
\verbatim \verbatim

View File

@ -37,11 +37,10 @@ Description
\endverbatim \endverbatim
Types of coordinateRotation: Types of coordinateRotation:
-# axesRotation
\li 1. axesRotation -# STARCDRotation
\li 2. STARCDRotation -# cylindrical
\li 3. cylindrical -# EulerCoordinateRotation
\li 4. EulerCoordinateRotation
SourceFiles SourceFiles
coordinateRotation.C coordinateRotation.C

View File

@ -26,21 +26,21 @@ Class
Description Description
A local coordinate rotation. A local coordinate rotation.
The cell based rotational field can be created in two ways: 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
\li 1. Each rotational tensor is defined with two vectors (\c dir and \c e3) -# The rotational tensor field is provided at construction.
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.
SourceFiles SourceFiles
cylindrical.C cylindrical.C

View File

@ -43,15 +43,13 @@ Description
\endverbatim \endverbatim
Types of coordinateRotation: Types of coordinateRotation:
-# axesRotation
\li 1. axesRotation -# \link STARCDCoordinateRotation STARCDRotation \endlink
\li 2. STARCDRotation -# cylindricalCS cylindrical
\li 3. cylindrical -# EulerCoordinateRotation
\li 4. EulerCoordinateRotation
Type of co-ordinates: Type of co-ordinates:
-# \link cartesianCS cartesian \endlink
\li 1. cartesian
SourceFiles SourceFiles

View File

@ -25,20 +25,18 @@ Class
Foam::surfaceLocation Foam::surfaceLocation
Description Description
Contains information about location on a triSurface: Contains information about location on a triSurface
\li pointIndexHit: Access to data:
- pointIndexHit provides
- location - location
- bool: hit/miss - bool: hit/miss
- index (of triangle/point/edge) - index (of triangle/point/edge)
- elementType() provides
\li elementType():
- what index above relates to. In triangle::proxType - what index above relates to. In triangle::proxType
- triangle() provides
\li triangle():
- last known triangle - last known triangle
SourceFiles SourceFiles
surfaceLocation.C surfaceLocation.C

View File

@ -37,9 +37,8 @@ Description
\endverbatim \endverbatim
where: where:
- %r gets replaced by current processor rank
\li \c %r gets replaced by current processor rank - it will decompose into 2 domains
\li it will decompose into 2 domains
SeeAlso SeeAlso
Foam::scotchDecomp Foam::scotchDecomp

View File

@ -66,8 +66,8 @@ Description
Notes: Notes:
\li \c kappa and \c kappaName are inherited from temperatureCoupledBase. - kappa and \c kappaName are inherited from temperatureCoupledBase.
\li \c Qr is the radiative flux defined in the radiation model. - Qr is the radiative flux defined in the radiation model.
SeeAlso SeeAlso

View File

@ -30,8 +30,8 @@ Description
for patches on the primary region based on whether the patch is seen to for patches on the primary region based on whether the patch is seen to
be 'wet', retrieved from the film alpha field. be 'wet', retrieved from the film alpha field.
\li if the patch is wet, the temperature is set using the film temperature - if the patch is wet, the temperature is set using the film temperature
\li otherwise, it is set using pyrolysis temperature - otherwise, it is set using pyrolysis temperature
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim

View File

@ -26,12 +26,13 @@ Class
Description Description
This boundary condition is designed to be used in conjunction with surface This boundary condition is designed to be used in conjunction with surface
film and pyrolysis modelling. It provides a velocity boundary condition film and pyrolysis modelling.
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 velocity is set using the film velocity It provides a velocity boundary condition for patches on the primary region
\li otherwise, it is set using pyrolysis out-gassing velocity 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: Example of the boundary condition specification:
\verbatim \verbatim

View File

@ -29,16 +29,16 @@ Group
Description Description
This boundary condition provides a coupled temperature condition between 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, The regions are generally referred to as the:
\li and baffle region. - primary region,
- and baffle region.
The primary region creates the baffle region and evolves its energy The primary region creates the baffle region and evolves its energy
equation either: equation either:
- 1-D, normal to each patch face
- 1-D, normal to each patch face - 2-D, normal and tangential components
- 2-D, normal and tangential components
The thermodynamic properties of the baffle material are specified via The thermodynamic properties of the baffle material are specified via
dictionary entries on the master patch. dictionary entries on the master patch.
@ -118,7 +118,7 @@ Description
} }
\endverbatim \endverbatim
\li Slave patch on primary region Slave patch on primary region:
\verbatim \verbatim
myPatch_slave myPatch_slave
{ {
@ -129,7 +129,7 @@ Description
\endverbatim \endverbatim
\li Patches on baffle region Patches on baffle region:
\verbatim \verbatim
bottom bottom
{ {

View File

@ -34,12 +34,11 @@ Description
wall contact angle field. wall contact angle field.
The essential entry "limit" controls the gradient of alpha1 on the wall: The essential entry "limit" controls the gradient of alpha1 on the wall:
- none - Calculate the gradient from the contact-angle without limiter
\li \c none - Calculate the gradient from the contact-angle without limiter - gradient - Limit the wall-gradient such that alpha1 remains bounded
\li \c gradient - Limit the wall-gradient such that alpha1 remains bounded
on the wall on the wall
\li \c alpha - Bound the calculated alpha1 on the wall - alpha - Bound the calculated alpha1 on the wall
\li \c zeroGradient - Set the gradient of alpha1 to 0 on the wall, i.e. - zeroGradient - Set the gradient of alpha1 to 0 on the wall, i.e.
reproduce previous behaviour, the pressure BCs can be left as before. 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 Note that if any of the first three options are used the boundary condition