zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Doxygen : fixed rogue classes, simplified INPUT

Browse Source
This commit is contained in:
Mark Olesen
2008-06-06 10:17:32 +02:00
parent aa68159ae4
commit b2fd02df8d
46 changed files with 118 additions and 145 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
doc/Doxygen/Doxyfile
View File

@ -477,40 +477,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
INPUT = $(WM_PROJECT_DIR)/src/OpenFOAM \
$(WM_PROJECT_DIR)/src/Pstream \
$(WM_PROJECT_DIR)/src/finiteVolume \
$(WM_PROJECT_DIR)/src/transportModels/incompressible \
$(WM_PROJECT_DIR)/src/transportModels/interfaceProperties \
$(WM_PROJECT_DIR)/src/thermophysicalModels/thermophysicalFunctions \
$(WM_PROJECT_DIR)/src/thermophysicalModels/specie \
$(WM_PROJECT_DIR)/src/thermophysicalModels/liquids \
$(WM_PROJECT_DIR)/src/thermophysicalModels/liquidMixture \
$(WM_PROJECT_DIR)/src/thermophysicalModels/basic \
$(WM_PROJECT_DIR)/src/thermophysicalModels/combustion \
$(WM_PROJECT_DIR)/src/thermophysicalModels/pdfs \
$(WM_PROJECT_DIR)/src/thermophysicalModels/chemistryModel \
$(WM_PROJECT_DIR)/src/thermophysicalModels/laminarFlameSpeed \
$(WM_PROJECT_DIR)/src/turbulenceModels/incompressible \
$(WM_PROJECT_DIR)/src/turbulenceModels/compressible \
$(WM_PROJECT_DIR)/src/LESmodels/LESfilters \
$(WM_PROJECT_DIR)/src/LESmodels/incompressible \
$(WM_PROJECT_DIR)/src/LESmodels/compressible \
$(WM_PROJECT_DIR)/src/errorEstimation \
$(WM_PROJECT_DIR)/src/dynamicMesh \
$(WM_PROJECT_DIR)/src/triSurface \
$(WM_PROJECT_DIR)/src/edgeMesh \
$(WM_PROJECT_DIR)/src/lagrangian/basic \
$(WM_PROJECT_DIR)/src/lagrangian/solidParticle \
$(WM_PROJECT_DIR)/src/lagrangian/dieselSpray \
$(WM_PROJECT_DIR)/src/engine \
$(WM_PROJECT_DIR)/src/ODE \
$(WM_PROJECT_DIR)/src/randomProcesses \
$(WM_PROJECT_DIR)/src/sampling \
$(WM_PROJECT_DIR)/src/meshTools \
$(WM_PROJECT_DIR)/src/dynamicFvMesh \
$(WM_PROJECT_DIR)/src/topoChangerFvMesh \
$(WM_PROJECT_DIR)/src/fvMotionSolver \
INPUT = $(WM_PROJECT_DIR)/src \
$(WM_PROJECT_DIR)/applications/utilities \
$(WM_PROJECT_DIR)/applications/solvers

5
src/OpenFOAM/containers/HashTables/HashSet/HashSet.H
View File

@ -28,6 +28,11 @@ Class
Description
A HashTable with word keys but without contents.
Class
Foam::wordHashSet
Description
A HashSet with (the default) word keys.
\*---------------------------------------------------------------------------*/
#ifndef HashSet_H

2
src/OpenFOAM/global/foamVersion.H
View File

@ -30,7 +30,7 @@ Description
Global
foamVersion
Foam::FOAMversion
Description
OpenFOAM version number static string.

7
src/OpenFOAM/meshes/polyMesh/polyPatches/basic/coupled/coupledPolyPatch.H
View File

@ -23,11 +23,12 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
coupledPolyPatch
Foam::coupledPolyPatch
Description
coupledPolyPatch is an abstract base class for patches that couple regions
of the computational domain e.g. cyclic and processor-processor links.
The coupledPolyPatch is an abstract base class for patches that couple
regions of the computational domain e.g. cyclic and processor-processor
links.
SourceFiles
coupledPolyPatch.C

3
src/autoMesh/autoHexMesh/autoHexMeshDriver/autoHexMeshDriver.C
View File

@ -22,9 +22,6 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
autoHexMeshDriver
\*----------------------------------------------------------------------------*/
#include "autoHexMeshDriver.H"

