Commit b2fd02df authored by Mark Olesen's avatar Mark Olesen
Browse files

Doxygen : fixed rogue classes, simplified INPUT

parent aa68159a
......@@ -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
......
......@@ -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
......
......@@ -30,7 +30,7 @@ Description
Global
foamVersion
Foam::FOAMversion
Description
OpenFOAM version number static string.
......
......@@ -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
......
......@@ -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"
......
......@@ -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:
......
......@@ -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
......
......@@ -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"
......
......@@ -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 */
};
......
......@@ -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"
......
......@@ -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"
......
......@@ -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"
......
......@@ -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();
......
......@@ -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.
......
......@@ -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.
......
......@@ -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
......
......@@ -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
......
......@@ -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
+------+------+------+
^ ^ <- 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.
| | | |
+------+------+------+
@verbatim
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.
| | | |
+------+------+------+
@endverbatim
SourceFiles
......
......@@ -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
......
......@@ -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
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment