From b6d458230067b8f3b7788f4e8bec27fc82889ffd Mon Sep 17 00:00:00 2001 From: Henry Date: Mon, 13 Jun 2011 22:31:43 +0100 Subject: [PATCH] Updated doc/Doxygen --- doc/Doxygen/Allwmake | 8 + doc/Doxygen/Doxyfile | 496 +++-- doc/Doxygen/Doxygen.css | 76 - doc/Doxygen/FoamFooter.html | 5 - doc/Doxygen/FoamHeader.html | 73 - doc/Doxygen/Macros/tensorOperator.sty | 128 -- doc/{doxygen => Doxygen}/OpenFOAMdocIcon.png | Bin doc/Doxygen/OpenFOAMicon.png | Bin 1416 -> 1199 bytes doc/Doxygen/OpenFOAMlogo.jpg | Bin 8524 -> 0 bytes doc/Doxygen/OpenSourceToolbox.jpg | Bin 10156 -> 0 bytes doc/Doxygen/OpenSourceToolkit.jpg | Bin 9835 -> 0 bytes doc/{doxygen => Doxygen}/_Footer | 0 doc/{doxygen => Doxygen}/_Header | 0 doc/{doxygen => Doxygen}/css/cfdLayout.css | 0 doc/{doxygen => Doxygen}/css/cfdNav.css | 0 doc/{doxygen => Doxygen}/css/doxyMod.css | 0 doc/{doxygen => Doxygen}/css/doxyTabs.css | 0 doc/{doxygen => Doxygen}/css/doxygen.css | 0 .../css/img/OpenCFDlogo.png | Bin .../css/img/bg_bullet_full_1.gif | Bin .../css/img/bg_bullet_full_2.gif | Bin .../css/img/bg_bullet_half_1.gif | Bin .../css/img/bg_bullet_half_2.gif | Bin .../css/img/bg_corner_topright.gif | Bin .../css/img/bg_head_corner_topleft_25px.gif | Bin .../css/img/bg_head_corner_topright_25px.gif | Bin doc/{doxygen => Doxygen}/css/openfoam.css | 0 doc/Doxygen/tabs.css | 100 -- doc/doxygen/Allwmake | 30 - doc/doxygen/Doxyfile | 1589 ----------------- doc/doxygen/OpenFOAMicon.png | Bin 1199 -> 0 bytes 31 files changed, 399 insertions(+), 2106 deletions(-) delete mode 100644 doc/Doxygen/Doxygen.css delete mode 100644 doc/Doxygen/FoamFooter.html delete mode 100644 doc/Doxygen/FoamHeader.html delete mode 100644 doc/Doxygen/Macros/tensorOperator.sty rename doc/{doxygen => Doxygen}/OpenFOAMdocIcon.png (100%) delete mode 100644 doc/Doxygen/OpenFOAMlogo.jpg delete mode 100644 doc/Doxygen/OpenSourceToolbox.jpg delete mode 100644 doc/Doxygen/OpenSourceToolkit.jpg rename doc/{doxygen => Doxygen}/_Footer (100%) rename doc/{doxygen => Doxygen}/_Header (100%) rename doc/{doxygen => Doxygen}/css/cfdLayout.css (100%) rename doc/{doxygen => Doxygen}/css/cfdNav.css (100%) rename doc/{doxygen => Doxygen}/css/doxyMod.css (100%) rename doc/{doxygen => Doxygen}/css/doxyTabs.css (100%) rename doc/{doxygen => Doxygen}/css/doxygen.css (100%) rename doc/{doxygen => Doxygen}/css/img/OpenCFDlogo.png (100%) rename doc/{doxygen => Doxygen}/css/img/bg_bullet_full_1.gif (100%) rename doc/{doxygen => Doxygen}/css/img/bg_bullet_full_2.gif (100%) rename doc/{doxygen => Doxygen}/css/img/bg_bullet_half_1.gif (100%) rename doc/{doxygen => Doxygen}/css/img/bg_bullet_half_2.gif (100%) rename doc/{doxygen => Doxygen}/css/img/bg_corner_topright.gif (100%) rename doc/{doxygen => Doxygen}/css/img/bg_head_corner_topleft_25px.gif (100%) rename doc/{doxygen => Doxygen}/css/img/bg_head_corner_topright_25px.gif (100%) rename doc/{doxygen => Doxygen}/css/openfoam.css (100%) delete mode 100644 doc/Doxygen/tabs.css delete mode 100755 doc/doxygen/Allwmake delete mode 100644 doc/doxygen/Doxyfile delete mode 100644 doc/doxygen/OpenFOAMicon.png diff --git a/doc/Doxygen/Allwmake b/doc/Doxygen/Allwmake index a34eb3fd7e..fbc20d93fd 100755 --- a/doc/Doxygen/Allwmake +++ b/doc/Doxygen/Allwmake @@ -1,5 +1,13 @@ #!/bin/sh cd ${0%/*} || exit 1 # run from this directory + +[ -d "$WM_PROJECT_DIR" ] || { + echo "Error: WM_PROJECT_DIR directory does not exist" + echo " Check the OpenFOAM entries in your dot-files and source them." + echo " WM_PROJECT_DIR=$WM_PROJECT_DIR" + exit 1 +} + set -x rm -rf latex man diff --git a/doc/Doxygen/Doxyfile b/doc/Doxygen/Doxyfile index 3ef243ee83..346b976e5b 100644 --- a/doc/Doxygen/Doxyfile +++ b/doc/Doxygen/Doxyfile @@ -1,4 +1,4 @@ -# Doxyfile 1.5.3 +# Doxyfile 1.6.3 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project @@ -14,11 +14,11 @@ # Project related configuration options #--------------------------------------------------------------------------- -# This tag specifies the encoding used for all characters in the config file that -# follow. The default is UTF-8 which is also the encoding used for all text before -# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into -# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of -# possible encodings. +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. DOXYFILE_ENCODING = UTF-8 @@ -54,10 +54,11 @@ CREATE_SUBDIRS = NO # information to generate all constant output in the proper language. # The default language is English, other supported languages are: # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, -# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, -# Italian, Japanese, Japanese-en (Japanese with English messages), Korean, -# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, -# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. +# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, +# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English +# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, +# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. OUTPUT_LANGUAGE = English @@ -154,13 +155,6 @@ QT_AUTOBRIEF = NO MULTILINE_CPP_IS_BRIEF = NO -# If the DETAILS_AT_TOP tag is set to YES then Doxygen -# will output the detailed description near the top, like JavaDoc. -# If set to NO, the detailed description appears after the member -# documentation. - -DETAILS_AT_TOP = YES - # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented # member inherits the documentation from any documented member that it # re-implements. @@ -195,14 +189,39 @@ ALIASES = OPTIMIZE_OUTPUT_FOR_C = NO # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java -# sources only. Doxygen will then generate output that is more tailored for Java. -# For instance, namespaces will be presented as packages, qualified scopes -# will look different, etc. +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. OPTIMIZE_OUTPUT_JAVA = NO -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to -# include (a tag file for) the STL sources as input, then you should +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, +# and language is one of the parsers supported by doxygen: IDL, Java, +# Javascript, C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, +# C++. For instance to make doxygen treat .inc files as Fortran files (default +# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note +# that for custom extensions you also need to set FILE_PATTERNS otherwise the +# files are not read by doxygen. + +EXTENSION_MAPPING = + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should # set this tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. # func(std::string) {}). This also make the inheritance and collaboration @@ -215,6 +234,21 @@ BUILTIN_STL_SUPPORT = NO CPP_CLI_SUPPORT = NO +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES (the +# default) will make doxygen to replace the get and set methods by a property in +# the documentation. This will only work if the methods are indeed getting or +# setting a simple type. If this is not the case, or you want to show the +# methods anyway, you should set this option to NO. + +IDL_PROPERTY_SUPPORT = YES + # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES, then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default @@ -230,6 +264,32 @@ DISTRIBUTE_GROUP_DOC = NO SUBGROUPING = YES +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = NO + +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to +# determine which symbols to keep in memory and which to flush to disk. +# When the cache is full, less often used symbols will be written to disk. +# For small to medium size projects (<1000 input files) the default value is +# probably good enough. For larger projects a too small cache size can cause +# doxygen to be busy swapping symbols to and from disk most of the time +# causing a significant performance penality. +# If the system has enough physical memory increasing the cache will improve the +# performance by keeping more symbols in memory. Note that the value works on +# a logarithmic scale so increasing the size by one will rougly double the +# memory usage. The cache size is given by this formula: +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols + +SYMBOL_CACHE_SIZE = 0 + #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- @@ -264,10 +324,11 @@ EXTRACT_LOCAL_CLASSES = YES EXTRACT_LOCAL_METHODS = NO -# If this flag is set to YES, the members of anonymous namespaces will be extracted -# and appear in the documentation as a namespace called 'anonymous_namespace{file}', -# where file will be replaced with the base name of the file that contains the anonymous -# namespace. By default anonymous namespace are hidden. +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespace are hidden. EXTRACT_ANON_NSPACES = NO @@ -327,6 +388,12 @@ HIDE_SCOPE_NAMES = YES SHOW_INCLUDE_FILES = NO +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen +# will list include files with double quotes in the documentation +# rather than with sharp brackets. + +FORCE_LOCAL_INCLUDES = NO + # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] # is inserted in the documentation for inline members. @@ -346,6 +413,21 @@ SORT_MEMBER_DOCS = NO SORT_BRIEF_DOCS = NO +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO (the default) the constructors will +# appear in the respective orders defined by SORT_MEMBER_DOCS and +# SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is +# set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = NO + # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be # sorted by fully-qualified names, including namespaces. If set to # NO (the default), the class list will be sorted only by class name, @@ -407,9 +489,22 @@ SHOW_USED_FILES = YES SHOW_DIRECTORIES = YES +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the +# Folder Tree View (if specified). The default is YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. +# This will remove the Namespaces entry from the Quick Index +# and from the Folder Tree View (if specified). The default is YES. + +SHOW_NAMESPACES = YES + # The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from the -# version control system). Doxygen will invoke the program by executing (via +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via # popen()) the command , where is the value of # the FILE_VERSION_FILTER tag, and is the name of an input file # provided by doxygen. Whatever the program writes to standard output @@ -417,6 +512,15 @@ SHOW_DIRECTORIES = YES FILE_VERSION_FILTER = +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. The create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. + +LAYOUT_FILE = + #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- @@ -481,10 +585,18 @@ INPUT = $(WM_PROJECT_DIR)/src \ $(WM_PROJECT_DIR)/applications/utilities \ $(WM_PROJECT_DIR)/applications/solvers -# This tag can be used to specify the character encoding of the source files that -# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default -# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. -# See http://www.gnu.org/software/libiconv for the list of possible encodings. +# limit input for testing purposes +# INPUT = $(WM_PROJECT_DIR)/src/OpenFOAM/global \ +# $(WM_PROJECT_DIR)/src/OpenFOAM/containers \ +# $(WM_PROJECT_DIR)/src/OpenFOAM/primitives \ +# $(WM_PROJECT_DIR)/sampling \ +# $(WM_PROJECT_DIR)/src/finiteVolume/fvMesh + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. INPUT_ENCODING = UTF-8 @@ -493,9 +605,10 @@ INPUT_ENCODING = UTF-8 # and *.h) to filter out the source-files in the directories. If left # blank the following patterns are tested: # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx -# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 -FILE_PATTERNS = *.H *.C +FILE_PATTERNS = *.H \ + *.C # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. @@ -521,14 +634,14 @@ EXCLUDE_SYMLINKS = NO # against the file with absolute path, so to exclude all test directories # for example use the pattern */test/* -EXCLUDE_PATTERNS = */lnInclude/* \ +EXCLUDE_PATTERNS = */lnInclude/* \ */t/* - # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the output. -# The symbol name can be a fully qualified name, a word, or if the wildcard * is used, -# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test EXCLUDE_SYMBOLS = @@ -538,7 +651,6 @@ EXCLUDE_SYMBOLS = EXAMPLE_PATH = - # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # and *.h) to filter out the source-files in the directories. If left @@ -564,14 +676,17 @@ IMAGE_PATH = # by executing (via popen()) the command , where # is the value of the INPUT_FILTER tag, and is the name of an # input file. Doxygen will then use the output that the filter program writes -# to standard output. If FILTER_PATTERNS is specified, this tag will be +# to standard output. +# If FILTER_PATTERNS is specified, this tag will be # ignored. INPUT_FILTER = $(WM_PROJECT_DIR)/bin/tools/doxyFilter # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: +# basis. +# Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. +# The filters are a list of the form: # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER # is applied to all files. @@ -591,9 +706,7 @@ FILTER_SOURCE_FILES = NO # If the SOURCE_BROWSER tag is set to YES then a list of source files will # be generated. Documented entities will be cross-referenced with these sources. # Note: To get rid of all source code in the generated output, make sure also -# VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH -# then you must also enable this option. If you don't then doxygen will produce -# a warning and turn it on anyway +# VERBATIM_HEADERS is set to NO. SOURCE_BROWSER = YES @@ -608,13 +721,13 @@ INLINE_SOURCES = NO STRIP_CODE_COMMENTS = YES -# If the REFERENCED_BY_RELATION tag is set to YES (the default) +# If the REFERENCED_BY_RELATION tag is set to YES # then for each documented function all documented # functions referencing it will be listed. REFERENCED_BY_RELATION = YES -# If the REFERENCES_RELATION tag is set to YES (the default) +# If the REFERENCES_RELATION tag is set to YES # then for each documented function all documented entities # called/used by that function will be listed. @@ -623,7 +736,8 @@ REFERENCES_RELATION = YES # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will -# link to the source code. Otherwise they will link to the documentstion. +# link to the source code. +# Otherwise they will link to the documentation. REFERENCES_LINK_SOURCE = YES @@ -655,7 +769,7 @@ ALPHABETICAL_INDEX = YES # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns # in which this list will be split (can be a number in the range [1..20]) -COLS_IN_ALPHA_INDEX = 4 +COLS_IN_ALPHA_INDEX = 1 # In case all classes in a project start with a common prefix, all # classes will be put under the same header in the alphabetical index. @@ -673,6 +787,11 @@ IGNORE_PREFIX = GENERATE_HTML = YES +# If the HTML_FOOTER_DESCRIPTION tag is set to YES, Doxygen will +# add generated date, project name and doxygen version to HTML footer. + +HTML_FOOTER_DESCRIPTION= NO + # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `html' will be used as the default path. @@ -689,13 +808,13 @@ HTML_FILE_EXTENSION = .html # each generated HTML page. If it is left blank doxygen will generate a # standard header. -HTML_HEADER = $(WM_PROJECT_DIR)/doc/Doxygen/FoamHeader.html +HTML_HEADER = $(WM_PROJECT_DIR)/doc/Doxygen/_Header # The HTML_FOOTER tag can be used to specify a personal HTML footer for # each generated HTML page. If it is left blank doxygen will generate a # standard footer. -HTML_FOOTER = $(WM_PROJECT_DIR)/doc/Doxygen/FoamFooter.html +HTML_FOOTER = $(WM_PROJECT_DIR)/doc/Doxygen/_Footer # 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 @@ -706,19 +825,18 @@ HTML_FOOTER = $(WM_PROJECT_DIR)/doc/Doxygen/FoamFooter.html HTML_STYLESHEET = +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting +# this to NO can help when comparing the output of multiple runs. + +HTML_TIMESTAMP = NO + # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, # files or namespaces will be aligned in HTML using tables. If set to # NO a bullet list will be used. HTML_ALIGN_MEMBERS = YES -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) -# of the generated HTML documentation. - -GENERATE_HTMLHELP = NO - # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. For this to work a browser that supports @@ -727,6 +845,39 @@ GENERATE_HTMLHELP = NO HTML_DYNAMIC_SECTIONS = NO +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment, introduced with OSX 10.5 (Leopard). To create a documentation +# set, doxygen will generate a Makefile in the HTML output directory. Running +# make will produce the docset in that directory and running "make install" will +# install the docset in ~/Library/Developer/Shared/Documentation/DocSets so that +# Xcode will find it at startup. See +# http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more +# information. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can # be used to specify the file name of the resulting .chm file. You # can add a path in front of the file if the result should not be @@ -747,6 +898,12 @@ HHC_LOCATION = GENERATE_CHI = NO +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# content. + +CHM_INDEX_ENCODING = + # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag # controls whether a binary table of contents is generated (YES) or a # normal table of contents (NO) in the .chm file. @@ -758,6 +915,75 @@ BINARY_TOC = NO TOC_EXPAND = NO +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can +# be used to specify the file name of the resulting .qch file. +# The path specified is relative to the HTML output folder. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#namespace + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#virtual-folders + +QHP_VIRTUAL_FOLDER = doc + +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to +# add. For more information please see +# http://doc.trolltech.com/qthelpproject.html#custom-filters + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom +# filter to add.For more information please see Qt Help +# Project / Custom Filters. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help +# Project / Filter Attributes. + +QHP_SECT_FILTER_ATTRS = + +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated +# .qhp file. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, which together with the HTML files, form an Eclipse help +# plugin. To install this plugin and make it available under the help contents +# menu in Eclipse, the contents of the directory containing the HTML and XML +# files needs to be copied into the plugins directory of eclipse. The name of +# the directory within the plugins directory should be the same as the +# ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before the +# help appears. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have +# this name. + +ECLIPSE_DOC_ID = org.doxygen.Project + # The DISABLE_INDEX tag can be used to turn on/off the condensed index at # top of each HTML page. The value NO (the default) enables the index and # the value YES disables it. @@ -769,29 +995,61 @@ DISABLE_INDEX = NO ENUM_VALUES_PER_LINE = 4 -# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be -# generated containing a tree-like index structure (just like the one that +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to YES, a side panel will be generated +# containing a tree-like index structure (just like the one that # is generated for HTML Help). For this to work a browser that supports -# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, -# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are -# probably better off using the HTML help feature. +# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). +# Windows users are probably better off using the HTML help feature. GENERATE_TREEVIEW = NO +# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, +# and Class Hierarchy pages using a tree view instead of an ordered list. + +USE_INLINE_TREES = NO + # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be # used to set the initial width (in pixels) of the frame in which the tree # is shown. TREEVIEW_WIDTH = 250 +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory +# to force them to be regenerated. + +FORMULA_FONTSIZE = 10 + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be +# disabled. For large projects the javascript based search engine can be slow, +# then enabling SERVER_BASED_SEARCH may provide a better solution. + +SEARCHENGINE = YES + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a PHP enabled web server instead of at the web client using +# Javascript. Doxygen will generate the search PHP script and index file to put +# on the web server. The advantage of the server based approach is that it +# scales better to large projects and allows full text search. The disadvances +# is that it is more difficult to setup and does not have live searching +# capabilities. + +SERVER_BASED_SEARCH = NO +# old default +# SERVER_BASED_SEARCH = YES + #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- -# Path for OpenCFD LaTeX macros - -@INCLUDE_PATH = $(WM_PROJECT_DIR)/doc/Doxygen/Macros/ - # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # generate Latex output. @@ -805,6 +1063,9 @@ LATEX_OUTPUT = latex # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be # invoked. If left blank `latex' will be used as the default command name. +# Note that when enabling USE_PDFLATEX this option is only used for +# generating bitmaps for formulas in the HTML output, but not in the +# Makefile that is written to the output directory. LATEX_CMD_NAME = latex @@ -864,6 +1125,12 @@ LATEX_BATCHMODE = NO LATEX_HIDE_INDICES = NO +# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with +# syntax highlighting in the LaTeX output. Note that which sources are shown +# also depends on other settings such as SOURCE_BROWSER. + +LATEX_SOURCE_CODE = NO + #--------------------------------------------------------------------------- # configuration options related to the RTF output #--------------------------------------------------------------------------- @@ -1000,8 +1267,10 @@ GENERATE_PERLMOD = NO PERLMOD_LATEX = NO # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be -# nicely formatted so it can be parsed by a human reader. This is useful -# if you want to understand what is going on. On the other hand, if this +# nicely formatted so it can be parsed by a human reader. +# This is useful +# if you want to understand what is going on. +# On the other hand, if this # tag is set to NO the size of the Perl module output will be much smaller # and Perl will parse it just the same. @@ -1088,9 +1357,11 @@ SKIP_FUNCTION_MACROS = YES # Optionally an initial location of the external documentation # can be added for each tagfile. The format of a tag file without # this location is as follows: -# TAGFILES = file1 file2 ... +# +# TAGFILES = file1 file2 ... # Adding location for the tag files is done as follows: -# TAGFILES = file1=loc1 "file2 = loc2" ... +# +# TAGFILES = file1=loc1 "file2 = loc2" ... # where "loc1" and "loc2" can be relative or absolute paths or # URLs. If a location is present for each tag, the installdox tool # does not have to be run to correct the links. @@ -1137,10 +1408,11 @@ PERL_PATH = /usr/bin/perl CLASS_DIAGRAMS = YES # You can define message sequence charts within doxygen comments using the \msc -# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to -# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to -# specify the directory where the mscgen tool resides. If left empty the tool is assumed to -# be found in the default search path. +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. MSCGEN_PATH = @@ -1157,6 +1429,29 @@ HIDE_UNDOC_RELATIONS = YES HAVE_DOT = YES +# By default doxygen will write a font called FreeSans.ttf to the output +# directory and reference it in all dot files that doxygen generates. This font +# does not include all possible unicode characters however, so when you need +# these (or just want a differently looking font) you can specify the font name +# using DOT_FONTNAME. You need need to make sure dot is able to find the font, +# which can be done by putting it in a standard location or by setting the +# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory +# containing the font. + +DOT_FONTNAME = FreeSans + +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The default size is 10pt. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the output directory to look for the +# FreeSans.ttf font (which doxygen will put there itself). If you specify a +# different font using DOT_FONTNAME you can set the path where dot +# can find it using this tag. + +DOT_FONTPATH = + # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen # will generate a graph for each documented class showing the direct and # indirect inheritance relations. Setting this tag to YES will force the @@ -1201,19 +1496,19 @@ INCLUDE_GRAPH = YES INCLUDED_BY_GRAPH = YES -# If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will -# generate a call dependency graph for every global function or class method. -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable call graphs for selected -# functions only using the \callgraph command. +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. CALL_GRAPH = YES -# If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will -# generate a caller dependency graph for every global function or class method. -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable caller graphs for selected -# functions only using the \callergraph command. +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. CALLER_GRAPH = YES @@ -1246,15 +1541,15 @@ DOT_PATH = DOTFILE_DIRS = -# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of # nodes that will be shown in the graph. If the number of nodes in a graph # becomes larger than this value, doxygen will truncate the graph, which is -# visualized by representing a node as a red box. Note that if the number -# of direct children of the root node in a graph is already larger than -# MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. -DOT_GRAPH_MAX_NODES = 10 +DOT_GRAPH_MAX_NODES = 50 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the # graphs generated by dot. A depth value of 3 means that only nodes reachable @@ -1264,13 +1559,13 @@ DOT_GRAPH_MAX_NODES = 10 # code bases. Also note that the size of a graph can be further restricted by # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. -MAX_DOT_GRAPH_DEPTH = 1 +MAX_DOT_GRAPH_DEPTH = 3 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, which results in a white background. -# Warning: Depending on the platform used, enabling this option may lead to -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to -# read). +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. Warning: Depending on the platform used, +# enabling this option may lead to badly anti-aliased labels on the edges of +# a graph (i.e. they become hard to read). DOT_TRANSPARENT = YES @@ -1292,12 +1587,3 @@ GENERATE_LEGEND = YES # the various graphs. DOT_CLEANUP = YES - -#--------------------------------------------------------------------------- -# Configuration::additions related to the search engine -#--------------------------------------------------------------------------- - -# The SEARCHENGINE tag specifies whether or not a search engine should be -# used. If set to NO the values of all tags below this one will be ignored. - -SEARCHENGINE = YES diff --git a/doc/Doxygen/Doxygen.css b/doc/Doxygen/Doxygen.css deleted file mode 100644 index 24955d35f2..0000000000 --- a/doc/Doxygen/Doxygen.css +++ /dev/null @@ -1,76 +0,0 @@ -body { color: #000000 ; background: #ffffff; margin: 0px; font-family: verdana, arial, helvetica, sans-serif; text-decoration: none; font-size: 12px; } -a:link { text-decoration: none; color: #0000ff ; } -a:link:hover { text-decoration: none; color: #0000ff ; } -a:visited { text-decoration: none; color: #0000ff ; } -a:visited:hover { text-decoration: none; color: #0000ff ; } -a:link img { border: 0; } -a:visited img { border: 0; } -a:active img { border: 0; } -a.menuLefton { color: #0000ff; font-size: 12px; font-weight: bold; } -td.leftmenu { font-family: verdana, arial, helvetica, sans-serif; text-decoration: none; background: #ddddff; text-align: left; font-size: 14px; height: 20px; width: 200px; } -a.menuTopoff { color: #000000; font-size: 14px; } -a.menuTopoff:visited { color: #000000; font-size: 14px; } -a.menuTopoff:hover { color: #0000ff; font-size: 14px; } -td.topmenu { font-family: verdana, arial, helvetica, sans-serif; background: #ddddff; text-align: center; font-size: 16px; width: 150px; font-weight: bold; } -h1 { font-size: 18px; } -h2 { font-size: 16px; } -h3 { font-size: 14px; } - -/* formatting for member functions: - * Since the OpenFOAM code already has nice line-breaks, wrapping the lines - * just looks terrible. - * Give a slightly different background to make it easier to find. -*/ -.memitem { - padding: 4px; - background-color: #eef3f5; - border-width: 1px; - border-style: solid; - border-color: #dedeee; -} - -.memproto { - background-color: #d5e1e8; - width: 100%; - border-width: 1px; - border-style: solid; - border-color: #84b0c7; - font-weight: bold; -} - -table.memname { - width: 100%; - background: #f7f7ff; - white-space: nowrap; -} - - -.indexkey { - vertical-align: top; - background: #f7f7ff; -} - -.indexvalue { - vertical-align: top; - background: #f7f7ff; -} - -.paramkey { - width: 5%; -} - -.memItemLeft { - background: #f7f7ff; -} - -.memItemRight { - background: #f7f7ff; -} - -.mdescLeft { - margin: 0px; -} - -.mdescRight { - font-style: italic; -} diff --git a/doc/Doxygen/FoamFooter.html b/doc/Doxygen/FoamFooter.html deleted file mode 100644 index 3e70a02e79..0000000000 --- a/doc/Doxygen/FoamFooter.html +++ /dev/null @@ -1,5 +0,0 @@ -Copyright © 2000-2010 OpenCFD Ltd. - - - - diff --git a/doc/Doxygen/FoamHeader.html b/doc/Doxygen/FoamHeader.html deleted file mode 100644 index e67053d4ae..0000000000 --- a/doc/Doxygen/FoamHeader.html +++ /dev/null @@ -1,73 +0,0 @@ - - - - OpenFOAM programmer's C++ documentation - - - - - - - - - - - - - - - - - -
-OpenFOAM logo - - - - -
The Open Source CFD Toolbox
-
- - - - - -
- - - - - - - - - -
  - Source Guide - - OpenCFD - - Features - - Contact - - OpenFOAM -
-
- - -
diff --git a/doc/Doxygen/Macros/tensorOperator.sty b/doc/Doxygen/Macros/tensorOperator.sty deleted file mode 100644 index 60b2234b82..0000000000 --- a/doc/Doxygen/Macros/tensorOperator.sty +++ /dev/null @@ -1,128 +0,0 @@ -%----------------------------------------------------------------------------- -% ========= | -% \\ / F ield | OpenFOAM: The Open Source CFD Toolbox -% \\ / O peration | -% \\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd. -% \\/ M anipulation | -%------------------------------------------------------------------------------ -% License -% This file is part of OpenFOAM. -% -% OpenFOAM is free software: you can redistribute it and/or modify it -% under the terms of the GNU General Public License as published by -% the Free Software Foundation, either version 3 of the License, or -% (at your option) any later version. -% -% OpenFOAM is distributed in the hope that it will be useful, but WITHOUT -% ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -% FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -% for more details. -% -% You should have received a copy of the GNU General Public License -% along with OpenFOAM. If not, see . -% -% LaTeX Style file -% tensorOperator.sty -% -% Description -% Standard OpenCFD LaTeX macros for typesetting tensor algebra. -% -%------------------------------------------------------------------------------ - -% tensor style -% ~~~~~~~~~~~~ -\renewcommand{\vec}[1] {\ensuremath{\mathbf #1}} -\newcommand{\gvec}[1] {\ensuremath{\mbox{\boldmath$\bf#1$}}} - -% products -% ~~~~~~~~ -\newcommand{\anyprod}{\star} -\newcommand{\cprod} {\times} -\newcommand{\dprod} {\,{\scriptscriptstyle \stackrel{\bullet}{{}}}\,} -\newcommand{\ddprod} {\,{\scriptscriptstyle \stackrel{\bullet}{\bullet}}\,} -\newcommand{\tdprod} {\,{\scriptscriptstyle \stackrel{3}{\bullet}}\,} -\newcommand{\tprod} {\,{\scriptscriptstyle \stackrel{\otimes}{{}}}\,} - -% operations -% ~~~~~~~~~~ -\newcommand{\adj} {\ensuremath{\operatorname{adj}}} -\newcommand{\cof} {\ensuremath{\operatorname{cof}}} -\newcommand{\diag} {\ensuremath{\operatorname{diag}}} -\newcommand{\dev} {\ensuremath{\operatorname{dev}}} - -\newcommand{\Hodge} {\ensuremath{\operatorname{\stackrel{\displaystyle \ast}{}}}} -\newcommand{\hyd} {\ensuremath{\operatorname{hyd}}} -\renewcommand{\max} {\ensuremath{\operatorname{max}}} -\renewcommand{\min} {\ensuremath{\operatorname{min}}} -\newcommand{\inv} {\ensuremath{\operatorname{inv}}} -\newcommand{\sym} {\ensuremath{\operatorname{symm}}} % symm ? -\newcommand{\skw} {\ensuremath{\operatorname{skew}}} % skew already defined -\newcommand{\tr} {\ensuremath{\operatorname{tr}}} -\newcommand{\trans}[1] {\ensuremath{#1^{\operatorname{T}}}} - -% alternative tensor operators for hypersonics etc. -% ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -\newcommand{\devs}[1] {\overset{\scriptscriptstyle\circ}{#1}} -%\newcommand{\trans}[1] {\ensuremath{#1^{\operatorname{T}}}} -\newcommand{\symms}[1] {\overleftrightarrow{#1}} -\newlength{\skewslength} -\newlength{\skewsheight} -\newcommand{\skews}[1]{ - \settowidth{\skewslength}{#1}% - \settoheight{\skewsheight}{#1}% - \addtolength{\skewsheight}{0.4mm}% - {\overleftrightarrow{#1}\hspace{-.5\skewslength}% - \rule[\skewsheight]{.4pt}{1.4mm} - \hspace{.5\skewslength}% -}} -%\newcommand{\skew}[1] {\ensuremath{#1^{\operatorname{A}}}} - -% spatial derivatives -% ~~~~~~~~~~~~~~~~~~~ -\newcommand{\curl}{\ensuremath{\nabla\cprod}} -\renewcommand{\div} {\ensuremath{\nabla\dprod}} -\newcommand{\grad}{\ensuremath{\nabla}} -\newcommand{\laplacian}{\ensuremath{\nabla^{2}}} - -% temporal derivatives -% ~~~~~~~~~~~~~~~~~~~~ -\newcommand{\ddt}[1] {\ensuremath{\frac{\partial #1}{\partial t }}} -\newcommand{\DDt}[1] {\ensuremath{\frac{D #1}{D t}}} -\newcommand{\DpDt}[2] {\ensuremath{\frac{d_{#1} #2}{d t }}} -\newcommand{\dsdts}[1] {\ensuremath{\frac{\partial ^2 #1}{\partial t^2}}} -\newcommand{\rate}[1] {\ensuremath{\dot{#1}}} - -\newcommand{\genDer}{\mathcal{L}} - -% time average symbols -% ~~~~~~~~~~~~~~~~~~~~ -\newcommand{\av}[1] {\ensuremath{\overline{#1}}} -\newcommand{\corrtwo}[2] {{\dwea{\dprime{#1} \dprime{#2}}}} -\newcommand{\curly}[1] {{\cal #1}} -\newcommand{\dprime}[1] {\ensuremath{{#1}^{^{\prime \prime}}}} -\newcommand{\dwea}[1] {\ensuremath{\widetilde{#1}}} -\newcommand{\dweafluc}[1] {\ensuremath{\dprime{#1}}} -\newcommand{\fluc}[1] {\ensuremath{#1^{\prime}}} - -% index style -% ~~~~~~~~~~~ -\newcommand{\veci}[2][i] {\ensuremath{#2_{#1}}} -\newcommand{\teni}[2][ij] {\ensuremath{#2_{#1}}} -\newcommand{\tenTi}[2][ji] {\ensuremath{#2_{#1}}} - -% index operations -% ~~~~~~~~~~~~~~~~ -\newcommand{\deltai}[1] {\ensuremath{\partial_{#1}}} - -% Sub-subscripts -% ~~~~~~~~~~~~~~ -\newcommand{\eff} {{\scriptscriptstyle e\!f\!\!f\!}} - -% unknown use -% ~~~~~~~~~~~ -%\font\bigtenrm=cmr12 scaled 1200 -%\newcommand{\eexp}[1]{{\hbox{$\textfont1=\bigtenrm e$}}^{\raise3pt -%\hbox{$#1$}}} - - -% ------------------------------------------------------------------------------ diff --git a/doc/doxygen/OpenFOAMdocIcon.png b/doc/Doxygen/OpenFOAMdocIcon.png similarity index 100% rename from doc/doxygen/OpenFOAMdocIcon.png rename to doc/Doxygen/OpenFOAMdocIcon.png diff --git a/doc/Doxygen/OpenFOAMicon.png b/doc/Doxygen/OpenFOAMicon.png index 073c65b684d0ddaa64412ce6637f8e5776bbb2a9..568b0060908a05c84cc9e9a707e65ddd43949d2b 100644 GIT binary patch delta 1154 zcmV-|1bzF63$F&M-2b~1TRTMK~z}7?Uzezl~ojlzkUAyzn8vf3oS2^)P|RWkBU(+Aw~tGEkuKn zfkq<=q=~=;!8^i7g2=5QmVhDwbWmfA2|;fyGlQZ7iJBmyLhykCDhfp^DedilmV*MZ zJj%V5N=)3dle16O%06qaeGXjaf3O~_nJbHs4>9|9&@-t&!ZV9|8p=>t6L14kf5Hm0 zB(M#b9Rl3H=76F zq_wr}jkh*LL{TH?iyj(S(h`p|tVObFOhTBQr3Fb?p87a_CJ4~Frj5s2e~%t+!?{{A zsa{;64-!{`yFf&Jdyclo z2*Q_7gZCf+knqQrcUt*eOoN@7?LTy)ZTG%o#RfqXY4fb{SRHNCd}kKKSaSpYs;L%#|yUQW$rV zNxlE~Eq8WqLtU^Du}2bNXa!ShD%;~&7&fvqF0RiPJGgJ<1fU+YL$W6o7mPYb_4lp~Mb`pE1@O?tuE||2AqrX-c3Ub8DoqR=S6$i`#~w2)kBQRf zUVL^8_(h=QWKz5TF@fjr9(>eH%LMosCSPBX3Bas|FH{W69@;zYk^ScKXjIS;&t0+&lc`t%6xoPrk zj~woI0-z5-EfPpXQzs3LvR(d5$#48{k*VJar0b$iSd(wS$V#GYU?QA)(~u3nZ5X?^ zFOOA6pQ7^*UR7my0~sN=q~~=C+ZCl zB&sTX5LFbBn_{i1NIT=7++*A5^3^LZ)?YZ&h-HO{g!eiCl_C3JNz|+nf6)>U5ex5p zLvyp|sS&|+OmmI|15U%$oM?vxToOO-*wwfG{Ha`QXBm<3UI1rqw1M(a1_9HsC?=Ux z5$$S;$gz``8uuS=NEfhOSJzG)o4eSyENzd~IX%SGtlpUW>*2i{vF$%m76MREcB2Jz zHh6D|ShWDgXw&L%e^<|Fe=2Z1U|)RV#3#f4YIlGO%S%xWBRoSSyoG`?s0(8y*Qcye zD)a4?CTaFBwDn}l_t)+5<%5A@(Dg*ZTPXCQz%}sX zydEvP%sYtSc}oA>PF=cW1nZ3|AoIHwZyO3Q+Kg%4O6w8;o@dQPe@z-9vjK>Nuc;(o zM)f^SNi+e^sh{J{Ksgd1SzN*gL;z?Do~D6SazGv zb(54t&3IM$T!i#Q!o;?0KNUZI>T;S0o=W`Pb1Mcd$(pv0b1R0l7TXi3i6infk?@II zoN~K86(MUq=neqaf3*SwALy*EVhqZr+{2m7$<- zb-uGrRligP1!qKFcET9-5J6SmQ!l0W$(n1iPMJ`P{lZd5e@Vv};%=PO`582(6B(6+56RYg@^?mq3%*wZTp@b=>se)(wZBUDd< z)LdUag`3B;e+>+M=#JElJ56)Fo~d1;waU-E-=p4*uyMzJ!`_2-Vbu z|F~%?wjG?5vQXM_;4?&wh-lwl>4A)Nx4ESj`+H&+^K5Y{ny5zfH;^0JTH)r=)Q$a) zg3Y7b2lnS_e2J)@2I!dP2Kw|)kBNvuu)&(*bj(`|f7%mdHj(h9>zhSn>{dUqTb^wO zmu!ep9txgASgs&Ou^#G|X?Ft!K5#)#2zB|1Z@P`2z$7_UW9Fl^JX_MzNjX zs^Ozve?N0`KmO0)vQUR)etr)cRRvYtk;A&X@r2o@YF7R*OO!~MW$TLW9{6ex&v#>@ zrV=5ps$_HuI3pkHR(rO#|DmML^a(XATU&H@!M?<{i)s`RY)gKwo0(Y+&~4h`s~XcM z*4$li(I%xLKeY+WQc+dVH~lM<;mnG@tg3pAGgVcS?!K#gUD=r&Ae#{#R}r!f0958% f*NUW#H}ii0@@yKODsg#O00000NkvXXu0mjf%{z~9 diff --git a/doc/Doxygen/OpenFOAMlogo.jpg b/doc/Doxygen/OpenFOAMlogo.jpg deleted file mode 100644 index f16a0683da8681c1d9891c2b19c44e56ac2869f8..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 8524 zcmbt(bxa&i@bBTS#hr4vyL)lxa40RVhr7EKJ)FW(iWDowp-{XWZiicoyHngA-@Lr! zUWUN=c06qW#8R>N( zAR!^3p}d|!MnpnEML3r8tJ~g5N)MVc zPxs}3^e_ymFzbEO*=LPk0VkhLiQd0o%s+H*&Cz_9Ts;7$Xb15lZ<3E2M<8GR4)G2d z8m@Z~(}d|H{vaO?E!1BBWpY5JfD_CCc@q|4y)rN*%i#WGwy!7(7*ZS<+~0u(zX0+> zMJ6s2H=jGJy^?5>C?qKa0tD>;*-!0FmE-J6XLVIKHQ9Z0;vEifHQY{^eL!M#^jeY_ zjkHfl^JeMo==xZ|&CzS$gZ{y5ove|9waLd&dZEZ#T%{bc}8h zUDqVMeGWu#Dc$(}?9^x^aC-8qqJ+wzbFBWPUoE2tmw6$Eki@#x2~_G3`kXX@ltP*J zsD7rTyiXncll{$d&s#G(7|R(bxLTy#fBpQn;p|6{{m*ggqzwC_x{Gn5X2|qU7|#yx zfp3%62>(UWwekF_+T^^GuMGK7Hiku6xl4XKOHGT~-Jy2?(hLKuq4K$^8xK_*(#ft$ z(f*;NH-{i^lL4cQk>Ais>-yxg(?27Ei(S*{r>GUf7l2B~{^<)~+{yR_aOU>{IGs0t z0l=w`cb|KXZe9Rd??azRN?!o)jzgM0oM*oPs?>ZQ&yj}pe!kbQ5zHuCPF?zJc|_!_ zJ)MotN;W7aL72u}$EEuPMGNpvE;igjCN?TdjHVzf!9p`gukrqv+m1GCzFGX3*2r7Q zK-bGgSlJ645zsaSzE(@(eBW2jMPJ@#*{=kWJSiiBwr%u&4eDcH>`bm#FpCz8Hk|g^ z%Y%~P$U?trSG6hFD5v8{RDb1B)?4%7J1Q2dB$Vvm9Dv3@4;lx)$?$fbt0ALsXuJ5^ zbp>`D)A=nTpDZ9TO0-(8;y0~?hqUdij6Ef)3O|e=H@majVZ5w_ocp)E|KXdUQgb7A zU-^*HFe?KYGBxC%(GxH7UNBK1JL<+ne~qNMaS?3y5_edyfW97rCSrN_08QivDn>Xq0M-Y`~+K*$j9Os?9lp zVO(Cw>0v1EMS;+6yf+Z9E?lkF7r>qAqrje~X0O3pAP0#`T-zg&a!modpfDZKOx<3- zm`lp|f?2FPJaL#ev+WK~2>vE$u&`A-kVjCin1_|j5`Wsw6SL>RWqt`d%t3Tgzl z`RuH~?N`D^hxZ349zA{wBu0+Wssw0M0w2|~>a=o@)dSSicw|s@Y?@+6S={sPBrffB zner(7mW;QP$8|xuVRiIEXK;-zGnT$ozDr$-YTJDBQE9xad`Sh$d$g>w7pn z-z_c!HR~BZuB}gIibzn=;8CE{twrD!kx6$MF^wEZIZl&Ol>J(MLMpui-`|CMDwjG- z7O0mk9p8$n;rHw`e5f5A7#?5y8MMLS48zn~r7!Gr-BP-J5)`yylt}BB)R*8JNx>Dh zO%_gPwqHo>`OJBeh?G7M>_Hp{WXBgz#X#CoY-yMx0Po{e4{cGBji3t*10 zk?h2HMog+NXIoHjiGnHGcuu%2V}w<;*mfCGG0@M{yH+B!9ED-~t{AoDy2u~AU6OTL zdG9l&j}fOMtGUptp+P9m#&fisrg(wp_Rz39A!cKnrs+#^%L}C4U9WiBC>{(Mh6nxp z)Apf(k;7EU#;^Qyv(mWnJ9a*Ur`Yn3F9ctOjV4S zDtHFQE)AfmmHorT-MnEqs+%XU@qp5fGqHA|M~y0z4UcYrhyi=5-i>i!kXCwkUhL1g zlwVQvl^ECEpc(7js)at{cLd8N1DwDQafoQf!y0{PVj2V<15#?FSWRwk;j3AEwGh}R zK};+riDxP`UBe0zzc~|1aIgomQtnp;EG#~>vrmNYAS_b1>d_J|3YnVEz_xVCatwT{C0AQX?e7BY7wKJymWPoN1QdPHmxBcCU- zG>!eIha3iW=PaY<7PEa9ubr<2IVhHp0lH-%9}5aZVS)^e?wTRhPXs)b)?ApwP)CcS zh4Dj_*H@hJN+Pgt)p&`b*g&HI!S7E16p>H*gD3;R@x!!0wyoJ{^fW=&Ajj<9wsbbunEPEOi2bPC9*SY|wU{f%*N#A|Aa_w!=UL~RgJW}{k3{A0wiZx)2mIt; zh)Ych+QvTDNXZ+#&l1bgHNgt@c33jeizh-Cr2|3;^#)~D>xA)3-u#Wu5y}^@ynnNM zj-;7Qe1j(CZ#YRQxU{XgZ2FX?Yp3nXDPF&km(-$D%@}rQD>vM@^p_|~LJVreT$jNK zOppg+llMr82SAe!DcXbK%QMXwyDh6nq+*UscA_f#?B(0W8{^Z%CuTgzsPFfJU^(UA z43uKDX+*Uv{@GYWK8A+FaW>^PEjCYTSIs4xts`%vA-Sn7j^s!gC4BC!)*eR6@dhDf z>ELppzeH)FZ8|%;_CjxAs8nZ8h<>xUUGu3`Fxs8ESAjsNR%uaL{Z*5o2+IDKzZ@O{ zTY)FeEe)J>d^Tg$z2qtc1J&NiO3f>d)zftgqc&yCqi22>k6V5&A}dk8VtWQ$qSxFv8&!m^$XCkgXy6`I$_n!+wG)ByChkgg+Oaj%e`U4v!L0m}Wos3!j|5Sn z1Bfz*e@}+gxY?Ly+Z=^dXQ&p$XBY>hD>QEeFVX7hGg9ew)CznT0cjqYLV!T2tp|=A z^nepH1D%*9yUyV9);*VueOIf-C`KEKo;m1bE?yV6vAO-Mef4yzve*76g0iv&k2l7B?!Egf|K_=m}M$4I0X#|w!s47t61^HKz+3It2N$G4Nq z%$pXk=&q@Fra5FOc^+>sN?>%+^c-TI0OToEt+uT2MOf&+U8!H0u0_S)4{*Pj4Es4E zd&mtkYWJwQtQbnhcTbEMj*r&%HKwJFOUWCW3;!nl#Ig^tw!DqaM}+|Dl2d>t>OL4` zQ#7(~Q^g=Bda*gdC1OkIDP9$1w9>Dr_q@K|eBBv9V zXS1%teZrsQo5sB(ZtV&dBA?m`h6=FEdt>WTGn!%`wnC{#!gZt!iJQ1v^VKzCo1F)~ zTo$UDt{M@emS-W~OO_K|2w1XrHvvo&10i1XNlcy{T{P0TOPMr6*3G0zA6S;vek(v8 z?7J=%`{z)+Na-oPGD2)!Aku$Ytjn$P4r(XQ*$A1|`qt|w`*uv~IjRu(o)Y^d)g1Vi zxcQCpl(LeIG~OemX4%L1f0FjaVs^$ELM9V1&XqhWiE}J6Dcn6y-@s>&{wQlhPrTU$ zt*_fT?DCevIc2Elptvd`M|hooPo7OS@Vr!5p9sP)r3W9qxBXC|={v#S{)Vug@G-t# zv8xkm|1?{={{W7-+TS>Qcd3*HR=H>!7@aeBi2-DZ(M8waJaq7H$-h1d(V8qJU>;j` zR-vz_7Aqh~>M%bfBk60XpAyRxW6xd6E^ULd@PYW`bxrIA<+$DfhHZSUrd_+G?W%pa0g;%Q&Ka zRNBSVT~S4CQ5-38ZI^ZmFSpB1wE1hwuJQ3li>|&MCkN|>)vyhv4edFS)q0X*nvXbl zk;t8Y$Z@E2p=6dyXYpUt>4x;TDirm_@KLvuTnqN$VvH1c+u7o33Y(B;X6fi>->kPKf3irI_LlCH>tIKM>a%UzmP#Ezi4z?EY~AF&QSib?bo8)Qo2h>9bLdJ4J8 zK9GBIdj^wC(9iGts63NUop3qD=sdNMjh2DPAKY>w#W?%u>cC;yv2?l=N)qRj+VQ2wT+ zvbJ#?08xb*fG`Av0+1kDV8wZS3gsWC*ELUS9aB2?(fdjLMxBQp?xHaUGvFUYe&V7r z>iyg-svj%{hsgM68eaevWjl&$Luv^opn0!>eI4)MA^v~F}q4^MdSK)!eeRGp*!34 z7-UNSDy(!}DxpU1`i%s5W0MNCCl&geYX2E?+T{wSMTN*avHrbpW1YtKPy%6OYNbx$ z{Ny@5(DW0#0^fwyBK9(nJTC*1`I_E@@#n0j9oT|?Dltz=dBl{w02qI49^RHIe7={- z8s=3ZE}!Z%88H*^*{U2E4+#n%7X~U~vRo;DS5~FC zkG4UVPK|7!ml0^R2N1OJEdozOIiZpwKA^Se)ss{t9+;w%)$TW? zf4j45P9bkaz2cOo!a^nr3Tz95W8m4Pc34Z<_~vPXqgFe2w2@Q*Wz$>(Q+)bZMYm}d zO%5@AVh%l1Md91=za;!3z~^qXL7cZ9>fZ}F5H7msvd*fPop108U`uk8VCs#0Mx1Zx za_$eWZ?0y-d@HhN&-~qG+HueP7r?+Ywe(ZbOyOd6T8(zl+UdS6faaoRR&iu=-?cWQ|L=~ZbiWNiphQRV0;J%PtXX~>50 z{;f*-7tNZCa&k3%C^tl~6+*1Tp+vx;5ewmnB`2h$ixPijPnIT+gbITmDvV)z)!WA7 zo;#);bDa;~Kh0}0@eDoM4fV~O4y;A}4-T0E;G$#W8~tk*Ox1 z=%!@YY}c+dfJW%cV5k-Ye@|Hr;zd1xY zqe~YLe0W^)pnvw@t2I>>#+p3k9>L0*+lo8#aDH z?_U6`j6v?D(Y}VT$<(Q3dt*Cqy7IJNvJH~;*u&@(C?8G=RA9p)f$eTmWT&@C4~@kR ztC4>Sz}r;~LE-0$G4SPs%o5zd)T{iM!$mtCx{sD?FzWb<1jkLuf*c|6?Y@KjssYa= zf~f-S&f%wV5Gsa?_xwmSd{skBpIY=DndvKt@M}3`o<#81-~4a3>a8Z!=t+P|wz_}L z0e0tWF8~H}lBEt`LmL11En2$Os^WitrDxh`&qQgh3Ce_c4J!-6SOrq?8*T_o&Tr&Z z0O<$cgi71OX;GtwSgzeb9vjSA+p-~F+RPj(_I0a>2=n}d^gb>ktU&c+tR&By>4K7F z2)_DFeIhu;P7I;)d3rp^zsflxy^jm>KnE!YS^i`WOqRzj#&X!9(O+%Jb7zC;Hm`tH z<>1wJJv2kC!mG}%>cAHE))b$p9$@*IP=}ehqSn#_tPd&K9WK7k`Jr&t7m^Ivy#R@S2jqhQ4Fw3SlBz6MMpr_xRNxYc2En7FjX_2)$S|B2xV|haR-IT!epdN5BIC|yP<;KTDbcfN#BQR zHC)wp9t-nZy<(OZv2kr;-HfZ(+K}OlvF57xPNA|MEV%ezxAdcjhqD~Y$bq1dNmEYz z<%;dN2E7rzF-EgXfJxB`eow53Iw2zDuR}brZkn6k18;FT?2EtE!@o$qN97wO*0+n* zK|%ghp&FhzP!~%_Bpq;)7HMP271|ZKYk?qb^-(`zVjPVYPhYQmcw`j*1`RKhvh|R> z6XAfzS3I1WBZs}!+$@YW<59{X4tfs{R27D!%fHMVW_-nKLo`PIk%^l#4y#*TWMZco z{;`4fgJZGa1#$jzl&)ddKe6q&0+}06wL+X8ny9)nMuj1~akr%-WX=)@gi(()z+JU; zxF^&cHPT|GK2|Fe;UDlq;*Tg-f1 z`y1a9qbZ9*a}4Hd%AmuRkSoG+@d>TRvZAb8xt{1#@%htVmv|R4_EEyKM@J&Q?IF@r z$+?1ZNV4izT|00Mry2(l*2#`+qWla+l#Q=Y;!qDb=uGsG*4HW8xPVJ7w?hIZP`R;veUoK1&2whs1KleIGEr_b)K`< zBXedBOwt&4ch^e ztAX=PGor@AZok`PVM|OoQmosSUkMEECh)r(V5z78KIt;(u1(aC@QQGxM9dcIJcB|r z3Zz?D#1xZ9?DGaR#`C~$I$jEf3~z4p{apxROQDiai19wpypyZ9Ha_RmXbxbj$x3jlwrAufnruD@ z$kALZa(O=VuaRN&+d?cgEfA$jBHv66fkS_XrVQLBX|((@_fJfVG5C>wspY6xX-XdF z(MMh0PwLT*lxR`S=*v`Ul%rlB3&Y>~%5e)Zx%fs3+)Mx^l;7t)8}>-bJ)6Bs$g-=5{-air)7LwluI7VLBed-YYEiu;k&sBWUnP-{VO~%-y-K%s|hl^6q z=TsWq*(h5jv1mbP+_u$Xe7I*WR|MafUW;=BD$-}I+*s5AS}xxyEAcV@W_ZpHMA&h7 zuS_U}xoaVwi2$J4f~bH??LL~;GGL03p|#u{THbD~9ehX*v8cIBlA8k@Jc9RsH4X1bIcHRv=qhrep+``#BBnuTPlY`g!xiWfsp!W z2kHgLZ=1UC=m(|dpz|7_CxZ(E6+%kZuL;IZX;vwfyDy#oEi1V5C`n$GfA=3qn2?>Q zn#9J8=%Pv{EfdmXoeNhiN*LEMv`*wIkcLDqNV6$i$u<7WQ~ybXtI)^Y#&dX7#@er9 zY_Zym>(xV*aG;xJ1N2EP2vBr}8QRO9Iik~K!_o(&ly;Kkjxvty5WPvldx^bl`wes$ zoXt^8=FJa2kK9Hg1s~ZPYbwFLvgps?`LiGX$WOWB1XntO|AZ%B~I zRsN{HX)S1V3Hs*;-J~-^1+P8?;4Z*rFjoarZqRM6=%IgRe?husUIRGr2KSJ(uC@}OHjf$%I| zrsI(oGOnC~psmBWlCyX^I|l0W%GrZUjn^{t%-O~K3xK2Z^}F1h^z8+ZlzmWh^OWZC z0ss}h04%1{LX8Tm1@9i;g%00DNFQ5iz5v$GJ6r2s09MP=GZim@+xd50bJB;@I-v$_ Yu1dvg#Z8m diff --git a/doc/Doxygen/OpenSourceToolbox.jpg b/doc/Doxygen/OpenSourceToolbox.jpg deleted file mode 100644 index 733025ba5959fb2905f7c3d0525cb994f7ce514b..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 10156 zcmbt4RZyHklOOIuf&_O75Zv7@xH|zBcXtoY0*kx5g@pjYLPBtNcXxsZKmMw_tGef# zd6}uHmg=6Kws~E6-2ku@WaMQ47#LW9_iX~N%YfwD?*BLbgXI5*;SKur7l4fn;K8uN z!C(Wh*f4O|Ft0rT834e*A;7=@|2t6N5RqYE;gL`gfVXoVEC4`)0bpU^V36Qo-&Oz& zEF3%nA`&tRHV*Kf5*H7jnq6GY6qSlYB81=rjk>l=>f9R~F$@6nf6)Ff;M*bp8w0Q~ z@NZP$;gH}E-blY8#fAqEa46Z|t5J!Yx*+0)KsXBj;!)E`K!0y?s!wW|nTJllE&=Fp zZ_HrBVFRLoqYwSx+U;1ul_xLLf1a41;EFub&80bJELQBZjjE(y0Z}!xHG?~vX_?7F zrD9TQj?oi+WIZhVxG=mF!;!UuUG*GcR?jEV@4d-Q=G)sG!?}4ymi&b8l$pN_CQlE| z=we^QP`B|`sSQ)=5oUGMn;^eXPyK_dbvUPg5&VbL#|r1fDbxZP-qk129suQ(QVWc| z0=0*n@s;VT>b0ESrYJ@&%eDQ^r@j`BJ?RUf;OCNmM^ruH-JfGEtkyhh8?BZ(vQZHu z45tyXO=+&!;wSyOXR_OO0*{?k z7_FtT0Tq4@hJOV%bcRmpcQX@Si zMJ3|0*QKr(zXywpEG~Gi#UCrk#u=MTma+F5Sq1%DU0Ci_tW9m*{}8r_75r^~@o_fM zIowNj8icD_OOFTp^J^HTg>FfamF~J;cHBL`&*aHJ*Jk0~`?#l+GdXDV7F5dmYnJ(D zf^8QTym4MIW2UZ&dyGH+oydltoznU%FrEIZuIeg{WOD8?_u7?RWo=%-u#=!h!Fs@8 z%D!mwsu^L=KEW=2nTbYIJ5xRd-gMTUDYa-M1$RanB?#3aoN$w0&EkTVQIy{k4#Svp@cN!5el(gOg@;r*Lu#PUzFL#w!td!pmSEvz^B zv-h{-(PQmUI7hivRTVPKJOUI z$ppXHD^;_d&HXPw)tKV%)q1E>e|0GeX(+%){Mwjt2o}zjG2_zZU^5Ythu)mL`?=KH zcyBj6lQ(Pr*Vy@(rM23$(aodQN_F3G>zi=q?1`3Z#%%`jvh>)aobn^TfgFsyb=+=K zgEW@Fmu!o03IE7-%3Zd;p0P1SOHiJ@9Ar~Q+_7*cO;juSX&B4x)RU`-dbZ)CZ9)If zCn8|taW3}(DRoS%_-`-yfFzQa;2CDo=h*^V@S(HfsxheSWFFyQSdvyhEiDReM2DG~ zj!>ny8iOJhp1hTcq2}JJhT(SMP7IWeuPrT31ozP@v9~{r<4JBajDcn;5k?pn zo866EJUrQ|F8ux>fyhSs-mI9q?dI<{~=C_`y zIxS)lMp8(JfqA4d>H`fKDpjj{l7#xVgfgwbfQY{9f`*@sTs6GolU(5Og z<+x&EJNb6`gsdLT=6^^NaCEU8<=ht_y;AbYS*ObSDqXn)U-B6H(PG(T$Eeu`h5$yC zo}TJ@GEQ+;vMf5fHZmHq&&^eb_Pv$&mbV$lFnf#^iD5B+poF@ZmW-Ja>akiQ*9t*2 z2dp@^wusKDiG%%M7ki2T^BPZGSATA66ll3FL~qRcaj!OGqB^tcy%%28T0>`>FouGp zTnRKoPwIDJEf+(%Ee*Y^c7$WhP&t#+q|8L1Ih;#h7@cMWbLA$Oa+h9y#JA7-kAG_) zhL^rmkpXZL)uD^6WIXFZ>Ms$#o`@JY+RA63nZzvEx2 zvvGS~!ijK7+A-t4&qkX&r_hsXi89LCWGSi+rL|t6wC|{4YjFD$%DXtAMH}HCj%qnb{GZK+=^XE!ilKnH9rls_$Pce*a5HqZGCX;}Nou z^>N+pX95$T!SbZ)rItc|)L7@V;=}&NE6*SyYTA*5k@O5~Iza**9@|~fN{$g)5jdEG z{j%wP-=Kk&vtcHd5Vd3?$IK0ljp_QTSslO1s`*t;Z_*jEEYz&(HV)jRK5LkjEgZ2V zSwimq6=4nXAnqb^P0`q;GPBnxfVkogj|nFYs#vjv|4kuB*OQ{)dq?ojw`c|h*c+6m zD$X{CRPF!Z6}sX5(%xN?D`C%*=P-UWea$Ew%3pqLVMq64jn$pcK&y%tOErnxS1^|O z(Mz6TgnDd$15%po`}MPs?m}zpK4Hv`2#MT<%r89^b$K%#h-^w+dnn^~WH9VVqDigJTOTG;TRVG zpx_r&9pZt0TC=nvDQT>AkA^w-B`^`jO4BApd$%=YfjsUx>M6q^fheShaiy5=_YVtC zcVumr+}9HK$qAok3x`0w7%!-cmDhCR2GVVJ=>6F?Wz6<}^f`v{%p_L7U7lgWpn>!_ zh|txM(8G0DfYHl4!?@^%3m$)d12V-@pUVcExWvu=zx6TaaShO|Z<8j}jg`~@lU#Rq zBCbiA$SWYeua@rn3aB9Q%kJ|KpX2L!Jo&XzWb@{a`tl4dE`z z`cB-!7VVZa)O(~=wQ$xuXUl$?6!MG76b*NQS7BMZ`rXQ~`_5ojd1ML}^R6cy!QhXJ z`2KHvv^39pl8-6~-tm#s`j4aby^g0c7qWe;g@t?W1GxzW47_>mO^PPE`~1@}x1VwZ zNIzD2MSC@A=u~SzS`_|~c}3HjkPhtjHqx}_oBM525%I?61}9RguxM;Ox?MFjog;?Zj!(y4tED4R z!|#aAH^qwN%~2<16u+Cf(?@fOx6$8B$AL*)!nyPpt}*jFUxD&z75#CR8GpHZh0Ts~ zu)S9Wi~E`P^H5>cRcg$+dFL#nYo>!5xSL$Q_M;snEi1WGlwbnH}S zthd3njL6<^Z22ABz>n<2!FYdJ$c~h?IS%vSNaIJE+2k`8unp^M^y06bl(!6ucb4d- z!>-hi+mmtKpk8xd-N^g16it(-DdIO{nO1#9hp?zc`0RmxmO1gzBQ94cj_>bjE3hU` z-K@KgVhlm8yB;>Arn;J1jnTWFViF$9`W_y8hj`X>K5%Kfz0RN3d*Pc8%Ej^^UyJC# z{C3kIMv&%#CY>sL8nfpjZQ-x^XfiMH@i{aWR`&TFz!B;~l~lJE$N?KTe{ zkKXXXaNII#EsqbA_*p-?77b)%G>Mg0Gn3h_=Q%Gs%5*dNalyMox#l<;Q1-sw1j9&) zVkdR6GFer@?cvQXd>ifKBj4MZr{1UH%b%SCEkDOo(i_b)1J!JsRk<@hdEz0Xy*Lz3 zlR*>G3-s)qFYy8HP962X6@A@3oyo4xHW_;ZK&$RRd1XS!rb-yghTg?y$lAv_4>V?u zJ~8WD+?Ia(?^W_b!KArtJ)5CEG`iah)N9X8CFMeW6BWsP+u)!CK`-nv2A>i)z7GP z&lFfZgLSXPzGlWT|ESozbnY)5`^+M!l~E$2v|xfGb22aJf?mOGbcAWhiMvv%VYR9Q zXWhr)@CfOb;!w({moeRC`ktf!r$}d=nsJ#ZrBh@dLko)Qs8vo=LZDff2!0{@*#Ta#D|$mitAuCL>MuO!QTzKXodc zs}~IT>x_+07&k>o?{cJ892lHYbB}bYBwX_#fq$&7Ze*ou2$&bzWNyJ$yAJN6&bl8P z$xK;s^g03aXN%j}tUNc3u&wv011(|XKJhlLF3Xs_lJW~JawEi zlH$|U@o!URU3zmTLj{?)_^)1m*G*xrpUy)XlN1ySl#1a%~@Kfw;Z0tYjqFX_h` z$w7x*=j5+IS#jZ+X#NY=TNa9OJboKw%=XgI{wGJ+v`dH~az8h-{d~ zRu7XUCj1&$qW0-Eo%_QhaWiUH2sRA7Jbcij!6Yl~2^XK_$ysbiw(HsNTCX zSnnY;X@UDM)Lx5hPgU}ee1->e**@aOk*%No2dJ`t`EJW;t=o7PlfrDvy;UN56z2l=z&KH7xpAk_J5I1kqtj| z^$15q#LHa3Z(?xTqCVha{ezaDU2ihs8T4(xAa_tdm6fE$D-Q8ur>p2+V<~tsJ2h`{ zY_S&!ziIJ$uE8~U3v5{=W!$>2I>Fk2|G|u&Y%~XcB^&XuU{q6Iw%MDpdVFIPU+~N> zxqbKaK4^)Mm5zqpeBd&4p17xBONqH=_-}BHtYpEvGE-Azu#q=wk38VF{^i}xL`(Ef zCz}wr@T$3D;W?hwSp%ixYA)}Wc#>UGBc`!}v7bXqr!h>-b+bo!`|oS2+2`<%Ym115 zBmJ09b7GW?%8KbaWd@_zT}Y2<~SFW|=2`RbGh3W1qP~E0dL%|B|=vvMw7ilPRycrUXc{Cn77e4WlHcQnsG~mQl2c`V^tkQmwNZoPb~;KmTW8U;_K7F`r*c&pwkK zCshPy&&qf}=j!#{Usu+nCZ%k9p z$4e`u7Mtczk~&GEViLca<$A5$M*1sIQmTY?qF?p%6`;H%Z;k>*GHbD0k)d^1Y3Z(@ zX;q(QS(&XLEg4jGhVH&6PbsySH~6)(GEKd0!vUl)n%= z_X zO@_HXb~H3HYpD>JO%_$DpC4kWOG^*ag2`Deoe0VPRti~Hv^W>g?ZP25D%GTAvhVwQ zU<&+Uk^qB*hT_aMq=>9gG2UV~qG;RRf6ySi^Lx9T402Xuind|Of{BhSwIj9wMZ7ZA ztUcPYid60`% zx1~n5@cnJ-IcPvBmum5oVPLv& zw*56LPFm0>?$rizn$~V3E85GGcMvtTT57Q$lX-PRTrx*mKH1au62N-1w ztc0(v(q&;ebAOQ6X|&;2no7nfHb^Yj2yz(+^Yv#YK_X;-aV5!V-GcuEk3|L|l-mF$ zJ~0s`t$hXlXG%42HduhlA9Q6kYwU{dq;U`QCyw z1WWy1uMt~renHxp&jK+qAxV%QUrW2SM5q7EP9>$f7n`>+A;>jYDkYxrc`xr>(AjsR zz;11C_Z>a$MDPtaO5w>TC$}gBL$72WP}yVHih7|U0`$GF!1zSK)~H}mQvSv1-u6He z+m+^{mC;H12^y7^rMUH@y*oOoBT}~8UY%a`p?9mdjUY30oT%%f*rFh(NsT%%qf|S| zg44kys>S#dN#^u$Ea0Myt>r@Xh-c;4H8c>=?qhOJ8UG+g*rAiu|8RS*&N-N-Je=;$ z*}E6OuNO#?I+lwzjOsD%jf})GYUXAuq)&Aj*o%a-xEzg~zaA9#b*UV5O(M@HKU`FG z>iXf1*INdExlw9B<{h0j!G3q;m-@cW#;P#8quV|(6n^nsG49d_jDH*kaxHarqQ{ zx9*O2t-S7bU3TYvtveT+P)&|^GMVM8LYW?A81q`EoX$FGn>kh-za5Db*LrD7^+}o> zWWTMn*1ZA+i*sG<`fbN|p_Zc`5%3?RL8OXOzx!#jjSXxE63AhS)4j&}#^f6U99qao z^yus(GDl^SOoy2=k#Ka|8Iv4RWwl9go~3G1zVBqAX}to@uh zO02S-G#|s+nKE2zcsOMw6OofcXaodu!>RF4X~GH(!DZDdaa2|@p`4wU_!)2@?}el= z`{Z(8Gww%RLgA=%?`FRF=PJZQS0LxKjexVW&(7S({Zcvyj-MYk_lnNtB&P`ss%ebC zL2b1hk^%XsmQe#T_m|VE0a)#DrHfiFo zunVqQh*6}m#TEC0>S^X6cU?%3gPYTq;K&`A%xT|<@3BipIQn4i>k;W=v3r)G@~5AM zv^oukX;&{j@pgjR!@EaQ-w0}@#L6NMYv}E>Vqh67W_s1Q?uBE6me|>8pT_hIJ8DL1 zT8j<+D?fCM{|z2QqsECT(9r3$?WrFa`51_&rRpFndGq+xVV!r0;Pv@jWY=Y&3yPtLyQ4YmAv@$ zdD#jsM2B*9!Nl4l)XNn3m7I_uld`B#YB>ootU@|KyWK62Dqvls%$Y%vYKE~80yhXT90ZmIk zH5&!I8W#Y-$cO7{E>c>@nQh%p@gX-nGMrm9?DHiau3a9Wchy+VVGHoje^2AGd^mOB2h16+aH` zi){`+Sw?j$%d!kYJF+xyBP#~i2`tB&A5QI)q&sjCB=GfiHc9X%cbEEkDV59Wwju9s z7rcr6;wr`r`3aMIP$JO1i8B%Pku4IZXl#4yh5;ccob=#|%Rhw*Zcu)CB2qThcP^oH z>nrWPKu2!dZNhf=oAJ*(ufPX>VxnaaGNlm=`?%}cqgE5^Oaj;4gI<9&YtN`MhFZ!y z^ak6P_Zrk*nI+^=WnyDfN@0y+@0%U*c+?qS&!X|p&$rcOfNSvsV2b!Ta{BpNzRi4q zmD9Z+i#+>sRgR=nU6eTR0qNQi^!)rYvtjKg~pw#F`S zhPoygC&6;3lFvD!+4wLrvxT(Xnwru72O^DX4_J3nE-!m9QP(BhEG{oM%(XxWhgx^h zB&Q2mV<6cGvhdAMWND(K)&7q^=$?G7Vzt`SDOt-#D6HTA73d*4OPo>`6=~dUEemWg zV3zirDW=DA(dH*br&|4lSbRIBGHu-o!^=pD!(@PR(F|T^6z*0Lr~b8k;d!`+VCqd7 z(||`76UnK@WC|vyIUFC-osaY!87r#6@rAw>UL5$-js=R157zuE=w;jVtT}`pr7pIA zbE(x0YhSBW7oKGuR~b4=>L{V)Td#k6y`9ZF-Hgst?Im1H8<+ z`_qsuKIo|d$e)mQJY~qr4V4Y^@Zl?K)nE^OuRD{{wl!222?80t4z19;`<6I|8EZ)A z_SGM9)GDez?WTL0-pJtQSJ+ffiK)|!(n_Ti-O$2=4H;7pn$q|n)-?fl zQ0Qg!_;hVs6bcJ9jQNNbiZzJsq8JKQXA6nT)WW(?iC_aVg1<0C0a1PrTy`6d!7MD| zxFLhd@QNGn>DM{LoDyjmp8_|^5V6^?lrG>f>oJ3*{a*rEWuW84B*h7{dBTuYKbU9v zr2;FmA+q4Wzh#Vm0H&BI>lgCi2L%Fm*0uKMYdhXUcN-)O13{Hj0mrbE&c{bbY$ee1 zD-aYK&K~dz_4FK3e2cy0P8bIhwgUg(}j0$jqY3Z zXO-ng(TYdV<11jdd--VMwS6bDKK#6nncly9e{+5?SsDl?`X!{P9~)RGH;3d*eTg?V z+M0Iv{BoH5{tZZ!HAr6KEc|hzYh9*cMxHjAgRvy5@`DJSyaeuHM%SaFB#sC=VO;3b-&zGa$bL5X=$)6TqymC4$Nw+@v#=>T+rg2KXB? z%)-@~BwYThdF$^TuWwIwkx#$fDT(LfPNE;W4Y<-j8f`y~6jXr_+9aZ?=pREXN@)I} zhL&HzZjwdxn_WZ#A4psxH9_E^Y z@!mku%?Z6@3 z{A1K0SpSb)Daff_9=Nqn^}o|ETQ4G3KHl9f7iH1B$@ODO>D@~}006V0vn*4keLB!k zha5^{^o3H}uoA195gtciO7vNC0@azVih4WbEzr9!op&o0%DT)$jH2WY- z{+XOs4d+KEU+7^&Q6zt3_03Z8M;03yAlcfZ$fmbuJmNH{)XzPYxCPWNQX>DOhWrBa z6WMErfXrX*Y%jUwmhO}Xh6#_NEbyYR^{)VyvP zXZsyjrPZB_kaOLEUori15n5P$zI-$VDasinqKL4_{$clz4@~=4L|iSC#U`(d{{=2% BH%|Zn diff --git a/doc/Doxygen/OpenSourceToolkit.jpg b/doc/Doxygen/OpenSourceToolkit.jpg deleted file mode 100644 index fc943f8c32fea11123a58731f4e17f047fff7229..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 9835 zcmbt)RZtv2v-RSd;4TU7wzxxZ4J<6~7Muk4paB+LEWqMnad!wFT!T9Vm*DQ)d|%bA z|9`(dPgC7}daAqTOij8p;S&G|X^4nPXo1q2=9qNBqzpW~A3$GR|G828b3yt4K>wfL ze=z^WM?geDL_$MEMfz{x|6t+)Q1EGZ2&8E>%~1(~UxJ}|^k+nL{{XwSY9<+8mjKxR zY!UI0@Bos4dH+Oj@cFOoQ)*G}BT2N>;NQL@HFV_mt|y*qmD9AZfSlql&L@WZf8-;fxQAoZP(FT7F_&@`%mekODc(v1T>pbR}fZS?z_#$#bBSRDFlUF z!hq?lX{DBCWsmS{&C({Am363{yV=XS=1wi=&$*`v@(OkG2XKd%+9 zb)EDUEmsCx%1tRq)sDe>Qt(03)8P4!D6M~$$bmh2M(l|r^qOdNpMys{8_q&_&3a3b z`hQpiNC9BJOAFaTdo>qtH-@PGHlH5LpyKNK30Qg;o8-ppweR_=@r`!c?KdeRRi0jz zVT-taDQj_r6|n^TyeTcL87|r!L-8kzLG=wVV~@v9RjJ`?TD!Pvm4N ziwrssIEObpm{RW6Wp$MmCJ)MGgw<3>dwe0o+e7=i_8z#8{pMQlt}TP((l){t_ERle z0>Oe*-M%Q`L++M#=ttx@rK@+hk)|rI0QCq|6p6z%0&045X1g)nUy(mC$DYGlQm!0z$VPRL zVkVcUZxyu@ZxX9)XsQ-SQR746G}Lu&qD16~xNsL6gp4%)WZG#S-7R}jBAc}DSeD`W zVsp5r+;Nh}7{|l%yS|jrgH0g~Vg-Ebz@6H5sr-A(UH!f&j?B>Vm0Qu-|9O{ zdzYmWYJht*Mp2Ihqh z6waOyD+2nEE_wp~%LNynqJqi_NLH3jF+7|cndcRt!8XJm0LodR!Kd~VpD*zINt@JD zr}yB9(D3XOg{FN`F+vtWvJ5#T1@86}&*gdYc9-D>jtOb=%*VouCNsCE@5&t+kX{!<2@lmE_$oX%Kg4cD z8X7iPt}D`8Jb*z$x*VX4a%oZeeO=HVGeIsYOWwZZz$U*6&Tk#gmx3n`9UkT4Nk^5eQL@_gV@@&Wba?f8lR)~ItIjouV*<&P#Cqk#$E zxdZ>bm{Q3shc_0#C%Cj{%#QV+?I$cIO-gtf4~{b1Vqm?9Jo1W^mD9KzXlJ7X+@tvu zrI;#2mcJBK#8s0MAllUsy`DD3W1gAbI$pfOmCgA}JltLZRxECWxF3Up$Uy>E-2%Ig zk{oBJWD6OW?NgYd{bL39MBia`pIg^G*aRGGoD7~}o%3ubML1?|wpwa!m5a)b4ED~} z7a=guN)RjD*ws;US|*{we;2OH92hz!Gn4u$yvH^Lw=sX$j$>NehRICs_7_>q5=y*= zsb)1GPVTND;<2~9>3gY~>4#tThJx=sbHt}b7;lL(cSYrgGCy5EZ5)^OM$MGTC8+k))<>i-3H1RuWBScdU$Y0$3l=CkvBzi|h10_V$^-9Op~mJ?up>5I;=Ue3YTKC@Mx1~K13V{8drF4D ziO--M0B0gD%Mt2G!tL?vhQ0M93sCL zSEWN8Hd&L7uKFc;h+08bejEIl>=?F%buuC;%0oqgrdmjDOopp$JxqXxZat|Bd}n7{ zsNVFUkrf;{chjAfxT02q0+cmr$C&e(r77OUKEJnv zC&okDR+d5pj1lKY>7ve*J8G9#0=0k?dRyo<44t82@s3beqBeJ5RWo5si7rk;q7yJW zR+j!CxnzsOBvX%Cl(N8$Z^o&t=Vq}*Y&?IK+pnBvg7@6Wd!M!Q;gxTJ6RsUoAD(#) zWD)ee%QxVS()d)8QMEmJ;^Y1oR9X;w<-`4h^hBQnT7_^b34Yx~y@zs`y`F3sk{|V- z$OU7lia~eW?$dt>D0+F!m?Y)8kSy~`he-q;&og8GJ-u9+b5@@7nRHlDYE*u(Mq5rE zRPA;StWF#qwZzhA-c$4&$9Rm8Pprf|v@JczG2&&ha?m^K)5G<`t}HJX<)*{7X6`eD zK0d`@s~^q?s6&t1zW1%66fN=yMWcRXn-q7c`#m1*_v}LHBm&o|%J^M44vSxmb`F8|5B>lia^4{7Vc&Pe@Kq!V0PR!U1(n*0Ev=V^SPw%KW?noBV$)A{l-Zbde zm_JTMQOwx^hDAE)wr)DE{r#JZN2^3~m9Bb^I;ZAzs2@4=s`l7<-!VdAb``_OC5A;@ z){=cjf1)|Euf@0FcF>@135}Hs5&a7>m9(`x>LY6qrz;&%oJl&nAXztF@CJ1*G*})GL2m#dXvmUYa*)E zrtrWb-$BHuz5dt%){>R4IQu3p zORZWGuX*<_y=58^a_+UWOtwvJ*0`pI(K2?_WCIIcVJi`mRNwr?mOdz-9Gc$$1jxy**b+@cEs6wYQ2$qsR+mU zy|6@QB`ljd4-58Ry)me{9H0FHBrmD3?d}_7EXTR@C4#AU4Ppzl_ezNG8bMQMoZAkb zw)1!d?65H@@mLrHJdNg%uW$~;E+CJ3v8jaW6=<}pPAZ6jq?tJ=izl10hn0m`yMPJ9 zjy@ptZHi5R;`=!1=07iQ7q$iU&yu$E2U1`3w;Ts@wrPQlZIcyOIV!SD)yKffPv&ae z{%zKP?^$2-iUcD$+|_Q3FcxNxH)=3c4dw4HMTy# zdoFnlJn26F1;2@M#VPuOorvo8X)!B|b9H=f-6b2nir?0VWUFsaW>Q@Nz8)7@~QjZ6nyvsehf|-WrB$%yH!P*y#6(Vbx2}HC~5}6uA^0J z8^gfECAgBL_SKIH(nS6mX%4jyf89w?g;Wy!jMnk06V(_MG{1%k^bbtxc2=SjDGVzx zEZ*hgw3+Jf9SR+7<^0AEsqSJe%t(!RIBbYt1!<=d?PiVI7S+%esCc8J;pZNFh_0ui z7J{^W1c~j2U+j#I)M_#%N-yF5m%HR$z z$qgc};D~oU##W28L7gyud7&9N9<<6%u8H}B*Q4H64Pu6wjLoH@lvNkV%%2+OUb`gujhxR$h{PsPJe@YLZDcoGtM8t3UR-Gr?Ysmj4U%}#OXP25eg!0I-blM$ zK3QCz-<)T-%G31uOWU5BC;L#&+Bxi1g_jv2 z%Mwp70q~5Y!Q(y3()RMyuL+`}A3y0Z26*4G8PAV zUIAPlF)zix*oqbQ8`;Xr`3)b#S<1e0_1o9Mk&G=*~)DF1H1KO)TZT{;r^0nSKNx`z4*STKarF3)#3N1L_! z;;@OFB|?OVQ->AdUv;-l;qSH_-oagNc2gD#2bd$yl(Li4;UJBU;F}Vrrw=Y56v1cR z`g1Op)SW7p3j(krp27rt6Kw>CniL1t-T{%c{2SZUW(cqM;W$?sQ%+&QyarAD^rVg= z|6$RpMEYbCseEI#amf0$k-2@UqI}xf@*x4DP?;N?Ov}Q-X#EhgPG7Ktcj&M~+#W7w zK*O}h7qU*bkEyT`r*kl8h*1#3!0Xv)44O9W zvnvp+dP&*=$y+GlCkI;Q;k!K`GH|CAKP%L0<6hMB@$<)SQ+pX$-BZ}pwI|Lj2!uLfdCDro>+q$h%@%?<*5|44?y`4x{Vzw8>g3IvsSknHh*L1Q?y3-F`vV(e!FMHQg{e6kQV%~ zX;5yrmQAUxFjXmMNY@a^!z^(4Lh3{#4eF(!3d3(KJhn!Vhb;uVtq0z8O-wzQz&CS7 zIzL^Z8FjClx8$_eo;ZDho$^0$q&^$uEuI)!t+M058`Fmm%zZ$_)P=J23v|ZX+=@!u z&QShr;|QDR;%1jWX}A6ruuPJIg*nD({Wi(d1&;pdqn51d_KbC6JnNXNuP{uF(@=(n z7nnrpK_n=bYWzO(A)I=28L=yA{q4CDWen=cmiZ9)NEGJeug{rOuY3&iXKPf9}YS((PtEo8~Pvr zSbqN2nFe|a*dv2W4w>4>o_@JrrjmCVC?rX}gol3QEMk-7p7Z=phUBu#M$`~y9b$b^ znYqT5YE6@tM_X4S`ko9Y3>>u{%4jZu1=?P4FQ$&bHpS-j`-$@KX5#cR#BORX)&x3X=rn>^uCOZLTWRQ3z0*LZZ6q99XR`5k zVtvkRt;zN{wCK(Dj)vo;EQPpzYgbi2dHRk+-(dzB zk!e}yx{j31@yJ!`owQ*HRfsMB{W85sq+Xf@|sgIFs@8&FJ?KWZ6wA5 z?~CH{*^~EpwabAKZYqfH37vrY>6UgLgECkE1ans&8k&(H>Fcu6DQ-=~f!kni~APNyIEeVeQgB(`(Y8WCHrnp@jXn%Ut7J>IG!Xna z>qJa%_q-?~EJfpJ+!8mp{y!V~qyxB`9yRnUdiY)~Vur_%aFVix@<3Yuf*U?Z?Ql1> z3(fgP|67j8^n3go28@77yUd9!9UX+5EG8oIyd!7Tl|QJ?1&&3Jrh`F~1fo{@W8Nq> zV}I9}!Hu62$EYY311#h9n;fXB{~G8`L&*`H`nwVXe+Jz4EnL)qO5IS(9eUFd~Ws1 zLKif&(A3Gf5B87}YxQI~yEQotC8>vK7@nWWk=!EDa+ynP^1-^BTYG#~jgw=be4R;6 zXG50|B!8fSTzJ$&rDEQ%g6zxCS+q70$HP4)`_WVb{0}F|qsOGIgQe&NYxz*je{ z(}o+Qc>qDMr_rU*26-&zyP>aES|T6NU2t`B-YwYZPY49asd+rt+SaB-V(xUNb9~q0 zt5Xt{o{r8M9zMZ~Sg-V9!)M_o1nvGKIr9ca5iCQ3W|5(T!mJ89e3Xi@Uxv9sFCWY?+5n&d{?N<*SuQdD~k4 zD2IC0%J45W2dSifgs~hkPHNM4(Qo=eg4&AMHP4A6v{#Y5JyPf2EL;O>>=P2_U z?5HnUuLagcQ&wIgwTvr}zhHME(96Rs6WGR=LTS=+pxCt5qNmYWN*SVyUh!QfZWc?| z|GBQy16(IATRzgy-G>s#z`402e z;BJwynP0|Z6XT*h%@GXveCs)Uxmw4%#cAI6g|xIVOCz{rR)62Xzo0Sg;DClbroaL= zQWpo(DE_Hd+^$5z#59;r!cE>>7|MGCX`bn(k|hhE5*I0$ERSSJ&#-W>HY0tbBY-+E zxZw;UtYI~dY8DV6rVRBbm~Y$ZTVcpLZl{ZN<3tJ{`&}bW?K<>jxYmFOwSO~9KNNJ# zfw^hZf8TJAbIaxoyDtz#nqR$l55|yU3RwXh zQUX?sl5+CHM-ao7D_JS6<3;>sp|o=Raz4=+*~uHoBWxM&mbtFFum9bc&c6DtK0>NwHPr_%flW%V5Ul1J9Zls3zJ2EJj8mL(y)*w4M= z0}-Sd}wZg zI7HDFw%nswXJm)TF1!^#&RQx|@gtb!g^=n-+|!_L+#|Lw|3Ri=ord&bOlzPOM>FKB z*{`L28dDeURptk$#D47UqPLLh^9#*Hd%-VfAr57VT0;NXZIp|%Pc32J3lgy--d&Cn z!y3IIImiQe2^fo-&Sbv={5`b@+x&`~=Xo%5+qAx6&&L?o1RbZwgIn!^;Fi!cD?&%B zIB4h@OO&i6()C(JBue1F<7daIle8#;!FeT``A;ORE@pB8*tOt8c?rf-xTXd(AXklgQHEr#SrJ*T*e*j)1)OTW}j`e!nU3$rP0$LqO<6;^>Hs zYQC7_M0FNP=o)Z^a39X2HG_19baD-N3SbC7HUBE=a@!rzsS=7VWIwwo!Q_NuT zzd<<1RP`br03qzVzIy4%kp^6FU3SM90&PZ-%a;V~wZ8HgzE1?WymZqNqP+wr0E7Vk z;nilc=TvG9MS}{d;;B79e1w}GY|x_nx%H#e=ZI61w`1QBkF~~;d}hs1H}N$1@(O4m z9(um~^+5PXwl_`R-eJsbXss`1rv8tibsQ;5P>Uo1k7f1Brmh6~d_&r^Qn#;k>zgE2 z4yaPA+>3UCY80dCD}Y`V&iu72z{P@HP+35jsBf5^jDEX^_7eubH2)~$Q<@y85EDJ^ z>jkaL#Px#;z{T8csBsUK67zraEkiHY2gK}E?Lh@vYs;*GNV^a%5Q6gGBhnoHr!;4l zf1HCjIi(4Mhmw$0{}3>ZTLrECQ3T&Sg`|xcgp>|-Mr(jnheE8Wn~}1 z3YD+s4Hj(HC3fmF7kmZKXlva@bx!=8Kj5qQPsXwS{A$pYb038qFxD#I$P|=d=G)*L zSx_Pu;+(ygR0+jsw4F>x5r{QxP*qr=cZAsDDm+GkSd{5r0>uBNS^$7>(1^|Gy?;%K zR99`|CH4OO_OS+U5dJHGIiyEg1G#hhuJhgWes%j1*PhdvC0C908MJe;;f_FqnD(9X z_Z~T^&0JR5=j@(hG&~_nOjM*u*!)aDVCt_CR3c+!%0ern{G_mtPY0aoM5=2!3AcDs zJZk%rIfFQp4o6<3JfSvDWC>a}vp=;*CGzD5>4TBKHmA@gBY&m4$Gv`feh>HzxHs!j z>K~wQZdD4U&rFl;{|wVcZwXsZLNC|umL|a2mQ_2Hod4einx9Vn`Spo?v7H%jOMZM% z^O}V+H*x1*xA8M8TnO+ANWd{Icuy6H?0XtYCg`}BZ;HCjBmQK_4R5lT1`vqiEjoFFPJ?+!=mf#ZH}9+g*< zZ&vky^#f~SI1i!Phvb7|89;KcFgBtVVHYhbOOTY5EV8&n4C!SQ8fH4geUo<3HNHe$ z@g|%{;W4>S5gF|%=vnX|mqVVvVf*H&cgJ_ckjgP0|0a?{#*@|67-46jm+iBT-A4s$ z(nx7*tOcJ4KdVXvA4GKBiEFHVH{bYX zg_*#_UxRL6OHTjo?o`{!p-8VchL!HadFa+qH7(rI?+Yc0mdQP!Vrl$hz /dev/null -rm -rf html-stagedRemove$$ >/dev/null 2>&1 & - -# ensure that created files are readable by everyone -umask 22 -doxygen - -# fix permissions (NB: '+X' and not '+x'!) -chmod -R a+rX html latex man 2>/dev/null - -echo -echo "Done doxygen" -echo - -# ----------------------------------------------------------------- end-of-file diff --git a/doc/doxygen/Doxyfile b/doc/doxygen/Doxyfile deleted file mode 100644 index 35d29e2ce7..0000000000 --- a/doc/doxygen/Doxyfile +++ /dev/null @@ -1,1589 +0,0 @@ -# Doxyfile 1.6.3 - -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project -# -# All text after a hash (#) is considered a comment and will be ignored -# The format is: -# TAG = value [value, ...] -# For lists items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (" ") - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all -# text before the first occurrence of this tag. Doxygen uses libiconv (or the -# iconv built into libc) for the transcoding. See -# http://www.gnu.org/software/libiconv for the list of possible encodings. - -DOXYFILE_ENCODING = UTF-8 - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded -# by quotes) that should identify the project. - -PROJECT_NAME = OpenFOAM-$(WM_PROJECT_VERSION) - -# 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 = - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) -# base path where the generated documentation will be put. -# If a relative path is entered, it will be relative to the location -# where doxygen was started. If left blank the current directory will be used. - -OUTPUT_DIRECTORY = - -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create -# 4096 sub-directories (in 2 levels) under the output directory of each output -# format and will distribute the generated files over these directories. -# Enabling this option can be useful when feeding doxygen a huge amount of -# source files, where putting all generated files in the same directory would -# otherwise cause performance problems for the file system. - -CREATE_SUBDIRS = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# The default language is English, other supported languages are: -# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, -# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, -# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English -# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, -# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, -# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. - -OUTPUT_LANGUAGE = English - -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will -# include brief member descriptions after the members that are listed in -# the file and class documentation (similar to JavaDoc). -# Set to NO to disable this. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend -# the brief description of a member or function before the detailed description. -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. - -REPEAT_BRIEF = YES - -# This tag implements a quasi-intelligent brief description abbreviator -# that is used to form the text in various listings. Each string -# in this list, if found as the leading text of the brief description, will be -# stripped from the text and the result after processing the whole list, is -# used as the annotated text. Otherwise, the brief description is used as-is. -# If left blank, the following values are used ("$name" is automatically -# replaced with the name of the entity): "The $name class" "The $name widget" -# "The $name file" "is" "provides" "specifies" "contains" -# "represents" "a" "an" "the" - -ABBREVIATE_BRIEF = - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# Doxygen will generate a detailed section even if there is only a brief -# description. - -ALWAYS_DETAILED_SEC = NO - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. - -INLINE_INHERITED_MEMB = NO - -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full -# path before files name in the file list and in the header files. If set -# to NO the shortest path that makes the file name unique will be used. - -FULL_PATH_NAMES = YES - -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag -# can be used to strip a user-defined part of the path. Stripping is -# only done if one of the specified strings matches the left-hand part of -# the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the -# path to strip. - -STRIP_FROM_PATH = $(WM_PROJECT_DIR) - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of -# the path mentioned in the documentation of a class, which tells -# the reader which header file to include in order to use a class. -# If left blank only the name of the header file containing the class -# definition is used. Otherwise one should specify the include paths that -# are normally passed to the compiler using the -I flag. - -STRIP_FROM_INC_PATH = - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter -# (but less readable) file names. This can be useful is your file systems -# doesn't support long names like on DOS, Mac, or CD-ROM. - -SHORT_NAMES = NO - -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen -# will interpret the first line (until the first dot) of a JavaDoc-style -# comment as the brief description. If set to NO, the JavaDoc -# comments will behave just like regular Qt-style comments -# (thus requiring an explicit @brief command for a brief description.) - -JAVADOC_AUTOBRIEF = NO - -# If the QT_AUTOBRIEF tag is set to YES then Doxygen will -# interpret the first line (until the first dot) of a Qt-style -# comment as the brief description. If set to NO, the comments -# will behave just like regular Qt-style comments (thus requiring -# an explicit \brief command for a brief description.) - -QT_AUTOBRIEF = NO - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen -# treat a multi-line C++ special comment block (i.e. a block of //! or /// -# comments) as a brief description. This used to be the default behaviour. -# The new default is to treat a multi-line C++ comment block as a detailed -# description. Set this tag to YES if you prefer the old behaviour instead. - -MULTILINE_CPP_IS_BRIEF = NO - -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented -# member inherits the documentation from any documented member that it -# re-implements. - -INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce -# a new page for each member. If set to NO, the documentation of a member will -# be part of the file/class/namespace that contains it. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. -# Doxygen uses this value to replace tabs by spaces in code fragments. - -TAB_SIZE = 4 - -# This tag can be used to specify a number of aliases that acts -# as commands in the documentation. An alias has the form "name=value". -# For example adding "sideeffect=\par Side Effects:\n" will allow you to -# put the command \sideeffect (or @sideeffect) in the documentation, which -# will result in a user-defined paragraph with heading "Side Effects:". -# You can put \n's in the value part of an alias to insert newlines. - -ALIASES = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C -# sources only. Doxygen will then generate output that is more tailored for C. -# For instance, some of the names that are used will be different. The list -# of all members will be omitted, etc. - -OPTIMIZE_OUTPUT_FOR_C = NO - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java -# sources only. Doxygen will then generate output that is more tailored for -# Java. For instance, namespaces will be presented as packages, qualified -# scopes will look different, etc. - -OPTIMIZE_OUTPUT_JAVA = NO - -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources only. Doxygen will then generate output that is more tailored for -# Fortran. - -OPTIMIZE_FOR_FORTRAN = NO - -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for -# VHDL. - -OPTIMIZE_OUTPUT_VHDL = NO - -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given -# extension. Doxygen has a built-in mapping, but you can override or extend it -# using this tag. The format is ext=language, where ext is a file extension, -# and language is one of the parsers supported by doxygen: IDL, Java, -# Javascript, C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, -# C++. For instance to make doxygen treat .inc files as Fortran files (default -# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note -# that for custom extensions you also need to set FILE_PATTERNS otherwise the -# files are not read by doxygen. - -EXTENSION_MAPPING = - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should -# set this tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. -# func(std::string) {}). This also make the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. - -BUILTIN_STL_SUPPORT = NO - -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. - -CPP_CLI_SUPPORT = NO - -# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. -# Doxygen will parse them like normal C++ but will assume all classes use public -# instead of private inheritance when no explicit protection keyword is present. - -SIP_SUPPORT = NO - -# For Microsoft's IDL there are propget and propput attributes to indicate -# getter and setter methods for a property. Setting this option to YES (the -# default) will make doxygen to replace the get and set methods by a property in -# the documentation. This will only work if the methods are indeed getting or -# setting a simple type. If this is not the case, or you want to show the -# methods anyway, you should set this option to NO. - -IDL_PROPERTY_SUPPORT = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. - -DISTRIBUTE_GROUP_DOC = NO - -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of -# the same type (for instance a group of public functions) to be put as a -# subgroup of that type (e.g. under the Public Functions section). Set it to -# NO to prevent subgrouping. Alternatively, this can be done per class using -# the \nosubgrouping command. - -SUBGROUPING = YES - -# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum -# is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically -# be useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. - -TYPEDEF_HIDES_STRUCT = NO - -# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to -# determine which symbols to keep in memory and which to flush to disk. -# When the cache is full, less often used symbols will be written to disk. -# For small to medium size projects (<1000 input files) the default value is -# probably good enough. For larger projects a too small cache size can cause -# doxygen to be busy swapping symbols to and from disk most of the time -# causing a significant performance penality. -# If the system has enough physical memory increasing the cache will improve the -# performance by keeping more symbols in memory. Note that the value works on -# a logarithmic scale so increasing the size by one will rougly double the -# memory usage. The cache size is given by this formula: -# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, -# corresponding to a cache size of 2^16 = 65536 symbols - -SYMBOL_CACHE_SIZE = 0 - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. -# Private class members and static file members will be hidden unless -# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES - -EXTRACT_ALL = YES - -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class -# will be included in the documentation. - -EXTRACT_PRIVATE = NO - -# If the EXTRACT_STATIC tag is set to YES all static members of a file -# will be included in the documentation. - -EXTRACT_STATIC = YES - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) -# defined locally in source files will be included in the documentation. -# If set to NO only classes defined in header files are included. - -EXTRACT_LOCAL_CLASSES = YES - -# This flag is only useful for Objective-C code. When set to YES local -# methods, which are defined in the implementation section but not in -# the interface are included in the documentation. -# If set to NO (the default) only methods in the interface are included. - -EXTRACT_LOCAL_METHODS = NO - -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base -# name of the file that contains the anonymous namespace. By default -# anonymous namespace are hidden. - -EXTRACT_ANON_NSPACES = NO - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all -# undocumented members of documented classes, files or namespaces. -# If set to NO (the default) these members will be included in the -# various overviews, but no documentation section is generated. -# This option has no effect if EXTRACT_ALL is enabled. - -HIDE_UNDOC_MEMBERS = NO - -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. -# If set to NO (the default) these classes will be included in the various -# overviews. This option has no effect if EXTRACT_ALL is enabled. - -HIDE_UNDOC_CLASSES = NO - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all -# friend (class|struct|union) declarations. -# If set to NO (the default) these declarations will be included in the -# documentation. - -HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any -# documentation blocks found inside the body of a function. -# If set to NO (the default) these blocks will be appended to the -# function's detailed documentation block. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation -# that is typed after a \internal command is included. If the tag is set -# to NO (the default) then the documentation will be excluded. -# Set it to YES to include the internal documentation. - -INTERNAL_DOCS = NO - -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate -# file names in lower-case letters. If set to YES upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. - -CASE_SENSE_NAMES = YES - -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen -# will show members with their full class and namespace scopes in the -# documentation. If set to YES the scope will be hidden. - -HIDE_SCOPE_NAMES = YES - -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put a list of the files that are included by a file in the documentation -# of that file. - -SHOW_INCLUDE_FILES = NO - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen -# will list include files with double quotes in the documentation -# rather than with sharp brackets. - -FORCE_LOCAL_INCLUDES = NO - -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] -# is inserted in the documentation for inline members. - -INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen -# will sort the (detailed) documentation of file and class members -# alphabetically by member name. If set to NO the members will appear in -# declaration order. - -SORT_MEMBER_DOCS = NO - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the -# brief documentation of file, namespace and class members alphabetically -# by member name. If set to NO (the default) the members will appear in -# declaration order. - -SORT_BRIEF_DOCS = NO - -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the -# (brief and detailed) documentation of class members so that constructors and -# destructors are listed first. If set to NO (the default) the constructors will -# appear in the respective orders defined by SORT_MEMBER_DOCS and -# SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is -# set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. - -SORT_MEMBERS_CTORS_1ST = NO - -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the -# hierarchy of group names into alphabetical order. If set to NO (the default) -# the group names will appear in their defined order. - -SORT_GROUP_NAMES = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be -# sorted by fully-qualified names, including namespaces. If set to -# NO (the default), the class list will be sorted only by class name, -# not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the -# alphabetical list. - -SORT_BY_SCOPE_NAME = NO - -# The GENERATE_TODOLIST tag can be used to enable (YES) or -# disable (NO) the todo list. This list is created by putting \todo -# commands in the documentation. - -GENERATE_TODOLIST = YES - -# 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. - -GENERATE_TESTLIST = YES - -# The GENERATE_BUGLIST tag can be used to enable (YES) or -# disable (NO) the bug list. This list is created by putting \bug -# commands in the documentation. - -GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or -# disable (NO) the deprecated list. This list is created by putting -# \deprecated commands in the documentation. - -GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional -# documentation sections, marked by \if sectionname ... \endif. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines -# the initial value of a variable or define consists of for it to appear in -# the documentation. If the initializer consists of more lines than specified -# here it will be hidden. Use a value of 0 to hide initializers completely. -# The appearance of the initializer of individual variables and defines in the -# documentation can be controlled using \showinitializer or \hideinitializer -# command in the documentation regardless of this setting. - -MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated -# at the bottom of the documentation of classes and structs. If set to YES the -# list will mention the files that were used to generate the documentation. - -SHOW_USED_FILES = YES - -# If the sources in your project are distributed over multiple directories -# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy -# in the documentation. The default is NO. - -SHOW_DIRECTORIES = YES - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. -# This will remove the Files entry from the Quick Index and from the -# Folder Tree View (if specified). The default is YES. - -SHOW_FILES = YES - -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the -# Namespaces page. -# This will remove the Namespaces entry from the Quick Index -# and from the Folder Tree View (if specified). The default is YES. - -SHOW_NAMESPACES = YES - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command , where is the value of -# the FILE_VERSION_FILTER tag, and is the name of an input file -# provided by doxygen. Whatever the program writes to standard output -# is used as the file version. See the manual for examples. - -FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. The create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. You can -# optionally specify a file name after the option, if omitted DoxygenLayout.xml -# will be used as the name of the layout file. - -LAYOUT_FILE = - -#--------------------------------------------------------------------------- -# configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated -# by doxygen. Possible values are YES and NO. If left blank NO is used. - -QUIET = NO - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated by doxygen. Possible values are YES and NO. If left blank -# NO is used. - -WARNINGS = YES - -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will -# automatically be disabled. - -WARN_IF_UNDOCUMENTED = YES - -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some -# parameters in a documented function, or documenting parameters that -# don't exist or using markup commands wrongly. - -WARN_IF_DOC_ERROR = YES - -# This WARN_NO_PARAMDOC option can be abled to get warnings for -# functions that are documented, but have no documentation for their parameters -# or return value. If set to NO (the default) doxygen will only warn about -# wrong or incomplete parameter documentation, but not about the absence of -# documentation. - -WARN_NO_PARAMDOC = NO - -# The WARN_FORMAT tag determines the format of the warning messages that -# doxygen can produce. The string should contain the $file, $line, and $text -# tags, which will be replaced by the file and line number from which the -# warning originated and the warning text. Optionally the format may contain -# $version, which will be replaced by the version of the file (if it could -# be obtained via FILE_VERSION_FILTER) - -WARN_FORMAT = "$file:$line: $text " - -# The WARN_LOGFILE tag can be used to specify a file to which warning -# and error messages should be written. If left blank the output is written -# to stderr. - -WARN_LOGFILE = - -#--------------------------------------------------------------------------- -# configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag can be used to specify the files and/or directories that contain -# documented source files. You may enter file names like "myfile.cpp" or -# directories like "/usr/src/myproject". Separate the files or directories -# with spaces. - -INPUT = $(WM_PROJECT_DIR)/src \ - $(WM_PROJECT_DIR)/applications/utilities \ - $(WM_PROJECT_DIR)/applications/solvers - -# limit input for testing purposes -# INPUT = $(WM_PROJECT_DIR)/src/OpenFOAM/global \ -# $(WM_PROJECT_DIR)/src/OpenFOAM/containers \ -# $(WM_PROJECT_DIR)/src/OpenFOAM/primitives \ -# $(WM_PROJECT_DIR)/sampling \ -# $(WM_PROJECT_DIR)/src/finiteVolume/fvMesh - -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is -# also the default input encoding. Doxygen uses libiconv (or the iconv built -# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for -# the list of possible encodings. - -INPUT_ENCODING = UTF-8 - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx -# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 - -FILE_PATTERNS = *.H \ - *.C - -# The RECURSIVE tag can be used to turn specify whether or not subdirectories -# should be searched for input files as well. Possible values are YES and NO. -# If left blank NO is used. - -RECURSIVE = YES - -# The EXCLUDE tag can be used to specify files and/or directories that should -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. - -EXCLUDE = - -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or -# directories that are symbolic links (a Unix filesystem feature) are excluded -# from the input. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. Note that the wildcards are matched -# against the file with absolute path, so to exclude all test directories -# for example use the pattern */test/* - -EXCLUDE_PATTERNS = */lnInclude/* \ - */t/* - -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test - -EXCLUDE_SYMBOLS = - -# The EXAMPLE_PATH tag can be used to specify one or more files or -# directories that contain example code fragments that are included (see -# the \include command). - -EXAMPLE_PATH = - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank all files are included. - -EXAMPLE_PATTERNS = - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude -# commands irrespective of the value of the RECURSIVE tag. -# Possible values are YES and NO. If left blank NO is used. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or -# directories that contain image that are included in the documentation (see -# the \image command). - -IMAGE_PATH = - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command , where -# is the value of the INPUT_FILTER tag, and is the name of an -# input file. Doxygen will then use the output that the filter program writes -# to standard output. -# If FILTER_PATTERNS is specified, this tag will be -# ignored. - -INPUT_FILTER = $(WM_PROJECT_DIR)/bin/tools/doxyFilter - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. -# Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. -# The filters are a list of the form: -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further -# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER -# is applied to all files. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will be used to filter the input files when producing source -# files to browse (i.e. when SOURCE_BROWSER is set to YES). - -FILTER_SOURCE_FILES = NO - -#--------------------------------------------------------------------------- -# configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will -# be generated. Documented entities will be cross-referenced with these sources. -# Note: To get rid of all source code in the generated output, make sure also -# VERBATIM_HEADERS is set to NO. - -SOURCE_BROWSER = YES - -# Setting the INLINE_SOURCES tag to YES will include the body -# of functions and classes directly in the documentation. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# doxygen to hide any special comment blocks from generated source code -# fragments. Normal C and C++ comments will always remain visible. - -STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES -# then for each documented function all documented -# functions referencing it will be listed. - -REFERENCED_BY_RELATION = YES - -# If the REFERENCES_RELATION tag is set to YES -# then for each documented function all documented entities -# called/used by that function will be listed. - -REFERENCES_RELATION = YES - -# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) -# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from -# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will -# link to the source code. -# Otherwise they will link to the documentation. - -REFERENCES_LINK_SOURCE = YES - -# If the USE_HTAGS tag is set to YES then the references to source code -# will point to the HTML generated by the htags(1) tool instead of doxygen -# built-in source browser. The htags tool is part of GNU's global source -# tagging system (see http://www.gnu.org/software/global/global.html). You -# will need version 4.8.6 or higher. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen -# will generate a verbatim copy of the header file for each class for -# which an include is specified. Set to NO to disable this. - -VERBATIM_HEADERS = YES - -#--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index -# of all compounds will be generated. Enable this if the project -# contains a lot of classes, structs, unions or interfaces. - -ALPHABETICAL_INDEX = YES - -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns -# in which this list will be split (can be a number in the range [1..20]) - -COLS_IN_ALPHA_INDEX = 1 - -# In case all classes in a project start with a common prefix, all -# classes will be put under the same header in the alphabetical index. -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that -# should be ignored while generating the index headers. - -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will -# generate HTML output. - -GENERATE_HTML = YES - -# If the HTML_FOOTER_DESCRIPTION tag is set to YES, Doxygen will -# add generated date, project name and doxygen version to HTML footer. - -HTML_FOOTER_DESCRIPTION= NO - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `html' will be used as the default path. - -HTML_OUTPUT = html - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank -# doxygen will generate files with .html extension. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a -# standard header. - -HTML_HEADER = $(WM_PROJECT_DIR)/doc/doxygen/_Header - -# The HTML_FOOTER tag can be used to specify a personal HTML footer for -# each generated HTML page. If it is left blank doxygen will generate a -# standard footer. - -HTML_FOOTER = $(WM_PROJECT_DIR)/doc/doxygen/_Footer - -# 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 the HTML output. If the tag is left blank doxygen -# will generate a default style sheet. Note that doxygen will try to copy -# the style sheet file to the HTML output directory, so don't put your own -# stylesheet in the HTML output directory as well, or it will be erased! - -HTML_STYLESHEET = - -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting -# this to NO can help when comparing the output of multiple runs. - -HTML_TIMESTAMP = NO - -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, -# files or namespaces will be aligned in HTML using tables. If set to -# NO a bullet list will be used. - -HTML_ALIGN_MEMBERS = YES - -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. For this to work a browser that supports -# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox -# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). - -HTML_DYNAMIC_SECTIONS = NO - -# If the GENERATE_DOCSET tag is set to YES, additional index files will be -# generated that can be used as input for Apple's Xcode 3 integrated development -# environment, introduced with OSX 10.5 (Leopard). To create a documentation -# set, doxygen will generate a Makefile in the HTML output directory. Running -# make will produce the docset in that directory and running "make install" will -# install the docset in ~/Library/Developer/Shared/Documentation/DocSets so that -# Xcode will find it at startup. See -# http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more -# information. - -GENERATE_DOCSET = NO - -# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the -# feed. A documentation feed provides an umbrella under which multiple -# documentation sets from a single provider (such as a company or product suite) -# can be grouped. - -DOCSET_FEEDNAME = "Doxygen generated docs" - -# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that -# should uniquely identify the documentation set bundle. This should be a -# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen -# will append .docset to the name. - -DOCSET_BUNDLE_ID = org.doxygen.Project - -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) -# of the generated HTML documentation. - -GENERATE_HTMLHELP = NO - -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can -# be used to specify the file name of the resulting .chm file. You -# can add a path in front of the file if the result should not be -# written to the html output directory. - -CHM_FILE = - -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can -# be used to specify the location (absolute path including file name) of -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run -# the HTML help compiler on the generated index.hhp. - -HHC_LOCATION = - -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag -# controls if a separate .chi index file is generated (YES) or that -# it should be included in the master .chm file (NO). - -GENERATE_CHI = NO - -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING -# is used to encode HtmlHelp index (hhk), content (hhc) and project file -# content. - -CHM_INDEX_ENCODING = - -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag -# controls whether a binary table of contents is generated (YES) or a -# normal table of contents (NO) in the .chm file. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members -# to the contents of the HTML help documentation and to the tree view. - -TOC_EXPAND = NO - -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that -# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help -# (.qch) of the generated HTML documentation. - -GENERATE_QHP = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can -# be used to specify the file name of the resulting .qch file. -# The path specified is relative to the HTML output folder. - -QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#namespace - -QHP_NAMESPACE = org.doxygen.Project - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#virtual-folders - -QHP_VIRTUAL_FOLDER = doc - -# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to -# add. For more information please see -# http://doc.trolltech.com/qthelpproject.html#custom-filters - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom -# filter to add.For more information please see Qt Help -# Project / Custom Filters. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's filter section matches. Qt Help -# Project / Filter Attributes. - -QHP_SECT_FILTER_ATTRS = - -# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can -# be used to specify the location of Qt's qhelpgenerator. -# If non-empty doxygen will try to run qhelpgenerator on the generated -# .qhp file. - -QHG_LOCATION = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be -# generated, which together with the HTML files, form an Eclipse help -# plugin. To install this plugin and make it available under the help contents -# menu in Eclipse, the contents of the directory containing the HTML and XML -# files needs to be copied into the plugins directory of eclipse. The name of -# the directory within the plugins directory should be the same as the -# ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before the -# help appears. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have -# this name. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# The DISABLE_INDEX tag can be used to turn on/off the condensed index at -# top of each HTML page. The value NO (the default) enables the index and -# the value YES disables it. - -DISABLE_INDEX = NO - -# This tag can be used to set the number of enum values (range [1..20]) -# that doxygen will group on one line in the generated HTML documentation. - -ENUM_VALUES_PER_LINE = 4 - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. -# If the tag value is set to YES, a side panel will be generated -# containing a tree-like index structure (just like the one that -# is generated for HTML Help). For this to work a browser that supports -# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). -# Windows users are probably better off using the HTML help feature. - -GENERATE_TREEVIEW = NO - -# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, -# and Class Hierarchy pages using a tree view instead of an ordered list. - -USE_INLINE_TREES = NO - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be -# used to set the initial width (in pixels) of the frame in which the tree -# is shown. - -TREEVIEW_WIDTH = 250 - -# Use this tag to change the font size of Latex formulas included -# as images in the HTML documentation. The default is 10. Note that -# when you change the font size after a successful doxygen run you need -# to manually remove any form_*.png images from the HTML output directory -# to force them to be regenerated. - -FORMULA_FONTSIZE = 10 - -# When the SEARCHENGINE tag is enabled doxygen will generate a search box for -# the HTML output. The underlying search engine uses javascript and DHTML and -# should work on any modern browser. Note that when using HTML help -# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) -# there is already a search function so this one should typically be -# disabled. For large projects the javascript based search engine can be slow, -# then enabling SERVER_BASED_SEARCH may provide a better solution. - -SEARCHENGINE = YES - -# When the SERVER_BASED_SEARCH tag is enabled the search engine will be -# implemented using a PHP enabled web server instead of at the web client using -# Javascript. Doxygen will generate the search PHP script and index file to put -# on the web server. The advantage of the server based approach is that it -# scales better to large projects and allows full text search. The disadvances -# is that it is more difficult to setup and does not have live searching -# capabilities. - -SERVER_BASED_SEARCH = NO -# old default -# SERVER_BASED_SEARCH = YES - -#--------------------------------------------------------------------------- -# configuration options related to the LaTeX output -#--------------------------------------------------------------------------- - -# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will -# generate Latex output. - -GENERATE_LATEX = NO - -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `latex' will be used as the default path. - -LATEX_OUTPUT = latex - -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be -# invoked. If left blank `latex' will be used as the default command name. -# Note that when enabling USE_PDFLATEX this option is only used for -# generating bitmaps for formulas in the HTML output, but not in the -# Makefile that is written to the output directory. - -LATEX_CMD_NAME = latex - -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to -# generate index for LaTeX. If left blank `makeindex' will be used as the -# default command name. - -MAKEINDEX_CMD_NAME = makeindex - -# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact -# LaTeX documents. This may be useful for small projects and may help to -# save some trees in general. - -COMPACT_LATEX = NO - -# The PAPER_TYPE tag can be used to set the paper type that is used -# by the printer. Possible values are: a4, a4wide, letter, legal and -# executive. If left blank a4wide will be used. - -PAPER_TYPE = a4wide - -# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX -# packages that should be included in the LaTeX output. - -EXTRA_PACKAGES = $(WM_PROJECT_DIR)/doc/Doxygen/Macros/tensorOperator - -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for -# the generated latex document. The header should contain everything until -# the first chapter. If it is left blank doxygen will generate a -# standard header. Notice: only use this tag if you know what you are doing! - -LATEX_HEADER = - -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated -# is prepared for conversion to pdf (using ps2pdf). The pdf file will -# contain links (just like the HTML output) instead of page references -# This makes the output suitable for online browsing using a pdf viewer. - -PDF_HYPERLINKS = YES - -# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of -# plain latex in the generated Makefile. Set this option to YES to get a -# higher quality PDF documentation. - -USE_PDFLATEX = YES - -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. -# command to the generated LaTeX files. This will instruct LaTeX to keep -# running if errors occur, instead of asking the user for help. -# This option is also used when generating formulas in HTML. - -LATEX_BATCHMODE = NO - -# If LATEX_HIDE_INDICES is set to YES then doxygen will not -# include the index chapters (such as File Index, Compound Index, etc.) -# in the output. - -LATEX_HIDE_INDICES = NO - -# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with -# syntax highlighting in the LaTeX output. Note that which sources are shown -# also depends on other settings such as SOURCE_BROWSER. - -LATEX_SOURCE_CODE = NO - -#--------------------------------------------------------------------------- -# configuration options related to the RTF output -#--------------------------------------------------------------------------- - -# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output -# The RTF output is optimized for Word 97 and may not look very pretty with -# other RTF readers or editors. - -GENERATE_RTF = NO - -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `rtf' will be used as the default path. - -RTF_OUTPUT = rtf - -# If the COMPACT_RTF tag is set to YES Doxygen generates more compact -# RTF documents. This may be useful for small projects and may help to -# save some trees in general. - -COMPACT_RTF = NO - -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated -# will contain hyperlink fields. The RTF file will -# contain links (just like the HTML output) instead of page references. -# This makes the output suitable for online browsing using WORD or other -# programs which support those fields. -# Note: wordpad (write) and others do not support links. - -RTF_HYPERLINKS = NO - -# Load stylesheet definitions from file. Syntax is similar to doxygen's -# config file, i.e. a series of assignments. You only have to provide -# replacements, missing definitions are set to their default value. - -RTF_STYLESHEET_FILE = - -# Set optional variables used in the generation of an rtf document. -# Syntax is similar to doxygen's config file. - -RTF_EXTENSIONS_FILE = - -#--------------------------------------------------------------------------- -# configuration options related to the man page output -#--------------------------------------------------------------------------- - -# If the GENERATE_MAN tag is set to YES (the default) Doxygen will -# generate man pages - -GENERATE_MAN = NO - -# The MAN_OUTPUT tag is used to specify where the man pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `man' will be used as the default path. - -MAN_OUTPUT = man - -# The MAN_EXTENSION tag determines the extension that is added to -# the generated man pages (default is the subroutine's section .3) - -MAN_EXTENSION = .3 - -# If the MAN_LINKS tag is set to YES and Doxygen generates man output, -# then it will generate one additional man file for each entity -# documented in the real man page(s). These additional files -# only source the real man page, but without them the man command -# would be unable to find the correct page. The default is NO. - -MAN_LINKS = NO - -#--------------------------------------------------------------------------- -# configuration options related to the XML output -#--------------------------------------------------------------------------- - -# If the GENERATE_XML tag is set to YES Doxygen will -# generate an XML file that captures the structure of -# the code including all documentation. - -GENERATE_XML = NO - -# The XML_OUTPUT tag is used to specify where the XML pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `xml' will be used as the default path. - -XML_OUTPUT = xml - -# The XML_SCHEMA tag can be used to specify an XML schema, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -XML_SCHEMA = - -# The XML_DTD tag can be used to specify an XML DTD, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -XML_DTD = - -# If the XML_PROGRAMLISTING tag is set to YES Doxygen will -# dump the program listings (including syntax highlighting -# and cross-referencing information) to the XML output. Note that -# enabling this will significantly increase the size of the XML output. - -XML_PROGRAMLISTING = YES - -#--------------------------------------------------------------------------- -# configuration options for the AutoGen Definitions output -#--------------------------------------------------------------------------- - -# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will -# generate an AutoGen Definitions (see autogen.sf.net) file -# that captures the structure of the code including all -# documentation. Note that this feature is still experimental -# and incomplete at the moment. - -GENERATE_AUTOGEN_DEF = NO - -#--------------------------------------------------------------------------- -# configuration options related to the Perl module output -#--------------------------------------------------------------------------- - -# If the GENERATE_PERLMOD tag is set to YES Doxygen will -# generate a Perl module file that captures the structure of -# the code including all documentation. Note that this -# feature is still experimental and incomplete at the -# moment. - -GENERATE_PERLMOD = NO - -# If the PERLMOD_LATEX tag is set to YES Doxygen will generate -# the necessary Makefile rules, Perl scripts and LaTeX code to be able -# to generate PDF and DVI output from the Perl module output. - -PERLMOD_LATEX = NO - -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be -# nicely formatted so it can be parsed by a human reader. -# This is useful -# if you want to understand what is going on. -# On the other hand, if this -# tag is set to NO the size of the Perl module output will be much smaller -# and Perl will parse it just the same. - -PERLMOD_PRETTY = YES - -# The names of the make variables in the generated doxyrules.make file -# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. -# This is useful so different doxyrules.make files included by the same -# Makefile don't overwrite each other's variables. - -PERLMOD_MAKEVAR_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the preprocessor -#--------------------------------------------------------------------------- - -# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will -# evaluate all C-preprocessor directives found in the sources and include -# files. - -ENABLE_PREPROCESSING = YES - -# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro -# names in the source code. If set to NO (the default) only conditional -# compilation will be performed. Macro expansion can be done in a controlled -# way by setting EXPAND_ONLY_PREDEF to YES. - -MACRO_EXPANSION = YES - -# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES -# then the macro expansion is limited to the macros specified with the -# PREDEFINED and EXPAND_AS_DEFINED tags. - -EXPAND_ONLY_PREDEF = NO - -# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files -# in the INCLUDE_PATH (see below) will be search if a #include is found. - -SEARCH_INCLUDES = NO - -# The INCLUDE_PATH tag can be used to specify one or more directories that -# contain include files that are not input files but should be processed by -# the preprocessor. - -INCLUDE_PATH = - -# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard -# patterns (like *.h and *.hpp) to filter out the header-files in the -# directories. If left blank, the patterns specified with FILE_PATTERNS will -# be used. - -INCLUDE_FILE_PATTERNS = - -# The PREDEFINED tag can be used to specify one or more macro names that -# are defined before the preprocessor is started (similar to the -D option of -# gcc). The argument of the tag is a list of macros of the form: name -# or name=definition (no spaces). If the definition and the = are -# omitted =1 is assumed. To prevent a macro definition from being -# undefined via #undef or recursively expanded use the := operator -# instead of the = operator. - -PREDEFINED = - -# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then -# this tag can be used to specify a list of macro names that should be expanded. -# The macro definition that is found in the sources will be used. -# Use the PREDEFINED tag if you want to use a different macro definition. - -EXPAND_AS_DEFINED = - -# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then -# doxygen's preprocessor will remove all function-like macros that are alone -# on a line, have an all uppercase name, and do not end with a semicolon. Such -# function macros are typically used for boiler-plate code, and will confuse -# the parser if not removed. - -SKIP_FUNCTION_MACROS = YES - -#--------------------------------------------------------------------------- -# Configuration::additions related to external references -#--------------------------------------------------------------------------- - -# The TAGFILES option can be used to specify one or more tagfiles. -# Optionally an initial location of the external documentation -# can be added for each tagfile. The format of a tag file without -# this location is as follows: -# -# TAGFILES = file1 file2 ... -# Adding location for the tag files is done as follows: -# -# TAGFILES = file1=loc1 "file2 = loc2" ... -# where "loc1" and "loc2" can be relative or absolute paths or -# URLs. If a location is present for each tag, the installdox tool -# does not have to be run to correct the links. -# Note that each tag file must have a unique name -# (where the name does NOT include the path) -# If a tag file is not located in the directory in which doxygen -# is run, you must also specify the path to the tagfile here. - -TAGFILES = - -# When a file name is specified after GENERATE_TAGFILE, doxygen will create -# a tag file that is based on the input files it reads. - -GENERATE_TAGFILE = DTAGS - -# If the ALLEXTERNALS tag is set to YES all external classes will be listed -# in the class index. If set to NO only the inherited external classes -# will be listed. - -ALLEXTERNALS = YES - -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed -# in the modules index. If set to NO, only the current project's groups will -# be listed. - -EXTERNAL_GROUPS = YES - -# The PERL_PATH should be the absolute path and name of the perl script -# interpreter (i.e. the result of `which perl'). - -PERL_PATH = /usr/bin/perl - -#--------------------------------------------------------------------------- -# Configuration options related to the dot tool -#--------------------------------------------------------------------------- - -# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will -# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base -# or super classes. Setting the tag to NO turns the diagrams off. Note that -# this option is superseded by the HAVE_DOT option below. This is only a -# fallback. It is recommended to install and use dot, since it yields more -# powerful graphs. - -CLASS_DIAGRAMS = YES - -# You can define message sequence charts within doxygen comments using the \msc -# command. Doxygen will then run the mscgen tool (see -# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the -# documentation. The MSCGEN_PATH tag allows you to specify the directory where -# the mscgen tool resides. If left empty the tool is assumed to be found in the -# default search path. - -MSCGEN_PATH = - -# If set to YES, the inheritance and collaboration graphs will hide -# inheritance and usage relations if the target is undocumented -# or is not a class. - -HIDE_UNDOC_RELATIONS = YES - -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is -# available from the path. This tool is part of Graphviz, a graph visualization -# toolkit from AT&T and Lucent Bell Labs. The other options in this section -# have no effect if this option is set to NO (the default) - -HAVE_DOT = YES - -# By default doxygen will write a font called FreeSans.ttf to the output -# directory and reference it in all dot files that doxygen generates. This font -# does not include all possible unicode characters however, so when you need -# these (or just want a differently looking font) you can specify the font name -# using DOT_FONTNAME. You need need to make sure dot is able to find the font, -# which can be done by putting it in a standard location or by setting the -# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory -# containing the font. - -DOT_FONTNAME = FreeSans - -# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. -# The default size is 10pt. - -DOT_FONTSIZE = 10 - -# By default doxygen will tell dot to use the output directory to look for the -# FreeSans.ttf font (which doxygen will put there itself). If you specify a -# different font using DOT_FONTNAME you can set the path where dot -# can find it using this tag. - -DOT_FONTPATH = - -# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect inheritance relations. Setting this tag to YES will force the -# the CLASS_DIAGRAMS tag to NO. - -CLASS_GRAPH = YES - -# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect implementation dependencies (inheritance, containment, and -# class references variables) of the class with other documented classes. - -COLLABORATION_GRAPH = YES - -# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for groups, showing the direct groups dependencies - -GROUP_GRAPHS = YES - -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and -# collaboration diagrams in a style similar to the OMG's Unified Modeling -# Language. - -UML_LOOK = NO - -# If set to YES, the inheritance and collaboration graphs will show the -# relations between templates and their instances. - -TEMPLATE_RELATIONS = YES - -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT -# tags are set to YES then doxygen will generate a graph for each documented -# file showing the direct and indirect include dependencies of the file with -# other documented files. - -INCLUDE_GRAPH = YES - -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and -# HAVE_DOT tags are set to YES then doxygen will generate a graph for each -# documented header file showing the documented files that directly or -# indirectly include this file. - -INCLUDED_BY_GRAPH = YES - -# If the CALL_GRAPH and HAVE_DOT options are set to YES then -# doxygen will generate a call dependency graph for every global function -# or class method. Note that enabling this option will significantly increase -# the time of a run. So in most cases it will be better to enable call graphs -# for selected functions only using the \callgraph command. - -CALL_GRAPH = YES - -# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then -# doxygen will generate a caller dependency graph for every global function -# or class method. Note that enabling this option will significantly increase -# the time of a run. So in most cases it will be better to enable caller -# graphs for selected functions only using the \callergraph command. - -CALLER_GRAPH = YES - -# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen -# will graphical hierarchy of all classes instead of a textual one. - -GRAPHICAL_HIERARCHY = YES - -# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES -# then doxygen will show the dependencies a directory has on other directories -# in a graphical way. The dependency relations are determined by the #include -# relations between the files in the directories. - -DIRECTORY_GRAPH = YES - -# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images -# generated by dot. Possible values are png, jpg, or gif -# If left blank png will be used. - -DOT_IMAGE_FORMAT = png - -# The tag DOT_PATH can be used to specify the path where the dot tool can be -# found. If left blank, it is assumed the dot tool can be found in the path. - -DOT_PATH = - -# The DOTFILE_DIRS tag can be used to specify one or more directories that -# contain dot files that are included in the documentation (see the -# \dotfile command). - -DOTFILE_DIRS = - -# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of -# nodes that will be shown in the graph. If the number of nodes in a graph -# becomes larger than this value, doxygen will truncate the graph, which is -# visualized by representing a node as a red box. Note that doxygen if the -# number of direct children of the root node in a graph is already larger than -# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note -# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. - -DOT_GRAPH_MAX_NODES = 50 - -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the -# graphs generated by dot. A depth value of 3 means that only nodes reachable -# from the root by following a path via at most 3 edges will be shown. Nodes -# that lay further from the root node will be omitted. Note that setting this -# option to 1 or 2 may greatly reduce the computation time needed for large -# code bases. Also note that the size of a graph can be further restricted by -# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. - -MAX_DOT_GRAPH_DEPTH = 3 - -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, because dot on Windows does not -# seem to support this out of the box. Warning: Depending on the platform used, -# enabling this option may lead to badly anti-aliased labels on the edges of -# a graph (i.e. they become hard to read). - -DOT_TRANSPARENT = YES - -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output -# files in one run (i.e. multiple -o and -T options on the command line). This -# makes dot run faster, but since only newer versions of dot (>1.8.10) -# support this, this feature is disabled by default. - -DOT_MULTI_TARGETS = YES - -# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will -# generate a legend page explaining the meaning of the various boxes and -# arrows in the dot generated graphs. - -GENERATE_LEGEND = YES - -# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will -# remove the intermediate dot files that are used to generate -# the various graphs. - -DOT_CLEANUP = YES diff --git a/doc/doxygen/OpenFOAMicon.png b/doc/doxygen/OpenFOAMicon.png deleted file mode 100644 index 568b0060908a05c84cc9e9a707e65ddd43949d2b..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1199 zcmV;g1W@~lP)Px#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