A bunch of small changes to make doxygen happy

timofeymukha · Apr 26, 2023 · 1dbae40 · 1dbae40
1 parent 890d81e
commit 1dbae40
Show file tree

Hide file tree

Showing 40 changed files with 47 additions and 43 deletions.
diff --git a/cellFinders/CellFinder/CellFinder.H b/cellFinders/CellFinder/CellFinder.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::CellFinder
 
-Description
+@brief
     Class for searching for sampling cells.
 
 Contributors/Copyright:

diff --git a/cellFinders/CrawlingCellFinder/CrawlingCellFinder.H b/cellFinders/CrawlingCellFinder/CrawlingCellFinder.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::CrawlingCellFinder
 
-Description
+@brief
     Class for searching for sampling cells by crawling through opposite faces.
 
 Contributors/Copyright:

diff --git a/cellFinders/TreeCellFinder/TreeCellFinder.H b/cellFinders/TreeCellFinder/TreeCellFinder.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::TreeCellFinder
 
-Description
+@brief
     Class for searching for sampling cells using.
 
 Contributors/Copyright:

diff --git a/docs/Doxyfile b/docs/Doxyfile
@@ -1296,7 +1296,8 @@ HTML_STYLESHEET        =
 # documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_EXTRA_STYLESHEET  =
+#HTML_EXTRA_STYLESHEET  = /home/timofey/Software/doxygen-awesome-css/doxygen-awesome.css \
+#                         /home/timofey/Software/doxygen-awesome-css/doxygen-awesome-sidebar-only.css
 
 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
 # other source files which should be copied to the HTML output directory. Note
@@ -1619,7 +1620,7 @@ DISABLE_INDEX          = NO
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-GENERATE_TREEVIEW      = NO
+GENERATE_TREEVIEW      = YES 
 
 # When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
 # FULL_SIDEBAR option determines if the side bar is limited to only the treeview

diff --git a/docs/conf.py b/docs/conf.py
@@ -53,7 +53,6 @@
     'exhale',
     'sphinx_rtd_theme',
     'sphinxcontrib.bibtex',
-    'sphinx.ext.autosectionlabel'
 ]
 
 bibtex_bibfiles = ['bibl.bib']
@@ -204,7 +203,7 @@
     "rootFileTitle":         "Library API",
     "doxygenStripFromPath":  "..",
     # Suggested optional arguments
-    "createTreeView":        True,
+    "createTreeView":        False,
     # TIP: if using the sphinx-bootstrap-theme, you need
     # "treeViewIsBootstrap": True,
     "exhaleExecutesDoxygen": True,
@@ -214,4 +213,4 @@
     "doxygenStripFromPath": "../"
 }
 
-numfig = True
+numfig = True
diff --git a/docs/grid_construction.rst b/docs/grid_construction.rst
@@ -1,3 +1,5 @@
+.. _grid-construction:
+
 Grid construction
 =================
 

diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -24,14 +24,14 @@ following:
     type         Spalding;
   }
 
-* In your :code:`0` directory, you should add a new volScalarField, :code:`h`, see the :ref:`Sampling` section for details.
+* In your :code:`0` directory, you should add a new volScalarField, :code:`h`, see the :ref:`sampling` section for details.
   For a quick start, set the value of :code:`h` to :code:`uniform 0` at the wall, and use :code:`zeroGradient` at all
   non-wall patch boundaries.
   This will lead to sampling from the wall adjacent-cell, which is very robust, but inaccurate.
 
 The settings above are not optimal, but should get your case running.
 Of course, you should never run your WMLES on a wall-resolving mesh.
-Instead, we recommend using a meshing strategy presented in :ref:`Grid construction`.
+Instead, we recommend using a meshing strategy presented in :ref:`grid-construction`.
 
 Miscellaneous tips and troubleshooting
 --------------------------------------

diff --git a/docs/sampling.rst b/docs/sampling.rst
@@ -1,3 +1,5 @@
+.. _sampling:
+
 Sampling
 ========
 

diff --git a/eddyViscosities/Duprat/DupratEddyViscosity.H b/eddyViscosities/Duprat/DupratEddyViscosity.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::DupratEddyViscosity
 