10
src/autoMesh/autoHexMesh/autoHexMeshDriver/autoHexMeshDriver.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
autoHexMeshDriver
Foam::autoHexMeshDriver
Description
main meshing driver.
@ -85,9 +85,9 @@ class autoHexMeshDriver
//- Extrusion controls
enum extrudeMode
{
NOEXTRUDE, // Do not extrude. No layers added.
EXTRUDE, // Extrude
EXTRUDEREMOVE // Extrude but afterwards remove added faces locally
NOEXTRUDE, /*!< Do not extrude. No layers added. */
EXTRUDE, /*!< Extrude */
EXTRUDEREMOVE /*!< Extrude but afterwards remove added faces locally */
};
@ -107,7 +107,7 @@ class autoHexMeshDriver
}
};
// Combine operator class to combine normal with other normal.
//- Combine operator class to combine normal with other normal.
class nomalsCombine
{
public:

3
src/autoMesh/autoHexMesh/autoHexMeshDriver/pointData/pointData.H
View File

@ -23,11 +23,12 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
pointData
Foam::pointData
Description
Holds information regarding nearest wall point. Used in pointEdgeWave.
(so not standard meshWave)
To be used in wall distance calculation.
SourceFiles

3
src/autoMesh/autoHexMesh/meshRefinement/meshRefinement.C
View File

@ -22,9 +22,6 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
meshRefinement
\*----------------------------------------------------------------------------*/
#include "Pstream.H"

9
src/autoMesh/autoHexMesh/meshRefinement/meshRefinement.H
View File

@ -23,11 +23,12 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
meshRefinement
Foam::meshRefinement
Description
Helper class which maintains intersections of (changing) mesh with
(static) surfaces.
Maintains
- per face any intersections of this edge with any of the surfaces
@ -90,9 +91,9 @@ public:
//- Enumeration for how the userdata is to be mapped upon refinement.
enum mapType
{
MASTERONLY = 1, // maintain master only
KEEPALL = 2, // have slaves (upon refinement) from master
REMOVE = 4 // set value to -1 any face that has been refined
MASTERONLY = 1, /*!< maintain master only */
KEEPALL = 2, /*!< have slaves (upon refinement) from master */
REMOVE = 4 /*!< set value to -1 any face that has been refined */
};

3
src/autoMesh/autoHexMesh/meshRefinement/meshRefinementBaffles.C
View File

@ -22,9 +22,6 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
meshRefinement
\*----------------------------------------------------------------------------*/
#include "meshRefinement.H"

3
src/autoMesh/autoHexMesh/meshRefinement/meshRefinementMerge.C
View File

@ -22,9 +22,6 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
meshRefinement
\*----------------------------------------------------------------------------*/
#include "meshRefinement.H"

3
src/autoMesh/autoHexMesh/meshRefinement/meshRefinementRefine.C
View File

@ -22,9 +22,6 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
meshRefinement
\*----------------------------------------------------------------------------*/
#include "meshRefinement.H"

5
src/autoMesh/autoHexMesh/refinementSurfaces/refinementSurfaces.C
View File

@ -22,9 +22,6 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
refinementSurfaces
\*----------------------------------------------------------------------------*/
#include "refinementSurfaces.H"
@ -261,7 +258,7 @@ Foam::refinementSurfaces::refinementSurfaces
<< " which has regions " << regionNames
<< abort(FatalError);
}
label globalRegionI = regionOffset_[surfI] + regionI;
minLevel_[globalRegionI] = iter();

2
src/autoMesh/autoHexMesh/refinementSurfaces/refinementSurfaces.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
refinementSurfaces
Foam::refinementSurfaces
Description
Container for triSurfaces used for surface-driven refinement.

2
src/autoMesh/autoHexMesh/trackedParticle/ExactParticle.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
ExactParticle
Foam::ExactParticle
Description
Special version of Particle to do tracking on non-convex cells.

2
src/autoMesh/autoHexMesh/trackedParticle/trackedParticle.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
trackedParticle
Foam::trackedParticle
Description
Particle class that marks cells it passes through. Used to mark cells

7
src/dynamicFvMesh/dynamicRefineFvMesh/dynamicRefineFvMesh.H
View File

@ -23,11 +23,12 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
dynamicRefineFvMesh
Foam::dynamicRefineFvMesh
Description
fvMesh with built-in refinement. Determines which cells to refine/unrefine
and does all in update().
A fvMesh with built-in refinement.
Determines which cells to refine/unrefine and does all in update().
SourceFiles
dynamicRefineFvMesh.C

52
src/dynamicMesh/polyTopoChange/polyTopoChange/addPatchCellLayer.H
View File

