DOC: Fixed some doxygen complaints
This commit is contained in:
parent
af864cdcd1
commit
281f136f38
@ -754,7 +754,7 @@ WARN_FORMAT = "$file:$line: $text"
|
|||||||
# messages should be written. If left blank the output is written to standard
|
# messages should be written. If left blank the output is written to standard
|
||||||
# error (stderr).
|
# error (stderr).
|
||||||
|
|
||||||
WARN_LOGFILE =
|
WARN_LOGFILE = Doxygen.warnings
|
||||||
|
|
||||||
#---------------------------------------------------------------------------
|
#---------------------------------------------------------------------------
|
||||||
# Configuration options related to the input files
|
# Configuration options related to the input files
|
||||||
|
@ -54,13 +54,14 @@
|
|||||||
|
|
||||||
\newcommand{\Hodge} {\ensuremath{\operatorname{\stackrel{\displaystyle \ast}{}}}}
|
\newcommand{\Hodge} {\ensuremath{\operatorname{\stackrel{\displaystyle \ast}{}}}}
|
||||||
\newcommand{\hyd} {\ensuremath{\operatorname{hyd}}}
|
\newcommand{\hyd} {\ensuremath{\operatorname{hyd}}}
|
||||||
\renewcommand{\max} {\ensuremath{\operatorname{max}}}
|
%\renewcommand{\max} {\ensuremath{\operatorname{max}}}
|
||||||
\renewcommand{\min} {\ensuremath{\operatorname{min}}}
|
%\renewcommand{\min} {\ensuremath{\operatorname{min}}}
|
||||||
\newcommand{\inv} {\ensuremath{\operatorname{inv}}}
|
\newcommand{\inv} {\ensuremath{\operatorname{inv}}}
|
||||||
\newcommand{\sym} {\ensuremath{\operatorname{symm}}} % symm ?
|
\newcommand{\sym} {\ensuremath{\operatorname{symm}}} % symm ?
|
||||||
\newcommand{\skw} {\ensuremath{\operatorname{skew}}} % skew already defined
|
\newcommand{\skw} {\ensuremath{\operatorname{skew}}} % skew already defined
|
||||||
\newcommand{\tr} {\ensuremath{\operatorname{tr}}}
|
\newcommand{\tr} {\ensuremath{\operatorname{tr}}}
|
||||||
\newcommand{\trans}[1] {\ensuremath{#1^{\operatorname{T}}}}
|
\newcommand{\trans}[1] {\ensuremath{#1^{\operatorname{T}}}}
|
||||||
|
\newcommand{\symm}[1] {\ensuremath{frac{1}{2}\left(#1 + {#1}^T\right)}}
|
||||||
|
|
||||||
% alternative tensor operators for hypersonics etc.
|
% alternative tensor operators for hypersonics etc.
|
||||||
% ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
% ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
@ -38,13 +38,13 @@ Description
|
|||||||
The Nu number is calculated as:
|
The Nu number is calculated as:
|
||||||
|
|
||||||
\f[
|
\f[
|
||||||
Nu = a \, \text{Re}^b \, \text{Pr}^c
|
Nu = a \, \textrm{Re}^b \, \textrm{Pr}^c
|
||||||
\f]
|
\f]
|
||||||
|
|
||||||
and the heat transfer coefficient as:
|
and the heat transfer coefficient as:
|
||||||
|
|
||||||
\f[
|
\f[
|
||||||
htc = \frac{\text{Nu} \, K}{ds}
|
htc = \frac{\textrm{Nu} \, K}{ds}
|
||||||
\f]
|
\f]
|
||||||
|
|
||||||
where
|
where
|
||||||
|
@ -97,7 +97,7 @@ Usage
|
|||||||
min | Minimum point (single box) | vector | cond'l | -
|
min | Minimum point (single box) | vector | cond'l | -
|
||||||
max | Maximum point (single box) | vector | cond'l | -
|
max | Maximum point (single box) | vector | cond'l | -
|
||||||
span | Box width (single box) | vector | cond'l | -
|
span | Box width (single box) | vector | cond'l | -
|
||||||
\verbatim
|
\endverbatim
|
||||||
|
|
||||||
Note
|
Note
|
||||||
The order of precedence among the conditional mandatory entries from the
|
The order of precedence among the conditional mandatory entries from the
|
||||||
|
@ -86,7 +86,7 @@ Usage
|
|||||||
Entry | Description | Type | Req'd | Dflt
|
Entry | Description | Type | Req'd | Dflt
|
||||||
sets | Names of input cellSets | wordList | cond'l | -
|
sets | Names of input cellSets | wordList | cond'l | -
|
||||||
set | Name of input cellSet | word | cond'l | -
|
set | Name of input cellSet | word | cond'l | -
|
||||||
\verbatim
|
\endverbatim
|
||||||
|
|
||||||
Note
|
Note
|
||||||
The order of precedence among the conditional mandatory entries from the
|
The order of precedence among the conditional mandatory entries from the
|
||||||
|
@ -98,7 +98,7 @@ Usage
|
|||||||
Entry | Description | Type | Req'd | Dflt
|
Entry | Description | Type | Req'd | Dflt
|
||||||
sets | Names of input faceSets | wordList | cond'l | -
|
sets | Names of input faceSets | wordList | cond'l | -
|
||||||
set | Name of input faceSet | word | cond'l | -
|
set | Name of input faceSet | word | cond'l | -
|
||||||
\verbatim
|
\endverbatim
|
||||||
|
|
||||||
Note
|
Note
|
||||||
The order of precedence among the conditional mandatory entries from the
|
The order of precedence among the conditional mandatory entries from the
|
||||||
|
@ -95,7 +95,7 @@ Usage
|
|||||||
Entry | Description | Type | Req'd | Dflt
|
Entry | Description | Type | Req'd | Dflt
|
||||||
zones | Names of input faceZones | wordRes | cond'l | -
|
zones | Names of input faceZones | wordRes | cond'l | -
|
||||||
zone | Name of input faceZone | wordRe | cond'l | -
|
zone | Name of input faceZone | wordRe | cond'l | -
|
||||||
\verbatim
|
\endverbatim
|
||||||
|
|
||||||
Note
|
Note
|
||||||
The order of precedence among the conditional mandatory entries from the
|
The order of precedence among the conditional mandatory entries from the
|
||||||
|
@ -84,7 +84,7 @@ Usage
|
|||||||
Entry | Description | Type | Req'd | Dflt
|
Entry | Description | Type | Req'd | Dflt
|
||||||
patches | Names of patches or wildcards | wordList | cond'l | -
|
patches | Names of patches or wildcards | wordList | cond'l | -
|
||||||
patch | Name of patch or wildcard | word | cond'l | -
|
patch | Name of patch or wildcard | word | cond'l | -
|
||||||
\verbatim
|
\endverbatim
|
||||||
|
|
||||||
Note
|
Note
|
||||||
The order of precedence among the conditional mandatory entries from the
|
The order of precedence among the conditional mandatory entries from the
|
||||||
|
@ -95,7 +95,7 @@ Usage
|
|||||||
Entry | Description | Type | Req'd | Dflt
|
Entry | Description | Type | Req'd | Dflt
|
||||||
sets | Names of input pointSets | wordList | cond'l | -
|
sets | Names of input pointSets | wordList | cond'l | -
|
||||||
set | Name of input pointSet | word | cond'l | -
|
set | Name of input pointSet | word | cond'l | -
|
||||||
\verbatim
|
\endverbatim
|
||||||
|
|
||||||
Note
|
Note
|
||||||
The order of precedence among the conditional mandatory entries from the
|
The order of precedence among the conditional mandatory entries from the
|
||||||
|
@ -86,7 +86,7 @@ Usage
|
|||||||
Entry | Description | Type | Req'd | Dflt
|
Entry | Description | Type | Req'd | Dflt
|
||||||
zones | Names of input cellZones | wordRes | cond'l | -
|
zones | Names of input cellZones | wordRes | cond'l | -
|
||||||
zone | Name of input cellZone | wordRe | cond'l | -
|
zone | Name of input cellZone | wordRe | cond'l | -
|
||||||
\verbatim
|
\endverbatim
|
||||||
|
|
||||||
Note
|
Note
|
||||||
The order of precedence among the conditional mandatory entries from the
|
The order of precedence among the conditional mandatory entries from the
|
||||||
|
@ -97,7 +97,7 @@ Usage
|
|||||||
min | Minimum point (single box) | vector | cond'l | -
|
min | Minimum point (single box) | vector | cond'l | -
|
||||||
max | Maximum point (single box) | vector | cond'l | -
|
max | Maximum point (single box) | vector | cond'l | -
|
||||||
span | Box width (single box) | vector | cond'l | -
|
span | Box width (single box) | vector | cond'l | -
|
||||||
\verbatim
|
\endverbatim
|
||||||
|
|
||||||
Note
|
Note
|
||||||
The order of precedence among the conditional mandatory entries from the
|
The order of precedence among the conditional mandatory entries from the
|
||||||
|
@ -94,7 +94,7 @@ Usage
|
|||||||
Entry | Description | Type | Req'd | Dflt
|
Entry | Description | Type | Req'd | Dflt
|
||||||
sets | Names of input cellSets | wordList | cond'l | -
|
sets | Names of input cellSets | wordList | cond'l | -
|
||||||
set | Name of input cellSet | word | cond'l | -
|
set | Name of input cellSet | word | cond'l | -
|
||||||
\verbatim
|
\endverbatm
|
||||||
|
|
||||||
Note
|
Note
|
||||||
The order of precedence among the conditional mandatory entries from the
|
The order of precedence among the conditional mandatory entries from the
|
||||||
|
@ -86,7 +86,7 @@ Usage
|
|||||||
Entry | Description | Type | Req'd | Dflt
|
Entry | Description | Type | Req'd | Dflt
|
||||||
sets | Names of input faceSets | wordList | cond'l | -
|
sets | Names of input faceSets | wordList | cond'l | -
|
||||||
set | Name of input faceSet | word | cond'l | -
|
set | Name of input faceSet | word | cond'l | -
|
||||||
\verbatim
|
\endverbatim
|
||||||
|
|
||||||
Note
|
Note
|
||||||
The order of precedence among the conditional mandatory entries from the
|
The order of precedence among the conditional mandatory entries from the
|
||||||
|
@ -85,7 +85,7 @@ Usage
|
|||||||
Entry | Description | Type | Req'd | Dflt
|
Entry | Description | Type | Req'd | Dflt
|
||||||
patches | Names of patches | wordList | cond'l | -
|
patches | Names of patches | wordList | cond'l | -
|
||||||
patch | Name of patch | word | cond'l | -
|
patch | Name of patch | word | cond'l | -
|
||||||
\verbatim
|
\endverbatim
|
||||||
|
|
||||||
Note
|
Note
|
||||||
The order of precedence among the conditional mandatory entries from the
|
The order of precedence among the conditional mandatory entries from the
|
||||||
|
@ -96,7 +96,7 @@ Usage
|
|||||||
Entry | Description | Type | Req'd | Dflt
|
Entry | Description | Type | Req'd | Dflt
|
||||||
sets | Names of input pointSets | wordList | cond'l | -
|
sets | Names of input pointSets | wordList | cond'l | -
|
||||||
set | Name of input pointSet | word | cond'l | -
|
set | Name of input pointSet | word | cond'l | -
|
||||||
\verbatim
|
\endverbatim
|
||||||
|
|
||||||
Note
|
Note
|
||||||
The order of precedence among the conditional mandatory entries from the
|
The order of precedence among the conditional mandatory entries from the
|
||||||
|
@ -86,7 +86,7 @@ Usage
|
|||||||
Entry | Description | Type | Req'd | Dflt
|
Entry | Description | Type | Req'd | Dflt
|
||||||
zones | Names of input faceZones | wordRes | cond'l | -
|
zones | Names of input faceZones | wordRes | cond'l | -
|
||||||
zone | Name of input faceZone | wordRe | cond'l | -
|
zone | Name of input faceZone | wordRe | cond'l | -
|
||||||
\verbatim
|
\endverbatim
|
||||||
|
|
||||||
Note
|
Note
|
||||||
The order of precedence among the conditional mandatory entries from the
|
The order of precedence among the conditional mandatory entries from the
|
||||||
|
@ -97,7 +97,7 @@ Usage
|
|||||||
min | Minimum point (single box) | vector | cond'l | -
|
min | Minimum point (single box) | vector | cond'l | -
|
||||||
max | Maximum point (single box) | vector | cond'l | -
|
max | Maximum point (single box) | vector | cond'l | -
|
||||||
span | Box width (single box) | vector | cond'l | -
|
span | Box width (single box) | vector | cond'l | -
|
||||||
\verbatim
|
\endverbatim
|
||||||
|
|
||||||
Note
|
Note
|
||||||
The order of precedence among the conditional mandatory entries from the
|
The order of precedence among the conditional mandatory entries from the
|
||||||
|
@ -93,7 +93,7 @@ Usage
|
|||||||
Entry | Description | Type | Req'd | Dflt
|
Entry | Description | Type | Req'd | Dflt
|
||||||
sets | Names of input cellSets | wordList | cond'l | -
|
sets | Names of input cellSets | wordList | cond'l | -
|
||||||
set | Name of input cellSet | word | cond'l | -
|
set | Name of input cellSet | word | cond'l | -
|
||||||
\verbatim
|
\endverbatim
|
||||||
|
|
||||||
Note
|
Note
|
||||||
The order of precedence among the conditional mandatory entries from the
|
The order of precedence among the conditional mandatory entries from the
|
||||||
|
@ -94,7 +94,7 @@ Usage
|
|||||||
Entry | Description | Type | Req'd | Dflt
|
Entry | Description | Type | Req'd | Dflt
|
||||||
sets | Names of input faceSets | wordList | cond'l | -
|
sets | Names of input faceSets | wordList | cond'l | -
|
||||||
set | Name of input faceSet | word | cond'l | -
|
set | Name of input faceSet | word | cond'l | -
|
||||||
\verbatim
|
\endverbatim
|
||||||
|
|
||||||
Note
|
Note
|
||||||
The order of precedence among the conditional mandatory entries from the
|
The order of precedence among the conditional mandatory entries from the
|
||||||
|
@ -86,7 +86,7 @@ Usage
|
|||||||
Entry | Description | Type | Req'd | Dflt
|
Entry | Description | Type | Req'd | Dflt
|
||||||
sets | Names of input pointSets | wordList | cond'l | -
|
sets | Names of input pointSets | wordList | cond'l | -
|
||||||
set | Name of input pointSet | word | cond'l | -
|
set | Name of input pointSet | word | cond'l | -
|
||||||
\verbatim
|
\endverbatim
|
||||||
|
|
||||||
Note
|
Note
|
||||||
The order of precedence among the conditional mandatory entries from the
|
The order of precedence among the conditional mandatory entries from the
|
||||||
|
@ -86,7 +86,7 @@ Usage
|
|||||||
Entry | Description | Type | Req'd | Dflt
|
Entry | Description | Type | Req'd | Dflt
|
||||||
zones | Names of input pointZones | wordRes | cond'l | -
|
zones | Names of input pointZones | wordRes | cond'l | -
|
||||||
zone | Name of input pointZone | wordRe | cond'l | -
|
zone | Name of input pointZone | wordRe | cond'l | -
|
||||||
\verbatim
|
\endverbatim
|
||||||
|
|
||||||
Note
|
Note
|
||||||
The order of precedence among the conditional mandatory entries from the
|
The order of precedence among the conditional mandatory entries from the
|
||||||
|
@ -36,11 +36,11 @@ Description
|
|||||||
|
|
||||||
\f[
|
\f[
|
||||||
\frac{d c}{d t} =
|
\frac{d c}{d t} =
|
||||||
k_{abs} w (c_{int} - c_{p_{w}}) + k_{des} (c_{p_{w} - c_{int}})
|
k_{abs} w (c_{int} - c_{p_{w}}) + k_{des} (c_{p_{w}} - c_{int})
|
||||||
\f]
|
\f]
|
||||||
|
|
||||||
\f[
|
\f[
|
||||||
w = max(1 - c_{p_{w}/max, 0);
|
w = \max(1 - c_{p_{w}}/max, 0)
|
||||||
\f]
|
\f]
|
||||||
|
|
||||||
where
|
where
|
||||||
|
@ -33,7 +33,7 @@ Description
|
|||||||
\f[
|
\f[
|
||||||
C_1 (v_i^{2/3} + v_j^{2/3}) (v_i^{2/9} + v_j^{2/9})^{1/2}
|
C_1 (v_i^{2/3} + v_j^{2/3}) (v_i^{2/9} + v_j^{2/9})^{1/2}
|
||||||
\frac{\epsilon_c^{1/3}}{1 + \alpha_d}
|
\frac{\epsilon_c^{1/3}}{1 + \alpha_d}
|
||||||
\text{exp}
|
\textrm{exp}
|
||||||
\left[
|
\left[
|
||||||
- C_2 \frac{\mu_c \rho_c}{\sigma^2}
|
- C_2 \frac{\mu_c \rho_c}{\sigma^2}
|
||||||
\frac{\epsilon_c}{(1 + \alpha_d)^{3}}
|
\frac{\epsilon_c}{(1 + \alpha_d)^{3}}
|
||||||
|
@ -30,7 +30,7 @@ Description
|
|||||||
Model of Luo (1993). The coalescence rate is calculated by
|
Model of Luo (1993). The coalescence rate is calculated by
|
||||||
|
|
||||||
\f[
|
\f[
|
||||||
&\frac{\pi}{4} (d_i + d_j)^2 u_{ij}
|
\frac{\pi}{4} (d_i + d_j)^2 u_{ij}
|
||||||
\mathrm{exp}
|
\mathrm{exp}
|
||||||
\left[
|
\left[
|
||||||
- C_1
|
- C_1
|
||||||
|
@ -613,7 +613,7 @@ void Foam::radiation::viewFactor::calculate()
|
|||||||
if (pp.size() > 0)
|
if (pp.size() > 0)
|
||||||
{
|
{
|
||||||
scalarField& qrp = qrBf[patchID];
|
scalarField& qrp = qrBf[patchID];
|
||||||
const scalarField& sf = mesh_.magSf().boundaryField()[patchID];
|
//const scalarField& sf = mesh_.magSf().boundaryField()[patchID];
|
||||||
const labelList& agglom = finalAgglom_[patchID];
|
const labelList& agglom = finalAgglom_[patchID];
|
||||||
label nAgglom = max(agglom)+1;
|
label nAgglom = max(agglom)+1;
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user