Updated Doxygen setup from Chris
This commit is contained in:
Henry
parent
0200b59e79
commit
6bb467d902
7
.gitignore
vendored
7
.gitignore
vendored
@ -48,9 +48,10 @@ platforms/
|
||||
!wmake/rules/*/
|
||||
|
||||
# doxygen generated documentation
|
||||
doc/[Dd]oxygen/html
|
||||
doc/[Dd]oxygen/latex
|
||||
doc/[Dd]oxygen/man
|
||||
doc/Doxygen/html
|
||||
doc/Doxygen/latex
|
||||
doc/Doxygen/man
|
||||
doc/Doxygen/DTAGS
|
||||
|
||||
# generated files in the main directory (e.g. ReleaseNotes-?.?.html)
|
||||
# and in the doc directory
|
||||
|
||||
@ -129,7 +129,7 @@ STRIP_FROM_INC_PATH =
|
||||
# (but less readable) file names. This can be useful is your file systems
|
||||
# doesn't support long names like on DOS, Mac, or CD-ROM.
|
||||
|
||||
SHORT_NAMES = NO
|
||||
SHORT_NAMES = YES
|
||||
|
||||
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
|
||||
# will interpret the first line (until the first dot) of a JavaDoc-style
|
||||
|
||||
128
doc/Doxygen/Macros/tensorOperator.sty
Normal file
128
doc/Doxygen/Macros/tensorOperator.sty
Normal file
@ -0,0 +1,128 @@
|
||||
%-----------------------------------------------------------------------------
|
||||
% ========= |
|
||||
% \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
% \\ / O peration |
|
||||
% \\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
||||
% \\/ M anipulation |
|
||||
%------------------------------------------------------------------------------
|
||||
% License
|
||||
% This file is part of OpenFOAM.
|
||||
%
|
||||
% OpenFOAM is free software: you can redistribute it and/or modify it
|
||||
% under the terms of the GNU General Public License as published by
|
||||
% the Free Software Foundation, either version 3 of the License, or
|
||||
% (at your option) any later version.
|
||||
%
|
||||
% OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
|
||||
% ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||
% FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
||||
% for more details.
|
||||
%
|
||||
% You should have received a copy of the GNU General Public License
|
||||
% along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
||||
%
|
||||
% LaTeX Style file
|
||||
% tensorOperator.sty
|
||||
%
|
||||
% Description
|
||||
% Standard OpenCFD LaTeX macros for typesetting tensor algebra.
|
||||
%
|
||||
%------------------------------------------------------------------------------
|
||||
|
||||
% tensor style
|
||||
% ~~~~~~~~~~~~
|
||||
\renewcommand{\vec}[1] {\ensuremath{\mathbf #1}}
|
||||
\newcommand{\gvec}[1] {\ensuremath{\mbox{\boldmath$\bf#1$}}}
|
||||
|
||||
% products
|
||||
% ~~~~~~~~
|
||||
\newcommand{\anyprod}{\star}
|
||||
\newcommand{\cprod} {\times}
|
||||
\newcommand{\dprod} {\,{\scriptscriptstyle \stackrel{\bullet}{{}}}\,}
|
||||
\newcommand{\ddprod} {\,{\scriptscriptstyle \stackrel{\bullet}{\bullet}}\,}
|
||||
\newcommand{\tdprod} {\,{\scriptscriptstyle \stackrel{3}{\bullet}}\,}
|
||||
\newcommand{\tprod} {\,{\scriptscriptstyle \stackrel{\otimes}{{}}}\,}
|
||||
|
||||
% operations
|
||||
% ~~~~~~~~~~
|
||||
\newcommand{\adj} {\ensuremath{\operatorname{adj}}}
|
||||
\newcommand{\cof} {\ensuremath{\operatorname{cof}}}
|
||||
\newcommand{\diag} {\ensuremath{\operatorname{diag}}}
|
||||
\newcommand{\dev} {\ensuremath{\operatorname{dev}}}
|
||||
|
||||
\newcommand{\Hodge} {\ensuremath{\operatorname{\stackrel{\displaystyle \ast}{}}}}
|
||||
\newcommand{\hyd} {\ensuremath{\operatorname{hyd}}}
|
||||
\renewcommand{\max} {\ensuremath{\operatorname{max}}}
|
||||
\renewcommand{\min} {\ensuremath{\operatorname{min}}}
|
||||
\newcommand{\inv} {\ensuremath{\operatorname{inv}}}
|
||||
\newcommand{\sym} {\ensuremath{\operatorname{symm}}} % symm ?
|
||||
\newcommand{\skw} {\ensuremath{\operatorname{skew}}} % skew already defined
|
||||
\newcommand{\tr} {\ensuremath{\operatorname{tr}}}
|
||||
\newcommand{\trans}[1] {\ensuremath{#1^{\operatorname{T}}}}
|
||||
|
||||
% alternative tensor operators for hypersonics etc.
|
||||
% ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
\newcommand{\devs}[1] {\overset{\scriptscriptstyle\circ}{#1}}
|
||||
%\newcommand{\trans}[1] {\ensuremath{#1^{\operatorname{T}}}}
|
||||
\newcommand{\symms}[1] {\overleftrightarrow{#1}}
|
||||
\newlength{\skewslength}
|
||||
\newlength{\skewsheight}
|
||||
\newcommand{\skews}[1]{
|
||||
\settowidth{\skewslength}{#1}%
|
||||
\settoheight{\skewsheight}{#1}%
|
||||
\addtolength{\skewsheight}{0.4mm}%
|
||||
{\overleftrightarrow{#1}\hspace{-.5\skewslength}%
|
||||
\rule[\skewsheight]{.4pt}{1.4mm}
|
||||
\hspace{.5\skewslength}%
|
||||
}}
|
||||
%\newcommand{\skew}[1] {\ensuremath{#1^{\operatorname{A}}}}
|
||||
|
||||
% spatial derivatives
|
||||
% ~~~~~~~~~~~~~~~~~~~
|
||||
\newcommand{\curl}{\ensuremath{\nabla\cprod}}
|
||||
\renewcommand{\div} {\ensuremath{\nabla\dprod}}
|
||||
\newcommand{\grad}{\ensuremath{\nabla}}
|
||||
\newcommand{\laplacian}{\ensuremath{\nabla^{2}}}
|
||||
|
||||
% temporal derivatives
|
||||
% ~~~~~~~~~~~~~~~~~~~~
|
||||
\newcommand{\ddt}[1] {\ensuremath{\frac{\partial #1}{\partial t }}}
|
||||
\newcommand{\DDt}[1] {\ensuremath{\frac{D #1}{D t}}}
|
||||
\newcommand{\DpDt}[2] {\ensuremath{\frac{d_{#1} #2}{d t }}}
|
||||
\newcommand{\dsdts}[1] {\ensuremath{\frac{\partial ^2 #1}{\partial t^2}}}
|
||||
\newcommand{\rate}[1] {\ensuremath{\dot{#1}}}
|
||||
|
||||
\newcommand{\genDer}{\mathcal{L}}
|
||||
|
||||
% time average symbols
|
||||
% ~~~~~~~~~~~~~~~~~~~~
|
||||
\newcommand{\av}[1] {\ensuremath{\overline{#1}}}
|
||||
\newcommand{\corrtwo}[2] {{\dwea{\dprime{#1} \dprime{#2}}}}
|
||||
\newcommand{\curly}[1] {{\cal #1}}
|
||||
\newcommand{\dprime}[1] {\ensuremath{{#1}^{^{\prime \prime}}}}
|
||||
\newcommand{\dwea}[1] {\ensuremath{\widetilde{#1}}}
|
||||
\newcommand{\dweafluc}[1] {\ensuremath{\dprime{#1}}}
|
||||
\newcommand{\fluc}[1] {\ensuremath{#1^{\prime}}}
|
||||
|
||||
% index style
|
||||
% ~~~~~~~~~~~
|
||||
\newcommand{\veci}[2][i] {\ensuremath{#2_{#1}}}
|
||||
\newcommand{\teni}[2][ij] {\ensuremath{#2_{#1}}}
|
||||
\newcommand{\tenTi}[2][ji] {\ensuremath{#2_{#1}}}
|
||||
|
||||
% index operations
|
||||
% ~~~~~~~~~~~~~~~~
|
||||
\newcommand{\deltai}[1] {\ensuremath{\partial_{#1}}}
|
||||
|
||||
% Sub-subscripts
|
||||
% ~~~~~~~~~~~~~~
|
||||
\newcommand{\eff} {{\scriptscriptstyle e\!f\!\!f\!}}
|
||||
|
||||
% unknown use
|
||||
% ~~~~~~~~~~~
|
||||
%\font\bigtenrm=cmr12 scaled 1200
|
||||
%\newcommand{\eexp}[1]{{\hbox{$\textfont1=\bigtenrm e$}}^{\raise3pt
|
||||
%\hbox{$#1$}}}
|
||||
|
||||
|
||||
% ------------------------------------------------------------------------------
|
||||
@ -4,12 +4,17 @@
|
||||
<p>
|
||||
Copyright © 2004-2011
|
||||
<a href="http://www.openfoam.com/about">OpenCFD Limited</a>
|
||||
| OPENFOAM® and OpenCFD® are registered trademarks of OpenCFD Ltd.
|
||||
|
|
||||
OPENFOAM® and OpenCFD® are registered
|
||||
<a href="http://www.openfoam.com/legal/trademark-policy.php">trademarks
|
||||
</a> of OpenCFD Ltd.
|
||||
</p>
|
||||
<p class="credits">
|
||||
Based on design by
|
||||
<a target="new" href="http://1234.info">1234.info</a>
|
||||
| Content generated by <a target="new" href="http://www.doxygen.org">doxygen</a>
|
||||
|
|
||||
Content generated by
|
||||
<a target="new" href="http://www.doxygen.org">doxygen</a>
|
||||
</p>
|
||||
</div> <!-- footer -->
|
||||
</div> <!-- page-container -->
|
||||
|
||||
@ -24,47 +24,18 @@
|
||||
<div class="page-container">
|
||||
<div class="header">
|
||||
<div class="header-top">
|
||||
<div class="round-border-topleft"></div>
|
||||
<div class="round-border-topright"></div>
|
||||
<a class="sitelogo" href="http://www.openfoam.com" title="Home"></a>
|
||||
<a class="sitelogo" href="http://www.openfoam.com" title="Home">
|
||||
<img class=left src="../css/img/OpenFOAMlogo.png">
|
||||
</a>
|
||||
<div class="sitename">
|
||||
<h1><a
|
||||
href="http://foam.sourceforge.net/doc/Doxygen/html/"
|
||||
title="Source Guide">Programmer's C++ documentation</a></h1>
|
||||
<h1>
|
||||
<a href="http://foam.sourceforge.net/doc/Doxygen/html/"
|
||||
title="Source Guide">OpenFOAM C++ Documentation
|
||||
</a>
|
||||
</h1>
|
||||
<img class=right src="../css/img/OpenCFDlogo.png">
|
||||
</div>
|
||||
</div> <!-- header-top -->
|
||||
<div class="header-bottom">
|
||||
<!-- navigation -->
|
||||
<div class="nav2">
|
||||
<ul>
|
||||
<li>
|
||||
<a href="http://foam.sourceforge.net/doc/Doxygen/html">Source Guide</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="http://www.openfoam.com/features/">Features</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="http://www.openfoam.com/">OpenFOAM</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="http://www.openfoam.com/contact/">Contact</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="http://www.openfoam.com/about/">OpenCFD</a>
|
||||
</li>
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
</div> <!-- nav2 -->
|
||||
</div> <!-- header-bottom -->
|
||||
</div> <!-- header -->
|
||||
|
||||
<div class="main">
|
||||
|
||||
@ -29,8 +29,9 @@ p:after {
|
||||
}
|
||||
|
||||
/* page-container **************************************/
|
||||
|
||||
.page-container {
|
||||
width:960px;
|
||||
width:100%;
|
||||
margin:0px auto;
|
||||
margin-top:10px;
|
||||
margin-bottom:10px;
|
||||
@ -75,49 +76,31 @@ p:after {
|
||||
overflow:hidden /*IE6*/;
|
||||
}
|
||||
|
||||
.left {margin:none; border:none; }
|
||||
.right {margin:none; border:none; position:absolute; right:35px;top:32px}
|
||||
|
||||
.header-bottom {
|
||||
border:3px solid rgb(175,175,175);
|
||||
border-top-width: 1px;
|
||||
background:rgb(225,225,225);
|
||||
}
|
||||
|
||||
.header .round-border-topleft {
|
||||
width:25px;
|
||||
height:25px;
|
||||
position:absolute;
|
||||
z-index:100;
|
||||
background:url(img/bg_head_corner_topleft_25px.gif) no-repeat;
|
||||
margin-top:-3px;
|
||||
margin-left:-3px;
|
||||
}
|
||||
|
||||
.header .round-border-topright {
|
||||
width:25px;
|
||||
height:25px;
|
||||
position:absolute;
|
||||
z-index:100;
|
||||
background:url(img/bg_head_corner_topright_25px.gif) no-repeat;
|
||||
margin-top:-3px;
|
||||
margin-left:932px;
|
||||
}
|
||||
|
||||
/********************sitelogo *************************************************/
|
||||
.sitelogo {
|
||||
width:924px;
|
||||
width:100%;
|
||||
height:40px;
|
||||
position:absolute;
|
||||
z-index:1;
|
||||
margin:20px 0 0 15px;
|
||||
background:url(img/OpenCFDlogo.png) no-repeat;
|
||||
/* background:url(img/OpenCFDlogo.png) no-repeat;*/
|
||||
}
|
||||
|
||||
/**************************sitename ************************************************/
|
||||
.sitename {
|
||||
width:400px;
|
||||
height:45px;
|
||||
position:absolute;
|
||||
z-index:1;
|
||||
margin:25px 0 0 320px;
|
||||
margin:auto;
|
||||
margin-top:25px;
|
||||
overflow:visible !important /*Firefox*/;
|
||||
overflow:hidden /*IE6*/;
|
||||
}
|
||||
@ -149,7 +132,7 @@ p:after {
|
||||
width:100%;
|
||||
padding:1.0em 0 1.5em 0;
|
||||
border-left:3px solid rgb(175,175,175);
|
||||
border-right:3px solid rgb(175,175,175);
|
||||
border-right:0px solid rgb(175,175,175);
|
||||
}
|
||||
|
||||
.header-breadcrumbs ul {
|
||||
@ -257,7 +240,7 @@ p:after {
|
||||
/*******************main **********************************************/
|
||||
.main {
|
||||
clear:both;
|
||||
width:954px;
|
||||
width:100% minus 2px;
|
||||
padding-bottom:30px;
|
||||
border-left: 3px solid rgb(175,175,175);
|
||||
border-right:3px solid rgb(175,175,175);
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 12 KiB |
BIN
doc/Doxygen/css/img/OpenFOAMlogo.png
Normal file
BIN
doc/Doxygen/css/img/OpenFOAMlogo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.5 KiB |
Loading…
Reference in New Issue
Block a user