@ -23,27 +23,29 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
addPatchCellLayer
Foam::addPatchCellLayer
Description
Adds layers of cells to outside of polyPatch. Call setRefinement with
offset vector for every patch point and number of layers per patch face
and number of layers per patch point.
Adds layers of cells to outside of polyPatch.
Call setRefinement with offset vector for every patch point and number
of layers per patch face and number of layers per patch point.
- offset vector should be zero for any non-manifold point and synchronised
on coupled points before calling this.
on coupled points before calling this.
- offset vector of zero will not add any points.
- gets supplied the number of extruded layers both per face and per
point. Usually the point nlayers is the max of surrounding face nlayers.
point nlayers:
0 : no extrusion. Any surrounding face being extruded becomes 'prism'
>0 : should be max of surrounding face nlayers.
point nlayers:
- 0 : no extrusion. Any surrounding face being extruded becomes 'prism'
- >0 : should be max of surrounding face nlayers.
- differing face nlayers: 'termination' : (e.g. from 2 to 4 layers) match
at original patch face side.
E.g. 2 boundary faces on patches a,b. 2 layers for a, 3 for b.
@verbatim
Was:
a b <- patch of boundary face
@ -51,7 +53,6 @@ Description
| | | <- original cells
+------+------+
Becomes:
a b <- patch of boundary face
@ -61,6 +62,7 @@ Description
+------+------+
| | | <- original cells
+------+------+
@endverbatim
- added faces get same patchID as face they are extruded from
@ -70,24 +72,26 @@ Description
E.g. 3 boundary faces on patches a,b. b gets extruded, a doesn't.
a b b <- patch of boundary face
+------+------+------+
| | | | <- cells
+------+------+------+
@verbatim
a b b <- patch of boundary face
+------+------+------+
| | | | <- cells
+------+------+------+
^ ^ <- wanted extrusion vector (none at far right)
a | b | b <- patch of boundary face
+------+------+------+
| | | | <- cells
+------+------+------+
^ ^ <- wanted extrusion vector (none at far right)
a | b | b <- patch of boundary face
+------+------+------+
| | | | <- cells
+------+------+------+
b
+------+\ b 1. prism cell added onto second b face since
a a| | ----\ only one side gets extruded.
+------+------+------+ 2. side-face gets patch a, not b.
| | | |
+------+------+------+
b
+------+\ b 1. prism cell added onto second b face since
a a| | ----\ only one side gets extruded.
+------+------+------+ 2. side-face gets patch a, not b.
| | | |
+------+------+------+
@endverbatim
SourceFiles

2
src/dynamicMesh/polyTopoChange/polyTopoChange/combineFaces.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
combineFaces
Foam::combineFaces
Description
Combines boundary faces into single face. The faces get the patch

2
src/finiteVolume/finiteVolume/fvc/fvc.H
View File

@ -22,7 +22,7 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
InNamespace
Namespace
Foam::fvc
Description

4
src/finiteVolume/finiteVolume/fvm/fvm.H
View File

@ -27,7 +27,9 @@ Namespace
Description
Namespace of functions to calculate implicit derivatives returning a
matrix. Time derivatives are calculated using Euler-implicit, backward
matrix.
Temporal derivatives are calculated using Euler-implicit, backward
differencing or Crank-Nicholson. Spatial derivatives are calculated
using Gauss' Theorem.

14
src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/LimitedScheme/LimitFuncs.C
View File

@ -22,20 +22,6 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Description
Class to create the weighting-factors based on the NVD
(Normalised Variable Diagram).
The particular differencing scheme class is supplied as a template argument,
the weight function of which is called by the weight function of this class
for the internal faces as well as faces of coupled patches
(e.g. processor-processor patches). The weight function is supplied the
central-differencing weighting factor, the face-flux, the cell and face
gradients (from which the normalised variable distribution may be created)
and the cell centre distance.
This code organisation is both neat and efficient, allowing for convenient
implementation of new schemes to run on parallelised cases.
\*---------------------------------------------------------------------------*/
#include "volFields.H"

9
src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/LimitedScheme/LimitFuncs.H
View File

@ -22,12 +22,19 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Namespace
Foam::limitFuncs
Description
Namespace for limiting functions
Class
Foam::limitFuncs::LimitFuncs
Description
Class to create NVD/TVD limited weighting-factors.
The particular differencing scheme class is supplied as a template
argument, the weight function of which is called by the weight function
of this class for the internal faces as well as faces of coupled

2
src/lagrangian/intermediate/clouds/Templates/ReactingCloud/ReactingCloudThermoTypes.H
View File

@ -22,7 +22,7 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Typedefs
Foam::cloudThermoTypes
Description

2
src/lagrangian/intermediate/submodels/addOns/radiation/absorptionEmission/cloudAbsorptionEmission/cloudAbsorptionEmission.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::cloudAbsorptionEmission
Foam::radiation::cloudAbsorptionEmission
Description
Retrieves absorption/emission data from a cloud object

