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

Local Macros for Doxygen

Browse Source
This commit is contained in:
sergio
2008-12-01 10:32:53 +00:00
parent 3712ca92e6
commit 7c326218a8
3 changed files with 11 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
applications/solvers/combustion/PDRFoam/PDRModels/XiEqModels/basicXiSubXiEq/basicXiSubXiEq.H
View File

@ -29,7 +29,7 @@ Description
Basic sub-grid obstacle flame-wrinking enhancement factor model. Basic sub-grid obstacle flame-wrinking enhancement factor model.
Details supplied by J Puttock 2/7/06. Details supplied by J Puttock 2/7/06.
<b> Sub-grid flame area generation <\b> <b> Sub-grid flame area generation </b>
\f$ n = N - \hat{\dwea{\vec{U}}}.n_{s}.\hat{\dwea{\vec{U}}} \f$ \f$ n = N - \hat{\dwea{\vec{U}}}.n_{s}.\hat{\dwea{\vec{U}}} \f$
\f$ n_{r} = \sqrt{n} \f$ \f$ n_{r} = \sqrt{n} \f$

4
applications/solvers/combustion/PDRFoam/PDRModels/dragModels/basic/basic.H
View File

@ -29,7 +29,7 @@ Description
Basic sub-grid obstacle drag model. Basic sub-grid obstacle drag model.
Details supplied by J Puttock 2/7/06. Details supplied by J Puttock 2/7/06.
<b> Sub-grid drag term <\b> <b> Sub-grid drag term </b>
The resistance term (force per unit of volume) is given by: The resistance term (force per unit of volume) is given by:
@ -43,7 +43,7 @@ Description
This is term is treated implicitly in UEqn.H This is term is treated implicitly in UEqn.H
<b> Sub-grid turbulence generation <\b> <b> Sub-grid turbulence generation </b>
The turbulence source term \f$ G_{R} \f$ occurring in the The turbulence source term \f$ G_{R} \f$ occurring in the
\f$ \kappa-\epsilon \f$ equations for the generation of turbulence due \f$ \kappa-\epsilon \f$ equations for the generation of turbulence due

19
doc/Doxygen/Doxyfile
View File

@ -19,9 +19,7 @@
# PATH FOR OPEN CFD LATEX MACROS # PATH FOR OPEN CFD LATEX MACROS
#------------------------------- #-------------------------------
@INLUDE_PATH = $(TEXINPUTS) @INLUDE_PATH = $(WM_PROJECT_DIR)/doc/Doxygen/Macros/
@INLUDE_PATH += $(BIBINPUTS)
@INLUDE_PATH += $(BSTINPUTS)
# This tag specifies the encoding used for all characters in the config file that # This tag specifies the encoding used for all characters in the config file that
@ -487,9 +485,9 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories # directories like "/usr/src/myproject". Separate the files or directories
# with spaces. # with spaces.
INPUT = $(WM_PROJECT_DIR)/src \ INPUT = #$(WM_PROJECT_DIR)/src \
$(WM_PROJECT_DIR)/applications/utilities \ #$(WM_PROJECT_DIR)/applications/utilities \
$(WM_PROJECT_DIR)/applications/solvers #$(WM_PROJECT_DIR)/applications/solvers
@ -548,9 +546,8 @@ EXCLUDE_SYMBOLS =
# directories that contain example code fragments that are included (see # directories that contain example code fragments that are included (see
# the \include command). # the \include command).
EXAMPLE_PATH = $(TEXINPUTS) \ EXAMPLE_PATH =
$(BIBINPUTS) \
$(BSTINPUTS)
# If the value of the EXAMPLE_PATH tag contains directories, you can use the # If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
@ -838,9 +835,9 @@ PAPER_TYPE = a4wide
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
# packages that should be included in the LaTeX output. # packages that should be included in the LaTeX output.
EXTRA_PACKAGES = conditionalEqns finiteVolume algorithmic tensorCommon \ EXTRA_PACKAGES = $(WM_PROJECT_DIR)/doc/Doxygen/Macros/tensorOperator
tensorOperator tensorEquation
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
# the generated latex document. The header should contain everything until # the generated latex document. The header should contain everything until
# the first chapter. If it is left blank doxygen will generate a # the first chapter. If it is left blank doxygen will generate a