From cf89a3094ae003f6414e5e17b5cd2d1574b26c8b Mon Sep 17 00:00:00 2001 From: Henry Weller Date: Mon, 20 Jun 2016 21:20:28 +0100 Subject: [PATCH] Updated and simplified the Doxygen documentation --- README.org | 14 +- .../DelaunayMesh/DistributedDelaunayMesh.C | 2 +- .../backgroundMeshDecomposition.C | 4 +- .../cellShapeControlMesh.C | 2 +- .../controlMeshRefinement.C | 6 +- .../conformalVoronoiMeshConformToSurface.C | 4 +- .../triSurfaceMeshFeatures.C | 2 +- .../foamyQuadMesh/insertFeaturePoints.C | 2 +- .../surfaceFeatureExtract.C | 2 +- bin/tools/doxyFilter.sed | 14 - doc/Doxygen/CFDFoundation55x55.png | Bin 0 -> 496 bytes doc/Doxygen/Doxyfile | 19 +- doc/Doxygen/OpenFOAMdocIcon.png | Bin 1240 -> 0 bytes doc/Doxygen/OpenFOAMicon.png | Bin 1199 -> 0 bytes doc/Doxygen/README | 26 - doc/Doxygen/README.html | 227 +++ doc/Doxygen/README.org | 41 + doc/Doxygen/_Footer | 22 - doc/Doxygen/_Header | 44 - doc/Doxygen/css/cfdLayout.css | 349 ---- doc/Doxygen/css/cfdNav.css | 572 ------- doc/Doxygen/css/doxyMod.css | 111 -- doc/Doxygen/css/doxyTabs.css | 173 -- doc/Doxygen/css/doxygen.css | 750 --------- doc/Doxygen/css/img/OpenFOAMlogo.png | Bin 6140 -> 0 bytes doc/Doxygen/css/img/bg_bullet_full_1.gif | Bin 806 -> 0 bytes doc/Doxygen/css/img/bg_bullet_full_2.gif | Bin 50 -> 0 bytes doc/Doxygen/css/img/bg_bullet_half_1.gif | Bin 825 -> 0 bytes doc/Doxygen/css/img/bg_bullet_half_2.gif | Bin 99 -> 0 bytes doc/Doxygen/css/img/bg_corner_topright.gif | Bin 60 -> 0 bytes .../css/img/bg_head_corner_topleft_25px.gif | Bin 391 -> 0 bytes .../css/img/bg_head_corner_topright_25px.gif | Bin 389 -> 0 bytes doc/Doxygen/css/openfoam.css | 7 - doc/Doxygen/customdoxygen.css | 1474 +++++++++++++++++ doc/Doxygen/footer.html | 21 + doc/Doxygen/header.html | 55 + doc/codingStyleGuide.org | 2 +- src/OpenFOAM/global/foamDoc.H | 22 +- .../basic/coupled/coupledPolyPatch.C | 2 +- .../polyMeshFilter/polyMeshFilter.H | 2 +- 40 files changed, 1858 insertions(+), 2113 deletions(-) create mode 100644 doc/Doxygen/CFDFoundation55x55.png delete mode 100644 doc/Doxygen/OpenFOAMdocIcon.png delete mode 100644 doc/Doxygen/OpenFOAMicon.png delete mode 100644 doc/Doxygen/README create mode 100644 doc/Doxygen/README.html create mode 100644 doc/Doxygen/README.org delete mode 100644 doc/Doxygen/_Footer delete mode 100644 doc/Doxygen/_Header delete mode 100644 doc/Doxygen/css/cfdLayout.css delete mode 100644 doc/Doxygen/css/cfdNav.css delete mode 100644 doc/Doxygen/css/doxyMod.css delete mode 100644 doc/Doxygen/css/doxyTabs.css delete mode 100644 doc/Doxygen/css/doxygen.css delete mode 100644 doc/Doxygen/css/img/OpenFOAMlogo.png delete mode 100644 doc/Doxygen/css/img/bg_bullet_full_1.gif delete mode 100644 doc/Doxygen/css/img/bg_bullet_full_2.gif delete mode 100644 doc/Doxygen/css/img/bg_bullet_half_1.gif delete mode 100644 doc/Doxygen/css/img/bg_bullet_half_2.gif delete mode 100644 doc/Doxygen/css/img/bg_corner_topright.gif delete mode 100644 doc/Doxygen/css/img/bg_head_corner_topleft_25px.gif delete mode 100644 doc/Doxygen/css/img/bg_head_corner_topright_25px.gif delete mode 100644 doc/Doxygen/css/openfoam.css create mode 100644 doc/Doxygen/customdoxygen.css create mode 100644 doc/Doxygen/footer.html create mode 100644 doc/Doxygen/header.html diff --git a/README.org b/README.org index 58df48f056..580ce67d33 100644 --- a/README.org +++ b/README.org @@ -1,9 +1,9 @@ # -*- 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 -#+DATE: 20th April 2016 -#+LINK: http://www.openfoam.org +#+DATE: 20th June 2016 +#+LINK: http://openfoam.org #+OPTIONS: author:nil ^:{} # Copyright (c) 2015-2016 OpenFOAM Foundation. @@ -23,9 +23,9 @@ [[http://www.gnu.org/licenses/]], for a description of the GNU General Public License terms under which you can copy the files. -* [[http://www.OpenFOAM.org/git.php][Download and installation instructions]] -* [[http://www.OpenFOAM.org/docs][Documentation]] +* [[http://OpenFOAM.org/download/source][Download and installation instructions]] +* [[http://OpenFOAM.org/docs][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://www.OpenFOAM.org/bugs][Reporting bugs in OpenFOAM]] -* [[http://www.openfoam.org/contact][Contacting the OpenFOAM Foundation]] +* [[http://OpenFOAM.org/bugs][Reporting bugs in OpenFOAM]] +* [[http://openfoam.org/contact][Contacting the OpenFOAM Foundation]] diff --git a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/DelaunayMesh/DistributedDelaunayMesh.C b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/DelaunayMesh/DistributedDelaunayMesh.C index 7c6fb584f1..c620bea282 100644 --- a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/DelaunayMesh/DistributedDelaunayMesh.C +++ b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/DelaunayMesh/DistributedDelaunayMesh.C @@ -957,7 +957,7 @@ Foam::DistributedDelaunayMesh::rangeInsertReferredWithInfo } 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 // pointToInsert and an internal or internal boundary point. diff --git a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/backgroundMeshDecomposition/backgroundMeshDecomposition.C b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/backgroundMeshDecomposition/backgroundMeshDecomposition.C index b0ef8a48b0..88c31a0f7d 100644 --- a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/backgroundMeshDecomposition/backgroundMeshDecomposition.C +++ b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/backgroundMeshDecomposition/backgroundMeshDecomposition.C @@ -1434,7 +1434,7 @@ Foam::labelList Foam::backgroundMeshDecomposition::overlapProcessors //// map().distribute(testCentres); //// 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(), false); //// @@ -1551,7 +1551,7 @@ Foam::labelList Foam::backgroundMeshDecomposition::overlapProcessors // map().distribute(testCentres); // 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(), false); // diff --git a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cellShapeControl/cellShapeControlMesh/cellShapeControlMesh.C b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cellShapeControl/cellShapeControlMesh/cellShapeControlMesh.C index 8c597b90f1..8c1da2afc5 100644 --- a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cellShapeControl/cellShapeControlMesh/cellShapeControlMesh.C +++ b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cellShapeControl/cellShapeControlMesh/cellShapeControlMesh.C @@ -746,7 +746,7 @@ Foam::label Foam::cellShapeControlMesh::estimateCellCount { 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 tet ( cit->vertex(0)->point(), diff --git a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cellShapeControl/controlMeshRefinement/controlMeshRefinement.C b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cellShapeControl/controlMeshRefinement/controlMeshRefinement.C index b22e27393e..79e1531468 100644 --- a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cellShapeControl/controlMeshRefinement/controlMeshRefinement.C +++ b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cellShapeControl/controlMeshRefinement/controlMeshRefinement.C @@ -31,7 +31,7 @@ License namespace Foam { -defineTypeNameAndDebug(controlMeshRefinement, 0); + defineTypeNameAndDebug(controlMeshRefinement, 0); } // * * * * * * * * * * * * * Static Member Functions * * * * * * * * * * * * // @@ -396,7 +396,7 @@ void Foam::controlMeshRefinement::initialMeshPopulation << ", alignment difference = " << alignmentDiff << endl; } - // @todo Also need to base it on the alignments + // TODO: Also need to base it on the alignments if ( sizeDiff/interpolatedCellSize > 0.1 @@ -561,7 +561,7 @@ void Foam::controlMeshRefinement::initialMeshPopulation 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) { insertPoint = true; diff --git a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/conformalVoronoiMesh/conformalVoronoiMeshConformToSurface.C b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/conformalVoronoiMesh/conformalVoronoiMeshConformToSurface.C index ae550bd8a3..9567b8886b 100644 --- a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/conformalVoronoiMesh/conformalVoronoiMeshConformToSurface.C +++ b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/conformalVoronoiMesh/conformalVoronoiMeshConformToSurface.C @@ -104,7 +104,7 @@ bool Foam::conformalVoronoiMesh::reconformToSurface() const } -// @todo Investigate topological tests +// TODO: Investigate topological tests Foam::label Foam::conformalVoronoiMesh::findVerticesNearBoundaries() { label countNearBoundaryVertices = 0; @@ -1732,7 +1732,7 @@ bool Foam::conformalVoronoiMesh::nearSurfacePoint const scalar cosAngle = angleBetweenSurfacePoints(pt, closePoint.hitPoint()); - // @todo make this tolerance run-time selectable? + // TODO: make this tolerance run-time selectable? if (cosAngle < searchAngleOppositeSurface) { pointIndexHit pCloseHit; diff --git a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/searchableSurfaceFeatures/triSurfaceMeshFeatures.C b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/searchableSurfaceFeatures/triSurfaceMeshFeatures.C index de0e6c4753..902eca86fe 100644 --- a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/searchableSurfaceFeatures/triSurfaceMeshFeatures.C +++ b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/searchableSurfaceFeatures/triSurfaceMeshFeatures.C @@ -91,7 +91,7 @@ Foam::triSurfaceMeshFeatures::features() const surfaceFeatures sFeat(surfMesh, includedAngle_); - // @todo Need to read on a per region basis + // TODO: Need to read on a per region basis boolList surfBaffleRegions ( surfMesh.patches().size(), diff --git a/applications/utilities/mesh/generation/foamyMesh/foamyQuadMesh/insertFeaturePoints.C b/applications/utilities/mesh/generation/foamyMesh/foamyQuadMesh/insertFeaturePoints.C index 6ac1bc9bab..1cf848eec4 100644 --- a/applications/utilities/mesh/generation/foamyMesh/foamyQuadMesh/insertFeaturePoints.C +++ b/applications/utilities/mesh/generation/foamyMesh/foamyQuadMesh/insertFeaturePoints.C @@ -97,7 +97,7 @@ void Foam::CV2D::insertFeaturePoints() } // 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)); if (debug) diff --git a/applications/utilities/surface/surfaceFeatureExtract/surfaceFeatureExtract.C b/applications/utilities/surface/surfaceFeatureExtract/surfaceFeatureExtract.C index 84f00b6987..9336b30d1d 100644 --- a/applications/utilities/surface/surfaceFeatureExtract/surfaceFeatureExtract.C +++ b/applications/utilities/surface/surfaceFeatureExtract/surfaceFeatureExtract.C @@ -375,7 +375,7 @@ triSurfacePointScalarField calcCurvature ); // Calculate weight - // @todo Voronoi area weighting + // TODO: Voronoi area weighting scalar weight = calcVertexNormalWeight ( f, diff --git a/bin/tools/doxyFilter.sed b/bin/tools/doxyFilter.sed index 3e6e921b14..9b7cfd86f1 100644 --- a/bin/tools/doxyFilter.sed +++ b/bin/tools/doxyFilter.sed @@ -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/c\ \\warning @@ -150,13 +143,6 @@ s/^ // } -/^Deprecated *$/,/^[^ ]/{ -/^Deprecated/c\ -\\deprecated -s/^ // -} - - /^SourceFiles *$/,/^$/{ s?SourceFiles?\\par Source files\
  • %fileName%
    • ? diff --git a/doc/Doxygen/CFDFoundation55x55.png b/doc/Doxygen/CFDFoundation55x55.png new file mode 100644 index 0000000000000000000000000000000000000000..14a094fbb9e607ffb67cb67e9c8c64fcd3d80cb1 GIT binary patch literal 496 zcmeAS@N?(olHy`uVBq!ia0vp^<{-?$1|(P9zT^g^Sc;uILpXq-h9ji|$mcBZh%9Dc z5LE?X#;QLJCO|>S64!{5;QX|b^2DN4hVt@qz0ADq;^f4FRK5J7^x5xhq!<_&b3I)g zLoyoQ&f1uF$Uva2{&we-h1&iHPB9B~9?!UylltNcm&mP|osz0bSw}B0nuWwE2mNMP zQ_FOX&*Ma4d)bSWn#Zo+&zArHIoT#cef1hG8IFv#m+z+he7XAMs+(?_cUse|+TZTe zIKFSzo;ta0xxWQxaWc#bI>S5hao34L*C#uaiedyU*SSQ!o^t8JtjiCBdJW4MkG%eH z<+EYRIyWb))kS?@^3q(FuU`sN9e6!;<3baOWbxf6U!4x09J;xhLD?y1v;Habc*i*Z z-`8eYDhdmxdVlra!}ee*vw>3Heue|u>_=>uMqP@uuGMwz(^fhz3buXe<)VqjH!el# z=@&DY9J%TvY;@hy*=n^;2h>p=GT~R=zRL8-%sBhNI}Dz#elF{r5}E+U4A~g~ literal 0 HcmV?d00001 diff --git a/doc/Doxygen/Doxyfile b/doc/Doxygen/Doxyfile index ddbe275ff9..dccca6d8a8 100644 --- a/doc/Doxygen/Doxyfile +++ b/doc/Doxygen/Doxyfile @@ -32,26 +32,26 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # 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 # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = +PROJECT_NUMBER = $(WM_PROJECT_VERSION) # 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 # 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 # 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 # 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 # 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. # 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 # 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 # Note: If this tag is empty the current directory is searched. +#INPUT = $(WM_PROJECT_DIR)/src/OpenFOAM/global INPUT = $(WM_PROJECT_DIR)/src \ $(WM_PROJECT_DIR)/applications/utilities \ $(WM_PROJECT_DIR)/applications/solvers @@ -1067,7 +1068,7 @@ HTML_FILE_EXTENSION = .html # of the possible markers and block names see the documentation. # 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 # 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. # 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 # 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. # 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 # 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. # 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 # in the HTML output. For a value of 0 the output will use grayscales only. A diff --git a/doc/Doxygen/OpenFOAMdocIcon.png b/doc/Doxygen/OpenFOAMdocIcon.png deleted file mode 100644 index 705a314103c5da2d696e3ab829aac944555f8925..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1240 zcmV;}1Sk86P)Px#24YJ`L;(K){{a7>y{D4^000SaNLh0L01FcU01FcV0GgZ_00007bV*G`2igP= z4Fwg-;Glv400dY`L_t(o!{wJZENz;5lL+SU`A)^%-x{&61l|~Bk3UJqYjYe03N`op+(GnWKJbWVaD_l zoVCD-WU_tJyX$>?zZvwK9vo;$1mgrrsLE(W6-A^M7gQC=lONq{tVP$hY&exXdAuEC z>WRm8pN#;(ih8?mNy5D+qDw$T48e)E&dwlECxROk@qP%0ytea*n?novq`%nt)tKao zU#qd+Yu(O!000QNwq;#XIv3G$BO-^6oo?TIpsiTI`o35a=#jUn7a zJof3iQ>M4=im7%3%05-a^Q3TcZDmIgD1waa3W}ro`nC@?jt8QkTY5XcAb?C<+*61U z1j^Xz!DVG7;iOXqWa-f8j+^rV5CrBK)I|_kbfI~3k(~Wf&^QRH$Za=Ngn=$FXi&K^ z=hU0F@-8%Z4510-V9o%VrrI;WM&K`iVdVwh$l*mPRRy&ZD&~E=Ag2_RR14@Kkk{E7 z)7&EfG}W6epgRG4--NEac8L0(NsEXT{AlI;T~&R0pVssoxGF?e5|16dn3?JOrgG0` zwS?-cA_Wzt;VxB0l<}g4k5@&%zF6k?{T-9(&%n3Ir!$fYWkW)P$BiD+9s~{%DGl(O z&Oi864Y-A%%ZSJJ{%Zg)-dBE7M3*Yy0+@7TMc7)?p{l6LtYP!^*Y!v{?Rpi}V<78t zA*#vEsN+phJ)|hsNMY^uWhtj9C{9iDh`IXF5r(9G7@&;J>Km+B)&fVU8F zBBEoiE)JCx`<+=W9~+2`a&NQ+)>IO&er$MfBJH-L%Reoqbx{~2iF+`>7P zc6(IahR+wufa}TA+0Yc^R^Rsd(O`a{Z@gxzgPYr3wFUFS?fdZnQP>w%hV z!CDDC1bi}(4-UkB3a}YC2Bd&a;4rZ5asl}NwZ8$LHOWL#m`Er90000Px#24YJ`L;(K){{a7>y{D4^000SaNLh0L01FcU01FcV0GgZ_00007bV*G`2igP= z4FU&t7)K2N00b{dL_t(o!|j(#Y?W0Mg};6N|G$^MXbUYbk<^Blf{%((Fd;?-qb)>( zk%2}d3Z#j^1i?GPM}o+$A(nt50d!Dfj0r(+Ei;3n1Bsd-qC)V20xAkcDk<&lf0ly+ zu{_GXl}b$9vy-z=*2+F>uYC?&=CB^CnJbHs4>9|9&@-t&!ZV9|8p=>t6L14kf5Hm0 zB(M#b9Rl3H=76F zq_wr}jkh*LL{TH?iyj(S(h`p|tVObFOhTBQr3Fb?p87a_CJ4~Frj5s2j~;Hrxmq%* zU1ur)&`=xfS=!>?Hq%ltGe>;nSVu=3%bVd#io$P`iSXDt!p$KP5nUhc_;hsZkzc9^ z!k15j_aFd}@W+;STKQZ|gPob}KXjsP_r7Dr20;{Q^Q`Grs{`khPZdTCGrzuRYt`5L zc5NjHenLEZ;Wh-8yca)i<~9I$ulA;QzfZG6Z7QoDvE09tccallH z|Mx9-c5Xvmuo1CG5@BcsQ)(*P<5(CrvNJBO&lfwmZ{-A_9<=3b@bePru8V&HGvZi` ztr|FJP+79oOMopKQosGidl^vp6rx_i3z5HM@Q6ucHVxpnXATNegW7{GO5+QVf0EMT^DYb^ri%Ya7s;Om-mV> zL$W6o7mPYb_4lp~Mb`pE1@O?tuE||2AqrX-c3Ub8DoqR=S6$i`#~w2)kBQRfUVL^8 z_(h=QWKz5TF@fjr9(>eH%LMosCSPBX3g~z3+kCxUx>OIF?|EJHdn83Ih%@Q*O>GxKuJ-Qs2)|^X=WZH05>Nrso4w~ z4z`#~>ck}{u(CG!JH|SJdEu@dQyvUR2HoZa6QiKwR56KuE in the - _Header file (line 37) must be deleted before running Doxygen to - produce the correctly formatted HTML files. diff --git a/doc/Doxygen/README.html b/doc/Doxygen/README.html new file mode 100644 index 0000000000..1804b7f393 --- /dev/null +++ b/doc/Doxygen/README.html @@ -0,0 +1,227 @@ + + + + +Building the Doxygen help for OpenFOAM + + + + + + + +
    +

    Building the Doxygen help for OpenFOAM

    +
    +

    Table of Contents

    +
    + +
    +
    + +
    +

    1 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. +

    +
    +
    + +
    +

    2 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 +

    +
    +
    + +
    +

    3 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 $WM_PROJECT_DIR/doc/Doxygen/html/index.html +
      • +
    +
    +
    +
    +
    +

    Date: 18th June 2016

    +

    Created: 2016-06-18 Sat 10:13

    +

    Emacs 24.5 (Org mode 8.2.10)

    +

    Validate

    +
    + + diff --git a/doc/Doxygen/README.org b/doc/Doxygen/README.org new file mode 100644 index 0000000000..07568578a4 --- /dev/null +++ b/doc/Doxygen/README.org @@ -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= diff --git a/doc/Doxygen/_Footer b/doc/Doxygen/_Footer deleted file mode 100644 index d7b19528ec..0000000000 --- a/doc/Doxygen/_Footer +++ /dev/null @@ -1,22 +0,0 @@ - - -
    -

    - Copyright © 2011-2016  - OpenFOAM Foundation - | - OPENFOAM® is a registered - trademarks - of OpenCFD Ltd. -

    -

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

    -
    - - - diff --git a/doc/Doxygen/_Header b/doc/Doxygen/_Header deleted file mode 100644 index af6f4fdad9..0000000000 --- a/doc/Doxygen/_Header +++ /dev/null @@ -1,44 +0,0 @@ - - - - - OpenFOAM® Programmer's C++ documentation - - - - - - - - - - - - - - -
    -
    -
    - -
    -

    - OpenFOAM C++ Documentation - -

    -
    -
    -
    - -
    -
    - diff --git a/doc/Doxygen/css/cfdLayout.css b/doc/Doxygen/css/cfdLayout.css deleted file mode 100644 index 57a1ff569d..0000000000 --- a/doc/Doxygen/css/cfdLayout.css +++ /dev/null @@ -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 */ diff --git a/doc/Doxygen/css/cfdNav.css b/doc/Doxygen/css/cfdNav.css deleted file mode 100644 index 662442034f..0000000000 --- a/doc/Doxygen/css/cfdNav.css +++ /dev/null @@ -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; -} diff --git a/doc/Doxygen/css/doxyMod.css b/doc/Doxygen/css/doxyMod.css deleted file mode 100644 index 1831a683c8..0000000000 --- a/doc/Doxygen/css/doxyMod.css +++ /dev/null @@ -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; -} diff --git a/doc/Doxygen/css/doxyTabs.css b/doc/Doxygen/css/doxyTabs.css deleted file mode 100644 index c97c25ee55..0000000000 --- a/doc/Doxygen/css/doxyTabs.css +++ /dev/null @@ -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; -} - diff --git a/doc/Doxygen/css/doxygen.css b/doc/Doxygen/css/doxygen.css deleted file mode 100644 index 4958570ce3..0000000000 --- a/doc/Doxygen/css/doxygen.css +++ /dev/null @@ -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; - } -} diff --git a/doc/Doxygen/css/img/OpenFOAMlogo.png b/doc/Doxygen/css/img/OpenFOAMlogo.png deleted file mode 100644 index 6d9e2f698b4052636fad0c08cb0fbcb539fd2202..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 6140 zcmWky1ymGI7)J#uL8Kc5>5@A*1SF2`mKNzagp-h?Q@TN#1H2;z1f;t~1f)|!={%5< zzW@Gr-|W0Mvv1$dH}n1Ci`LOnCLy9H!ok5IQB_gU1Nw2GaS=QOp2>eJ_kix9wYstb z4)*`MpuHp&7$JP8V&Z{=Lrn31yN8pVOA8F*d#Y+G;x9iUc+5$@l3yYV4AFTi8hgsa zU0m#3J#pmS?W{cQY*`Ubo{p@_s+u}RA*3`oI5f7Z3Qz;@g#)CI@vG^p0h#MZtlZoL zxGzFpIP+w`*bwzld7>*^uR8Lbr(ZZyWI*Ir+%np0ygW;9HJ2S^jI#W>szX|kl=2{C zxZqvH?e*IChZ0*|;+Bmqf2BtQ^Lm$^7n~~*R~?571PJh9j6w3?M_LEss3_D?Nj#ME z!9U3StJuFZPZg&rGqv#L83_rhjD zXjRTzvnW2uob&F=Q{qKD7OF6f1KzowC=9+Yn*?b{@Z4Nt@ww+%Z|T4VaeIhj+ zVm2;qZtU0{jHgoEM=v^!3fEt+DExEgc2Mxc&Z?96DHsx>reRRM;n6Bn(aA8&Pe52> zd2_)lV9>9COZC?tgZv>u}S&dtGI(__Ok__ySqE@lvgAv(;QVz z`7lV`L6Ad4WU5elp}~1*fV*d)Idd9*fUF`C! zp$IcSH+Q6etZg5^_IBMQf|SX0cNvJQ&-<=&yP3(bCK}B*eMUK*yzi@=CX2m&eJ4tF zZ33?a!qsVn-1zRO#l^*K?d)n{XD~K4c0xkJ?w=zVmVO0_2Sk~W5jC!4++-4l&oW}1 zrXsBnQJ7^?h$lmT`pu0$F0{b39`@aK!)!~Dd}h3R+%aoU#=>F0sb;Yiq21!(?5tjH zSh@XsBiybYX5JZyWDs*rN=m}%DvHfGIzP8R-=B}m5&c>5Z?WE)2E}dt`t_EPbinaP z0kcN3Ingl@4>hvtx;lkQL-aH(d1zyOeVr_TwZ;4)w`$~L7A3(9v;prptlm+Co-*bb zEnB3f!7Q3}yKs*@;m?2b5r<8Ynq2BrQa3%jJ zN(I(rinYmfJi0EcAm*J=dWY@!Ddt<15?APpvb^@<@YtmN7hY#d0vv;2q$FbEvpSzU z3zc5)JgVn*x!E)F-UECce^Zx%wqHD8OGt=Yayo2zT=G{aldnZ_vT!?p>$mx zov!uER87oD>tTmH8E%Uw2IawyLS6j1W*MeOj2Ab4{VGSPI0X~MCuJ0gjYhGd#~ek9 zhUIF5!(H|oYOt-h#-^sgl8jqCd7K-+h<=yF5#5`$UFb=Sii+x5US@7K*K&6Uu_Ukz z$i#E1sUS-ymAcbt*iMQi)62s11}%3o&}gk%gNP6urFeP{VV$9Lf#`$;`zY*lbZCvs zzlQyox&Dj4Yr5sr#>U2Ew6xzZOHVk@5F6`uAYL*BRq#MVH4$dV^)Q-+rV|#5&AWLWEgTKwWq_LS9xC;?XI)5V&e)ul{uGfBxf6h)2ikqHxI;vrf8XIGJ z8E{1jfXCiUB^}u2QP$^3PO;Vb4zSHYf?}m1JHdTm0*o_VOjgeoQ!1r9(LUUo_2Ka4 z4~JT5o8>~E{kf(vKCY@vDYseeHx8qlQv7)xnU|?sCnHzziyebYt&O6!jHm^Q{tb$L z95pX@$e-386VV{5d|dyY^wGw5oU0nmE<6445QC~C`#g9GHE(6~Fm(G7n|T?poLmPq zi4ZvG)Pm*&C?Bgn4ybx{?c`-2;&9pSFumO_eN^iwCmY)_9h*@iHPW=8E`7YlMj03S z8$f|vQW=*S+T)Xxoy`-7p`nD#+4eY^b2>I5L5What-XCDPaRKILE%LxD{Bnf-QAtN zkZkepQ+DM9+sR^0Am@OLl{NQd%&YQMv+L>Y&5{X{#wjsFZn`hpZ4PJ2D=9@-_z5)z zWlfhGt(~WsW!+j_+}+O)Xo!oY5u){9u5;2a4my2O^?1kS=rR=T2h3^Ijg+F^uPe(FON77SG0}}}v3VGKrq~XqE1^22R z`!S7WFa3;q!hW$DD@2AH(%$+Hk+e zd@as@*!4k*T$t&^m!+Y;Z{Nt7m|nXg*RB&&Q&QwahhX0AkfU@^K zz`z$TUTkNs-QZoF@2KB2d!ug;=IbK6!|>G~8T{&i1YDonZI69wY8J)$e{16Cq_U?^ zNCp_+y0`$}ocr~w_IOhJ@^n&L)h}1c<$A%}+xs^LBbcTcrQHQjVu^N(=Dbi+R6$;L zjJG)z!#+)9e>dQoqh*rx(zrS}SgPtdc*OXEtVl1KJLbmob_+CwS!y&|5Q4Y;jqvO| zGz+Myt(B)#?7-gP>#b^zPL09pjkz~2E>0gP=;`Z=`)u3Jug$g6K*<~rr}J7!XMl{D z;)im?#>UE5>OJ`V=TFEYYSlg@BO~LBneP8ET4YzujT(3SK04|EU`lXTPdIUOLM-P| zxoE{DjD!aM#`cIIjHCXg{XT8jZJ*+R@GW`=00dm9C1z3FT&+#vo#XS6?mcn0%Vz*L z^o@@{fsz@wdI@lm?y5gaQwvu@|LKdSsIX`!nw9v1i;wTY^Os!4{3c|($q^uru$&wQ zqHsCOTrnS+wS>zxCE0g;2Scd~%S7 z&3>tre+LFP2VS*wyNiu3uMf|I2||NQO1Ma*7}9+)OS5M92$_JMj(}?o%p1Xs)G}X{ zL}sa)h8e;d`AE_<6Rz_q9tGXPAnYAEJ3YC9(nxb(pX3CKtE+2Tiaj$k^TgpmA`3(R z={@`5o2WAI=JusUNY4GikwFeNw$Q@DXAS-x;kx=tX}n~Aj~JgP0lG-~){}6_|IM_`J{v{X^mJMnKIvGK&z_#m?(}SiWe)x6 z2_}-2pf8Ogn3TZ#N1c;l)M!#mJVS*hWXCfq*AYd{D^&t8Vb{zIb-a>(u_oNg3Od%n z+J61-a7AbtACvYAAA`ZX^gSgAUeOCg<6YgGW0FJ!6R@$tJ1#lXtp$iatoqOkyW>hC z4gfN)4Y>CDHp&b?Hph7(>eW}?PBYGh5)Zs-8b4O9eJw7UeB1q|eq80^p$!A8@r8Us@UG#j>H5;wNkh*n+BjA~)+?eo^aE4vvic zS+4inV0%yhUUyNYd!~K^zaaLB_=$EUQK;?4#3D0 z$}0_PHQPI%@tXFPlfA0WU6Ft)ix-9-(|q~^#mv1CB&m1H)ox+)w?L@lcc;tQV^Gjk zK}qqP%uHI~OjjXRh}e-aDOw*5rwn24YHCalG!9`5hMcLYI0`0HZHgXW%-chOywv@{ zo|_|~ZVA=(Gx}ow)bTZ$_HjOI>TRAA^h;7|T2^>{y{M0mkFC8uy{MacpqPb}rfw;( z9U?<9@UVp3;C>lj3bcTCM$v_wjmkx2DdAjvuz5uzT|YlgSgWjX;44i1Bf0jEcw^3ZTn4o+(J%(LCJ z<F<7B}(PW1ZiC@wY+ym`@0Y^noYEE zn=DUE=uJ2R`6dFJB6$2b5mXgH!mzrzS=?A)mzAGZw0fe{zu@ScwB&IXt|s`-$#}*e zw$xHDf-hWC!YimEw3M7#V_0eGJ3x@|fe8u-q0~Wce*R~Ce6fH7I6gjBdwqF%xxTrn zXKc)k_jd%k6I1G-&7{Ufa9=rrF&X2qG_<jE_zt^c0Q(j_Df1m z&QSNkHQnhlYb|~bGFQ{nvu16%OrHyFL#|0{Y;KgK4FJnRuntO34qry&<9yjPn=1#?(g4k$I? z1)K^X#C=B*m^mK8!N)Q;WWc_ZwF&<@-^h5A0%!m=HKIR~y*uEF#KAQ;*uFxm*FjWt zG(bM9x6RJ~1iya$`p(^Rb$aDf!zPRkFIYQ><^MEbCBVhQ%NkJtNTy=BF1xMmB`&mU zX$c8gTA&q0x^gXk>zzaoLxKQ*zO+eZ`$CfDnoq#2VI8ms>l+*HXS=Uj#P;tp?ASX0 z=@Xh7WfVT^?a;Lgc&bl5XRr&ddra!V=zVh`tg5QYIOi3de782NhMl;S{4~+s2@O*_ zMAs%eaCBbw)4Z`AJf7ZYc%#141Me*Q>WU;yUuk(?ZlZyEH1iAogaQrTA&p?{Lo^9l zDJN`eG&5Ia@t4MBd*ImE$0dIaK3r_>jcMi^CR#*FQH^{fVbI~G1fWV*RyIrPok8?= zlW-+94Gq9CP0h`JCMvx71xzUi7|#!7bTD&274vL{$ApKOWv;bV-aFuL-h~s~|CrWhDSq>2tg8k9wodGgX7z<18xA_cMiUqB`wg zocImKapVHg2CxT#K(r4>VvFGhryTlFGD5-{t6fL+{e9lZ?^1A0-0HwvUsc#jyI&$; z-)f}hE|Nd!Ta_FgK!U3}?*Q`Bva)*Wu{k^q-sHRjCN!(6D`P-K+5lY{Vwc!AM4ur ztP*FY!o;RJo`<;j9UwNfkP?d4)@%V5hw`0)x7&9xg!x{R`=1^>z|u6o`xA<*gz2F-T0ggj*fDH!Ku~q*K`uTrFG1T9#)SmcW#y7`}T9mNMyWeWo$GF9jK2x)9Pp2 zZg^Pdn^G``+jeT3T9h43ebSonod>K>0ueDUp^V26sQ* z)(s5}B_QH$?`C3TG_HqHVRx}Y=!3U1Uy)9ClXI;IAppPkm)mmyQrSx@H)|Ap5l+qK|VfpdVRavCiN6` zeHzqH#Tsi2QG?4bB`qz|ot>RragPYF!=wDl-GzESzz{-c-$+onDP3*HhwG^x21--W zXCx*jeqeowkFTy_@Nv$(PU~B#O-TYH$s|(fvwlee^k^u>6!0Mi+1mP~lJvu8N4q=y zn7meT3b*v_?X|@wpRhNnK^#(2OyP2$JkDRg-kC?^cl3_PNc`;~76J}ErQA#;8Qqh? zQ5kHUx!^!=?*l+8e2Zgpm_X3q7sCg^rnmtsA@A@15`kI#R8WAUtgK8g;wXE#+)f9v z&m6z1YC9$(B_#zaBRWeh`|_R#7Ou+B5G@bDtr-!NU0b_IVV3c9KmP5;Ps1iG0*Xt^ z*H@z8x@F{~I7{6Dmsc*Z7A%l5*m?&h%Erco3E5( zr*GF(-w(uWICflPT3`B?4!KOi>I=DwYz|$u>vtPYF-r`9BPuB=8NXtWNc_D+fjpZk zNwoS<6|9jBap8?`d1KIpXNk%w1VFdsM0QUd@000010RaL60s{jB1Ox;H1qB8M1_uWR2nYxX2?+`c z3JVJh3=9kn4Gj(s4i66x5D*X%5fKs+5)%^>6ciK{6%`g178e&67#J8C85tTH8XFrM z92^`S9UUGX9v>ecARr(iAt53nA|oRsBqSsyB_$>%CMPE+C@3f?DJd!{Dl021EG#T7 zEiEoCE-x=HFfcGNF)=bSGBYzXG&D3dH8nOiHa9mnI5;>tIXOByIy*Z%JUl!-Jv}}? zK0iM{KtMo2K|w-7LPJACL_|bIMMXwNMn^|SNJvOYNl8jdN=r*iOiWBoO-)WtPESuy zP*6}&QBhJ-Qd3h?R8&+|RaI72R##V7SXfwDSy@_IT3cINTwGjTU0q&YUSD5dU|?Wj zVPRroVq;@tWMpJzWo2e&W@l$-XlQ6@X=!R|YHMq2Y;0_8ZEbFDZf|dIaBy&OadC2T za&vQYbaZreb#-=jc6WDoczAeud3kzzdV70&e0+R;eSLm@et&;|fPjF3fq{a8f`fyD zgoK2Jg@uNOhKGlTh=_=ZiHVAeii?YjjEszpjg5|uj*pLzkdTm(k&%*;l9Q8@l$4Z} zm6ev3mY0{8n3$NEnVFiJnwy)OoSdAUot>VZo}ZteprD|kp`oIpqNAguq@<*!rKP5( zrl+T;sHmu^si~@}s;jH3tgNi9t*x%EuCK4Ju&}VPv9YqUva_?Zw6wIfwY9dkwzs#p zxVX5vxw*Q!y1To(yu7@dCU$jHda z$;ryf%FD~k%*@Qq&CSlv&d<-!(9qD)(b3Y<($mw^)YR0~)z#M4*4Nk9*x1lt)=I7_<=;-L_>FMg~>g((4 z?Ck9A?d|UF?(gsK@bK{Q@$vHV^7Hfa^z`)g_4W4l_V@Sq`1ttw`T6?#`uqF){QUg= k{r&#_{{R2~EC2ui00jUA06+)}0DlP_NU)$mf&l>lJ8I*E{r~^~ diff --git a/doc/Doxygen/css/img/bg_bullet_full_2.gif b/doc/Doxygen/css/img/bg_bullet_full_2.gif deleted file mode 100644 index 98807b21e1924965ac7c8f294b91e2a7c4b39860..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 50 ucmZ?wbhEHbWMyDwn8?6jo6*kz13DlENZf&gn}Lx-#$&?*$0kNb25SJWVg|kd diff --git a/doc/Doxygen/css/img/bg_bullet_half_1.gif b/doc/Doxygen/css/img/bg_bullet_half_1.gif deleted file mode 100644 index 04e6f94141bc53e94305667bff3619674efee4ca..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 825 zcmV-91IGMENk%w1VFmyO0QUd@000010RaL60s{jB1Ox;H1qB8M1_uWR2nYxX2?+`c z3JVJh3=9kn4Gj(s4i66x5D*X%5fKs+5)%^>6ciK{6%`g178e&67#J8C85tTH8XFrM z92^`S9UUGX9v>ecARr(iAt53nA|oRsBqSsyB_$>%CMPE+C@3f?DJd!{Dl021EG#T7 zEiEoCE-x=HFfcGNF)=bSGBYzXG&D3dH8nOiHa9mnI5;>tIXOByIy*Z%JUl!-Jv}}? zK0iM{KtMo2K|w-7LPJACL_|bIMMXwNMn^|SNJvOYNl8jdN=r*iOiWBoO-)WtPESuy zP*6}&QBhJ-Qd3h?R8&+|RaI72R##V7SXfwDSy@_IT3cINTwGjTU0q&YUSD5dU|?Wj zVPRroVq;@tWMpJzWo2e&W@l$-XlQ6@X=!R|YHMq2Y;0_8ZEbFDZf|dIaBy&OadC2T za&vQYbaZreb#-=jc6WDoczAeud3kzzdV70&e0+R;eSLm@et&;|fPjF3fq{a8f`fyD zgoK2Jg@uNOhKGlTh=_=ZiHVAeii?YjjEszpjg5|uj*pLzkdTm(k&%*;l9Q8@l$4Z} zm6ev3mY0{8n3$NEnVFiJnwy)OoSdAUot>VZo}ZteprD|kp`oIpqNAguq@<*!rKP5( zrl+T;sHmu^si~@}s;jH3tgNi9t*x%EuCK4Ju&}VPv9YqUva_?Zw6wIfwY9dkwzs#p zxVX5vxw*Q!y1To(yu7@dCU$jHda z$;ryf%FD~k%*@Qq&CSlv&d<-!(9qD)(b3Y<($mw^)YR0~)z#M4*4Nk9*x1lt)=I7_<=;-L_>FMg~>g((4 z?Ck9A?d|UF?(gsK@bK{Q@$vHV^7Hfa^z`)g_4W4l_V@Sq`1ttw`T6?#`uqF){QUg= z{r&#_{{R2~A^8Le00930EC2ui00saC06+*90RIUT`0L-Vg9is99B8m$Lxd221q1*) D%&UxL diff --git a/doc/Doxygen/css/img/bg_bullet_half_2.gif b/doc/Doxygen/css/img/bg_bullet_half_2.gif deleted file mode 100644 index 9be6bc623d141645afceebe8c36a34711102d034..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 99 zcmZ?wbhEHbWMyDw*v!CSo6#RoJ}aedY5CL*8xLJPa`Eo#_n-g$`}hC i0|N(x4oDJYh69HHgCK_s!-55ljqHL<3K<3p4AuaX5*rBs diff --git a/doc/Doxygen/css/img/bg_corner_topright.gif b/doc/Doxygen/css/img/bg_corner_topright.gif deleted file mode 100644 index 95b146294bb3ffdc32b3ecdbeca7cfa00d32a132..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 60 zcmZ?wbhEHbP-#>r;{PE+*w{PFReEIVE^XK>P-@kkJ z?&ZsuPo6w^`0(NV`}gnMxpV8*ts6IPT)ler%9SgZFJHcN>C(lE7cX46aOTXJlP6Ce zKYsk^(W6I>965aW@S#J84jw#s;J|@>`}XbKyLZ>FT|0N~+_7WFwr$(CZr!?N%a+ZX zH*egyal?iU>({RbI)i~Mp!k!8k%2*%K?kH8-<#KObFbx$V$v3yH_`7mDafw-*kKa#m~4zR{oyPrS7XNRM+Olt?4Vz z-`4KJ;jN=B+1Ka76f#+S+H_|L->Gx^8F+o=7SCf$)lu$US9*SeveNzF%oTf2ad zR_&fr21Os4Lv?K0KE)?W_pC)60|1L9 Bw2A-# diff --git a/doc/Doxygen/css/img/bg_head_corner_topright_25px.gif b/doc/Doxygen/css/img/bg_head_corner_topright_25px.gif deleted file mode 100644 index 1bcf6a6a4c610a6a28601037b62c3e838f141381..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 389 zcmZ?wbhEHblw^=(xXQrr|NsBLfB*jZ^XK>P-#>r;{PE+*w{PFReEIVE^XK>P-@kkJ z?&ZsuPo6w^`0(NV`}gnMxpV8*ts6IPT)ler%9SgZFJHcN>C(lE7cX46aOTXJlP6Ce zKYsk^(W6I>965aW@S#J84jw#s;J|@>`}XbKyLZ>FT|0N~+_7WFwr$(CZr!?N%a+ZX zH*egyal?iU>({RbI)i~Mp!k!8k%2*%K?kH8N2_3l^xdS!m{UtIJ$14rbW>UT{K~g;m7+1|elW + + + + + +
    +$generatedby   +doxygen + $doxygenversion +
    + + + diff --git a/doc/Doxygen/header.html b/doc/Doxygen/header.html new file mode 100644 index 0000000000..08815ffd22 --- /dev/null +++ b/doc/Doxygen/header.html @@ -0,0 +1,55 @@ + + + + + + + +$projectname: $title +$title + + + +$treeview +$search +$mathjax + +$extrastylesheet + + +
    + + +
    + + + + + + + + + + + + + + + + + + + + + +
    +
    $projectname +  $projectnumber +
    + +     		+
    $projectbrief
    +     		$searchbox
    +
    + + diff --git a/doc/codingStyleGuide.org b/doc/codingStyleGuide.org index 43e42c4361..e2254e144e 100644 --- a/doc/codingStyleGuide.org +++ b/doc/codingStyleGuide.org @@ -3,7 +3,7 @@ #+TITLE: OpenFOAM C++ Style Guide #+AUTHOR: OpenFOAM Foundation #+DATE: 2011-2016 -#+LINK: http://www.OpenFOAM.org +#+LINK: http://OpenFOAM.org #+OPTIONS: author:nil ^:{} #+STARTUP: hidestars #+STARTUP: odd diff --git a/src/OpenFOAM/global/foamDoc.H b/src/OpenFOAM/global/foamDoc.H index 46b69ff11d..d53c83f62b 100644 --- a/src/OpenFOAM/global/foamDoc.H +++ b/src/OpenFOAM/global/foamDoc.H @@ -23,33 +23,27 @@ License // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // -\mainpage OpenFOAM®: Open-Source CFD +\mainpage Free, Open Source Software from the OpenFOAM Foundation \section about About OpenFOAM OpenFOAM is a free, open source CFD software package released free and open-source under the GNU General Public License by the, - OpenFOAM Foundation. It has a large + OpenFOAM Foundation. It has a large user base across most areas of engineering and science, from both commercial and academic organisations. OpenFOAM has an extensive range of features to solve anything from complex fluid flows involving chemical reactions, turbulence and heat transfer, to solid dynamics and electromagnetics. - More ... + More ... \section layout OpenFOAM Directory Structure OpenFOAM comprises of four main directories: - - src: - The core OpenFOAM libraries - - - applications: - Solvers and utilities - - - tutorials: - Test-cases that demonstrate a wide-range of OpenFOAM functionality - - - doc: - Documentation + - \b src: the core OpenFOAM libraries + - \b applications: solvers and utilities + - \b tutorials: test-cases that demonstrate a wide-range of OpenFOAM + functionality + - \b doc: documentation \section usingOpenFOAM Using OpenFOAM diff --git a/src/OpenFOAM/meshes/polyMesh/polyPatches/basic/coupled/coupledPolyPatch.C b/src/OpenFOAM/meshes/polyMesh/polyPatches/basic/coupled/coupledPolyPatch.C index 4c1e351c18..3c8819d642 100644 --- a/src/OpenFOAM/meshes/polyMesh/polyPatches/basic/coupled/coupledPolyPatch.C +++ b/src/OpenFOAM/meshes/polyMesh/polyPatches/basic/coupled/coupledPolyPatch.C @@ -168,7 +168,7 @@ Foam::pointField Foam::coupledPolyPatch::getAnchorPoints 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 if (p1 == p2) { diff --git a/src/dynamicMesh/polyMeshFilter/polyMeshFilter.H b/src/dynamicMesh/polyMeshFilter/polyMeshFilter.H index ffe92dc899..05da5c8b9f 100644 --- a/src/dynamicMesh/polyMeshFilter/polyMeshFilter.H +++ b/src/dynamicMesh/polyMeshFilter/polyMeshFilter.H @@ -145,7 +145,7 @@ class polyMeshFilter // + -1 : point not on boundary // + 0 : point on a real boundary // + >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 void updatePointPriorities (