Skip to content
Snippets Groups Projects
Commit b6d45823 authored by Henry's avatar Henry
Browse files

Updated doc/Doxygen

parent a47d5f81
Branches
Tags
No related merge requests found
Expand all Hide whitespace changes
Inline Side-by-side
Showing
with 399 additions and 387 deletions
doc/Doxygen/Allwmake
+ 8
− 0
View file @ b6d45823
#!/bin/sh
cd ${0%/*} || exit 1 # run from this directory
[ -d "$WM_PROJECT_DIR" ] || {
echo "Error: WM_PROJECT_DIR directory does not exist"
echo " Check the OpenFOAM entries in your dot-files and source them."
echo " WM_PROJECT_DIR=$WM_PROJECT_DIR"
exit 1
}
set -x
rm -rf latex man
......
doc/Doxygen/Doxyfile
+ 391
− 105
View file @ b6d45823
This diff is collapsed.
doc/Doxygen/Doxygen.css deleted 100644 → 0
+ 0
− 76
View file @ a47d5f81
body { color: #000000 ; background: #ffffff; margin: 0px; font-family: verdana, arial, helvetica, sans-serif; text-decoration: none; font-size: 12px; }
a:link { text-decoration: none; color: #0000ff ; }
a:link:hover { text-decoration: none; color: #0000ff ; }
a:visited { text-decoration: none; color: #0000ff ; }
a:visited:hover { text-decoration: none; color: #0000ff ; }
a:link img { border: 0; }
a:visited img { border: 0; }
a:active img { border: 0; }
a.menuLefton { color: #0000ff; font-size: 12px; font-weight: bold; }
td.leftmenu { font-family: verdana, arial, helvetica, sans-serif; text-decoration: none; background: #ddddff; text-align: left; font-size: 14px; height: 20px; width: 200px; }
a.menuTopoff { color: #000000; font-size: 14px; }
a.menuTopoff:visited { color: #000000; font-size: 14px; }
a.menuTopoff:hover { color: #0000ff; font-size: 14px; }
td.topmenu { font-family: verdana, arial, helvetica, sans-serif; background: #ddddff; text-align: center; font-size: 16px; width: 150px; font-weight: bold; }
h1 { font-size: 18px; }
h2 { font-size: 16px; }
h3 { font-size: 14px; }
/* formatting for member functions:
* Since the OpenFOAM code already has nice line-breaks, wrapping the lines
* just looks terrible.
* Give a slightly different background to make it easier to find.
*/
.memitem {
padding: 4px;
background-color: #eef3f5;
border-width: 1px;
border-style: solid;
border-color: #dedeee;
}
.memproto {
background-color: #d5e1e8;
width: 100%;
border-width: 1px;
border-style: solid;
border-color: #84b0c7;
font-weight: bold;
}
table.memname {
width: 100%;
background: #f7f7ff;
white-space: nowrap;
}
.indexkey {
vertical-align: top;
background: #f7f7ff;
}
.indexvalue {
vertical-align: top;
background: #f7f7ff;
}
.paramkey {
width: 5%;
}
.memItemLeft {
background: #f7f7ff;
}
.memItemRight {
background: #f7f7ff;
}
.mdescLeft {
margin: 0px;
}
.mdescRight {
font-style: italic;
}
doc/Doxygen/FoamFooter.html deleted 100644 → 0
+ 0
− 5
View file @ a47d5f81
Copyright&nbsp;&copy;&nbsp;2000-2010&nbsp;<a href="http://www.openfoam.com/about">OpenCFD Ltd.</a>
</td></tr>
</table>
</body>
</html>
doc/Doxygen/FoamHeader.html deleted 100644 → 0
+ 0
− 73
View file @ a47d5f81
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title> OpenFOAM programmer's C++ documentation </title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<!-- html,info -->
<link rel="stylesheet" type="text/css" href="../Doxygen.css">
<link rel="stylesheet" type="text/css" href="../tabs.css">
<link href="../OpenFOAMicon.png" type="image/png" rel="icon" />
<meta name="keywords" content="computational fluid dynamics, CFD, OpenCFD, OpenFOAM, open source CFD, open source">
<meta name="description" content="OpenCFD Ltd, leaders in open source Computational Fluid Dynamics (CFD), the developers and maintainers of OpenFOAM: the open source CFD toolbox. We supply support and contracted developments for OpenFOAM">
</head>
<body>
<a id="openfoam"> </a>
<!-- Top banner -->
<table
style="border-width: 0px; width: 800px; background: #ddddff;"
cellspacing="0" cellpadding="0">
<tr>
<td style="width: 9px; height:54px"></td>
<td style="width: 250px; height:54px; vertical-align:middle;
horizontal-align: left;">
<img alt="OpenFOAM logo" src="../OpenFOAMlogo.jpg"> </td>
<td style="width:350px; height:54px; vertical-align:middle;
horizontal-align: left; ">
<table>
<tr>
<td><img alt="The Open Source CFD Toolbox" src="../OpenSourceToolbox.jpg"></td>
</tr>
</table>
</td>
</tr>
</table>
<!-- Button banner -->
<table
style="border-width: 0px; width: 800px; background: #ffffff;"
cellspacing="0" cellpadding="0">
<tr>
<td valign="top">
<table width="801" border="0" cellspacing="1" cellpadding="0" bgcolor="#ffffff">
<tr>
<td class="leftmenu">&nbsp;
<a href="http://foam.sourceforge.net/doc/Doxygen/html"
class="menuLefton">Source Guide</a>
</td>
<td class="topmenu">
<a href="http://www.openfoam.com/about/"
class="menuTopoff">OpenCFD</a>
</td>
<td class="topmenu">
<a href="http://www.openfoam.com/features/"
class="menuTopoff">Features</a>
</td>
<td class="topmenu">
<a href="http://www.openfoam.com/contact/"
class="menuTopoff">Contact</a>
</td>
<td class="topmenu">
<a href="http://www.openfoam.com/"
class="menuTopoff">OpenFOAM</a>
</td>
</tr>
<tr><td></td></tr>
</table>
</td>
</tr>
</table>
<table
style="border-width: 0px; width: 800px; background: #ffffff;"
cellspacing="5" cellpadding="0">
<tr>
<td>
doc/Doxygen/Macros/tensorOperator.sty deleted 100644 → 0
+ 0
− 128
View file @ a47d5f81
%-----------------------------------------------------------------------------
% ========= |
% \\ / 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$}}}
% ------------------------------------------------------------------------------
doc/doxygen/OpenFOAMdocIcon.png → doc/Doxygen/OpenFOAMdocIcon.png
+ 0
− 0
View file @ b6d45823
File moved
doc/Doxygen/OpenFOAMicon.png
+ 0
− 0
View replaced file @ a47d5f81 View file @ b6d45823
doc/Doxygen/OpenFOAMicon.png