2
src/lagrangian/intermediate/submodels/addOns/radiation/scatter/cloudScatter/cloudScatter.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::scatterModel
Foam::radiation::cloudScatter
Description
Cloud radiation scatter model

3
src/lagrangian/molecule/molecule/molecule.H
View File

@ -23,9 +23,10 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
molecule
Foam::molecule
Description
Foam::molecule
SourceFiles
moleculeI.H

2
src/meshTools/triSurface/searchableSurface/triSurfaceMesh.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
triSurfaceMesh
Foam::triSurfaceMesh
Description
IOoject and searching on triSurface

7
src/postProcessing/foamCalcFunctions/calcType/calcType.H
View File

@ -22,6 +22,13 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Namespace
Foam::calcTypes
Description
Namespace for post-processing calculation functions
Class
Foam::calcType

2
src/postProcessing/foamCalcFunctions/field/components/components.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::components
Foam::calcTypes::components
Description
Writes scalar fields corresponding to each component of the supplied

2
src/postProcessing/foamCalcFunctions/field/div/div.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::div
Foam::calcTypes::div
Description
Writes scalar fields corresponding to the divergence of the supplied

2
src/postProcessing/foamCalcFunctions/field/mag/mag.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::mag
Foam::calcTypes::mag
Description
Calculates and writes the magnitude of a field for each time

2
src/postProcessing/foamCalcFunctions/field/magGrad/magGrad.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::magGrad
Foam::calcTypes::magGrad
Description
Writes scalar fields corresponding to the magnitude ot the gradient

2
src/postProcessing/foamCalcFunctions/field/magSqr/magSqr.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::magSqr
Foam::calcTypes::magSqr
Description
Calculates and writes the magnitude-sqaured of a field for each time

2
src/postProcessing/forces/forceCoeffs/forceCoeffs.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
forceCoeffs
Foam::forceCoeffs
Description
Derived from the forces function object, creates a specialisation to

5
src/postProcessing/forces/forces/forces.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
forces
Foam::forces
Description
Calculates the forces and moments by integrating the pressure and
@ -77,8 +77,7 @@ public:
// pressure/viscous forces Tuples.
typedef Tuple2<pressureViscous, pressureViscous> forcesMoments;
// Sum operation class used to accumulate the pressure and viscous
// forces and moments
//- Sum operation class to accumulate the pressure, viscous forces and moments
class sumOp
{
public:

4
src/sampling/sampledSurface/writers/dx/dxWriters.H
View File

@ -22,8 +22,8 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
dxWriters
InClass
Foam::dxWriters
Description

3
src/sampling/sampledSurface/writers/foamFile/foamFile.H
View File

@ -23,9 +23,10 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
foamFile
Foam::foamFile
Description
A surfaceWriter for foamFiles
SourceFiles
foamFile.C

4
src/sampling/sampledSurface/writers/foamFile/foamFileWriters.H
View File

@ -22,8 +22,8 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
foamFileWriters
InClass
Foam::foamFileWriters
Description

4
src/sampling/sampledSurface/writers/null/nullWriters.H
View File

@ -22,8 +22,8 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
nullWriters
InClass
Foam::nullWriters
Description

4
src/sampling/sampledSurface/writers/raw/rawSurfaceWriters.H
View File

@ -22,8 +22,8 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
rawSurfaceWriters
InClass
Foam::rawSurfaceWriters
Description

4
src/sampling/sampledSurface/writers/stl/stlWriters.H
View File

@ -22,8 +22,8 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
stlWriters
InClass
Foam::stlWriters
Description

4
src/sampling/sampledSurface/writers/surfaceWriters.H
View File

@ -22,8 +22,8 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
surfaceWriter
InClass
Foam::surfaceWriters
Description

4
src/sampling/sampledSurface/writers/vtk/vtkWriters.H
View File

@ -22,8 +22,8 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
vtkWriters
InClass
Foam::vtkWriters
Description

8
src/thermophysicalModels/barotropicCompressibilityModel/barotropicCompressibilityModel/barotropicCompressibilityModel.H
View File

@ -22,10 +22,18 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Namespace
Foam::compressibilityModels
Description
Namespace for compressibility models.
Class
Foam::barotropicCompressibilityModel
Description
Abstract class for barotropic compressibility models
SourceFiles
barotropicCompressibilityModel.C

2
src/triSurface/triSurfaceFields/triSurfaceFields.H
View File

@ -22,7 +22,7 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
InClass
Foam::triSurfaceFields
Description