-Description
+@brief
     Eddy viscosity model based on the work of Duprat et al. [Duprat].
 
     \f[

diff --git a/eddyViscosities/EddyViscosity/EddyViscosity.H b/eddyViscosities/EddyViscosity/EddyViscosity.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::EddyViscosity
 
-Description
+@brief
     Base abstract class for 1D turbulence models based on eddy viscosity.
 
     Meant to be used with ODE based wall models that need the distribution

diff --git a/eddyViscosities/VanDriest/VanDriestEddyViscosity.H b/eddyViscosities/VanDriest/VanDriestEddyViscosity.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::VanDriestEddyViscosity
 
-Description
+@brief
     A mixing-length based eddy viscosity model using a van Driest damping
     function.
     Corresponds to the formulation used by Cabot in [Cabot].

diff --git a/helpers/helpers.H b/helpers/helpers.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::PatchProjector
 
-Description
+@brief
     Class for projecting fields and lists onto a patch.
 
 Contributors/Copyright:

diff --git a/lawsOfTheWall/IntegratedReichardtLawOfTheWall/IntegratedReichardtLawOfTheWall.H b/lawsOfTheWall/IntegratedReichardtLawOfTheWall/IntegratedReichardtLawOfTheWall.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::IntegratedReichardtLawOfTheWall
 
-Description
+@brief
     Model based on integrating the law of the wall proposed by Reichardt.
 
     \f[

diff --git a/lawsOfTheWall/IntegratedWernerWengleLawOfTheWall/IntegratedWernerWengleLawOfTheWall.H b/lawsOfTheWall/IntegratedWernerWengleLawOfTheWall/IntegratedWernerWengleLawOfTheWall.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::IntegratedWernerWengleLawOfTheWall
 
-Description
+@brief
     The integrated version of the wall proposed by Werner and Wengle.
     Explicitely couples shear stress with the wall-normal-averaged velocity.
     Derived assuming that the sampling is from the wall-adjacent cell.

diff --git a/lawsOfTheWall/LawOfTheWall/LawOfTheWall.H b/lawsOfTheWall/LawOfTheWall/LawOfTheWall.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::LawOfTheWall
 
-Description
+@brief
     Base abstract class for laws of the wall.
  
     It is to be used in conjuction

diff --git a/lawsOfTheWall/ReichardtLawOfTheWall/ReichardtLawOfTheWall.H b/lawsOfTheWall/ReichardtLawOfTheWall/ReichardtLawOfTheWall.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::ReichardtLawOfTheWall
 
-Description
+@brief
     The law of the wall proposed by Reichardt.
 
     \f[

diff --git a/lawsOfTheWall/RoughLogLawOfTheWall/RoughLogLawOfTheWall.H b/lawsOfTheWall/RoughLogLawOfTheWall/RoughLogLawOfTheWall.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::RoughLogLawOfTheWall
 
-Description
+@brief
     A log-law, in which the wall-normal distance is scaled by roughness
     length-scale.
 

diff --git a/lawsOfTheWall/SpaldingLawOfTheWall/SpaldingLawOfTheWall.H b/lawsOfTheWall/SpaldingLawOfTheWall/SpaldingLawOfTheWall.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::SpaldingLawOfTheWall
 
-Description
+@brief
     The law of the wall proposed by Spalding.
 
     \f[

diff --git a/lawsOfTheWall/WernerWengleLawOfTheWall/WernerWengleLawOfTheWall.H b/lawsOfTheWall/WernerWengleLawOfTheWall/WernerWengleLawOfTheWall.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::WernerWengleLawOfTheWall
 
-Description
+@brief
     The law of the wall proposed by Werner and Wengle. Note that the model in
     the reference uses the integrated version of this law, also present in the
     library.

diff --git a/rootFinding/BisectionRootFinder/BisectionRootFinder.H b/rootFinding/BisectionRootFinder/BisectionRootFinder.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::BisectionRootFinder
 
-Description
+@brief
     Root finder based on the bisection method. 
  
    Controlled by three paramters:

diff --git a/rootFinding/NewtonRootFinder/NewtonRootFinder.H b/rootFinding/NewtonRootFinder/NewtonRootFinder.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::NewtonRootFinder
 
-Description
+@brief
     Root finder based on Newton's method.
 
     Controlled by two parameters: the max number of iterations and the relative

diff --git a/rootFinding/RootFinder/RootFinder.H b/rootFinding/RootFinder/RootFinder.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::RootFinder
 
-Description
+@brief
     Base abstract class for finding roots of non-linear algebraic equations.
 
     In the context of wall modelling the latter are provided by laws of the

diff --git a/samplers/MultiCellSampler/MultiCellSampler.H b/samplers/MultiCellSampler/MultiCellSampler.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::MultiCellSampler
 
-Description
+@brief
     Class for sampling from several consecutive cells per wall face.
 
 Contributors/Copyright:

diff --git a/samplers/SampledField/SampledField.H b/samplers/SampledField/SampledField.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::SampledField
 
-Description
+@brief
     Base class for a sampled field. Handles sampling of and recomputing a 
     specific field. Also registers the field to the object registry
     under the sub-registry wallModelSampling -- patch-name.

diff --git a/samplers/SampledField/SampledPGradField.H b/samplers/SampledField/SampledPGradField.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::SampledPGradField
 
-Description
+@brief
     Class for the sampled pressure gradient field.
 
 Contributors/Copyright:

diff --git a/samplers/SampledField/SampledVelocityField.H b/samplers/SampledField/SampledVelocityField.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::SampledVelocityField
 
-Description
+@brief
     Class for the sampled velocity field.
 
 Contributors/Copyright:

diff --git a/samplers/SampledField/SampledWallGradUField.H b/samplers/SampledField/SampledWallGradUField.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::SampledWallGradUField
 
-Description
+@brief
     Class for the sampled velocity gradient field at the wall.
 
 Contributors/Copyright:

diff --git a/samplers/Sampler/Sampler.H b/samplers/Sampler/Sampler.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::Sampler
 
-Description
+@brief
     Class for sampling data to the wall models.
 
 Contributors/Copyright:

diff --git a/samplers/SingleCellSampler/SingleCellSampler.H b/samplers/SingleCellSampler/SingleCellSampler.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::SingleCellSampler
 
-Description
+@brief
     Class for sampling data to the wall models for a single cell per face.
 
 Contributors/Copyright:

diff --git a/scalarListListIOList/scalarListListIOList.H b/scalarListListIOList/scalarListListIOList.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::SingleCellSampler
 
-Description
+@brief
     
 
 Contributors/Copyright:

diff --git a/tests/fixtures.H b/tests/fixtures.H
@@ -16,7 +16,7 @@ License
     along with libWallModelledLES. 
     If not, see <http://www.gnu.org/licenses/>.
 
-Description
+@brief
     Various helper functions for testing the software.
     
 Contributors/Copyright:

diff --git a/tests/testCases/channel_flow/0/nut b/tests/testCases/channel_flow/0/nut
@@ -24,7 +24,7 @@ boundaryField
     bottomWall
     {
 /* * * * * * * * * Law of the wall wall model * * * * * * */                  
-         type           LOTWWallModel;
+         type           MulticellLOTWWallModel;
          //type           LSQRWallModel;
   //       value            uniform 0;  //redundant
   //
@@ -43,7 +43,7 @@ boundaryField
        }
 
        sampler Crawling;
-       interpolationType cellPointFace;
+       interpolationType cell;
        hIsIndex false;
        silent false;
 

diff --git a/versionRules/codeRules.H b/versionRules/codeRules.H
@@ -19,7 +19,7 @@ License
 Class
 
 
-Description
+@brief
     Based on the OpenFOAM version, generates macros that can be used to make
     the code support multiple versions via #ifdef statements.
     The file is adopted with minor changes from swak4foam, see list of

diff --git a/wallModels/EquilibriumODEWallModelFvPatchScalarField.H b/wallModels/EquilibriumODEWallModelFvPatchScalarField.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::EquilibriumODEWallModelFvPatchScalarField
 
-Description
+@brief
     ODE model with a zero source-term.
   
     Physically, this means that the total shear stress is assumed to be constant

diff --git a/wallModels/KnownWallShearStressWallModelFvPatchScalarField.H b/wallModels/KnownWallShearStressWallModelFvPatchScalarField.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::KnownWallShearStressWallModelFvPatchScalarField
 
-Description
+@brief
     Wall model that uses the values of the magnitude of the mean wall shear
     stress known a priori, for example, from a RANS precursor or an analytical
     solution.

diff --git a/wallModels/LOTWWallModelFvPatchScalarField.H b/wallModels/LOTWWallModelFvPatchScalarField.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::LOTWWallModelFvPatchScalarField
 
-Description
+@brief
     Class for the wall models based on a law of the wall.
  
     Needs a root finder and a law of the wall to be defined.

diff --git a/wallModels/MulticellLOTWWallModelFvPatchScalarField.H b/wallModels/MulticellLOTWWallModelFvPatchScalarField.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::MulticellLOTWWallModelFvPatchScalarField
 
-Description
+@brief
     Class for the wall models based on a law of the wall, sampling data
     from multiple cells. Currently hardcoded to use the integrated
     Reichardt law.

diff --git a/wallModels/ODEWallModelFvPatchScalarField.H b/wallModels/ODEWallModelFvPatchScalarField.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::ODEWallModelFvPatchScalarField
 
-Description
+@brief
     Base abstract class for ODE-based wall models.
   
     All the models are based on the following equation

diff --git a/wallModels/PGradODEWallModelFvPatchScalarField.H b/wallModels/PGradODEWallModelFvPatchScalarField.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::PGradODEWallModelFvPatchScalarField
 
-Description
+@brief
     ODE wall model with the source term equal to the wall-parallel pressure
     gradient.
 

diff --git a/wallModels/wallModelFvPatchScalarField.H b/wallModels/wallModelFvPatchScalarField.H
@@ -19,7 +19,7 @@ License
 Class
     Foam::wallModelFvPatchScalarField
 
-Description
+@brief
     Base abstract class for LES wall models.
     
     Handles creating and storing fields used by the wall models.