1.38 KiB | W: | H:

doc/Doxygen/OpenFOAMicon.png

1.17 KiB | W: | H:

doc/Doxygen/OpenFOAMicon.png
doc/Doxygen/OpenFOAMicon.png
doc/Doxygen/OpenFOAMicon.png
doc/Doxygen/OpenFOAMicon.png
  • 2-up
  • Swipe
  • Onion skin
doc/Doxygen/OpenFOAMlogo.jpg deleted 100644 → 0
+ 0
− 0
View file @ a47d5f81
doc/Doxygen/OpenFOAMlogo.jpg

8.32 KiB

doc/Doxygen/OpenSourceToolbox.jpg deleted 100644 → 0
+ 0
− 0
View file @ a47d5f81
doc/Doxygen/OpenSourceToolbox.jpg

9.92 KiB

doc/Doxygen/OpenSourceToolkit.jpg deleted 100644 → 0
+ 0
− 0
View file @ a47d5f81
doc/Doxygen/OpenSourceToolkit.jpg

9.6 KiB

doc/doxygen/_Footer → doc/Doxygen/_Footer
+ 0
− 0
View file @ b6d45823
File moved
doc/doxygen/_Header → doc/Doxygen/_Header
+ 0
− 0
View file @ b6d45823
File moved
doc/doxygen/css/cfdLayout.css → doc/Doxygen/css/cfdLayout.css
+ 0
− 0
View file @ b6d45823
File moved
doc/doxygen/css/cfdNav.css → doc/Doxygen/css/cfdNav.css
+ 0
− 0
View file @ b6d45823
File moved
doc/doxygen/css/doxyMod.css → doc/Doxygen/css/doxyMod.css
+ 0
− 0
View file @ b6d45823
File moved
doc/doxygen/css/doxyTabs.css → doc/Doxygen/css/doxyTabs.css
+ 0
− 0
View file @ b6d45823
File moved
doc/doxygen/css/doxygen.css → doc/Doxygen/css/doxygen.css
+ 0
− 0
View file @ b6d45823
File moved
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment