Updated and simplified the Doxygen documentation
14
README.org
@ -1,9 +1,9 @@
|
|||||||
# -*- mode: org; -*-
|
# -*- mode: org; -*-
|
||||||
#
|
#
|
||||||
#+TITLE: README for [[http://www.openfoam.org/dev.php][OpenFOAM-dev]]
|
#+TITLE: README for [[http://openfoam.org/download/source][OpenFOAM-dev]]
|
||||||
#+AUTHOR: The OpenFOAM Foundation
|
#+AUTHOR: The OpenFOAM Foundation
|
||||||
#+DATE: 20th April 2016
|
#+DATE: 20th June 2016
|
||||||
#+LINK: http://www.openfoam.org
|
#+LINK: http://openfoam.org
|
||||||
#+OPTIONS: author:nil ^:{}
|
#+OPTIONS: author:nil ^:{}
|
||||||
# Copyright (c) 2015-2016 OpenFOAM Foundation.
|
# Copyright (c) 2015-2016 OpenFOAM Foundation.
|
||||||
|
|
||||||
@ -23,9 +23,9 @@
|
|||||||
[[http://www.gnu.org/licenses/]], for a description of the GNU General Public
|
[[http://www.gnu.org/licenses/]], for a description of the GNU General Public
|
||||||
License terms under which you can copy the files.
|
License terms under which you can copy the files.
|
||||||
|
|
||||||
* [[http://www.OpenFOAM.org/git.php][Download and installation instructions]]
|
* [[http://OpenFOAM.org/download/source][Download and installation instructions]]
|
||||||
* [[http://www.OpenFOAM.org/docs][Documentation]]
|
* [[http://OpenFOAM.org/docs][Documentation]]
|
||||||
* [[http://OpenFOAM.github.io/Documentation-dev/html][Source code documentation]]
|
* [[http://OpenFOAM.github.io/Documentation-dev/html][Source code documentation]]
|
||||||
* [[http://OpenFOAM.github.io/Documentation-dev/html/codingStyleGuide.html][OpenFOAM C++ Style Guide]]
|
* [[http://OpenFOAM.github.io/Documentation-dev/html/codingStyleGuide.html][OpenFOAM C++ Style Guide]]
|
||||||
* [[http://www.OpenFOAM.org/bugs][Reporting bugs in OpenFOAM]]
|
* [[http://OpenFOAM.org/bugs][Reporting bugs in OpenFOAM]]
|
||||||
* [[http://www.openfoam.org/contact][Contacting the OpenFOAM Foundation]]
|
* [[http://openfoam.org/contact][Contacting the OpenFOAM Foundation]]
|
||||||
|
|||||||
@ -957,7 +957,7 @@ Foam::DistributedDelaunayMesh<Triangulation>::rangeInsertReferredWithInfo
|
|||||||
}
|
}
|
||||||
else if (lt == Triangulation::OUTSIDE_CONVEX_HULL)
|
else if (lt == Triangulation::OUTSIDE_CONVEX_HULL)
|
||||||
{
|
{
|
||||||
// @todo Can this be optimised?
|
// TODO: Can this be optimised?
|
||||||
//
|
//
|
||||||
// Only want to insert if a connection is formed between
|
// Only want to insert if a connection is formed between
|
||||||
// pointToInsert and an internal or internal boundary point.
|
// pointToInsert and an internal or internal boundary point.
|
||||||
|
|||||||
@ -1434,7 +1434,7 @@ Foam::labelList Foam::backgroundMeshDecomposition::overlapProcessors
|
|||||||
//// map().distribute(testCentres);
|
//// map().distribute(testCentres);
|
||||||
//// map().distribute(testRadiusSqrs);
|
//// map().distribute(testRadiusSqrs);
|
||||||
//
|
//
|
||||||
// // @todo This is faster, but results in more vertices being referred
|
// // TODO: This is faster, but results in more vertices being referred
|
||||||
// boolList sphereOverlapsCandidate(testCentres.size(), true);
|
// boolList sphereOverlapsCandidate(testCentres.size(), true);
|
||||||
//// boolList sphereOverlapsCandidate(testCentres.size(), false);
|
//// boolList sphereOverlapsCandidate(testCentres.size(), false);
|
||||||
////
|
////
|
||||||
@ -1551,7 +1551,7 @@ Foam::labelList Foam::backgroundMeshDecomposition::overlapProcessors
|
|||||||
// map().distribute(testCentres);
|
// map().distribute(testCentres);
|
||||||
// map().distribute(testRadiusSqrs);
|
// map().distribute(testRadiusSqrs);
|
||||||
//
|
//
|
||||||
// // @todo This is faster, but results in more vertices being referred
|
// // TODO: This is faster, but results in more vertices being referred
|
||||||
//// boolList sphereOverlapsCandidate(testCentres.size(), true);
|
//// boolList sphereOverlapsCandidate(testCentres.size(), true);
|
||||||
// boolList sphereOverlapsCandidate(testCentres.size(), false);
|
// boolList sphereOverlapsCandidate(testCentres.size(), false);
|
||||||
//
|
//
|
||||||
|
|||||||
@ -746,7 +746,7 @@ Foam::label Foam::cellShapeControlMesh::estimateCellCount
|
|||||||
{
|
{
|
||||||
if (!cit->hasFarPoint() && !is_infinite(cit))
|
if (!cit->hasFarPoint() && !is_infinite(cit))
|
||||||
{
|
{
|
||||||
// @todo Check if tet centre is on the processor..
|
// TODO: Check if tet centre is on the processor..
|
||||||
CGAL::Tetrahedron_3<baseK> tet
|
CGAL::Tetrahedron_3<baseK> tet
|
||||||
(
|
(
|
||||||
cit->vertex(0)->point(),
|
cit->vertex(0)->point(),
|
||||||
|
|||||||
@ -396,7 +396,7 @@ void Foam::controlMeshRefinement::initialMeshPopulation
|
|||||||
<< ", alignment difference = " << alignmentDiff << endl;
|
<< ", alignment difference = " << alignmentDiff << endl;
|
||||||
}
|
}
|
||||||
|
|
||||||
// @todo Also need to base it on the alignments
|
// TODO: Also need to base it on the alignments
|
||||||
if
|
if
|
||||||
(
|
(
|
||||||
sizeDiff/interpolatedCellSize > 0.1
|
sizeDiff/interpolatedCellSize > 0.1
|
||||||
@ -561,7 +561,7 @@ void Foam::controlMeshRefinement::initialMeshPopulation
|
|||||||
Info<< " size difference = " << sizeDiff << endl;
|
Info<< " size difference = " << sizeDiff << endl;
|
||||||
}
|
}
|
||||||
|
|
||||||
// @todo Also need to base it on the alignments
|
// TODO: Also need to base it on the alignments
|
||||||
if (sizeDiff/interpolatedCellSize > 0.1)
|
if (sizeDiff/interpolatedCellSize > 0.1)
|
||||||
{
|
{
|
||||||
insertPoint = true;
|
insertPoint = true;
|
||||||
|
|||||||
@ -104,7 +104,7 @@ bool Foam::conformalVoronoiMesh::reconformToSurface() const
|
|||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
// @todo Investigate topological tests
|
// TODO: Investigate topological tests
|
||||||
Foam::label Foam::conformalVoronoiMesh::findVerticesNearBoundaries()
|
Foam::label Foam::conformalVoronoiMesh::findVerticesNearBoundaries()
|
||||||
{
|
{
|
||||||
label countNearBoundaryVertices = 0;
|
label countNearBoundaryVertices = 0;
|
||||||
@ -1732,7 +1732,7 @@ bool Foam::conformalVoronoiMesh::nearSurfacePoint
|
|||||||
const scalar cosAngle =
|
const scalar cosAngle =
|
||||||
angleBetweenSurfacePoints(pt, closePoint.hitPoint());
|
angleBetweenSurfacePoints(pt, closePoint.hitPoint());
|
||||||
|
|
||||||
// @todo make this tolerance run-time selectable?
|
// TODO: make this tolerance run-time selectable?
|
||||||
if (cosAngle < searchAngleOppositeSurface)
|
if (cosAngle < searchAngleOppositeSurface)
|
||||||
{
|
{
|
||||||
pointIndexHit pCloseHit;
|
pointIndexHit pCloseHit;
|
||||||
|
|||||||
@ -91,7 +91,7 @@ Foam::triSurfaceMeshFeatures::features() const
|
|||||||
|
|
||||||
surfaceFeatures sFeat(surfMesh, includedAngle_);
|
surfaceFeatures sFeat(surfMesh, includedAngle_);
|
||||||
|
|
||||||
// @todo Need to read on a per region basis
|
// TODO: Need to read on a per region basis
|
||||||
boolList surfBaffleRegions
|
boolList surfBaffleRegions
|
||||||
(
|
(
|
||||||
surfMesh.patches().size(),
|
surfMesh.patches().size(),
|
||||||
|
|||||||
@ -97,7 +97,7 @@ void Foam::CV2D::insertFeaturePoints()
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Args: (base point, normal)
|
// Args: (base point, normal)
|
||||||
// @todo allow user to input this
|
// TODO: allow user to input this
|
||||||
plane zPlane(vector(0, 0, z_), vector(0, 0, 1));
|
plane zPlane(vector(0, 0, z_), vector(0, 0, 1));
|
||||||
|
|
||||||
if (debug)
|
if (debug)
|
||||||
|
|||||||
@ -375,7 +375,7 @@ triSurfacePointScalarField calcCurvature
|
|||||||
);
|
);
|
||||||
|
|
||||||
// Calculate weight
|
// Calculate weight
|
||||||
// @todo Voronoi area weighting
|
// TODO: Voronoi area weighting
|
||||||
scalar weight = calcVertexNormalWeight
|
scalar weight = calcVertexNormalWeight
|
||||||
(
|
(
|
||||||
f,
|
f,
|
||||||
|
|||||||
@ -136,13 +136,6 @@ s/^ //
|
|||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
# Remove ToDo paragraph to avoid them showing on related pages
|
|
||||||
/^To[Dd]o *$/,/^[^ ]/{
|
|
||||||
s/^To[Dd]o *$//
|
|
||||||
s/^ .*//
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/^Warning *$/,/^[^ ]/{
|
/^Warning *$/,/^[^ ]/{
|
||||||
/^Warning/c\
|
/^Warning/c\
|
||||||
\\warning
|
\\warning
|
||||||
@ -150,13 +143,6 @@ s/^ //
|
|||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
/^Deprecated *$/,/^[^ ]/{
|
|
||||||
/^Deprecated/c\
|
|
||||||
\\deprecated
|
|
||||||
s/^ //
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/^SourceFiles *$/,/^$/{
|
/^SourceFiles *$/,/^$/{
|
||||||
s?SourceFiles?\\par Source files\
|
s?SourceFiles?\\par Source files\
|
||||||
<ul><li><a href="%filePath%">%fileName%</a></li>?
|
<ul><li><a href="%filePath%">%fileName%</a></li>?
|
||||||
|
|||||||
BIN
doc/Doxygen/CFDFoundation55x55.png
Normal file
|
After Width: | Height: | Size: 496 B |
@ -32,26 +32,26 @@ DOXYFILE_ENCODING = UTF-8
|
|||||||
# title of most generated pages and in a few other places.
|
# title of most generated pages and in a few other places.
|
||||||
# The default value is: My Project.
|
# The default value is: My Project.
|
||||||
|
|
||||||
PROJECT_NAME = OpenFOAM-$(WM_PROJECT_VERSION)
|
PROJECT_NAME = OpenFOAM
|
||||||
|
|
||||||
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
|
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
|
||||||
# could be handy for archiving the generated documentation or if some version
|
# could be handy for archiving the generated documentation or if some version
|
||||||
# control system is used.
|
# control system is used.
|
||||||
|
|
||||||
PROJECT_NUMBER =
|
PROJECT_NUMBER = $(WM_PROJECT_VERSION)
|
||||||
|
|
||||||
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
||||||
# for a project that appears at the top of each page and should give viewer a
|
# for a project that appears at the top of each page and should give viewer a
|
||||||
# quick idea about the purpose of the project. Keep the description short.
|
# quick idea about the purpose of the project. Keep the description short.
|
||||||
|
|
||||||
PROJECT_BRIEF =
|
PROJECT_BRIEF = "The OpenFOAM Foundation"
|
||||||
|
|
||||||
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
|
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
|
||||||
# in the documentation. The maximum height of the logo should not exceed 55
|
# in the documentation. The maximum height of the logo should not exceed 55
|
||||||
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
|
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
|
||||||
# the logo to the output directory.
|
# the logo to the output directory.
|
||||||
|
|
||||||
PROJECT_LOGO =
|
PROJECT_LOGO = CFDFoundation55x55.png
|
||||||
|
|
||||||
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
|
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
|
||||||
# into which the generated documentation will be written. If a relative path is
|
# into which the generated documentation will be written. If a relative path is
|
||||||
@ -604,7 +604,7 @@ STRICT_PROTO_MATCHING = NO
|
|||||||
# list. This list is created by putting \todo commands in the documentation.
|
# list. This list is created by putting \todo commands in the documentation.
|
||||||
# The default value is: YES.
|
# The default value is: YES.
|
||||||
|
|
||||||
GENERATE_TODOLIST = YES
|
GENERATE_TODOLIST = NO
|
||||||
|
|
||||||
# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
|
# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
|
||||||
# list. This list is created by putting \test commands in the documentation.
|
# list. This list is created by putting \test commands in the documentation.
|
||||||
@ -765,6 +765,7 @@ WARN_LOGFILE =
|
|||||||
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
|
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
|
||||||
# Note: If this tag is empty the current directory is searched.
|
# Note: If this tag is empty the current directory is searched.
|
||||||
|
|
||||||
|
#INPUT = $(WM_PROJECT_DIR)/src/OpenFOAM/global
|
||||||
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
|
||||||
@ -1067,7 +1068,7 @@ HTML_FILE_EXTENSION = .html
|
|||||||
# of the possible markers and block names see the documentation.
|
# of the possible markers and block names see the documentation.
|
||||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||||
|
|
||||||
HTML_HEADER = $(WM_PROJECT_DIR)/doc/Doxygen/_Header
|
HTML_HEADER = header.html
|
||||||
|
|
||||||
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
|
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
|
||||||
# generated HTML page. If the tag is left blank doxygen will generate a standard
|
# generated HTML page. If the tag is left blank doxygen will generate a standard
|
||||||
@ -1077,7 +1078,7 @@ HTML_HEADER = $(WM_PROJECT_DIR)/doc/Doxygen/_Header
|
|||||||
# that doxygen normally uses.
|
# that doxygen normally uses.
|
||||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||||
|
|
||||||
HTML_FOOTER = $(WM_PROJECT_DIR)/doc/Doxygen/_Footer
|
HTML_FOOTER = footer.html
|
||||||
|
|
||||||
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
|
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
|
||||||
# sheet that is used by each HTML page. It can be used to fine-tune the look of
|
# sheet that is used by each HTML page. It can be used to fine-tune the look of
|
||||||
@ -1102,7 +1103,7 @@ HTML_STYLESHEET =
|
|||||||
# list). For an example see the documentation.
|
# list). For an example see the documentation.
|
||||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||||
|
|
||||||
HTML_EXTRA_STYLESHEET =
|
HTML_EXTRA_STYLESHEET = customdoxygen.css
|
||||||
|
|
||||||
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
|
# 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
|
# other source files which should be copied to the HTML output directory. Note
|
||||||
@ -1123,7 +1124,7 @@ HTML_EXTRA_FILES =
|
|||||||
# Minimum value: 0, maximum value: 359, default value: 220.
|
# Minimum value: 0, maximum value: 359, default value: 220.
|
||||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||||
|
|
||||||
HTML_COLORSTYLE_HUE = 220
|
HTML_COLORSTYLE_HUE = 120
|
||||||
|
|
||||||
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
|
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
|
||||||
# in the HTML output. For a value of 0 the output will use grayscales only. A
|
# in the HTML output. For a value of 0 the output will use grayscales only. A
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 1.2 KiB |
|
Before Width: | Height: | Size: 1.2 KiB |
@ -1,26 +0,0 @@
|
|||||||
Building the Doxygen help for OpenFOAM
|
|
||||||
======================================
|
|
||||||
|
|
||||||
The HTML documentation of OpenFOAM can be built using the Doxygen
|
|
||||||
software. Images in the documentation are generated using "dot", a
|
|
||||||
program within the graphviz software package. To build the
|
|
||||||
documentation on the Ubuntu Linux system, for example, the user should
|
|
||||||
install both doxygen and graphviz packages, e.g. by typing in a
|
|
||||||
terminal window:
|
|
||||||
|
|
||||||
sudo apt-get install doxygen graphviz
|
|
||||||
|
|
||||||
The Doxygen documentation will build automatically for a user that is
|
|
||||||
configured to run OpenFOAM, i.e. has environment variables such as
|
|
||||||
$WM_PROJECT_DIR set. The user must also ensure they have write
|
|
||||||
permission for the directory that Doxygen writes files to.
|
|
||||||
|
|
||||||
The Doygen configuration file, Doxyfile, in the
|
|
||||||
$WM_PROJECT_DIR/doc/Doxygen directory is configured to work with
|
|
||||||
Doxygen versions 1.6.3-1.8.5.
|
|
||||||
|
|
||||||
|
|
||||||
**Note**:
|
|
||||||
For versions of Doxygen below 1.7, the final <div> in the
|
|
||||||
_Header file (line 37) must be deleted before running Doxygen to
|
|
||||||
produce the correctly formatted HTML files.
|
|
||||||
227
doc/Doxygen/README.html
Normal file
@ -0,0 +1,227 @@
|
|||||||
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||||
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||||
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
||||||
|
<head>
|
||||||
|
<title>Building the Doxygen help for OpenFOAM</title>
|
||||||
|
<!-- 2016-06-18 Sat 10:13 -->
|
||||||
|
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||||
|
<meta name="generator" content="Org-mode" />
|
||||||
|
<style type="text/css">
|
||||||
|
<!--/*--><![CDATA[/*><!--*/
|
||||||
|
.title { text-align: center; }
|
||||||
|
.todo { font-family: monospace; color: red; }
|
||||||
|
.done { color: green; }
|
||||||
|
.tag { background-color: #eee; font-family: monospace;
|
||||||
|
padding: 2px; font-size: 80%; font-weight: normal; }
|
||||||
|
.timestamp { color: #bebebe; }
|
||||||
|
.timestamp-kwd { color: #5f9ea0; }
|
||||||
|
.right { margin-left: auto; margin-right: 0px; text-align: right; }
|
||||||
|
.left { margin-left: 0px; margin-right: auto; text-align: left; }
|
||||||
|
.center { margin-left: auto; margin-right: auto; text-align: center; }
|
||||||
|
.underline { text-decoration: underline; }
|
||||||
|
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
|
||||||
|
p.verse { margin-left: 3%; }
|
||||||
|
pre {
|
||||||
|
border: 1px solid #ccc;
|
||||||
|
box-shadow: 3px 3px 3px #eee;
|
||||||
|
padding: 8pt;
|
||||||
|
font-family: monospace;
|
||||||
|
overflow: auto;
|
||||||
|
margin: 1.2em;
|
||||||
|
}
|
||||||
|
pre.src {
|
||||||
|
position: relative;
|
||||||
|
overflow: visible;
|
||||||
|
padding-top: 1.2em;
|
||||||
|
}
|
||||||
|
pre.src:before {
|
||||||
|
display: none;
|
||||||
|
position: absolute;
|
||||||
|
background-color: white;
|
||||||
|
top: -10px;
|
||||||
|
right: 10px;
|
||||||
|
padding: 3px;
|
||||||
|
border: 1px solid black;
|
||||||
|
}
|
||||||
|
pre.src:hover:before { display: inline;}
|
||||||
|
pre.src-sh:before { content: 'sh'; }
|
||||||
|
pre.src-bash:before { content: 'sh'; }
|
||||||
|
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
|
||||||
|
pre.src-R:before { content: 'R'; }
|
||||||
|
pre.src-perl:before { content: 'Perl'; }
|
||||||
|
pre.src-java:before { content: 'Java'; }
|
||||||
|
pre.src-sql:before { content: 'SQL'; }
|
||||||
|
|
||||||
|
table { border-collapse:collapse; }
|
||||||
|
caption.t-above { caption-side: top; }
|
||||||
|
caption.t-bottom { caption-side: bottom; }
|
||||||
|
td, th { vertical-align:top; }
|
||||||
|
th.right { text-align: center; }
|
||||||
|
th.left { text-align: center; }
|
||||||
|
th.center { text-align: center; }
|
||||||
|
td.right { text-align: right; }
|
||||||
|
td.left { text-align: left; }
|
||||||
|
td.center { text-align: center; }
|
||||||
|
dt { font-weight: bold; }
|
||||||
|
.footpara:nth-child(2) { display: inline; }
|
||||||
|
.footpara { display: block; }
|
||||||
|
.footdef { margin-bottom: 1em; }
|
||||||
|
.figure { padding: 1em; }
|
||||||
|
.figure p { text-align: center; }
|
||||||
|
.inlinetask {
|
||||||
|
padding: 10px;
|
||||||
|
border: 2px solid gray;
|
||||||
|
margin: 10px;
|
||||||
|
background: #ffffcc;
|
||||||
|
}
|
||||||
|
#org-div-home-and-up
|
||||||
|
{ text-align: right; font-size: 70%; white-space: nowrap; }
|
||||||
|
textarea { overflow-x: auto; }
|
||||||
|
.linenr { font-size: smaller }
|
||||||
|
.code-highlighted { background-color: #ffff00; }
|
||||||
|
.org-info-js_info-navigation { border-style: none; }
|
||||||
|
#org-info-js_console-label
|
||||||
|
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
|
||||||
|
.org-info-js_search-highlight
|
||||||
|
{ background-color: #ffff00; color: #000000; font-weight: bold; }
|
||||||
|
/*]]>*/-->
|
||||||
|
</style>
|
||||||
|
<script type="text/javascript">
|
||||||
|
/*
|
||||||
|
@licstart The following is the entire license notice for the
|
||||||
|
JavaScript code in this tag.
|
||||||
|
|
||||||
|
Copyright (C) 2012-2013 Free Software Foundation, Inc.
|
||||||
|
|
||||||
|
The JavaScript code in this tag is free software: you can
|
||||||
|
redistribute it and/or modify it under the terms of the GNU
|
||||||
|
General Public License (GNU GPL) as published by the Free Software
|
||||||
|
Foundation, either version 3 of the License, or (at your option)
|
||||||
|
any later version. The code is distributed WITHOUT ANY WARRANTY;
|
||||||
|
without even the implied warranty of MERCHANTABILITY or FITNESS
|
||||||
|
FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
|
||||||
|
|
||||||
|
As additional permission under GNU GPL version 3 section 7, you
|
||||||
|
may distribute non-source (e.g., minimized or compacted) forms of
|
||||||
|
that code without the copy of the GNU GPL normally required by
|
||||||
|
section 4, provided you include this license notice and a URL
|
||||||
|
through which recipients can access the Corresponding Source.
|
||||||
|
|
||||||
|
|
||||||
|
@licend The above is the entire license notice
|
||||||
|
for the JavaScript code in this tag.
|
||||||
|
*/
|
||||||
|
<!--/*--><![CDATA[/*><!--*/
|
||||||
|
function CodeHighlightOn(elem, id)
|
||||||
|
{
|
||||||
|
var target = document.getElementById(id);
|
||||||
|
if(null != target) {
|
||||||
|
elem.cacheClassElem = elem.className;
|
||||||
|
elem.cacheClassTarget = target.className;
|
||||||
|
target.className = "code-highlighted";
|
||||||
|
elem.className = "code-highlighted";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
function CodeHighlightOff(elem, id)
|
||||||
|
{
|
||||||
|
var target = document.getElementById(id);
|
||||||
|
if(elem.cacheClassElem)
|
||||||
|
elem.className = elem.cacheClassElem;
|
||||||
|
if(elem.cacheClassTarget)
|
||||||
|
target.className = elem.cacheClassTarget;
|
||||||
|
}
|
||||||
|
/*]]>*///-->
|
||||||
|
</script>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="content">
|
||||||
|
<h1 class="title">Building the Doxygen help for OpenFOAM</h1>
|
||||||
|
<div id="table-of-contents">
|
||||||
|
<h2>Table of Contents</h2>
|
||||||
|
<div id="text-table-of-contents">
|
||||||
|
<ul>
|
||||||
|
<li><a href="#sec-1">1. Doxygen</a></li>
|
||||||
|
<li><a href="#sec-2">2. Configuration</a></li>
|
||||||
|
<li><a href="#sec-3">3. Running Doxygen</a></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="outline-container-sec-1" class="outline-2">
|
||||||
|
<h2 id="sec-1"><span class="section-number-2">1</span> Doxygen</h2>
|
||||||
|
<div class="outline-text-2" id="text-1">
|
||||||
|
<p>
|
||||||
|
The HTML documentation of OpenFOAM can be built using the Doxygen software.
|
||||||
|
Images in the documentation are generated using "dot", a program within the
|
||||||
|
graphviz software package. To build the documentation on the Ubuntu GNU/Linux
|
||||||
|
system, for example, the user should install both <code>doxygen</code> and <code>graphviz</code>
|
||||||
|
packages, e.g. by typing in a terminal window:
|
||||||
|
</p>
|
||||||
|
<ul class="org-ul">
|
||||||
|
<li><code>sudo apt-get install doxygen graphviz</code>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
The Doxygen documentation will build automatically for a user that is
|
||||||
|
configured to run OpenFOAM, i.e. has environment variables such as
|
||||||
|
<code>$WM_PROJECT_DIR</code> set. The user must also ensure they have write
|
||||||
|
permission for the directory that Doxygen writes files to.
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="outline-container-sec-2" class="outline-2">
|
||||||
|
<h2 id="sec-2"><span class="section-number-2">2</span> Configuration</h2>
|
||||||
|
<div class="outline-text-2" id="text-2">
|
||||||
|
<p>
|
||||||
|
The Doygen configuration file, Doxyfile, in the <code>$WM_PROJECT_DIR/doc/Doxygen</code>
|
||||||
|
directory is configured to work with Doxygen versions 1.6.3-1.8.5.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
The Header, Footer, and Stylesheet are generated automatically:
|
||||||
|
</p>
|
||||||
|
<ul class="org-ul">
|
||||||
|
<li><code>doxygen -w html header.html footer.html customdoxygen.css</code>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
See: <a href="https://www.stack.nl/~dimitri/doxygen/manual/customize.html">https://www.stack.nl/~dimitri/doxygen/manual/customize.html</a>
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="outline-container-sec-3" class="outline-2">
|
||||||
|
<h2 id="sec-3"><span class="section-number-2">3</span> Running Doxygen</h2>
|
||||||
|
<div class="outline-text-2" id="text-3">
|
||||||
|
<p>
|
||||||
|
In the <code>$WM_PROJECT_DIR/doc/Doxygen</code> directory type
|
||||||
|
</p>
|
||||||
|
<ul class="org-ul">
|
||||||
|
<li><code>./Allwmake</code>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
which will generate the <code>$WM_PROJECT_DIR/doc/Doxygen/html</code> directory
|
||||||
|
containing the OpenFOAM source code documentation. Load the <code>index.html</code> file
|
||||||
|
into a browser, <i>e.g.</i>
|
||||||
|
</p>
|
||||||
|
<ul class="org-ul">
|
||||||
|
<li><code>firefox $WM_PROJECT_DIR/doc/Doxygen/html/index.html</code>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="postamble" class="status">
|
||||||
|
<p class="date">Date: 18th June 2016</p>
|
||||||
|
<p class="date">Created: 2016-06-18 Sat 10:13</p>
|
||||||
|
<p class="creator"><a href="http://www.gnu.org/software/emacs/">Emacs</a> 24.5 (<a href="http://orgmode.org">Org</a> mode 8.2.10)</p>
|
||||||
|
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
41
doc/Doxygen/README.org
Normal file
@ -0,0 +1,41 @@
|
|||||||
|
# -*- mode: org; -*-
|
||||||
|
#
|
||||||
|
#+TITLE: Building the Doxygen help for OpenFOAM
|
||||||
|
#+AUTHOR: The OpenFOAM Foundation
|
||||||
|
#+DATE: 18th June 2016
|
||||||
|
#+LINK: http://www.openfoam.org
|
||||||
|
#+OPTIONS: author:nil ^:{}
|
||||||
|
# Copyright (c) 2015-2016 OpenFOAM Foundation.
|
||||||
|
|
||||||
|
* Doxygen
|
||||||
|
The HTML documentation of OpenFOAM can be built using the Doxygen software.
|
||||||
|
Images in the documentation are generated using "dot", a program within the
|
||||||
|
graphviz software package. To build the documentation on the Ubuntu GNU/Linux
|
||||||
|
system, for example, the user should install both =doxygen= and =graphviz=
|
||||||
|
packages, e.g. by typing in a terminal window:
|
||||||
|
|
||||||
|
+ =sudo apt-get install doxygen graphviz=
|
||||||
|
|
||||||
|
The Doxygen documentation will build automatically for a user that is
|
||||||
|
configured to run OpenFOAM, i.e. has environment variables such as
|
||||||
|
=$WM_PROJECT_DIR= set. The user must also ensure they have write
|
||||||
|
permission for the directory that Doxygen writes files to.
|
||||||
|
|
||||||
|
* Configuration
|
||||||
|
The Doygen configuration file, Doxyfile, in the =$WM_PROJECT_DIR/doc/Doxygen=
|
||||||
|
directory is configured to work with Doxygen versions 1.6.3-1.8.5.
|
||||||
|
|
||||||
|
The Header, Footer, and Stylesheet are generated automatically:
|
||||||
|
|
||||||
|
+ =doxygen -w html header.html footer.html customdoxygen.css=
|
||||||
|
|
||||||
|
See: https://www.stack.nl/~dimitri/doxygen/manual/customize.html
|
||||||
|
|
||||||
|
* Running Doxygen
|
||||||
|
In the =$WM_PROJECT_DIR/doc/Doxygen= directory type
|
||||||
|
+ =./Allwmake=
|
||||||
|
|
||||||
|
which will generate the =$WM_PROJECT_DIR/doc/Doxygen/html= directory
|
||||||
|
containing the OpenFOAM source code documentation. Load the =index.html= file
|
||||||
|
into a browser, \e.g.\
|
||||||
|
+ =firefox html/index.html=
|
||||||
@ -1,22 +0,0 @@
|
|||||||
<!-- end of doxygen-generated content -->
|
|
||||||
</div> <!-- main -->
|
|
||||||
<div class="footer">
|
|
||||||
<p>
|
|
||||||
Copyright © 2011-2016
|
|
||||||
<a href="http://www.openfoam.org">OpenFOAM Foundation</a>
|
|
||||||
|
|
|
||||||
OPENFOAM® is a 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>
|
|
||||||
</p>
|
|
||||||
</div> <!-- footer -->
|
|
||||||
</div> <!-- page-container -->
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@ -1,44 +0,0 @@
|
|||||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
||||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
||||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
||||||
<head>
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
|
||||||
<title> OpenFOAM® Programmer's C++ documentation </title>
|
|
||||||
<!-- links -->
|
|
||||||
<link href="../OpenFOAMdocIcon.png" rel="icon" type="image/png" />
|
|
||||||
<link href="search/search.css" rel="stylesheet" type="text/css" />
|
|
||||||
<link href="../css/openfoam.css" rel="stylesheet" type="text/css" />
|
|
||||||
<script type="text/javaScript" src="search/searchdata.js"></script>
|
|
||||||
<script type="text/javaScript" src="search/search.js"></script>
|
|
||||||
<script type="text/javascript" src="jquery.js"></script>
|
|
||||||
<script type="text/javascript" src="dynsections.js"></script>
|
|
||||||
<script type="text/javascript">
|
|
||||||
$(document).ready(function() { init_search(); });
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<!-- meta info -->
|
|
||||||
<meta
|
|
||||||
name="keywords"
|
|
||||||
content="computational fluid dynamics, CFD, OpenFOAM, open source CFD, open source"
|
|
||||||
/>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<div class="page-container">
|
|
||||||
<div class="header">
|
|
||||||
<div class="header-top">
|
|
||||||
<a class="sitelogo" href="http://www.openfoam.org" 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">OpenFOAM C++ Documentation
|
|
||||||
</a>
|
|
||||||
</h1>
|
|
||||||
</div>
|
|
||||||
</div> <!-- header-top -->
|
|
||||||
</div> <!-- header -->
|
|
||||||
|
|
||||||
<div class="main">
|
|
||||||
<div>
|
|
||||||
<!-- begin of doxygen-generated content -->
|
|
||||||
@ -1,349 +0,0 @@
|
|||||||
/* OpenFOAM layout styles */
|
|
||||||
|
|
||||||
* {
|
|
||||||
padding: 0;
|
|
||||||
margin: 0;
|
|
||||||
font-family: Arial, sans-serif;
|
|
||||||
}
|
|
||||||
|
|
||||||
body {
|
|
||||||
background-color: #ffffff;
|
|
||||||
font-size: 62.5%;
|
|
||||||
} /*Font-size: 1.0em = 10px when browser default size is 16px*/
|
|
||||||
|
|
||||||
/* Using the same as the code/verbatim blocks in doxygen.css */
|
|
||||||
code {
|
|
||||||
font-family: "Courier New", Courier, monospace, fixed;
|
|
||||||
}
|
|
||||||
|
|
||||||
p:after {
|
|
||||||
content:".";
|
|
||||||
display:block;
|
|
||||||
height:0;
|
|
||||||
/* clear:both */;
|
|
||||||
visibility:hidden;
|
|
||||||
}
|
|
||||||
|
|
||||||
.clear-contentunit {
|
|
||||||
clear:both;
|
|
||||||
width:100%;
|
|
||||||
height:0.1em;
|
|
||||||
border:none;
|
|
||||||
background:rgb(210,210,210);
|
|
||||||
color:rgb(210,210,210);
|
|
||||||
}
|
|
||||||
|
|
||||||
/* page-container **************************************/
|
|
||||||
|
|
||||||
.page-container {
|
|
||||||
width:100%;
|
|
||||||
margin:0px auto;
|
|
||||||
margin-top:10px;
|
|
||||||
margin-bottom:10px;
|
|
||||||
font-size:1.0em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.page-container:after,
|
|
||||||
.header:after,
|
|
||||||
.header-bottom:after,
|
|
||||||
.header-breadcrumbs:after,
|
|
||||||
.main:after,
|
|
||||||
.main-navigation:after,
|
|
||||||
.main-content:after,
|
|
||||||
.main-content div:after,
|
|
||||||
.main-subcontent:after
|
|
||||||
{
|
|
||||||
content:".";
|
|
||||||
display:block;
|
|
||||||
height:0;
|
|
||||||
clear:both;
|
|
||||||
visibility:hidden;
|
|
||||||
}
|
|
||||||
|
|
||||||
/*Font-size: 1.0em = 12px when browser default size is 16px*/
|
|
||||||
.main
|
|
||||||
{
|
|
||||||
font-size: 120%;
|
|
||||||
}
|
|
||||||
|
|
||||||
/*********************header***************************************************/
|
|
||||||
.header {
|
|
||||||
width:100%;
|
|
||||||
}
|
|
||||||
|
|
||||||
.header-top {
|
|
||||||
height:80px;
|
|
||||||
border:3px solid rgb(175,175,175);
|
|
||||||
border-bottom-width: 0;
|
|
||||||
margin-top:10px;
|
|
||||||
background:#e1f0e1;
|
|
||||||
overflow:visible !important /*Firefox*/;
|
|
||||||
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);
|
|
||||||
}
|
|
||||||
|
|
||||||
/********************sitelogo *************************************************/
|
|
||||||
.sitelogo {
|
|
||||||
width:100%;
|
|
||||||
height:40px;
|
|
||||||
position:absolute;
|
|
||||||
z-index:1;
|
|
||||||
margin:20px 0 0 15px;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**************************sitename ************************************************/
|
|
||||||
.sitename {
|
|
||||||
width:400px;
|
|
||||||
height:45px;
|
|
||||||
margin:auto;
|
|
||||||
margin-top:25px;
|
|
||||||
overflow:visible !important /*Firefox*/;
|
|
||||||
overflow:hidden /*IE6*/;
|
|
||||||
}
|
|
||||||
|
|
||||||
.sitename h1 {
|
|
||||||
font-weight:normal;
|
|
||||||
font-size:240%;
|
|
||||||
}
|
|
||||||
|
|
||||||
.sitename h2 {
|
|
||||||
margin:-2px 0 0 0;
|
|
||||||
color:rgb(125,125,125);
|
|
||||||
font-weight:normal;
|
|
||||||
font-size:100%;
|
|
||||||
}
|
|
||||||
.sitename a {
|
|
||||||
text-decoration:none;
|
|
||||||
color:rgb(125,125,125);
|
|
||||||
color:#333;
|
|
||||||
}
|
|
||||||
.sitename a:hover {
|
|
||||||
text-decoration:none;
|
|
||||||
color:rgb(125,125,125);
|
|
||||||
}
|
|
||||||
|
|
||||||
/*****************header-breadcrumbs ***************************************/
|
|
||||||
.header-breadcrumbs {
|
|
||||||
clear:both;
|
|
||||||
width:100%;
|
|
||||||
padding:1.0em 0 1.5em 0;
|
|
||||||
border-left:3px solid rgb(175,175,175);
|
|
||||||
border-right:0px solid rgb(175,175,175);
|
|
||||||
}
|
|
||||||
|
|
||||||
.header-breadcrumbs ul {
|
|
||||||
float:left;
|
|
||||||
width:560px;
|
|
||||||
list-style:none;
|
|
||||||
padding:7px 0 0 3px;
|
|
||||||
font-family:verdana,arial,sans-serif;
|
|
||||||
}
|
|
||||||
|
|
||||||
.header-breadcrumbs ul li {
|
|
||||||
display:inline;
|
|
||||||
padding:0 0 0 5px;
|
|
||||||
color:#323232;
|
|
||||||
font-size:100%;
|
|
||||||
}
|
|
||||||
|
|
||||||
.header-breadcrumbs ul a {
|
|
||||||
color:rgb(70,122,167);
|
|
||||||
text-decoration:none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.header-breadcrumbs ul a:hover {
|
|
||||||
color:rgb(42,90,138);
|
|
||||||
color:#333;
|
|
||||||
text-decoration:underline;
|
|
||||||
}
|
|
||||||
.header-breadcrumbs .searchform {
|
|
||||||
float:right;
|
|
||||||
width:285px;
|
|
||||||
padding:0 17px 0px 0px !important /*Non-IE6*/;
|
|
||||||
padding:0 12px 0px 0px /*IE6*/;
|
|
||||||
}
|
|
||||||
.header-breadcrumbs .searchform form fieldset {
|
|
||||||
float:right;
|
|
||||||
border:none;
|
|
||||||
}
|
|
||||||
.header-breadcrumbs .searchform input.field {
|
|
||||||
width:10.0em;
|
|
||||||
padding:0.2em 0 0.2em 0;
|
|
||||||
border:1px solid rgb(200,200,200);
|
|
||||||
font-family:verdana,arial,sans-serif;
|
|
||||||
font-size:120%;
|
|
||||||
}
|
|
||||||
.header-breadcrumbs .searchform input.button {
|
|
||||||
width:3.0em;
|
|
||||||
padding:1px !important /*Non-IE6*/;
|
|
||||||
padding:0 /*IE6*/;
|
|
||||||
background:rgb(230,230,230);
|
|
||||||
border:solid 1px rgb(150,150,150);
|
|
||||||
text-align:center;
|
|
||||||
font-family:verdana,arial,sans-serif;
|
|
||||||
color:rgb(150,150,150);
|
|
||||||
font-size:120%;
|
|
||||||
}
|
|
||||||
.header-breadcrumbs .searchform input.button:hover {
|
|
||||||
cursor:pointer;
|
|
||||||
border:solid 1px rgb(80,80,80);
|
|
||||||
background:rgb(220,220,220);
|
|
||||||
color:rgb(80,80,80);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/******************footer ************************************************/
|
|
||||||
.footer {
|
|
||||||
clear:both;
|
|
||||||
padding:1.0em 1.0em 1.0em 1.0em;
|
|
||||||
border:3px solid rgb(175,175,175);
|
|
||||||
background:rgb(225,225,225);
|
|
||||||
font-size:1.0em;
|
|
||||||
overflow:visible !important /*Firefox*/;
|
|
||||||
overflow:hidden /*IE6*/;
|
|
||||||
}
|
|
||||||
.footer p {
|
|
||||||
line-height:1.3em;
|
|
||||||
text-align:center;
|
|
||||||
color:rgb(125,125,125);
|
|
||||||
font-weight:bold;
|
|
||||||
font-size:110%;
|
|
||||||
}
|
|
||||||
.footer p.credits {
|
|
||||||
font-weight:normal;
|
|
||||||
}
|
|
||||||
.footer a {
|
|
||||||
text-decoration:underline;
|
|
||||||
color:rgb(125,125,125);
|
|
||||||
}
|
|
||||||
.footer a:hover {
|
|
||||||
text-decoration:none;
|
|
||||||
color:rgb(0,0,0);
|
|
||||||
}
|
|
||||||
/*
|
|
||||||
.footer a:visited {
|
|
||||||
color:rgb(0,0,0);
|
|
||||||
}
|
|
||||||
*/
|
|
||||||
.footer:after {
|
|
||||||
content:".";
|
|
||||||
display:block;
|
|
||||||
height:0;
|
|
||||||
clear:both;
|
|
||||||
visibility:hidden;
|
|
||||||
}
|
|
||||||
|
|
||||||
/*******************main **********************************************/
|
|
||||||
.main {
|
|
||||||
clear:both;
|
|
||||||
width:100% minus 2px;
|
|
||||||
padding-bottom:30px;
|
|
||||||
border-left: 3px solid rgb(175,175,175);
|
|
||||||
border-right:3px solid rgb(175,175,175);
|
|
||||||
background:transparent;
|
|
||||||
}
|
|
||||||
.main img {
|
|
||||||
clear:both;
|
|
||||||
margin:3px 10px 7px 0;
|
|
||||||
padding:1px;
|
|
||||||
}
|
|
||||||
.main img.center {
|
|
||||||
clear:both;
|
|
||||||
float:none;
|
|
||||||
display:block;
|
|
||||||
margin:0 auto;
|
|
||||||
padding:1px;
|
|
||||||
}
|
|
||||||
.main img.right {
|
|
||||||
clear:both;
|
|
||||||
float:right;
|
|
||||||
margin:3px 0 7px 10px;
|
|
||||||
padding:1px;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.contents a {
|
|
||||||
color:rgb(85,144,112);
|
|
||||||
font-weight:bold;
|
|
||||||
text-decoration:none;
|
|
||||||
}
|
|
||||||
div.contents a:hover {
|
|
||||||
color:rgb(56,94,73);
|
|
||||||
text-decoration:underline;
|
|
||||||
}
|
|
||||||
/*
|
|
||||||
.main a:visited {
|
|
||||||
color:rgb(42,90,138);
|
|
||||||
}
|
|
||||||
*/
|
|
||||||
|
|
||||||
.main a img {
|
|
||||||
border:solid 1px rgb(150,150,150);
|
|
||||||
}
|
|
||||||
.main a:hover img {
|
|
||||||
border:solid 1px rgb(220,220,220);
|
|
||||||
}
|
|
||||||
|
|
||||||
/********************************/
|
|
||||||
/* PRINTING and MISCELLANEOUS */
|
|
||||||
/********************************/
|
|
||||||
@media print {
|
|
||||||
|
|
||||||
.header-top {
|
|
||||||
width:100%;
|
|
||||||
height:80px;
|
|
||||||
background:rgb(240,240,240);
|
|
||||||
overflow:visible !important /*Firefox*/;
|
|
||||||
overflow:hidden /*IE6*/;
|
|
||||||
}
|
|
||||||
.header-breadcrumbs {
|
|
||||||
width:100%;
|
|
||||||
background:transparent;
|
|
||||||
}
|
|
||||||
.nav2 {
|
|
||||||
float:left;
|
|
||||||
width:100%;
|
|
||||||
border:none;
|
|
||||||
background:rgb(240,240,240);
|
|
||||||
color:rgb(75,75,75);
|
|
||||||
font-size:1.0em;
|
|
||||||
font-size:130%;
|
|
||||||
} /*Color navigation bar normal mode*/
|
|
||||||
.main {
|
|
||||||
clear:both;
|
|
||||||
width:100%;
|
|
||||||
padding-bottom:30px;
|
|
||||||
background:transparent;
|
|
||||||
}
|
|
||||||
.main-navigation {
|
|
||||||
display:inline /*Fix IE floating margin bug*/;
|
|
||||||
float:left;
|
|
||||||
width:199px;
|
|
||||||
border-right:1px solid rgb(200,200,200);
|
|
||||||
border-bottom:1px solid rgb(200,200,200);
|
|
||||||
background-color:rgb(240,240,240);
|
|
||||||
overflow:visible !important /*Firefox*/;
|
|
||||||
overflow:hidden /*IE*/;
|
|
||||||
}
|
|
||||||
.footer {
|
|
||||||
clear:both;
|
|
||||||
width:100%;
|
|
||||||
height:3.7em;
|
|
||||||
padding:1.1em 0 0;
|
|
||||||
background:rgb(240,240,240);
|
|
||||||
font-size:1.0em;
|
|
||||||
overflow:visible !important /*Firefox*/;
|
|
||||||
overflow:hidden /*IE6*/;
|
|
||||||
}
|
|
||||||
div.crosslinks {
|
|
||||||
visibility:hidden;
|
|
||||||
}
|
|
||||||
|
|
||||||
} /* end media print */
|
|
||||||
@ -1,572 +0,0 @@
|
|||||||
/* Naviation Styles */
|
|
||||||
.nav0
|
|
||||||
{
|
|
||||||
width:350px;
|
|
||||||
position:absolute;
|
|
||||||
z-index:2;
|
|
||||||
margin:25px 0 0 0;
|
|
||||||
margin-left:610px !important /*Non-IE6*/;
|
|
||||||
margin-left:613px /*IE6*/;
|
|
||||||
}
|
|
||||||
.nav0 ul
|
|
||||||
{
|
|
||||||
float:right;
|
|
||||||
padding:0 20px 0 0;
|
|
||||||
}
|
|
||||||
.nav0 li
|
|
||||||
{
|
|
||||||
display:inline;
|
|
||||||
list-style:none;
|
|
||||||
}
|
|
||||||
.nav0 li a
|
|
||||||
{
|
|
||||||
padding:0 0 0 3px;
|
|
||||||
}
|
|
||||||
.nav0 a:hover
|
|
||||||
{
|
|
||||||
text-decoration:none;
|
|
||||||
}
|
|
||||||
.nav0 a img
|
|
||||||
{
|
|
||||||
height:20px;
|
|
||||||
border:none;
|
|
||||||
}
|
|
||||||
.nav1
|
|
||||||
{
|
|
||||||
width:350px;
|
|
||||||
position:absolute;
|
|
||||||
z-index:3;
|
|
||||||
margin:55px 0 0 610px;
|
|
||||||
}
|
|
||||||
.nav1 ul
|
|
||||||
{
|
|
||||||
float:right;
|
|
||||||
padding:0 15px 0 0;
|
|
||||||
font-weight:normal;
|
|
||||||
}
|
|
||||||
.nav1 li
|
|
||||||
{
|
|
||||||
display:inline;
|
|
||||||
list-style:none;
|
|
||||||
}
|
|
||||||
.nav1 li a
|
|
||||||
{
|
|
||||||
display:block;
|
|
||||||
float:left;
|
|
||||||
padding:2px 5px 2px 5px;
|
|
||||||
color:rgb(125,125,125);
|
|
||||||
text-decoration:none;
|
|
||||||
font-size:110%;
|
|
||||||
}
|
|
||||||
.nav1 a:hover
|
|
||||||
{
|
|
||||||
text-decoration:none;
|
|
||||||
color:rgb(50,50,50);
|
|
||||||
}
|
|
||||||
.nav1_ln
|
|
||||||
{
|
|
||||||
float:right;
|
|
||||||
height:2.1em;
|
|
||||||
width:300px;
|
|
||||||
}
|
|
||||||
.nav1_ln ul
|
|
||||||
{
|
|
||||||
float:right;
|
|
||||||
padding:7px 15px 0 0;
|
|
||||||
font-weight:normal;
|
|
||||||
}
|
|
||||||
.nav1_ln li
|
|
||||||
{
|
|
||||||
display:inline;
|
|
||||||
list-style:none;
|
|
||||||
}
|
|
||||||
.nav1_ln li a
|
|
||||||
{
|
|
||||||
display:block;
|
|
||||||
float:left;
|
|
||||||
padding:2px 5px 2px 5px;
|
|
||||||
color:rgb(125,125,125);
|
|
||||||
text-decoration:none;
|
|
||||||
font-size:110%;
|
|
||||||
}
|
|
||||||
.nav1_ln a:hover
|
|
||||||
{
|
|
||||||
text-decoration:none;
|
|
||||||
color:rgb(50,50,50);
|
|
||||||
}
|
|
||||||
.nav2
|
|
||||||
{
|
|
||||||
white-space:nowrap /*IE hack*/;
|
|
||||||
float:left;
|
|
||||||
width:100%;
|
|
||||||
background:rgb(225,225,225);
|
|
||||||
color:rgb(100,100,100);
|
|
||||||
font-size:130%;
|
|
||||||
height:2.1em;
|
|
||||||
} /*Color navigation bar normal mode*/
|
|
||||||
.nav2 ul
|
|
||||||
{
|
|
||||||
list-style-type:none;
|
|
||||||
}
|
|
||||||
.nav2 ul li
|
|
||||||
{
|
|
||||||
float:left;
|
|
||||||
z-index:auto !important /*Non-IE6*/;
|
|
||||||
z-index:1000 /*IE6*/;
|
|
||||||
border-right:solid 1px rgb(175,175,175);
|
|
||||||
}
|
|
||||||
.nav2 ul li a
|
|
||||||
{
|
|
||||||
float:none !important /*Non-IE6*/;
|
|
||||||
float:left /*IE-6*/;
|
|
||||||
display:block;
|
|
||||||
height:2.1em;
|
|
||||||
line-height:2.1em;
|
|
||||||
padding:0 16px 0 16px;
|
|
||||||
text-decoration:none;
|
|
||||||
font-weight:normal;
|
|
||||||
color: rgb(100,100,100);
|
|
||||||
color:#333;
|
|
||||||
}
|
|
||||||
.nav2 ul li ul
|
|
||||||
{
|
|
||||||
display:none;
|
|
||||||
border:none;
|
|
||||||
}
|
|
||||||
.nav2 ul li:hover
|
|
||||||
{
|
|
||||||
position:relative;
|
|
||||||
} /*Sylvain IE hack*/
|
|
||||||
.nav2 ul li:hover a
|
|
||||||
{
|
|
||||||
background-color:rgb(215,215,215);
|
|
||||||
text-decoration:none;
|
|
||||||
} /*Color main cells hovering mode*/
|
|
||||||
.nav2 ul li:hover ul
|
|
||||||
{
|
|
||||||
display:block;
|
|
||||||
width:12.0em;
|
|
||||||
position:absolute;
|
|
||||||
z-index:999;
|
|
||||||
top:2.0em;
|
|
||||||
margin-top:0.1em;
|
|
||||||
left:0;
|
|
||||||
}
|
|
||||||
.nav2 ul li:hover ul li a
|
|
||||||
{
|
|
||||||
white-space:normal;
|
|
||||||
display:block;
|
|
||||||
width:12.0em;
|
|
||||||
height:auto;
|
|
||||||
line-height:1.3em;
|
|
||||||
margin-left:-1px;
|
|
||||||
padding:4px 16px 4px 16px;
|
|
||||||
border-left:solid 1px rgb(175,175,175);
|
|
||||||
border-bottom: solid 1px rgb(175,175,175);
|
|
||||||
background-color:rgb(240,240,240);
|
|
||||||
font-weight:normal;
|
|
||||||
color:rgb(100,100,100);
|
|
||||||
color:#333;
|
|
||||||
} /*Color subcells normal mode*/
|
|
||||||
.nav2 ul li:hover ul li a:hover
|
|
||||||
{
|
|
||||||
background-color:rgb(215,215,215);
|
|
||||||
text-decoration:none;
|
|
||||||
} /*Color subcells hovering mode*/
|
|
||||||
.nav2 table
|
|
||||||
{
|
|
||||||
position:absolute;
|
|
||||||
top:0;
|
|
||||||
left:-1px;
|
|
||||||
border-collapse:collapse;
|
|
||||||
}
|
|
||||||
.nav2 ul li a:hover
|
|
||||||
{
|
|
||||||
position:relative /*Sylvain IE hack*/;
|
|
||||||
z-index:1000 /*Sylvain IE hack*/;
|
|
||||||
background-color:rgb(215,215,215);
|
|
||||||
text-decoration:none;
|
|
||||||
} /*Color main cells hovering mode*/
|
|
||||||
.nav2 ul li a:hover ul
|
|
||||||
{
|
|
||||||
display:block;
|
|
||||||
width:12.0em;
|
|
||||||
position:absolute;
|
|
||||||
z-index:999;
|
|
||||||
top:2.1em;
|
|
||||||
t\op:2.0em;
|
|
||||||
left:0;
|
|
||||||
marg\in-top:0.1em;
|
|
||||||
}
|
|
||||||
.nav2 ul li a:hover ul li a
|
|
||||||
{
|
|
||||||
white-space:normal;
|
|
||||||
display:block;
|
|
||||||
w\idth:12.0em;
|
|
||||||
height:1px;
|
|
||||||
line-height:1.3em;
|
|
||||||
padding:4px 16px 4px 16px;
|
|
||||||
border-left:solid 1px rgb(175,175,175);
|
|
||||||
border-bottom: solid 1px rgb(175,175,175);
|
|
||||||
background-color:rgb(240,240,240);
|
|
||||||
font-weight:normal;
|
|
||||||
color:rgb(50,50,50);
|
|
||||||
} /*Color subcells normal mode*/
|
|
||||||
.nav2 ul li a:hover ul li a:hover
|
|
||||||
{
|
|
||||||
background-color:rgb(215,215,215);
|
|
||||||
text-decoration:none;
|
|
||||||
} /*Color subcells hovering mode*/
|
|
||||||
|
|
||||||
/*nav3-grid ****************************************/
|
|
||||||
.nav3-grid
|
|
||||||
{
|
|
||||||
width:199px;
|
|
||||||
border-bottom:solid 1px rgb(200,200,200);
|
|
||||||
}
|
|
||||||
.nav3-grid dt a, .nav3-grid dt a:visited
|
|
||||||
{
|
|
||||||
display:block;
|
|
||||||
min-height:2.0em /*Non-IE6*/;
|
|
||||||
height:auto !important;
|
|
||||||
height:2.0em /*IE6*/;
|
|
||||||
line-height:2.0em;
|
|
||||||
padding:0px 10px 0px 20px;
|
|
||||||
border-top: solid 1px rgb(200,200,200);
|
|
||||||
text-decoration:none;
|
|
||||||
color:rgb(70,122,167);
|
|
||||||
font-weight:bold;
|
|
||||||
font-size:100%;
|
|
||||||
}
|
|
||||||
.nav3-grid dd a, .nav3-grid dd a:visited
|
|
||||||
{
|
|
||||||
display:block;
|
|
||||||
min-height:1.7em /*Non-IE6*/;
|
|
||||||
height:auto !important;
|
|
||||||
height:1.7em /*IE6*/;
|
|
||||||
line-height:1.7em;
|
|
||||||
padding:0px 10px 0px 40px;
|
|
||||||
border:none;
|
|
||||||
font-weight:normal;
|
|
||||||
text-decoration:none;
|
|
||||||
color:rgb(70,122,167);
|
|
||||||
font-size:100%;
|
|
||||||
}
|
|
||||||
.nav3-grid dt a:hover, .nav3-grid dd a:hover
|
|
||||||
{
|
|
||||||
background-color:rgb(225,225,225);
|
|
||||||
color:rgb(42,90,138);
|
|
||||||
text-decoration:none;
|
|
||||||
}
|
|
||||||
|
|
||||||
/*nav3-nobullet *********************/
|
|
||||||
nav3-bullet
|
|
||||||
{
|
|
||||||
width:170px;
|
|
||||||
margin:10px 0 0 20px;
|
|
||||||
}
|
|
||||||
.nav3-bullet dt a, .nav3-bullet dt a:visited
|
|
||||||
{
|
|
||||||
line-height:2.0em;
|
|
||||||
padding:0 0 0 10px;
|
|
||||||
background:url(img/bg_bullet_full_1.gif) no-repeat 0px 50%;
|
|
||||||
text-decoration:none;
|
|
||||||
color:rgb(56,94,73);
|
|
||||||
font-weight:bold;
|
|
||||||
font-size:120%;
|
|
||||||
}
|
|
||||||
.nav3-bullet dd a, .nav3-bullet dd a:visited
|
|
||||||
{
|
|
||||||
line-height:1.7em;
|
|
||||||
margin:0 0 0 15px;
|
|
||||||
padding:0 0 0 10px;
|
|
||||||
background:url(img/bg_bullet_half_1.gif) no-repeat 0px 50%;
|
|
||||||
text-decoration:none;
|
|
||||||
color:rgb(56,94,73);
|
|
||||||
font-weight:normal;
|
|
||||||
font-size:120%;
|
|
||||||
}
|
|
||||||
.nav3-bullet dt a:hover
|
|
||||||
{
|
|
||||||
background:url(img/bg_bullet_full_2.gif) no-repeat 0px 50%;
|
|
||||||
text-decoration:underline;
|
|
||||||
color:rgb(42,90,138);
|
|
||||||
}
|
|
||||||
.nav3-bullet dd a:hover
|
|
||||||
{
|
|
||||||
background:url(img/bg_bullet_half_2.gif) no-repeat 0px 50%;
|
|
||||||
text-decoration:underline;
|
|
||||||
color:rgb(42,90,138);
|
|
||||||
}
|
|
||||||
.nav3-nobullet
|
|
||||||
{
|
|
||||||
width:170px;
|
|
||||||
margin:10px 0 0 20px;
|
|
||||||
}
|
|
||||||
.nav3-nobullet dt a, .nav3-nobullet dt a:visited
|
|
||||||
{
|
|
||||||
line-height:2.0em;
|
|
||||||
text-decoration:none;
|
|
||||||
color:rgb(70,122,167);
|
|
||||||
font-weight:bold;
|
|
||||||
font-size:120%;
|
|
||||||
}
|
|
||||||
.nav3-nobullet dd a, .nav3-nobullet dd a:visited
|
|
||||||
{
|
|
||||||
line-height:1.7em;
|
|
||||||
margin:0 0 0 15px;
|
|
||||||
text-decoration:none;
|
|
||||||
color:rgb(70,122,167);
|
|
||||||
font-weight:normal;
|
|
||||||
font-size:120%;
|
|
||||||
}
|
|
||||||
.nav3-nobullet dt a:hover, .nav3-nobullet dd a:hover
|
|
||||||
{
|
|
||||||
text-decoration:underline;
|
|
||||||
color:rgb(42,90,138);
|
|
||||||
}
|
|
||||||
|
|
||||||
div.navpath, div.summary
|
|
||||||
{
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
/*main-navigation ************************************************/
|
|
||||||
.main-navigation .loginform
|
|
||||||
{
|
|
||||||
width:160px;
|
|
||||||
margin:-10px 20px 0 20px;
|
|
||||||
}
|
|
||||||
.main-navigation .loginform p
|
|
||||||
{
|
|
||||||
clear:both;
|
|
||||||
margin:0;
|
|
||||||
padding:0;
|
|
||||||
}
|
|
||||||
.main-navigation .loginform fieldset
|
|
||||||
{
|
|
||||||
width:160px;
|
|
||||||
border:none;
|
|
||||||
}
|
|
||||||
.main-navigation .loginform label.top
|
|
||||||
{
|
|
||||||
float:left;
|
|
||||||
width:125px;
|
|
||||||
margin:0 0 2px 0;
|
|
||||||
font-size:110%;
|
|
||||||
}
|
|
||||||
.main-navigation .loginform label.right
|
|
||||||
{
|
|
||||||
float:left;
|
|
||||||
width:125px;
|
|
||||||
margin:5px 0 0 0;
|
|
||||||
padding:0 0 0 3px;
|
|
||||||
/*IE6*/;
|
|
||||||
font-size:110%;
|
|
||||||
}
|
|
||||||
.main-navigation .loginform input.field
|
|
||||||
{
|
|
||||||
width:158px;
|
|
||||||
margin:0 0 5px 0;
|
|
||||||
padding:0.1em 0 0.2em 0 !important /*Non-IE6*/;
|
|
||||||
padding:0.2em 0 0.3em 0 /*IE6*/;
|
|
||||||
border:solid 1px rgb(200,200,200);
|
|
||||||
font-family:verdana,arial,sans-serif;
|
|
||||||
font-size:110%;
|
|
||||||
}
|
|
||||||
.main-navigation .loginform input.checkbox
|
|
||||||
{
|
|
||||||
float:left;
|
|
||||||
margin:5px 0 0 0 !important /*Non-IE6*/;
|
|
||||||
margin:2px 0 0 -3px /*IE6*/;
|
|
||||||
border:none;
|
|
||||||
}
|
|
||||||
.main-navigation .loginform input.button
|
|
||||||
{
|
|
||||||
float:left;
|
|
||||||
width:5.0em;
|
|
||||||
margin:10px 0 5px 0;
|
|
||||||
padding:1px;
|
|
||||||
background:rgb(230,230,230);
|
|
||||||
border:solid 1px rgb(150,150,150);
|
|
||||||
text-align:center;
|
|
||||||
font-family:verdana,arial,sans-serif;
|
|
||||||
color:rgb(150,150,150);
|
|
||||||
font-size:110%;
|
|
||||||
}
|
|
||||||
.main-navigation .loginform input.button:hover
|
|
||||||
{
|
|
||||||
cursor:pointer;
|
|
||||||
border:solid 1px rgb(80,80,80);
|
|
||||||
background:rgb(220,220,220);
|
|
||||||
color:rgb(80,80,80);
|
|
||||||
}
|
|
||||||
.main-navigation .searchform
|
|
||||||
{
|
|
||||||
width:160px;
|
|
||||||
margin:0 20px 0 20px;
|
|
||||||
}
|
|
||||||
.main-navigation .searchform p
|
|
||||||
{
|
|
||||||
clear:both;
|
|
||||||
margin:0;
|
|
||||||
padding:0;
|
|
||||||
}
|
|
||||||
.main-navigation .searchform fieldset
|
|
||||||
{
|
|
||||||
border:none;
|
|
||||||
}
|
|
||||||
.main-navigation .searchform input.field
|
|
||||||
{
|
|
||||||
float:left;
|
|
||||||
width:158px;
|
|
||||||
padding:0.1em 0 0.2em 0 !important /*Non-IE6*/;
|
|
||||||
padding:0.2em 0 0.3em 0 /*IE6*/;
|
|
||||||
border:1px solid rgb(200,200,200);
|
|
||||||
font-family:verdana,arial,sans-serif;
|
|
||||||
font-size:120%;
|
|
||||||
}
|
|
||||||
.main-navigation .searchform input.button
|
|
||||||
{
|
|
||||||
float:left;
|
|
||||||
width:3.0em;
|
|
||||||
margin-top: 0.5em;
|
|
||||||
padding:1px;
|
|
||||||
background:rgb(230,230,230);
|
|
||||||
border:solid 1px rgb(150,150,150);
|
|
||||||
text-align:center;
|
|
||||||
font-family:verdana,arial,sans-serif;
|
|
||||||
color:rgb(150,150,150);
|
|
||||||
font-size:120%;
|
|
||||||
}
|
|
||||||
.main-navigation .searchform input.button:hover
|
|
||||||
{
|
|
||||||
cursor:pointer;
|
|
||||||
border:solid 1px rgb(80,80,80);
|
|
||||||
background:rgb(220,220,220);
|
|
||||||
color:rgb(80,80,80);
|
|
||||||
}
|
|
||||||
.main-navigation h1.first
|
|
||||||
{
|
|
||||||
clear:both;
|
|
||||||
margin:0px;
|
|
||||||
padding:4px 20px 3px 20px;
|
|
||||||
background-color:rgb(190,190,190);
|
|
||||||
background-color:#89aad6;
|
|
||||||
font-family:"trebuchet ms",arial,sans-serif;
|
|
||||||
color:rgb(255,255,255);
|
|
||||||
font-weight:bold;
|
|
||||||
}
|
|
||||||
.main-navigation h1
|
|
||||||
{
|
|
||||||
clear:both;
|
|
||||||
margin:30px 0 20px 0;
|
|
||||||
padding:4px 20px 3px 20px;
|
|
||||||
background:rgb(190,190,190);
|
|
||||||
background:#89aad6;
|
|
||||||
font-family:"trebuchet ms",arial,sans-serif;
|
|
||||||
color:rgb(255,255,255);
|
|
||||||
font-weight:bold;
|
|
||||||
font-size:1.2em;
|
|
||||||
}
|
|
||||||
.main-navigation h2
|
|
||||||
{
|
|
||||||
clear:both;
|
|
||||||
margin:20px 10px 10px 20px;
|
|
||||||
font-family:"trebuchet ms",arial,sans-serif;
|
|
||||||
color:rgb(100,100,100);
|
|
||||||
font-weight:bold;
|
|
||||||
font-size:150%;
|
|
||||||
}
|
|
||||||
.main-navigation h3
|
|
||||||
{
|
|
||||||
clear:both;
|
|
||||||
margin:10px 10px 5px 20px;
|
|
||||||
color:rgb(80,80,80);
|
|
||||||
font-weight:bold;
|
|
||||||
font-size:110%;
|
|
||||||
} /* Note: h2 not existent, to make identical to formats for main-navigation for easier exchange */
|
|
||||||
.main-navigation p
|
|
||||||
{
|
|
||||||
clear:both;
|
|
||||||
margin:0 10px 10px 20px;
|
|
||||||
color:rgb(80,80,80);
|
|
||||||
line-height:1.3em;
|
|
||||||
font-size:110%;
|
|
||||||
}
|
|
||||||
.main-navigation p.center
|
|
||||||
{
|
|
||||||
text-align:center;
|
|
||||||
}
|
|
||||||
.main-navigation p.right
|
|
||||||
{
|
|
||||||
text-align:right;
|
|
||||||
}
|
|
||||||
.main-navigation ul
|
|
||||||
{
|
|
||||||
list-style:none;
|
|
||||||
margin:0.5em 5px 1.0em 5px;
|
|
||||||
}
|
|
||||||
.main-navigation ul li
|
|
||||||
{
|
|
||||||
margin:5px 0 0.2em 2px;
|
|
||||||
background-image:none;
|
|
||||||
line-height:1.4em;
|
|
||||||
font-size:90%;
|
|
||||||
color:#467aa7;
|
|
||||||
font-weight:normal;
|
|
||||||
}
|
|
||||||
.main-navigation a,
|
|
||||||
.main-navigation ul li ul li,
|
|
||||||
.main-navigation ul li ul li a,
|
|
||||||
.main-navigation ul li ul li a:visited
|
|
||||||
{
|
|
||||||
color:#333;
|
|
||||||
font-weight:normal;
|
|
||||||
}
|
|
||||||
.main-navigation ol
|
|
||||||
{
|
|
||||||
margin:0.5em 10px 1.0em 40px !important /*Non-IE6*/;
|
|
||||||
margin:0.5em 10px 1.0em 45px /*IE6*/;
|
|
||||||
}
|
|
||||||
.main-navigation ol li
|
|
||||||
{
|
|
||||||
list-style-position:outside;
|
|
||||||
margin:0 0 0.4em 0;
|
|
||||||
font-size:110%;
|
|
||||||
}
|
|
||||||
|
|
||||||
.main-navigation
|
|
||||||
{
|
|
||||||
font-size:14px;
|
|
||||||
display:inline /*Fix IE floating margin bug*/;
|
|
||||||
float:left;
|
|
||||||
width:200px;
|
|
||||||
height:100%;
|
|
||||||
overflow:visible !important /*Firefox*/;
|
|
||||||
overflow:hidden /*IE6*/;
|
|
||||||
background:rgb(245,245,245);
|
|
||||||
}
|
|
||||||
|
|
||||||
.main-navigation .round-border-topright
|
|
||||||
{
|
|
||||||
width:10px;
|
|
||||||
height:10px;
|
|
||||||
position:absolute;
|
|
||||||
z-index:10;
|
|
||||||
margin:0 0 0 190px;
|
|
||||||
background:url(img/bg_corner_topright.gif) no-repeat;
|
|
||||||
}
|
|
||||||
|
|
||||||
.main-navigation h2
|
|
||||||
{
|
|
||||||
margin: 5px 10px 5px 10px;
|
|
||||||
}
|
|
||||||
.main-navigation h1.first ,.main-navigation h1
|
|
||||||
{
|
|
||||||
background-color:#89aad6 !important;
|
|
||||||
}
|
|
||||||
.main-navigation
|
|
||||||
{
|
|
||||||
background-color:#d5e1f0 !important;
|
|
||||||
}
|
|
||||||
@ -1,111 +0,0 @@
|
|||||||
/* Modifications to standard doxygen style */
|
|
||||||
|
|
||||||
/* needs space between surrounding border */
|
|
||||||
.contents {
|
|
||||||
padding-left: 10px;
|
|
||||||
padding-right: 10px;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* needs space between surrounding border */
|
|
||||||
.contents ul {
|
|
||||||
margin-left: 20px;
|
|
||||||
list-style-type: square;
|
|
||||||
}
|
|
||||||
|
|
||||||
.contents ol {
|
|
||||||
margin-left: 20px;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* colour and underline to match OpenFOAM style */
|
|
||||||
div.title
|
|
||||||
{
|
|
||||||
text-align: center;
|
|
||||||
font-size: 150%;
|
|
||||||
color: #646464;
|
|
||||||
padding-top: 1em;
|
|
||||||
padding-bottom: 1em;
|
|
||||||
margin-bottom: 1em;
|
|
||||||
border-bottom: 7px solid #E1E1E1;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* colour and underline to match OpenFOAM style */
|
|
||||||
.contents h1,
|
|
||||||
.contents h2
|
|
||||||
{
|
|
||||||
color: #646464;
|
|
||||||
padding-top: 1em;
|
|
||||||
padding-bottom: 1em;
|
|
||||||
margin-bottom: 1em;
|
|
||||||
border-bottom: 7px solid #E1E1E1;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* sub-heading as per navigation background */
|
|
||||||
.contents h2
|
|
||||||
{
|
|
||||||
margin-top: 1em;
|
|
||||||
background: rgb(240,240,240);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/* match overall border style */
|
|
||||||
.contents hr
|
|
||||||
{
|
|
||||||
border: 2px solid rgb(175,175,175);
|
|
||||||
margin: 1em -10px;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/* client-side search */
|
|
||||||
/* #MSearchResultsWindow { } */
|
|
||||||
|
|
||||||
|
|
||||||
/* table displayed in "Class List" */
|
|
||||||
td.indexkey,
|
|
||||||
td.indexvalue,
|
|
||||||
tr.memlist
|
|
||||||
{
|
|
||||||
background-color: #F0F0F0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.memSeparator {
|
|
||||||
display:none;
|
|
||||||
}
|
|
||||||
|
|
||||||
#searchli {
|
|
||||||
padding: 0px;
|
|
||||||
}
|
|
||||||
|
|
||||||
#MSearchBox {
|
|
||||||
margin-top: 0px;
|
|
||||||
width: 200px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.OFTable {
|
|
||||||
width: 100%;
|
|
||||||
border: 1px solid rgb(175,175,175);
|
|
||||||
margin-top: 10px;
|
|
||||||
margin-bottom: 10px;
|
|
||||||
/* background-color: #F0F0F0; */
|
|
||||||
padding: 5px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.OFTable th {
|
|
||||||
text-align: left;
|
|
||||||
padding: 5px;
|
|
||||||
border-bottom: 2px solid rgb(175,175,175);
|
|
||||||
}
|
|
||||||
|
|
||||||
.OFTable td {
|
|
||||||
padding-left: 5px;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.line,
|
|
||||||
span.comment,
|
|
||||||
span.keyword,
|
|
||||||
span.preprocessor,
|
|
||||||
span.keywordflow,
|
|
||||||
a.code
|
|
||||||
{
|
|
||||||
white-space: pre-wrap;
|
|
||||||
font-family: "Courier New", Courier, monospace, fixed;
|
|
||||||
}
|
|
||||||
@ -1,173 +0,0 @@
|
|||||||
/*
|
|
||||||
* tabs styles, without slidingdoor graphics
|
|
||||||
* http://www.alistapart.com/articles/slidingdoors
|
|
||||||
*/
|
|
||||||
|
|
||||||
div.navigation
|
|
||||||
{
|
|
||||||
margin: 0px;
|
|
||||||
padding: 0px;
|
|
||||||
border-bottom: 3px solid rgb(175,175,175);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
div.tabs,
|
|
||||||
div.tabs2,
|
|
||||||
div.tabs3
|
|
||||||
{
|
|
||||||
width : 100%;
|
|
||||||
padding-top : 5px;
|
|
||||||
padding-bottom : 5px;
|
|
||||||
background: rgb(240,240,240);
|
|
||||||
border-bottom: 1px solid rgb(175,175,175);
|
|
||||||
}
|
|
||||||
|
|
||||||
div.tabs ul,
|
|
||||||
div.tabs2 ul,
|
|
||||||
div.tabs3 ul
|
|
||||||
{
|
|
||||||
margin: 0px;
|
|
||||||
padding-left: 10px;
|
|
||||||
padding-right: 10px;
|
|
||||||
list-style: none;
|
|
||||||
/* max-height: 16px; */
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
div.tabs li, div.tabs form,
|
|
||||||
div.tabs2 li, div.tabs2 form,
|
|
||||||
div.tabs3 li, div.tabs3 form
|
|
||||||
{
|
|
||||||
display : inline;
|
|
||||||
margin : 0px;
|
|
||||||
padding : 0px;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.tabs ul li,
|
|
||||||
div.tabs2 ul li,
|
|
||||||
div.tabs3 ul li
|
|
||||||
{
|
|
||||||
padding-top: 10px;
|
|
||||||
padding-bottom: 10px;
|
|
||||||
height: 100%;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.tabs form,
|
|
||||||
div.tabs2 form
|
|
||||||
{
|
|
||||||
padding : 0px 9px;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.tabs a,
|
|
||||||
div.tabs2 a
|
|
||||||
{
|
|
||||||
font-size : 12px;
|
|
||||||
font-weight : normal;
|
|
||||||
text-decoration : none;
|
|
||||||
border-right: 1px solid rgb(175,175,175);
|
|
||||||
}
|
|
||||||
|
|
||||||
/* not needed - no image */
|
|
||||||
div.tabs a:hover,
|
|
||||||
div.tabs2 a:hover
|
|
||||||
{
|
|
||||||
background-position: 100% -150px;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.tabs a:link,
|
|
||||||
div.tabs a:visited,
|
|
||||||
div.tabs a:active,
|
|
||||||
div.tabs a:hover,
|
|
||||||
div.tabs2 a:link,
|
|
||||||
div.tabs2 a:visited,
|
|
||||||
div.tabs2 a:active,
|
|
||||||
div.tabs2 a:hover,
|
|
||||||
div.tabs3 a:link,
|
|
||||||
div.tabs3 a:visited,
|
|
||||||
div.tabs3 a:active,
|
|
||||||
div.tabs3 a:hover
|
|
||||||
{
|
|
||||||
color : #000000;
|
|
||||||
color:#555;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.tabs span,
|
|
||||||
div.tabs2 span,
|
|
||||||
div.tabs3 span
|
|
||||||
{
|
|
||||||
display : inline;
|
|
||||||
padding : 0px 9px;
|
|
||||||
white-space : nowrap;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* client-side search */
|
|
||||||
div.tabs #MSearchBox,
|
|
||||||
div.tabs2 #MSearchBox
|
|
||||||
{
|
|
||||||
float : right;
|
|
||||||
background : white;
|
|
||||||
display : inline;
|
|
||||||
font-size : 1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.tabs #MSearchSelect,
|
|
||||||
div.tabs2 #MSearchSelect
|
|
||||||
{
|
|
||||||
float : left;
|
|
||||||
display : inline;
|
|
||||||
font-size : 1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* old name? */
|
|
||||||
div.tabs input,
|
|
||||||
div.tabs2 input
|
|
||||||
{
|
|
||||||
float : right;
|
|
||||||
display : inline;
|
|
||||||
font-size : 1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.tabs td,
|
|
||||||
div.tabs2 td
|
|
||||||
{
|
|
||||||
font-size : 80%;
|
|
||||||
font-weight : bold;
|
|
||||||
text-decoration : none;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* Commented backslash hack hides rule from IE5-Mac \*/
|
|
||||||
div.tabs span { float : none; }
|
|
||||||
/* End IE5-Mac hack */
|
|
||||||
|
|
||||||
/* not needed - no image */
|
|
||||||
div.tabs a:hover span
|
|
||||||
{
|
|
||||||
background-position: 0% -150px;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.tabs li.current a,
|
|
||||||
div.tabs2 li.current a
|
|
||||||
{
|
|
||||||
border-width : 0px;
|
|
||||||
border-right: 1px solid rgb(175,175,175);
|
|
||||||
color : #555;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.tabs li.current span,
|
|
||||||
div.tabs2 li.current span
|
|
||||||
{
|
|
||||||
padding-bottom: 0px;
|
|
||||||
white-space: nowrap;
|
|
||||||
font-style: italic;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.navpath
|
|
||||||
{
|
|
||||||
background : none;
|
|
||||||
border : none;
|
|
||||||
margin : 10px 0px;
|
|
||||||
padding : 0px;
|
|
||||||
font-size : 110%;
|
|
||||||
text-align : center;
|
|
||||||
}
|
|
||||||
|
|
||||||
@ -1,750 +0,0 @@
|
|||||||
/* The standard CSS for doxygen */
|
|
||||||
|
|
||||||
/* set these elsewhere!! */
|
|
||||||
/*
|
|
||||||
body, table, div, p, dl {
|
|
||||||
font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif;
|
|
||||||
font-size: 12px;
|
|
||||||
}
|
|
||||||
*/
|
|
||||||
|
|
||||||
/* @group Heading Levels */
|
|
||||||
|
|
||||||
h1 {
|
|
||||||
text-align: center;
|
|
||||||
font-size: 150%;
|
|
||||||
}
|
|
||||||
|
|
||||||
h2 {
|
|
||||||
font-size: 120%;
|
|
||||||
}
|
|
||||||
|
|
||||||
h3 {
|
|
||||||
font-size: 100%;
|
|
||||||
}
|
|
||||||
|
|
||||||
dt {
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.multicol {
|
|
||||||
-moz-column-gap: 1em;
|
|
||||||
-webkit-column-gap: 1em;
|
|
||||||
-moz-column-count: 3;
|
|
||||||
-webkit-column-count: 3;
|
|
||||||
}
|
|
||||||
|
|
||||||
p.startli, p.startdd, p.starttd {
|
|
||||||
margin-top: 2px;
|
|
||||||
}
|
|
||||||
|
|
||||||
p.endli {
|
|
||||||
margin-bottom: 0px;
|
|
||||||
}
|
|
||||||
|
|
||||||
p.enddd {
|
|
||||||
margin-bottom: 4px;
|
|
||||||
}
|
|
||||||
|
|
||||||
p.endtd {
|
|
||||||
margin-bottom: 2px;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* @end */
|
|
||||||
|
|
||||||
caption {
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
span.legend {
|
|
||||||
font-size: 70%;
|
|
||||||
text-align: center;
|
|
||||||
}
|
|
||||||
|
|
||||||
h3.version {
|
|
||||||
font-size: 90%;
|
|
||||||
text-align: center;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.qindex, div.navtab{
|
|
||||||
background-color: #e8eef2;
|
|
||||||
border: 1px solid #84b0c7;
|
|
||||||
text-align: center;
|
|
||||||
margin: 2px;
|
|
||||||
padding: 2px;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.qindex, div.navpath {
|
|
||||||
width: 100%;
|
|
||||||
line-height: 140%;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.navtab {
|
|
||||||
margin-right: 15px;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* @group Link Styling */
|
|
||||||
|
|
||||||
a {
|
|
||||||
color: rgb(85,144,112);
|
|
||||||
font-weight: normal;
|
|
||||||
text-decoration: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.contents a:visited {
|
|
||||||
color: rgb(85,144,112);
|
|
||||||
}
|
|
||||||
|
|
||||||
a:hover {
|
|
||||||
text-decoration: underline;
|
|
||||||
}
|
|
||||||
|
|
||||||
a.qindex {
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
a.qindexHL {
|
|
||||||
font-weight: bold;
|
|
||||||
background-color: #6666cc;
|
|
||||||
color: #ffffff;
|
|
||||||
border: 1px double #9295C2;
|
|
||||||
}
|
|
||||||
|
|
||||||
.contents a.qindexHL:visited {
|
|
||||||
color: #ffffff;
|
|
||||||
}
|
|
||||||
|
|
||||||
a.el {
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
a.elRef {
|
|
||||||
}
|
|
||||||
|
|
||||||
a.code {
|
|
||||||
color: #3030f0;;
|
|
||||||
font-family: "Courier New", Courier, monospace, fixed;
|
|
||||||
}
|
|
||||||
|
|
||||||
a.codeRef {
|
|
||||||
color: #3030f0;;
|
|
||||||
font-family: "Courier New", Courier, monospace, fixed;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* @end */
|
|
||||||
|
|
||||||
dl.el {
|
|
||||||
margin-left: -1cm;
|
|
||||||
}
|
|
||||||
|
|
||||||
.fragment {
|
|
||||||
font-size: 105%;
|
|
||||||
font-family: "Courier New", Courier, monospace, fixed;
|
|
||||||
}
|
|
||||||
|
|
||||||
pre.fragment {
|
|
||||||
border: 1px solid #CCCCCC;
|
|
||||||
background-color: #f5f5f5;
|
|
||||||
padding: 4px 6px;
|
|
||||||
margin: 4px 8px 4px 2px;
|
|
||||||
overflow: auto;
|
|
||||||
word-wrap: break-word;
|
|
||||||
font-size: 9pt;
|
|
||||||
line-height: 125%;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.ah {
|
|
||||||
background-color: black;
|
|
||||||
font-weight: bold;
|
|
||||||
color: #ffffff;
|
|
||||||
margin-bottom: 3px;
|
|
||||||
margin-top: 3px
|
|
||||||
}
|
|
||||||
|
|
||||||
div.groupHeader {
|
|
||||||
margin-left: 16px;
|
|
||||||
margin-top: 12px;
|
|
||||||
margin-bottom: 6px;
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.groupText {
|
|
||||||
margin-left: 16px;
|
|
||||||
font-style: italic;
|
|
||||||
}
|
|
||||||
|
|
||||||
body {
|
|
||||||
background: white;
|
|
||||||
color: black;
|
|
||||||
margin-right: 20px;
|
|
||||||
margin-left: 20px;
|
|
||||||
}
|
|
||||||
|
|
||||||
td.indexkey {
|
|
||||||
background-color: #e8eef2;
|
|
||||||
font-weight: bold;
|
|
||||||
border: 1px solid #CCCCCC;
|
|
||||||
margin: 2px 0px 2px 0;
|
|
||||||
padding: 2px 10px;
|
|
||||||
}
|
|
||||||
|
|
||||||
td.indexvalue {
|
|
||||||
background-color: #e8eef2;
|
|
||||||
border: 1px solid #CCCCCC;
|
|
||||||
padding: 2px 10px;
|
|
||||||
margin: 2px 0px;
|
|
||||||
}
|
|
||||||
|
|
||||||
tr.memlist {
|
|
||||||
background-color: #f0f0f0;
|
|
||||||
}
|
|
||||||
|
|
||||||
p.formulaDsp {
|
|
||||||
text-align: center;
|
|
||||||
}
|
|
||||||
|
|
||||||
img.formulaDsp {
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
img.formulaInl {
|
|
||||||
vertical-align: middle;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.center {
|
|
||||||
text-align: center;
|
|
||||||
margin-top: 0px;
|
|
||||||
margin-bottom: 0px;
|
|
||||||
padding: 0px;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.center img {
|
|
||||||
border: 0px;
|
|
||||||
}
|
|
||||||
|
|
||||||
img.footer {
|
|
||||||
border: 0px;
|
|
||||||
vertical-align: middle;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* @group Code Colorization */
|
|
||||||
|
|
||||||
span.keyword {
|
|
||||||
color: #008000;
|
|
||||||
font-family: "Courier New", Courier, monospace, fixed;
|
|
||||||
}
|
|
||||||
|
|
||||||
span.keywordtype {
|
|
||||||
color: #604020;
|
|
||||||
font-family: "Courier New", Courier, monospace, fixed;
|
|
||||||
}
|
|
||||||
|
|
||||||
span.keywordflow {
|
|
||||||
color: #e08000;
|
|
||||||
font-family: "Courier New", Courier, monospace, fixed;
|
|
||||||
}
|
|
||||||
|
|
||||||
span.comment {
|
|
||||||
color: #800000;
|
|
||||||
font-family: "Courier New", Courier, monospace, fixed;
|
|
||||||
}
|
|
||||||
|
|
||||||
span.preprocessor {
|
|
||||||
color: #806020;
|
|
||||||
font-family: "Courier New", Courier, monospace, fixed;
|
|
||||||
}
|
|
||||||
|
|
||||||
span.stringliteral {
|
|
||||||
color: #002080;
|
|
||||||
font-family: "Courier New", Courier, monospace, fixed;
|
|
||||||
}
|
|
||||||
|
|
||||||
span.charliteral {
|
|
||||||
color: #008080;
|
|
||||||
font-family: "Courier New", Courier, monospace, fixed;
|
|
||||||
}
|
|
||||||
|
|
||||||
span.vhdldigit {
|
|
||||||
color: #ff00ff;
|
|
||||||
font-family: "Courier New", Courier, monospace, fixed;
|
|
||||||
}
|
|
||||||
|
|
||||||
span.vhdlchar {
|
|
||||||
color: #000000;
|
|
||||||
font-family: "Courier New", Courier, monospace, fixed;
|
|
||||||
}
|
|
||||||
|
|
||||||
span.vhdlkeyword {
|
|
||||||
color: #700070;
|
|
||||||
font-family: "Courier New", Courier, monospace, fixed;
|
|
||||||
}
|
|
||||||
|
|
||||||
span.vhdllogic {
|
|
||||||
color: #ff0000;
|
|
||||||
font-family: "Courier New", Courier, monospace, fixed;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* @end */
|
|
||||||
|
|
||||||
.search {
|
|
||||||
color: #003399;
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
form.search {
|
|
||||||
margin-bottom: 0px;
|
|
||||||
margin-top: 0px;
|
|
||||||
}
|
|
||||||
|
|
||||||
input.search {
|
|
||||||
font-size: 75%;
|
|
||||||
color: #000080;
|
|
||||||
font-weight: normal;
|
|
||||||
background-color: #e8eef2;
|
|
||||||
}
|
|
||||||
|
|
||||||
td.tiny {
|
|
||||||
font-size: 75%;
|
|
||||||
}
|
|
||||||
|
|
||||||
.dirtab {
|
|
||||||
padding: 4px;
|
|
||||||
border-collapse: collapse;
|
|
||||||
border: 1px solid #84b0c7;
|
|
||||||
}
|
|
||||||
|
|
||||||
th.dirtab {
|
|
||||||
background: #e8eef2;
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
hr {
|
|
||||||
height: 0px;
|
|
||||||
border: none;
|
|
||||||
border-top: 1px solid #666;
|
|
||||||
}
|
|
||||||
|
|
||||||
hr.footer {
|
|
||||||
height: 1px;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* @group Member Descriptions */
|
|
||||||
|
|
||||||
.mdescLeft, .mdescRight,
|
|
||||||
.memItemLeft, .memItemRight,
|
|
||||||
.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
|
|
||||||
background-color: #FAFAFA;
|
|
||||||
border: none;
|
|
||||||
margin: 4px;
|
|
||||||
padding: 1px 0 0 8px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.mdescLeft, .mdescRight {
|
|
||||||
padding: 0px 8px 4px 8px;
|
|
||||||
color: #555;
|
|
||||||
}
|
|
||||||
|
|
||||||
.memItemLeft, .memItemRight, .memTemplParams {
|
|
||||||
border-top: 1px solid #ccc;
|
|
||||||
}
|
|
||||||
|
|
||||||
.memItemLeft, .memTemplItemLeft {
|
|
||||||
white-space: nowrap;
|
|
||||||
}
|
|
||||||
|
|
||||||
.memTemplParams {
|
|
||||||
color: #606060;
|
|
||||||
white-space: nowrap;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* @end */
|
|
||||||
|
|
||||||
/* @group Member Details */
|
|
||||||
|
|
||||||
/* Styles for detailed member documentation */
|
|
||||||
|
|
||||||
.memtemplate {
|
|
||||||
font-size: 80%;
|
|
||||||
color: #606060;
|
|
||||||
font-weight: normal;
|
|
||||||
margin-left: 3px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.memnav {
|
|
||||||
background-color: #e8eef2;
|
|
||||||
border: 1px solid #84b0c7;
|
|
||||||
text-align: center;
|
|
||||||
margin: 2px;
|
|
||||||
margin-right: 15px;
|
|
||||||
padding: 2px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.memitem {
|
|
||||||
padding: 0;
|
|
||||||
margin-bottom: 10px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.memname {
|
|
||||||
white-space: nowrap;
|
|
||||||
font-weight: bold;
|
|
||||||
margin-left: 6px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.memproto {
|
|
||||||
border-top: 1px solid #84b0c7;
|
|
||||||
border-left: 1px solid #84b0c7;
|
|
||||||
border-right: 1px solid #84b0c7;
|
|
||||||
padding: 0;
|
|
||||||
background-color: #d5e1e8;
|
|
||||||
font-weight: bold;
|
|
||||||
/* firefox specific markup */
|
|
||||||
background-image: -moz-linear-gradient(rgba(225, 244, 238, 1.0) 0%, rgba(191, 223, 191, 1.0) 100%);
|
|
||||||
-moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
|
|
||||||
-moz-border-radius-topright: 8px;
|
|
||||||
-moz-border-radius-topleft: 8px;
|
|
||||||
/* webkit specific markup */
|
|
||||||
background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(rgba(225, 244, 238, 1.0)), to(rgba(191, 223, 191, 1.0)));
|
|
||||||
-webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
|
|
||||||
-webkit-border-top-right-radius: 8px;
|
|
||||||
-webkit-border-top-left-radius: 8px;
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
.memdoc {
|
|
||||||
border-bottom: 1px solid #84b0c7;
|
|
||||||
border-left: 1px solid #84b0c7;
|
|
||||||
border-right: 1px solid #84b0c7;
|
|
||||||
padding: 2px 5px;
|
|
||||||
background-color: #eef3f5;
|
|
||||||
border-top-width: 0;
|
|
||||||
/* firefox specific markup */
|
|
||||||
-moz-border-radius-bottomleft: 8px;
|
|
||||||
-moz-border-radius-bottomright: 8px;
|
|
||||||
-moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
|
|
||||||
/* webkit specific markup */
|
|
||||||
-webkit-border-bottom-left-radius: 8px;
|
|
||||||
-webkit-border-bottom-right-radius: 8px;
|
|
||||||
-webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
|
|
||||||
}
|
|
||||||
|
|
||||||
.paramkey {
|
|
||||||
text-align: right;
|
|
||||||
}
|
|
||||||
|
|
||||||
.paramtype {
|
|
||||||
white-space: nowrap;
|
|
||||||
}
|
|
||||||
|
|
||||||
.paramname {
|
|
||||||
color: #602020;
|
|
||||||
white-space: nowrap;
|
|
||||||
}
|
|
||||||
.paramname em {
|
|
||||||
font-style: normal;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* @end */
|
|
||||||
|
|
||||||
/* @group Directory (tree) */
|
|
||||||
|
|
||||||
/* for the tree view */
|
|
||||||
|
|
||||||
.ftvtree {
|
|
||||||
font-family: sans-serif;
|
|
||||||
margin: 0.5em;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* these are for tree view when used as main index */
|
|
||||||
|
|
||||||
.directory {
|
|
||||||
font-size: 9pt;
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
.directory h3 {
|
|
||||||
margin: 0px;
|
|
||||||
margin-top: 1em;
|
|
||||||
font-size: 11pt;
|
|
||||||
}
|
|
||||||
|
|
||||||
/*
|
|
||||||
The following two styles can be used to replace the root node title
|
|
||||||
with an image of your choice. Simply uncomment the next two styles,
|
|
||||||
specify the name of your image and be sure to set 'height' to the
|
|
||||||
proper pixel height of your image.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/*
|
|
||||||
.directory h3.swap {
|
|
||||||
height: 61px;
|
|
||||||
background-repeat: no-repeat;
|
|
||||||
background-image: url("yourimage.gif");
|
|
||||||
}
|
|
||||||
.directory h3.swap span {
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
*/
|
|
||||||
|
|
||||||
.directory > h3 {
|
|
||||||
margin-top: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.directory p {
|
|
||||||
margin: 0px;
|
|
||||||
white-space: nowrap;
|
|
||||||
}
|
|
||||||
|
|
||||||
.directory div {
|
|
||||||
display: none;
|
|
||||||
margin: 0px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.directory img {
|
|
||||||
vertical-align: -30%;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* these are for tree view when not used as main index */
|
|
||||||
|
|
||||||
.directory-alt {
|
|
||||||
font-size: 100%;
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
.directory-alt h3 {
|
|
||||||
margin: 0px;
|
|
||||||
margin-top: 1em;
|
|
||||||
font-size: 11pt;
|
|
||||||
}
|
|
||||||
|
|
||||||
.directory-alt > h3 {
|
|
||||||
margin-top: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.directory-alt p {
|
|
||||||
margin: 0px;
|
|
||||||
white-space: nowrap;
|
|
||||||
}
|
|
||||||
|
|
||||||
.directory-alt div {
|
|
||||||
display: none;
|
|
||||||
margin: 0px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.directory-alt img {
|
|
||||||
vertical-align: -30%;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* @end */
|
|
||||||
|
|
||||||
address {
|
|
||||||
font-style: normal;
|
|
||||||
color: #333;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.doxtable {
|
|
||||||
border-collapse:collapse;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.doxtable td, table.doxtable th {
|
|
||||||
border: 1px solid rgb(85,144,112);
|
|
||||||
padding: 3px 7px 2px;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.doxtable th {
|
|
||||||
background-color: #254798;
|
|
||||||
color: #FFFFFF;
|
|
||||||
font-size: 110%;
|
|
||||||
padding-bottom: 4px;
|
|
||||||
padding-top: 5px;
|
|
||||||
text-align:left;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* tooltip related style info */
|
|
||||||
|
|
||||||
.ttc {
|
|
||||||
position: absolute;
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
#powerTip {
|
|
||||||
cursor: default;
|
|
||||||
white-space: nowrap;
|
|
||||||
background-color: white;
|
|
||||||
border: 1px solid gray;
|
|
||||||
border-radius: 4px 4px 4px 4px;
|
|
||||||
box-shadow: 1px 1px 7px gray;
|
|
||||||
display: none;
|
|
||||||
font-size: smaller;
|
|
||||||
max-width: 80%;
|
|
||||||
opacity: 0.9;
|
|
||||||
padding: 1ex 1em 1em;
|
|
||||||
position: absolute;
|
|
||||||
z-index: 2147483647;
|
|
||||||
}
|
|
||||||
|
|
||||||
#powerTip div.ttdoc {
|
|
||||||
color: grey;
|
|
||||||
font-style: italic;
|
|
||||||
}
|
|
||||||
|
|
||||||
#powerTip div.ttname a {
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
#powerTip div.ttname {
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
#powerTip div.ttdeci {
|
|
||||||
color: #006318;
|
|
||||||
}
|
|
||||||
|
|
||||||
#powerTip div {
|
|
||||||
margin: 0px;
|
|
||||||
padding: 0px;
|
|
||||||
font: 12px/16px Roboto,sans-serif;
|
|
||||||
}
|
|
||||||
|
|
||||||
#powerTip:before, #powerTip:after {
|
|
||||||
content: "";
|
|
||||||
position: absolute;
|
|
||||||
margin: 0px;
|
|
||||||
}
|
|
||||||
|
|
||||||
#powerTip.n:after, #powerTip.n:before,
|
|
||||||
#powerTip.s:after, #powerTip.s:before,
|
|
||||||
#powerTip.w:after, #powerTip.w:before,
|
|
||||||
#powerTip.e:after, #powerTip.e:before,
|
|
||||||
#powerTip.ne:after, #powerTip.ne:before,
|
|
||||||
#powerTip.se:after, #powerTip.se:before,
|
|
||||||
#powerTip.nw:after, #powerTip.nw:before,
|
|
||||||
#powerTip.sw:after, #powerTip.sw:before {
|
|
||||||
border: solid transparent;
|
|
||||||
content: " ";
|
|
||||||
height: 0;
|
|
||||||
width: 0;
|
|
||||||
position: absolute;
|
|
||||||
}
|
|
||||||
|
|
||||||
#powerTip.n:after, #powerTip.s:after,
|
|
||||||
#powerTip.w:after, #powerTip.e:after,
|
|
||||||
#powerTip.nw:after, #powerTip.ne:after,
|
|
||||||
#powerTip.sw:after, #powerTip.se:after {
|
|
||||||
border-color: rgba(255, 255, 255, 0);
|
|
||||||
}
|
|
||||||
|
|
||||||
#powerTip.n:before, #powerTip.s:before,
|
|
||||||
#powerTip.w:before, #powerTip.e:before,
|
|
||||||
#powerTip.nw:before, #powerTip.ne:before,
|
|
||||||
#powerTip.sw:before, #powerTip.se:before {
|
|
||||||
border-color: rgba(128, 128, 128, 0);
|
|
||||||
}
|
|
||||||
|
|
||||||
#powerTip.n:after, #powerTip.n:before,
|
|
||||||
#powerTip.ne:after, #powerTip.ne:before,
|
|
||||||
#powerTip.nw:after, #powerTip.nw:before {
|
|
||||||
top: 100%;
|
|
||||||
}
|
|
||||||
|
|
||||||
#powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after {
|
|
||||||
border-top-color: #ffffff;
|
|
||||||
border-width: 10px;
|
|
||||||
margin: 0px -10px;
|
|
||||||
}
|
|
||||||
#powerTip.n:before {
|
|
||||||
border-top-color: #808080;
|
|
||||||
border-width: 11px;
|
|
||||||
margin: 0px -11px;
|
|
||||||
}
|
|
||||||
#powerTip.n:after, #powerTip.n:before {
|
|
||||||
left: 50%;
|
|
||||||
}
|
|
||||||
|
|
||||||
#powerTip.nw:after, #powerTip.nw:before {
|
|
||||||
right: 14px;
|
|
||||||
}
|
|
||||||
|
|
||||||
#powerTip.ne:after, #powerTip.ne:before {
|
|
||||||
left: 14px;
|
|
||||||
}
|
|
||||||
|
|
||||||
#powerTip.s:after, #powerTip.s:before,
|
|
||||||
#powerTip.se:after, #powerTip.se:before,
|
|
||||||
#powerTip.sw:after, #powerTip.sw:before {
|
|
||||||
bottom: 100%;
|
|
||||||
}
|
|
||||||
|
|
||||||
#powerTip.s:after, #powerTip.se:after, #powerTip.sw:after {
|
|
||||||
border-bottom-color: #ffffff;
|
|
||||||
border-width: 10px;
|
|
||||||
margin: 0px -10px;
|
|
||||||
}
|
|
||||||
|
|
||||||
#powerTip.s:before, #powerTip.se:before, #powerTip.sw:before {
|
|
||||||
border-bottom-color: #808080;
|
|
||||||
border-width: 11px;
|
|
||||||
margin: 0px -11px;
|
|
||||||
}
|
|
||||||
|
|
||||||
#powerTip.s:after, #powerTip.s:before {
|
|
||||||
left: 50%;
|
|
||||||
}
|
|
||||||
|
|
||||||
#powerTip.sw:after, #powerTip.sw:before {
|
|
||||||
right: 14px;
|
|
||||||
}
|
|
||||||
|
|
||||||
#powerTip.se:after, #powerTip.se:before {
|
|
||||||
left: 14px;
|
|
||||||
}
|
|
||||||
|
|
||||||
#powerTip.e:after, #powerTip.e:before {
|
|
||||||
left: 100%;
|
|
||||||
}
|
|
||||||
#powerTip.e:after {
|
|
||||||
border-left-color: #ffffff;
|
|
||||||
border-width: 10px;
|
|
||||||
top: 50%;
|
|
||||||
margin-top: -10px;
|
|
||||||
}
|
|
||||||
#powerTip.e:before {
|
|
||||||
border-left-color: #808080;
|
|
||||||
border-width: 11px;
|
|
||||||
top: 50%;
|
|
||||||
margin-top: -11px;
|
|
||||||
}
|
|
||||||
|
|
||||||
#powerTip.w:after, #powerTip.w:before {
|
|
||||||
right: 100%;
|
|
||||||
}
|
|
||||||
#powerTip.w:after {
|
|
||||||
border-right-color: #ffffff;
|
|
||||||
border-width: 10px;
|
|
||||||
top: 50%;
|
|
||||||
margin-top: -10px;
|
|
||||||
}
|
|
||||||
#powerTip.w:before {
|
|
||||||
border-right-color: #808080;
|
|
||||||
border-width: 11px;
|
|
||||||
top: 50%;
|
|
||||||
margin-top: -11px;
|
|
||||||
}
|
|
||||||
|
|
||||||
@media print
|
|
||||||
{
|
|
||||||
#top { display: none; }
|
|
||||||
#side-nav { display: none; }
|
|
||||||
#nav-path { display: none; }
|
|
||||||
body { overflow:visible; }
|
|
||||||
h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
|
|
||||||
.summary { display: none; }
|
|
||||||
.memitem { page-break-inside: avoid; }
|
|
||||||
#doc-content
|
|
||||||
{
|
|
||||||
margin-left:0 !important;
|
|
||||||
height:auto !important;
|
|
||||||
width:auto !important;
|
|
||||||
overflow:inherit;
|
|
||||||
display:inline;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
Before Width: | Height: | Size: 6.0 KiB |
|
Before Width: | Height: | Size: 806 B |
|
Before Width: | Height: | Size: 50 B |
|
Before Width: | Height: | Size: 825 B |
|
Before Width: | Height: | Size: 99 B |
|
Before Width: | Height: | Size: 60 B |
|
Before Width: | Height: | Size: 391 B |
|
Before Width: | Height: | Size: 389 B |
@ -1,7 +0,0 @@
|
|||||||
/* import doxygen-specific styles */
|
|
||||||
@import url(doxygen.css); /* standard doxygen style with very minor mods */
|
|
||||||
@import url(doxyMod.css); /* modifications to standard doxygen style */
|
|
||||||
@import url(doxyTabs.css); /* modified doxygen tabs style */
|
|
||||||
@import url(cfdLayout.css); /* OpenFOAM layout styles */
|
|
||||||
@import url(cfdNav.css); /* OpenFOAM navigation styles */
|
|
||||||
|
|
||||||
1474
doc/Doxygen/customdoxygen.css
Normal file
21
doc/Doxygen/footer.html
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
<!-- HTML footer for doxygen 1.8.11-->
|
||||||
|
<!-- start footer part -->
|
||||||
|
<!--BEGIN GENERATE_TREEVIEW-->
|
||||||
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||||
|
<ul>
|
||||||
|
$navpath
|
||||||
|
<li class="footer">$generatedby
|
||||||
|
<a href="http://www.doxygen.org/index.html">
|
||||||
|
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/></a> $doxygenversion </li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<!--END GENERATE_TREEVIEW-->
|
||||||
|
<!--BEGIN !GENERATE_TREEVIEW-->
|
||||||
|
<hr class="footer"/><address class="footer"><small>
|
||||||
|
$generatedby  <a href="http://www.doxygen.org/index.html">
|
||||||
|
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/>
|
||||||
|
</a> $doxygenversion
|
||||||
|
</small></address>
|
||||||
|
<!--END !GENERATE_TREEVIEW-->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
55
doc/Doxygen/header.html
Normal file
@ -0,0 +1,55 @@
|
|||||||
|
<!-- HTML header for doxygen 1.8.11-->
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||||
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||||
|
<meta name="generator" content="Doxygen $doxygenversion"/>
|
||||||
|
<!--BEGIN PROJECT_NAME--><title>$projectname: $title </title><!--END PROJECT_NAME-->
|
||||||
|
<!--BEGIN !PROJECT_NAME--><title>$title </title><!--END !PROJECT_NAME-->
|
||||||
|
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
|
||||||
|
<script type="text/javascript" src="$relpath^jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="$relpath^dynsections.js"></script>
|
||||||
|
$treeview
|
||||||
|
$search
|
||||||
|
$mathjax
|
||||||
|
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
|
||||||
|
$extrastylesheet
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||||
|
|
||||||
|
<!--BEGIN TITLEAREA-->
|
||||||
|
<div id="titlearea">
|
||||||
|
<table cellspacing="0" cellpadding="0">
|
||||||
|
<tbody>
|
||||||
|
<tr style="height: 56px;">
|
||||||
|
<!--BEGIN PROJECT_LOGO-->
|
||||||
|
<td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></td>
|
||||||
|
<!--END PROJECT_LOGO-->
|
||||||
|
<!--BEGIN PROJECT_NAME-->
|
||||||
|
<td id="projectalign" style="padding-left: 0.5em;">
|
||||||
|
<div id="projectname"><a href="http://openfoam.org/download/source">$projectname</a>
|
||||||
|
<!--BEGIN PROJECT_NUMBER--> <span id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER-->
|
||||||
|
</div>
|
||||||
|
<!--BEGIN PROJECT_BRIEF--><div id="projectbrief"><a href="http://openfoam.org">$projectbrief</a></div><!--END PROJECT_BRIEF-->
|
||||||
|
</td>
|
||||||
|
<!--END PROJECT_NAME-->
|
||||||
|
<!--BEGIN !PROJECT_NAME-->
|
||||||
|
<!--BEGIN PROJECT_BRIEF-->
|
||||||
|
<td style="padding-left: 0.5em;">
|
||||||
|
<div id="projectbrief">$projectbrief</div>
|
||||||
|
</td>
|
||||||
|
<!--END PROJECT_BRIEF-->
|
||||||
|
<!--END !PROJECT_NAME-->
|
||||||
|
<!--BEGIN DISABLE_INDEX-->
|
||||||
|
<!--BEGIN SEARCHENGINE-->
|
||||||
|
<td>$searchbox</td>
|
||||||
|
<!--END SEARCHENGINE-->
|
||||||
|
<!--END DISABLE_INDEX-->
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
<!--END TITLEAREA-->
|
||||||
|
<!-- end header part -->
|
||||||
@ -3,7 +3,7 @@
|
|||||||
#+TITLE: OpenFOAM C++ Style Guide
|
#+TITLE: OpenFOAM C++ Style Guide
|
||||||
#+AUTHOR: OpenFOAM Foundation
|
#+AUTHOR: OpenFOAM Foundation
|
||||||
#+DATE: 2011-2016
|
#+DATE: 2011-2016
|
||||||
#+LINK: http://www.OpenFOAM.org
|
#+LINK: http://OpenFOAM.org
|
||||||
#+OPTIONS: author:nil ^:{}
|
#+OPTIONS: author:nil ^:{}
|
||||||
#+STARTUP: hidestars
|
#+STARTUP: hidestars
|
||||||
#+STARTUP: odd
|
#+STARTUP: odd
|
||||||
|
|||||||
@ -23,33 +23,27 @@ License
|
|||||||
|
|
||||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||||
|
|
||||||
\mainpage OpenFOAM®: Open-Source CFD
|
\mainpage Free, Open Source Software from the OpenFOAM Foundation
|
||||||
|
|
||||||
\section about About OpenFOAM
|
\section about About OpenFOAM
|
||||||
|
|
||||||
OpenFOAM is a free, open source CFD software package released free and
|
OpenFOAM is a free, open source CFD software package released free and
|
||||||
open-source under the GNU General Public License by the,
|
open-source under the GNU General Public License by the,
|
||||||
<a href="http://www.openfoam.org">OpenFOAM Foundation</a>. It has a large
|
<a href="http://openfoam.org">OpenFOAM Foundation</a>. It has a large
|
||||||
user base across most areas of engineering and science, from both commercial
|
user base across most areas of engineering and science, from both commercial
|
||||||
and academic organisations. OpenFOAM has an extensive range of features to
|
and academic organisations. OpenFOAM has an extensive range of features to
|
||||||
solve anything from complex fluid flows involving chemical reactions,
|
solve anything from complex fluid flows involving chemical reactions,
|
||||||
turbulence and heat transfer, to solid dynamics and electromagnetics.
|
turbulence and heat transfer, to solid dynamics and electromagnetics.
|
||||||
<a href="http://www.openfoam.org/features">More ...</a>
|
<a href="http://openfoam.org/features">More ...</a>
|
||||||
|
|
||||||
\section layout OpenFOAM Directory Structure
|
\section layout OpenFOAM Directory Structure
|
||||||
|
|
||||||
OpenFOAM comprises of four main directories:
|
OpenFOAM comprises of four main directories:
|
||||||
- src:
|
- \b src: the core OpenFOAM libraries
|
||||||
The core OpenFOAM libraries
|
- \b applications: solvers and utilities
|
||||||
|
- \b tutorials: test-cases that demonstrate a wide-range of OpenFOAM
|
||||||
- applications:
|
functionality
|
||||||
Solvers and utilities
|
- \b doc: documentation
|
||||||
|
|
||||||
- tutorials:
|
|
||||||
Test-cases that demonstrate a wide-range of OpenFOAM functionality
|
|
||||||
|
|
||||||
- doc:
|
|
||||||
Documentation
|
|
||||||
|
|
||||||
\section usingOpenFOAM Using OpenFOAM
|
\section usingOpenFOAM Using OpenFOAM
|
||||||
|
|
||||||
|
|||||||
@ -168,7 +168,7 @@ Foam::pointField Foam::coupledPolyPatch::getAnchorPoints
|
|||||||
|
|
||||||
const point& p2 = points[f[fp2]];
|
const point& p2 = points[f[fp2]];
|
||||||
|
|
||||||
// @todo Change to a tolerance and possibly select closest
|
// TODO: Change to a tolerance and possibly select closest
|
||||||
// point to the origin
|
// point to the origin
|
||||||
if (p1 == p2)
|
if (p1 == p2)
|
||||||
{
|
{
|
||||||
|
|||||||
@ -145,7 +145,7 @@ class polyMeshFilter
|
|||||||
// + -1 : point not on boundary
|
// + -1 : point not on boundary
|
||||||
// + 0 : point on a real boundary
|
// + 0 : point on a real boundary
|
||||||
// + >0 : point on a processor patch with that ID
|
// + >0 : point on a processor patch with that ID
|
||||||
// @todo Need to mark boundaryEdges as well, as an edge may have two
|
// TODO: Need to mark boundaryEdges as well, as an edge may have two
|
||||||
// boundary points but not itself lie on a boundary
|
// boundary points but not itself lie on a boundary
|
||||||
void updatePointPriorities
|
void updatePointPriorities
|
||||||
(
|
(
|
||||||
|
|||||||