Commit 87b30065 authored by Mark Olesen's avatar Mark Olesen
Browse files

STYLE: backslash doxygen commands, email address, typos in error messages

parent 8629755f
......@@ -31,7 +31,7 @@ Description
corresponding to PDR basic drag model (\link basic.H \endlink)
The default model coefficients correspond to the following:
@verbatim
\verbatim
PDRkEpsilonCoeffs
{
Cmu 0.09;
......@@ -43,7 +43,7 @@ Description
sigmaEps 1.3;
Prt 1.0; // only for compressible
}
@endverbatim
\endverbatim
The turbulence source term \f$ G_{R} \f$ appears in the
\f$ \kappa-\epsilon \f$ equation for the generation of turbulence due to
......
......@@ -29,7 +29,7 @@ Class
Description
Simple SCOPEBlendXiEq model for XiEq based on SCOPEXiEqs correlation
with a linear correction function to give a plausible profile for XiEq.
See @link SCOPELaminarFlameSpeed.H @endlink for details on the SCOPE
See \link SCOPELaminarFlameSpeed.H \endlink for details on the SCOPE
laminar flame speed model.
SourceFiles
......
......@@ -29,7 +29,7 @@ Class
Description
This is the equilibrium level of the flame wrinkling generated by
instability. It is a constant (default 2.5). It is used in
@link XiModel.H @endlink.
\link XiModel.H \endlink.
SourceFiles
instability.C
......
......@@ -41,8 +41,7 @@ Description
airframe noise, VKI LS 2013-03.
\endverbatim
Contact: info@cfd-berlin.com
Contact: info@upstream-cfd.com
\*---------------------------------------------------------------------------*/
......
......@@ -816,7 +816,7 @@ void correctCoupledBoundaryConditions(fvMesh& mesh)
else
{
FatalErrorInFunction
<< "Unsuported communications type "
<< "Unsupported communications type "
<< Pstream::commsTypeNames[Pstream::defaultCommsType]
<< exit(FatalError);
}
......
......@@ -46,8 +46,8 @@ Description
}
\endverbatim
The result program would receive \b -time, @b -latestTime, @b -constant
and \b -noZero options. The @b -constant option explicitly includes the
The result program would receive \b -time, \b -latestTime, \b -constant
and \b -noZero options. The \b -constant option explicitly includes the
\c constant/ directory in the time list and the \b -noZero option
explicitly excludes the \c 0/ directory from the time list.
......@@ -133,7 +133,7 @@ public:
// behaviour (and \b -latestTime behaviour) to exclude the \c 0/
// directory. The \c 0/ directory will only be included when
// \b -withZero is specified.
// The \b -noZero option has precedence over the @b -withZero option.
// The \b -noZero option has precedence over the \b -withZero option.
static void addOptions
(
const bool constant=true,
......
......@@ -432,7 +432,7 @@ evaluate()
else
{
FatalErrorInFunction
<< "Unsuported communications type "
<< "Unsupported communications type "
<< Pstream::commsTypeNames[Pstream::defaultCommsType]
<< exit(FatalError);
}
......
......@@ -91,7 +91,7 @@ void Foam::LduMatrix<Type, DType, LUType>::initMatrixInterfaces
else
{
FatalErrorInFunction
<< "Unsuported communications type "
<< "Unsupported communications type "
<< Pstream::commsTypeNames[Pstream::defaultCommsType]
<< exit(FatalError);
}
......@@ -200,7 +200,7 @@ void Foam::LduMatrix<Type, DType, LUType>::updateMatrixInterfaces
else
{
FatalErrorInFunction
<< "Unsuported communications type "
<< "Unsupported communications type "
<< Pstream::commsTypeNames[Pstream::defaultCommsType]
<< exit(FatalError);
}
......
......@@ -92,7 +92,7 @@ void Foam::lduMatrix::initMatrixInterfaces
else
{
FatalErrorInFunction
<< "Unsuported communications type "
<< "Unsupported communications type "
<< Pstream::commsTypeNames[Pstream::defaultCommsType]
<< exit(FatalError);
}
......@@ -272,7 +272,7 @@ void Foam::lduMatrix::updateMatrixInterfaces
else
{
FatalErrorInFunction
<< "Unsuported communications type "
<< "Unsupported communications type "
<< Pstream::commsTypeNames[Pstream::defaultCommsType]
<< exit(FatalError);
}
......
......@@ -33,17 +33,19 @@ Description
Primary Breakup Model for pressure swirl atomizers.
Accurate description in
@verbatim
\verbatim
Z. Han, S. Parrish, P.V. Farrell, R.D. Reitz
"Modeling Atomization Processes Of Pressure Swirl Hollow-Cone Fuel Sprays"
Atomization and Sprays, vol. 7, pp. 663-684, 1997
\endverbatim
and
\verbatim
L. Allocca, G. Bella, A. De Vita, L. Di Angelo
"Experimental Validation of a GDI Spray Model"
SAE Technical Paper Series, 2002-01-1137
@endverbatim
\endverbatim
\*---------------------------------------------------------------------------*/
......@@ -57,6 +59,7 @@ Description
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class BlobsSheetAtomization Declaration
\*---------------------------------------------------------------------------*/
......
......@@ -33,19 +33,19 @@ Description
Primary Breakup Model for pressure swirl atomizers.
Accurate description in
@verbatim
\verbatim
P.K. Senecal, D.P. Schmidt, I. Nouar, C.J. Rutland, R.D. Reitz, M. Corradini
"Modeling high-speed viscous liquid sheet atomization"
International Journal of Multiphase Flow 25 (1999) pags. 1073-1097
@endverbatim
\endverbatim
and
@verbatim
\verbatim
D.P. Schmidt, I. Nouar, P.K. Senecal, C.J. Rutland, J.K. Martin, R.D. Reitz
"Pressure-Swirl Atomization in the Near Field"
SAE Techical Paper Series 1999-01-0496
@endverbatim
\endverbatim
\*---------------------------------------------------------------------------*/
......@@ -58,6 +58,7 @@ Description
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class LISAAtomization Declaration
\*---------------------------------------------------------------------------*/
......
......@@ -33,7 +33,7 @@ Description
The Enhanced TAB model.
Described in the papers below.
@verbatim
\verbatim
F.X. Tanner
"Liquid Jet Atomization and Droplet Breakup Modeling of
Non-Evaporating Diesel Fuel Sprays"
......@@ -45,7 +45,7 @@ Description
Fuel Sprays by Means of Cascade Drop Breakup Model"
SAE 980808
SAE Technical Paper Series
@endverbatim
\endverbatim
See also
The TAB model
......@@ -61,6 +61,7 @@ See also
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class ETAB Declaration
\*---------------------------------------------------------------------------*/
......
......@@ -32,13 +32,13 @@ Group
Description
Particle secondary breakup model, based on the reference:
@verbatim
\verbatim
Pilch, M. and Erdman, C.A.
"Use of breakup time data and velocity history data
to predict the maximum size of stable fragments for acceleration
induced breakup of a liquid drop."
Int. J. Multiphase Flows 13 (1987), 741-757
@endverbatim
\endverbatim
The droplet fragment velocity is described by the equation:
......@@ -69,6 +69,7 @@ Description
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class PilchErdman Declaration
\*---------------------------------------------------------------------------*/
......
......@@ -32,23 +32,23 @@ Group
Description
secondary breakup model
@verbatim
\verbatim
Reitz, R.D.
"Modelling atomization processes in highpressure vaporizing sprays"
Atomization and Spray Technology 3 (1987), 309-337
@endverbatim
\endverbatim
@verbatim
\verbatim
Reitz, R.D. and Diwakar, R.
"Effect of drop breakup on fuel sprays"
SAE Tech. paper series, 860469 (1986)
@endverbatim
\endverbatim
@verbatim
\verbatim
Reitz, R.D. and Diwakar, R.
"Structure of high-pressure fuel sprays"
SAE Tech. paper series, 870598 (1987)
@endverbatim
\endverbatim
\*---------------------------------------------------------------------------*/
......@@ -61,6 +61,7 @@ Description
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class ReitzDiwakar Declaration
\*---------------------------------------------------------------------------*/
......
......@@ -34,12 +34,12 @@ Description
bag, molutimode, shear....
Accurate description in
@verbatim
\verbatim
R. Schmehl, G. Maier, S. Witting
"CFD Analysis of Fuel Atomization, Secondary Droplet Breakup and Spray
Dispersion in the Premix Duct of a LPP Combustor".
Eight International Conference on Liquid Atomization and Spray Systems, 2000
@endverbatim
\endverbatim
\*---------------------------------------------------------------------------*/
......@@ -52,6 +52,7 @@ Description
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class SHF Declaration
\*---------------------------------------------------------------------------*/
......
......@@ -32,14 +32,14 @@ Group
Description
The TAB Method for Numerical Calculation of Spray Droplet Breakup.
@verbatim
\verbatim
O'Rourke, P.J. and Amsden, A.A.,
"The TAB Method for Numerical Calculation of Spray Droplet Breakup,"
1987 SAE International Fuels and Lubricants Meeting and Exposition,
Toronto, Ontario, November 2-5, 1987,
Los Alamos National Laboratory document LA-UR-87-2105;
SAE Technical Paper Series, Paper 872089.
@endverbatim
\endverbatim
This implementation follows the kiva version.
......@@ -58,6 +58,7 @@ See also
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class TAB Declaration
\*---------------------------------------------------------------------------*/
......
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