mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
Documentation: converted javadoc @ to LaTeX style \ in Doxygen code docs
This commit is contained in:
Henry
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -30,7 +30,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;
|
||||
@ -41,7 +41,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
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -27,7 +27,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
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -27,7 +27,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
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -30,7 +30,7 @@ Description
|
||||
causing pressure loss as estimated using an adjoint formulation.
|
||||
|
||||
References:
|
||||
@verbatim
|
||||
\verbatim
|
||||
"Implementation of a continuous adjoint for topology optimization of
|
||||
ducted flows"
|
||||
C. Othmer,
|
||||
@ -38,7 +38,7 @@ Description
|
||||
H.G. Weller
|
||||
AIAA-2007-3947
|
||||
http://pdf.aiaa.org/preview/CDReadyMCFD07_1379/PV2007_3947.pdf
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
Note that this solver optimises for total pressure loss whereas the
|
||||
above paper describes the method for optimising power-loss.
|
||||
|
||||
@ -32,14 +32,14 @@ Description
|
||||
implicit term in the pressure equation.
|
||||
|
||||
Reference:
|
||||
@verbatim
|
||||
\verbatim
|
||||
Kunz, R.F., Boger, D.A., Stinebring, D.R., Chyczewski, Lindau. J.W.,
|
||||
Gibeling, H.J., Venkateswaran, S., Govindan, T.R.,
|
||||
“A Preconditioned Implicit Method for Two-Phase Flows with Application
|
||||
to Cavitation Prediction,”
|
||||
Computers and Fluids,
|
||||
29(8):849-875, 2000.
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
SourceFiles
|
||||
Kunz.C
|
||||
|
||||
@ -28,12 +28,12 @@ Description
|
||||
Merkle cavitation model.
|
||||
|
||||
Reference:
|
||||
@verbatim
|
||||
\verbatim
|
||||
C. L. Merkle, J. Feng, and P. E. O. Buelow,
|
||||
"Computational modeling of the dynamics of sheet cavitation",
|
||||
in Proceedings Third International Symposium on Cavitation
|
||||
Grenoble, France 1998.
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
SourceFiles
|
||||
Merkle.C
|
||||
|
||||
@ -28,12 +28,12 @@ Description
|
||||
SchnerrSauer cavitation model.
|
||||
|
||||
Reference:
|
||||
@verbatim
|
||||
\verbatim
|
||||
Schnerr, G. H., And Sauer, J.,
|
||||
"Physical and Numerical Modeling of Unsteady Cavitation Dynamics",
|
||||
Proc. 4th International Conference on Multiphase Flow,
|
||||
New Orleans, U.S.A., 2001.
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
SourceFiles
|
||||
SchnerrSauer.C
|
||||
|
||||
@ -29,12 +29,12 @@ Description
|
||||
|
||||
Plot normal distribution test in gnuplot using:
|
||||
|
||||
@verbatim
|
||||
\verbatim
|
||||
normalDistribution(mean, sigma, x) = \
|
||||
sqrt(1.0/(2.0*pi*sigma**2))*exp(-(x - mean)**2.0/(2.0*sigma**2))
|
||||
|
||||
plot normalDistribution(8.5, 2.5, x), "Distribution_scalar_test_x" w p
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -31,16 +31,16 @@ Usage
|
||||
- foamToStarMesh [OPTION] \n
|
||||
Reads an OpenFOAM mesh and writes a pro-STAR (v4) bnd/cel/vrt format.
|
||||
|
||||
@param -noBnd \n
|
||||
Suppress writing the @c .bnd file
|
||||
\param -noBnd \n
|
||||
Suppress writing the \c .bnd file
|
||||
|
||||
@param -scale \<factor\>\n
|
||||
\param -scale \<factor\>\n
|
||||
Specify an alternative geometry scaling factor.
|
||||
The default is @b 1000 (scale @em [m] to @em [mm]).
|
||||
The default is \b 1000 (scale \em [m] to \em [mm]).
|
||||
|
||||
Note
|
||||
The cellTable information available in the files
|
||||
@c constant/cellTable and @c constant/polyMesh/cellTableId
|
||||
\c constant/cellTable and @c constant/polyMesh/cellTableId
|
||||
will be used if available. Otherwise the cellZones are used when
|
||||
creating the cellTable information.
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2010-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2010-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -31,11 +31,11 @@ Usage
|
||||
- foamToSurface [OPTION] \n
|
||||
Reads an OpenFOAM mesh and writes the boundaries in a surface format.
|
||||
|
||||
@param -scale \<factor\>\n
|
||||
\param -scale \<factor\>\n
|
||||
Specify an alternative geometry scaling factor.
|
||||
Eg, use @b 1000 to scale @em [m] to @em [mm].
|
||||
Eg, use \b 1000 to scale \em [m] to \em [mm].
|
||||
|
||||
@param -tri \n
|
||||
\param -tri \n
|
||||
Triangulate surface.
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -27,7 +27,7 @@ Description
|
||||
Work in progress! Handles ascii multiblock (and optionally singleBlock)
|
||||
format.
|
||||
By default expects blanking. Use -noBlank if none.
|
||||
Use -2D @a thickness if 2D.
|
||||
Use -2D \a thickness if 2D.
|
||||
|
||||
Niklas Nordin has experienced a problem with lefthandedness of the blocks.
|
||||
The code should detect this automatically - see hexBlock::readPoints but
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -31,14 +31,14 @@ Usage
|
||||
- star4ToFoam [OPTION] ccmMesh\n
|
||||
convert pro-STAR mesh to OpenFOAM
|
||||
|
||||
@param -ascii \n
|
||||
\param -ascii \n
|
||||
Write in ASCII format instead of binary
|
||||
|
||||
@param -scale \<factor\>\n
|
||||
\param -scale \<factor\>\n
|
||||
Specify an alternative geometry scaling factor.
|
||||
The default is @b 0.001 (scale @em [mm] to @em [m]).
|
||||
The default is \b 0.001 (scale \em [mm] to \em [m]).
|
||||
|
||||
@param -solids \n
|
||||
\param -solids \n
|
||||
Treat any solid cells present just like fluid cells.
|
||||
The default is to discard them.
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -29,7 +29,7 @@ Description
|
||||
and run tetgen with -f option.
|
||||
|
||||
Sample smesh file:
|
||||
@verbatim
|
||||
\verbatim
|
||||
# cube.smesh -- A 10x10x10 cube
|
||||
8 3
|
||||
1 0 0 0
|
||||
@ -49,7 +49,7 @@ Description
|
||||
4 2 6 7 3 65
|
||||
0
|
||||
0
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
Note
|
||||
- for some reason boundary faces point inwards. I just reverse them
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -28,20 +28,20 @@ Description
|
||||
A multi-block mesh generator.
|
||||
|
||||
Uses the block mesh description found in
|
||||
@a constant/polyMesh/blockMeshDict
|
||||
(or @a constant/\<region\>/polyMesh/blockMeshDict).
|
||||
\a constant/polyMesh/blockMeshDict
|
||||
(or \a constant/\<region\>/polyMesh/blockMeshDict).
|
||||
|
||||
Usage
|
||||
|
||||
- blockMesh [OPTION]
|
||||
|
||||
@param -blockTopology \n
|
||||
\param -blockTopology \n
|
||||
Write the topology as a set of edges in OBJ format.
|
||||
|
||||
@param -region \<name\> \n
|
||||
\param -region \<name\> \n
|
||||
Specify an alternative mesh region.
|
||||
|
||||
@param -dict \<filename\> \n
|
||||
\param -dict \<filename\> \n
|
||||
Specify alternative dictionary for the block mesh description.
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
@ -108,13 +108,13 @@ Usage
|
||||
|
||||
- extrudeToRegionMesh \<regionName\> \<faceZones\> \<thickness\>
|
||||
|
||||
@param \<regionName\> \n
|
||||
\param \<regionName\> \n
|
||||
Name of mesh to create.
|
||||
|
||||
@param \<faceZones\> \n
|
||||
\param \<faceZones\> \n
|
||||
List of faceZones to extrude
|
||||
|
||||
@param \<thickness\> \n
|
||||
\param \<thickness\> \n
|
||||
Thickness of extruded mesh.
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2010-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2010-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -28,7 +28,7 @@ Description
|
||||
Walks from starting edge/face around point on patch.
|
||||
|
||||
-# Use in-place: \n
|
||||
@code
|
||||
\code
|
||||
patchPointEdgeCirculator circ(..);
|
||||
|
||||
// Walk
|
||||
@ -38,10 +38,10 @@ Description
|
||||
++circ;
|
||||
}
|
||||
while (circ != circ.end());
|
||||
@endcode
|
||||
\endcode
|
||||
|
||||
-# Use like STL iterator: \n
|
||||
@code
|
||||
\code
|
||||
patchPointEdgeCirculator circ(..);
|
||||
for
|
||||
(
|
||||
@ -52,7 +52,7 @@ Description
|
||||
{
|
||||
Info<< "edge:" << iter.edgeID() << endl;
|
||||
}
|
||||
@endcode
|
||||
\endcode
|
||||
|
||||
|
||||
SourceFiles
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -32,7 +32,7 @@ Usage
|
||||
|
||||
- extrude2DMesh thickness
|
||||
|
||||
@param thickness \n
|
||||
\param thickness \n
|
||||
Thickness (in metre) of slab.
|
||||
|
||||
Note
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -33,18 +33,18 @@ Usage
|
||||
for it. Normal behaviour is to have each point become a cell
|
||||
(1.5 behaviour)
|
||||
|
||||
@param -concaveMultiCells
|
||||
\param -concaveMultiCells
|
||||
Creates multiple cells for each point on a concave edge. Might limit
|
||||
the amount of distortion on some meshes.
|
||||
|
||||
@param -splitAllFaces
|
||||
\param -splitAllFaces
|
||||
Normally only constructs a single face between two cells. This single face
|
||||
might be too distorted. splitAllFaces will create a single face for every
|
||||
original cell the face passes through. The mesh will thus have
|
||||
multiple faces inbetween two cells! (so is not strictly upper-triangular
|
||||
anymore - checkMesh will complain)
|
||||
|
||||
@param -doNotPreserveFaceZones:
|
||||
\param -doNotPreserveFaceZones:
|
||||
By default all faceZones are preserved by marking all faces, edges and
|
||||
points on them as features. The -doNotPreserveFaceZones disables this
|
||||
behaviour.
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -40,7 +40,7 @@ Description
|
||||
Comparable to running a meshModifier of the form
|
||||
(if masterPatch is called "M" and slavePatch "S"):
|
||||
|
||||
@verbatim
|
||||
\verbatim
|
||||
couple
|
||||
{
|
||||
type slidingInterface;
|
||||
@ -52,7 +52,7 @@ Description
|
||||
slavePatchName S;
|
||||
typeOfMatch partial or integral
|
||||
}
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -32,30 +32,30 @@ Usage
|
||||
|
||||
- decomposePar [OPTION]
|
||||
|
||||
@param -cellDist \n
|
||||
\param -cellDist \n
|
||||
Write the cell distribution as a labelList, for use with 'manual'
|
||||
decomposition method or as a volScalarField for post-processing.
|
||||
|
||||
@param -region regionName \n
|
||||
\param -region regionName \n
|
||||
Decompose named region. Does not check for existence of processor*.
|
||||
|
||||
@param -copyUniform \n
|
||||
Copy any @a uniform directories too.
|
||||
\param -copyUniform \n
|
||||
Copy any \a uniform directories too.
|
||||
|
||||
@param -constant \n
|
||||
\param -constant \n
|
||||
Override controlDict settings and use constant directory.
|
||||
|
||||
@param -fields \n
|
||||
\param -fields \n
|
||||
Use existing geometry decomposition and convert fields only.
|
||||
|
||||
@param -force \n
|
||||
Remove any existing @a processor subdirectories before decomposing the
|
||||
\param -force \n
|
||||
Remove any existing \a processor subdirectories before decomposing the
|
||||
geometry.
|
||||
|
||||
@param -ifRequired \n
|
||||
\param -ifRequired \n
|
||||
Only decompose the geometry if the number of domains has changed from a
|
||||
previous decomposition. No @a processor subdirectories will be removed
|
||||
unless the @a -force option is also specified. This option can be used
|
||||
previous decomposition. No \a processor subdirectories will be removed
|
||||
unless the \a -force option is also specified. This option can be used
|
||||
to avoid redundant geometry decomposition (eg, in scripts), but should
|
||||
be used with caution when the underlying (serial) geometry or the
|
||||
decomposition method etc. have been changed between decompositions.
|
||||
|
||||
@ -32,7 +32,7 @@ Description
|
||||
Balances mesh and writes new mesh to new time directory.
|
||||
|
||||
Can also work like decomposePar:
|
||||
@verbatim
|
||||
\verbatim
|
||||
# Create empty processor directories (have to exist for argList)
|
||||
mkdir processor0
|
||||
..
|
||||
@ -43,7 +43,7 @@ Description
|
||||
|
||||
# Distribute
|
||||
mpirun -np ddd redistributeMeshPar -parallel
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
#include "fvMesh.H"
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -30,22 +30,22 @@ Usage
|
||||
- foamToEnsight [OPTION] \n
|
||||
Translates OpenFOAM data to Ensight format
|
||||
|
||||
@param -ascii \n
|
||||
\param -ascii \n
|
||||
Write Ensight data in ASCII format instead of "C Binary"
|
||||
|
||||
@param -patches patchList \n
|
||||
\param -patches patchList \n
|
||||
Specify particular patches to write.
|
||||
Specifying an empty list suppresses writing the internalMesh.
|
||||
|
||||
@param -noPatches \n
|
||||
\param -noPatches \n
|
||||
Suppress writing any patches.
|
||||
|
||||
@param -faceZones zoneList \n
|
||||
\param -faceZones zoneList \n
|
||||
Specify faceZones to write, with wildcards
|
||||
|
||||
Note
|
||||
Parallel support for cloud data is not supported
|
||||
- writes to @a EnSight directory to avoid collisions with foamToEnsightParts
|
||||
- writes to \a EnSight directory to avoid collisions with foamToEnsightParts
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -32,23 +32,23 @@ Usage
|
||||
- foamToEnsightParts [OPTION] \n
|
||||
Translates OpenFOAM data to Ensight format
|
||||
|
||||
@param -ascii \n
|
||||
\param -ascii \n
|
||||
Write Ensight data in ASCII format instead of "C Binary"
|
||||
|
||||
@param -noZero \n
|
||||
\param -noZero \n
|
||||
Exclude the often incomplete initial conditions.
|
||||
|
||||
@param -index \<start\>\n
|
||||
\param -index \<start\>\n
|
||||
Ignore the time index contained in the time file and use a
|
||||
simple indexing when creating the @c Ensight/data/######## files.
|
||||
simple indexing when creating the \c Ensight/data/######## files.
|
||||
|
||||
@param -noMesh \n
|
||||
\param -noMesh \n
|
||||
Suppress writing the geometry. Can be useful for converting partial
|
||||
results for a static geometry.
|
||||
|
||||
Note
|
||||
- no parallel data.
|
||||
- writes to @a Ensight directory to avoid collisions with foamToEnsight.
|
||||
- writes to \a Ensight directory to avoid collisions with foamToEnsight.
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -31,40 +31,40 @@ Usage
|
||||
|
||||
- foamToTecplot360 [OPTION]
|
||||
|
||||
@param -fields \<names\>\n
|
||||
\param -fields \<names\>\n
|
||||
Convert selected fields only. For example,
|
||||
@verbatim
|
||||
\verbatim
|
||||
-fields '( p T U )'
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
The quoting is required to avoid shell expansions and to pass the
|
||||
information as a single argument.
|
||||
|
||||
@param -cellSet \<name\>\n
|
||||
@param -faceSet \<name\>\n
|
||||
\param -cellSet \<name\>\n
|
||||
\param -faceSet \<name\>\n
|
||||
Restrict conversion to the cellSet, faceSet.
|
||||
|
||||
@param -nearCellValue \n
|
||||
\param -nearCellValue \n
|
||||
Output cell value on patches instead of patch value itself
|
||||
|
||||
@param -noInternal \n
|
||||
\param -noInternal \n
|
||||
Do not generate file for mesh, only for patches
|
||||
|
||||
@param -noPointValues \n
|
||||
\param -noPointValues \n
|
||||
No pointFields
|
||||
|
||||
@param -noFaceZones \n
|
||||
\param -noFaceZones \n
|
||||
No faceZones
|
||||
|
||||
@param -excludePatches \<patchNames\>\n
|
||||
\param -excludePatches \<patchNames\>\n
|
||||
Specify patches (wildcards) to exclude. For example,
|
||||
@verbatim
|
||||
\verbatim
|
||||
-excludePatches '( inlet_1 inlet_2 "proc.*")'
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
The quoting is required to avoid shell expansions and to pass the
|
||||
information as a single argument. The double quotes denote a regular
|
||||
expression.
|
||||
|
||||
@param -useTimeName \n
|
||||
\param -useTimeName \n
|
||||
use the time index in the VTK file name instead of the time index
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -40,59 +40,59 @@ Usage
|
||||
|
||||
- foamToVTK [OPTION]
|
||||
|
||||
@param -ascii \n
|
||||
\param -ascii \n
|
||||
Write VTK data in ASCII format instead of binary.
|
||||
|
||||
@param -mesh \<name\>\n
|
||||
\param -mesh \<name\>\n
|
||||
Use a different mesh name (instead of -region)
|
||||
|
||||
@param -fields \<fields\>\n
|
||||
\param -fields \<fields\>\n
|
||||
Convert selected fields only. For example,
|
||||
@verbatim
|
||||
\verbatim
|
||||
-fields "( p T U )"
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
The quoting is required to avoid shell expansions and to pass the
|
||||
information as a single argument.
|
||||
|
||||
@param -surfaceFields \n
|
||||
\param -surfaceFields \n
|
||||
Write surfaceScalarFields (e.g., phi)
|
||||
|
||||
@param -cellSet \<name\>\n
|
||||
@param -faceSet \<name\>\n
|
||||
@param -pointSet \<name\>\n
|
||||
\param -cellSet \<name\>\n
|
||||
\param -faceSet \<name\>\n
|
||||
\param -pointSet \<name\>\n
|
||||
Restrict conversion to the cellSet, faceSet or pointSet.
|
||||
|
||||
@param -nearCellValue \n
|
||||
\param -nearCellValue \n
|
||||
Output cell value on patches instead of patch value itself
|
||||
|
||||
@param -noInternal \n
|
||||
\param -noInternal \n
|
||||
Do not generate file for mesh, only for patches
|
||||
|
||||
@param -noPointValues \n
|
||||
\param -noPointValues \n
|
||||
No pointFields
|
||||
|
||||
@param -noFaceZones \n
|
||||
\param -noFaceZones \n
|
||||
No faceZones
|
||||
|
||||
@param -noLinks \n
|
||||
\param -noLinks \n
|
||||
(in parallel) do not link processor files to master
|
||||
|
||||
@param poly \n
|
||||
\param poly \n
|
||||
write polyhedral cells without tet/pyramid decomposition
|
||||
|
||||
@param -allPatches \n
|
||||
\param -allPatches \n
|
||||
Combine all patches into a single file
|
||||
|
||||
@param -excludePatches \<patchNames\>\n
|
||||
\param -excludePatches \<patchNames\>\n
|
||||
Specify patches (wildcards) to exclude. For example,
|
||||
@verbatim
|
||||
\verbatim
|
||||
-excludePatches '( inlet_1 inlet_2 "proc.*")'
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
The quoting is required to avoid shell expansions and to pass the
|
||||
information as a single argument. The double quotes denote a regular
|
||||
expression.
|
||||
|
||||
@param -useTimeName \n
|
||||
\param -useTimeName \n
|
||||
use the time index in the VTK file name instead of the time index
|
||||
|
||||
Note
|
||||
@ -110,7 +110,7 @@ Note
|
||||
However can have .pvd file format which refers to time simulation
|
||||
if XML *.vtu files are available:
|
||||
|
||||
@verbatim
|
||||
\verbatim
|
||||
<?xml version="1.0"?>
|
||||
<VTKFile type="Collection"
|
||||
version="0.1"
|
||||
@ -129,7 +129,7 @@ Note
|
||||
<DataSet timestep="500" file="pitzDaily_11.vtu"/>
|
||||
</Collection>
|
||||
</VTKFile>
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -45,7 +45,7 @@ Description
|
||||
|
||||
namespace Foam
|
||||
{
|
||||
//! @cond fileScope
|
||||
//! \cond fileScope
|
||||
// Extract up to the first non-word characters
|
||||
inline word getFirstWord(const char* str)
|
||||
{
|
||||
@ -64,7 +64,7 @@ namespace Foam
|
||||
}
|
||||
|
||||
}
|
||||
//! @endcond
|
||||
//! \endcond
|
||||
|
||||
} // End namespace Foam
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2009-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2009-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -39,7 +39,7 @@ Description
|
||||
|
||||
namespace Foam
|
||||
{
|
||||
//! @cond fileScope
|
||||
//! \cond fileScope
|
||||
// Extract up to the first non-word characters
|
||||
inline word getFirstWord(const char* str)
|
||||
{
|
||||
@ -58,7 +58,7 @@ namespace Foam
|
||||
}
|
||||
|
||||
}
|
||||
//! @endcond
|
||||
//! \endcond
|
||||
|
||||
} // End namespace Foam
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -45,7 +45,7 @@ defineTypeNameAndDebug(Foam::vtkPV3Readers, 0);
|
||||
|
||||
namespace Foam
|
||||
{
|
||||
//! @cond fileScope
|
||||
//! \cond fileScope
|
||||
// Extract up to the first non-word characters
|
||||
inline word getFirstWord(const char* str)
|
||||
{
|
||||
@ -64,7 +64,7 @@ namespace Foam
|
||||
}
|
||||
|
||||
}
|
||||
//! @endcond
|
||||
//! \endcond
|
||||
|
||||
} // End namespace Foam
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -31,7 +31,7 @@ Usage
|
||||
|
||||
- foamListTimes [OPTION]
|
||||
|
||||
@param -processor \n
|
||||
\param -processor \n
|
||||
List times from processor0/ directory
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -27,13 +27,13 @@ Description
|
||||
|
||||
Keywords:
|
||||
|
||||
@param setFormat : set output format, choice of \n
|
||||
\param setFormat : set output format, choice of \n
|
||||
- xmgr
|
||||
- jplot
|
||||
- gnuplot
|
||||
- raw
|
||||
|
||||
@param surfaceFormat : surface output format, choice of \n
|
||||
\param surfaceFormat : surface output format, choice of \n
|
||||
- null : suppress output
|
||||
- foamFile : separate points, faces and values file
|
||||
- dx : DX scalar or vector format
|
||||
@ -42,7 +42,7 @@ Description
|
||||
- obj : Wavefron stl. Does not contain values!
|
||||
- stl : ascii stl. Does not contain values!
|
||||
|
||||
@param interpolationScheme : interpolation scheme, choice of \n
|
||||
\param interpolationScheme : interpolation scheme, choice of \n
|
||||
- cell : use cell-centre value; constant over cells (default)
|
||||
- cellPoint : use cell-centre and vertex values
|
||||
- cellPointFace : use cell-centre, vertex and face values. \n
|
||||
@ -50,9 +50,9 @@ Description
|
||||
-# face values determined using the current face interpolation scheme
|
||||
for the field (linear, limitedLinear, etc.)
|
||||
|
||||
@param fields : list of fields to sample
|
||||
\param fields : list of fields to sample
|
||||
|
||||
@param sets : list of sets to sample, choice of \n
|
||||
\param sets : list of sets to sample, choice of \n
|
||||
- uniform evenly distributed points on line
|
||||
- face one point per face intersection
|
||||
- midPoint one point per cell, inbetween two face intersections
|
||||
@ -74,7 +74,7 @@ Description
|
||||
uniform: extra number of sampling points
|
||||
curve, cloud: list of coordinates
|
||||
|
||||
@param surfaces : list of surfaces to sample, choice of \n
|
||||
\param surfaces : list of surfaces to sample, choice of \n
|
||||
- plane : values on plane defined by point, normal.
|
||||
- patch : values on patch.
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -30,7 +30,7 @@ Description
|
||||
The -noWrite option has no meaning.
|
||||
|
||||
The flow type parameter is obtained according to the following equation:
|
||||
@verbatim
|
||||
\verbatim
|
||||
|D| - |Omega|
|
||||
lambda = -------------
|
||||
|D| + |Omega|
|
||||
@ -38,7 +38,7 @@ Description
|
||||
-1 = rotational flow
|
||||
0 = simple shear flow
|
||||
1 = planar extensional flow
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -29,10 +29,10 @@ Description
|
||||
type in the field and polyMesh/boundary files.
|
||||
|
||||
Reads dictionaries (fields) and entries to change from a dictionary.
|
||||
E.g. to make the @em movingWall a @em fixedValue for @em p but all other
|
||||
@em Walls a zeroGradient boundary condition, the
|
||||
@c system/changeDictionaryDict would contain the following:
|
||||
@verbatim
|
||||
E.g. to make the \em movingWall a \em fixedValue for @em p but all other
|
||||
\em Walls a zeroGradient boundary condition, the
|
||||
\c system/changeDictionaryDict would contain the following:
|
||||
\verbatim
|
||||
dictionaryReplacement
|
||||
{
|
||||
p // field to change
|
||||
@ -51,13 +51,13 @@ Description
|
||||
}
|
||||
}
|
||||
}
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
Usage
|
||||
|
||||
- changeDictionary [OPTION]
|
||||
|
||||
@param -literalRE \n
|
||||
\param -literalRE \n
|
||||
Do not interpret regular expressions; treat them as any other keyword.
|
||||
|
||||
|
||||
|
||||
@ -31,7 +31,7 @@ Usage
|
||||
|
||||
- foamUpgradeCyclics [OPTION]
|
||||
|
||||
@param -test \n
|
||||
\param -test \n
|
||||
Suppress writing the updated files with split cyclics
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
@ -195,7 +195,7 @@ void rewriteBoundary
|
||||
dictionary::null,
|
||||
patchDict
|
||||
)
|
||||
);
|
||||
);
|
||||
oldToNew[addedPatchI] = newPatchI++;
|
||||
dictionary& nbrPatchDict = patches[addedPatchI].dict();
|
||||
nbrPatchDict.set("neighbourPatch", thisName);
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -31,7 +31,7 @@ Usage
|
||||
|
||||
- foamUpgradeFvSolution [OPTION]
|
||||
|
||||
@param -test \n
|
||||
\param -test \n
|
||||
Suppress writing the updated fvSolution file
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -30,13 +30,13 @@ Description
|
||||
Usage
|
||||
- surfaceConvert inputFile outputFile [OPTION]
|
||||
|
||||
@param -clean \n
|
||||
\param -clean \n
|
||||
Perform some surface checking/cleanup on the input surface
|
||||
|
||||
@param -scale \<scale\> \n
|
||||
\param -scale \<scale\> \n
|
||||
Specify a scaling factor for writing the files
|
||||
|
||||
@param -group \n
|
||||
\param -group \n
|
||||
Orders faces by region
|
||||
|
||||
Note
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2009-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2009-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -31,25 +31,25 @@ Description
|
||||
Usage
|
||||
- surfaceMeshConvert inputFile outputFile [OPTION]
|
||||
|
||||
@param -clean \n
|
||||
\param -clean \n
|
||||
Perform some surface checking/cleanup on the input surface.
|
||||
|
||||
@param -scaleIn \<scale\> \n
|
||||
\param -scaleIn \<scale\> \n
|
||||
Specify a scaling factor when reading files.
|
||||
|
||||
@param -scaleOut \<scale\> \n
|
||||
\param -scaleOut \<scale\> \n
|
||||
Specify a scaling factor when writing files.
|
||||
|
||||
@param -dict \<dictionary\> \n
|
||||
\param -dict \<dictionary\> \n
|
||||
Specify an alternative dictionary for constant/coordinateSystems.
|
||||
|
||||
@param -from \<coordinateSystem\> \n
|
||||
\param -from \<coordinateSystem\> \n
|
||||
Specify a coordinate System when reading files.
|
||||
|
||||
@param -to \<coordinateSystem\> \n
|
||||
\param -to \<coordinateSystem\> \n
|
||||
Specify a coordinate System when writing files.
|
||||
|
||||
@param -tri \n
|
||||
\param -tri \n
|
||||
Triangulate surface.
|
||||
|
||||
Note
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -31,19 +31,19 @@ Description
|
||||
Usage
|
||||
- surfaceMeshConvertTesting inputFile outputFile [OPTION]
|
||||
|
||||
@param -clean \n
|
||||
\param -clean \n
|
||||
Perform some surface checking/cleanup on the input surface
|
||||
|
||||
@param -orient \n
|
||||
\param -orient \n
|
||||
Check face orientation on the input surface
|
||||
|
||||
@param -scale \<scale\> \n
|
||||
\param -scale \<scale\> \n
|
||||
Specify a scaling factor for writing the files
|
||||
|
||||
@param -triSurface \n
|
||||
\param -triSurface \n
|
||||
Use triSurface library for input/output
|
||||
|
||||
@param -keyed \n
|
||||
\param -keyed \n
|
||||
Use keyedSurface for input/output
|
||||
|
||||
Note
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -32,25 +32,25 @@ Description
|
||||
Usage
|
||||
- surfaceMeshExport outputFile [OPTION]
|
||||
|
||||
@param -clean \n
|
||||
\param -clean \n
|
||||
Perform some surface checking/cleanup on the input surface.
|
||||
|
||||
@param -name \<name\> \n
|
||||
\param -name \<name\> \n
|
||||
Specify an alternative surface name when writing.
|
||||
|
||||
@param -scaleIn \<scale\> \n
|
||||
\param -scaleIn \<scale\> \n
|
||||
Specify a scaling factor when reading files.
|
||||
|
||||
@param -scaleOut \<scale\> \n
|
||||
\param -scaleOut \<scale\> \n
|
||||
Specify a scaling factor when writing files.
|
||||
|
||||
@param -dict \<dictionary\> \n
|
||||
\param -dict \<dictionary\> \n
|
||||
Specify an alternative dictionary for constant/coordinateSystems.
|
||||
|
||||
@param -from \<coordinateSystem\> \n
|
||||
\param -from \<coordinateSystem\> \n
|
||||
Specify a coordinate system when reading files.
|
||||
|
||||
@param -to \<coordinateSystem\> \n
|
||||
\param -to \<coordinateSystem\> \n
|
||||
Specify a coordinate system when writing files.
|
||||
|
||||
Note
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -32,25 +32,25 @@ Description
|
||||
Usage
|
||||
- surfaceMeshImport inputFile [OPTION]
|
||||
|
||||
@param -clean \n
|
||||
\param -clean \n
|
||||
Perform some surface checking/cleanup on the input surface.
|
||||
|
||||
@param -name \<name\> \n
|
||||
\param -name \<name\> \n
|
||||
Specify an alternative surface name when writing.
|
||||
|
||||
@param -scaleIn \<scale\> \n
|
||||
\param -scaleIn \<scale\> \n
|
||||
Specify a scaling factor when reading files.
|
||||
|
||||
@param -scaleOut \<scale\> \n
|
||||
\param -scaleOut \<scale\> \n
|
||||
Specify a scaling factor when writing files.
|
||||
|
||||
@param -dict \<dictionary\> \n
|
||||
\param -dict \<dictionary\> \n
|
||||
Specify an alternative dictionary for constant/coordinateSystems.
|
||||
|
||||
@param -from \<coordinateSystem\> \n
|
||||
\param -from \<coordinateSystem\> \n
|
||||
Specify a coordinate system when reading files.
|
||||
|
||||
@param -to \<coordinateSystem\> \n
|
||||
\param -to \<coordinateSystem\> \n
|
||||
Specify a coordinate system when writing files.
|
||||
|
||||
Note
|
||||
|
||||
@ -1,13 +1,14 @@
|
||||
# -*- mode: org; -*-
|
||||
#
|
||||
#+TITLE: OpenFOAM C++ style guide
|
||||
#+AUTHOR: OpenCFD Ltd.
|
||||
#+DATE: June 2010
|
||||
#+AUTHOR: 2011 OpenCFD Ltd.
|
||||
#+DATE: Feb 2011
|
||||
#+LINK: http://www.opencfd.co.uk
|
||||
#+OPTIONS: author:nil ^:{}
|
||||
#+STARTUP: hidestars
|
||||
#+STARTUP: odd
|
||||
|
||||
* OpenFOAM C++ style guide
|
||||
|
||||
*** General
|
||||
+ 80 character lines max
|
||||
+ The normal indentation is 4 spaces per logical level.
|
||||
@ -23,31 +24,24 @@
|
||||
+ stream output
|
||||
+ =<<= is always four characters after the start of the stream,
|
||||
so that the =<<= symbols align, i.e.
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
Info<< ...
|
||||
os << ...
|
||||
#+END_EXAMPLE
|
||||
|
||||
so
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
WarningIn("className::functionName()")
|
||||
#+BEGIN_EXAMPLE
|
||||
Info<< ...
|
||||
os << ...
|
||||
#+END_EXAMPLE
|
||||
so
|
||||
#+BEGIN_EXAMPLE
|
||||
WarningIn("className::functionName()")
|
||||
<< "Warning message"
|
||||
#+END_EXAMPLE
|
||||
NOT
|
||||
#+BEGIN_EXAMPLE
|
||||
WarningIn("className::functionName()")
|
||||
<< "Warning message"
|
||||
#+END_EXAMPLE
|
||||
|
||||
NOT
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
WarningIn("className::functionName()")
|
||||
<< "Warning message"
|
||||
#+END_EXAMPLE
|
||||
|
||||
#+END_EXAMPLE
|
||||
|
||||
+ no unnecessary class section headers, i.e. remove
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
|
||||
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
|
||||
|
||||
// Check
|
||||
|
||||
@ -55,117 +49,99 @@
|
||||
|
||||
// Write
|
||||
#+END_EXAMPLE
|
||||
|
||||
|
||||
if they contain nothing, even if planned for 'future use'
|
||||
|
||||
+ class titles are centred
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
/*---------------------------------------------------------------------------*\
|
||||
Class exampleClass Declaration
|
||||
\*---------------------------------------------------------------------------*/
|
||||
/*---------------------------------------------------------------------------*\
|
||||
Class exampleClass Declaration
|
||||
\*---------------------------------------------------------------------------*/
|
||||
#+END_EXAMPLE
|
||||
|
||||
NOT
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
/*---------------------------------------------------------------------------*\
|
||||
/*---------------------------------------------------------------------------*\
|
||||
Class exampleClass Declaration
|
||||
\*---------------------------------------------------------------------------*/
|
||||
\*---------------------------------------------------------------------------*/
|
||||
#+END_EXAMPLE
|
||||
|
||||
*** The /.H/ Files
|
||||
+ header file spacing
|
||||
+ Leave two empty lines between sections
|
||||
(as per functions in the /.C/ file etc)
|
||||
|
||||
+ use =//- Comment= comments in header file
|
||||
+ add descriptions to class data and functions
|
||||
+ destructor
|
||||
+ If adding a comment to the destructor -
|
||||
use =//-= and code as a normal function:
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
//- Destructor
|
||||
~className();
|
||||
#+END_EXAMPLE
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
//- Destructor
|
||||
~className();
|
||||
#+END_EXAMPLE
|
||||
+ inline functions
|
||||
+ Use inline functions where appropriate in a separate /classNameI.H/ file.
|
||||
Avoid cluttering the header file with function bodies.
|
||||
+ Use inline functions where appropriate in a separate /classNameI.H/
|
||||
file. Avoid cluttering the header file with function bodies.
|
||||
|
||||
*** The /.C/ Files
|
||||
+ Do not open/close namespaces in a /.C/ file
|
||||
+ Fully scope the function name, i.e.
|
||||
#+BEGIN_EXAMPLE
|
||||
Foam::returnType Foam::className::functionName()
|
||||
#+END_EXAMPLE
|
||||
NOT
|
||||
#+BEGIN_EXAMPLE
|
||||
namespace Foam
|
||||
{
|
||||
...
|
||||
returnType className::functionName()
|
||||
...
|
||||
}
|
||||
#+END_EXAMPLE
|
||||
EXCEPTION
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
Foam::returnType Foam::className::functionName()
|
||||
#+END_EXAMPLE
|
||||
|
||||
NOT
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
namespace Foam
|
||||
{
|
||||
...
|
||||
returnType className::functionName()
|
||||
...
|
||||
}
|
||||
#+END_EXAMPLE
|
||||
|
||||
EXCEPTION
|
||||
|
||||
When there are multiple levels of namespace, they may be used in the /.C/
|
||||
file, i.e.
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
namespace Foam
|
||||
{
|
||||
namespace compressible
|
||||
{
|
||||
namespace RASModels
|
||||
{
|
||||
...
|
||||
} // End namespace RASModels
|
||||
} // End namespace compressible
|
||||
} // End namespace Foam
|
||||
#+END_EXAMPLE
|
||||
When there are multiple levels of namespace, they may be used in the
|
||||
/.C/ file, i.e.
|
||||
#+BEGIN_EXAMPLE
|
||||
namespace Foam
|
||||
{
|
||||
namespace compressible
|
||||
{
|
||||
namespace RASModels
|
||||
{
|
||||
...
|
||||
} // End namespace RASModels
|
||||
} // End namespace compressible
|
||||
} // End namespace Foam
|
||||
#+END_EXAMPLE
|
||||
|
||||
+ Use two empty lines between functions
|
||||
|
||||
*** Coding Practice
|
||||
+ passing data as arguments or return values.
|
||||
+ Pass bool, label and scalar as copy, anything larger by reference.
|
||||
|
||||
+ const
|
||||
+ Use everywhere it is applicable.
|
||||
|
||||
+ variable initialisation using
|
||||
#+BEGIN_EXAMPLE
|
||||
const className& variableName = otherClass.data();
|
||||
#+END_EXAMPLE
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
const className& variableName = otherClass.data();
|
||||
#+END_EXAMPLE
|
||||
NOT
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
const className& variableName(otherClass.data());
|
||||
#+END_EXAMPLE
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
const className& variableName(otherClass.data());
|
||||
#+END_EXAMPLE
|
||||
+ virtual functions
|
||||
+ If a class is virtual, make all derived classes virtual.
|
||||
|
||||
*** Conditional Statements
|
||||
#+BEGIN_EXAMPLE
|
||||
#+BEGIN_EXAMPLE
|
||||
if (condition)
|
||||
{
|
||||
code;
|
||||
}
|
||||
#+END_EXAMPLE
|
||||
|
||||
#+END_EXAMPLE
|
||||
OR
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
#+BEGIN_EXAMPLE
|
||||
if
|
||||
(
|
||||
long condition
|
||||
@ -173,29 +149,24 @@
|
||||
{
|
||||
code;
|
||||
}
|
||||
#+END_EXAMPLE
|
||||
|
||||
#+END_EXAMPLE
|
||||
NOT (no space between =if= and =(= used)
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
#+BEGIN_EXAMPLE
|
||||
if(condition)
|
||||
{
|
||||
code;
|
||||
}
|
||||
#+END_EXAMPLE
|
||||
#+END_EXAMPLE
|
||||
|
||||
*** =for= and =while= Loops
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
#+BEGIN_EXAMPLE
|
||||
for (i = 0; i < maxI; i++)
|
||||
{
|
||||
code;
|
||||
}
|
||||
#+END_EXAMPLE
|
||||
|
||||
#+END_EXAMPLE
|
||||
OR
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
#+BEGIN_EXAMPLE
|
||||
for
|
||||
(
|
||||
i = 0;
|
||||
@ -205,33 +176,26 @@
|
||||
{
|
||||
code;
|
||||
}
|
||||
#+END_EXAMPLE
|
||||
|
||||
#+END_EXAMPLE
|
||||
NOT this (no space between =for= and =(= used)
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
#+BEGIN_EXAMPLE
|
||||
for(i = 0; i < maxI; i++)
|
||||
{
|
||||
code;
|
||||
}
|
||||
#+END_EXAMPLE
|
||||
|
||||
#+END_EXAMPLE
|
||||
Note that when indexing through iterators, it is often slightly more
|
||||
efficient to use the pre-increment form. Eg, =++iter= instead of =iter++=
|
||||
|
||||
*** =forAll=, =forAllIter=, =forAllConstIter=, etc. loops
|
||||
like =for= loops, but
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
#+BEGIN_EXAMPLE
|
||||
forAll(
|
||||
#+END_EXAMPLE
|
||||
|
||||
#+END_EXAMPLE
|
||||
NOT
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
#+BEGIN_EXAMPLE
|
||||
forAll (
|
||||
#+END_EXAMPLE
|
||||
|
||||
#+END_EXAMPLE
|
||||
Using the =forAllIter= and =forAllConstIter= macros is generally
|
||||
advantageous - less typing, easier to find later. However, since
|
||||
they are macros, they will fail if the iterated object contains
|
||||
@ -239,150 +203,120 @@
|
||||
|
||||
The following will FAIL!:
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
#+BEGIN_EXAMPLE
|
||||
forAllIter(HashTable<labelPair, edge, Hash<edge> >, foo, iter)
|
||||
#+END_EXAMPLE
|
||||
|
||||
#+END_EXAMPLE
|
||||
These convenience macros are also generally avoided in other
|
||||
container classes and OpenFOAM primitive classes.
|
||||
|
||||
*** Splitting Over Multiple Lines
|
||||
***** Splitting return type and function name
|
||||
+ split initially after the function return type and left align
|
||||
+ do not put =const= onto its own line - use a split to keep it with
|
||||
the function name and arguments.
|
||||
#+BEGIN_EXAMPLE
|
||||
const Foam::longReturnTypeName&
|
||||
Foam::longClassName::longFunctionName const
|
||||
#+END_EXAMPLE
|
||||
NOT
|
||||
#+BEGIN_EXAMPLE
|
||||
const Foam::longReturnTypeName&
|
||||
Foam::longClassName::longFunctionName const
|
||||
#+END_EXAMPLE
|
||||
NOR
|
||||
#+BEGIN_EXAMPLE
|
||||
const Foam::longReturnTypeName& Foam::longClassName::longFunctionName
|
||||
const
|
||||
#+END_EXAMPLE
|
||||
NOR
|
||||
#+BEGIN_EXAMPLE
|
||||
const Foam::longReturnTypeName& Foam::longClassName::
|
||||
longFunctionName const
|
||||
#+END_EXAMPLE
|
||||
+ if it needs to be split again, split at the function name (leaving
|
||||
behind the preceding scoping =::=s), and again, left align, i.e.
|
||||
#+BEGIN_EXAMPLE
|
||||
const Foam::longReturnTypeName&
|
||||
Foam::veryveryveryverylongClassName::
|
||||
veryveryveryverylongFunctionName const
|
||||
#+END_EXAMPLE
|
||||
|
||||
**** Splitting return type and function name
|
||||
+ split initially after the function return type and left align
|
||||
|
||||
+ do not put =const= onto its own line - use a split to keep it with
|
||||
the function name and arguments.
|
||||
|
||||
so
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
const Foam::longReturnTypeName&
|
||||
Foam::longClassName::longFunctionName const
|
||||
#+END_EXAMPLE
|
||||
|
||||
NOT
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
const Foam::longReturnTypeName&
|
||||
Foam::longClassName::longFunctionName const
|
||||
#+END_EXAMPLE
|
||||
|
||||
NOR
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
const Foam::longReturnTypeName& Foam::longClassName::longFunctionName
|
||||
const
|
||||
#+END_EXAMPLE
|
||||
|
||||
NOR
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
const Foam::longReturnTypeName& Foam::longClassName::
|
||||
longFunctionName const
|
||||
#+END_EXAMPLE
|
||||
|
||||
+ if it needs to be split again, split at the function name (leaving
|
||||
behind the preceding scoping =::=s), and again, left align, i.e.
|
||||
|
||||
For example,
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
const Foam::longReturnTypeName&
|
||||
Foam::veryveryveryverylongClassName::
|
||||
veryveryveryverylongFunctionName const
|
||||
#+END_EXAMPLE
|
||||
|
||||
**** Splitting long lines at an "="
|
||||
|
||||
***** Splitting long lines at an "="
|
||||
Indent after split
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
#+BEGIN_EXAMPLE
|
||||
variableName =
|
||||
longClassName.longFunctionName(longArgument);
|
||||
#+END_EXAMPLE
|
||||
|
||||
#+END_EXAMPLE
|
||||
OR (where necessary)
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
#+BEGIN_EXAMPLE
|
||||
variableName =
|
||||
longClassName.longFunctionName
|
||||
(
|
||||
longArgument1,
|
||||
longArgument2
|
||||
);
|
||||
#+END_EXAMPLE
|
||||
|
||||
#+END_EXAMPLE
|
||||
NOT
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
#+BEGIN_EXAMPLE
|
||||
variableName =
|
||||
longClassName.longFunctionName(longArgument);
|
||||
#+END_EXAMPLE
|
||||
|
||||
#+END_EXAMPLE
|
||||
NOR
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
#+BEGIN_EXAMPLE
|
||||
variableName = longClassName.longFunctionName
|
||||
(
|
||||
longArgument1,
|
||||
longArgument2
|
||||
);
|
||||
#+END_EXAMPLE
|
||||
#+END_EXAMPLE
|
||||
|
||||
*** Maths and Logic
|
||||
+ operator spacing
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
#+BEGIN_EXAMPLE
|
||||
a + b, a - b
|
||||
a*b, a/b
|
||||
a & b, a ^ b
|
||||
a = b, a != b
|
||||
a < b, a > b, a >= b, a <= b
|
||||
a || b, a && b
|
||||
#+END_EXAMPLE
|
||||
#+END_EXAMPLE
|
||||
|
||||
+ splitting formulae over several lines
|
||||
|
||||
Split and indent as per "splitting long lines at an ="
|
||||
with the operator on the lower line. Align operator so that first
|
||||
variable, function or bracket on the next line is 4 spaces indented i.e.
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
variableName =
|
||||
a * (a + b)
|
||||
- exp(c/d)
|
||||
* (k + t);
|
||||
#+END_EXAMPLE
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
variableName =
|
||||
a*(a + b)
|
||||
*exp(c/d)
|
||||
*(k + t);
|
||||
#+END_EXAMPLE
|
||||
This is sometimes more legible when surrounded by extra parentheses:
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
variableName =
|
||||
(
|
||||
a * (a + b)
|
||||
- exp(c/d)
|
||||
* (k + t)
|
||||
);
|
||||
#+END_EXAMPLE
|
||||
#+BEGIN_EXAMPLE
|
||||
variableName =
|
||||
(
|
||||
a*(a + b)
|
||||
*exp(c/d)
|
||||
*(k + t)
|
||||
);
|
||||
#+END_EXAMPLE
|
||||
|
||||
+ splitting logical tests over several lines
|
||||
|
||||
outdent the operator so that the next variable to test is aligned with
|
||||
the four space indentation, i.e.
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
if
|
||||
(
|
||||
a == true
|
||||
&& b == c
|
||||
)
|
||||
#+END_EXAMPLE
|
||||
#+BEGIN_EXAMPLE
|
||||
if
|
||||
(
|
||||
a == true
|
||||
&& b == c
|
||||
)
|
||||
#+END_EXAMPLE
|
||||
|
||||
** Documentation
|
||||
|
||||
*** General
|
||||
|
||||
+ For readability in the comment blocks, certain tags are used that are
|
||||
translated by pre-filtering the file before sending it to Doxygen.
|
||||
|
||||
@ -397,17 +331,16 @@
|
||||
description.
|
||||
|
||||
For example,
|
||||
#+BEGIN_EXAMPLE
|
||||
Class
|
||||
Foam::myClass
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
Class
|
||||
Foam::myClass
|
||||
Description
|
||||
A class for specifying the documentation style.
|
||||
|
||||
Description
|
||||
A class for specifying the documentation style.
|
||||
|
||||
The class is implemented as a set of recommendations that may
|
||||
sometimes be useful.
|
||||
#+END_EXAMPLE
|
||||
The class is implemented as a set of recommendations that may
|
||||
sometimes be useful.
|
||||
#+END_EXAMPLE
|
||||
|
||||
+ The class name must be qualified by its namespace, otherwise Doxygen
|
||||
will think you are documenting some other class.
|
||||
@ -415,49 +348,33 @@
|
||||
+ If you don't have anything to say about the class (at the moment), use
|
||||
the namespace-qualified class name for the description. This aids with
|
||||
finding these under-documented classes later.
|
||||
#+BEGIN_EXAMPLE
|
||||
Class
|
||||
Foam::myUnderDocumentedClass
|
||||
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
Class
|
||||
Foam::myUnderDocumentedClass
|
||||
|
||||
Description
|
||||
Foam::myUnderDocumentedClass
|
||||
#+END_EXAMPLE
|
||||
|
||||
Description
|
||||
Foam::myUnderDocumentedClass
|
||||
#+END_EXAMPLE
|
||||
|
||||
+ Use 'Class' and 'Namespace' tags in the header files.
|
||||
The Description block then applies to documenting the class.
|
||||
|
||||
+ Use 'InClass' and 'InNamespace' in the source files.
|
||||
The Description block then applies to documenting the file itself.
|
||||
#+BEGIN_EXAMPLE
|
||||
InClass
|
||||
Foam::myClass
|
||||
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
InClass
|
||||
Foam::myClass
|
||||
|
||||
Description
|
||||
Implements the read and writing of files.
|
||||
#+END_EXAMPLE
|
||||
Description
|
||||
Implements the read and writing of files.
|
||||
#+END_EXAMPLE
|
||||
|
||||
*** Doxygen Special Commands
|
||||
Doxygen has a large number of special commands with a =\= prefix.
|
||||
|
||||
Doxygen has a large number of special commands with a =\= prefix or
|
||||
(alternatively) an =@= prefix.
|
||||
|
||||
The =@= prefix form is recommended for most Doxygen specials, since it
|
||||
has the advantage of standing out. It also happens to be what projects
|
||||
like gcc and VTK are using.
|
||||
|
||||
The =\= prefix form, however, looks a bit better for the =\n= newline
|
||||
command and when escaping single characters - eg, =\@=, =\<=, =\>=, etc.
|
||||
|
||||
Since the filtering removes the leading 4 spaces within the blocks, the
|
||||
Since the filtering removes the leading spaces within the blocks, the
|
||||
Doxygen commmands can be inserted within the block without problems.
|
||||
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
#+BEGIN_EXAMPLE
|
||||
InClass
|
||||
Foam::myClass
|
||||
|
||||
@ -465,68 +382,57 @@
|
||||
Implements the read and writing of files.
|
||||
|
||||
An example input file:
|
||||
@verbatim
|
||||
\verbatim
|
||||
patchName
|
||||
{
|
||||
type myPatchType;
|
||||
refValue 100;
|
||||
value uniform 1;
|
||||
}
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
Within the implementation, a loop over all patches is done:
|
||||
@code
|
||||
\code
|
||||
forAll(patches, patchI)
|
||||
{
|
||||
... // some operation
|
||||
}
|
||||
@endcode
|
||||
#+END_EXAMPLE
|
||||
\endcode
|
||||
#+END_EXAMPLE
|
||||
|
||||
*** HTML Special Commands
|
||||
|
||||
Since Doxygen also handles HTML tags to a certain extent, the angle
|
||||
brackets need quoting in the documentation blocks. Non-HTML tags cause
|
||||
Doxygen to complain, but seem to work anyhow.
|
||||
|
||||
eg,
|
||||
+ The template with type =<HR>= is a bad example.
|
||||
|
||||
+ The template with type =\<HR\>= is a better example.
|
||||
|
||||
+ The template with type =<Type>= causes Doxygen to complain about an
|
||||
unknown html type, but it seems to work okay anyhow.
|
||||
|
||||
|
||||
*** Documenting Namespaces
|
||||
|
||||
+ If namespaces are explictly declared with the =Namespace()= macro,
|
||||
they should be documented there.
|
||||
|
||||
+ If the namespaces is used to hold sub-models, the namespace can be
|
||||
documented in the same file as the class with the model selector.
|
||||
eg,
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
documented namespace 'Foam::functionEntries' within the
|
||||
class 'Foam::functionEntry'
|
||||
#+END_EXAMPLE
|
||||
#+BEGIN_EXAMPLE
|
||||
documented namespace 'Foam::functionEntries' within the
|
||||
class 'Foam::functionEntry'
|
||||
#+END_EXAMPLE
|
||||
|
||||
+ If nothing else helps, find some sensible header.
|
||||
eg,
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
namespace 'Foam' is documented in the foamVersion.H file
|
||||
#+END_EXAMPLE
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
namespace 'Foam' is documented in the foamVersion.H file
|
||||
#+END_EXAMPLE
|
||||
|
||||
*** Documenting typedefs and classes defined via macros
|
||||
|
||||
... not yet properly resolved
|
||||
|
||||
|
||||
*** Documenting Applications
|
||||
|
||||
Any number of classes might be defined by a particular application, but
|
||||
these classes will not, however, be available to other parts of
|
||||
OpenFOAM. At the moment, the sole purpuse for running Doxygen on the
|
||||
@ -542,23 +448,17 @@
|
||||
The layout of the application documentation has not yet been finalized,
|
||||
but foamToVTK shows an initial attempt.
|
||||
|
||||
*** Orthography (an opinion)
|
||||
|
||||
Given the origins of OpenFOAM, the British spellings (eg, neighbour and
|
||||
not neighbor) are generally favoured. For code sections that interact
|
||||
with external libraries, it can be useful to adopt American spellings,
|
||||
especially for names that constitute a significant part of the external
|
||||
library - eg, 'color' within graphics sub-systems.
|
||||
*** Orthography
|
||||
Given the origins of OpenFOAM, the British spellings (eg, neighbour and not
|
||||
neighbor) are generally favoured.
|
||||
|
||||
Both '-ize' and the '-ise' variant are found in the code comments. If
|
||||
used as a variable or class method name, it is probably better to use
|
||||
'-ize', which is considered the main form by the Oxford University
|
||||
Press.
|
||||
|
||||
Eg,
|
||||
#+BEGIN_EXAMPLE
|
||||
Press. Eg,
|
||||
#+BEGIN_EXAMPLE
|
||||
myClass.initialize()
|
||||
#+END_EXAMPLE
|
||||
#+END_EXAMPLE
|
||||
|
||||
The word "its" (possesive) vs. "it's" (colloquial for "it is" or "it has")
|
||||
seems to confuse non-native (and some native) English speakers.
|
||||
|
||||
Binary file not shown.
@ -581,16 +581,16 @@ WARN_LOGFILE =
|
||||
# directories like "/usr/src/myproject". Separate the files or directories
|
||||
# with spaces.
|
||||
|
||||
#INPUT = $(WM_PROJECT_DIR)/src \
|
||||
# $(WM_PROJECT_DIR)/applications/utilities \
|
||||
# $(WM_PROJECT_DIR)/applications/solvers
|
||||
INPUT = $(WM_PROJECT_DIR)/src \
|
||||
$(WM_PROJECT_DIR)/applications/utilities \
|
||||
$(WM_PROJECT_DIR)/applications/solvers
|
||||
|
||||
# limit input for testing purposes
|
||||
INPUT = $(WM_PROJECT_DIR)/src/OpenFOAM/global \
|
||||
$(WM_PROJECT_DIR)/src/OpenFOAM/containers \
|
||||
$(WM_PROJECT_DIR)/src/OpenFOAM/primitives \
|
||||
$(WM_PROJECT_DIR)/sampling \
|
||||
$(WM_PROJECT_DIR)/src/finiteVolume/fvMesh
|
||||
# INPUT = $(WM_PROJECT_DIR)/src/OpenFOAM/global \
|
||||
# $(WM_PROJECT_DIR)/src/OpenFOAM/containers \
|
||||
# $(WM_PROJECT_DIR)/src/OpenFOAM/primitives \
|
||||
# $(WM_PROJECT_DIR)/sampling \
|
||||
# $(WM_PROJECT_DIR)/src/finiteVolume/fvMesh
|
||||
|
||||
# This tag can be used to specify the character encoding of the source files
|
||||
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -29,7 +29,7 @@ Description
|
||||
|
||||
SeeAlso
|
||||
The manpage regex(7) for more information about POSIX regular expressions.
|
||||
These differ somewhat from @c Perl and @c sed regular expressions.
|
||||
These differ somewhat from \c Perl and @c sed regular expressions.
|
||||
|
||||
SourceFiles
|
||||
regExp.C
|
||||
|
||||
@ -28,9 +28,9 @@ Description
|
||||
Set up trapping for floating point exceptions (signal FPE).
|
||||
|
||||
Controlled by two env vars:
|
||||
@param FOAM_SIGFPE \n
|
||||
\param FOAM_SIGFPE \n
|
||||
exception trapping
|
||||
@param FOAM_SETNAN \n
|
||||
\param FOAM_SETNAN \n
|
||||
initialization of all malloced memory to NaN. If FOAM_SIGFPE
|
||||
also set, this will cause usage of uninitialized scalars to trigger
|
||||
an abort.
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -28,7 +28,7 @@ Description
|
||||
Implements a timeout mechanism via sigalarm.
|
||||
|
||||
Example usage:
|
||||
@code
|
||||
\code
|
||||
timer myTimer(5); // 5 sec
|
||||
..
|
||||
if (timedOut(myTimer))
|
||||
@ -39,7 +39,7 @@ Description
|
||||
{
|
||||
// do something possible blocking
|
||||
}
|
||||
@endcode
|
||||
\endcode
|
||||
|
||||
Constructor set signal handler on sigalarm and alarm(). Destructor
|
||||
clears these.
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -236,10 +236,10 @@ public:
|
||||
|
||||
//- Read a bracket-delimited list, or handle a single value as list of size 1.
|
||||
// For example,
|
||||
// @code
|
||||
// \code
|
||||
// wList = readList<word>(IStringStream("(patch1 patch2 patch3)")());
|
||||
// wList = readList<word>(IStringStream("patch0")());
|
||||
// @endcode
|
||||
// \endcode
|
||||
// Mostly useful for handling command-line arguments.
|
||||
template<class T>
|
||||
List<T> readList(Istream&);
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -37,7 +37,7 @@ Description
|
||||
in one go, minimizing communication, and then picked apart and recombined.
|
||||
|
||||
Example:
|
||||
@code
|
||||
\code
|
||||
// Assuming myContainer defined which holds all the data I want to
|
||||
// transfer (say a pointField and a faceList). myContainer also defines
|
||||
// access operators to
|
||||
@ -76,7 +76,7 @@ Description
|
||||
gatheredData, sizes, myContainerFaces(), offsetOp<face>()
|
||||
)
|
||||
);
|
||||
@endcode
|
||||
\endcode
|
||||
|
||||
SourceFiles
|
||||
ListListOps.C
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2010-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2010-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -54,7 +54,7 @@ namespace Foam
|
||||
// Forward declaration
|
||||
class PackedBoolList;
|
||||
|
||||
//- @typedef A List of PackedBoolList
|
||||
//- \typedef A List of PackedBoolList
|
||||
typedef List<PackedBoolList> PackedBoolListList;
|
||||
|
||||
/*---------------------------------------------------------------------------*\
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -42,11 +42,11 @@ Note
|
||||
|
||||
Using the iteratorBase as a proxy allows assignment of values
|
||||
between list elements. Thus the following bit of code works as expected:
|
||||
@code
|
||||
\code
|
||||
list[1] = list[5]; // value assignment, not iterator position
|
||||
list[2] = list[5] = 4; // propagates value
|
||||
list[1] = list[5] = list[6]; // propagates value
|
||||
@endcode
|
||||
\endcode
|
||||
|
||||
Using get() or the '[]' operator are similarly fast. Looping and reading
|
||||
via an iterator is approx. 15% slower, but can be more flexible.
|
||||
@ -56,21 +56,21 @@ Note
|
||||
advantage of also returning a bool if the value changed. This can be
|
||||
useful for branching on changed values.
|
||||
|
||||
@code
|
||||
\code
|
||||
list[5] = 4;
|
||||
changed = list.set(5, 8);
|
||||
if (changed) ...
|
||||
@endcode
|
||||
\endcode
|
||||
|
||||
The lazy evaluation used means that reading an out-of-range element
|
||||
returns zero, but does not affect the list size. Even in a non-const
|
||||
context, only the assigment itself causes the element to be created.
|
||||
For example,
|
||||
@code
|
||||
\code
|
||||
list.resize(4);
|
||||
Info<< list[10] << "\n"; // print zero, but doesn't adjust list
|
||||
list[8] = 1;
|
||||
@endcode
|
||||
\endcode
|
||||
|
||||
Also note that all unused internal storage elements are guaranteed to
|
||||
always be bit-wise zero. This property must not be violated by any
|
||||
@ -79,14 +79,14 @@ Note
|
||||
In addition to the normal output format, PackedList also supports a
|
||||
compact ASCII format that may be convenient for user input in some
|
||||
situations. The general format is a group of index/value pairs:
|
||||
@verbatim
|
||||
\verbatim
|
||||
{ (index1 value1) (index2 value2) (index3 value3) }
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
The bool specialization just uses the indices corresponding to
|
||||
non-zero entries instead of a index/value pair:
|
||||
@verbatim
|
||||
\verbatim
|
||||
{ index1 index2 index3 }
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
In both cases, the supplied indices can be randomly ordered.
|
||||
|
||||
SeeAlso
|
||||
@ -356,14 +356,14 @@ public:
|
||||
//
|
||||
// The indexed output may be convenient in some situations.
|
||||
// The general format is a group of index/value pairs:
|
||||
// @verbatim
|
||||
// \verbatim
|
||||
// { (index1 value1) (index2 value2) (index3 value3) }
|
||||
// @endverbatim
|
||||
// \endverbatim
|
||||
// The bool specialization just uses the indices corresponding to
|
||||
// non-zero entries instead of a index/value pair:
|
||||
// @verbatim
|
||||
// \verbatim
|
||||
// { index1 index2 index3 }
|
||||
// @endverbatim
|
||||
// \endverbatim
|
||||
//
|
||||
// Note the indexed output is only supported for ASCII streams.
|
||||
Ostream& write
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -367,28 +367,28 @@ inline void reverse(UList<T>&);
|
||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||
|
||||
/**
|
||||
* @def forAll(list, i)
|
||||
* Loop across all elements in @a list
|
||||
* @par Usage
|
||||
* @code
|
||||
* \def forAll(list, i)
|
||||
* Loop across all elements in \a list
|
||||
* \par Usage
|
||||
* \code
|
||||
* forAll(anyList, i)
|
||||
* {
|
||||
* statements;
|
||||
* }
|
||||
* @endcode
|
||||
* @sa forAllReverse
|
||||
* \endcode
|
||||
* \sa forAllReverse
|
||||
*/
|
||||
/**
|
||||
* @def forAllReverse(list, i)
|
||||
* Reverse loop across all elements in @a list
|
||||
* @par Usage
|
||||
* @code
|
||||
* \def forAllReverse(list, i)
|
||||
* Reverse loop across all elements in \a list
|
||||
* \par Usage
|
||||
* \code
|
||||
* forAllReverse(anyList, i)
|
||||
* {
|
||||
* statements;
|
||||
* }
|
||||
* @endcode
|
||||
* @sa forAll
|
||||
* \endcode
|
||||
* \sa forAll
|
||||
*/
|
||||
#define forAll(list, i) \
|
||||
for (Foam::label i=0; i<(list).size(); i++)
|
||||
@ -397,17 +397,17 @@ inline void reverse(UList<T>&);
|
||||
for (Foam::label i=(list).size()-1; i>=0; i--)
|
||||
|
||||
/**
|
||||
* @def forAllIter(Container, container, iter)
|
||||
* Iterate across all elements in the @a container object of type
|
||||
* @a Container.
|
||||
* @par Usage
|
||||
* @code
|
||||
* \def forAllIter(Container, container, iter)
|
||||
* Iterate across all elements in the \a container object of type
|
||||
* \a Container.
|
||||
* \par Usage
|
||||
* \code
|
||||
* forAll(ContainerType, container, iter)
|
||||
* {
|
||||
* statements;
|
||||
* }
|
||||
* @endcode
|
||||
* @sa forAllConstIter
|
||||
* \endcode
|
||||
* \sa forAllConstIter
|
||||
*/
|
||||
#define forAllIter(Container,container,iter) \
|
||||
for \
|
||||
@ -418,17 +418,17 @@ inline void reverse(UList<T>&);
|
||||
)
|
||||
|
||||
/**
|
||||
* @def forAllConstIter(Container, container, iter)
|
||||
* Iterate across all elements in the @a container object of type
|
||||
* @a Container with const access.
|
||||
* @par Usage
|
||||
* @code
|
||||
* \def forAllConstIter(Container, container, iter)
|
||||
* Iterate across all elements in the \a container object of type
|
||||
* \a Container with const access.
|
||||
* \par Usage
|
||||
* \code
|
||||
* forAllConstIter(ContainerType, container, iter)
|
||||
* {
|
||||
* statements;
|
||||
* }
|
||||
* @endcode
|
||||
* @sa forAllIter
|
||||
* \endcode
|
||||
* \sa forAllIter
|
||||
*/
|
||||
#define forAllConstIter(Container,container,iter) \
|
||||
for \
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -33,32 +33,32 @@ Description
|
||||
path, a reference to a objectRegistry, and parameters determining its
|
||||
storage status.
|
||||
|
||||
@par Read options
|
||||
\par Read options
|
||||
|
||||
Define what is done on object construction and explicit reads:
|
||||
@param MUST_READ
|
||||
\param MUST_READ
|
||||
Object must be read from Istream on construction. \n
|
||||
Error if Istream does not exist or can't be read.
|
||||
Does not check timestamp or re-read.
|
||||
@param MUST_READ_IF_MODIFIED
|
||||
\param MUST_READ_IF_MODIFIED
|
||||
Object must be read from Istream on construction. \n
|
||||
Error if Istream does not exist or can't be read. If object is
|
||||
registered its timestamp will be checked every timestep and possibly
|
||||
re-read.
|
||||
@param READ_IF_PRESENT
|
||||
\param READ_IF_PRESENT
|
||||
Read object from Istream if Istream exists, otherwise don't. \n
|
||||
Error only if Istream exists but can't be read.
|
||||
Does not check timestamp or re-read.
|
||||
@param NO_READ
|
||||
\param NO_READ
|
||||
Don't read
|
||||
|
||||
@par Write options
|
||||
\par Write options
|
||||
|
||||
Define what is done on object destruction and explicit writes:
|
||||
@param AUTO_WRITE
|
||||
\param AUTO_WRITE
|
||||
Object is written automatically when requested to by the
|
||||
objectRegistry.
|
||||
@param NO_WRITE
|
||||
\param NO_WRITE
|
||||
No automatic write on destruction but can be written explicitly
|
||||
|
||||
SourceFiles
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -393,39 +393,39 @@ public:
|
||||
//- Return true if run should continue,
|
||||
// also invokes the functionObjectList::end() method
|
||||
// when the time goes out of range
|
||||
// @note
|
||||
// \note
|
||||
// For correct behaviour, the following style of time-loop
|
||||
// is recommended:
|
||||
// @code
|
||||
// \code
|
||||
// while (runTime.run())
|
||||
// {
|
||||
// runTime++;
|
||||
// solve;
|
||||
// runTime.write();
|
||||
// }
|
||||
// @endcode
|
||||
// \endcode
|
||||
virtual bool run() const;
|
||||
|
||||
//- Return true if run should continue and if so increment time
|
||||
// also invokes the functionObjectList::end() method
|
||||
// when the time goes out of range
|
||||
// @note
|
||||
// \note
|
||||
// For correct behaviour, the following style of time-loop
|
||||
// is recommended:
|
||||
// @code
|
||||
// \code
|
||||
// while (runTime.loop())
|
||||
// {
|
||||
// solve;
|
||||
// runTime.write();
|
||||
// }
|
||||
// @endcode
|
||||
// \endcode
|
||||
virtual bool loop();
|
||||
|
||||
//- Return true if end of run,
|
||||
// does not invoke any functionObject methods
|
||||
// @note
|
||||
// \note
|
||||
// The rounding heuristics near endTime mean that
|
||||
// @code run() @endcode and @code !end() @endcode may
|
||||
// \code run() \endcode and \code !end() \endcode may
|
||||
// not yield the same result
|
||||
virtual bool end() const;
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -30,7 +30,7 @@ Description
|
||||
The timeSelector provides a convenient means of selecting multiple
|
||||
times. A typical use would be the following:
|
||||
|
||||
@verbatim
|
||||
\verbatim
|
||||
timeSelector::addOptions();
|
||||
// add other options
|
||||
#include "setRootCase.H"
|
||||
@ -41,27 +41,27 @@ Description
|
||||
{
|
||||
...
|
||||
}
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
There may however also be many cases in which neither the @c constant/
|
||||
directory nor the @c 0/ directory contain particularly relevant
|
||||
There may however also be many cases in which neither the \c constant/
|
||||
directory nor the \c 0/ directory contain particularly relevant
|
||||
information. This might occur, for example, when post-processing
|
||||
results. In this case, addOptions is called with optional boolean
|
||||
arguments.
|
||||
|
||||
@verbatim
|
||||
\verbatim
|
||||
timeSelector::addOptions(false, true);
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
The first argument avoids adding the @b -constant option. The second
|
||||
argument adds an additional @b -zeroTime option and also prevents the
|
||||
@c 0/ directory from being included in the default time range and in the
|
||||
@b -latestTime selection.
|
||||
The first argument avoids adding the \b -constant option. The second
|
||||
argument adds an additional \b -zeroTime option and also prevents the
|
||||
\c 0/ directory from being included in the default time range and in the
|
||||
\b -latestTime selection.
|
||||
|
||||
SourceFiles
|
||||
timeSelector.C
|
||||
@ -119,15 +119,15 @@ public:
|
||||
|
||||
//- Add the options handled by timeSelector to argList::validOptions
|
||||
//
|
||||
// @param constant
|
||||
// Add the @b -constant option to include the @c constant/ directory
|
||||
// \param constant
|
||||
// Add the \b -constant option to include the \c constant/ directory
|
||||
//
|
||||
// @param zeroTime
|
||||
// Enable the @b -zeroTime option and alter the normal time selection
|
||||
// behaviour (and @b -latestTime behaviour) to exclude the @c 0/
|
||||
// directory. The @c 0/ directory will only be included when
|
||||
// @b -zeroTime is specified.
|
||||
// The @b -noZero option has precedence over the @b -zeroTime option.
|
||||
// \param zeroTime
|
||||
// Enable the \b -zeroTime option and alter the normal time selection
|
||||
// behaviour (and \b -latestTime behaviour) to exclude the \c 0/
|
||||
// directory. The \c 0/ directory will only be included when
|
||||
// \b -zeroTime is specified.
|
||||
// The \b -noZero option has precedence over the @b -zeroTime option.
|
||||
static void addOptions
|
||||
(
|
||||
const bool constant=true,
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -35,7 +35,7 @@ Description
|
||||
A functionEntry causes entries to be added/manipulated on the specified
|
||||
dictionary given an input stream.
|
||||
|
||||
In dictionaries, a @c '\#' sigil is typically used for a functionEntry.
|
||||
In dictionaries, a \c '\#' sigil is typically used for a functionEntry.
|
||||
|
||||
SourceFiles
|
||||
functionEntry.C
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -28,13 +28,13 @@ Description
|
||||
Specify an include file when reading dictionaries, expects a
|
||||
single string to follow.
|
||||
|
||||
An example of the @c \#include directive:
|
||||
@verbatim
|
||||
An example of the \c \#include directive:
|
||||
\verbatim
|
||||
#include "includeFile"
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
The usual expansion of environment variables and other constructs
|
||||
(eg, the @c ~OpenFOAM/ expansion) is retained.
|
||||
(eg, the \c ~OpenFOAM/ expansion) is retained.
|
||||
|
||||
See Also
|
||||
fileName, string::expand()
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -27,7 +27,7 @@ Class
|
||||
Description
|
||||
Specify a file to include if it exists. Expects a single string to follow.
|
||||
|
||||
The @c \#includeIfPresent directive is similar to the @c \#include
|
||||
The \c \#includeIfPresent directive is similar to the @c \#include
|
||||
directive, but does not generate an error if the file does not exist.
|
||||
|
||||
See Also
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -28,18 +28,18 @@ Description
|
||||
Specify the input mode when reading dictionaries, expects
|
||||
a single word to follow.
|
||||
|
||||
An example of @c \#inputMode directive:
|
||||
@verbatim
|
||||
An example of \c \#inputMode directive:
|
||||
\verbatim
|
||||
#inputMode merge
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
The possible input modes:
|
||||
@param merge merge sub-dictionaries when possible
|
||||
@param overwrite keep last entry and silently remove previous ones
|
||||
@param protect keep initial entry and silently ignore subsequent ones
|
||||
@param warn keep initial entry and warn about subsequent ones
|
||||
@param error issue a FatalError for duplicate entries
|
||||
@param default currently identical to merge
|
||||
\param merge merge sub-dictionaries when possible
|
||||
\param overwrite keep last entry and silently remove previous ones
|
||||
\param protect keep initial entry and silently ignore subsequent ones
|
||||
\param warn keep initial entry and warn about subsequent ones
|
||||
\param error issue a FatalError for duplicate entries
|
||||
\param default currently identical to merge
|
||||
|
||||
SourceFiles
|
||||
inputModeEntry.C
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -27,14 +27,14 @@ Class
|
||||
Description
|
||||
Remove a dictionary entry.
|
||||
|
||||
The @c \#remove directive takes a list or a single wordRe.
|
||||
The \c \#remove directive takes a list or a single wordRe.
|
||||
For example,
|
||||
@verbatim
|
||||
\verbatim
|
||||
#remove entry0
|
||||
#remove ( entry1 entry2 entry3 otherEntry )
|
||||
#remove "entry[1-3]"
|
||||
#remove ( "entry[1-3]" otherEntry )
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
The removal only occurs in the current context.
|
||||
Removing sub-entries or parent entries is not supported.
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2008-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2008-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -72,7 +72,7 @@ class StaticAssertionTest {};
|
||||
// external use:
|
||||
// ~~~~~~~~~~~~~
|
||||
/**
|
||||
* @def StaticAssert(Test)
|
||||
* \def StaticAssert(Test)
|
||||
* Assert that some test is true at compile-time
|
||||
*/
|
||||
#define StaticAssert(Test) \
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -35,10 +35,10 @@ Description
|
||||
handling has beed switched on (off by default).
|
||||
|
||||
Usage
|
||||
@code
|
||||
\code
|
||||
error << "message1" << "message2" << FoamDataType << exit(errNo);
|
||||
error << "message1" << "message2" << FoamDataType << abort();
|
||||
@endcode
|
||||
\endcode
|
||||
|
||||
SourceFiles
|
||||
error.C
|
||||
@ -296,7 +296,7 @@ extern IOerror FatalIOError;
|
||||
// Convenience macros to add the file name and line number to the function name
|
||||
|
||||
/**
|
||||
* @def FatalErrorIn(functionName)
|
||||
* \def FatalErrorIn(functionName)
|
||||
* Report an error message using Foam::FatalError for functionName in
|
||||
* file __FILE__ at line __LINE__
|
||||
*/
|
||||
@ -304,7 +304,7 @@ extern IOerror FatalIOError;
|
||||
::Foam::FatalError((fn), __FILE__, __LINE__)
|
||||
|
||||
/**
|
||||
* @def FatalIOErrorIn(functionName, ios)
|
||||
* \def FatalIOErrorIn(functionName, ios)
|
||||
* Report an error message using Foam::FatalIOError for functionName in
|
||||
* file __FILE__ at line __LINE__
|
||||
* for a particular IOstream
|
||||
@ -313,12 +313,12 @@ extern IOerror FatalIOError;
|
||||
::Foam::FatalIOError((fn), __FILE__, __LINE__, (ios))
|
||||
|
||||
/**
|
||||
* @def notImplemented(functionName)
|
||||
* \def notImplemented(functionName)
|
||||
* Issue a FatalErrorIn for the functionName.
|
||||
* This is used for functions that are not currently implemented.
|
||||
* The functionName is printed and then abort is called.
|
||||
*
|
||||
* @note
|
||||
* \note
|
||||
* This macro can be particularly useful when methods must be defined to
|
||||
* complete the interface of a derived class even if they should never be
|
||||
* called for this derived class.
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -30,10 +30,10 @@ Description
|
||||
handling has been switched on (off by default).
|
||||
|
||||
Usage
|
||||
@code
|
||||
\code
|
||||
error << "message1" << "message2" << FoamDataType << exit(error, errNo);
|
||||
error << "message1" << "message2" << FoamDataType << abort(error);
|
||||
@endcode
|
||||
\endcode
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -34,10 +34,10 @@ Description
|
||||
the messageStream class in the standard manner.
|
||||
|
||||
Usage
|
||||
@code
|
||||
\code
|
||||
messageStream
|
||||
<< "message1" << "message2" << FoamDataType << endl;
|
||||
@endcode
|
||||
\endcode
|
||||
|
||||
SourceFiles
|
||||
messageStream.C
|
||||
@ -214,7 +214,7 @@ extern messageStream Info;
|
||||
// Convenience macros to add the file name and line number to the function name
|
||||
|
||||
/**
|
||||
* @def SeriousErrorIn(functionName)
|
||||
* \def SeriousErrorIn(functionName)
|
||||
* Report an error message using Foam::SeriousError for functionName in
|
||||
* file __FILE__ at line __LINE__
|
||||
*/
|
||||
@ -222,7 +222,7 @@ extern messageStream Info;
|
||||
::Foam::SeriousError((fn), __FILE__, __LINE__)
|
||||
|
||||
/**
|
||||
* @def SeriousIOErrorIn(functionName, ios)
|
||||
* \def SeriousIOErrorIn(functionName, ios)
|
||||
* Report an IO error message using Foam::SeriousError for functionName in
|
||||
* file __FILE__ at line __LINE__
|
||||
* for a particular IOstream
|
||||
@ -231,7 +231,7 @@ extern messageStream Info;
|
||||
::Foam::SeriousError((fn), __FILE__, __LINE__, ios)
|
||||
|
||||
/**
|
||||
* @def WarningIn(functionName)
|
||||
* \def WarningIn(functionName)
|
||||
* Report a warning using Foam::Warning for functionName in
|
||||
* file __FILE__ at line __LINE__
|
||||
*/
|
||||
@ -239,7 +239,7 @@ extern messageStream Info;
|
||||
::Foam::Warning((fn), __FILE__, __LINE__)
|
||||
|
||||
/**
|
||||
* @def IOWarningIn(functionName, ios)
|
||||
* \def IOWarningIn(functionName, ios)
|
||||
* Report an IO warning using Foam::Warning for functionName in
|
||||
* file __FILE__ at line __LINE__
|
||||
* for a particular IOstream
|
||||
@ -248,7 +248,7 @@ extern messageStream Info;
|
||||
::Foam::Warning((fn), __FILE__, __LINE__, (ios))
|
||||
|
||||
/**
|
||||
* @def InfoIn(functionName)
|
||||
* \def InfoIn(functionName)
|
||||
* Report a information message using Foam::Info for functionName in
|
||||
* file __FILE__ at line __LINE__
|
||||
*/
|
||||
@ -256,7 +256,7 @@ extern messageStream Info;
|
||||
::Foam::Info((fn), __FILE__, __LINE__)
|
||||
|
||||
/**
|
||||
* @def IOInfoIn(functionName, ios)
|
||||
* \def IOInfoIn(functionName, ios)
|
||||
* Report an IO information message using Foam::Info for functionName in
|
||||
* file __FILE__ at line __LINE__
|
||||
* for a particular IOstream
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -30,9 +30,9 @@ Description
|
||||
|
||||
Note
|
||||
Since the timeIndex is used directly from Foam::Time, it is unaffected
|
||||
by user-time conversions. For example, Foam::engineTime might cause @a
|
||||
by user-time conversions. For example, Foam::engineTime might cause \a
|
||||
writeInterval to be degrees crank angle, but the functionObject
|
||||
execution @a interval would still be in timestep.
|
||||
execution \a interval would still be in timestep.
|
||||
|
||||
SourceFiles
|
||||
OutputFilterFunctionObject.C
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -108,7 +108,7 @@ public:
|
||||
|
||||
//- Construct from Time, a dictionary with "functions" entry
|
||||
// and the execution setting.
|
||||
// @param[in] parentDict - the parent dictionary containing
|
||||
// \param[in] parentDict - the parent dictionary containing
|
||||
// a "functions" entry, which can either be a list or a dictionary
|
||||
// of functionObject specifications.
|
||||
functionObjectList
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -74,7 +74,7 @@ private:
|
||||
//- Type of output
|
||||
outputControls outputControl_;
|
||||
|
||||
//- The execution interval (in time steps) when using @c timeStep mode,
|
||||
//- The execution interval (in time steps) when using \c timeStep mode,
|
||||
// a value <= 1 means execute at every time step
|
||||
label outputInterval_;
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -39,19 +39,19 @@ Description
|
||||
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
|
||||
//- Add typeName information from argument @a TypeNameString to a class.
|
||||
//- Add typeName information from argument \a TypeNameString to a class.
|
||||
// Without debug information
|
||||
#define ClassNameNoDebug(TypeNameString) \
|
||||
static const char* typeName_() { return TypeNameString; } \
|
||||
static const ::Foam::word typeName
|
||||
|
||||
//- Add typeName information from argument @a TypeNameString to a namespace.
|
||||
//- Add typeName information from argument \a TypeNameString to a namespace.
|
||||
// Without debug information.
|
||||
#define NamespaceNameNoDebug(TypeNameString) \
|
||||
inline const char* typeName_() { return TypeNameString; } \
|
||||
extern const ::Foam::word typeName
|
||||
|
||||
//- Add typeName information from argument @a TemplateNameString to a
|
||||
//- Add typeName information from argument \a TemplateNameString to a
|
||||
// template class. Without debug information.
|
||||
#define TemplateNameNoDebug(TemplateNameString) \
|
||||
class TemplateNameString##Name \
|
||||
@ -68,19 +68,19 @@ public: \
|
||||
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
|
||||
//- Add typeName information from argument @a TypeNameString to a class.
|
||||
//- Add typeName information from argument \a TypeNameString to a class.
|
||||
// Also declares debug information.
|
||||
#define ClassName(TypeNameString) \
|
||||
ClassNameNoDebug(TypeNameString); \
|
||||
static int debug
|
||||
|
||||
//- Add typeName information from argument @a TypeNameString to a namespace.
|
||||
//- Add typeName information from argument \a TypeNameString to a namespace.
|
||||
// Also declares debug information.
|
||||
#define NamespaceName(TypeNameString) \
|
||||
NamespaceNameNoDebug(TypeNameString); \
|
||||
extern int debug
|
||||
|
||||
//- Add typeName information from argument @a TypeNameString to a
|
||||
//- Add typeName information from argument \a TypeNameString to a
|
||||
// template class. Also declares debug information.
|
||||
#define TemplateName(TemplateNameString) \
|
||||
class TemplateNameString##Name \
|
||||
@ -97,7 +97,7 @@ public: \
|
||||
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
|
||||
//- Define the typeName, with alternative lookup as @a Name
|
||||
//- Define the typeName, with alternative lookup as \a Name
|
||||
#define defineTypeNameWithName(Type, Name) \
|
||||
const ::Foam::word Type::typeName(Name)
|
||||
|
||||
@ -106,18 +106,18 @@ public: \
|
||||
defineTypeNameWithName(Type, Type::typeName_())
|
||||
|
||||
#ifdef __INTEL_COMPILER
|
||||
//- Define the typeName as @a Name for template classes
|
||||
//- Define the typeName as \a Name for template classes
|
||||
# define defineTemplateTypeNameWithName(Type, Name) \
|
||||
defineTypeNameWithName(Type, Name)
|
||||
//- Define the typeName as @a Name for template sub-classes
|
||||
//- Define the typeName as \a Name for template sub-classes
|
||||
# define defineTemplate2TypeNameWithName(Type, Name) \
|
||||
defineTypeNameWithName(Type, Name)
|
||||
#else
|
||||
//- Define the typeName as @a Name for template classes
|
||||
//- Define the typeName as \a Name for template classes
|
||||
# define defineTemplateTypeNameWithName(Type, Name) \
|
||||
template<> \
|
||||
defineTypeNameWithName(Type, Name)
|
||||
//- Define the typeName as @a Name for template sub-classes
|
||||
//- Define the typeName as \a Name for template sub-classes
|
||||
# define defineTemplate2TypeNameWithName(Type, Name) \
|
||||
template<> \
|
||||
template<> \
|
||||
@ -139,7 +139,7 @@ public: \
|
||||
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
|
||||
//- Define the debug information, lookup as @a Name
|
||||
//- Define the debug information, lookup as \a Name
|
||||
#define defineDebugSwitchWithName(Type, Name, DebugSwitch) \
|
||||
int Type::debug(::Foam::debug::debugSwitch(Name, DebugSwitch))
|
||||
|
||||
@ -148,18 +148,18 @@ public: \
|
||||
defineDebugSwitchWithName(Type, Type::typeName_(), DebugSwitch)
|
||||
|
||||
#ifdef __INTEL_COMPILER
|
||||
//- Define the debug information for templates, lookup as @a Name
|
||||
//- Define the debug information for templates, lookup as \a Name
|
||||
# define defineTemplateDebugSwitchWithName(Type, Name, DebugSwitch) \
|
||||
defineDebugSwitchWithName(Type, Name, DebugSwitch)
|
||||
//- Define the debug information for templates sub-classes, lookup as @a Name
|
||||
//- Define the debug information for templates sub-classes, lookup as \a Name
|
||||
# define defineTemplate2DebugSwitchWithName(Type, Name, DebugSwitch) \
|
||||
defineDebugSwitchWithName(Type, Name, DebugSwitch)
|
||||
#else
|
||||
//- Define the debug information for templates, lookup as @a Name
|
||||
//- Define the debug information for templates, lookup as \a Name
|
||||
# define defineTemplateDebugSwitchWithName(Type, Name, DebugSwitch) \
|
||||
template<> \
|
||||
defineDebugSwitchWithName(Type, Name, DebugSwitch)
|
||||
//- Define the debug information for templates sub-classes, lookup as @a Name
|
||||
//- Define the debug information for templates sub-classes, lookup as \a Name
|
||||
# define defineTemplate2DebugSwitchWithName(Type, Name, DebugSwitch) \
|
||||
template<> \
|
||||
template<> \
|
||||
@ -199,7 +199,7 @@ public: \
|
||||
defineTypeName(Type); \
|
||||
defineDebugSwitch(Type, DebugSwitch)
|
||||
|
||||
//- Define the typeName and debug information, lookup as @a Name
|
||||
//- Define the typeName and debug information, lookup as \a Name
|
||||
#define defineTemplateTypeNameAndDebugWithName(Type, Name, DebugSwitch) \
|
||||
defineTemplateTypeNameWithName(Type, Name); \
|
||||
defineTemplateDebugSwitchWithName(Type, Name, DebugSwitch)
|
||||
@ -216,7 +216,7 @@ public: \
|
||||
|
||||
// for templated sub-classes
|
||||
|
||||
//- Define the typeName and debug information, lookup as @a Name
|
||||
//- Define the typeName and debug information, lookup as \a Name
|
||||
#define defineTemplate2TypeNameAndDebugWithName(Type, Name, DebugSwitch) \
|
||||
defineTemplate2TypeNameWithName(Type, Name); \
|
||||
defineTemplate2DebugSwitchWithName(Type, Name, DebugSwitch)
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -29,22 +29,22 @@ Description
|
||||
Used to enhance the standard RTTI to cover I/O.
|
||||
|
||||
The user can get the type's type name using the type info access function
|
||||
@code
|
||||
\code
|
||||
type()
|
||||
@endcode
|
||||
\endcode
|
||||
|
||||
The reference type cast template function:
|
||||
@code
|
||||
\code
|
||||
refCast<T>(r)
|
||||
@endcode
|
||||
\endcode
|
||||
|
||||
wraps dynamic_cast to handle the bad_cast exception and generate a
|
||||
FatalError.
|
||||
|
||||
The isA function:
|
||||
@code
|
||||
\code
|
||||
isA<T>(r)
|
||||
@endcode
|
||||
\endcode
|
||||
|
||||
returns true if r is of type T or derived from type T.
|
||||
|
||||
|
||||
@ -26,38 +26,38 @@ Class
|
||||
|
||||
Description
|
||||
Extract command arguments and options from the supplied
|
||||
@a argc and @a argv parameters.
|
||||
\a argc and @a argv parameters.
|
||||
|
||||
Sequences with "(" ... ")" are transformed into a stringList.
|
||||
For example,
|
||||
@verbatim
|
||||
\verbatim
|
||||
program -listFiles \( *.txt \)
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
would create a stringList:
|
||||
@verbatim
|
||||
\verbatim
|
||||
( "file1.txt" "file2.txt" ... "fileN.txt" )
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
The backslash-escaping is required to avoid interpretation by the shell.
|
||||
|
||||
@par Default command-line options
|
||||
@param -case \<dir\> \n
|
||||
\par Default command-line options
|
||||
\param -case \<dir\> \n
|
||||
select an case directory instead of the current working directory
|
||||
@param -parallel \n
|
||||
\param -parallel \n
|
||||
specify case as a parallel job
|
||||
@param -doc \n
|
||||
\param -doc \n
|
||||
display the documentation in browser
|
||||
@param -srcDoc \n
|
||||
\param -srcDoc \n
|
||||
display the source documentation in browser
|
||||
@param -help \n
|
||||
\param -help \n
|
||||
print the usage
|
||||
|
||||
The environment variable @b FOAM_CASE is set to the path of the
|
||||
The environment variable \b FOAM_CASE is set to the path of the
|
||||
global case (same for serial and parallel jobs).
|
||||
The environment variable @b FOAM_CASENAME is set to the name of the
|
||||
The environment variable \b FOAM_CASENAME is set to the name of the
|
||||
global case.
|
||||
|
||||
Note
|
||||
- The document browser used is defined by the @b FOAM_DOC_BROWSER
|
||||
- The document browser used is defined by the \b FOAM_DOC_BROWSER
|
||||
environment variable or the <tt>Documentation/docBrowser</tt> entry
|
||||
in the <tt>~OpenFOAM/controlDict</tt> file.
|
||||
The \%f token is used as a placeholder for the file name.
|
||||
@ -168,14 +168,14 @@ public:
|
||||
//- Max screen width for displaying usage (default: 80)
|
||||
static string::size_type usageMax;
|
||||
|
||||
//! @cond internalClass
|
||||
//! \cond internalClass
|
||||
class initValidTables
|
||||
{
|
||||
public:
|
||||
|
||||
initValidTables();
|
||||
};
|
||||
//! @endcond
|
||||
//! \endcond
|
||||
|
||||
|
||||
// Constructors
|
||||
@ -230,7 +230,7 @@ public:
|
||||
inline T argRead(const label index) const;
|
||||
|
||||
//- Return arguments that are additional to the executable
|
||||
// @deprecated use operator[] directly (deprecated Feb 2010)
|
||||
// \deprecated use operator[] directly (deprecated Feb 2010)
|
||||
stringList::subList additionalArgs() const
|
||||
{
|
||||
return stringList::subList(args_, args_.size()-1, 1);
|
||||
@ -292,7 +292,7 @@ public:
|
||||
inline const string& operator[](const label index) const;
|
||||
|
||||
//- Return the argument string associated with the named option
|
||||
// @sa option()
|
||||
// \sa option()
|
||||
inline const string& operator[](const word& opt) const;
|
||||
|
||||
// Edit
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -38,7 +38,7 @@ namespace Foam
|
||||
namespace debug
|
||||
{
|
||||
|
||||
//! @cond ignoreDocumentation - local scope
|
||||
//! \cond ignoreDocumentation - local scope
|
||||
dictionary* controlDictPtr_(NULL);
|
||||
dictionary* debugSwitchesPtr_(NULL);
|
||||
dictionary* infoSwitchesPtr_(NULL);
|
||||
@ -63,7 +63,7 @@ public:
|
||||
};
|
||||
|
||||
deleteControlDictPtr deleteControlDictPtr_;
|
||||
//! @endcond
|
||||
//! \endcond
|
||||
|
||||
|
||||
} // End namespace debug
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -49,7 +49,7 @@ namespace debug
|
||||
{
|
||||
//- The central control dictionary.
|
||||
// Located in ~/.OpenFOAM/VERSION or $WM_PROJECT_DIR/etc
|
||||
// @sa Foam::findEtcFile()
|
||||
// \sa Foam::findEtcFile()
|
||||
dictionary& controlDict();
|
||||
|
||||
//- The DebugSwitches sub-dictionary in the central controlDict.
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -25,7 +25,7 @@ Class
|
||||
Foam::xmgrGraph
|
||||
|
||||
Description
|
||||
Output and @b agr file for @em xmgrace
|
||||
Output and \b agr file for \em xmgrace
|
||||
(http://plasma-gate.weizmann.ac.il/Grace/)
|
||||
|
||||
SourceFiles
|
||||
|
||||
@ -90,7 +90,7 @@ fileName cwd();
|
||||
// else return false
|
||||
bool chDir(const fileName& dir);
|
||||
|
||||
//- Search for @em name
|
||||
//- Search for \em name
|
||||
// in the following hierarchy:
|
||||
// -# personal settings:
|
||||
// - ~/.OpenFOAM/\<VERSION\>/
|
||||
@ -105,7 +105,7 @@ bool chDir(const fileName& dir);
|
||||
// -# shipped settings:
|
||||
// - $WM_PROJECT_DIR/etc/
|
||||
//
|
||||
// @return the full path name or fileName() if the name cannot be found
|
||||
// \return the full path name or fileName() if the name cannot be found
|
||||
// Optionally abort if the file cannot be found
|
||||
fileName findEtcFile(const fileName&, bool mandatory=false);
|
||||
|
||||
|
||||
@ -29,9 +29,9 @@ Description
|
||||
The reference scalar values must be monotonically increasing.
|
||||
|
||||
The handling of out-of-bounds values depends on the current setting
|
||||
of @a outOfBounds.
|
||||
of \a outOfBounds.
|
||||
|
||||
If @a REPEAT is chosen for the out-of-bounds handling, the final time
|
||||
If \a REPEAT is chosen for the out-of-bounds handling, the final time
|
||||
value is treated as being equivalent to time=0 for the following periods.
|
||||
|
||||
Note
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2009-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2009-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -30,7 +30,7 @@ Description
|
||||
|
||||
Example usage (scalar): values specified within a dictionary:
|
||||
|
||||
@verbatim
|
||||
\verbatim
|
||||
{
|
||||
x0 0; // lower limit
|
||||
dx 0.2; // fixed interval
|
||||
@ -43,7 +43,7 @@ Description
|
||||
7870 // value at x0 + n*dx
|
||||
);
|
||||
}
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
SourceFiles
|
||||
uniformInterpolationTable.C
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -38,7 +38,7 @@ Description
|
||||
the same point. The neighbour labels are also ordered in ascending
|
||||
order but only for groups of edges belonging to each point. An example
|
||||
is given below:
|
||||
@verbatim
|
||||
\verbatim
|
||||
owner eighbour
|
||||
0 1
|
||||
0 20
|
||||
@ -60,7 +60,7 @@ Description
|
||||
8 28
|
||||
9 10
|
||||
9 29
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
There exists an alternative way of addressing the owner
|
||||
list: instead of repeating the same label in the owner list, it is
|
||||
@ -68,9 +68,9 @@ Description
|
||||
neighbour list. This reduces the size of owner addressing from a list
|
||||
over all edges to a list over all points + 1:
|
||||
|
||||
@verbatim
|
||||
\verbatim
|
||||
Owner start list: 0 2 4 6 8 10 12 14 16 18
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
We shall use the second form of the addressing for fast lookup
|
||||
of edge label from the known owner and neighbour, using the following
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -36,12 +36,12 @@ License
|
||||
int Foam::solution::debug(::Foam::debug::debugSwitch("solution", 0));
|
||||
|
||||
// List of sub-dictionaries to rewrite
|
||||
//! @cond localScope
|
||||
//! \cond localScope
|
||||
static const Foam::List<Foam::word> subDictNames
|
||||
(
|
||||
Foam::IStringStream("(preconditioner smoother)")()
|
||||
);
|
||||
//! @endcond
|
||||
//! \endcond
|
||||
|
||||
|
||||
// * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * //
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -43,21 +43,21 @@ Description
|
||||
memory becoming inaccessible, the xferMoveTo() function should be used to
|
||||
invoke the correct List\<T\>::transfer(DynamicList\<T\>&) method.
|
||||
|
||||
@code
|
||||
\code
|
||||
DynamicList<label> dynLst;
|
||||
...
|
||||
labelList plainLst( xferMoveTo<labelList>(dynLst) );
|
||||
@endcode
|
||||
\endcode
|
||||
|
||||
Of course, since this example is a very common operation, the
|
||||
DynamicList::xfer() method transfers to a plain List anyhow.
|
||||
It would thus be simpler (and clearer) just to use the following code:
|
||||
|
||||
@code
|
||||
\code
|
||||
DynamicList<label> dynLst;
|
||||
...
|
||||
labelList plainLst(dynLst.xfer());
|
||||
@endcode
|
||||
\endcode
|
||||
|
||||
SeeAlso
|
||||
xferCopy, xferCopyTo, xferMove, xferMoveTo, xferTmp
|
||||
@ -135,53 +135,53 @@ public:
|
||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||
|
||||
/**
|
||||
* Construct by copying the contents of the @a arg
|
||||
* Construct by copying the contents of the \a arg
|
||||
*
|
||||
* @sa xferCopyTo, xferMove, xferMoveTo, xferTmp and Foam::Xfer
|
||||
* \sa xferCopyTo, xferMove, xferMoveTo, xferTmp and Foam::Xfer
|
||||
*/
|
||||
template<class T>
|
||||
inline Xfer<T> xferCopy(const T&);
|
||||
|
||||
/**
|
||||
* Construct by transferring the contents of the @a arg
|
||||
* Construct by transferring the contents of the \a arg
|
||||
*
|
||||
* @sa xferCopy, xferCopyTo, xferMoveTo, xferTmp and Foam::Xfer
|
||||
* \sa xferCopy, xferCopyTo, xferMoveTo, xferTmp and Foam::Xfer
|
||||
*/
|
||||
template<class T>
|
||||
inline Xfer<T> xferMove(T&);
|
||||
|
||||
|
||||
/**
|
||||
* Construct by transferring the contents of the @a arg
|
||||
* Construct by transferring the contents of the \a arg
|
||||
*
|
||||
* @sa xferCopy, xferCopyTo, xferMove, xferMoveTo and Foam::Xfer
|
||||
* \sa xferCopy, xferCopyTo, xferMove, xferMoveTo and Foam::Xfer
|
||||
*/
|
||||
template<class T>
|
||||
inline Xfer<T> xferTmp(Foam::tmp<T>&);
|
||||
|
||||
|
||||
/**
|
||||
* Construct by copying the contents of the @a arg
|
||||
* Construct by copying the contents of the \a arg
|
||||
* between dissimilar types
|
||||
*
|
||||
* @sa xferCopy, xferMove, xferMoveTo, xferTmp and Foam::Xfer
|
||||
* \sa xferCopy, xferMove, xferMoveTo, xferTmp and Foam::Xfer
|
||||
*/
|
||||
template<class To, class From>
|
||||
inline Xfer<To> xferCopyTo(const From&);
|
||||
|
||||
|
||||
/**
|
||||
* Construct by transferring the contents of the @a arg
|
||||
* Construct by transferring the contents of the \a arg
|
||||
* between dissimilar types
|
||||
*
|
||||
* @par Example Use
|
||||
* @code
|
||||
* \par Example Use
|
||||
* \code
|
||||
* DynamicList<label> dynLst;
|
||||
* ...
|
||||
* labelList plainLst( xferMoveTo<labelList>(dynLst) );
|
||||
* @endcode
|
||||
* \endcode
|
||||
*
|
||||
* @sa xferCopy, xferCopyTo, xferMove, xferTmp and Foam::Xfer
|
||||
* \sa xferCopy, xferCopyTo, xferMove, xferTmp and Foam::Xfer
|
||||
*/
|
||||
template<class To, class From>
|
||||
inline Xfer<To> xferMoveTo(From&);
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -31,22 +31,22 @@ Description
|
||||
cell-face to mesh-face mapping.
|
||||
|
||||
For example,
|
||||
@verbatim
|
||||
\verbatim
|
||||
hexMatcher hex(mesh);
|
||||
cellShape shape;
|
||||
..
|
||||
bool isHex = hex.match(cellI, shape);
|
||||
@endverbatim
|
||||
Now shape is set to the correct Hex cellShape (if @a isHex is true)
|
||||
\endverbatim
|
||||
Now shape is set to the correct Hex cellShape (if \a isHex is true)
|
||||
|
||||
Alternatively there is direct access to the vertex and face mapping:
|
||||
@verbatim
|
||||
\verbatim
|
||||
const labelList& hexVertLabels = hex.vertLabels();
|
||||
const labelList& hexFaceLabels = hex.faceLabels();
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
Now
|
||||
- @c hexVertLabels[n] is vertex label of hex vertex n
|
||||
- @c hexFaceLabels[n] is face label of hex vertex n
|
||||
- \c hexVertLabels[n] is vertex label of hex vertex n
|
||||
- \c hexFaceLabels[n] is face label of hex vertex n
|
||||
|
||||
Process of cellShape recognition consists of following steps:
|
||||
- renumber vertices of cell to local vertex numbers
|
||||
|
||||
@ -41,9 +41,9 @@ Description
|
||||
Works by constructing equivalence lists for all the points on processor
|
||||
patches. These list are in globalIndexAndTransform numbering
|
||||
E.g.
|
||||
@verbatim
|
||||
\verbatim
|
||||
((7 93)(4 731)(3 114))
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
means point 93 on proc7 is connected to point 731 on proc4 and 114 on proc3.
|
||||
It then assigns the lowest numbered processor to be the local 'master' and
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -49,7 +49,7 @@ Description
|
||||
|
||||
All this information is nessecary to correctly map fields.
|
||||
|
||||
@par points
|
||||
\par points
|
||||
|
||||
- unchanged:
|
||||
- pointMap[pointI] contains old point label
|
||||
@ -66,7 +66,7 @@ Description
|
||||
- appended:
|
||||
- pointMap[pointI] contains -1
|
||||
|
||||
@par faces
|
||||
\par faces
|
||||
|
||||
- unchanged:
|
||||
- faceMap[faceI] contains old face label
|
||||
@ -98,7 +98,7 @@ Description
|
||||
only be boundary faces; if the new face is an internal face they
|
||||
will only be internal faces.
|
||||
|
||||
@par cells
|
||||
\par cells
|
||||
|
||||
- unchanged:
|
||||
- cellMap[cellI] contains old cell label
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -115,9 +115,9 @@ public:
|
||||
|
||||
//- Determine the mapping for a sub-patch.
|
||||
// Only include faces for which bool-list entry is true.
|
||||
// @param[in] includeFaces faces to include
|
||||
// @param[out] pointMap mapping new to old localPoints
|
||||
// @param[out] faceMap mapping new to old faces
|
||||
// \param[in] includeFaces faces to include
|
||||
// \param[out] pointMap mapping new to old localPoints
|
||||
// \param[out] faceMap mapping new to old faces
|
||||
template
|
||||
<
|
||||
class BoolListType,
|
||||
|
||||
@ -28,9 +28,9 @@ Description
|
||||
Templated basic entry that holds a constant value.
|
||||
|
||||
Usage - for entry \<entryName\> having the value <value>:
|
||||
@verbatim
|
||||
\verbatim
|
||||
<entryName> constant <value>
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
SourceFiles
|
||||
Constant.C
|
||||
|
||||
@ -29,13 +29,13 @@ Description
|
||||
Tuple2's. First column is always stored as scalar entries. Data is read
|
||||
in the form, e.g. for an entry \<entryName\> that is (scalar, vector):
|
||||
|
||||
@verbatim
|
||||
\verbatim
|
||||
<entryName> table
|
||||
(
|
||||
0.0 (1 2 3)
|
||||
1.0 (4 5 6)
|
||||
);
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
SourceFiles
|
||||
Table.C
|
||||
|
||||
@ -29,13 +29,13 @@ Description
|
||||
Tuple2's. Data is input in the form, e.g. for an entry \<entryName\> that
|
||||
describes y = x^2 + 2x^3
|
||||
|
||||
@verbatim
|
||||
\verbatim
|
||||
<entryName> polynomial
|
||||
(
|
||||
(1 2)
|
||||
(2 3)
|
||||
);
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
SourceFiles
|
||||
polynomial.C
|
||||
|
||||
@ -54,9 +54,9 @@ namespace Foam
|
||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||
|
||||
//- Bob Jenkins's 96-bit mixer hashing function (lookup3)
|
||||
// @param[in] data - a character stream
|
||||
// @param[in] len - the number of bytes
|
||||
// @param[in] seed - the previous hash, or an arbitrary value
|
||||
// \param[in] data - a character stream
|
||||
// \param[in] len - the number of bytes
|
||||
// \param[in] seed - the previous hash, or an arbitrary value
|
||||
unsigned Hasher(const void* data, size_t len, unsigned seed = 0);
|
||||
|
||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||
|
||||
@ -48,17 +48,17 @@ namespace Foam
|
||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||
|
||||
//- An optimized version of Hasher
|
||||
// @param[in] data - an array of uint32_t values
|
||||
// @param[in] length - the number of values (not bytes)
|
||||
// @param[in] seed - the previous hash, or an arbitrary value
|
||||
// \param[in] data - an array of uint32_t values
|
||||
// \param[in] length - the number of values (not bytes)
|
||||
// \param[in] seed - the previous hash, or an arbitrary value
|
||||
unsigned HasherInt(const uint32_t* data, size_t length, unsigned seed = 0);
|
||||
|
||||
//- An optimized version of Hasher, returning dual hash values
|
||||
// @param[in] data - an array of uint32_t values
|
||||
// @param[in] length - the number of values (not bytes)
|
||||
// @param[in] hash1 - the previous hash, or an arbitrary value
|
||||
// \param[in] data - an array of uint32_t values
|
||||
// \param[in] length - the number of values (not bytes)
|
||||
// \param[in] hash1 - the previous hash, or an arbitrary value
|
||||
// on output, the primary hash value
|
||||
// @param[in] hash1 - the previous hash, or an arbitrary value
|
||||
// \param[in] hash1 - the previous hash, or an arbitrary value
|
||||
// on output, the secondary hash value
|
||||
unsigned HasherDual
|
||||
(
|
||||
|
||||
@ -45,11 +45,11 @@ Description
|
||||
|
||||
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
|
||||
|
||||
//! @cond fileScope
|
||||
//! \cond fileScope
|
||||
// The bytes used to pad buffer to the next 64-byte boundary.
|
||||
// (RFC 1321, 3.1: Step 1)
|
||||
static const unsigned char fillbuf[64] = { 0x80, 0 /* , 0, 0, ... */ };
|
||||
//! @endcond
|
||||
//! \endcond
|
||||
|
||||
|
||||
// * * * * * * * * * * * * Static Member Functions * * * * * * * * * * * * * //
|
||||
|
||||
@ -30,9 +30,9 @@ License
|
||||
|
||||
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
|
||||
|
||||
//! @cond fileScope
|
||||
//! \cond fileScope
|
||||
static const char hexChars[] = "0123456789abcdef";
|
||||
//! @endcond
|
||||
//! \endcond
|
||||
|
||||
|
||||
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -180,7 +180,7 @@ public:
|
||||
// - leading "~user" : home directory for specified user
|
||||
// - leading "~OpenFOAM" : site/user OpenFOAM configuration directory
|
||||
//
|
||||
// @sa
|
||||
// \sa
|
||||
// Foam::findEtcFile
|
||||
string& expand(const bool recurse=false);
|
||||
|
||||
@ -199,14 +199,14 @@ public:
|
||||
|
||||
// Member Operators
|
||||
|
||||
//- Return the sub-string from the i-th character for @a n characters
|
||||
//- Return the sub-string from the i-th character for \a n characters
|
||||
inline string operator()
|
||||
(
|
||||
const size_type i,
|
||||
const size_type n
|
||||
) const;
|
||||
|
||||
//- Return the sub-string from the first character for @a n characters
|
||||
//- Return the sub-string from the first character for \a n characters
|
||||
inline string operator()
|
||||
(
|
||||
const size_type n
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -46,9 +46,9 @@ namespace Foam
|
||||
// Largest message sent so far. This tracks the size of the receive
|
||||
// buffer on the receiving end. Done so we only send out resize messages
|
||||
// if necessary
|
||||
//! @cond fileScope
|
||||
//! \cond fileScope
|
||||
labelList maxSendSize;
|
||||
//! @endcond
|
||||
//! \endcond
|
||||
|
||||
|
||||
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -33,9 +33,9 @@ namespace Foam
|
||||
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
|
||||
|
||||
// Outstanding non-blocking operations.
|
||||
//! @cond fileScope
|
||||
//! \cond fileScope
|
||||
DynamicList<MPI_Request> PstreamGlobals::outstandingRequests_;
|
||||
//! @endcond
|
||||
//! \endcond
|
||||
|
||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||
|
||||
|
||||
@ -206,7 +206,7 @@ public:
|
||||
};
|
||||
|
||||
//- Reconstruct part characteristics on freestore from Istream
|
||||
// @sa reconstruct
|
||||
// \sa reconstruct
|
||||
static autoPtr<ensightPart> New(Istream&);
|
||||
|
||||
|
||||
|
||||
@ -138,7 +138,7 @@ public:
|
||||
//- Reconstruct part characteristics (eg, element types) from Istream
|
||||
// A part reconstructed in this manner can be used when writing fields,
|
||||
// but cannot be used to write a new geometry
|
||||
// @sa Foam::ensightPart::reconstruct
|
||||
// \sa Foam::ensightPart::reconstruct
|
||||
ensightPartCells(Istream&);
|
||||
|
||||
//- Reconstruct part characteristics on freestore from Istream
|
||||
|
||||
@ -144,7 +144,7 @@ public:
|
||||
//- Reconstruct part characteristics (eg, element types) from Istream
|
||||
// A part reconstructed in this manner can be used when writing fields,
|
||||
// but cannot be used to write a new geometry
|
||||
// @sa Foam::ensightPart::reconstruct
|
||||
// \sa Foam::ensightPart::reconstruct
|
||||
ensightPartFaces(Istream&);
|
||||
|
||||
//- Reconstruct part characteristics on freestore from Istream
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -29,11 +29,11 @@ Description
|
||||
|
||||
The meshReader supports boundaryRegion information.
|
||||
|
||||
The <tt>constant/boundaryRegion</tt> file is an @c IOMap<dictionary>
|
||||
The <tt>constant/boundaryRegion</tt> file is an \c IOMap<dictionary>
|
||||
that is used to save the information persistently.
|
||||
It contains the boundaryRegion information of the following form:
|
||||
|
||||
@verbatim
|
||||
\verbatim
|
||||
(
|
||||
INT
|
||||
{
|
||||
@ -42,7 +42,7 @@ Description
|
||||
}
|
||||
...
|
||||
)
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
SourceFiles
|
||||
boundaryRegion.C
|
||||
@ -149,9 +149,9 @@ public:
|
||||
|
||||
//- Rename regions
|
||||
// each dictionary entry is a single word:
|
||||
// @verbatim
|
||||
// \verbatim
|
||||
// newPatchName originalName;
|
||||
// @endverbatim
|
||||
// \endverbatim
|
||||
void rename(const dictionary&);
|
||||
};
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -29,11 +29,11 @@ Description
|
||||
|
||||
The meshReader supports cellTable information.
|
||||
|
||||
The <tt>constant/cellTable</tt> file is an @c IOMap<dictionary> that is
|
||||
The <tt>constant/cellTable</tt> file is an \c IOMap<dictionary> that is
|
||||
used to save the information persistently. It contains the cellTable
|
||||
information of the following form:
|
||||
|
||||
@verbatim
|
||||
\verbatim
|
||||
(
|
||||
ID
|
||||
{
|
||||
@ -46,10 +46,10 @@ Description
|
||||
}
|
||||
...
|
||||
)
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
If the @a Label is missing, a value <tt>cellTable_{ID}</tt> will be
|
||||
inferred. If the @a MaterialType is missing, the value @a fluid will
|
||||
If the \a Label is missing, a value <tt>cellTable_{ID}</tt> will be
|
||||
inferred. If the \a MaterialType is missing, the value @a fluid will
|
||||
be inferred.
|
||||
|
||||
SourceFiles
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -39,7 +39,7 @@ Description
|
||||
|
||||
"constant/boundaryRegion" is an IOMap<dictionary> that contains
|
||||
the boundary type and names. eg,
|
||||
@verbatim
|
||||
\verbatim
|
||||
(
|
||||
0
|
||||
{
|
||||
@ -61,7 +61,7 @@ Description
|
||||
Label outlet;
|
||||
}
|
||||
)
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
|
||||
SourceFiles
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -44,7 +44,7 @@ Description
|
||||
|
||||
-# Start:
|
||||
cell with anchor points at bottom
|
||||
@verbatim
|
||||
\verbatim
|
||||
+-------+
|
||||
| +
|
||||
| +
|
||||
@ -55,13 +55,13 @@ Description
|
||||
| +
|
||||
+-------+
|
||||
anchor anchor
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
|
||||
-# Topo change:
|
||||
splitface introduced at bottom of cell, introducing a new
|
||||
cell and splitting the side faces into two.
|
||||
@verbatim
|
||||
\verbatim
|
||||
+-------+
|
||||
| +
|
||||
| +
|
||||
@ -72,12 +72,12 @@ Description
|
||||
+-------+ <- splitFace
|
||||
+-------+ <- original cell
|
||||
anchor anchor
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
|
||||
-# Inflation:
|
||||
splitface shifted up to middle of cell (or wherever cut was)
|
||||
@verbatim
|
||||
\verbatim
|
||||
+-------+
|
||||
| +
|
||||
| + <- addedCell
|
||||
@ -88,7 +88,7 @@ Description
|
||||
| +
|
||||
+-------+
|
||||
anchor anchor
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
Anyway this was the original idea. Inflation was meant to handle
|
||||
conservative properties distribution without interpolation.
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -33,7 +33,7 @@ Description
|
||||
scale back displacement.
|
||||
|
||||
E.g.
|
||||
@verbatim
|
||||
\verbatim
|
||||
// Construct iterative mesh mover.
|
||||
motionSmoother meshMover(mesh, labelList(1, patchI));
|
||||
|
||||
@ -48,7 +48,7 @@ Description
|
||||
return true;
|
||||
}
|
||||
}
|
||||
@endverbatim
|
||||
\endverbatim
|
||||
|
||||
Note
|
||||
- Shared points (parallel): a processor can have points which are part of
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user