diff --git a/.gitignore b/.gitignore index 67ac189fcc..7c8bce03fe 100644 --- a/.gitignore +++ b/.gitignore @@ -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 diff --git a/doc/Doxygen/Doxyfile b/doc/Doxygen/Doxyfile index 346b976e5b..7c72c4595e 100644 --- a/doc/Doxygen/Doxyfile +++ b/doc/Doxygen/Doxyfile @@ -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 diff --git a/doc/Doxygen/Macros/tensorOperator.sty b/doc/Doxygen/Macros/tensorOperator.sty new file mode 100644 index 0000000000..60b2234b82 --- /dev/null +++ b/doc/Doxygen/Macros/tensorOperator.sty @@ -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 . +% +% 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$}}} + + +% ------------------------------------------------------------------------------ diff --git a/doc/Doxygen/_Footer b/doc/Doxygen/_Footer index f68739e803..b6622df85b 100644 --- a/doc/Doxygen/_Footer +++ b/doc/Doxygen/_Footer @@ -4,12 +4,17 @@

Copyright © 2004-2011  OpenCFD Limited - | OPENFOAM® and OpenCFD® are registered trademarks of OpenCFD Ltd. + | + OPENFOAM® and OpenCFD® are registered + trademarks + of OpenCFD Ltd.

Based on design by 1234.info - | Content generated by doxygen + | + Content generated by + doxygen

diff --git a/doc/Doxygen/_Header b/doc/Doxygen/_Header index e788da5f0d..f08179b6f8 100644 --- a/doc/Doxygen/_Header +++ b/doc/Doxygen/_Header @@ -24,47 +24,18 @@
-
- - -
diff --git a/doc/Doxygen/css/cfdLayout.css b/doc/Doxygen/css/cfdLayout.css index 4376035c4c..666b82f355 100644 --- a/doc/Doxygen/css/cfdLayout.css +++ b/doc/Doxygen/css/cfdLayout.css @@ -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); diff --git a/doc/Doxygen/css/img/OpenCFDlogo.png b/doc/Doxygen/css/img/OpenCFDlogo.png index 15c03032ca..a709672473 100644 Binary files a/doc/Doxygen/css/img/OpenCFDlogo.png and b/doc/Doxygen/css/img/OpenCFDlogo.png differ diff --git a/doc/Doxygen/css/img/OpenFOAMlogo.png b/doc/Doxygen/css/img/OpenFOAMlogo.png new file mode 100644 index 0000000000..aae8387f5e Binary files /dev/null and b/doc/Doxygen/css/img/OpenFOAMlogo.png differ