diff --git a/.gitignore b/.gitignore
index 24683e8308bcb2d033bd512840a9befe145399e8..7b23bbf95143249fed0ac2b56bc3ab07ec53843b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -22,6 +22,7 @@ tags
CMakeFiles/
*.mexw*.pdb
*.mexw*
+*.mexa*
/Debug
/DebugMatlab
/DebugArmadillo
diff --git a/CHANGELOG b/CHANGELOG
index 2620f3482bdf20c1c1758ecb83905a26ff8a20b3..47e1012c90a00c5be1061bf96f7b78f51cc048af 100644
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -1,3 +1,9 @@
+Version 2.23.0
+===========
+- The aging model is available as an S-Function for Simulink
+- Individual twoports can be added to the observer output by marking them as observable
+- Updates to the documentation
+
Version 2.22.0
===========
- Output filenames for the thermal matlab filter can be set in the XML file
diff --git a/CMakeLists.txt b/CMakeLists.txt
index e9181e96c765908c3112ea45ffff6482e6d4d1cb..cc77ea5352c7dc743963d86670420736c4ee00c6 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -5,9 +5,9 @@ set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake/")
cmake_policy(SET CMP0009 NEW)
set(ISEAFrameVERSION_MAJOR 2)
-set(ISEAFrameVERSION_MINOR 22)
+set(ISEAFrameVERSION_MINOR 23)
set(ISEAFramePATCH_LEVEL 0)
-set(ISEAFrameNAME "Refactor")
+set(ISEAFrameNAME "docs")
set(ARCH_TYPE
"64"
CACHE STRING "")
@@ -187,7 +187,7 @@ function(copy_windows_files_to_dir binary_dir)
endif()
endfunction(copy_windows_files_to_dir)
-# copy files to the binary folder if CREATE_RELEASE_DIRS is set target is the
+# copy files to the binary folder if CREATE_RELEASE_DIRS is set. target is the
# CMake target and must have RUNTIME_OUTPUT_DIRECTORY set
function(add_release_files target files_to_copy)
if(CREATE_RELEASE_DIRS)
diff --git a/README.md b/README.md
index 9ee21b444a7ba5f54ff6452e54503132b574a76f..a1a70aeded2b68f3378588724803ed77a0671157 100644
--- a/README.md
+++ b/README.md
@@ -2,12 +2,12 @@
<pre>
- <img src="misc/images/Logo_V3.jpg" />
+ <img src="misc/images/logo.jpg" />
</pre>
<div align=right>
-<a href="http://www.isea.rwth-aachen.de/"> <img src="misc/images/logo.png" width="500" /> </a>
+<a href="http://www.isea.rwth-aachen.de/"> <img src="misc/images/logo_isea.png" width="500" /> </a>
</div>
About ISEAFrame
@@ -36,7 +36,7 @@ Linux Standalones: [Download](https://git.rwth-aachen.de/isea/framework/-/jobs/a
Windows Standalones: [Download](https://git.rwth-aachen.de/isea/framework/-/jobs/artifacts/master/download?job=windows_standalones)<br/>
Wndows Simulink Converter: [Download](https://git.rwth-aachen.de/isea/framework/-/jobs/artifacts/master/download?job=windows_simulink_converter)<br/>
<br/><br/>
-Documentation: [View online](https://isea.pages.rwth-aachen.de/framework) | [Download](https://git.rwth-aachen.de/isea/framework/-/jobs/artifacts/master/download?job=documentation) | [Download Development Version](https://git.rwth-aachen.de/isea/framework/-/jobs/artifacts/master/download?job=documentation)
+Documentation: [View online](https://isea.pages.rwth-aachen.de/framework) | [Download](https://git.rwth-aachen.de/isea/framework/-/jobs/artifacts/master/download?job=documentation) | [Download Development Version](https://git.rwth-aachen.de/isea/framework/-/jobs/artifacts/master/download?job=development_documentation)
Required Software:
diff --git a/doxygen/Doxyfile.in b/doxygen/Doxyfile.in
index 5ff5a86eaf6f06e1647a317cd98892f4da1e7554..b3d8492ad54e72c45271c001bb4c6b8edca7b1da 100644
--- a/doxygen/Doxyfile.in
+++ b/doxygen/Doxyfile.in
@@ -1,358 +1,415 @@
-# Doxyfile 1.8.2
+# Doxyfile 1.8.13
# This file describes the settings to be used by the documentation system
-# doxygen (www.doxygen.org) for a project
+# doxygen (www.doxygen.org) for a project.
#
-# All text after a hash (#) is considered a comment and will be ignored
+# All text after a double hash (##) is considered a comment and is placed in
+# front of the TAG it is preceding.
+#
+# All text after a single 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 (" ")
+# 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.
+# 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.
+# The default value is: UTF-8.
DOXYFILE_ENCODING = UTF-8
-# The PROJECT_NAME tag is a single word (or sequence of words) that should
-# identify the project. Note that if you do not use Doxywizard you need
-# to put quotes around the project name if it contains spaces.
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
+# double-quotes, unless you are using Doxywizard) that should identify the
+# project for which the documentation is generated. This name is used in the
+# title of most generated pages and in a few other places.
+# The default value is: My Project.
-PROJECT_NAME = "ISEA Framework"
+PROJECT_NAME = "ISEAFrame"
-# 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.
+# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
+# could be handy for archiving the generated documentation or if some version
+# control system is used.
-PROJECT_NUMBER =
+PROJECT_NUMBER = "@ISEAFrameVERSION_MAJOR@.@ISEAFrameVERSION_MINOR@.@ISEAFramePATCH_LEVEL@"
-# Using the PROJECT_BRIEF tag one can provide an optional one line description
-# for a project that appears at the top of each page and should give viewer
-# a quick idea about the purpose of the project. Keep the description short.
+# Using the PROJECT_BRIEF tag one can provide an optional one line description
+# for a project that appears at the top of each page and should give viewer a
+# quick idea about the purpose of the project. Keep the description short.
-PROJECT_BRIEF =
+PROJECT_BRIEF =
-# With the PROJECT_LOGO tag one can specify an logo or icon that is
-# included in the documentation. The maximum height of the logo should not
-# exceed 55 pixels and the maximum width should not exceed 200 pixels.
-# Doxygen will copy the logo to the output directory.
+# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
+# in the documentation. The maximum height of the logo should not exceed 55
+# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
+# the logo to the output directory.
-PROJECT_LOGO =
+PROJECT_LOGO =
-# 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.
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
+# into which the generated documentation will be written. If a relative path is
+# entered, it will be relative to the location where doxygen was started. If
+# left blank the current directory will be used.
-OUTPUT_DIRECTORY =
+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.
+# 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 causes
+# performance problems for the file system.
+# The default value is: NO.
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-Cyrillic, Slovak,
-# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
+# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
+# characters to appear in the names of generated files. If set to NO, non-ASCII
+# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
+# U+3044.
+# The default value is: NO.
+
+ALLOW_UNICODE_NAMES = 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.
+# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
+# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
+# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
+# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
+# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
+# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
+# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
+# Ukrainian and Vietnamese.
+# The default value is: English.
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.
+# If the BRIEF_MEMBER_DESC tag is set to YES, 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.
+# The default value is: YES.
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
+# If the REPEAT_BRIEF tag is set to YES, 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.
+# The default value is: YES.
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"
+# 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 and the.
-ABBREVIATE_BRIEF =
+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
+# 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.
+# The default value is: NO.
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
+# 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.
+# The default value is: NO.
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.
+# If the FULL_PATH_NAMES tag is set to YES, 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
+# The default value is: YES.
FULL_PATH_NAMES = NO
-# 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. Note that you specify absolute paths here, but also
-# relative paths, which will be relative from the directory where doxygen is
-# started.
+# 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.
+#
+# Note that you can specify absolute paths here, but also relative paths, which
+# will be relative from the directory where doxygen is started.
+# This tag requires that the tag FULL_PATH_NAMES is set to YES.
-STRIP_FROM_PATH =
+STRIP_FROM_PATH =
-# 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.
+# 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 list of include paths that are normally passed to the compiler
+# using the -I flag.
-STRIP_FROM_INC_PATH =
+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 if your file system
-# doesn't support long names like on DOS, Mac, or CD-ROM.
+# 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.
+# The default value is: NO.
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.)
+# 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-style will behave just like regular Qt-
+# style comments (thus requiring an explicit @brief command for a brief
+# description.)
+# The default value is: NO.
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.)
+# 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 Qt-style will behave just like regular Qt-style comments (thus
+# requiring an explicit \brief command for a brief description.)
+# The default value is: NO.
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.
+# 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 behavior. 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 behavior instead.
+#
+# Note that setting this tag to YES also means that rational rose comments are
+# not recognized any more.
+# The default value is: NO.
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.
+# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
+# documentation from any documented member that it re-implements.
+# The default value is: YES.
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.
+# 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.
+# The default value is: NO.
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.
+# 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.
+# Minimum value: 1, maximum value: 16, default value: 4.
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.
+# This tag can be used to specify a number of aliases that act 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 =
+ALIASES =
-# This tag can be used to specify a number of word-keyword mappings (TCL only).
-# A mapping has the form "name=value". For example adding
-# "class=itcl::class" will allow you to use the command class in the
-# itcl::class meaning.
+# This tag can be used to specify a number of word-keyword mappings (TCL only).
+# A mapping has the form "name=value". For example adding "class=itcl::class"
+# will allow you to use the command class in the itcl::class meaning.
-TCL_SUBST =
+TCL_SUBST =
-# 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.
+# 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.
+# The default value is: NO.
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.
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
+# Python sources only. Doxygen will then generate output that is more tailored
+# for that language. For instance, namespaces will be presented as packages,
+# qualified scopes will look different, etc.
+# The default value is: NO.
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.
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
+# sources. Doxygen will then generate output that is tailored for Fortran.
+# The default value is: NO.
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.
+# 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.
+# The default value is: NO.
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, CSharp, 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 MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
-# comments according to the Markdown format, which allows for more readable
-# documentation. See http://daringfireball.net/projects/markdown/ for details.
-# The output of markdown processing is further processed by doxygen, so you
-# can mix doxygen, HTML, and XML commands with Markdown formatting.
-# Disable only in case of backward compatibilities issues.
+# 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 (fixed format Fortran:
+# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
+# Fortran. In the later case the parser tries to guess whether the code is fixed
+# or free formatted code, this is the default for Fortran type files), VHDL. 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: For files without extension you can use no_extension as a placeholder.
+#
+# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
+# the files are not read by doxygen.
+
+EXTENSION_MAPPING =
+
+# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
+# according to the Markdown format, which allows for more readable
+# documentation. See http://daringfireball.net/projects/markdown/ for details.
+# The output of markdown processing is further processed by doxygen, so you can
+# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
+# case of backward compatibilities issues.
+# The default value is: YES.
MARKDOWN_SUPPORT = YES
-# When enabled doxygen tries to link words that correspond to documented classes,
-# or namespaces to their corresponding documentation. Such a link can be
-# prevented in individual cases by by putting a % sign in front of the word or
+# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
+# to that level are automatically included in the table of contents, even if
+# they do not have an id attribute.
+# Note: This feature currently applies only to Markdown headings.
+# Minimum value: 0, maximum value: 99, default value: 0.
+# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
+
+TOC_INCLUDE_HEADINGS = 0
+
+# When enabled doxygen tries to link words that correspond to documented
+# classes, or namespaces to their corresponding documentation. Such a link can
+# be prevented in individual cases by putting a % sign in front of the word or
# globally by setting AUTOLINK_SUPPORT to NO.
+# The default value is: YES.
AUTOLINK_SUPPORT = YES
-# 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 makes the inheritance and collaboration
+# 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);
+# versus func(std::string) {}). This also make the inheritance and collaboration
# diagrams that involve STL classes more complete and accurate.
+# The default value is: NO.
BUILTIN_STL_SUPPORT = YES
-# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
+# The default value is: 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.
+# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
+# http://www.riverbankcomputing.co.uk/software/sip/intro) 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.
+# The default value is: NO.
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 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.
+# getter and setter methods for a property. Setting this option to YES 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.
+# The default value is: YES.
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
+# 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.
+# The default value is: NO.
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.
+# If one adds a struct or class to a group and this option is enabled, then also
+# any nested class or struct is added to the same group. By default this option
+# is disabled and one has to add nested compounds explicitly via \ingroup.
+# The default value is: NO.
+
+GROUP_NESTED_COMPOUNDS = NO
+
+# Set the SUBGROUPING tag to YES 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.
+# The default value is: YES.
SUBGROUPING = YES
-# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
-# unions are shown inside the group in which they are included (e.g. using
-# @ingroup) instead of on a separate page (for HTML and Man pages) or
-# section (for LaTeX and RTF).
+# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
+# are shown inside the group in which they are included (e.g. using \ingroup)
+# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
+# and RTF).
+#
+# Note that this feature does not work in combination with
+# SEPARATE_MEMBER_PAGES.
+# The default value is: NO.
INLINE_GROUPED_CLASSES = NO
-# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
-# unions with only public data fields will be shown inline in the documentation
-# of the scope in which they are defined (i.e. file, namespace, or group
-# documentation), provided this scope is documented. If set to NO (the default),
-# structs, classes, and unions are shown on a separate page (for HTML and Man
-# pages) or section (for LaTeX and RTF).
+# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
+# with only public data fields or simple typedef fields will be shown inline in
+# the documentation of the scope in which they are defined (i.e. file,
+# namespace, or group documentation), provided this scope is documented. If set
+# to NO, structs, classes, and unions are shown on a separate page (for HTML and
+# Man pages) or section (for LaTeX and RTF).
+# The default value is: NO.
INLINE_SIMPLE_STRUCTS = NO
-# 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
+# When TYPEDEF_HIDES_STRUCT tag 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.
+# The default value is: NO.
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 penalty.
-# 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 roughly 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
-
-# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
-# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
-# their name and scope. Since this can be an expensive process and often the
-# same symbol appear multiple times in the code, doxygen keeps a cache of
-# pre-resolved symbols. If the cache is too small doxygen will become slower.
-# If the cache is too large, memory is wasted. The cache size is given by this
-# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
-# corresponding to a cache size of 2^16 = 65536 symbols.
+# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
+# cache is used to resolve symbols given their name and scope. Since this can be
+# an expensive process and often the same symbol appears multiple times in the
+# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
+# doxygen will become slower. If the cache is too large, memory is wasted. The
+# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
+# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
+# symbols. At the end of a run doxygen will report the cache usage and suggest
+# the optimal cache size from a speed point of view.
+# Minimum value: 0, maximum value: 9, default value: 0.
LOOKUP_CACHE_SIZE = 0
@@ -360,1173 +417,1640 @@ LOOKUP_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
+# 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 respectively EXTRACT_STATIC tags are set to YES.
+# Note: This will also disable the warnings about undocumented members that are
+# normally produced when WARNINGS is set to YES.
+# The default value is: NO.
EXTRACT_ALL = YES
-# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
-# will be included in the documentation.
+# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
+# be included in the documentation.
+# The default value is: NO.
EXTRACT_PRIVATE = YES
-# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
+# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
# scope will be included in the documentation.
+# The default value is: NO.
EXTRACT_PACKAGE = NO
-# If the EXTRACT_STATIC tag is set to YES all static members of a file
-# will be included in the documentation.
+# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
+# included in the documentation.
+# The default value is: NO.
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.
+# 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. Does not have any effect
+# for Java sources.
+# The default value is: YES.
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.
+# This flag is only useful for Objective-C code. If 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, only methods in the interface are
+# included.
+# The default value is: NO.
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 namespaces 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.
+# The default value is: NO.
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.
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
+# undocumented members inside documented classes or files. If set to NO 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.
+# The default value is: NO.
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.
+# 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, these classes will be included in the various overviews. This option
+# has no effect if EXTRACT_ALL is enabled.
+# The default value is: NO.
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.
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
+# (class|struct|union) declarations. If set to NO, these declarations will be
+# included in the documentation.
+# The default value is: NO.
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.
+# 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, these
+# blocks will be appended to the function's detailed documentation block.
+# The default value is: NO.
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.
+# The INTERNAL_DOCS tag determines if documentation that is typed after a
+# \internal command is included. If the tag is set to NO then the documentation
+# will be excluded. Set it to YES to include the internal documentation.
+# The default value is: NO.
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
+# 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.
+# The default value is: system dependent.
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.
+# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
+# their full class and namespace scopes in the documentation. If set to YES, the
+# scope will be hidden.
+# The default value is: NO.
HIDE_SCOPE_NAMES = NO
-# 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.
+# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
+# append additional text to a page's title, such as Class Reference. If set to
+# YES the compound reference will be hidden.
+# The default value is: NO.
+
+HIDE_COMPOUND_REFERENCE= NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
+# the files that are included by a file in the documentation of that file.
+# The default value is: YES.
SHOW_INCLUDE_FILES = YES
-# 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.
+# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
+# grouped member an include statement to the documentation, telling the reader
+# which file to include in order to use the member.
+# The default value is: NO.
+
+SHOW_GROUPED_MEMB_INC = 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.
+# The default value is: NO.
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.
+# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
+# documentation for inline members.
+# The default value is: YES.
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.
+# If the SORT_MEMBER_DOCS tag is set to YES 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.
+# The default value is: YES.
SORT_MEMBER_DOCS = YES
-# 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.
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
+# descriptions of file, namespace and class members alphabetically by member
+# name. If set to NO, the members will appear in declaration order. Note that
+# this will also influence the order of the classes in the class list.
+# The default value is: 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.
+# 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 constructors will appear in the
+# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
+# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
+# member documentation.
+# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
+# detailed member documentation.
+# The default value is: 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.
+# 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 group names will
+# appear in their defined order.
+# The default value is: NO.
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.
+# 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 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.
+# The default value is: NO.
SORT_BY_SCOPE_NAME = NO
-# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
-# do proper type resolution of all parameters of a function it will reject a
-# match between the prototype and the implementation of a member function even
-# if there is only one candidate or it is obvious which candidate to choose
-# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
-# will still accept a match between prototype and implementation in such cases.
+# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
+# type resolution of all parameters of a function it will reject a match between
+# the prototype and the implementation of a member function even if there is
+# only one candidate or it is obvious which candidate to choose by doing a
+# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
+# accept a match between prototype and implementation in such cases.
+# The default value is: NO.
STRICT_PROTO_MATCHING = 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.
+# 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.
+# The default value is: YES.
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.
+# 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.
+# The default value is: YES.
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.
+# 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.
+# The default value is: YES.
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.
+# 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.
+# The default value is: YES.
GENERATE_DEPRECATEDLIST= YES
-# The ENABLED_SECTIONS tag can be used to enable conditional
-# documentation sections, marked by \if sectionname ... \endif.
+# The ENABLED_SECTIONS tag can be used to enable conditional documentation
+# sections, marked by \if <section_label> ... \endif and \cond <section_label>
+# ... \endcond blocks.
-ENABLED_SECTIONS =
+ENABLED_SECTIONS =
-# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
-# the initial value of a variable or macro 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 macros in the
-# documentation can be controlled using \showinitializer or \hideinitializer
-# command in the documentation regardless of this setting.
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
+# initial value of a variable or macro / define can have 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 value of individual variables and macros / defines can be
+# controlled using \showinitializer or \hideinitializer command in the
+# documentation regardless of this setting.
+# Minimum value: 0, maximum value: 10000, default value: 30.
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
+# 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.
+# The default value is: YES.
SHOW_USED_FILES = 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.
+# 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 value 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.
+# 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 value 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 <command> <input-file>, where <command> is the value of
-# the FILE_VERSION_FILTER tag, and <input-file> 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. To 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.
+# 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 command input-file, where command is the value of the
+# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
+# by doxygen. Whatever the program writes to standard output is used as the file
+# version. For an example see the documentation.
+
+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. To 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.
+#
+# Note that if you run doxygen from a directory containing a file called
+# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
+# tag is left empty.
-LAYOUT_FILE =
+LAYOUT_FILE =
-# The CITE_BIB_FILES tag can be used to specify one or more bib files
-# containing the references data. This must be a list of .bib files. The
-# .bib extension is automatically appended if omitted. Using this command
-# requires the bibtex tool to be installed. See also
-# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
-# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
-# feature you need bibtex and perl available in the search path.
+# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
+# the reference definitions. This must be a list of .bib files. The .bib
+# extension is automatically appended if omitted. This requires the bibtex tool
+# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
+# For LaTeX the style of the bibliography can be controlled using
+# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
+# search path. See also \cite for info how to create references.
-CITE_BIB_FILES =
+CITE_BIB_FILES =
#---------------------------------------------------------------------------
-# configuration options related to warning and progress messages
+# 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.
+# The QUIET tag can be used to turn on/off the messages that are generated to
+# standard output by doxygen. If QUIET is set to YES this implies that the
+# messages are off.
+# The default value is: NO.
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.
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
+# this implies that the warnings are on.
+#
+# Tip: Turn warnings on while writing the documentation.
+# The default value is: YES.
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.
+# If the WARN_IF_UNDOCUMENTED tag 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.
+# The default value is: YES.
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.
+# If the WARN_IF_DOC_ERROR tag 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.
+# The default value is: YES.
WARN_IF_DOC_ERROR = YES
-# The WARN_NO_PARAMDOC option can be enabled 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.
+# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
+# are documented, but have no documentation for their parameters or return
+# value. If set to NO, doxygen will only warn about wrong or incomplete
+# parameter documentation, but not about the absence of documentation.
+# The default value is: NO.
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)
+# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
+# a warning is encountered.
+# The default value is: NO.
+
+WARN_AS_ERROR = 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)
+# The default value is: $file:$line: $text.
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.
+# 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 standard
+# error (stderr).
-WARN_LOGFILE =
+WARN_LOGFILE =
#---------------------------------------------------------------------------
-# configuration options related to the input files
+# 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.
+# The INPUT tag is 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. See also FILE_PATTERNS and EXTENSION_MAPPING
+# Note: If this tag is empty the current directory is searched.
INPUT = "@CMAKE_SOURCE_DIR@/doxygen/" \
"@CMAKE_SOURCE_DIR@/src/" \
- "@CMAKE_SOURCE_DIR@/benchmark/" \
- "@CMAKE_SOURCE_DIR@/standalone/standalone/" \
- "@CMAKE_SOURCE_DIR@/examples/"
+ "@CMAKE_SOURCE_DIR@/benchmark/" \
+ "@CMAKE_SOURCE_DIR@/standalone/standalone/" \
+ "@CMAKE_SOURCE_DIR@/examples/"
-# 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.
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
+# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
+# documentation (see: http://www.gnu.org/software/libiconv) for the list of
+# possible encodings.
+# The default value is: UTF-8.
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++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
-# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
-# *.f90 *.f *.for *.vhd *.vhdl
+# If the value of the INPUT tag contains directories, you can use the
+# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
+# *.h) to filter out the source-files in the directories.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# read by doxygen.
+#
+# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
+# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
+# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
+# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
+# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.
-FILE_PATTERNS =
+FILE_PATTERNS =
-# 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.
+# The RECURSIVE tag can be used to specify whether or not subdirectories should
+# be searched for input files as well.
+# The default value is: NO.
RECURSIVE = YES
-# The EXCLUDE tag can be used to specify files and/or directories that should be
-# 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.
-# Note that relative paths are relative to the directory from which doxygen is
+# The EXCLUDE tag can be used to specify files and/or directories that should be
+# 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.
+#
+# Note that relative paths are relative to the directory from which doxygen is
# run.
EXCLUDE = ../src/expressionparser
-# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
-# directories that are symbolic links (a Unix file system feature) are excluded
+# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
+# directories that are symbolic links (a Unix file system feature) are excluded
# from the input.
+# The default value is: NO.
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/*
+# 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 =
+EXCLUDE_PATTERNS =
-# 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,
+# 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
+#
+# Note that the wildcards are matched against the file with absolute path, so to
+# exclude all test directories use the pattern */test/*
EXCLUDE_SYMBOLS = boost \
std \
exprtk::*
-# 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).
+# 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 = "@CMAKE_SOURCE_DIR@/doxygen/examples/"
-# 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.
+# 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 =
+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.
+# 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.
+# The default value is: NO.
EXAMPLE_RECURSIVE = YES
-# 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).
+# The IMAGE_PATH tag can be used to specify one or more files or directories
+# that contain images that are to be included in the documentation (see the
+# \image command).
IMAGE_PATH = "@CMAKE_SOURCE_DIR@/doxygen/images/"
-# 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 <filter> <input-file>, where <filter>
-# is the value of the INPUT_FILTER tag, and <input-file> 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.
+# 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:
+#
+# <filter> <input-file>
+#
+# where <filter> is the value of the INPUT_FILTER tag, and <input-file> 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.
+#
+# Note that the filter must not add or remove lines; it is applied before the
+# code is scanned, but not when the output code is generated. If lines are added
+# or removed, the anchors will not be placed correctly.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# properly processed by doxygen.
+
+INPUT_FILTER =
+
+# 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 information on how
+# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
+# patterns match the file name, INPUT_FILTER is applied.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# properly processed by doxygen.
-INPUT_FILTER =
+FILTER_PATTERNS =
-# 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 or if
-# non of the patterns match the file name, INPUT_FILTER is applied.
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER) will also be used to filter the input files that are used for
+# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
+# The default value is: NO.
-FILTER_PATTERNS =
+FILTER_SOURCE_FILES = NO
-# 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).
+# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
+# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
+# it is also possible to disable source filtering for a specific pattern using
+# *.ext= (so without naming a filter).
+# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
-FILTER_SOURCE_FILES = NO
+FILTER_SOURCE_PATTERNS =
-# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
-# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
-# and it is also possible to disable source filtering for a specific pattern
-# using *.ext= (so without naming a filter). This option only has effect when
-# FILTER_SOURCE_FILES is enabled.
+# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
+# is part of the input, its contents will be placed on the main page
+# (index.html). This can be useful if you have a project on for instance GitHub
+# and want to reuse the introduction page also for the doxygen output.
-FILTER_SOURCE_PATTERNS =
+USE_MDFILE_AS_MAINPAGE =
#---------------------------------------------------------------------------
-# configuration options related to source browsing
+# 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.
+# 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 that
+# also VERBATIM_HEADERS is set to NO.
+# The default value is: NO.
SOURCE_BROWSER = NO
-# Setting the INLINE_SOURCES tag to YES will include the body
-# of functions and classes directly in the documentation.
+# Setting the INLINE_SOURCES tag to YES will include the body of functions,
+# classes and enums directly into the documentation.
+# The default value is: NO.
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, C++ and Fortran comments will always remain visible.
+# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
+# special comment blocks from generated source code fragments. Normal C, C++ and
+# Fortran comments will always remain visible.
+# The default value is: YES.
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.
+# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
+# function all documented functions referencing it will be listed.
+# The default value is: NO.
REFERENCED_BY_RELATION = NO
-# 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.
+# 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.
+# The default value is: NO.
REFERENCES_RELATION = NO
-# 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.
+# If the REFERENCES_LINK_SOURCE tag is set to YES 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.
+# The default value is: YES.
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.
+# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
+# source code will show a tooltip with additional information such as prototype,
+# brief description and links to the definition and documentation. Since this
+# will make the HTML file larger and loading of large files a bit slower, you
+# can opt to disable this feature.
+# The default value is: YES.
+# This tag requires that the tag SOURCE_BROWSER is set to YES.
+
+SOURCE_TOOLTIPS = 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.
+#
+# To use it do the following:
+# - Install the latest version of global
+# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
+# - Make sure the INPUT points to the root of the source tree
+# - Run doxygen as normal
+#
+# Doxygen will invoke htags (and that will in turn invoke gtags), so these
+# tools must be available from the command line (i.e. in the search path).
+#
+# The result: instead of the source browser generated by doxygen, the links to
+# source code will now point to the output of htags.
+# The default value is: NO.
+# This tag requires that the tag SOURCE_BROWSER is set to YES.
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.
+# If the VERBATIM_HEADERS tag is set the YES 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.
+# See also: Section \class.
+# The default value is: YES.
VERBATIM_HEADERS = YES
+# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
+# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
+# cost of reduced performance. This can be particularly helpful with template
+# rich C++ code for which doxygen's built-in parser lacks the necessary type
+# information.
+# Note: The availability of this option depends on whether or not doxygen was
+# generated with the -Duse-libclang=ON option for CMake.
+# The default value is: NO.
+
+CLANG_ASSISTED_PARSING = NO
+
+# If clang assisted parsing is enabled you can provide the compiler with command
+# line options that you would normally use when invoking the compiler. Note that
+# the include paths will already be set by doxygen for the files and directories
+# specified with INPUT and INCLUDE_PATH.
+# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
+
+CLANG_OPTIONS =
+
#---------------------------------------------------------------------------
-# configuration options related to the alphabetical class index
+# 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.
+# 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.
+# The default value is: YES.
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])
+# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
+# which the alphabetical index list will be split.
+# Minimum value: 1, maximum value: 20, default value: 5.
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
COLS_IN_ALPHA_INDEX = 5
-# 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.
+# 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 a prefix (or a list of prefixes) that should be ignored
+# while generating the index headers.
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
-IGNORE_PREFIX =
+IGNORE_PREFIX =
#---------------------------------------------------------------------------
-# configuration options related to the HTML output
+# Configuration options related to the HTML output
#---------------------------------------------------------------------------
-# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
-# generate HTML output.
+# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
+# The default value is: YES.
GENERATE_HTML = YES
-# 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.
+# 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.
+# The default directory is: html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
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.
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
+# generated HTML page (for example: .htm, .php, .asp).
+# The default value is: .html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
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. Note that when using a custom header you are responsible
-# for the proper inclusion of any scripts and style sheets that doxygen
-# needs, which is dependent on the configuration options used.
-# It is advised to generate a default header using "doxygen -w html
-# header.html footer.html stylesheet.css YourConfigFile" and then modify
-# that header. Note that the header is subject to change so you typically
-# have to redo this when upgrading to a newer version of doxygen or when
-# changing the value of configuration settings such as GENERATE_TREEVIEW!
-
-HTML_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 =
-
-# 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 left blank doxygen will
-# generate a default style sheet. Note that it is recommended to use
-# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
-# tag will in the future become obsolete.
-
-HTML_STYLESHEET =
-
-# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
-# user-defined cascading style sheet that is included after the standard
-# style sheets created by doxygen. Using this option one can overrule
-# certain style aspects. This is preferred over using HTML_STYLESHEET
-# since it does not replace the standard style sheet and is therefor more
-# robust against future updates. Doxygen will copy the style sheet file to
-# the output directory.
-
-HTML_EXTRA_STYLESHEET =
-
-# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
-# other source files which should be copied to the HTML output directory. Note
-# that these files will be copied to the base HTML output directory. Use the
-# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
-# files. In the HTML_STYLESHEET file, use the file name only. Also note that
-# the files will be copied as-is; there are no commands or markers available.
-
-HTML_EXTRA_FILES =
-
-# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
-# Doxygen will adjust the colors in the style sheet and background images
-# according to this color. Hue is specified as an angle on a colorwheel,
-# see http://en.wikipedia.org/wiki/Hue for more information.
-# For instance the value 0 represents red, 60 is yellow, 120 is green,
-# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
-# The allowed range is 0 to 359.
+# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
+# each generated HTML page. If the tag is left blank doxygen will generate a
+# standard header.
+#
+# To get valid HTML the header file that includes any scripts and style sheets
+# that doxygen needs, which is dependent on the configuration options used (e.g.
+# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
+# default header using
+# doxygen -w html new_header.html new_footer.html new_stylesheet.css
+# YourConfigFile
+# and then modify the file new_header.html. See also section "Doxygen usage"
+# for information on how to generate the default header that doxygen normally
+# uses.
+# Note: The header is subject to change so you typically have to regenerate the
+# default header when upgrading to a newer version of doxygen. For a description
+# of the possible markers and block names see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_HEADER =
+
+# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
+# generated HTML page. If the tag is left blank doxygen will generate a standard
+# footer. See HTML_HEADER for more information on how to generate a default
+# footer and what special commands can be used inside the footer. See also
+# section "Doxygen usage" for information on how to generate the default footer
+# that doxygen normally uses.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_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 left blank doxygen will generate a default style sheet.
+# See also section "Doxygen usage" for information on how to generate the style
+# sheet that doxygen normally uses.
+# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
+# it is more robust and this tag (HTML_STYLESHEET) will in the future become
+# obsolete.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_STYLESHEET =
+
+# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
+# cascading style sheets that are included after the standard style sheets
+# created by doxygen. Using this option one can overrule certain style aspects.
+# This is preferred over using HTML_STYLESHEET since it does not replace the
+# standard style sheet and is therefore more robust against future updates.
+# Doxygen will copy the style sheet files to the output directory.
+# Note: The order of the extra style sheet files is of importance (e.g. the last
+# style sheet in the list overrules the setting of the previous ones in the
+# list). For an example see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_EXTRA_STYLESHEET =
+
+# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the HTML output directory. Note
+# that these files will be copied to the base HTML output directory. Use the
+# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
+# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
+# files will be copied as-is; there are no commands or markers available.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_EXTRA_FILES =
+
+# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
+# will adjust the colors in the style sheet and background images according to
+# this color. Hue is specified as an angle on a colorwheel, see
+# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
+# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
+# purple, and 360 is red again.
+# Minimum value: 0, maximum value: 359, default value: 220.
+# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_HUE = 220
-# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
-# the colors in the HTML output. For a value of 0 the output will use
-# grayscales only. A value of 255 will produce the most vivid colors.
+# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
+# in the HTML output. For a value of 0 the output will use grayscales only. A
+# value of 255 will produce the most vivid colors.
+# Minimum value: 0, maximum value: 255, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_SAT = 100
-# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
-# the luminance component of the colors in the HTML output. Values below
-# 100 gradually make the output lighter, whereas values above 100 make
-# the output darker. The value divided by 100 is the actual gamma applied,
-# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
-# and 100 does not change the gamma.
+# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
+# luminance component of the colors in the HTML output. Values below 100
+# gradually make the output lighter, whereas values above 100 make the output
+# darker. The value divided by 100 is the actual gamma applied, so 80 represents
+# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
+# change the gamma.
+# Minimum value: 40, maximum value: 240, default value: 80.
+# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_GAMMA = 80
-# 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.
+# 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 YES can help to show when doxygen was last run and thus if the
+# documentation is up to date.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_TIMESTAMP = 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
+# 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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_DYNAMIC_SECTIONS = NO
-# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
-# entries shown in the various tree structured indices initially; the user
-# can expand and collapse entries dynamically later on. Doxygen will expand
-# the tree to such a level that at most the specified number of entries are
-# visible (unless a fully collapsed tree already exceeds this amount).
-# So setting the number of entries 1 will produce a full collapsed tree by
-# default. 0 is a special value representing an infinite number of entries
-# and will result in a full expanded tree by default.
+# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
+# shown in the various tree structured indices initially; the user can expand
+# and collapse entries dynamically later on. Doxygen will expand the tree to
+# such a level that at most the specified number of entries are visible (unless
+# a fully collapsed tree already exceeds this amount). So setting the number of
+# entries 1 will produce a full collapsed tree by default. 0 is a special value
+# representing an infinite number of entries and will result in a full expanded
+# tree by default.
+# Minimum value: 0, maximum value: 9999, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_INDEX_NUM_ENTRIES = 100
-# 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
+# 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 (see: http://developer.apple.com/tools/xcode/), 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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
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.
+# This tag determines the name of the docset 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.
+# The default value is: Doxygen generated docs.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
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.
+# 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.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_BUNDLE_ID = org.doxygen.Project
-# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
-# identify the documentation publisher. This should be a reverse domain-name
-# style string, e.g. com.mycompany.MyDocSet.documentation.
+# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
+# the documentation publisher. This should be a reverse domain-name style
+# string, e.g. com.mycompany.MyDocSet.documentation.
+# The default value is: org.doxygen.Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
-# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
+# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
+# The default value is: Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_PUBLISHER_NAME = Publisher
-# 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.
+# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
+# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
+# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
+# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
+# Windows.
+#
+# The HTML Help Workshop contains a compiler that can convert all HTML output
+# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
+# files are now used as the Windows 98 help format, and will replace the old
+# Windows help format (.hlp) on all Windows platforms in the future. Compressed
+# HTML files also contain an index, a table of contents, and you can search for
+# words in the documentation. The HTML workshop also contains a viewer for
+# compressed HTML files.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
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
+# 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.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
-CHM_FILE =
+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.
+# 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.
+# The file has to be specified with full path.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
-HHC_LOCATION =
+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).
+# 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).
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
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.
+# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
+# and project file content.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
-CHM_INDEX_ENCODING =
+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.
+# 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. Furthermore it
+# enables the Previous and Next buttons.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
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.
+# The TOC_EXPAND flag can be set to YES to add extra items for group members to
+# the table of contents of the HTML help documentation and to the tree view.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
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.
+# 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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
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.
+# 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.
+# This tag requires that the tag GENERATE_QHP is set to YES.
-QCH_FILE =
+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
+# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
+# Project output. For more information please see Qt Help Project / Namespace
+# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_QHP is set to YES.
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
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
+# Help Project output. For more information please see Qt Help Project / Virtual
+# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
+# folders).
+# The default value is: doc.
+# This tag requires that the tag GENERATE_QHP is set to YES.
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
+# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
+# filter to add. For more information please see Qt Help Project / Custom
+# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
+# filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
-QHP_CUST_FILTER_NAME =
+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
-# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
-# Qt Help Project / Custom Filters</a>.
+# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
+# custom filter to add. For more information please see Qt Help Project / Custom
+# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
+# filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
-QHP_CUST_FILTER_ATTRS =
+QHP_CUST_FILTER_ATTRS =
-# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
-# project's
-# filter section matches.
-# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
-# Qt Help Project / Filter Attributes</a>.
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
+# project's filter section matches. Qt Help Project / Filter Attributes (see:
+# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
+# This tag requires that the tag GENERATE_QHP is set to YES.
-QHP_SECT_FILTER_ATTRS =
+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.
+# 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.
+# This tag requires that the tag GENERATE_QHP is set to YES.
-QHG_LOCATION =
+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.
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
+# generated, together with the HTML files, they 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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
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.
+# 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. Each documentation set should have its own identifier.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
ECLIPSE_DOC_ID = org.doxygen.Project
-# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
-# at top of each HTML page. The value NO (the default) enables the index and
-# the value YES disables it. Since the tabs have the same information as the
-# navigation tree you can set this option to NO if you already set
-# GENERATE_TREEVIEW to YES.
+# If you want full control over the layout of the generated HTML pages it might
+# be necessary to disable the index and replace it with your own. The
+# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
+# of each HTML page. A value of NO enables the index and the value YES disables
+# it. Since the tabs in the index contain the same information as the navigation
+# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
DISABLE_INDEX = NO
-# 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.
-# Since the tree basically has the same information as the tab index you
-# could consider to set DISABLE_INDEX to NO when enabling this option.
+# 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. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
+# further fine-tune the look of the index. As an example, the default style
+# sheet generated by doxygen has an example that shows how to put an image at
+# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
+# the same information as the tab index, you could consider setting
+# DISABLE_INDEX to YES when enabling this option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_TREEVIEW = NO
-# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
-# (range [0,1..20]) that doxygen will group on one line in the generated HTML
-# documentation. Note that a value of 0 will completely suppress the enum
-# values from appearing in the overview section.
+# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
+# doxygen will group on one line in the generated HTML documentation.
+#
+# Note that a value of 0 will completely suppress the enum values from appearing
+# in the overview section.
+# Minimum value: 0, maximum value: 20, default value: 4.
+# This tag requires that the tag GENERATE_HTML is set to YES.
ENUM_VALUES_PER_LINE = 4
-# 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.
+# 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.
+# Minimum value: 0, maximum value: 1500, default value: 250.
+# This tag requires that the tag GENERATE_HTML is set to YES.
TREEVIEW_WIDTH = 250
-# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
-# links to external symbols imported via tag files in a separate window.
+# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
+# external symbols imported via tag files in a separate window.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
EXT_LINKS_IN_WINDOW = NO
-# 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.
+# Use this tag to change the font size of LaTeX formulas included as images in
+# the HTML documentation. 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.
+# Minimum value: 8, maximum value: 50, default value: 10.
+# This tag requires that the tag GENERATE_HTML is set to YES.
FORMULA_FONTSIZE = 12
-# Use the FORMULA_TRANPARENT tag to determine whether or not the images
-# generated for formulas are transparent PNGs. Transparent PNGs are
-# not supported properly for IE 6.0, but are supported on all modern browsers.
-# Note that when changing this option you need to delete any form_*.png files
-# in the HTML output before the changes have effect.
+# Use the FORMULA_TRANPARENT tag to determine whether or not the images
+# generated for formulas are transparent PNGs. Transparent PNGs are not
+# supported properly for IE 6.0, but are supported on all modern browsers.
+#
+# Note that when changing this option you need to delete any form_*.png files in
+# the HTML output directory before the changes have effect.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
FORMULA_TRANSPARENT = YES
-# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
-# (see http://www.mathjax.org) which uses client side Javascript for the
-# rendering instead of using prerendered bitmaps. Use this if you do not
-# have LaTeX installed or if you want to formulas look prettier in the HTML
-# output. When enabled you may also need to install MathJax separately and
-# configure the path to it using the MATHJAX_RELPATH option.
+# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
+# http://www.mathjax.org) which uses client side Javascript for the rendering
+# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
+# installed or if you want to formulas look prettier in the HTML output. When
+# enabled you may also need to install MathJax separately and configure the path
+# to it using the MATHJAX_RELPATH option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
USE_MATHJAX = NO
-# When MathJax is enabled you need to specify the location relative to the
-# HTML output directory using the MATHJAX_RELPATH option. The destination
-# directory should contain the MathJax.js script. For instance, if the mathjax
-# directory is located at the same level as the HTML output directory, then
-# MATHJAX_RELPATH should be ../mathjax. The default value points to
-# the MathJax Content Delivery Network so you can quickly see the result without
-# installing MathJax. However, it is strongly recommended to install a local
-# copy of MathJax from http://www.mathjax.org before deployment.
+# When MathJax is enabled you can set the default output format to be used for
+# the MathJax output. See the MathJax site (see:
+# http://docs.mathjax.org/en/latest/output.html) for more details.
+# Possible values are: HTML-CSS (which is slower, but has the best
+# compatibility), NativeMML (i.e. MathML) and SVG.
+# The default value is: HTML-CSS.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_FORMAT = HTML-CSS
+
+# When MathJax is enabled you need to specify the location relative to the HTML
+# output directory using the MATHJAX_RELPATH option. The destination directory
+# should contain the MathJax.js script. For instance, if the mathjax directory
+# is located at the same level as the HTML output directory, then
+# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
+# Content Delivery Network so you can quickly see the result without installing
+# MathJax. However, it is strongly recommended to install a local copy of
+# MathJax from http://www.mathjax.org before deployment.
+# The default value is: http://cdn.mathjax.org/mathjax/latest.
+# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_RELPATH = http://www.mathjax.org/mathjax
-# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
-# names that should be enabled during MathJax rendering.
-
-MATHJAX_EXTENSIONS =
-
-# 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.
+# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
+# extension names that should be enabled during MathJax rendering. For example
+# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_EXTENSIONS =
+
+# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
+# of code that will be used on startup of the MathJax code. See the MathJax site
+# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
+# example see the documentation.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_CODEFILE =
+
+# 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. It is possible to
+# search using the keyboard; to jump to the search box use <access key> + S
+# (what the <access key> is depends on the OS and browser, but it is typically
+# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
+# key> to jump into the search results window, the results can be navigated
+# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
+# the search. The filter options can be selected when the cursor is inside the
+# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
+# to select a filter and <Enter> or <escape> to activate or cancel the filter
+# option.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
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 disadvantages are that it is more difficult to setup
-# and does not have live searching capabilities.
+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
+# implemented using a web server instead of a web client using Javascript. There
+# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
+# setting. When disabled, doxygen will generate a PHP script for searching and
+# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
+# and searching needs to be provided by external tools. See the section
+# "External Indexing and Searching" for details.
+# The default value is: NO.
+# This tag requires that the tag SEARCHENGINE is set to YES.
SERVER_BASED_SEARCH = NO
+# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
+# script for searching. Instead the search results are written to an XML file
+# which needs to be processed by an external indexer. Doxygen will invoke an
+# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
+# search results.
+#
+# Doxygen ships with an example indexer (doxyindexer) and search engine
+# (doxysearch.cgi) which are based on the open source search engine library
+# Xapian (see: http://xapian.org/).
+#
+# See the section "External Indexing and Searching" for details.
+# The default value is: NO.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTERNAL_SEARCH = NO
+
+# The SEARCHENGINE_URL should point to a search engine hosted by a web server
+# which will return the search results when EXTERNAL_SEARCH is enabled.
+#
+# Doxygen ships with an example indexer (doxyindexer) and search engine
+# (doxysearch.cgi) which are based on the open source search engine library
+# Xapian (see: http://xapian.org/). See the section "External Indexing and
+# Searching" for details.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SEARCHENGINE_URL =
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
+# search data is written to a file for indexing by an external tool. With the
+# SEARCHDATA_FILE tag the name of this file can be specified.
+# The default file is: searchdata.xml.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SEARCHDATA_FILE = searchdata.xml
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
+# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
+# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
+# projects and redirect the results back to the right project.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTERNAL_SEARCH_ID =
+
+# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
+# projects other than the one defined by this configuration file, but that are
+# all added to the same external search index. Each project needs to have a
+# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
+# to a relative location where the documentation can be found. The format is:
+# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTRA_SEARCH_MAPPINGS =
+
#---------------------------------------------------------------------------
-# configuration options related to the LaTeX output
+# Configuration options related to the LaTeX output
#---------------------------------------------------------------------------
-# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
-# generate Latex output.
+# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
+# The default value is: YES.
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.
+# 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.
+# The default directory is: latex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
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.
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked.
+#
+# 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.
+# The default file is: latex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
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.
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
+# index for LaTeX.
+# The default file is: makeindex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
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.
+# 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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
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, letter, legal and
-# executive. If left blank a4wide will be used.
+# The PAPER_TYPE tag can be used to set the paper type that is used by the
+# printer.
+# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
+# 14 inches) and executive (7.25 x 10.5 inches).
+# The default value is: a4.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
PAPER_TYPE = a4
-# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
-# packages that should be included in the LaTeX output.
+# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
+# that should be included in the LaTeX output. The package can be specified just
+# by its name or with the correct syntax as to be used with the LaTeX
+# \usepackage command. To get the times font for instance you can specify :
+# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
+# To use the option intlimits with the amsmath package you can specify:
+# EXTRA_PACKAGES=[intlimits]{amsmath}
+# If left blank no extra packages will be included.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+EXTRA_PACKAGES =
+
+# 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. See
+# section "Doxygen usage" for information on how to let doxygen write the
+# default header to a separate file.
+#
+# Note: Only use a user-defined header if you know what you are doing! The
+# following commands have a special meaning inside the header: $title,
+# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
+# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
+# string, for the replacement values of the other commands the user is referred
+# to HTML_HEADER.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_HEADER =
+
+# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
+# generated LaTeX document. The footer should contain everything after the last
+# chapter. If it is left blank doxygen will generate a standard footer. See
+# LATEX_HEADER for more information on how to generate a default footer and what
+# special commands can be used inside the footer.
+#
+# Note: Only use a user-defined footer if you know what you are doing!
+# This tag requires that the tag GENERATE_LATEX is set to YES.
-EXTRA_PACKAGES =
+LATEX_FOOTER =
-# 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!
+# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
+# LaTeX style sheets that are included after the standard style sheets created
+# by doxygen. Using this option one can overrule certain style aspects. Doxygen
+# will copy the style sheet files to the output directory.
+# Note: The order of the extra style sheet files is of importance (e.g. the last
+# style sheet in the list overrules the setting of the previous ones in the
+# list).
+# This tag requires that the tag GENERATE_LATEX is set to YES.
-LATEX_HEADER =
+LATEX_EXTRA_STYLESHEET =
-# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
-# the generated latex document. The footer should contain everything after
-# the last chapter. If it is left blank doxygen will generate a
-# standard footer. Notice: only use this tag if you know what you are doing!
+# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the LATEX_OUTPUT output
+# directory. Note that the files will be copied as-is; there are no commands or
+# markers available.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
-LATEX_FOOTER =
+LATEX_EXTRA_FILES =
-# 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.
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
+# prepared for conversion to PDF (using ps2pdf or pdflatex). 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.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
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
+# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
+# the PDF file directly from the LaTeX files. Set this option to YES, to get a
# higher quality PDF documentation.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
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.
+# 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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
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.
+# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
+# index chapters (such as File Index, Compound Index, etc.) in the output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
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.
+# If the LATEX_SOURCE_CODE tag 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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_SOURCE_CODE = NO
-# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
-# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
-# http://en.wikipedia.org/wiki/BibTeX for more info.
+# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
+# bibliography, e.g. plainnat, or ieeetr. See
+# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
+# The default value is: plain.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_BIB_STYLE = plain
+# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
+# 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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_TIMESTAMP = NO
+
#---------------------------------------------------------------------------
-# configuration options related to the RTF output
+# 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.
+# 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 too pretty with other RTF
+# readers/editors.
+# The default value is: NO.
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.
+# 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.
+# The default directory is: rtf.
+# This tag requires that the tag GENERATE_RTF is set to YES.
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.
+# 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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
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.
+# 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 some other Word compatible readers that support those
+# fields.
+#
+# Note: WordPad (write) and others do not support links.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_HYPERLINKS = NO
-# Load style sheet 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.
+# 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.
+#
+# See also section "Doxygen usage" for information on how to generate the
+# default style sheet that doxygen normally uses.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_STYLESHEET_FILE =
-RTF_STYLESHEET_FILE =
+# Set optional variables used in the generation of an RTF document. Syntax is
+# similar to doxygen's config file. A template extensions file can be generated
+# using doxygen -e rtf extensionFile.
+# This tag requires that the tag GENERATE_RTF is set to YES.
-# Set optional variables used in the generation of an rtf document.
-# Syntax is similar to doxygen's config file.
+RTF_EXTENSIONS_FILE =
-RTF_EXTENSIONS_FILE =
+# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
+# with syntax highlighting in the RTF output.
+#
+# Note that which sources are shown also depends on other settings such as
+# SOURCE_BROWSER.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_SOURCE_CODE = NO
#---------------------------------------------------------------------------
-# configuration options related to the man page output
+# Configuration options related to the man page output
#---------------------------------------------------------------------------
-# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
-# generate man pages
+# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
+# classes and files.
+# The default value is: NO.
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.
+# 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. A directory man3 will be created inside the directory specified by
+# MAN_OUTPUT.
+# The default directory is: man.
+# This tag requires that the tag GENERATE_MAN is set to YES.
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)
+# The MAN_EXTENSION tag determines the extension that is added to the generated
+# man pages. In case the manual section does not start with a number, the number
+# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
+# optional.
+# The default value is: .3.
+# This tag requires that the tag GENERATE_MAN is set to YES.
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.
+# The MAN_SUBDIR tag determines the name of the directory created within
+# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
+# MAN_EXTENSION with the initial . removed.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_SUBDIR =
+
+# 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 value is: NO.
+# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_LINKS = NO
#---------------------------------------------------------------------------
-# configuration options related to the XML output
+# 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.
+# 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.
+# The default value is: NO.
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.
+# 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.
+# The default directory is: xml.
+# This tag requires that the tag GENERATE_XML is set to YES.
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.
+# 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.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_PROGRAMLISTING = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to the DOCBOOK output
+#---------------------------------------------------------------------------
-XML_SCHEMA =
+# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
+# that can be used to generate PDF.
+# The default value is: NO.
-# 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.
+GENERATE_DOCBOOK = NO
-XML_DTD =
+# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
+# front of it.
+# The default directory is: docbook.
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
-# 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.
+DOCBOOK_OUTPUT = docbook
-XML_PROGRAMLISTING = YES
+# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
+# program listings (including syntax highlighting and cross-referencing
+# information) to the DOCBOOK output. Note that enabling this will significantly
+# increase the size of the DOCBOOK output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
+
+DOCBOOK_PROGRAMLISTING = NO
#---------------------------------------------------------------------------
-# configuration options for the AutoGen Definitions output
+# 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.
+# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
+# AutoGen Definitions (see http://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.
+# The default value is: NO.
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
-# configuration options related to the Perl module output
+# 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.
+# 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.
+# The default value is: NO.
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.
+# 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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
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.
+# 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.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
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.
+# 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.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
-PERLMOD_MAKEVAR_PREFIX =
+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.
+# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
+# C-preprocessor directives found in the sources and include files.
+# The default value is: YES.
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.
+# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
+# in the source code. If set to NO, only conditional compilation will be
+# performed. Macro expansion can be done in a controlled way by setting
+# EXPAND_ONLY_PREDEF to YES.
+# The default value is: NO.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
MACRO_EXPANSION = NO
-# 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.
+# 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.
+# The default value is: NO.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_ONLY_PREDEF = NO
-# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
-# pointed to by INCLUDE_PATH will be searched when a #include is found.
+# If the SEARCH_INCLUDES tag is set to YES, the include files in the
+# INCLUDE_PATH will be searched if a #include is found.
+# The default value is: YES.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
SEARCH_INCLUDES = YES
-# 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.
+# 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.
+# This tag requires that the tag SEARCH_INCLUDES is set to YES.
-INCLUDE_PATH =
+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.
+# 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.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
-INCLUDE_FILE_PATTERNS =
+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.
+# 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 e.g.
+# 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.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
PREDEFINED = BOOST_MPI \
BOOST_THREAD \
@@ -1534,57 +2058,74 @@ PREDEFINED = BOOST_MPI \
__EXCEPTIONS__ \
BUILD_AGING_SIMULATION
-# 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 that
-# overrules the definition found in the source code.
+# 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 that overrules the
+# definition found in the source code.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
-EXPAND_AS_DEFINED =
+EXPAND_AS_DEFINED =
-# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
-# doxygen's preprocessor will remove all references to function-like macros
-# that are alone on a line, have an all uppercase name, and do not end with a
-# semicolon, because these will confuse the parser if not removed.
+# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
+# remove all references to 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.
+# The default value is: YES.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
-# Configuration::additions related to external references
+# Configuration options related to external references
#---------------------------------------------------------------------------
-# The TAGFILES option can be used to specify one or more tagfiles. For each
-# tag file the location of the external documentation should be added. 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. 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.
+# The TAGFILES tag can be used to specify one or more tag files. For each tag
+# file the location of the external documentation should be added. 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. See the
+# section "Linking to external documentation" for more information about the use
+# of tag files.
+# Note: 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 =
+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.
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
+# tag file that is based on the input files it reads. See section "Linking to
+# external documentation" for more information about the usage of tag files.
-GENERATE_TAGFILE =
+GENERATE_TAGFILE =
-# 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.
+# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
+# the class index. If set to NO, only the inherited external classes will be
+# listed.
+# The default value is: NO.
ALLEXTERNALS = NO
-# 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.
+# 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.
+# The default value is: YES.
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').
+# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
+# the related pages index. If set to NO, only the current project's pages will
+# be listed.
+# The default value is: YES.
+
+EXTERNAL_PAGES = YES
+
+# The PERL_PATH should be the absolute path and name of the perl script
+# interpreter (i.e. the result of 'which perl').
+# The default file (with absolute path) is: /usr/bin/perl.
PERL_PATH = /usr/bin/perl
@@ -1592,222 +2133,319 @@ 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 also works with HAVE_DOT disabled, but it is recommended to
-# install and use dot, since it yields more powerful graphs.
+# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
+# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
+# NO turns the diagrams off. Note that this option also works with HAVE_DOT
+# disabled, but it is recommended to install and use dot, since it yields more
+# powerful graphs.
+# The default value is: YES.
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
+# 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 =
+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.
+# You can include diagrams made with dia in doxygen documentation. Doxygen will
+# then run dia to produce the diagram and insert it in the documentation. The
+# DIA_PATH tag allows you to specify the directory where the dia binary resides.
+# If left empty dia is assumed to be found in the default search path.
+
+DIA_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.
+# The default value is: YES.
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)
+# 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 (see:
+# http://www.graphviz.org/), 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 value is: YES.
HAVE_DOT = YES
-# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
-# allowed to run in parallel. When set to 0 (the default) doxygen will
-# base this on the number of processors available in the system. You can set it
-# explicitly to a value larger than 0 to get control over the balance
-# between CPU load and processing speed.
+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
+# to run in parallel. When set to 0 doxygen will base this on the number of
+# processors available in the system. You can set it explicitly to a value
+# larger than 0 to get control over the balance between CPU load and processing
+# speed.
+# Minimum value: 0, maximum value: 32, default value: 0.
+# This tag requires that the tag HAVE_DOT is set to YES.
DOT_NUM_THREADS = 0
-# By default doxygen will use the Helvetica font for all dot files that
-# doxygen generates. When you want a differently looking font you can specify
-# the font name using DOT_FONTNAME. You 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.
+# When you want a differently looking font in the dot files that doxygen
+# generates you can specify the font name using DOT_FONTNAME. You 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.
+# The default value is: Helvetica.
+# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTNAME = Helvetica
-# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
-# The default size is 10pt.
+# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
+# dot graphs.
+# Minimum value: 4, maximum value: 24, default value: 10.
+# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTSIZE = 10
-# By default doxygen will tell dot to use the Helvetica font.
-# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
-# set the path where dot can find it.
+# By default doxygen will tell dot to use the default font as specified with
+# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
+# the path where dot can find it using this tag.
+# This tag requires that the tag HAVE_DOT is set to YES.
-DOT_FONTPATH =
+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
-# CLASS_DIAGRAMS tag to NO.
+# If the CLASS_GRAPH tag is 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 CLASS_DIAGRAMS tag to NO.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
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.
+# If the COLLABORATION_GRAPH tag is 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.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
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
+# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
+# groups, showing the direct groups dependencies.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
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
+# 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.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
UML_LOOK = YES
-# If the UML_LOOK tag is enabled, the fields and methods are shown inside
-# the class node. If there are many fields or methods and many nodes the
-# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
-# threshold limits the number of items for each type to make the size more
-# managable. Set this to 0 for no limit. Note that the threshold may be
-# exceeded by 50% before the limit is enforced.
+# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
+# class node. If there are many fields or methods and many nodes the graph may
+# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
+# number of items for each type to make the size more manageable. Set this to 0
+# for no limit. Note that the threshold may be exceeded by 50% before the limit
+# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
+# but if the number exceeds 15, the total amount of fields shown is limited to
+# 10.
+# Minimum value: 0, maximum value: 100, default value: 10.
+# This tag requires that the tag HAVE_DOT is set to YES.
UML_LIMIT_NUM_FIELDS = 10
-# If set to YES, the inheritance and collaboration graphs will show the
-# relations between templates and their instances.
+# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
+# collaboration graphs will show the relations between templates and their
+# instances.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
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.
+# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES 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.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
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.
+# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES 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.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
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.
+# If the CALL_GRAPH tag is 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. Disabling a call graph can be
+# accomplished by means of the command \hidecallgraph.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
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.
+# If the CALLER_GRAPH tag is 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. Disabling a caller graph can be
+# accomplished by means of the command \hidecallergraph.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
CALLER_GRAPH = YES
-# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
-# will generate a graphical hierarchy of all classes instead of a textual one.
+# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
+# hierarchy of all classes instead of a textual one.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
GRAPHICAL_HIERARCHY = YES
-# If the DIRECTORY_GRAPH 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.
+# If the DIRECTORY_GRAPH tag is 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.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
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 svg, png, jpg, or gif.
-# If left blank png will be used. If you choose svg you need to set
-# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
-# visible in IE 9+ (other browsers do not have this requirement).
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+# generated by dot. For an explanation of the image formats see the section
+# output formats in the documentation of the dot tool (Graphviz (see:
+# http://www.graphviz.org/)).
+# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
+# to make the SVG files visible in IE 9+ (other browsers do not have this
+# requirement).
+# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
+# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
+# gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
+# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
+# png:gdiplus:gdiplus.
+# The default value is: png.
+# This tag requires that the tag HAVE_DOT is set to YES.
DOT_IMAGE_FORMAT = png
-# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
-# enable generation of interactive SVG images that allow zooming and panning.
-# Note that this requires a modern browser other than Internet Explorer.
-# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
-# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
-# visible. Older versions of IE do not have SVG support.
+# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
+# enable generation of interactive SVG images that allow zooming and panning.
+#
+# Note that this requires a modern browser other than Internet Explorer. Tested
+# and working are Firefox, Chrome, Safari, and Opera.
+# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
+# the SVG files visible. Older versions of IE do not have SVG support.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
INTERACTIVE_SVG = NO
-# The tag DOT_PATH can be used to specify the path where the dot tool can be
+# The DOT_PATH tag 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.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+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).
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOTFILE_DIRS =
-DOT_PATH =
+# The MSCFILE_DIRS tag can be used to specify one or more directories that
+# contain msc files that are included in the documentation (see the \mscfile
+# command).
-# 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).
+MSCFILE_DIRS =
-DOTFILE_DIRS =
+# The DIAFILE_DIRS tag can be used to specify one or more directories that
+# contain dia files that are included in the documentation (see the \diafile
+# command).
-# The MSCFILE_DIRS tag can be used to specify one or more directories that
-# contain msc files that are included in the documentation (see the
-# \mscfile command).
+DIAFILE_DIRS =
-MSCFILE_DIRS =
+# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
+# path where java can find the plantuml.jar file. If left blank, it is assumed
+# PlantUML is not used or called during a preprocessing step. Doxygen will
+# generate a warning when it encounters a \startuml command in this case and
+# will not generate output for the diagram.
-# 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.
+PLANTUML_JAR_PATH =
+
+# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
+# configuration file for plantuml.
+
+PLANTUML_CFG_FILE =
+
+# When using plantuml, the specified paths are searched for files specified by
+# the !include statement in a plantuml block.
+
+PLANTUML_INCLUDE_PATH =
+
+# 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.
+# Minimum value: 0, maximum value: 10000, default value: 50.
+# This tag requires that the tag HAVE_DOT is set to YES.
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
+# 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.
+# Minimum value: 0, maximum value: 1000, default value: 0.
+# This tag requires that the tag HAVE_DOT is set to YES.
MAX_DOT_GRAPH_DEPTH = 0
-# 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).
+# 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).
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
DOT_TRANSPARENT = NO
-# 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.
+# Set the DOT_MULTI_TARGETS tag to YES to 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.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
DOT_MULTI_TARGETS = NO
-# 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.
+# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
+# explaining the meaning of the various boxes and arrows in the dot generated
+# graphs.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
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.
+# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
+# files that are used to generate the various graphs.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
DOT_CLEANUP = YES
diff --git a/doxygen/Doxyfile_release.in b/doxygen/Doxyfile_release.in
index 3dcec6bafc96fd8dd4961a1a1a0730f91c5fa549..41e1c9ddcbb3950dbbb638aa3c333fd52e64af4b 100644
--- a/doxygen/Doxyfile_release.in
+++ b/doxygen/Doxyfile_release.in
@@ -1,107 +1,129 @@
-# Doxyfile 1.7.3
+# Doxyfile 1.8.13
# 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.
+# All text after a double hash (##) is considered a comment and is placed in
+# front of the TAG it is preceding.
+#
+# All text after a single 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 (" ").
+# 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.
+# 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.
+# The default value is: UTF-8.
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.
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
+# double-quotes, unless you are using Doxywizard) that should identify the
+# project for which the documentation is generated. This name is used in the
+# title of most generated pages and in a few other places.
+# The default value is: My Project.
-PROJECT_NAME = "ISEA Framework"
+PROJECT_NAME = "ISEAFrame"
-# 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.
+# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
+# could be handy for archiving the generated documentation or if some version
+# control system is used.
-PROJECT_NUMBER =
+PROJECT_NUMBER = "@ISEAFrameVERSION_MAJOR@.@ISEAFrameVERSION_MINOR@.@ISEAFramePATCH_LEVEL@"
-# Using the PROJECT_BRIEF tag one can provide an optional one line description for a project that appears at the top of each page and should give viewer a quick idea about the purpose of the project. Keep the description short.
+# Using the PROJECT_BRIEF tag one can provide an optional one line description
+# for a project that appears at the top of each page and should give viewer a
+# quick idea about the purpose of the project. Keep the description short.
PROJECT_BRIEF =
-# With the PROJECT_LOGO tag one can specify an logo or icon that is
-# included in the documentation. The maximum height of the logo should not
-# exceed 55 pixels and the maximum width should not exceed 200 pixels.
-# Doxygen will copy the logo to the output directory.
+# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
+# in the documentation. The maximum height of the logo should not exceed 55
+# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
+# the logo to the output directory.
PROJECT_LOGO =
-# 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.
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
+# into which the generated documentation will be written. If a relative path is
+# 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.
+# 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 causes
+# performance problems for the file system.
+# The default value is: NO.
CREATE_SUBDIRS = NO
+# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
+# characters to appear in the names of generated files. If set to NO, non-ASCII
+# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
+# U+3044.
+# The default value is: NO.
+
+ALLOW_UNICODE_NAMES = 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-Cyrillic, Slovak,
-# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
+# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
+# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
+# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
+# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
+# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
+# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
+# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
+# Ukrainian and Vietnamese.
+# The default value is: English.
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.
+# If the BRIEF_MEMBER_DESC tag is set to YES, 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.
+# The default value is: YES.
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
+# If the REPEAT_BRIEF tag is set to YES, 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.
+# The default value is: YES.
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"
+# 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 and 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
+# doxygen will generate a detailed section even if there is only a brief
# description.
+# The default value is: NO.
ALWAYS_DETAILED_SEC = NO
@@ -109,538 +131,710 @@ ALWAYS_DETAILED_SEC = NO
# 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.
+# The default value is: NO.
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.
+# If the FULL_PATH_NAMES tag is set to YES, 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
+# The default value is: YES.
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.
+# 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.
+#
+# Note that you can specify absolute paths here, but also relative paths, which
+# will be relative from the directory where doxygen is started.
+# This tag requires that the tag FULL_PATH_NAMES is set to YES.
STRIP_FROM_PATH =
-# 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.
+# 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 list of 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 if your file system
-# doesn't support long names like on DOS, Mac, or CD-ROM.
+# 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.
+# The default value is: NO.
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.)
+# 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-style will behave just like regular Qt-
+# style comments (thus requiring an explicit @brief command for a brief
+# description.)
+# The default value is: NO.
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.)
+# 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 Qt-style will behave just like regular Qt-style comments (thus
+# requiring an explicit \brief command for a brief description.)
+# The default value is: NO.
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.
+# 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 behavior. 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 behavior instead.
+#
+# Note that setting this tag to YES also means that rational rose comments are
+# not recognized any more.
+# The default value is: NO.
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.
+# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
+# documentation from any documented member that it re-implements.
+# The default value is: YES.
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.
+# 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.
+# The default value is: NO.
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.
+# 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.
+# Minimum value: 1, maximum value: 16, default value: 4.
TAB_SIZE = 8
-# 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.
+# This tag can be used to specify a number of aliases that act 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.
+# This tag can be used to specify a number of word-keyword mappings (TCL only).
+# A mapping has the form "name=value". For example adding "class=itcl::class"
+# will allow you to use the command class in the itcl::class meaning.
+
+TCL_SUBST =
+
+# 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.
+# The default value is: NO.
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.
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
+# Python sources only. Doxygen will then generate output that is more tailored
+# for that language. For instance, namespaces will be presented as packages,
+# qualified scopes will look different, etc.
+# The default value is: NO.
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.
+# sources. Doxygen will then generate output that is tailored for Fortran.
+# The default value is: NO.
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.
+# sources. Doxygen will then generate output that is tailored for VHDL.
+# The default value is: NO.
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, CSharp, 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.
+# 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 (fixed format Fortran:
+# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
+# Fortran. In the later case the parser tries to guess whether the code is fixed
+# or free formatted code, this is the default for Fortran type files), VHDL. 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: For files without extension you can use no_extension as a placeholder.
+#
+# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
+# the files are not read by doxygen.
EXTENSION_MAPPING =
+# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
+# according to the Markdown format, which allows for more readable
+# documentation. See http://daringfireball.net/projects/markdown/ for details.
+# The output of markdown processing is further processed by doxygen, so you can
+# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
+# case of backward compatibilities issues.
+# The default value is: YES.
+
+MARKDOWN_SUPPORT = YES
+
+# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
+# to that level are automatically included in the table of contents, even if
+# they do not have an id attribute.
+# Note: This feature currently applies only to Markdown headings.
+# Minimum value: 0, maximum value: 99, default value: 0.
+# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
+
+TOC_INCLUDE_HEADINGS = 0
+
+# When enabled doxygen tries to link words that correspond to documented
+# classes, or namespaces to their corresponding documentation. Such a link can
+# be prevented in individual cases by putting a % sign in front of the word or
+# globally by setting AUTOLINK_SUPPORT to NO.
+# The default value is: YES.
+
+AUTOLINK_SUPPORT = YES
+
# 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 makes the inheritance and collaboration
+# 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);
+# versus func(std::string) {}). This also make the inheritance and collaboration
# diagrams that involve STL classes more complete and accurate.
+# The default value is: NO.
BUILTIN_STL_SUPPORT = NO
# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
+# The default value is: 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.
+# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
+# http://www.riverbankcomputing.co.uk/software/sip/intro) 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.
+# The default value is: NO.
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 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.
+# For Microsoft's IDL there are propget and propput attributes to indicate
+# getter and setter methods for a property. Setting this option to YES 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.
+# The default value is: YES.
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
+# 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.
+# The default value is: NO.
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.
+# If one adds a struct or class to a group and this option is enabled, then also
+# any nested class or struct is added to the same group. By default this option
+# is disabled and one has to add nested compounds explicitly via \ingroup.
+# The default value is: NO.
+
+GROUP_NESTED_COMPOUNDS = NO
+
+# Set the SUBGROUPING tag to YES 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.
+# The default value is: YES.
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
+# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
+# are shown inside the group in which they are included (e.g. using \ingroup)
+# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
+# and RTF).
+#
+# Note that this feature does not work in combination with
+# SEPARATE_MEMBER_PAGES.
+# The default value is: NO.
+
+INLINE_GROUPED_CLASSES = NO
+
+# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
+# with only public data fields or simple typedef fields will be shown inline in
+# the documentation of the scope in which they are defined (i.e. file,
+# namespace, or group documentation), provided this scope is documented. If set
+# to NO, structs, classes, and unions are shown on a separate page (for HTML and
+# Man pages) or section (for LaTeX and RTF).
+# The default value is: NO.
+
+INLINE_SIMPLE_STRUCTS = NO
+
+# When TYPEDEF_HIDES_STRUCT tag 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
+# 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.
+# The default value is: NO.
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 penalty.
-# 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 roughly 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
+# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
+# cache is used to resolve symbols given their name and scope. Since this can be
+# an expensive process and often the same symbol appears multiple times in the
+# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
+# doxygen will become slower. If the cache is too large, memory is wasted. The
+# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
+# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
+# symbols. At the end of a run doxygen will report the cache usage and suggest
+# the optimal cache size from a speed point of view.
+# Minimum value: 0, maximum value: 9, default value: 0.
+
+LOOKUP_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
+# 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 respectively EXTRACT_STATIC tags are set to YES.
+# Note: This will also disable the warnings about undocumented members that are
+# normally produced when WARNINGS is set to YES.
+# The default value is: NO.
-EXTRACT_ALL = 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.
+# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
+# be included in the documentation.
+# The default value is: NO.
EXTRACT_PRIVATE = NO
-# If the EXTRACT_STATIC tag is set to YES all static members of a file
-# will be included in the documentation.
+# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
+# scope will be included in the documentation.
+# The default value is: NO.
+
+EXTRACT_PACKAGE = NO
+
+# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
+# included in the documentation.
+# The default value is: NO.
EXTRACT_STATIC = NO
-# 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.
+# 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. Does not have any effect
+# for Java sources.
+# The default value is: YES.
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.
+# This flag is only useful for Objective-C code. If 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, only methods in the interface are
+# included.
+# The default value is: NO.
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 namespaces are hidden.
+# '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.
+# The default value is: NO.
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.
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
+# undocumented members inside documented classes or files. If set to NO 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.
+# The default value is: NO.
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.
+# 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, these classes will be included in the various overviews. This option
+# has no effect if EXTRACT_ALL is enabled.
+# The default value is: NO.
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.
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
+# (class|struct|union) declarations. If set to NO, these declarations will be
+# included in the documentation.
+# The default value is: NO.
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.
+# 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, these
+# blocks will be appended to the function's detailed documentation block.
+# The default value is: NO.
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.
+# The INTERNAL_DOCS tag determines if documentation that is typed after a
+# \internal command is included. If the tag is set to NO then the documentation
+# will be excluded. Set it to YES to include the internal documentation.
+# The default value is: NO.
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
+# 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.
+# The default value is: system dependent.
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.
+# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
+# their full class and namespace scopes in the documentation. If set to YES, the
+# scope will be hidden.
+# The default value is: NO.
HIDE_SCOPE_NAMES = NO
-# 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.
+# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
+# append additional text to a page's title, such as Class Reference. If set to
+# YES the compound reference will be hidden.
+# The default value is: NO.
+
+HIDE_COMPOUND_REFERENCE= NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
+# the files that are included by a file in the documentation of that file.
+# The default value is: YES.
SHOW_INCLUDE_FILES = YES
-# 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.
+# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
+# grouped member an include statement to the documentation, telling the reader
+# which file to include in order to use the member.
+# The default value is: NO.
+
+SHOW_GROUPED_MEMB_INC = 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.
+# The default value is: NO.
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.
+# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
+# documentation for inline members.
+# The default value is: YES.
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.
+# If the SORT_MEMBER_DOCS tag is set to YES 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.
+# The default value is: YES.
SORT_MEMBER_DOCS = YES
-# 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.
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
+# descriptions of file, namespace and class members alphabetically by member
+# name. If set to NO, the members will appear in declaration order. Note that
+# this will also influence the order of the classes in the class list.
+# The default value is: 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.
+# 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 constructors will appear in the
+# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
+# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
+# member documentation.
+# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
+# detailed member documentation.
+# The default value is: 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.
+# 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 group names will
+# appear in their defined order.
+# The default value is: NO.
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.
+# 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 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.
+# Note: This option applies only to the class list, not to the alphabetical
+# list.
+# The default value is: NO.
SORT_BY_SCOPE_NAME = NO
-# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper type resolution of all parameters of a function it will reject a
-# match between the prototype and the implementation of a member function even if there is only one candidate or it is obvious which candidate to choose by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
-# will still accept a match between prototype and implementation in such cases.
+# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
+# type resolution of all parameters of a function it will reject a match between
+# the prototype and the implementation of a member function even if there is
+# only one candidate or it is obvious which candidate to choose by doing a
+# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
+# accept a match between prototype and implementation in such cases.
+# The default value is: NO.
STRICT_PROTO_MATCHING = 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.
+# 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.
+# The default value is: YES.
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.
+# 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.
+# The default value is: YES.
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.
+# 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.
+# The default value is: YES.
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.
+# 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.
+# The default value is: YES.
GENERATE_DEPRECATEDLIST= YES
-# The ENABLED_SECTIONS tag can be used to enable conditional
-# documentation sections, marked by \if sectionname ... \endif.
+# The ENABLED_SECTIONS tag can be used to enable conditional documentation
+# sections, marked by \if <section_label> ... \endif and \cond <section_label>
+# ... \endcond blocks.
ENABLED_SECTIONS = RELEASE_DOCU
-# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
-# the initial value of a variable or macro 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 macros in the
-# documentation can be controlled using \showinitializer or \hideinitializer
-# command in the documentation regardless of this setting.
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
+# initial value of a variable or macro / define can have 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 value of individual variables and macros / defines can be
+# controlled using \showinitializer or \hideinitializer command in the
+# documentation regardless of this setting.
+# Minimum value: 0, maximum value: 10000, default value: 30.
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
+# 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.
+# The default value is: YES.
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 = NO
-
-# 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.
+# 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 value 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.
+# 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 value 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 <command> <input-file>, where <command> is the value of
-# the FILE_VERSION_FILTER tag, and <input-file> 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.
+# popen()) the command command input-file, where command is the value of the
+# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
+# by doxygen. Whatever the program writes to standard output is used as the file
+# version. For an example see the documentation.
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.
+# output files in an output format independent way. To 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.
+#
+# Note that if you run doxygen from a directory containing a file called
+# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
+# tag is left empty.
LAYOUT_FILE =
+# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
+# the reference definitions. This must be a list of .bib files. The .bib
+# extension is automatically appended if omitted. This requires the bibtex tool
+# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
+# For LaTeX the style of the bibliography can be controlled using
+# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
+# search path. See also \cite for info how to create references.
+
+CITE_BIB_FILES =
+
#---------------------------------------------------------------------------
-# configuration options related to warning and progress messages
+# 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.
+# The QUIET tag can be used to turn on/off the messages that are generated to
+# standard output by doxygen. If QUIET is set to YES this implies that the
+# messages are off.
+# The default value is: NO.
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.
+# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
+# this implies that the warnings are on.
+#
+# Tip: Turn warnings on while writing the documentation.
+# The default value is: YES.
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.
+# If the WARN_IF_UNDOCUMENTED tag 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.
+# The default value is: YES.
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.
+# If the WARN_IF_DOC_ERROR tag 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.
+# The default value is: YES.
WARN_IF_DOC_ERROR = YES
-# The WARN_NO_PARAMDOC option can be enabled 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.
+# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
+# are documented, but have no documentation for their parameters or return
+# value. If set to NO, doxygen will only warn about wrong or incomplete
+# parameter documentation, but not about the absence of documentation.
+# The default value is: NO.
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)
+# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
+# a warning is encountered.
+# The default value is: NO.
+
+WARN_AS_ERROR = 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)
+# The default value is: $file:$line: $text.
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.
+# 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 standard
+# error (stderr).
WARN_LOGFILE =
#---------------------------------------------------------------------------
-# configuration options related to the input files
+# 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.
+# The INPUT tag is 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. See also FILE_PATTERNS and EXTENSION_MAPPING
+# Note: If this tag is empty the current directory is searched.
INPUT = "@CMAKE_SOURCE_DIR@/doxygen/"
# 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.
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
+# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
+# documentation (see: http://www.gnu.org/software/libiconv) for the list of
+# possible encodings.
+# The default value is: UTF-8.
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++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
-# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
-# *.f90 *.f *.for *.vhd *.vhdl
+# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
+# *.h) to filter out the source-files in the directories.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# read by doxygen.
+#
+# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
+# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
+# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
+# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
+# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.
FILE_PATTERNS =
-# 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.
+# The RECURSIVE tag can be used to specify whether or not subdirectories should
+# be searched for input files as well.
+# The default value is: NO.
RECURSIVE = YES
-# The EXCLUDE tag can be used to specify files and/or directories that should
+# The EXCLUDE tag can be used to specify files and/or directories that should be
# 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.
+#
+# Note that relative paths are relative to the directory from which doxygen is
+# run.
EXCLUDE = ../src/expressionparser
-# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
+# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
# from the input.
+# The default value is: NO.
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/*
+# 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 =
@@ -649,716 +843,1149 @@ EXCLUDE_PATTERNS =
# 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
+#
+# Note that the wildcards are matched against the file with absolute path, so to
+# exclude all test directories use the pattern */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).
+# 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 = "@CMAKE_SOURCE_DIR@/doxygen/examples/"
# 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 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.
+# searched for input files to be used with the \include or \dontinclude commands
+# irrespective of the value of the RECURSIVE tag.
+# The default value is: NO.
EXAMPLE_RECURSIVE = Yes
-# 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).
+# The IMAGE_PATH tag can be used to specify one or more files or directories
+# that contain images that are to be included in the documentation (see the
+# \image command).
IMAGE_PATH = "@CMAKE_SOURCE_DIR@/doxygen/images/"
# 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 <filter> <input-file>, where <filter>
-# is the value of the INPUT_FILTER tag, and <input-file> 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.
+# by executing (via popen()) the command:
+#
+# <filter> <input-file>
+#
+# where <filter> is the value of the INPUT_FILTER tag, and <input-file> 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.
+#
+# Note that the filter must not add or remove lines; it is applied before the
+# code is scanned, but not when the output code is generated. If lines are added
+# or removed, the anchors will not be placed correctly.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# properly processed by doxygen.
INPUT_FILTER =
# 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 or if
-# non of the patterns match the file name, INPUT_FILTER is applied.
+# 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 information on how
+# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
+# patterns match the file name, INPUT_FILTER is applied.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# properly processed by doxygen.
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).
+# INPUT_FILTER) will also be used to filter the input files that are used for
+# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
+# The default value is: NO.
FILTER_SOURCE_FILES = NO
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
-# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
-# and it is also possible to disable source filtering for a specific pattern
-# using *.ext= (so without naming a filter). This option only has effect when
-# FILTER_SOURCE_FILES is enabled.
+# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
+# it is also possible to disable source filtering for a specific pattern using
+# *.ext= (so without naming a filter).
+# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
FILTER_SOURCE_PATTERNS =
+# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
+# is part of the input, its contents will be placed on the main page
+# (index.html). This can be useful if you have a project on for instance GitHub
+# and want to reuse the introduction page also for the doxygen output.
+
+USE_MDFILE_AS_MAINPAGE =
+
#---------------------------------------------------------------------------
-# configuration options related to source browsing
+# 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.
+# 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 that
+# also VERBATIM_HEADERS is set to NO.
+# The default value is: NO.
SOURCE_BROWSER = NO
-# Setting the INLINE_SOURCES tag to YES will include the body
-# of functions and classes directly in the documentation.
+# Setting the INLINE_SOURCES tag to YES will include the body of functions,
+# classes and enums directly into the documentation.
+# The default value is: NO.
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.
+# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
+# special comment blocks from generated source code fragments. Normal C, C++ and
+# Fortran comments will always remain visible.
+# The default value is: YES.
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.
+# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
+# function all documented functions referencing it will be listed.
+# The default value is: NO.
REFERENCED_BY_RELATION = NO
-# 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.
+# 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.
+# The default value is: NO.
REFERENCES_RELATION = NO
-# 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.
+# If the REFERENCES_LINK_SOURCE tag is set to YES 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.
+# The default value is: YES.
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.
+# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
+# source code will show a tooltip with additional information such as prototype,
+# brief description and links to the definition and documentation. Since this
+# will make the HTML file larger and loading of large files a bit slower, you
+# can opt to disable this feature.
+# The default value is: YES.
+# This tag requires that the tag SOURCE_BROWSER is set to YES.
+
+SOURCE_TOOLTIPS = 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.
+#
+# To use it do the following:
+# - Install the latest version of global
+# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
+# - Make sure the INPUT points to the root of the source tree
+# - Run doxygen as normal
+#
+# Doxygen will invoke htags (and that will in turn invoke gtags), so these
+# tools must be available from the command line (i.e. in the search path).
+#
+# The result: instead of the source browser generated by doxygen, the links to
+# source code will now point to the output of htags.
+# The default value is: NO.
+# This tag requires that the tag SOURCE_BROWSER is set to YES.
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.
+# If the VERBATIM_HEADERS tag is set the YES 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.
+# See also: Section \class.
+# The default value is: YES.
VERBATIM_HEADERS = YES
+# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
+# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
+# cost of reduced performance. This can be particularly helpful with template
+# rich C++ code for which doxygen's built-in parser lacks the necessary type
+# information.
+# Note: The availability of this option depends on whether or not doxygen was
+# generated with the -Duse-libclang=ON option for CMake.
+# The default value is: NO.
+
+CLANG_ASSISTED_PARSING = NO
+
+# If clang assisted parsing is enabled you can provide the compiler with command
+# line options that you would normally use when invoking the compiler. Note that
+# the include paths will already be set by doxygen for the files and directories
+# specified with INPUT and INCLUDE_PATH.
+# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
+
+CLANG_OPTIONS =
+
#---------------------------------------------------------------------------
-# configuration options related to the alphabetical class index
+# 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.
+# 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.
+# The default value is: YES.
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])
+# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
+# which the alphabetical index list will be split.
+# Minimum value: 1, maximum value: 20, default value: 5.
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
COLS_IN_ALPHA_INDEX = 5
-# 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.
+# 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 a prefix (or a list of prefixes) that should be ignored
+# while generating the index headers.
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
IGNORE_PREFIX =
#---------------------------------------------------------------------------
-# configuration options related to the HTML output
+# Configuration options related to the HTML output
#---------------------------------------------------------------------------
-# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
-# generate HTML output.
+# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
+# The default value is: YES.
GENERATE_HTML = YES
-# 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.
+# 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.
+# The default directory is: html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
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.
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
+# generated HTML page (for example: .htm, .php, .asp).
+# The default value is: .html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
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
+# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
+# each generated HTML page. If the tag is left blank doxygen will generate a
# standard header.
+#
+# To get valid HTML the header file that includes any scripts and style sheets
+# that doxygen needs, which is dependent on the configuration options used (e.g.
+# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
+# default header using
+# doxygen -w html new_header.html new_footer.html new_stylesheet.css
+# YourConfigFile
+# and then modify the file new_header.html. See also section "Doxygen usage"
+# for information on how to generate the default header that doxygen normally
+# uses.
+# Note: The header is subject to change so you typically have to regenerate the
+# default header when upgrading to a newer version of doxygen. For a description
+# of the possible markers and block names see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_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.
+# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
+# generated HTML page. If the tag is left blank doxygen will generate a standard
+# footer. See HTML_HEADER for more information on how to generate a default
+# footer and what special commands can be used inside the footer. See also
+# section "Doxygen usage" for information on how to generate the default footer
+# that doxygen normally uses.
+# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_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!
+# 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 left blank doxygen will generate a default style sheet.
+# See also section "Doxygen usage" for information on how to generate the style
+# sheet that doxygen normally uses.
+# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
+# it is more robust and this tag (HTML_STYLESHEET) will in the future become
+# obsolete.
+# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_STYLESHEET =
-# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
-# Doxygen will adjust the colors in the stylesheet and background images
-# according to this color. Hue is specified as an angle on a colorwheel,
-# see http://en.wikipedia.org/wiki/Hue for more information.
-# For instance the value 0 represents red, 60 is yellow, 120 is green,
-# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
-# The allowed range is 0 to 359.
+# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
+# cascading style sheets that are included after the standard style sheets
+# created by doxygen. Using this option one can overrule certain style aspects.
+# This is preferred over using HTML_STYLESHEET since it does not replace the
+# standard style sheet and is therefore more robust against future updates.
+# Doxygen will copy the style sheet files to the output directory.
+# Note: The order of the extra style sheet files is of importance (e.g. the last
+# style sheet in the list overrules the setting of the previous ones in the
+# list). For an example see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_EXTRA_STYLESHEET =
+
+# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the HTML output directory. Note
+# that these files will be copied to the base HTML output directory. Use the
+# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
+# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
+# files will be copied as-is; there are no commands or markers available.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_EXTRA_FILES =
+
+# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
+# will adjust the colors in the style sheet and background images according to
+# this color. Hue is specified as an angle on a colorwheel, see
+# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
+# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
+# purple, and 360 is red again.
+# Minimum value: 0, maximum value: 359, default value: 220.
+# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_HUE = 220
-# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
-# the colors in the HTML output. For a value of 0 the output will use
-# grayscales only. A value of 255 will produce the most vivid colors.
+# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
+# in the HTML output. For a value of 0 the output will use grayscales only. A
+# value of 255 will produce the most vivid colors.
+# Minimum value: 0, maximum value: 255, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_SAT = 100
-# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
-# the luminance component of the colors in the HTML output. Values below
-# 100 gradually make the output lighter, whereas values above 100 make
-# the output darker. The value divided by 100 is the actual gamma applied,
-# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
-# and 100 does not change the gamma.
+# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
+# luminance component of the colors in the HTML output. Values below 100
+# gradually make the output lighter, whereas values above 100 make the output
+# darker. The value divided by 100 is the actual gamma applied, so 80 represents
+# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
+# change the gamma.
+# Minimum value: 40, maximum value: 240, default value: 80.
+# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_GAMMA = 80
# 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.
+# page will contain the date and time when the page was generated. Setting this
+# to YES can help to show when doxygen was last run and thus if the
+# documentation is up to date.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_TIMESTAMP = YES
-# 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).
+# page has loaded.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
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
+# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
+# shown in the various tree structured indices initially; the user can expand
+# and collapse entries dynamically later on. Doxygen will expand the tree to
+# such a level that at most the specified number of entries are visible (unless
+# a fully collapsed tree already exceeds this amount). So setting the number of
+# entries 1 will produce a full collapsed tree by default. 0 is a special value
+# representing an infinite number of entries and will result in a full expanded
+# tree by default.
+# Minimum value: 0, maximum value: 9999, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_INDEX_NUM_ENTRIES = 100
+
+# 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 (see: http://developer.apple.com/tools/xcode/), 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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
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.
+# This tag determines the name of the docset 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.
+# The default value is: Doxygen generated docs.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
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.
+# 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.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_BUNDLE_ID = org.doxygen.Project
-# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
+# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
# the documentation publisher. This should be a reverse domain-name style
# string, e.g. com.mycompany.MyDocSet.documentation.
+# The default value is: org.doxygen.Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
-# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
+# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
+# The default value is: Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_PUBLISHER_NAME = Publisher
-# 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.
+# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
+# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
+# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
+# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
+# Windows.
+#
+# The HTML Help Workshop contains a compiler that can convert all HTML output
+# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
+# files are now used as the Windows 98 help format, and will replace the old
+# Windows help format (.hlp) on all Windows platforms in the future. Compressed
+# HTML files also contain an index, a table of contents, and you can search for
+# words in the documentation. The HTML workshop also contains a viewer for
+# compressed HTML files.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
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
+# 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.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
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.
+# 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.
+# The file has to be specified with full path.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
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).
+# 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).
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
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.
+# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
+# and project file content.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
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.
+# 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. Furthermore it
+# enables the Previous and Next buttons.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
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.
+# The TOC_EXPAND flag can be set to YES to add extra items for group members to
+# the table of contents of the HTML help documentation and to the tree view.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
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.
+# 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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
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.
+# 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.
+# This tag requires that the tag GENERATE_QHP is set to YES.
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
+# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
+# Project output. For more information please see Qt Help Project / Namespace
+# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_QHP is set to YES.
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
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
+# Help Project output. For more information please see Qt Help Project / Virtual
+# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
+# folders).
+# The default value is: doc.
+# This tag requires that the tag GENERATE_QHP is set to YES.
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
+# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
+# filter to add. For more information please see Qt Help Project / Custom
+# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
+# filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
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
-# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
-# Qt Help Project / Custom Filters</a>.
+# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
+# custom filter to add. For more information please see Qt Help Project / Custom
+# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
+# filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_CUST_FILTER_ATTRS =
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
-# project's
-# filter section matches.
-# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
-# Qt Help Project / Filter Attributes</a>.
+# project's filter section matches. Qt Help Project / Filter Attributes (see:
+# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
+# This tag requires that the tag GENERATE_QHP is set to YES.
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.
+# 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.
+# This tag requires that the tag GENERATE_QHP is set to YES.
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.
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
+# generated, together with the HTML files, they 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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
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.
+# 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. Each documentation set should have its own identifier.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
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.
+# If you want full control over the layout of the generated HTML pages it might
+# be necessary to disable the index and replace it with your own. The
+# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
+# of each HTML page. A value of NO enables the index and the value YES disables
+# it. Since the tabs in the index contain the same information as the navigation
+# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
DISABLE_INDEX = NO
-# This tag can be used to set the number of enum values (range [0,1..20])
-# that doxygen will group on one line in the generated HTML documentation.
-# Note that a value of 0 will completely suppress the enum values from appearing in the overview section.
-
-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.
+# 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. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
+# further fine-tune the look of the index. As an example, the default style
+# sheet generated by doxygen has an example that shows how to put an image at
+# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
+# the same information as the tab index, you could consider setting
+# DISABLE_INDEX to YES when enabling this option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
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.
+# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
+# doxygen will group on one line in the generated HTML documentation.
+#
+# Note that a value of 0 will completely suppress the enum values from appearing
+# in the overview section.
+# Minimum value: 0, maximum value: 20, default value: 4.
+# This tag requires that the tag GENERATE_HTML is set to YES.
-USE_INLINE_TREES = NO
+ENUM_VALUES_PER_LINE = 4
-# 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.
+# 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.
+# Minimum value: 0, maximum value: 1500, default value: 250.
+# This tag requires that the tag GENERATE_HTML is set to YES.
TREEVIEW_WIDTH = 250
-# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
-# links to external symbols imported via tag files in a separate window.
+# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
+# external symbols imported via tag files in a separate window.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
EXT_LINKS_IN_WINDOW = NO
-# 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.
+# Use this tag to change the font size of LaTeX formulas included as images in
+# the HTML documentation. 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.
+# Minimum value: 8, maximum value: 50, default value: 10.
+# This tag requires that the tag GENERATE_HTML is set to YES.
FORMULA_FONTSIZE = 12
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
-# generated for formulas are transparent PNGs. Transparent PNGs are
-# not supported properly for IE 6.0, but are supported on all modern browsers.
-# Note that when changing this option you need to delete any form_*.png files
-# in the HTML output before the changes have effect.
+# generated for formulas are transparent PNGs. Transparent PNGs are not
+# supported properly for IE 6.0, but are supported on all modern browsers.
+#
+# Note that when changing this option you need to delete any form_*.png files in
+# the HTML output directory before the changes have effect.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
FORMULA_TRANSPARENT = YES
-# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
-# (see http://www.mathjax.org) which uses client side Javascript for the
-# rendering instead of using prerendered bitmaps. Use this if you do not
-# have LaTeX installed or if you want to formulas look prettier in the HTML
-# output. When enabled you also need to install MathJax separately and
-# configure the path to it using the MATHJAX_RELPATH option.
+# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
+# http://www.mathjax.org) which uses client side Javascript for the rendering
+# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
+# installed or if you want to formulas look prettier in the HTML output. When
+# enabled you may also need to install MathJax separately and configure the path
+# to it using the MATHJAX_RELPATH option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
USE_MATHJAX = NO
-# When MathJax is enabled you need to specify the location relative to the
-# HTML output directory using the MATHJAX_RELPATH option. The destination
-# directory should contain the MathJax.js script. For instance, if the mathjax
-# directory is located at the same level as the HTML output directory, then
-# MATHJAX_RELPATH should be ../mathjax. The default value points to the mathjax.org site, so you can quickly see the result without installing
-# MathJax, but it is strongly recommended to install a local copy of MathJax
-# before deployment.
+# When MathJax is enabled you can set the default output format to be used for
+# the MathJax output. See the MathJax site (see:
+# http://docs.mathjax.org/en/latest/output.html) for more details.
+# Possible values are: HTML-CSS (which is slower, but has the best
+# compatibility), NativeMML (i.e. MathML) and SVG.
+# The default value is: HTML-CSS.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_FORMAT = HTML-CSS
+
+# When MathJax is enabled you need to specify the location relative to the HTML
+# output directory using the MATHJAX_RELPATH option. The destination directory
+# should contain the MathJax.js script. For instance, if the mathjax directory
+# is located at the same level as the HTML output directory, then
+# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
+# Content Delivery Network so you can quickly see the result without installing
+# MathJax. However, it is strongly recommended to install a local copy of
+# MathJax from http://www.mathjax.org before deployment.
+# The default value is: http://cdn.mathjax.org/mathjax/latest.
+# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_RELPATH = http://www.mathjax.org/mathjax
-# 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.
+# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
+# extension names that should be enabled during MathJax rendering. For example
+# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_EXTENSIONS =
+
+# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
+# of code that will be used on startup of the MathJax code. See the MathJax site
+# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
+# example see the documentation.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_CODEFILE =
+
+# 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. It is possible to
+# search using the keyboard; to jump to the search box use <access key> + S
+# (what the <access key> is depends on the OS and browser, but it is typically
+# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
+# key> to jump into the search results window, the results can be navigated
+# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
+# the search. The filter options can be selected when the cursor is inside the
+# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
+# to select a filter and <Enter> or <escape> to activate or cancel the filter
+# option.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
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 disadvantages are that it is more difficult to setup
-# and does not have live searching capabilities.
+# implemented using a web server instead of a web client using Javascript. There
+# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
+# setting. When disabled, doxygen will generate a PHP script for searching and
+# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
+# and searching needs to be provided by external tools. See the section
+# "External Indexing and Searching" for details.
+# The default value is: NO.
+# This tag requires that the tag SEARCHENGINE is set to YES.
SERVER_BASED_SEARCH = NO
+# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
+# script for searching. Instead the search results are written to an XML file
+# which needs to be processed by an external indexer. Doxygen will invoke an
+# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
+# search results.
+#
+# Doxygen ships with an example indexer (doxyindexer) and search engine
+# (doxysearch.cgi) which are based on the open source search engine library
+# Xapian (see: http://xapian.org/).
+#
+# See the section "External Indexing and Searching" for details.
+# The default value is: NO.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTERNAL_SEARCH = NO
+
+# The SEARCHENGINE_URL should point to a search engine hosted by a web server
+# which will return the search results when EXTERNAL_SEARCH is enabled.
+#
+# Doxygen ships with an example indexer (doxyindexer) and search engine
+# (doxysearch.cgi) which are based on the open source search engine library
+# Xapian (see: http://xapian.org/). See the section "External Indexing and
+# Searching" for details.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SEARCHENGINE_URL =
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
+# search data is written to a file for indexing by an external tool. With the
+# SEARCHDATA_FILE tag the name of this file can be specified.
+# The default file is: searchdata.xml.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SEARCHDATA_FILE = searchdata.xml
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
+# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
+# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
+# projects and redirect the results back to the right project.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTERNAL_SEARCH_ID =
+
+# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
+# projects other than the one defined by this configuration file, but that are
+# all added to the same external search index. Each project needs to have a
+# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
+# to a relative location where the documentation can be found. The format is:
+# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTRA_SEARCH_MAPPINGS =
+
#---------------------------------------------------------------------------
-# configuration options related to the LaTeX output
+# Configuration options related to the LaTeX output
#---------------------------------------------------------------------------
-# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
-# generate Latex output.
+# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
+# The default value is: YES.
GENERATE_LATEX = YES
-# 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.
+# 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.
+# The default directory is: latex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
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.
+# invoked.
+#
+# 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.
+# The default file is: latex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
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.
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
+# index for LaTeX.
+# The default file is: makeindex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
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.
+# 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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
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, letter, legal and
-# executive. If left blank a4wide will be used.
+# The PAPER_TYPE tag can be used to set the paper type that is used by the
+# printer.
+# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
+# 14 inches) and executive (7.25 x 10.5 inches).
+# The default value is: a4.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
PAPER_TYPE = a4
-# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
-# packages that should be included in the LaTeX output.
+# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
+# that should be included in the LaTeX output. The package can be specified just
+# by its name or with the correct syntax as to be used with the LaTeX
+# \usepackage command. To get the times font for instance you can specify :
+# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
+# To use the option intlimits with the amsmath package you can specify:
+# EXTRA_PACKAGES=[intlimits]{amsmath}
+# If left blank no extra packages will be included.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
EXTRA_PACKAGES =
-# 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!
+# 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. See
+# section "Doxygen usage" for information on how to let doxygen write the
+# default header to a separate file.
+#
+# Note: Only use a user-defined header if you know what you are doing! The
+# following commands have a special meaning inside the header: $title,
+# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
+# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
+# string, for the replacement values of the other commands the user is referred
+# to HTML_HEADER.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
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.
+# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
+# generated LaTeX document. The footer should contain everything after the last
+# chapter. If it is left blank doxygen will generate a standard footer. See
+# LATEX_HEADER for more information on how to generate a default footer and what
+# special commands can be used inside the footer.
+#
+# Note: Only use a user-defined footer if you know what you are doing!
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_FOOTER =
+
+# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
+# LaTeX style sheets that are included after the standard style sheets created
+# by doxygen. Using this option one can overrule certain style aspects. Doxygen
+# will copy the style sheet files to the output directory.
+# Note: The order of the extra style sheet files is of importance (e.g. the last
+# style sheet in the list overrules the setting of the previous ones in the
+# list).
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EXTRA_STYLESHEET =
+
+# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the LATEX_OUTPUT output
+# directory. Note that the files will be copied as-is; there are no commands or
+# markers available.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EXTRA_FILES =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
+# prepared for conversion to PDF (using ps2pdf or pdflatex). 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.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
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
+# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
+# the PDF file directly from the LaTeX files. Set this option to YES, to get a
# higher quality PDF documentation.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
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.
+# 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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
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.
+# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
+# index chapters (such as File Index, Compound Index, etc.) in the output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
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.
+# If the LATEX_SOURCE_CODE tag 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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_SOURCE_CODE = NO
+# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
+# bibliography, e.g. plainnat, or ieeetr. See
+# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
+# The default value is: plain.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_BIB_STYLE = plain
+
+# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
+# 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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_TIMESTAMP = NO
+
#---------------------------------------------------------------------------
-# configuration options related to the RTF output
+# 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.
+# 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 too pretty with other RTF
+# readers/editors.
+# The default value is: NO.
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.
+# 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.
+# The default directory is: rtf.
+# This tag requires that the tag GENERATE_RTF is set to YES.
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.
+# 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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
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.
+# 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 some other Word compatible readers that support those
+# fields.
+#
+# Note: WordPad (write) and others do not support links.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
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.
+# 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.
+#
+# See also section "Doxygen usage" for information on how to generate the
+# default style sheet that doxygen normally uses.
+# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_STYLESHEET_FILE =
-# Set optional variables used in the generation of an rtf document.
-# Syntax is similar to doxygen's config file.
+# Set optional variables used in the generation of an RTF document. Syntax is
+# similar to doxygen's config file. A template extensions file can be generated
+# using doxygen -e rtf extensionFile.
+# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_EXTENSIONS_FILE =
+# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
+# with syntax highlighting in the RTF output.
+#
+# Note that which sources are shown also depends on other settings such as
+# SOURCE_BROWSER.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_SOURCE_CODE = NO
+
#---------------------------------------------------------------------------
-# configuration options related to the man page output
+# Configuration options related to the man page output
#---------------------------------------------------------------------------
-# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
-# generate man pages
+# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
+# classes and files.
+# The default value is: NO.
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.
+# 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. A directory man3 will be created inside the directory specified by
+# MAN_OUTPUT.
+# The default directory is: man.
+# This tag requires that the tag GENERATE_MAN is set to YES.
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)
+# The MAN_EXTENSION tag determines the extension that is added to the generated
+# man pages. In case the manual section does not start with a number, the number
+# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
+# optional.
+# The default value is: .3.
+# This tag requires that the tag GENERATE_MAN is set to YES.
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.
+# The MAN_SUBDIR tag determines the name of the directory created within
+# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
+# MAN_EXTENSION with the initial . removed.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_SUBDIR =
+
+# 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 value is: NO.
+# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_LINKS = NO
#---------------------------------------------------------------------------
-# configuration options related to the XML output
+# 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.
+# 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.
+# The default value is: NO.
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.
+# 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.
+# The default directory is: xml.
+# This tag requires that the tag GENERATE_XML is set to YES.
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.
+# 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.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_PROGRAMLISTING = YES
-XML_SCHEMA =
+#---------------------------------------------------------------------------
+# Configuration options related to the DOCBOOK output
+#---------------------------------------------------------------------------
-# 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.
+# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
+# that can be used to generate PDF.
+# The default value is: NO.
-XML_DTD =
+GENERATE_DOCBOOK = NO
-# 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.
+# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
+# front of it.
+# The default directory is: docbook.
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
-XML_PROGRAMLISTING = YES
+DOCBOOK_OUTPUT = docbook
+
+# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
+# program listings (including syntax highlighting and cross-referencing
+# information) to the DOCBOOK output. Note that enabling this will significantly
+# increase the size of the DOCBOOK output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
+
+DOCBOOK_PROGRAMLISTING = NO
#---------------------------------------------------------------------------
-# configuration options for the AutoGen Definitions output
+# 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.
+# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
+# AutoGen Definitions (see http://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.
+# The default value is: NO.
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
-# configuration options related to the Perl module output
+# 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.
+# 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.
+# The default value is: NO.
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.
+# 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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
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.
+# 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.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
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.
+# 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.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_MAKEVAR_PREFIX =
@@ -1366,112 +1993,132 @@ 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.
+# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
+# C-preprocessor directives found in the sources and include files.
+# The default value is: YES.
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.
+# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
+# in the source code. If set to NO, only conditional compilation will be
+# performed. Macro expansion can be done in a controlled way by setting
+# EXPAND_ONLY_PREDEF to YES.
+# The default value is: NO.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
MACRO_EXPANSION = NO
-# 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.
+# 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.
+# The default value is: NO.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
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.
+# If the SEARCH_INCLUDES tag is set to YES, the include files in the
+# INCLUDE_PATH will be searched if a #include is found.
+# The default value is: YES.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
SEARCH_INCLUDES = YES
# 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.
+# contain include files that are not input files but should be processed by the
+# preprocessor.
+# This tag requires that the tag SEARCH_INCLUDES is set to YES.
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.
+# directories. If left blank, the patterns specified with FILE_PATTERNS will be
+# used.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
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.
+# 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 e.g.
+# 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.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
PREDEFINED = BOOST_MPI \
- BOOST_THREAD \
- _ARMADILLO_ \
- __EXCEPTIONS__
+ BOOST_THREAD \
+ _ARMADILLO_ \
+ __EXCEPTIONS__
-# 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 that overrules the definition found in the source code.
+# 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 that overrules the
+# definition found in the source code.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_AS_DEFINED =
-# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
-# doxygen's preprocessor will remove all references to function-like macros
-# that are alone on a line, have an all uppercase name, and do not end with a
-# semicolon, because these will confuse the parser if not removed.
+# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
+# remove all references to 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.
+# The default value is: YES.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
-# Configuration::additions related to external references
+# Configuration options 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:
-#
+# The TAGFILES tag can be used to specify one or more tag files. For each tag
+# file the location of the external documentation should be added. 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.
+# where loc1 and loc2 can be relative or absolute paths or URLs. See the
+# section "Linking to external documentation" for more information about the use
+# of tag files.
+# Note: 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.
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
+# tag file that is based on the input files it reads. See section "Linking to
+# external documentation" for more information about the usage of tag files.
GENERATE_TAGFILE =
-# 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.
+# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
+# the class index. If set to NO, only the inherited external classes will be
+# listed.
+# The default value is: NO.
ALLEXTERNALS = NO
-# 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.
+# 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.
+# The default value is: YES.
EXTERNAL_GROUPS = YES
+# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
+# the related pages index. If set to NO, only the current project's pages will
+# be listed.
+# The default value is: YES.
+
+EXTERNAL_PAGES = YES
+
# The PERL_PATH should be the absolute path and name of the perl script
-# interpreter (i.e. the result of `which perl').
+# interpreter (i.e. the result of 'which perl').
+# The default file (with absolute path) is: /usr/bin/perl.
PERL_PATH = /usr/bin/perl
@@ -1479,204 +2126,319 @@ 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 also works with HAVE_DOT disabled, but it is recommended to
-# install and use dot, since it yields more powerful graphs.
+# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
+# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
+# NO turns the diagrams off. Note that this option also works with HAVE_DOT
+# disabled, but it is recommended to install and use dot, since it yields more
+# powerful graphs.
+# The default value is: YES.
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
+# 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.
+# You can include diagrams made with dia in doxygen documentation. Doxygen will
+# then run dia to produce the diagram and insert it in the documentation. The
+# DIA_PATH tag allows you to specify the directory where the dia binary resides.
+# If left empty dia is assumed to be found in the default search path.
+
+DIA_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.
+# The default value is: YES.
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)
+# available from the path. This tool is part of Graphviz (see:
+# http://www.graphviz.org/), 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 value is: YES.
HAVE_DOT = NO
-# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
-# allowed to run in parallel. When set to 0 (the default) doxygen will
-# base this on the number of processors available in the system. You can set it
-# explicitly to a value larger than 0 to get control over the balance
-# between CPU load and processing speed.
+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
+# to run in parallel. When set to 0 doxygen will base this on the number of
+# processors available in the system. You can set it explicitly to a value
+# larger than 0 to get control over the balance between CPU load and processing
+# speed.
+# Minimum value: 0, maximum value: 32, default value: 0.
+# This tag requires that the tag HAVE_DOT is set to YES.
DOT_NUM_THREADS = 0
-# By default doxygen will write a font called Helvetica to the output
-# directory and reference it in all dot files that doxygen generates.
-# When you want a differently looking font you can specify the font name
-# using DOT_FONTNAME. You 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.
+# When you want a differently looking font in the dot files that doxygen
+# generates you can specify the font name using DOT_FONTNAME. You 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.
+# The default value is: Helvetica.
+# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTNAME = Helvetica
-# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
-# The default size is 10pt.
+# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
+# dot graphs.
+# Minimum value: 4, maximum value: 24, default value: 10.
+# This tag requires that the tag HAVE_DOT is set to YES.
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.
+# By default doxygen will tell dot to use the default font as specified with
+# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
+# the path where dot can find it using this tag.
+# This tag requires that the tag HAVE_DOT is set to YES.
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.
+# If the CLASS_GRAPH tag is 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 CLASS_DIAGRAMS tag to NO.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
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.
+# If the COLLABORATION_GRAPH tag is 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.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
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
+# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
+# groups, showing the direct groups dependencies.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
GROUP_GRAPHS = YES
-# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
+# 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 = YES
-
-# If set to YES, the inheritance and collaboration graphs will show the
-# relations between templates and their instances.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+UML_LOOK = YES
+
+# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
+# class node. If there are many fields or methods and many nodes the graph may
+# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
+# number of items for each type to make the size more manageable. Set this to 0
+# for no limit. Note that the threshold may be exceeded by 50% before the limit
+# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
+# but if the number exceeds 15, the total amount of fields shown is limited to
+# 10.
+# Minimum value: 0, maximum value: 100, default value: 10.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+UML_LIMIT_NUM_FIELDS = 10
+
+# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
+# collaboration graphs will show the relations between templates and their
+# instances.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
TEMPLATE_RELATIONS = NO
-# 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.
+# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES 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.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
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.
+# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES 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.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
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.
+# If the CALL_GRAPH tag is 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. Disabling a call graph can be
+# accomplished by means of the command \hidecallgraph.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
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.
+# If the CALLER_GRAPH tag is 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. Disabling a caller graph can be
+# accomplished by means of the command \hidecallergraph.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
CALLER_GRAPH = YES
-# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
-# will generate a graphical hierarchy of all classes instead of a textual one.
+# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
+# hierarchy of all classes instead of a textual one.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
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.
+# If the DIRECTORY_GRAPH tag is 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.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
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, svg, gif or svg.
-# If left blank png will be used.
+# generated by dot. For an explanation of the image formats see the section
+# output formats in the documentation of the dot tool (Graphviz (see:
+# http://www.graphviz.org/)).
+# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
+# to make the SVG files visible in IE 9+ (other browsers do not have this
+# requirement).
+# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
+# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
+# gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
+# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
+# png:gdiplus:gdiplus.
+# The default value is: png.
+# This tag requires that the tag HAVE_DOT is set to YES.
DOT_IMAGE_FORMAT = png
-# The tag DOT_PATH can be used to specify the path where the dot tool can be
+# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
+# enable generation of interactive SVG images that allow zooming and panning.
+#
+# Note that this requires a modern browser other than Internet Explorer. Tested
+# and working are Firefox, Chrome, Safari, and Opera.
+# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
+# the SVG files visible. Older versions of IE do not have SVG support.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+INTERACTIVE_SVG = NO
+
+# The DOT_PATH tag 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.
+# This tag requires that the tag HAVE_DOT is set to YES.
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).
+# contain dot files that are included in the documentation (see the \dotfile
+# command).
+# This tag requires that the tag HAVE_DOT is set to YES.
DOTFILE_DIRS =
# The MSCFILE_DIRS tag can be used to specify one or more directories that
-# contain msc files that are included in the documentation (see the
-# \mscfile command).
+# contain msc files that are included in the documentation (see the \mscfile
+# command).
MSCFILE_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.
+# The DIAFILE_DIRS tag can be used to specify one or more directories that
+# contain dia files that are included in the documentation (see the \diafile
+# command).
+
+DIAFILE_DIRS =
+
+# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
+# path where java can find the plantuml.jar file. If left blank, it is assumed
+# PlantUML is not used or called during a preprocessing step. Doxygen will
+# generate a warning when it encounters a \startuml command in this case and
+# will not generate output for the diagram.
+
+PLANTUML_JAR_PATH =
+
+# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
+# configuration file for plantuml.
+
+PLANTUML_CFG_FILE =
+
+# When using plantuml, the specified paths are searched for files specified by
+# the !include statement in a plantuml block.
+
+PLANTUML_INCLUDE_PATH =
+
+# 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.
+# Minimum value: 0, maximum value: 10000, default value: 50.
+# This tag requires that the tag HAVE_DOT is set to YES.
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
+# 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.
+# Minimum value: 0, maximum value: 1000, default value: 0.
+# This tag requires that the tag HAVE_DOT is set to YES.
MAX_DOT_GRAPH_DEPTH = 0
# 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).
+# 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).
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
DOT_TRANSPARENT = NO
-# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
+# Set the DOT_MULTI_TARGETS tag to YES to 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.
+# makes dot run faster, but since only newer versions of dot (>1.8.10) support
+# this, this feature is disabled by default.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
DOT_MULTI_TARGETS = NO
-# 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.
+# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
+# explaining the meaning of the various boxes and arrows in the dot generated
+# graphs.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
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.
+# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
+# files that are used to generate the various graphs.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
DOT_CLEANUP = YES
diff --git a/doxygen/aging_simulation.md b/doxygen/aging_simulation.md
index a6b3c71a0e0119848a46e553e6fb9cde3c34d263..d02070c78eb8bfd9c06da38f7efa43b672a209de 100644
--- a/doxygen/aging_simulation.md
+++ b/doxygen/aging_simulation.md
@@ -96,19 +96,8 @@ The time constant \f$ \tau \f$ depens on the temperature \f$ T \f$ and is calcul
XML Format
==========
-A detailed example for an aging simulation can be found at scenarions/aging/sanyo_18651_single_cell_aging.xml .
-
-Global Options
---------------
-
-These options for the aging simulation must be added in <Configuration><Options><Aging>.
-
-XML Tag | Type | Unit | Explanation
-----------------------------------------|---------------|-----------|----------------------------------------------------------------------------------------
-CalculationCycles | int > 0 | | Number of times the current or power profile is simulated before each aging step. Optional, default = 1.
-SteadyStateCycles | int >= 0 | | Number of cycles that are simulated without collecting data for aging before the cycles specified in CalculationCycles are simulated. Optional, default = 0.
-AgingSteps | int > 0 | | Number of aging steps. Optional, default = 1.
-AgingStepTime | double > 0 | day | Duration of each aging step
+Global options for the aging simulation are described on the page [XML options](xmloption.html#aging).
+A detailed example for an aging simulation can be found at scenarions/aging/sanyo_18651_single_cell_aging.xml.
Observer
--------
@@ -118,10 +107,10 @@ Filters for the aging simulation can be added in <Configuration><Observer><Aging
Cell Aging
----------
-The aging for each cell can be specified using the element <Aging> inside the cell's XML element.
+The aging for each cell can be specified using the element <**Aging**> inside the cell's XML element.
The aging element contains a list of aging effects affecting the cell.
-If the cell is not new at the beginnig of the simulation, the initial cell age and charge throughput can be set by adding an <AgingState> element with the following children:
+If the cell is not new at the beginnig of the simulation, the initial cell age and charge throughput can be set by adding an <**AgingState**> element with the following children:
XML Tag | Type | Unit | Explanation
----------------------------------------|---------------|-----------|----------------------------------------------------------------------------------------
@@ -131,7 +120,7 @@ ChargeThroughput | double | Ah | Charge thr
Halfcell Simulation
-------------------
-The general XML format of a halfcell simulation is described [here](xmlhalfcell.html). Each element of the classes AnodeElement and CathodeElement con contain an <Aging> element and an <AgingState> element that work in the same way as those of a cell. An example for a halfcell simulation is given in scenarions/aging/sanyo_18651_single_cell_aging.
+The general XML format of a halfcell simulation is described [here](xmlhalfcell.html). Each element of the classes AnodeElement and CathodeElement con contain an <**Aging**> element and an <**AgingState**> element that work in the same way as those of a cell. An example for a halfcell simulation is given in scenarions/aging/sanyo_18651_single_cell_aging.
Calendric Aging
---------------
diff --git a/doxygen/einleitung.md b/doxygen/einleitung.md
index 0e7d09a0c925f971c2db89736cd9df1ee5fedee8..8f02dfafbbddac527370a8a3d3b5f6b3bfd886b9 100644
--- a/doxygen/einleitung.md
+++ b/doxygen/einleitung.md
@@ -1,78 +1,28 @@
-Introduction {#einleitung}
+Introduction {#introduction}
=====
-\~German
-Das ISEAFramework ist eine am Institut für Stromrichtertechnik und Elektrische Antriebe (ISEA) entwickelte Programmbibliothek zur generischen Simulation von Batterienetzwerken.
-Basierend auf den charakteristischen Messergebnissen der Impedanzspektroskopie können beispielsweise Lithium-Ionen-Batterien oder Supercaps in der Simulation durch ein elektrisches Ersatzschaltbild angenähert werden.
-Es ist möglich, ein solches Ersatzschaltbild durch eine Reihenschaltung einfacher Grundelemente zu approximieren.
-Diese Grundelemente sind als Klassen im Framework hinterlegt und können in Reihen- und Parallelschaltungen zu einem Netzwerk verbunden werden.
-Auf diese Weise können ganze Batteriepakete nachgebildet werden.
-<br/><br/>
-Zusätzlich kann ein thermisches Modell erstellt werden, welches es ermöglicht, die Temperaturverteilung und -Entwicklung in der Batterie bzw. im Batteriepack zu simulieren.
-Dieses Modell kann gekoppelt mit dem elektrischen Modell laufen, so dass der Einfluss der Temperatur auf die elektrische Parametrierung simuliert werden kann.
-<br/><br/>
-
-Ablauf der Simulation
-----
-
-
-Die Simulation läßt sich in drei Schritte unterteilen.
-
-
-Initialisierungsphase:
-----
-- Aufstellen des elektrischen Ersatzschaltbildes
-- Erstellen des thermischen Modells
-
-Simulationszyklus:
------
-- 2. Setzen des geforderten Stroms
-- 3. Update der Lookups
-- 4. Setzen der algebraischen und differentiellen Gleichungen
-- 5. Berechnung und Lösung des Statespaces
-- 6. Berechnung der Ströme, Spannungen und thermischen Verlustleistungen
-- 7. Ãœbergabe der thermischen Verlustleistungen an das thermische Modell (Nicht eingezeichnet im Bild)
-- 8. Berechnen und Weiterleiten der neuen Temperaturen (Nicht eingezeichnet im Bild)
-
-Aufräumen:
-----
-- Freigabe des genutzten Speichers
-
-Nach einer Simulation können die Ergebnisse visualisiert werden.
-
-
-
-
-<!--
-
-Introduction {#einleitung}
-=====
--->
-\~English
-
-
-The ISEAFramework is a library for generic battery simulation and is developed at the Institute for Power Electronics and Electrical Drives (ISEA) .
+The ISEAFramework is a library for generic battery simulation and is developed at the Institute for Power Electronics and Electrical Drives (ISEA).
Models are based on datasets gained through electrochemical impedance spectroscopy (EIS) and a variety of different storage technologies can be described with these measurements,
e.g. lithium-ion batteries and double layer capacitors.
Results gained by EIS can be used to approximate the system through an electrical equivalent circuit and can be connected in different ways (parallel and serial).
This allows to describe storage systems in a generic way and to not only describe a single battery, but whole packs.
-
-<br/><br/>
+<br/>
Additionally a thermal model can be simulated, which simulates temperature distributions and trends inside the battery and battery pack.
This model is coupled with the electrical model during runtime, so that the thermal heat, which is generated by the electrical model, is directly fed into the thermal simulation.
-<br/><br/>
+<br/>
+The framework also includes an aging model that can be used to make aging and lifetime predictions. The results from this model influence the electrical equivalent circuit so that the aging has an effect on the electrical behaviour of the battery.
Simulation sequence
-----
-
+====
+A detailed description of the simulation process including the thermal and aging simulation can be found [here](simulation_cycle.html)
-Initialization:
+Initialization
----
- Creation of the electrical model
- Creation of the thermal model
-Simulation-cycle:
+Simulation cycle
-----
- 2. Set requested current
- 3. Update of lookup tables
@@ -82,7 +32,7 @@ Simulation-cycle:
- 7. Passing the thermal losses (head) to the thermal model (not depicted in the image)
- 8. Calculating new temperature distribution and closing the feedback loop through passing the temperature back to the electrical model (not depicted in the image)
-Clean up:
+Cleanup
----
- Release allocated memory
diff --git a/doxygen/examples/csvfilter.xml b/doxygen/examples/csvfilter.xml
index af6aba0f3eec2336c29615acf46cc1aa9b1ed9bf..65729551e6555d8ee1f5e96d88966b3774b7cdd2 100644
--- a/doxygen/examples/csvfilter.xml
+++ b/doxygen/examples/csvfilter.xml
@@ -1,10 +1,6 @@
<Observer>
<Filter4 class="CSVFilter">
- <filename>
- sanyo.csv
- </filename>
- <printHeader> 1 </printHeader>
+ <Filename>sanyo.csv</Filename>
+ <printHeader>true</printHeader>
</Filter4>
-</Observer>
-
-
+</Observer>
\ No newline at end of file
diff --git a/doxygen/examples/csvfilter_color.xml b/doxygen/examples/csvfilter_color.xml
index 79d5985813d9d889f12c626b26f1aa4aac64080e..be86455a59df703fb887627719e34cd18b683233 100644
--- a/doxygen/examples/csvfilter_color.xml
+++ b/doxygen/examples/csvfilter_color.xml
@@ -1,17 +1,12 @@
<div class="fragment">
-<!-- Generator: GNU source-highlight 3.1.8
+<!-- Generator: GNU source-highlight 3.1.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><b><font color="#0000FF"><Observer></font></b>
<b><font color="#0000FF"><Filter4</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"CSVFilter"</font><b><font color="#0000FF">></font></b>
- <b><font color="#0000FF"><filename></font></b>
- sanyo.csv
- <b><font color="#0000FF"></filename></font></b>
- <b><font color="#0000FF"><printHeader></font></b> 1 <b><font color="#0000FF"></printHeader></font></b>
+ <b><font color="#0000FF"><Filename></font></b>sanyo.csv<b><font color="#0000FF"></Filename></font></b>
+ <b><font color="#0000FF"><printHeader></font></b>true<b><font color="#0000FF"></printHeader></font></b>
<b><font color="#0000FF"></Filter4></font></b>
-<b><font color="#0000FF"></Observer></font></b>
-
-
-</tt></pre>
+<b><font color="#0000FF"></Observer></font></b></tt></pre>
</div>
diff --git a/doxygen/examples/expression_obj.xml b/doxygen/examples/expression_obj.xml
new file mode 100644
index 0000000000000000000000000000000000000000..d3424ace6e44c6fb5f4539dbe038cce30b2cd22b
--- /dev/null
+++ b/doxygen/examples/expression_obj.xml
@@ -0,0 +1,7 @@
+<Object class="ExpressionObj">
+ <Expression>Soc / 2 + T / 3</Expression>
+ <Parameters>
+ <Param cacheref="Soc"/>
+ <Param cacheref="ThermalState" name="T"/>
+ </Parameters>
+</Object>
\ No newline at end of file
diff --git a/doxygen/examples/expression_obj_color.xml b/doxygen/examples/expression_obj_color.xml
new file mode 100644
index 0000000000000000000000000000000000000000..9f25ef452b00421c23d4d2cbf5a70e7a34d0bc7e
--- /dev/null
+++ b/doxygen/examples/expression_obj_color.xml
@@ -0,0 +1,13 @@
+<div class="fragment">
+<!-- Generator: GNU source-highlight 3.1.9
+by Lorenzo Bettini
+http://www.lorenzobettini.it
+http://www.gnu.org/software/src-highlite -->
+<pre><tt><b><font color="#0000FF"><Object</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"ExpressionObj"</font><b><font color="#0000FF">></font></b>
+ <b><font color="#0000FF"><Expression></font></b>Soc / 2 + T / 3<b><font color="#0000FF"></Expression></font></b>
+ <b><font color="#0000FF"><Parameters></font></b>
+ <b><font color="#0000FF"><Param</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"Soc"</font><b><font color="#0000FF">/></font></b>
+ <b><font color="#0000FF"><Param</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"ThermalState"</font> <font color="#009900">name</font><font color="#990000">=</font><font color="#FF0000">"T"</font><b><font color="#0000FF">/></font></b>
+ <b><font color="#0000FF"></Parameters></font></b>
+<b><font color="#0000FF"></Object></font></b></tt></pre>
+</div>
diff --git a/doxygen/examples/filterChain.xml b/doxygen/examples/filterChain.xml
index 295a139642b4f3ec3a8de78a4c2fe78e43552a14..5d34fd43f515be15f5e3db291d2ab94e75f54c80 100644
--- a/doxygen/examples/filterChain.xml
+++ b/doxygen/examples/filterChain.xml
@@ -1,8 +1,8 @@
<Observer>
<Filter1 class="MatlabFilter">
- <filename>
+ <Filename>
sanyo.mat
- </filename>
+ </Filename>
</Filter1>
<Filter2 class="DecimateFilter">
@@ -11,13 +11,13 @@
</TimeDelay>
</Filter2>
- <Filter3 class="StdOutFilter"/>
+ <Filter3 class="StdoutFilter"/>
<Filter4 class="CSVFilter">
- <filename>
+ <Filename>
sanyo.csv
- </filename>
- <printHeader> 1 </printHeader>
+ </Filename>
+ <printHeader>true</printHeader>
</Filter4>
</Observer>
diff --git a/doxygen/examples/filterChain_color.xml b/doxygen/examples/filterChain_color.xml
index 10530a4b06c583883573f6caab8a37f20c6632d0..14490211e87a7d2b028064ff23fc216456c55d87 100644
--- a/doxygen/examples/filterChain_color.xml
+++ b/doxygen/examples/filterChain_color.xml
@@ -1,13 +1,13 @@
<div class="fragment">
-<!-- Generator: GNU source-highlight 3.1.8
+<!-- Generator: GNU source-highlight 3.1.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><b><font color="#0000FF"><Observer></font></b>
<b><font color="#0000FF"><Filter1</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"MatlabFilter"</font><b><font color="#0000FF">></font></b>
- <b><font color="#0000FF"><filename></font></b>
+ <b><font color="#0000FF"><Filename></font></b>
sanyo.mat
- <b><font color="#0000FF"></filename></font></b>
+ <b><font color="#0000FF"></Filename></font></b>
<b><font color="#0000FF"></Filter1></font></b>
<b><font color="#0000FF"><Filter2</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"DecimateFilter"</font><b><font color="#0000FF">></font></b>
@@ -16,13 +16,13 @@ http://www.gnu.org/software/src-highlite -->
<b><font color="#0000FF"></TimeDelay></font></b>
<b><font color="#0000FF"></Filter2></font></b>
- <b><font color="#0000FF"><Filter3</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"StdOutFilter"</font><b><font color="#0000FF">/></font></b>
+ <b><font color="#0000FF"><Filter3</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"StdoutFilter"</font><b><font color="#0000FF">/></font></b>
<b><font color="#0000FF"><Filter4</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"CSVFilter"</font><b><font color="#0000FF">></font></b>
- <b><font color="#0000FF"><filename></font></b>
+ <b><font color="#0000FF"><Filename></font></b>
sanyo.csv
- <b><font color="#0000FF"></filename></font></b>
- <b><font color="#0000FF"><printHeader></font></b> 1 <b><font color="#0000FF"></printHeader></font></b>
+ <b><font color="#0000FF"></Filename></font></b>
+ <b><font color="#0000FF"><printHeader></font></b>true<b><font color="#0000FF"></printHeader></font></b>
<b><font color="#0000FF"></Filter4></font></b>
<b><font color="#0000FF"></Observer></font></b>
diff --git a/doxygen/examples/matlabFilter.xml b/doxygen/examples/matlabFilter.xml
index 52fa83cf24a0469b9510af0b3bcb6091c9dc960f..e9bf6a176f6cdb0705689a25c572820d5dac8d3a 100644
--- a/doxygen/examples/matlabFilter.xml
+++ b/doxygen/examples/matlabFilter.xml
@@ -1,11 +1,11 @@
<Observer>
<Filter1 class="MatlabFilter">
- <filename>
+ <Filename>
sanyo.mat
- </filename>
- <maxSampleSize>
+ </Filename>
+ <MaxSampleSize>
10000
- </maxSampleSize>
+ </MaxSampleSize>
</Filter1>
</Observer>
diff --git a/doxygen/examples/matlabFilter_color.xml b/doxygen/examples/matlabFilter_color.xml
index 32e7d9f7a6e4b6de3c936e10bcd3263cfaeeb772..2858e3ae8477f77411da165d6c7be8086c2240d1 100644
--- a/doxygen/examples/matlabFilter_color.xml
+++ b/doxygen/examples/matlabFilter_color.xml
@@ -1,16 +1,16 @@
<div class="fragment">
-<!-- Generator: GNU source-highlight 3.1.8
+<!-- Generator: GNU source-highlight 3.1.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><b><font color="#0000FF"><Observer></font></b>
<b><font color="#0000FF"><Filter1</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"MatlabFilter"</font><b><font color="#0000FF">></font></b>
- <b><font color="#0000FF"><filename></font></b>
+ <b><font color="#0000FF"><Filename></font></b>
sanyo.mat
- <b><font color="#0000FF"></filename></font></b>
- <b><font color="#0000FF"><maxSampleSize></font></b>
+ <b><font color="#0000FF"></Filename></font></b>
+ <b><font color="#0000FF"><MaxSampleSize></font></b>
10000
- <b><font color="#0000FF"></maxSampleSize></font></b>
+ <b><font color="#0000FF"></MaxSampleSize></font></b>
<b><font color="#0000FF"></Filter1></font></b>
<b><font color="#0000FF"></Observer></font></b>
diff --git a/doxygen/examples/object_cacheref.xml b/doxygen/examples/object_cacheref.xml
new file mode 100644
index 0000000000000000000000000000000000000000..bdd4b6a4a9bfa49b2f7e4531c5ae5aff89f8f40b
--- /dev/null
+++ b/doxygen/examples/object_cacheref.xml
@@ -0,0 +1,34 @@
+<Cell class="CellElement">
+ <!-- Because the cache attribute is set to "true", the state object will be added to the cache under the name "Soc" -->
+ <Soc class="Soc" cache="true">
+ <InitialCapacity>10.0</InitialCapacity>
+ <InitialSoc>50.0</InitialSoc>
+ </Soc>
+
+ <!-- Similarly, this will be cached as "ThermalState" -->
+ <ThermalState cache="true">
+ <InitialTemperature>25.0</InitialTemperature>
+ </ThermalState>
+
+ <Children>
+ <!-- copy the Resistance element from below -->
+ <Resistance ref="Resistance"/>
+ </Children>
+</Cell>
+
+<Resistance class="OhmicResistance">
+ <Object class="LookupObj2dWithState">
+ <!-- Reference to the caced soc state of the cell -->
+ <RowState cacheref="Soc"/>
+ <!-- Reference to the caced thermal state of the cell -->
+ <ColState cacheref="ThermalState"/>
+ <LookupData>
+ 1.0, 1.1, 1.0;
+ 1.2, 1.1, 1.3;
+ </LookupData>
+ <!-- SOC values that the three columns were measured at -->
+ </MeasurementPointsRow>10, 50, 90</MeasurementPointsRow>
+ <!-- temperature values that the two rows were measured at -->
+ </MeasurementPointsColumn>20, 25</MeasurementPointsColumn>
+ </Object>
+</Resistance>
\ No newline at end of file
diff --git a/doxygen/examples/object_cacheref_color.xml b/doxygen/examples/object_cacheref_color.xml
new file mode 100644
index 0000000000000000000000000000000000000000..4dc1157db35e39d9eeaa2fefa977f6560a02ed7d
--- /dev/null
+++ b/doxygen/examples/object_cacheref_color.xml
@@ -0,0 +1,40 @@
+<div class="fragment">
+<!-- Generator: GNU source-highlight 3.1.8
+by Lorenzo Bettini
+http://www.lorenzobettini.it
+http://www.gnu.org/software/src-highlite -->
+<pre><tt><b><font color="#0000FF"><Cell</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"CellElement"</font><b><font color="#0000FF">></font></b>
+ <i><font color="#9A1900"><!-- Because the cache attribute is set to "true", the state object will be added to the cache under the name "Soc" --></font></i>
+ <b><font color="#0000FF"><Soc</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"Soc"</font> <font color="#009900">cache</font><font color="#990000">=</font><font color="#FF0000">"true"</font><b><font color="#0000FF">></font></b>
+ <b><font color="#0000FF"><InitialCapacity></font></b>10.0<b><font color="#0000FF"></InitialCapacity></font></b>
+ <b><font color="#0000FF"><InitialSoc></font></b>50.0<b><font color="#0000FF"></InitialSoc></font></b>
+ <b><font color="#0000FF"></Soc></font></b>
+
+ <i><font color="#9A1900"><!-- Similarly, this will be cached as "ThermalState" --></font></i>
+ <b><font color="#0000FF"><ThermalState</font></b> <font color="#009900">cache</font><font color="#990000">=</font><font color="#FF0000">"true"</font><b><font color="#0000FF">></font></b>
+ <b><font color="#0000FF"><InitialTemperature></font></b>25.0<b><font color="#0000FF"></InitialTemperature></font></b>
+ <b><font color="#0000FF"></ThermalState></font></b>
+
+ <b><font color="#0000FF"><Children></font></b>
+ <i><font color="#9A1900"><!-- copy the Resistance element from below --></font></i>
+ <b><font color="#0000FF"><Resistance</font></b> <font color="#009900">ref</font><font color="#990000">=</font><font color="#FF0000">"Resistance"</font><b><font color="#0000FF">/></font></b>
+ <b><font color="#0000FF"></Children></font></b>
+<b><font color="#0000FF"></Cell></font></b>
+
+<b><font color="#0000FF"><Resistance</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"OhmicResistance"</font><b><font color="#0000FF">></font></b>
+ <b><font color="#0000FF"><Object</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"LookupObj2dWithState"</font><b><font color="#0000FF">></font></b>
+ <i><font color="#9A1900"><!-- Reference to the caced soc state of the cell --></font></i>
+ <b><font color="#0000FF"><RowState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"Soc"</font><b><font color="#0000FF">/></font></b>
+ <i><font color="#9A1900"><!-- Reference to the caced thermal state of the cell --></font></i>
+ <b><font color="#0000FF"><ColState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"ThermalState"</font><b><font color="#0000FF">/></font></b>
+ <b><font color="#0000FF"><LookupData></font></b>
+ 1.0, 1.1, 1.0;
+ 1.2, 1.1, 1.3;
+ <b><font color="#0000FF"></LookupData></font></b>
+ <i><font color="#9A1900"><!-- SOC values that the three columns were measured at --></font></i>
+ <b><font color="#0000FF"></MeasurementPointsRow></font></b>10, 50, 90<b><font color="#0000FF"></MeasurementPointsRow></font></b>
+ <i><font color="#9A1900"><!-- temperature values that the two rows were measured at --></font></i>
+ <b><font color="#0000FF"></MeasurementPointsColumn></font></b>20, 25<b><font color="#0000FF"></MeasurementPointsColumn></font></b>
+ <b><font color="#0000FF"></Object></font></b>
+<b><font color="#0000FF"></Resistance></font></b></tt></pre>
+</div>
diff --git a/doxygen/examples/socstate.xml b/doxygen/examples/socstate.xml
index 90bc82073e4a32f45d82559971de0086db8c0e68..98b49932acb13abb9edbb549d7dcbd31c1eb1022 100644
--- a/doxygen/examples/socstate.xml
+++ b/doxygen/examples/socstate.xml
@@ -1,5 +1,4 @@
<Soc class="Soc" cache="True">
<InitialCapacity> ... </InitialCapacity>
<InitialSoc> ... </InitialSoc>
- <MeasurementPoints> ... </MeasurementPoints>
</Soc>
diff --git a/doxygen/examples/socstate_color.xml b/doxygen/examples/socstate_color.xml
index ea9fd0e154b40493ce2c49a5a083e41e7d737cc9..b6bab905a132fdfb96e4ca3d240ad37b285943cb 100644
--- a/doxygen/examples/socstate_color.xml
+++ b/doxygen/examples/socstate_color.xml
@@ -6,7 +6,6 @@ http://www.gnu.org/software/src-highlite -->
<pre><tt><b><font color="#0000FF"><Soc</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"Soc"</font> <font color="#009900">cache</font><font color="#990000">=</font><font color="#FF0000">"True"</font><b><font color="#0000FF">></font></b>
<b><font color="#0000FF"><InitialCapacity></font></b> ... <b><font color="#0000FF"></InitialCapacity></font></b>
<b><font color="#0000FF"><InitialSoc></font></b> ... <b><font color="#0000FF"></InitialSoc></font></b>
- <b><font color="#0000FF"><MeasurementPoints></font></b> ... <b><font color="#0000FF"></MeasurementPoints></font></b>
<b><font color="#0000FF"></Soc></font></b>
</tt></pre>
</div>
diff --git a/doxygen/examples/stdoutfilter.xml b/doxygen/examples/stdoutfilter.xml
index 282e3a239482640ca7324e735b9e92d0892257eb..258c39c7d268c3c34b850006a50b6a2aa418f0f1 100644
--- a/doxygen/examples/stdoutfilter.xml
+++ b/doxygen/examples/stdoutfilter.xml
@@ -1,3 +1,3 @@
<Observer>
- <Filter3 class="StdOutFilter"/>
+ <Filter3 class="StdoutFilter"/>
</Observer>
diff --git a/doxygen/examples/stdoutfilter_color.xml b/doxygen/examples/stdoutfilter_color.xml
index faed4328f052baff6582eb3e299436c0b69634f9..d415478cab064cf68693a98fe4556a0517b50037 100644
--- a/doxygen/examples/stdoutfilter_color.xml
+++ b/doxygen/examples/stdoutfilter_color.xml
@@ -1,10 +1,10 @@
<div class="fragment">
-<!-- Generator: GNU source-highlight 3.1.8
+<!-- Generator: GNU source-highlight 3.1.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><b><font color="#0000FF"><Observer></font></b>
- <b><font color="#0000FF"><Filter3</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"StdOutFilter"</font><b><font color="#0000FF">/></font></b>
+ <b><font color="#0000FF"><Filter3</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"StdoutFilter"</font><b><font color="#0000FF">/></font></b>
<b><font color="#0000FF"></Observer></font></b>
</tt></pre>
</div>
diff --git a/doxygen/examples/testconfig.xml b/doxygen/examples/testconfig.xml
index 21137e25fc453da562d14bd54119ceece89bb0a2..7fdea25c363a0ab7362f28c3386903e1977d19d4 100644
--- a/doxygen/examples/testconfig.xml
+++ b/doxygen/examples/testconfig.xml
@@ -1,35 +1,31 @@
<?xml version="1.0" encoding="UTF-8"?>
<Configuration>
<Options>
- <SampleRate> 100000000 </SampleRate> <!-- Die SampleRate gibt an, ab welcher Frequenz Vereinfachungen durchgeführt werden f_s < SampleRate => Modellvereinfachen -->
- <MaxStateSize> 1000 </MaxStateSize> <!-- Die maximale Größe des Statevektors in Simulink -->
- <MaxOutputSize> 1000 </MaxOutputSize> <!-- Die maximale Größe des Outputvektors in Simulink-->
+ <SampleRate> 100000000 </SampleRate> <!-- The sample rate determines for which frequencies simplifactions are done: f_s < sample rate => simplify model -->
</Options>
<!--
- In Observer sind die Filter für die Ausgabe des Modells definiert.
- Es können mehrere Filter definiert werden, diesen werden dann sequentiell abgearbeitet.
- Für Simulink werden die Filter ignoriert.
+ Observer constains definitions of filters for the simulation output.
+ Multiple filters can be defined that will be executed sequentially.
-->
<Observer>
- <Filter class="MatlabFilter">
- <filename>
- sanyo.mat
- </filename>
- </Filter>
+ <Electrical>
+ <Filter class="MatlabFilter">
+ <Filename>output.mat</Filename>
+ </Filter>
+ </Electrical>
</Observer>
<!--
- Hier werden genutzte Bauelemente und Verschaltugen definiert
- Dieser Teil kann als Bibliothek angesehen werden in dem genutzte Elemente definiert und später verwendet werden
+ Elements are defined here to be used later. This part of the XML file can be regarded as a library of elements that cen be used in the model.
-->
<CustomDefinitions>
<!--
- Ein Ohmscher Widerstand, der von Temperatur und SOC abhängig ist. Dieser wird als 2D Lookup hinterlegt
+ An ohmic resistance that is dependend on temperature and SOC. The dependency is given as a 2D lookup table.
-->
<Rser class="OhmicResistance">
@@ -51,7 +47,7 @@
</Rser>
<!--
- Eine OCV, die von Temperatur und SOC abhängig ist als 2D Lookup
+ An OCV that depends on temperature and SOC
-->
<OCV class="VoltageSource">
@@ -70,18 +66,17 @@
</OCV>
<!--
- Eine Liste von Zarc Elementen die im elektrischen Ersatzschaltbild genutzt wird.
+ A number of zarc elements that are used in the ECM.
R / ( 1 + (R*C)^phi)
- Die Parameter sind abhängig von Temperatur und Temperatur
-->
- <Zarc1 class="ZarcElement">
- <ThermalState cacheref="ThermalState"/>
- <Soc cacheref="Soc"/>
- <LookupTau class="LookupObj2DWithState">
- <RowState cacheref="ThermalState"/>
- <ColState cacheref="Soc"/>
- <LookupData>
+ <Zarc1 class="ZarcElement">
+ <ThermalState cacheref="ThermalState"/>
+ <Soc cacheref="Soc"/>
+ <LookupTau class="LookupObj2DWithState">
+ <RowState cacheref="ThermalState"/>
+ <ColState cacheref="Soc"/>
+ <LookupData>
1.12980227037822e-01, 1.71749789914134e-01, 4.27878577005388e-01, 4.70584769553997e-01;
2.88029269499999e-01, 2.03069924403468e-01, 7.59434298204209e-02, 5.38248547348156e-02;
1.80149147116020e-01, 1.12630469688383e-01, 3.52185854766679e-02, 2.98230802877780e-02;
@@ -89,14 +84,14 @@
1.32900242338032e-01, 7.22938740353130e-02, 2.05480235442034e-02, 9.95886997764575e-02;
1.19852623435413e-01, 6.56657395160509e-02, 2.36971844841798e-02, 1.02914420936082e-01;
1.18273000586515e-01, 6.60491071602289e-02, 3.25921294643322e-02, 1.09197268465146e-01;
- </LookupData>
- <MeasurementPointsRow>0, 10, 23, 50</MeasurementPointsRow>
- <MeasurementPointsColumn>5, 20, 35, 50, 65, 80, 90</MeasurementPointsColumn>
- </LookupTau>
- <LookupOhmicResistance class="LookupObj2DWithState">
- <RowState cacheref="ThermalState"/>
- <ColState cacheref="Soc"/>
- <LookupData>
+ </LookupData>
+ <MeasurementPointsRow>0, 10, 23, 50</MeasurementPointsRow>
+ <MeasurementPointsColumn>5, 20, 35, 50, 65, 80, 90</MeasurementPointsColumn>
+ </LookupTau>
+ <LookupOhmicResistance class="LookupObj2DWithState">
+ <RowState cacheref="ThermalState"/>
+ <ColState cacheref="Soc"/>
+ <LookupData>
0.0264994082415437, 0.0264994082415437, 0.0264994082415437, 0.0299913094135788;
0.0675569999999998, 0.0313318160740531, 0.0127731516995969, 0.00404164451684630;
0.0536386688114087, 0.0248200664672378, 0.00989750001969683, 0.00303781463624295;
@@ -104,14 +99,14 @@
0.0441171340633137, 0.0206405039153971, 0.00794555485936455, 0.00454415109298745;
0.0418986584966986, 0.0203278573267527, 0.00866505912064747, 0.00344848953405180;
0.0421316495020664, 0.0207584663601899, 0.0102011087727835, 0.00296383805146105;
- </LookupData>
- <MeasurementPointsRow>0, 10, 23, 50</MeasurementPointsRow>
- <MeasurementPointsColumn>5, 20, 35, 50, 65, 80, 90</MeasurementPointsColumn>
- </LookupOhmicResistance>
- <LookupPhi class="LookupObj2DWithState">
- <RowState cacheref="ThermalState"/>
- <ColState cacheref="Soc"/>
- <LookupData>
+ </LookupData>
+ <MeasurementPointsRow>0, 10, 23, 50</MeasurementPointsRow>
+ <MeasurementPointsColumn>5, 20, 35, 50, 65, 80, 90</MeasurementPointsColumn>
+ </LookupOhmicResistance>
+ <LookupPhi class="LookupObj2DWithState">
+ <RowState cacheref="ThermalState"/>
+ <ColState cacheref="Soc"/>
+ <LookupData>
0.574590000000000, 0.516891694022437, 0.408379079339744, 0.110443124808620;
0.574590000000000, 0.516891694022437, 0.568073405078093, 0.566435038531618;
0.616859078283881, 0.579111165549142, 0.662374262351899, 0.620812008168125;
@@ -119,19 +114,19 @@
0.621586176902636, 0.620972340223097, 0.721715387830978, 0.323239015612757;
0.620607929391110, 0.630419920219851, 0.671002168217511, 0.371661290927877;
0.620534462894923, 0.628465004550853, 0.585312180039373, 0.410302314031108;
- </LookupData>
- <MeasurementPointsRow>0, 10, 23, 50</MeasurementPointsRow>
- <MeasurementPointsColumn>5, 20, 35, 50, 65, 80, 90</MeasurementPointsColumn>
- </LookupPhi>
- </Zarc1>
-
- <Zarc2 class="ZarcElement">
- <ThermalState cacheref="ThermalState"/>
- <Soc cacheref="Soc"/>
- <LookupTau class="LookupObj2DWithState">
- <RowState cacheref="ThermalState"/>
- <ColState cacheref="Soc"/>
- <LookupData>
+ </LookupData>
+ <MeasurementPointsRow>0, 10, 23, 50</MeasurementPointsRow>
+ <MeasurementPointsColumn>5, 20, 35, 50, 65, 80, 90</MeasurementPointsColumn>
+ </LookupPhi>
+ </Zarc1>
+
+ <Zarc2 class="ZarcElement">
+ <ThermalState cacheref="ThermalState"/>
+ <Soc cacheref="Soc"/>
+ <LookupTau class="LookupObj2DWithState">
+ <RowState cacheref="ThermalState"/>
+ <ColState cacheref="Soc"/>
+ <LookupData>
7.18995948733622e+01, 7.18995948733622e+01, 7.18995948733622e+01, 1.72014439980198e+02;
1.06291852663799e+02, 6.72360031885497e+01, 2.25315701158008e+01, 1.24381452400449e+01;
8.51369323682503e+01, 7.96790294643858e+01, 4.06553583608283e+01, 1.39605547315769e+01;
@@ -139,14 +134,14 @@
2.09612418598535e+01, 2.05572641277478e+01, 1.30382153158531e+01, 8.83888257496744e+00;
2.91126500497086e+01, 1.79756822658049e+01, 1.00747391004287e+01, 7.40983806343882e+00;
1.61252822647543e+01, 1.05500749096217e+01, 8.03484722536149e+00, 5.90166478298738e+00;
- </LookupData>
- <MeasurementPointsRow>0, 10, 23, 50</MeasurementPointsRow>
- <MeasurementPointsColumn>5, 20, 35, 50, 65, 80, 90</MeasurementPointsColumn>
- </LookupTau>
- <LookupOhmicResistance class="LookupObj2DWithState">
- <RowState cacheref="ThermalState"/>
- <ColState cacheref="Soc"/>
- <LookupData>
+ </LookupData>
+ <MeasurementPointsRow>0, 10, 23, 50</MeasurementPointsRow>
+ <MeasurementPointsColumn>5, 20, 35, 50, 65, 80, 90</MeasurementPointsColumn>
+ </LookupTau>
+ <LookupOhmicResistance class="LookupObj2DWithState">
+ <RowState cacheref="ThermalState"/>
+ <ColState cacheref="Soc"/>
+ <LookupData>
0.0422632965521782, 0.0422632965521782, 0.0422632965521782, 0.0646154311756893;
0.0122909999999999, 0.00820305593966980, 0.00584662021670523, 0.00383743519303631;
0.0322225070656886, 0.0289438148360227, 0.0225495908462913, 0.00599634893454420;
@@ -154,14 +149,14 @@
0.0157426548912461, 0.0171684201770746, 0.0134953332473813, 0.00457332312382527;
0.0218280618476754, 0.0131225853688649, 0.00741527720123879, 0.00329020951414971;
0.0153521701301020, 0.00846967601820038, 0.00563955480281332, 0.00315825717209717;
- </LookupData>
- <MeasurementPointsRow>0, 10, 23, 50</MeasurementPointsRow>
- <MeasurementPointsColumn>5, 20, 35, 50, 65, 80, 90</MeasurementPointsColumn>
- </LookupOhmicResistance>
- <LookupPhi class="LookupObj2DWithState">
- <RowState cacheref="ThermalState"/>
- <ColState cacheref="Soc"/>
- <LookupData>
+ </LookupData>
+ <MeasurementPointsRow>0, 10, 23, 50</MeasurementPointsRow>
+ <MeasurementPointsColumn>5, 20, 35, 50, 65, 80, 90</MeasurementPointsColumn>
+ </LookupOhmicResistance>
+ <LookupPhi class="LookupObj2DWithState">
+ <RowState cacheref="ThermalState"/>
+ <ColState cacheref="Soc"/>
+ <LookupData>
1, 0.957683980942010, 0.762474540690386, 0.810166837787303;
1, 0.957683980942010, 0.837851589303327, 0.826206919812180;
0.806534226878276, 0.755415801951905, 0.630228467428149, 0.686969202518359;
@@ -169,19 +164,20 @@
0.791964147404381, 0.697353484425094, 0.628110619592649, 0.801166605326404;
0.759343341643463, 0.720390317831926, 0.755733232495091, 0.938336421996388;
0.790468798628622, 0.797350100822233, 0.852903199927494, 0.986742576117900;
- </LookupData>
- <MeasurementPointsRow>0, 10, 23, 50</MeasurementPointsRow>
- <MeasurementPointsColumn>5, 20, 35, 50, 65, 80, 90</MeasurementPointsColumn>
- </LookupPhi>
- </Zarc2>
+ </LookupData>
+ <MeasurementPointsRow>0, 10, 23, 50</MeasurementPointsRow>
+ <MeasurementPointsColumn>5, 20, 35, 50, 65, 80, 90</MeasurementPointsColumn>
+ </LookupPhi>
+ </Zarc2>
<!--
- Vordefiniertes Zellelement einer Lithium-Ionen Batterie.
- Standarmäßig besteht ein Zellelement aus einem ohmschen Serienwiderstand, einer OCV, und einer Liste von ZarcElementen.
- Die Elemente sind dabei jeweils von den States Temperatur und State of Charge abhängig.
- Temperatur stellt die anfängliche Temperatur in °C dar.
- SOC benötigt eine nominale Kapazität, einen anfänglichen SOC in % sowie die Diskretisierung.
+ This represents a cell of a lithium ion battery.
+ The cell consists of the previously defined elements that are dependent on the cell's temperature and SOC.
+ Die Elemente sind dabei jeweils von den States Temperatur und State of Charge abhängig.
+ The initial temperature is given as a value in °C.
+ SOC benötigt eine nominale Kapazität, einen anfänglichen SOC in % sowie die Diskretisierung.
+ For the SOC we need the initial value in percent as well as the initial cell capacity in Ah.
-->
<MyCellElement1 class="CellElement" observable="True">
@@ -192,7 +188,6 @@
<Soc class="Soc" cache="True">
<InitialCapacity>2.05</InitialCapacity>
<InitialSoc>55</InitialSoc>
- <MeasurementPoints>5, 10, 20, 23, 35, 50, 65, 80, 90</MeasurementPoints>
</Soc>
<Children>
<OhmicResistance ref="Rser"/>
@@ -209,7 +204,6 @@
<Soc class="Soc" cache="True">
<InitialCapacity>2.05</InitialCapacity>
<InitialSoc>60</InitialSoc>
- <MeasurementPoints>5, 10, 20, 23, 35, 50, 65, 80, 90</MeasurementPoints>
</Soc>
<Children>
<OhmicResistance ref="Rser"/>
@@ -220,8 +214,7 @@
</MyCellElement2>
<!--
- Beispielverschaltung zwei parallelen Batterien (Pack) welche jeweils in einem String, bestehend aus einer
- Serienschaltung von zwei Packs besteht.
+ Example parallel connection of cells. Because count is set to 2, each child is added twice, resulting in 4 parallel cells.
-->
<NormalBatteryPack class="ParallelTwoPort">
@@ -232,7 +225,7 @@
</NormalBatteryPack>
<!--
- Hier werden zwei Batterypacks(NormalBatteryPack) in Serie verschaltet
+ Connection of two packs in series
-->
<BatteryString class="SerialTwoPort">
<Children count="2">
@@ -243,8 +236,7 @@
</CustomDefinitions>
<!--
- Wurzelknoten des Systems.
- Dieses Batterienetzwerk wird in der Anwendung simuliert und besteht aus zwei Strings
+ Roo element of the electrical model that is simulated.
-->
<RootElement class="ParallelTwoPort">
diff --git a/doxygen/examples/testconfig_color.xml b/doxygen/examples/testconfig_color.xml
index 59e64a0e514691f357d56ae7ec138eba15cdc38b..7c1529c9945f1a9e26c5f7fa3fce976b01a51858 100644
--- a/doxygen/examples/testconfig_color.xml
+++ b/doxygen/examples/testconfig_color.xml
@@ -6,35 +6,31 @@ http://www.gnu.org/software/src-highlite -->
<pre><tt><b><font color="#000080"><?xml</font></b> <font color="#009900">version</font><font color="#990000">=</font><font color="#FF0000">"1.0"</font> <font color="#009900">encoding</font><font color="#990000">=</font><font color="#FF0000">"UTF-8"</font><b><font color="#000080">?></font></b>
<b><font color="#0000FF"><Configuration></font></b>
<b><font color="#0000FF"><Options></font></b>
- <b><font color="#0000FF"><SampleRate></font></b> 100000000 <b><font color="#0000FF"></SampleRate></font></b> <i><font color="#9A1900"><!-- Die SampleRate gibt an, ab welcher Frequenz Vereinfachungen durchgeführt werden f_s < SampleRate => Modellvereinfachen --></font></i>
- <b><font color="#0000FF"><MaxStateSize></font></b> 1000 <b><font color="#0000FF"></MaxStateSize></font></b> <i><font color="#9A1900"><!-- Die maximale Größe des Statevektors in Simulink --></font></i>
- <b><font color="#0000FF"><MaxOutputSize></font></b> 1000 <b><font color="#0000FF"></MaxOutputSize></font></b> <i><font color="#9A1900"><!-- Die maximale Größe des Outputvektors in Simulink--></font></i>
+ <b><font color="#0000FF"><SampleRate></font></b> 100000000 <b><font color="#0000FF"></SampleRate></font></b> <i><font color="#9A1900"><!-- The sample rate determines for which frequencies simplifactions are done: f_s < sample rate => simplify model --></font></i>
<b><font color="#0000FF"></Options></font></b>
<i><font color="#9A1900"><!--</font></i>
-<i><font color="#9A1900"> In Observer sind die Filter für die Ausgabe des Modells definiert.</font></i>
-<i><font color="#9A1900"> Es können mehrere Filter definiert werden, diesen werden dann sequentiell abgearbeitet.</font></i>
-<i><font color="#9A1900"> Für Simulink werden die Filter ignoriert.</font></i>
+<i><font color="#9A1900"> Observer constains definitions of filters for the simulation output.</font></i>
+<i><font color="#9A1900"> Multiple filters can be defined that will be executed sequentially.</font></i>
<i><font color="#9A1900"> --></font></i>
<b><font color="#0000FF"><Observer></font></b>
- <b><font color="#0000FF"><Filter</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"MatlabFilter"</font><b><font color="#0000FF">></font></b>
- <b><font color="#0000FF"><filename></font></b>
- sanyo.mat
- <b><font color="#0000FF"></filename></font></b>
- <b><font color="#0000FF"></Filter></font></b>
+ <b><font color="#0000FF"><Electrical></font></b>
+ <b><font color="#0000FF"><Filter</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"MatlabFilter"</font><b><font color="#0000FF">></font></b>
+ <b><font color="#0000FF"><Filename></font></b>output.mat<b><font color="#0000FF"></Filename></font></b>
+ <b><font color="#0000FF"></Filter></font></b>
+ <b><font color="#0000FF"></Electrical></font></b>
<b><font color="#0000FF"></Observer></font></b>
<i><font color="#9A1900"><!--</font></i>
-<i><font color="#9A1900"> Hier werden genutzte Bauelemente und Verschaltugen definiert</font></i>
-<i><font color="#9A1900"> Dieser Teil kann als Bibliothek angesehen werden in dem genutzte Elemente definiert und später verwendet werden </font></i>
+<i><font color="#9A1900"> Elements are defined here to be used later. This part of the XML file can be regarded as a library of elements that cen be used in the model.</font></i>
<i><font color="#9A1900"> --></font></i>
<b><font color="#0000FF"><CustomDefinitions></font></b>
<i><font color="#9A1900"><!--</font></i>
-<i><font color="#9A1900"> Ein Ohmscher Widerstand, der von Temperatur und SOC abhängig ist. Dieser wird als 2D Lookup hinterlegt </font></i>
+<i><font color="#9A1900"> An ohmic resistance that is dependend on temperature and SOC. The dependency is given as a 2D lookup table.</font></i>
<i><font color="#9A1900"> --></font></i>
<b><font color="#0000FF"><Rser</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"OhmicResistance"</font><b><font color="#0000FF">></font></b>
@@ -56,7 +52,7 @@ http://www.gnu.org/software/src-highlite -->
<b><font color="#0000FF"></Rser></font></b>
<i><font color="#9A1900"><!--</font></i>
-<i><font color="#9A1900"> Eine OCV, die von Temperatur und SOC abhängig ist als 2D Lookup</font></i>
+<i><font color="#9A1900"> An OCV that depends on temperature and SOC</font></i>
<i><font color="#9A1900"> --></font></i>
<b><font color="#0000FF"><OCV</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"VoltageSource"</font><b><font color="#0000FF">></font></b>
@@ -75,18 +71,17 @@ http://www.gnu.org/software/src-highlite -->
<b><font color="#0000FF"></OCV></font></b>
<i><font color="#9A1900"><!-- </font></i>
-<i><font color="#9A1900"> Eine Liste von Zarc Elementen die im elektrischen Ersatzschaltbild genutzt wird.</font></i>
+<i><font color="#9A1900"> A number of zarc elements that are used in the ECM.</font></i>
<i><font color="#9A1900"> R / ( 1 + (R*C)^phi)</font></i>
-<i><font color="#9A1900"> Die Parameter sind abhängig von Temperatur und Temperatur</font></i>
<i><font color="#9A1900"> --></font></i>
- <b><font color="#0000FF"><Zarc1</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"ZarcElement"</font><b><font color="#0000FF">></font></b>
- <b><font color="#0000FF"><ThermalState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"ThermalState"</font><b><font color="#0000FF">/></font></b>
- <b><font color="#0000FF"><Soc</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"Soc"</font><b><font color="#0000FF">/></font></b>
- <b><font color="#0000FF"><LookupTau</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"LookupObj2DWithState"</font><b><font color="#0000FF">></font></b>
- <b><font color="#0000FF"><RowState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"ThermalState"</font><b><font color="#0000FF">/></font></b>
- <b><font color="#0000FF"><ColState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"Soc"</font><b><font color="#0000FF">/></font></b>
- <b><font color="#0000FF"><LookupData></font></b>
+ <b><font color="#0000FF"><Zarc1</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"ZarcElement"</font><b><font color="#0000FF">></font></b>
+ <b><font color="#0000FF"><ThermalState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"ThermalState"</font><b><font color="#0000FF">/></font></b>
+ <b><font color="#0000FF"><Soc</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"Soc"</font><b><font color="#0000FF">/></font></b>
+ <b><font color="#0000FF"><LookupTau</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"LookupObj2DWithState"</font><b><font color="#0000FF">></font></b>
+ <b><font color="#0000FF"><RowState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"ThermalState"</font><b><font color="#0000FF">/></font></b>
+ <b><font color="#0000FF"><ColState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"Soc"</font><b><font color="#0000FF">/></font></b>
+ <b><font color="#0000FF"><LookupData></font></b>
1.12980227037822e-01, 1.71749789914134e-01, 4.27878577005388e-01, 4.70584769553997e-01;
2.88029269499999e-01, 2.03069924403468e-01, 7.59434298204209e-02, 5.38248547348156e-02;
1.80149147116020e-01, 1.12630469688383e-01, 3.52185854766679e-02, 2.98230802877780e-02;
@@ -94,14 +89,14 @@ http://www.gnu.org/software/src-highlite -->
1.32900242338032e-01, 7.22938740353130e-02, 2.05480235442034e-02, 9.95886997764575e-02;
1.19852623435413e-01, 6.56657395160509e-02, 2.36971844841798e-02, 1.02914420936082e-01;
1.18273000586515e-01, 6.60491071602289e-02, 3.25921294643322e-02, 1.09197268465146e-01;
- <b><font color="#0000FF"></LookupData></font></b>
- <b><font color="#0000FF"><MeasurementPointsRow></font></b>0, 10, 23, 50<b><font color="#0000FF"></MeasurementPointsRow></font></b>
- <b><font color="#0000FF"><MeasurementPointsColumn></font></b>5, 20, 35, 50, 65, 80, 90<b><font color="#0000FF"></MeasurementPointsColumn></font></b>
- <b><font color="#0000FF"></LookupTau></font></b>
- <b><font color="#0000FF"><LookupOhmicResistance</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"LookupObj2DWithState"</font><b><font color="#0000FF">></font></b>
- <b><font color="#0000FF"><RowState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"ThermalState"</font><b><font color="#0000FF">/></font></b>
- <b><font color="#0000FF"><ColState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"Soc"</font><b><font color="#0000FF">/></font></b>
- <b><font color="#0000FF"><LookupData></font></b>
+ <b><font color="#0000FF"></LookupData></font></b>
+ <b><font color="#0000FF"><MeasurementPointsRow></font></b>0, 10, 23, 50<b><font color="#0000FF"></MeasurementPointsRow></font></b>
+ <b><font color="#0000FF"><MeasurementPointsColumn></font></b>5, 20, 35, 50, 65, 80, 90<b><font color="#0000FF"></MeasurementPointsColumn></font></b>
+ <b><font color="#0000FF"></LookupTau></font></b>
+ <b><font color="#0000FF"><LookupOhmicResistance</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"LookupObj2DWithState"</font><b><font color="#0000FF">></font></b>
+ <b><font color="#0000FF"><RowState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"ThermalState"</font><b><font color="#0000FF">/></font></b>
+ <b><font color="#0000FF"><ColState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"Soc"</font><b><font color="#0000FF">/></font></b>
+ <b><font color="#0000FF"><LookupData></font></b>
0.0264994082415437, 0.0264994082415437, 0.0264994082415437, 0.0299913094135788;
0.0675569999999998, 0.0313318160740531, 0.0127731516995969, 0.00404164451684630;
0.0536386688114087, 0.0248200664672378, 0.00989750001969683, 0.00303781463624295;
@@ -109,14 +104,14 @@ http://www.gnu.org/software/src-highlite -->
0.0441171340633137, 0.0206405039153971, 0.00794555485936455, 0.00454415109298745;
0.0418986584966986, 0.0203278573267527, 0.00866505912064747, 0.00344848953405180;
0.0421316495020664, 0.0207584663601899, 0.0102011087727835, 0.00296383805146105;
- <b><font color="#0000FF"></LookupData></font></b>
- <b><font color="#0000FF"><MeasurementPointsRow></font></b>0, 10, 23, 50<b><font color="#0000FF"></MeasurementPointsRow></font></b>
- <b><font color="#0000FF"><MeasurementPointsColumn></font></b>5, 20, 35, 50, 65, 80, 90<b><font color="#0000FF"></MeasurementPointsColumn></font></b>
- <b><font color="#0000FF"></LookupOhmicResistance></font></b>
- <b><font color="#0000FF"><LookupPhi</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"LookupObj2DWithState"</font><b><font color="#0000FF">></font></b>
- <b><font color="#0000FF"><RowState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"ThermalState"</font><b><font color="#0000FF">/></font></b>
- <b><font color="#0000FF"><ColState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"Soc"</font><b><font color="#0000FF">/></font></b>
- <b><font color="#0000FF"><LookupData></font></b>
+ <b><font color="#0000FF"></LookupData></font></b>
+ <b><font color="#0000FF"><MeasurementPointsRow></font></b>0, 10, 23, 50<b><font color="#0000FF"></MeasurementPointsRow></font></b>
+ <b><font color="#0000FF"><MeasurementPointsColumn></font></b>5, 20, 35, 50, 65, 80, 90<b><font color="#0000FF"></MeasurementPointsColumn></font></b>
+ <b><font color="#0000FF"></LookupOhmicResistance></font></b>
+ <b><font color="#0000FF"><LookupPhi</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"LookupObj2DWithState"</font><b><font color="#0000FF">></font></b>
+ <b><font color="#0000FF"><RowState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"ThermalState"</font><b><font color="#0000FF">/></font></b>
+ <b><font color="#0000FF"><ColState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"Soc"</font><b><font color="#0000FF">/></font></b>
+ <b><font color="#0000FF"><LookupData></font></b>
0.574590000000000, 0.516891694022437, 0.408379079339744, 0.110443124808620;
0.574590000000000, 0.516891694022437, 0.568073405078093, 0.566435038531618;
0.616859078283881, 0.579111165549142, 0.662374262351899, 0.620812008168125;
@@ -124,19 +119,19 @@ http://www.gnu.org/software/src-highlite -->
0.621586176902636, 0.620972340223097, 0.721715387830978, 0.323239015612757;
0.620607929391110, 0.630419920219851, 0.671002168217511, 0.371661290927877;
0.620534462894923, 0.628465004550853, 0.585312180039373, 0.410302314031108;
- <b><font color="#0000FF"></LookupData></font></b>
- <b><font color="#0000FF"><MeasurementPointsRow></font></b>0, 10, 23, 50<b><font color="#0000FF"></MeasurementPointsRow></font></b>
- <b><font color="#0000FF"><MeasurementPointsColumn></font></b>5, 20, 35, 50, 65, 80, 90<b><font color="#0000FF"></MeasurementPointsColumn></font></b>
- <b><font color="#0000FF"></LookupPhi></font></b>
- <b><font color="#0000FF"></Zarc1></font></b>
-
- <b><font color="#0000FF"><Zarc2</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"ZarcElement"</font><b><font color="#0000FF">></font></b>
- <b><font color="#0000FF"><ThermalState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"ThermalState"</font><b><font color="#0000FF">/></font></b>
- <b><font color="#0000FF"><Soc</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"Soc"</font><b><font color="#0000FF">/></font></b>
- <b><font color="#0000FF"><LookupTau</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"LookupObj2DWithState"</font><b><font color="#0000FF">></font></b>
- <b><font color="#0000FF"><RowState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"ThermalState"</font><b><font color="#0000FF">/></font></b>
- <b><font color="#0000FF"><ColState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"Soc"</font><b><font color="#0000FF">/></font></b>
- <b><font color="#0000FF"><LookupData></font></b>
+ <b><font color="#0000FF"></LookupData></font></b>
+ <b><font color="#0000FF"><MeasurementPointsRow></font></b>0, 10, 23, 50<b><font color="#0000FF"></MeasurementPointsRow></font></b>
+ <b><font color="#0000FF"><MeasurementPointsColumn></font></b>5, 20, 35, 50, 65, 80, 90<b><font color="#0000FF"></MeasurementPointsColumn></font></b>
+ <b><font color="#0000FF"></LookupPhi></font></b>
+ <b><font color="#0000FF"></Zarc1></font></b>
+
+ <b><font color="#0000FF"><Zarc2</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"ZarcElement"</font><b><font color="#0000FF">></font></b>
+ <b><font color="#0000FF"><ThermalState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"ThermalState"</font><b><font color="#0000FF">/></font></b>
+ <b><font color="#0000FF"><Soc</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"Soc"</font><b><font color="#0000FF">/></font></b>
+ <b><font color="#0000FF"><LookupTau</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"LookupObj2DWithState"</font><b><font color="#0000FF">></font></b>
+ <b><font color="#0000FF"><RowState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"ThermalState"</font><b><font color="#0000FF">/></font></b>
+ <b><font color="#0000FF"><ColState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"Soc"</font><b><font color="#0000FF">/></font></b>
+ <b><font color="#0000FF"><LookupData></font></b>
7.18995948733622e+01, 7.18995948733622e+01, 7.18995948733622e+01, 1.72014439980198e+02;
1.06291852663799e+02, 6.72360031885497e+01, 2.25315701158008e+01, 1.24381452400449e+01;
8.51369323682503e+01, 7.96790294643858e+01, 4.06553583608283e+01, 1.39605547315769e+01;
@@ -144,14 +139,14 @@ http://www.gnu.org/software/src-highlite -->
2.09612418598535e+01, 2.05572641277478e+01, 1.30382153158531e+01, 8.83888257496744e+00;
2.91126500497086e+01, 1.79756822658049e+01, 1.00747391004287e+01, 7.40983806343882e+00;
1.61252822647543e+01, 1.05500749096217e+01, 8.03484722536149e+00, 5.90166478298738e+00;
- <b><font color="#0000FF"></LookupData></font></b>
- <b><font color="#0000FF"><MeasurementPointsRow></font></b>0, 10, 23, 50<b><font color="#0000FF"></MeasurementPointsRow></font></b>
- <b><font color="#0000FF"><MeasurementPointsColumn></font></b>5, 20, 35, 50, 65, 80, 90<b><font color="#0000FF"></MeasurementPointsColumn></font></b>
- <b><font color="#0000FF"></LookupTau></font></b>
- <b><font color="#0000FF"><LookupOhmicResistance</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"LookupObj2DWithState"</font><b><font color="#0000FF">></font></b>
- <b><font color="#0000FF"><RowState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"ThermalState"</font><b><font color="#0000FF">/></font></b>
- <b><font color="#0000FF"><ColState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"Soc"</font><b><font color="#0000FF">/></font></b>
- <b><font color="#0000FF"><LookupData></font></b>
+ <b><font color="#0000FF"></LookupData></font></b>
+ <b><font color="#0000FF"><MeasurementPointsRow></font></b>0, 10, 23, 50<b><font color="#0000FF"></MeasurementPointsRow></font></b>
+ <b><font color="#0000FF"><MeasurementPointsColumn></font></b>5, 20, 35, 50, 65, 80, 90<b><font color="#0000FF"></MeasurementPointsColumn></font></b>
+ <b><font color="#0000FF"></LookupTau></font></b>
+ <b><font color="#0000FF"><LookupOhmicResistance</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"LookupObj2DWithState"</font><b><font color="#0000FF">></font></b>
+ <b><font color="#0000FF"><RowState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"ThermalState"</font><b><font color="#0000FF">/></font></b>
+ <b><font color="#0000FF"><ColState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"Soc"</font><b><font color="#0000FF">/></font></b>
+ <b><font color="#0000FF"><LookupData></font></b>
0.0422632965521782, 0.0422632965521782, 0.0422632965521782, 0.0646154311756893;
0.0122909999999999, 0.00820305593966980, 0.00584662021670523, 0.00383743519303631;
0.0322225070656886, 0.0289438148360227, 0.0225495908462913, 0.00599634893454420;
@@ -159,14 +154,14 @@ http://www.gnu.org/software/src-highlite -->
0.0157426548912461, 0.0171684201770746, 0.0134953332473813, 0.00457332312382527;
0.0218280618476754, 0.0131225853688649, 0.00741527720123879, 0.00329020951414971;
0.0153521701301020, 0.00846967601820038, 0.00563955480281332, 0.00315825717209717;
- <b><font color="#0000FF"></LookupData></font></b>
- <b><font color="#0000FF"><MeasurementPointsRow></font></b>0, 10, 23, 50<b><font color="#0000FF"></MeasurementPointsRow></font></b>
- <b><font color="#0000FF"><MeasurementPointsColumn></font></b>5, 20, 35, 50, 65, 80, 90<b><font color="#0000FF"></MeasurementPointsColumn></font></b>
- <b><font color="#0000FF"></LookupOhmicResistance></font></b>
- <b><font color="#0000FF"><LookupPhi</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"LookupObj2DWithState"</font><b><font color="#0000FF">></font></b>
- <b><font color="#0000FF"><RowState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"ThermalState"</font><b><font color="#0000FF">/></font></b>
- <b><font color="#0000FF"><ColState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"Soc"</font><b><font color="#0000FF">/></font></b>
- <b><font color="#0000FF"><LookupData></font></b>
+ <b><font color="#0000FF"></LookupData></font></b>
+ <b><font color="#0000FF"><MeasurementPointsRow></font></b>0, 10, 23, 50<b><font color="#0000FF"></MeasurementPointsRow></font></b>
+ <b><font color="#0000FF"><MeasurementPointsColumn></font></b>5, 20, 35, 50, 65, 80, 90<b><font color="#0000FF"></MeasurementPointsColumn></font></b>
+ <b><font color="#0000FF"></LookupOhmicResistance></font></b>
+ <b><font color="#0000FF"><LookupPhi</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"LookupObj2DWithState"</font><b><font color="#0000FF">></font></b>
+ <b><font color="#0000FF"><RowState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"ThermalState"</font><b><font color="#0000FF">/></font></b>
+ <b><font color="#0000FF"><ColState</font></b> <font color="#009900">cacheref</font><font color="#990000">=</font><font color="#FF0000">"Soc"</font><b><font color="#0000FF">/></font></b>
+ <b><font color="#0000FF"><LookupData></font></b>
1, 0.957683980942010, 0.762474540690386, 0.810166837787303;
1, 0.957683980942010, 0.837851589303327, 0.826206919812180;
0.806534226878276, 0.755415801951905, 0.630228467428149, 0.686969202518359;
@@ -174,19 +169,20 @@ http://www.gnu.org/software/src-highlite -->
0.791964147404381, 0.697353484425094, 0.628110619592649, 0.801166605326404;
0.759343341643463, 0.720390317831926, 0.755733232495091, 0.938336421996388;
0.790468798628622, 0.797350100822233, 0.852903199927494, 0.986742576117900;
- <b><font color="#0000FF"></LookupData></font></b>
- <b><font color="#0000FF"><MeasurementPointsRow></font></b>0, 10, 23, 50<b><font color="#0000FF"></MeasurementPointsRow></font></b>
- <b><font color="#0000FF"><MeasurementPointsColumn></font></b>5, 20, 35, 50, 65, 80, 90<b><font color="#0000FF"></MeasurementPointsColumn></font></b>
- <b><font color="#0000FF"></LookupPhi></font></b>
- <b><font color="#0000FF"></Zarc2></font></b>
+ <b><font color="#0000FF"></LookupData></font></b>
+ <b><font color="#0000FF"><MeasurementPointsRow></font></b>0, 10, 23, 50<b><font color="#0000FF"></MeasurementPointsRow></font></b>
+ <b><font color="#0000FF"><MeasurementPointsColumn></font></b>5, 20, 35, 50, 65, 80, 90<b><font color="#0000FF"></MeasurementPointsColumn></font></b>
+ <b><font color="#0000FF"></LookupPhi></font></b>
+ <b><font color="#0000FF"></Zarc2></font></b>
<i><font color="#9A1900"><!-- </font></i>
-<i><font color="#9A1900"> Vordefiniertes Zellelement einer Lithium-Ionen Batterie.</font></i>
-<i><font color="#9A1900"> Standarmäßig besteht ein Zellelement aus einem ohmschen Serienwiderstand, einer OCV, und einer Liste von ZarcElementen. </font></i>
-<i><font color="#9A1900"> Die Elemente sind dabei jeweils von den States Temperatur und State of Charge abhängig.</font></i>
-<i><font color="#9A1900"> Temperatur stellt die anfängliche Temperatur in °C dar. </font></i>
-<i><font color="#9A1900"> SOC benötigt eine nominale Kapazität, einen anfänglichen SOC in % sowie die Diskretisierung.</font></i>
+<i><font color="#9A1900"> This represents a cell of a lithium ion battery.</font></i>
+<i><font color="#9A1900"> The cell consists of the previously defined elements that are dependent on the cell's temperature and SOC.</font></i>
+<i><font color="#9A1900"> Die Elemente sind dabei jeweils von den States Temperatur und State of Charge abhängig.</font></i>
+<i><font color="#9A1900"> The initial temperature is given as a value in °C.</font></i>
+<i><font color="#9A1900"> SOC benötigt eine nominale Kapazität, einen anfänglichen SOC in % sowie die Diskretisierung.</font></i>
+<i><font color="#9A1900"> For the SOC we need the initial value in percent as well as the initial cell capacity in Ah.</font></i>
<i><font color="#9A1900"> --></font></i>
<b><font color="#0000FF"><MyCellElement1</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"CellElement"</font> <font color="#009900">observable</font><font color="#990000">=</font><font color="#FF0000">"True"</font><b><font color="#0000FF">></font></b>
@@ -197,7 +193,6 @@ http://www.gnu.org/software/src-highlite -->
<b><font color="#0000FF"><Soc</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"Soc"</font> <font color="#009900">cache</font><font color="#990000">=</font><font color="#FF0000">"True"</font><b><font color="#0000FF">></font></b>
<b><font color="#0000FF"><InitialCapacity></font></b>2.05<b><font color="#0000FF"></InitialCapacity></font></b>
<b><font color="#0000FF"><InitialSoc></font></b>55<b><font color="#0000FF"></InitialSoc></font></b>
- <b><font color="#0000FF"><MeasurementPoints></font></b>5, 10, 20, 23, 35, 50, 65, 80, 90<b><font color="#0000FF"></MeasurementPoints></font></b>
<b><font color="#0000FF"></Soc></font></b>
<b><font color="#0000FF"><Children></font></b>
<b><font color="#0000FF"><OhmicResistance</font></b> <font color="#009900">ref</font><font color="#990000">=</font><font color="#FF0000">"Rser"</font><b><font color="#0000FF">/></font></b>
@@ -214,7 +209,6 @@ http://www.gnu.org/software/src-highlite -->
<b><font color="#0000FF"><Soc</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"Soc"</font> <font color="#009900">cache</font><font color="#990000">=</font><font color="#FF0000">"True"</font><b><font color="#0000FF">></font></b>
<b><font color="#0000FF"><InitialCapacity></font></b>2.05<b><font color="#0000FF"></InitialCapacity></font></b>
<b><font color="#0000FF"><InitialSoc></font></b>60<b><font color="#0000FF"></InitialSoc></font></b>
- <b><font color="#0000FF"><MeasurementPoints></font></b>5, 10, 20, 23, 35, 50, 65, 80, 90<b><font color="#0000FF"></MeasurementPoints></font></b>
<b><font color="#0000FF"></Soc></font></b>
<b><font color="#0000FF"><Children></font></b>
<b><font color="#0000FF"><OhmicResistance</font></b> <font color="#009900">ref</font><font color="#990000">=</font><font color="#FF0000">"Rser"</font><b><font color="#0000FF">/></font></b>
@@ -225,8 +219,7 @@ http://www.gnu.org/software/src-highlite -->
<b><font color="#0000FF"></MyCellElement2></font></b>
<i><font color="#9A1900"><!-- </font></i>
-<i><font color="#9A1900"> Beispielverschaltung zwei parallelen Batterien (Pack) welche jeweils in einem String, bestehend aus einer</font></i>
-<i><font color="#9A1900"> Serienschaltung von zwei Packs besteht.</font></i>
+<i><font color="#9A1900"> Example parallel connection of cells. Because count is set to 2, each child is added twice, resulting in 4 parallel cells.</font></i>
<i><font color="#9A1900"> --></font></i>
<b><font color="#0000FF"><NormalBatteryPack</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"ParallelTwoPort"</font><b><font color="#0000FF">></font></b>
@@ -237,7 +230,7 @@ http://www.gnu.org/software/src-highlite -->
<b><font color="#0000FF"></NormalBatteryPack></font></b>
<i><font color="#9A1900"><!-- </font></i>
-<i><font color="#9A1900"> Hier werden zwei Batterypacks(NormalBatteryPack) in Serie verschaltet</font></i>
+<i><font color="#9A1900"> Connection of two packs in series</font></i>
<i><font color="#9A1900"> --></font></i>
<b><font color="#0000FF"><BatteryString</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"SerialTwoPort"</font><b><font color="#0000FF">></font></b>
<b><font color="#0000FF"><Children</font></b> <font color="#009900">count</font><font color="#990000">=</font><font color="#FF0000">"2"</font><b><font color="#0000FF">></font></b>
@@ -248,8 +241,7 @@ http://www.gnu.org/software/src-highlite -->
<b><font color="#0000FF"></CustomDefinitions></font></b>
<i><font color="#9A1900"><!-- </font></i>
-<i><font color="#9A1900"> Wurzelknoten des Systems.</font></i>
-<i><font color="#9A1900"> Dieses Batterienetzwerk wird in der Anwendung simuliert und besteht aus zwei Strings</font></i>
+<i><font color="#9A1900"> Roo element of the electrical model that is simulated.</font></i>
<i><font color="#9A1900"> --></font></i>
<b><font color="#0000FF"><RootElement</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">"ParallelTwoPort"</font><b><font color="#0000FF">></font></b>
diff --git a/doxygen/examples/xmlCurrentState.xml b/doxygen/examples/xmlCurrentState.xml
index b931293be2cd0924f3fe2472685132853b26ee24..1d1a547f33adcdfbad760d66f562e68688f03589 100644
--- a/doxygen/examples/xmlCurrentState.xml
+++ b/doxygen/examples/xmlCurrentState.xml
@@ -1,5 +1,4 @@
-<LookupObj1D class='LookupObj1dWithState'>\
- <State class='ElectricalState' StateType='Current' />\
- <LookupData>1,2,3,4,5,6,7,8,9</LookupData>\
- <MeasurementPoints>1,2,3,4,5,6,7,8,9</MeasurementPoints>\
+<LookupObj1D class='LookupObj1dWithState'>
+ <State class='ElectricalState' StateType='Current' />
+ <LookupData>1,2,3,4,5,6,7,8,9</LookupData>
</LookupObj1D>
diff --git a/doxygen/examples/xmlCurrentState_color.xml b/doxygen/examples/xmlCurrentState_color.xml
index 4013fca8820dffc1ef9bef0d64700dd4e78d3413..898053338a3a00fcee0c0c840130299bc88f0221 100644
--- a/doxygen/examples/xmlCurrentState_color.xml
+++ b/doxygen/examples/xmlCurrentState_color.xml
@@ -3,10 +3,9 @@
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
-<pre><tt><b><font color="#0000FF"><LookupObj1D</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">'LookupObj1dWithState'</font><b><font color="#0000FF">></font></b>\
- <b><font color="#0000FF"><State</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">'ElectricalState'</font> <font color="#009900">StateType</font><font color="#990000">=</font><font color="#FF0000">'Current'</font> <b><font color="#0000FF">/></font></b>\
- <b><font color="#0000FF"><LookupData></font></b>1,2,3,4,5,6,7,8,9<b><font color="#0000FF"></LookupData></font></b>\
- <b><font color="#0000FF"><MeasurementPoints></font></b>1,2,3,4,5,6,7,8,9<b><font color="#0000FF"></MeasurementPoints></font></b>\
+<pre><tt><b><font color="#0000FF"><LookupObj1D</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">'LookupObj1dWithState'</font><b><font color="#0000FF">></font></b>
+ <b><font color="#0000FF"><State</font></b> <font color="#009900">class</font><font color="#990000">=</font><font color="#FF0000">'ElectricalState'</font> <font color="#009900">StateType</font><font color="#990000">=</font><font color="#FF0000">'Current'</font> <b><font color="#0000FF">/></font></b>
+ <b><font color="#0000FF"><LookupData></font></b>1,2,3,4,5,6,7,8,9<b><font color="#0000FF"></LookupData></font></b>
<b><font color="#0000FF"></LookupObj1D></font></b>
</tt></pre>
</div>
diff --git a/doxygen/images/simulation_cycle.svg b/doxygen/images/simulation_cycle.svg
new file mode 100644
index 0000000000000000000000000000000000000000..26a2bb5c4454e5a726ce3d0fec96cedfb9769a46
--- /dev/null
+++ b/doxygen/images/simulation_cycle.svg
@@ -0,0 +1,1642 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+ xmlns:dc="http://purl.org/dc/elements/1.1/"
+ xmlns:cc="http://creativecommons.org/ns#"
+ xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns="http://www.w3.org/2000/svg"
+ xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+ xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+ inkscape:version="1.0 (4035a4fb49, 2020-05-01)"
+ inkscape:export-ydpi="96"
+ inkscape:export-xdpi="96"
+ inkscape:export-filename="H:\Praesentationen\simulation_cycle.png"
+ sodipodi:docname="simulation_cycle.svg"
+ viewBox="0 0 960 567.03998"
+ height="567.03998"
+ width="960"
+ xml:space="preserve"
+ id="svg10"
+ version="1.1"><metadata
+ id="metadata16"><rdf:RDF><cc:Work
+ rdf:about=""><dc:format>image/svg+xml</dc:format><dc:type
+ rdf:resource="http://purl.org/dc/dcmitype/StillImage" /><dc:title></dc:title></cc:Work></rdf:RDF></metadata><defs
+ id="defs14"><clipPath
+ id="clipPath26"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path24"
+ clip-rule="evenodd"
+ d="M 0,9.1553e-5 H 720 V 425.28009 H 0 Z" /></clipPath><clipPath
+ id="clipPath40"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path38"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath52"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path50"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath68"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path66"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath80"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path78"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath96"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path94"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath108"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path106"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath124"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path122"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath140"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path138"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath152"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path150"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath164"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path162"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath180"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path178"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath192"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path190"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath208"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path206"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath220"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path218"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath232"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path230"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath248"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path246"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath260"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path258"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath276"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path274"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath288"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path286"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath300"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path298"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath316"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path314"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath328"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path326"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath340"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path338"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath352"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path350"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath364"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path362"
+ clip-rule="evenodd"
+ d="M -1.5126e-5,425.28 H 720 V 9.1553e-5 H -1.5126e-5" /></clipPath><clipPath
+ id="clipPath376"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path374"
+ clip-rule="evenodd"
+ d="M -1.5126e-5,425.28 H 720 V 9.1553e-5 H -1.5126e-5" /></clipPath><clipPath
+ id="clipPath388"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path386"
+ clip-rule="evenodd"
+ d="M 1.6306e-5,425.28 H 720 V 9.1553e-5 H 1.6306e-5" /></clipPath><clipPath
+ id="clipPath400"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path398"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath416"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path414"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath428"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path426"
+ clip-rule="evenodd"
+ d="M -1.4758e-5,425.28 H 720 V 9.1553e-5 H -1.4758e-5" /></clipPath><clipPath
+ id="clipPath438"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path436"
+ clip-rule="evenodd"
+ d="M -3.6023e-5,425.28 H 720 V 9.1553e-5 H -3.6023e-5" /></clipPath><clipPath
+ id="clipPath450"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path448"
+ clip-rule="evenodd"
+ d="M -3.6023e-5,425.28 H 720 V 9.1553e-5 H -3.6023e-5" /></clipPath><clipPath
+ id="clipPath468"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path466"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath480"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path478"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath492"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path490"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath504"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path502"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath516"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path514"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath528"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path526"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath540"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path538"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath554"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path552"
+ clip-rule="evenodd"
+ d="M -3.2584e-5,425.28 H 720 V 9.1553e-5 H -3.2584e-5" /></clipPath><clipPath
+ id="clipPath564"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path562"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath576"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path574"
+ clip-rule="evenodd"
+ d="M -2.1015e-5,425.28 H 720 V 9.1553e-5 H -2.1015e-5" /></clipPath><clipPath
+ id="clipPath588"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path586"
+ clip-rule="evenodd"
+ d="M 3.1987e-5,425.28 H 720 V 0 H -4.6753e-5" /></clipPath><clipPath
+ id="clipPath604"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path602"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath616"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path614"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath628"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path626"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath644"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path642"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath656"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path654"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath668"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path666"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath680"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path678"
+ clip-rule="evenodd"
+ d="M 2.1263e-5,425.28 H 720 V 3.0518e-5 H -1.8108e-5" /></clipPath><clipPath
+ id="clipPath690"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path688"
+ clip-rule="evenodd"
+ d="M 9.428e-6,425.28 H 720 V -3.0518e-5 H -2.9942e-5" /></clipPath><clipPath
+ id="clipPath700"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path698"
+ clip-rule="evenodd"
+ d="M 1.8458e-5,425.28 H 720 V 0 H -2.0912e-5" /></clipPath><clipPath
+ id="clipPath712"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path710"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath724"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path722"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath736"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path734"
+ clip-rule="evenodd"
+ d="M 5.09e-6,425.28 H 720 V 9.1553e-5 H 5.0899999e-6" /></clipPath><clipPath
+ id="clipPath748"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path746"
+ clip-rule="evenodd"
+ d="M 7.434e-6,425.28 H 720 V 0 H -3.1936e-5" /></clipPath><clipPath
+ id="clipPath758"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path756"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath770"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path768"
+ clip-rule="evenodd"
+ d="M 1.7992e-5,425.28 H 720 V 0 H -2.1378e-5" /></clipPath><clipPath
+ id="clipPath782"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path780"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath794"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path792"
+ clip-rule="evenodd"
+ d="M 1.31e-5,425.28 H 720 V 0 H -2.627e-5" /></clipPath><clipPath
+ id="clipPath810"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path808"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath822"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path820"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath834"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path832"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath846"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path844"
+ clip-rule="evenodd"
+ d="M -7.5e-8,425.28 H 720 V 0 H -9.918e-6" /></clipPath><clipPath
+ id="clipPath858"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path856"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath870"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path868"
+ clip-rule="evenodd"
+ d="M 1.874e-6,425.28 H 720 V 9.1553e-5 H 1.874e-6" /></clipPath><clipPath
+ id="clipPath882"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path880"
+ clip-rule="evenodd"
+ d="M 9.26e-7,425.28 H 720 V -3.0518e-5 L -1.8759e-5,0" /></clipPath><clipPath
+ id="clipPath896"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path894"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath912"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path910"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath924"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path922"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath936"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path934"
+ clip-rule="evenodd"
+ d="M 3.301e-6,425.28 H 720 V 0 H -1.621e-6" /></clipPath><clipPath
+ id="clipPath952"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path950"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath964"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path962"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath978"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path976"
+ clip-rule="evenodd"
+ d="M 6.24e-7,425.28 H 720 V 0 H -9.219e-6" /></clipPath><clipPath
+ id="clipPath990"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path988"
+ clip-rule="evenodd"
+ d="M -2.435e-6,425.28 H 720 V 6.1035e-5 H -2.4350001e-6" /></clipPath><clipPath
+ id="clipPath1002"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path1000"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath1014"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path1012"
+ clip-rule="evenodd"
+ d="M 3.955e-6,425.28 H 720 V 0 H -1.573e-5" /></clipPath><clipPath
+ id="clipPath1028"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path1026"
+ clip-rule="evenodd"
+ d="M 1.4758e-5,425.28 H 720 V -3.0518e-5 L -2.4612e-5,0" /></clipPath><clipPath
+ id="clipPath1038"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path1036"
+ clip-rule="evenodd"
+ d="M 7.798e-6,425.28 H 720 V 0 H -3.1572e-5" /></clipPath><clipPath
+ id="clipPath1048"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path1046"
+ clip-rule="evenodd"
+ d="M -4.369e-6,425.28 H 720 V 9.1553e-5 H -4.369e-6" /></clipPath><clipPath
+ id="clipPath1058"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path1056"
+ clip-rule="evenodd"
+ d="M -1.5511e-5,425.28 H 720 V 9.1553e-5 H -1.5511e-5" /></clipPath><clipPath
+ id="clipPath1068"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path1066"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath1080"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path1078"
+ clip-rule="evenodd"
+ d="M 5.437e-6,425.28 H 720 V 0 H -4.406e-6" /></clipPath><clipPath
+ id="clipPath1092"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path1090"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath1106"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path1104"
+ clip-rule="evenodd"
+ d="M 1.648e-6,425.28 H 720 V 3.0518e-5 H -3.7723e-5" /></clipPath><clipPath
+ id="clipPath1116"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path1114"
+ clip-rule="evenodd"
+ d="M -3.6023e-5,425.28 H 720 V 9.1553e-5 H -3.6023e-5" /></clipPath><clipPath
+ id="clipPath1130"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path1128"
+ clip-rule="evenodd"
+ d="M -4.73e-7,425.28 H 720 V 9.1553e-5 H -4.73e-7" /></clipPath><clipPath
+ id="clipPath1142"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path1140"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath1154"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path1152"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath1166"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path1164"
+ clip-rule="evenodd"
+ d="M -3.809e-6,425.28 H 720 V 9.1553e-5 H -3.809e-6" /></clipPath><clipPath
+ id="clipPath1180"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path1178"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath1192"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path1190"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath1204"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path1202"
+ clip-rule="evenodd"
+ d="M 3.301e-6,425.28 H 720 V -3.0518e-5 L -1.621e-6,0" /></clipPath><clipPath
+ id="clipPath1220"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path1218"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath1232"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path1230"
+ clip-rule="evenodd"
+ d="M -6.552e-6,425.28 H 720 V 9.1553e-5 H -6.552e-6" /></clipPath><clipPath
+ id="clipPath1244"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path1242"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath1256"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path1254"
+ clip-rule="evenodd"
+ d="M 5.09e-6,425.28 H 720 V 9.1553e-5 H 5.0899999e-6" /></clipPath><clipPath
+ id="clipPath1268"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path1266"
+ clip-rule="evenodd"
+ d="M -1.7989e-5,425.28 H 720 V 9.1553e-5 H -1.7989e-5" /></clipPath><clipPath
+ id="clipPath1280"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path1278"
+ clip-rule="evenodd"
+ d="M 3.054e-6,425.28 H 720 V 9.1553e-5 H 3.054e-6" /></clipPath><clipPath
+ id="clipPath1290"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path1288"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath><clipPath
+ id="clipPath1302"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path1300"
+ clip-rule="evenodd"
+ d="M 5.45e-7,425.28 H 720 V 0 H -4.376e-6" /></clipPath><clipPath
+ id="clipPath1312"
+ clipPathUnits="userSpaceOnUse"><path
+ id="path1310"
+ clip-rule="evenodd"
+ d="M 1.0729e-5,0 H 720.00001 V 425.28 H 1.0729e-5 Z" /></clipPath></defs><sodipodi:namedview
+ inkscape:current-layer="g18"
+ inkscape:window-maximized="1"
+ inkscape:window-y="-8"
+ inkscape:window-x="-8"
+ inkscape:cy="289.96327"
+ inkscape:cx="322.09654"
+ inkscape:zoom="1.458451"
+ showgrid="false"
+ id="namedview12"
+ inkscape:window-height="1017"
+ inkscape:window-width="1920"
+ inkscape:pageshadow="2"
+ inkscape:pageopacity="0"
+ guidetolerance="10"
+ gridtolerance="10"
+ objecttolerance="10"
+ borderopacity="1"
+ bordercolor="#666666"
+ pagecolor="#ffffff" /><g
+ transform="matrix(1.3333333,0,0,-1.3333333,0,567.04)"
+ inkscape:label="simulation_cycle"
+ inkscape:groupmode="layer"
+ id="g18"><g
+ id="g20"><g
+ clip-path="url(#clipPath26)"
+ id="g22"><path
+ id="path28"
+ style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="M 0,3.0518e-5 H 720 V 425.28003 H 0 Z" /></g></g><path
+ id="path30"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 23.4,381.12 h 112.08 v 17.16 H 23.4 Z" /><path
+ id="path32"
+ style="fill:none;stroke:#003b74;stroke-width:0.96;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:10;stroke-dasharray:none;stroke-opacity:1"
+ d="m 23.4,381.12 h 112.08 v 17.16 H 23.4 Z" /><g
+ id="g34"><g
+ clip-path="url(#clipPath40)"
+ id="g36"><text
+ id="text44"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,57.792,385.25)"><tspan
+ id="tspan42"
+ sodipodi:role="line"
+ y="0"
+ x="0 7.9200001 17.879999">XML</tspan></text></g></g><g
+ id="g46"><g
+ clip-path="url(#clipPath52)"
+ id="g48"><text
+ id="text56"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,85.752,385.25)"><tspan
+ id="tspan54"
+ sodipodi:role="line"
+ y="0"
+ x="0 3.4679999 6.132 8.7480001">file</tspan></text></g></g><path
+ id="path58"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 23.4,355.08 h 112.08 v 17.16 H 23.4 Z" /><path
+ id="path60"
+ style="fill:none;stroke:#003b74;stroke-width:0.96;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:10;stroke-dasharray:none;stroke-opacity:1"
+ d="m 23.4,355.08 h 112.08 v 17.16 H 23.4 Z" /><g
+ id="g62"><g
+ clip-path="url(#clipPath68)"
+ id="g64"><text
+ id="text72"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,41.472,359.18)"><tspan
+ id="tspan70"
+ sodipodi:role="line"
+ y="0"
+ x="0 8.6639996 15.336 19.332001 23.280001 29.988001 36.695999">Current</tspan></text></g></g><g
+ id="g74"><g
+ clip-path="url(#clipPath80)"
+ id="g76"><text
+ id="text84"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,84.672,359.18)"><tspan
+ id="tspan82"
+ sodipodi:role="line"
+ y="0"
+ x="0 6.7080002 10.704 17.375999 20.856001 23.52 26.136">profile</tspan></text></g></g><path
+ id="path86"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 303.24,355.32 h 113.52 v 42.96 H 303.24 Z" /><path
+ id="path88"
+ style="fill:none;stroke:#003b74;stroke-width:0.96;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:10;stroke-dasharray:none;stroke-opacity:1"
+ d="m 303.24,355.32 h 113.52 v 42.96 H 303.24 Z" /><g
+ id="g90"><g
+ clip-path="url(#clipPath96)"
+ id="g92"><text
+ id="text100"
+ style="font-variant:normal;font-weight:normal;font-size:12.024px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,312.84,379.58)"><tspan
+ id="tspan98"
+ sodipodi:role="line"
+ y="0"
+ x="0 9.9558716 16.641216 23.386681 30.072023 32.741352 35.867592 41.879593 45.823463 52.508808 59.254272 62.596943 65.266273 71.951614 78.685059 81.691055 88.376404 94.292206">Model creation by </tspan></text></g></g><g
+ id="g102"><g
+ clip-path="url(#clipPath108)"
+ id="g104"><text
+ id="text112"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,337.2,365.16)"><tspan
+ id="tspan110"
+ sodipodi:role="line"
+ y="0"
+ x="0 3.4679999 10.176 16.176001 19.511999 26.243999 30.24 32.844002 39.551998">factories</tspan></text></g></g><path
+ id="path114"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 583.2,191.4 h 113.4 v 42.96 H 583.2 Z" /><path
+ id="path116"
+ style="fill:none;stroke:#003b74;stroke-width:0.96;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:10;stroke-dasharray:none;stroke-opacity:1"
+ d="m 583.2,191.4 h 113.4 v 42.96 H 583.2 Z" /><g
+ id="g118"><g
+ clip-path="url(#clipPath124)"
+ id="g120"><text
+ id="text128"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,600.29,208.39)"><tspan
+ id="tspan126"
+ sodipodi:role="line"
+ y="0"
+ x="0 8.6639996 15.336 22.068001 28.775999 32.112 38.844002 41.844002 47.844002 54.551998 58.548 62.472 69.18 75.888">Update current</tspan></text></g></g><path
+ id="path130"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="M 583.2,27.48 H 696.6 V 70.44 H 583.2 Z" /><path
+ id="path132"
+ style="fill:none;stroke:#003b74;stroke-width:0.96;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:10;stroke-dasharray:none;stroke-opacity:1"
+ d="M 583.2,27.48 H 696.6 V 70.44 H 583.2 Z" /><g
+ id="g134"><g
+ clip-path="url(#clipPath140)"
+ id="g136"><text
+ id="text144"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,606.89,51.624)"><tspan
+ id="tspan142"
+ sodipodi:role="line"
+ y="0"
+ x="0 8.6400003">Do</tspan></text></g></g><g
+ id="g146"><g
+ clip-path="url(#clipPath152)"
+ id="g148"><text
+ id="text156"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,625.49,51.624)"><tspan
+ id="tspan154"
+ sodipodi:role="line"
+ y="0"
+ x="0 6.7080002 9.3719997 16.044001 22.044001 25.416 29.412001 32.015999 38.015999 44.723999 47.388">electrical </tspan></text></g></g><g
+ id="g158"><g
+ clip-path="url(#clipPath164)"
+ id="g160"><text
+ id="text168"
+ style="font-variant:normal;font-weight:normal;font-size:12.024px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,617.09,37.224)"><tspan
+ id="tspan166"
+ sodipodi:role="line"
+ y="0"
+ x="0 3.3426721 6.0120001 16.064064 22.749409 28.761408 32.128128 38.813473">timestep</tspan></text></g></g><path
+ id="path170"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="M 23.4,27.48 H 136.8 V 70.44 H 23.4 Z" /><path
+ id="path172"
+ style="fill:none;stroke:#003b74;stroke-width:0.96;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:10;stroke-dasharray:none;stroke-opacity:1"
+ d="M 23.4,27.48 H 136.8 V 70.44 H 23.4 Z" /><g
+ id="g174"><g
+ clip-path="url(#clipPath180)"
+ id="g176"><text
+ id="text184"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,39.768,51.624)"><tspan
+ id="tspan182"
+ sodipodi:role="line"
+ y="0"
+ x="0 8.6639996 15.336 18 20.664 27.336 33.335999 36.708 39.827999 46.535999 53.243999 56.580002 63.312 66.431999 69.900002 76.608002 80.603996">Collect data for </tspan></text></g></g><g
+ id="g186"><g
+ clip-path="url(#clipPath192)"
+ id="g188"><text
+ id="text196"
+ style="font-variant:normal;font-weight:normal;font-size:12.024px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,65.448,37.224)"><tspan
+ id="tspan194"
+ sodipodi:role="line"
+ y="0"
+ x="0 6.6853442 13.322592 15.99192 22.677263">aging</tspan></text></g></g><path
+ id="path198"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="M 303.24,27.48 H 416.76 V 70.44 H 303.24 Z" /><path
+ id="path200"
+ style="fill:none;stroke:#003b74;stroke-width:0.96;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:10;stroke-dasharray:none;stroke-opacity:1"
+ d="M 303.24,27.48 H 416.76 V 70.44 H 303.24 Z" /><g
+ id="g202"><g
+ clip-path="url(#clipPath208)"
+ id="g204"><text
+ id="text212"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,330.6,51.624)"><tspan
+ id="tspan210"
+ sodipodi:role="line"
+ y="0"
+ x="0 8.6400003">Do</tspan></text></g></g><g
+ id="g214"><g
+ clip-path="url(#clipPath220)"
+ id="g216"><text
+ id="text224"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,349.2,51.624)"><tspan
+ id="tspan222"
+ sodipodi:role="line"
+ y="0"
+ x="0 3.336 10.068 16.775999 20.771999 30.804001 37.512001 40.175999">thermal </tspan></text></g></g><g
+ id="g226"><g
+ clip-path="url(#clipPath232)"
+ id="g228"><text
+ id="text236"
+ style="font-variant:normal;font-weight:normal;font-size:12.024px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,337.2,37.224)"><tspan
+ id="tspan234"
+ sodipodi:role="line"
+ y="0"
+ x="0 3.3426721 6.0120001 16.064064 22.749409 28.761408 32.128128 38.813473">timestep</tspan></text></g></g><path
+ id="path238"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 303.24,191.52 h 113.52 v 42.96 H 303.24 Z" /><path
+ id="path240"
+ style="fill:none;stroke:#003b74;stroke-width:0.96;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:10;stroke-dasharray:none;stroke-opacity:1"
+ d="m 303.24,191.52 h 113.52 v 42.96 H 303.24 Z" /><g
+ id="g242"><g
+ clip-path="url(#clipPath248)"
+ id="g244"><text
+ id="text252"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,318.96,215.64)"><tspan
+ id="tspan250"
+ sodipodi:role="line"
+ y="0"
+ x="0 8.6639996 15.336 21.336 28.068001 31.403999 34.667999 41.375999 44.040001 50.712002 56.712002 60.084 64.080002 66.683998 72.683998 79.391998 82.056">Reset electrical </tspan></text></g></g><g
+ id="g254"><g
+ clip-path="url(#clipPath260)"
+ id="g256"><text
+ id="text264"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,333,201.24)"><tspan
+ id="tspan262"
+ sodipodi:role="line"
+ y="0"
+ x="0 6 8.6639996 18.708 25.416 28.08 34.751999 38.124001 40.787998 47.459999">simulation</tspan></text></g></g><path
+ id="path266"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 23.4,192.12 h 113.4 v 42.96 H 23.4 Z" /><path
+ id="path268"
+ style="fill:none;stroke:#003b74;stroke-width:0.96;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:10;stroke-dasharray:none;stroke-opacity:1"
+ d="m 23.4,192.12 h 113.4 v 42.96 H 23.4 Z" /><g
+ id="g270"><g
+ clip-path="url(#clipPath276)"
+ id="g272"><text
+ id="text280"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,43.128,209.09)"><tspan
+ id="tspan278"
+ sodipodi:role="line"
+ y="0"
+ x="0 8.6639996 15.336">Do </tspan></text></g></g><g
+ id="g282"><g
+ clip-path="url(#clipPath288)"
+ id="g284"><text
+ id="text292"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,61.728,209.09)"><tspan
+ id="tspan290"
+ sodipodi:role="line"
+ y="0"
+ x="0 6.7080002 13.308 15.972">agin</tspan></text></g></g><g
+ id="g294"><g
+ clip-path="url(#clipPath300)"
+ id="g296"><text
+ id="text304"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,84.408,209.09)"><tspan
+ id="tspan302"
+ sodipodi:role="line"
+ y="0"
+ x="0 6.5999999 9.8400002 15.84 19.176001 25.908001">g step</tspan></text></g></g><path
+ id="path306"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 583.2,355.32 h 113.4 v 42.96 H 583.2 Z" /><path
+ id="path308"
+ style="fill:none;stroke:#003b74;stroke-width:0.96;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:10;stroke-dasharray:none;stroke-opacity:1"
+ d="m 583.2,355.32 h 113.4 v 42.96 H 583.2 Z" /><g
+ id="g310"><g
+ clip-path="url(#clipPath316)"
+ id="g312"><text
+ id="text320"
+ style="font-variant:normal;font-weight:normal;font-size:12.024px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,610.49,379.58)"><tspan
+ id="tspan318"
+ y="0"
+ x="0">R</tspan></text></g></g><g
+ id="g322"><g
+ clip-path="url(#clipPath328)"
+ id="g324"><text
+ id="text332"
+ style="font-variant:normal;font-weight:normal;font-size:12.024px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,619.13,379.58)"><tspan
+ id="tspan330"
+ sodipodi:role="line"
+ y="0"
+ x="0 6.6853442 12.697344 16.064064 22.749409 26.753401">estart</tspan></text></g></g><g
+ id="g334"><g
+ clip-path="url(#clipPath340)"
+ id="g336"><text
+ id="text344"
+ style="font-variant:normal;font-weight:normal;font-size:12.024px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,652.51,379.58)"><tspan
+ id="tspan342"
+ sodipodi:role="line"
+ y="0"
+ x="0 3.3426721 10.064088 16.749432">the </tspan></text></g></g><g
+ id="g346"><g
+ clip-path="url(#clipPath352)"
+ id="g348"><text
+ id="text356"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,603.17,365.16)"><tspan
+ id="tspan354"
+ sodipodi:role="line"
+ y="0"
+ x="0 6 12.708 16.704 20.628 27.336 34.043999 37.380001 40.644001 47.352001 51.348 58.02 61.5 64.164001 66.779999">current profile</tspan></text></g></g><g
+ id="g358"><g
+ clip-path="url(#clipPath364)"
+ id="g360"><path
+ id="path366"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="M 276.24,396.72 291,389.94 276.24,383.16 Z" /></g></g><path
+ id="path368"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="M 150.12,387.72 H 279.6 v 4.56 H 150.12 Z" /><g
+ id="g370"><g
+ clip-path="url(#clipPath376)"
+ id="g372"><path
+ id="path378"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="M 276.24,370.92 291,364.14 276.24,357.36 Z" /></g></g><path
+ id="path380"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="M 150.12,361.92 H 279.6 v 4.44 H 150.12 Z" /><g
+ id="g382"><g
+ clip-path="url(#clipPath388)"
+ id="g384"><path
+ id="path390"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 555.6,383.76 14.76,-6.78 -14.76,-6.78 z" /></g></g><path
+ id="path392"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 429.48,374.76 h 129.48 v 4.56 H 429.48 Z" /><g
+ id="g394"><g
+ clip-path="url(#clipPath400)"
+ id="g396"><text
+ id="text404"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,610.44,249.6)"><tspan
+ id="tspan402"
+ sodipodi:role="line"
+ y="0"
+ x="0 5.8800001 12.588">yes</tspan></text></g></g><path
+ id="path406"
+ style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 583.32,273.6 h 113.4 v 42.96 h -113.4 z" /><path
+ id="path408"
+ style="fill:none;stroke:#003b74;stroke-width:0.96;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:10;stroke-dasharray:none;stroke-opacity:1"
+ d="m 583.32,273.6 h 113.4 v 42.96 h -113.4 z" /><g
+ id="g410"><g
+ clip-path="url(#clipPath416)"
+ id="g412"><text
+ id="text420"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,592.15,290.59)"><tspan
+ id="tspan418"
+ sodipodi:role="line"
+ y="0"
+ x="0 8.6639996 15.336 22.068001 28.775999 35.375999 42.084 48.683998 51.683998 57.683998 64.391998 68.388 72.311996 79.019997 85.727997 89.064003">Changed current?</tspan></text></g></g><g
+ id="g422"><g
+ clip-path="url(#clipPath428)"
+ id="g424"><path
+ id="path430"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 520.08,138.72 h 4.56 v 151.44 h -4.56 z" /></g></g><g
+ id="g432"><g
+ clip-path="url(#clipPath438)"
+ id="g434"><path
+ id="path440"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 637.56,330.96 h 4.56 v 18.6 h -4.56 z" /></g></g><path
+ id="path442"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 646.68,337.56 -6.78,-14.76 -6.78,14.76 z" /><g
+ id="g444"><g
+ clip-path="url(#clipPath450)"
+ id="g446"><path
+ id="path452"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 637.56,249.24 h 4.56 v 18.48 h -4.56 z" /></g></g><path
+ id="path454"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 646.68,255.84 -6.78,-14.76 -6.78,14.76 z" /><path
+ id="path456"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 520.08,285.6 h 54.48 v 4.56 h -54.48 z" /><path
+ id="path458"
+ style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 585.36,109.68 h 113.4 v 42.96 h -113.4 z" /><path
+ id="path460"
+ style="fill:none;stroke:#003b74;stroke-width:0.96;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:10;stroke-dasharray:none;stroke-opacity:1"
+ d="m 585.36,109.68 h 113.4 v 42.96 h -113.4 z" /><g
+ id="g462"><g
+ clip-path="url(#clipPath468)"
+ id="g464"><text
+ id="text472"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,595.1,141.02)"><tspan
+ id="tspan470"
+ sodipodi:role="line"
+ y="0"
+ x="0 9.96 16.667999 22.548 25.884001 29.375999 36.084 38.748001 42.084">Max. el. </tspan></text></g></g><g
+ id="g474"><g
+ clip-path="url(#clipPath480)"
+ id="g476"><text
+ id="text484"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,640.46,141.02)"><tspan
+ id="tspan482"
+ y="0"
+ x="0">s</tspan></text></g></g><g
+ id="g486"><g
+ clip-path="url(#clipPath492)"
+ id="g488"><text
+ id="text496"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,646.46,141.02)"><tspan
+ id="tspan494"
+ sodipodi:role="line"
+ y="0"
+ x="0 3.336 10.068 16.775999 20.016001 23.351999 26.016001 36.084 42.792">tep time </tspan></text></g></g><g
+ id="g498"><g
+ clip-path="url(#clipPath504)"
+ id="g500"><text
+ id="text508"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,602.78,126.62)"><tspan
+ id="tspan506"
+ sodipodi:role="line"
+ y="0"
+ x="0 6.7080002 12.588 19.296 23.292 26.628 29.964001">over / </tspan></text></g></g><g
+ id="g510"><g
+ clip-path="url(#clipPath516)"
+ id="g512"><text
+ id="text520"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,636.14,126.62)"><tspan
+ id="tspan518"
+ y="0"
+ x="0">s</tspan></text></g></g><g
+ id="g522"><g
+ clip-path="url(#clipPath528)"
+ id="g524"><text
+ id="text532"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,642.14,126.62)"><tspan
+ id="tspan530"
+ sodipodi:role="line"
+ y="0"
+ x="0 3.336 10.068 16.775999 20.016001 26.016001 30.011999 32.616001 35.952 39.324001">top crit. </tspan></text></g></g><g
+ id="g534"><g
+ clip-path="url(#clipPath540)"
+ id="g536"><text
+ id="text544"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,620.06,112.2)"><tspan
+ id="tspan542"
+ sodipodi:role="line"
+ y="0"
+ x="0 3.4679999 10.176 12.84 16.284 18.948 21.563999 24.228001 30.804001 37.403999">fulfilled?</tspan></text></g></g><path
+ id="path546"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 520.08,137.88 h 43.08 v 4.56 h -43.08 z" /><g
+ id="g548"><g
+ clip-path="url(#clipPath554)"
+ id="g550"><path
+ id="path556"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 559.8,146.88 14.76,-6.78 -14.76,-6.78 z" /></g></g><g
+ id="g558"><g
+ clip-path="url(#clipPath564)"
+ id="g560"><text
+ id="text568"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,559.73,275.66)"><tspan
+ id="tspan566"
+ sodipodi:role="line"
+ y="0"
+ x="0 6.7199998">no</tspan></text></g></g><g
+ id="g570"><g
+ clip-path="url(#clipPath576)"
+ id="g572"><path
+ id="path578"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 613.32,84.6 h 4.44 v 18.48 h -4.44 z" /></g></g><path
+ id="path580"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="M 622.32,91.2 615.54,76.44 608.76,91.2 Z" /><g
+ id="g582"><g
+ clip-path="url(#clipPath588)"
+ id="g584"><path
+ id="path590"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 663.48,76.44 h 4.44 v 18.48 h -4.44 z" /></g></g><path
+ id="path592"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 658.92,88.32 6.78,14.76 6.78,-14.76 z" /><path
+ id="path594"
+ style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 443.28,27 h 113.4 v 42.96 h -113.4 z" /><path
+ id="path596"
+ style="fill:none;stroke:#003b74;stroke-width:0.96;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:10;stroke-dasharray:none;stroke-opacity:1"
+ d="m 443.28,27 h 113.4 v 42.96 h -113.4 z" /><g
+ id="g598"><g
+ clip-path="url(#clipPath604)"
+ id="g600"><text
+ id="text608"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,464.9,51.12)"><tspan
+ id="tspan606"
+ sodipodi:role="line"
+ y="0"
+ x="0 7.428 14.136 20.844 24.84 34.872002 41.580002 44.243999 47.220001 53.220001 56.556 63.287998 69.996002">Thermal stop </tspan></text></g></g><g
+ id="g610"><g
+ clip-path="url(#clipPath616)"
+ id="g612"><text
+ id="text620"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,454.94,36.72)"><tspan
+ id="tspan618"
+ sodipodi:role="line"
+ y="0"
+ x="0 6 9.9960003 12.6 15.936 22.667999 26.664 29.268 35.976002">criterion</tspan></text></g></g><g
+ id="g622"><g
+ clip-path="url(#clipPath628)"
+ id="g624"><text
+ id="text632"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,500.78,36.72)"><tspan
+ id="tspan630"
+ sodipodi:role="line"
+ y="0"
+ x="0 3.4679999 10.176 12.84 16.284 18.948 21.563999 24.228001 30.804001 37.512001">fulfilled?</tspan></text></g></g><path
+ id="path634"
+ style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 304.56,109.68 h 113.4 v 42.96 h -113.4 z" /><path
+ id="path636"
+ style="fill:none;stroke:#003b74;stroke-width:0.96;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:10;stroke-dasharray:none;stroke-opacity:1"
+ d="m 304.56,109.68 h 113.4 v 42.96 h -113.4 z" /><g
+ id="g638"><g
+ clip-path="url(#clipPath644)"
+ id="g640"><text
+ id="text648"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,318.31,141.02)"><tspan
+ id="tspan646"
+ sodipodi:role="line"
+ y="0"
+ x="0 7.428 14.136 20.844 24.84 34.872002 41.580002 44.243999 47.220001 53.220001 55.883999 65.928001 69.264 72.528 79.236 85.944">Thermal sim. up </tspan></text></g></g><g
+ id="g650"><g
+ clip-path="url(#clipPath656)"
+ id="g652"><text
+ id="text660"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,330.67,126.62)"><tspan
+ id="tspan658"
+ sodipodi:role="line"
+ y="0"
+ x="0 3.336 10.068 13.308 20.016001 26.724001 30.059999 36.792 39.911999 48.431999 51.096001 54.431999 61.139999">to date with </tspan></text></g></g><g
+ id="g662"><g
+ clip-path="url(#clipPath668)"
+ id="g664"><text
+ id="text672"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,321.67,112.2)"><tspan
+ id="tspan670"
+ sodipodi:role="line"
+ y="0"
+ x="0 6.7080002 9.3719997 16.044001 22.044001 25.416 29.412001 32.015999 38.015999 44.723999 47.388 50.484001 56.484001 59.147999 69.192001 72.528">electrical sim.?</tspan></text></g></g><g
+ id="g674"><g
+ clip-path="url(#clipPath680)"
+ id="g676"><path
+ id="path682"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 503.16,114.72 c -5.1,0 -9.24,4.11 -9.24,9.18 0,5.07 4.14,9.18 9.24,9.18 v -4.59 c -2.57,0 -4.65,-2.05 -4.65,-4.59 0,-2.53 2.08,-4.59 4.65,-4.59 z" /></g></g><g
+ id="g684"><g
+ clip-path="url(#clipPath690)"
+ id="g686"><path
+ id="path692"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 498.72,76.32 h 4.44 v 41.28 h -4.44 z" /></g></g><g
+ id="g694"><g
+ clip-path="url(#clipPath700)"
+ id="g696"><path
+ id="path702"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 441.12,133.32 -14.76,6.78 14.76,6.78 z" /></g></g><path
+ id="path704"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 477.12,121.56 h 98.64 v 4.56 h -98.64 z" /><g
+ id="g706"><g
+ clip-path="url(#clipPath712)"
+ id="g708"><text
+ id="text716"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,551.02,109.73)"><tspan
+ id="tspan714"
+ sodipodi:role="line"
+ y="0"
+ x="0 5.8800001 12.588">yes</tspan></text></g></g><g
+ id="g718"><g
+ clip-path="url(#clipPath724)"
+ id="g720"><text
+ id="text728"
+ style="font-variant:normal;font-weight:normal;font-size:12.024px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,591.22,85.632)"><tspan
+ id="tspan726"
+ sodipodi:role="line"
+ y="0"
+ x="0 6.7200441">no</tspan></text></g></g><g
+ id="g730"><g
+ clip-path="url(#clipPath736)"
+ id="g732"><path
+ id="path738"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 498.84,130.68 h 4.32 v 84.72 h -4.32 z" /></g></g><path
+ id="path740"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 435.24,210.84 h 67.92 v 4.56 h -67.92 z" /><g
+ id="g742"><g
+ clip-path="url(#clipPath748)"
+ id="g744"><path
+ id="path750"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 440.64,205.8 -14.76,6.78 14.76,6.78 z" /></g></g><g
+ id="g752"><g
+ clip-path="url(#clipPath758)"
+ id="g754"><text
+ id="text762"
+ style="font-variant:normal;font-weight:normal;font-size:12.024px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,507.26,89.352)"><tspan
+ id="tspan760"
+ sodipodi:role="line"
+ y="0"
+ x="0 5.8797359 12.56508">yes</tspan></text></g></g><g
+ id="g764"><g
+ clip-path="url(#clipPath770)"
+ id="g766"><path
+ id="path772"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 435.24,41.52 -14.88,6.78 14.88,6.78 z" /></g></g><path
+ id="path774"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 429.6,46.08 h 9.96 v 4.44 h -9.96 z" /><g
+ id="g776"><g
+ clip-path="url(#clipPath782)"
+ id="g778"><text
+ id="text786"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,423.05,57.024)"><tspan
+ id="tspan784"
+ sodipodi:role="line"
+ y="0"
+ x="0 6.7199998">no</tspan></text></g></g><g
+ id="g788"><g
+ clip-path="url(#clipPath794)"
+ id="g790"><path
+ id="path796"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 357.36,76.08 h 4.56 v 18.48 h -4.56 z" /></g></g><path
+ id="path798"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 352.8,87.96 6.78,14.88 6.78,-14.88 z" /><path
+ id="path800"
+ style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 163.32,27 h 113.4 v 42.96 h -113.4 z" /><path
+ id="path802"
+ style="fill:none;stroke:#003b74;stroke-width:0.96;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:10;stroke-dasharray:none;stroke-opacity:1"
+ d="m 163.32,27 h 113.4 v 42.96 h -113.4 z" /><g
+ id="g804"><g
+ clip-path="url(#clipPath810)"
+ id="g806"><text
+ id="text814"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,186.67,51.12)"><tspan
+ id="tspan812"
+ sodipodi:role="line"
+ y="0"
+ x="0 8.0279999 11.364 18.096001 24.804001 31.511999 37.391998 40.632 46.632 49.967999 56.700001 60.035999">Steady state</tspan></text></g></g><g
+ id="g816"><g
+ clip-path="url(#clipPath822)"
+ id="g818"><text
+ id="text826"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,203.14,36.72)"><tspan
+ id="tspan824"
+ sodipodi:role="line"
+ y="0"
+ x="0 6 11.88 17.879999 20.544001">cycle</tspan></text></g></g><g
+ id="g828"><g
+ clip-path="url(#clipPath834)"
+ id="g830"><text
+ id="text838"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,230.38,36.72)"><tspan
+ id="tspan836"
+ y="0"
+ x="0">?</tspan></text></g></g><g
+ id="g840"><g
+ clip-path="url(#clipPath846)"
+ id="g842"><path
+ id="path848"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 155.28,42.24 -14.76,6.78 14.76,6.78 z" /></g></g><path
+ id="path850"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 149.76,46.68 h 9.96 v 4.56 h -9.96 z" /><g
+ id="g852"><g
+ clip-path="url(#clipPath858)"
+ id="g854"><text
+ id="text862"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,170.71,92.28)"><tspan
+ id="tspan860"
+ sodipodi:role="line"
+ y="0"
+ x="0 5.8800001 12.588">yes</tspan></text></g></g><g
+ id="g864"><g
+ clip-path="url(#clipPath870)"
+ id="g866"><path
+ id="path872"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 251.16,85.08 h 4.56 v 48.72 h -4.56 z" /></g></g><path
+ id="path874"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="M 260.28,92.16 253.5,77.4 246.72,92.16 Z" /><g
+ id="g876"><g
+ clip-path="url(#clipPath882)"
+ id="g878"><path
+ id="path884"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 192.72,76.92 h 4.56 v 45.48 h -4.56 z" /></g></g><path
+ id="path886"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 252.24,129.24 h 38.28 v 4.56 h -38.28 z" /><path
+ id="path888"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 150,129.24 h 85.8 v 4.56 H 150 Z" /><g
+ id="g890"><g
+ clip-path="url(#clipPath896)"
+ id="g892"><text
+ id="text900"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,143.06,57.552)"><tspan
+ id="tspan898"
+ sodipodi:role="line"
+ y="0"
+ x="0 6.7199998">no</tspan></text></g></g><path
+ id="path902"
+ style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 23.76,109.68 h 113.4 v 42.96 H 23.76 Z" /><path
+ id="path904"
+ style="fill:none;stroke:#003b74;stroke-width:0.96;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:10;stroke-dasharray:none;stroke-opacity:1"
+ d="m 23.76,109.68 h 113.4 v 42.96 H 23.76 Z" /><g
+ id="g906"><g
+ clip-path="url(#clipPath912)"
+ id="g908"><text
+ id="text916"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,42.336,133.82)"><tspan
+ id="tspan914"
+ sodipodi:role="line"
+ y="0"
+ x="0 8.6639996 15.336 19.332001 23.280001 29.988001 36.695999 40.032001 43.175999 49.883999 53.880001 60.551998 64.031998 66.695999 69.311996 76.019997">Current profile </tspan></text></g></g><g
+ id="g918"><g
+ clip-path="url(#clipPath924)"
+ id="g920"><text
+ id="text928"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,56.4,119.42)"><tspan
+ id="tspan926"
+ sodipodi:role="line"
+ y="0"
+ x="0 3.4679999 6.132 12.804 15.468 21.468 28.176001 34.776001 41.484001">finished?</tspan></text></g></g><g
+ id="g930"><g
+ clip-path="url(#clipPath936)"
+ id="g932"><path
+ id="path938"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 77.88,75.96 h 4.56 v 18.48 h -4.56 z" /></g></g><path
+ id="path940"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="M 73.32,87.84 80.1,102.6 86.88,87.84 Z" /><path
+ id="path942"
+ style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 163.56,191.4 h 113.52 v 42.96 H 163.56 Z" /><path
+ id="path944"
+ style="fill:none;stroke:#003b74;stroke-width:0.96;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:10;stroke-dasharray:none;stroke-opacity:1"
+ d="m 163.56,191.4 h 113.52 v 42.96 H 163.56 Z" /><g
+ id="g946"><g
+ clip-path="url(#clipPath952)"
+ id="g948"><text
+ id="text956"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,179.38,215.59)"><tspan
+ id="tspan954"
+ sodipodi:role="line"
+ y="0"
+ x="0 8.6639996 14.52 20.52 23.184 29.856001 35.855999 39.228001 45.936001 49.403999 52.644001 59.352001 65.952003 68.615997 75.288002 81.912003">Cycles of aging </tspan></text></g></g><g
+ id="g958"><g
+ clip-path="url(#clipPath964)"
+ id="g960"><text
+ id="text968"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,183.22,201.19)"><tspan
+ id="tspan966"
+ sodipodi:role="line"
+ y="0"
+ x="0 6 9.3360004 16.068001 22.775999 26.016001 29.483999 32.147999 38.82 41.484001 47.484001 54.192001 60.792 67.391998">step finished?</tspan></text></g></g><path
+ id="path970"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 160.8,117.84 h 34.44 v 4.56 H 160.8 Z" /><g
+ id="g972"><g
+ clip-path="url(#clipPath978)"
+ id="g974"><path
+ id="path980"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 164.28,112.92 -14.76,6.78 14.76,6.78 z" /></g></g><path
+ id="path982"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 149.4,140.64 h 67.44 v 4.56 H 149.4 Z" /><g
+ id="g984"><g
+ clip-path="url(#clipPath990)"
+ id="g986"><path
+ id="path992"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 212.28,142.44 h 4.56 v 33.24 h -4.56 z" /></g></g><path
+ id="path994"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 208.32,168.72 6.78,14.76 6.78,-14.76 z" /><g
+ id="g996"><g
+ clip-path="url(#clipPath1002)"
+ id="g998"><text
+ id="text1006"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,150.46,151.1)"><tspan
+ id="tspan1004"
+ sodipodi:role="line"
+ y="0"
+ x="0 5.8800001 12.588">yes</tspan></text></g></g><g
+ id="g1008"><g
+ clip-path="url(#clipPath1014)"
+ id="g1010"><path
+ id="path1016"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 231.72,129.24 h 4.56 V 174 h -4.56 z" /></g></g><path
+ id="path1018"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 231.72,169.44 h 250.2 V 174 h -250.2 z" /><path
+ id="path1020"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="M 357.12,297.48 H 570 v 4.56 H 357.12 Z" /><g
+ id="g1022"><g
+ clip-path="url(#clipPath1028)"
+ id="g1024"><path
+ id="path1030"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 482.22,203.52 c -5.07,0 -9.18,4.11 -9.18,9.18 0,5.07 4.11,9.18 9.18,9.18 v -4.59 c -2.53,0 -4.59,-2.06 -4.59,-4.59 0,-2.53 2.06,-4.59 4.59,-4.59 z" /></g></g><g
+ id="g1032"><g
+ clip-path="url(#clipPath1038)"
+ id="g1034"><path
+ id="path1040"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 477.72,169.44 h 4.56 v 36.36 h -4.56 z" /></g></g><g
+ id="g1042"><g
+ clip-path="url(#clipPath1048)"
+ id="g1044"><path
+ id="path1050"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 477.84,220.44 h 4.56 v 81.6 h -4.56 z" /></g></g><g
+ id="g1052"><g
+ clip-path="url(#clipPath1058)"
+ id="g1054"><path
+ id="path1060"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 560.88,306.84 14.76,-6.78 -14.76,-6.78 z" /></g></g><g
+ id="g1062"><g
+ clip-path="url(#clipPath1068)"
+ id="g1064"><text
+ id="text1072"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,207.98,117.79)"><tspan
+ id="tspan1070"
+ sodipodi:role="line"
+ y="0"
+ x="0 6.7199998">no</tspan></text></g></g><g
+ id="g1074"><g
+ clip-path="url(#clipPath1080)"
+ id="g1076"><path
+ id="path1082"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 155.52,205.44 -14.76,6.78 14.76,6.78 z" /></g></g><path
+ id="path1084"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 150,209.88 h 9.84 v 4.56 H 150 Z" /><g
+ id="g1086"><g
+ clip-path="url(#clipPath1092)"
+ id="g1088"><text
+ id="text1096"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,140.93,192.53)"><tspan
+ id="tspan1094"
+ sodipodi:role="line"
+ y="0"
+ x="0 5.8800001 12.588">yes</tspan></text></g></g><path
+ id="path1098"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 438.72,137.76 h 42.96 v 4.56 h -42.96 z" /><g
+ id="g1100"><g
+ clip-path="url(#clipPath1106)"
+ id="g1102"><path
+ id="path1108"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 477.12,122.16 h 4.56 v 20.04 h -4.56 z" /></g></g><g
+ id="g1110"><g
+ clip-path="url(#clipPath1116)"
+ id="g1112"><path
+ id="path1118"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 637.56,166.32 h 4.56 v 18.6 h -4.56 z" /></g></g><path
+ id="path1120"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 646.68,172.92 -6.78,-14.76 -6.78,14.76 z" /><path
+ id="path1122"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 425.88,121.92 h 40.68 v 4.56 h -40.68 z" /><g
+ id="g1124"><g
+ clip-path="url(#clipPath1130)"
+ id="g1126"><path
+ id="path1132"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 462,90.12 h 4.56 v 32.52 H 462 Z" /></g></g><path
+ id="path1134"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="M 471.12,92.16 464.34,77.4 457.56,92.16 Z" /><g
+ id="g1136"><g
+ clip-path="url(#clipPath1142)"
+ id="g1138"><text
+ id="text1146"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,272.74,117.05)"><tspan
+ id="tspan1144"
+ sodipodi:role="line"
+ y="0"
+ x="0 5.8800001 12.588">yes</tspan></text></g></g><g
+ id="g1148"><g
+ clip-path="url(#clipPath1154)"
+ id="g1150"><text
+ id="text1158"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,430.54,108.41)"><tspan
+ id="tspan1156"
+ sodipodi:role="line"
+ y="0"
+ x="0 6.7199998">no</tspan></text></g></g><g
+ id="g1160"><g
+ clip-path="url(#clipPath1166)"
+ id="g1162"><path
+ id="path1168"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 357.12,243.12 h 4.56 v 58.44 h -4.56 z" /></g></g><path
+ id="path1170"
+ style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 21.24,273.36 h 113.4 v 42.96 H 21.24 Z" /><path
+ id="path1172"
+ style="fill:none;stroke:#003b74;stroke-width:0.96;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:10;stroke-dasharray:none;stroke-opacity:1"
+ d="m 21.24,273.36 h 113.4 v 42.96 H 21.24 Z" /><g
+ id="g1174"><g
+ clip-path="url(#clipPath1180)"
+ id="g1176"><text
+ id="text1184"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,38.952,297.53)"><tspan
+ id="tspan1182"
+ sodipodi:role="line"
+ y="0"
+ x="0 8.0279999 10.692 13.308 16.643999 23.375999 29.976 32.639999 39.312 45.936001 49.056 55.056 58.391998 65.124001 71.832001 77.832001">All aging steps </tspan></text></g></g><g
+ id="g1186"><g
+ clip-path="url(#clipPath1192)"
+ id="g1188"><text
+ id="text1196"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,61.152,283.13)"><tspan
+ id="tspan1194"
+ sodipodi:role="line"
+ y="0"
+ x="0 6.7199998 13.44 20.16 26.879999">done?</tspan></text></g></g><g
+ id="g1198"><g
+ clip-path="url(#clipPath1204)"
+ id="g1200"><path
+ id="path1206"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 77.88,240.84 h 4.56 v 18.6 h -4.56 z" /></g></g><path
+ id="path1208"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 73.32,252.84 6.78,14.76 6.78,-14.76 z" /><path
+ id="path1210"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 163.92,272.88 h 113.4 v 42.96 h -113.4 z" /><path
+ id="path1212"
+ style="fill:none;stroke:#003b74;stroke-width:0.96;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:10;stroke-dasharray:none;stroke-opacity:1"
+ d="m 163.92,272.88 h 113.4 v 42.96 h -113.4 z" /><g
+ id="g1214"><g
+ clip-path="url(#clipPath1220)"
+ id="g1216"><text
+ id="text1224"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,181.2,289.92)"><tspan
+ id="tspan1222"
+ sodipodi:role="line"
+ y="0"
+ x="0 8.0279999 14.736 21.444 24.563999 30.563999 33.228001 43.271999 49.98 52.644001 59.316002 62.688 65.351997 72.024002">End simulation</tspan></text></g></g><g
+ id="g1226"><g
+ clip-path="url(#clipPath1232)"
+ id="g1228"><path
+ id="path1234"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 144.84,300.48 14.88,-6.78 -14.88,-6.78 z" /></g></g><path
+ id="path1236"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 140.52,291.48 h 9.96 v 4.56 h -9.96 z" /><g
+ id="g1238"><g
+ clip-path="url(#clipPath1244)"
+ id="g1240"><text
+ id="text1248"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,139.25,274.27)"><tspan
+ id="tspan1246"
+ sodipodi:role="line"
+ y="0"
+ x="0 5.8800001 12.588">yes</tspan></text></g></g><g
+ id="g1250"><g
+ clip-path="url(#clipPath1256)"
+ id="g1252"><path
+ id="path1258"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 498.72,333.36 h 4.44 v 45.96 h -4.44 z" /></g></g><path
+ id="path1260"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 77.64,333.24 h 425.52 v 4.56 H 77.64 Z" /><g
+ id="g1262"><g
+ clip-path="url(#clipPath1268)"
+ id="g1264"><path
+ id="path1270"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 315.12,252.48 h 4.44 v 84.24 h -4.44 z" /></g></g><path
+ id="path1272"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 214.56,252.12 h 104.88 v 4.56 H 214.56 Z" /><g
+ id="g1274"><g
+ clip-path="url(#clipPath1280)"
+ id="g1276"><path
+ id="path1282"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 212.64,240.24 h 4.44 v 16.44 h -4.44 z" /></g></g><g
+ id="g1284"><g
+ clip-path="url(#clipPath1290)"
+ id="g1286"><text
+ id="text1294"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,222.29,239.71)"><tspan
+ id="tspan1292"
+ sodipodi:role="line"
+ y="0"
+ x="0 6.7199998">no</tspan></text></g></g><g
+ id="g1296"><g
+ clip-path="url(#clipPath1302)"
+ id="g1298"><path
+ id="path1304"
+ style="fill:#00549f;fill-opacity:1;fill-rule:evenodd;stroke:none"
+ d="m 77.76,322.32 h 4.56 v 14.76 h -4.56 z" /></g></g><g
+ id="g1306"><g
+ clip-path="url(#clipPath1312)"
+ id="g1308"><text
+ id="text1316"
+ style="font-variant:normal;font-weight:normal;font-size:12px;font-family:Arial;-inkscape-font-specification:ArialMT;writing-mode:lr-tb;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+ transform="matrix(1,0,0,-1,59.808,326.28)"><tspan
+ id="tspan1314"
+ sodipodi:role="line"
+ y="0"
+ x="0 6.7199998">no</tspan></text></g></g></g></svg>
diff --git a/doxygen/mainpage.md b/doxygen/mainpage.md
index 7537db5568a1764327cb5e16980a169302328a1f..9323c5981d39a87fc4311d612ad583a6e55b9ff8 100644
--- a/doxygen/mainpage.md
+++ b/doxygen/mainpage.md
@@ -1,35 +1,15 @@
-Kurzanleitung / Short introduction ISEAFramework {#mainpage}
+ISEAFrame Documentation {#mainpage}
=======================
-\~German
- Das ISEAFramework ist eine Programmbibliothek zur generischen Simulation verschiedener Batterietypen und Supercaps.
-
-Diese Anleitung gliedert sich in folgende Teile:
-- [Einleitung](einleitung.html)
-- [Getting Started](gettingStarted.html)
-- [Kompilieren](compiling.html)
-- [XML-Beschreibungssprache](xmlsprache.html)
-- [Factory und Parser](factory.html)
-- [Solversystem](system.html)
-- [Executable mit elektrisch/thermischer Simulation](xmlexecutable.html)
-- [Simulink](xmlcinterface.html)
-- [Visualisierung der Simulationsdaten](visualization.html)
-- [Halbzellensimulation](xmlhalfcell.html)
-- [Alterungsimulation] (aging_simulation.html)
-
-\~English
-
- The ISEAFramework is a library for generic simulation of various battery types and double layer capacitor.
+ The ISEAFramework is a library for generic simulation of various battery types and double layer capacitors.
This short introduction can be divided into the following parts:
-- [Introduction](einleitung.html)
+- [Introduction](introduction.html)
- [Getting Started](gettingStarted.html)
- [Compiling](compiling.html)
- [XML-description language](xmlsprache.html)
-- [Factory and Parser](factory.html)
-- [Solver systems](system.html)
- [Standalone executable for electrical and thermal simulation ](xmlexecutable.html)
-- [Simulink](xmlcinterface.html)
+- [Simulink Converter](simulink_converter.html)
- [Visualization of simulation data](visualization.html)
- [Half cell simulation](xmlhalfcell.html)
- [Aging simulation](aging_simulation.html)
diff --git a/doxygen/simulation_cycle.md b/doxygen/simulation_cycle.md
new file mode 100644
index 0000000000000000000000000000000000000000..c2083403c44260b3d6520a0521674b10f615e344
--- /dev/null
+++ b/doxygen/simulation_cycle.md
@@ -0,0 +1,50 @@
+Simulation Cycle {#simulation_cycle}
+====
+
+Electrical Simulation
+----
+
+
+The steps of the electrical simulation are pictured above.
+
+### 1. Initialize the simulation
+The circuit elements and their parameters are read from a [configuration file](xmlsprache.html). This file also determines the initial state of the system.
+
+### 2. Set requested current
+For each simulation, the current through the simulated system is given as a function of time. For the standalone version, this is done with a [current profile](xmlexecutable.html). For each timestep of the electrical model, the profile is evaluated at the current time and the current is set.
+
+### 3. Update of lookup tables
+Most elements in the electrical circuit change their values depending on system states like SoC or temperature. For each timestep, the values are updated by evaluating the respective lookup tables.
+
+### 4. Calculation of differential and algebraic equations (DAE)
+Since the values of the electrical system change each time the lookup tables are evaluated, the system equations have to be recalculated for every time step. Since there are both algebraic and differential equations, this results in an ODE system.
+
+### 5. Solving the DAE system and calculating the state space vector
+The system is turned into an ordinary differential equation system and solved.
+
+### 6. Calculating current and voltage values
+After the state space vector is calculated, the voltage and current values for each element in the electrical system can be easily calculated.
+
+Thermal Simulation
+----
+If the thermal model is used, [thermal blocks](xmlthermalblock.html) are added to the configuration file. When the simulation is initialized, the thermal model is built as described [here](xmlthermalmodel.html). This results in a conductivity matrix that is used to calculate the flow of thermal energy between any two thermal elements. In contrast to the electrical model, the parameters of the thermal model stay constant for the duration of the simulation. After each electrical step, the ohmic heat generation during the timestep is passed from the electrical to the thermal model. The conductivity matrix as wall as the parameters given by additional cooling blocks are used to determine the temperature distribution inside the system. The temperature values are passed back to the electrical simulation and influence the electrical parameters for the next timestep.
+
+Aging Simulation
+----
+
+To simulate the aging of cells, [aging effects](aging_simulation.html) are added to the cells. These effects are calculated independently from each other. The timespans of the aging model are much larger than those of the electrical and thermal models, so the aging is only calculated after a certain time has passed in the thermal-electrical model. During the thermal-electrical simulation, each aging effect is called regularly to collect data needed for the aging step. This data is used to calculate three values for every aging effect:
+- The capacity factor \f$ C_{rel} \f$. The initial capacity of the cell is multiplied with this factor to get the capacity after the aging effect has been applied.
+- The resistance factor \f$ R_{rel} \f$. The initial internal resistance of the cell is multiplied with this factor to get the resistance after the aging effect has been applied.
+- The SOC offset \f$ \Delta Q \f$. The offset is added to the stored charge when the aging effect is applied.
+
+The total aging for a cell with \f$ n \f$ aging effects are calculated in the following way:
+
+\f{eqnarray*}{
+C_{rel,total} & = && 1 - \sum_{n} ( 1 - C_{rel,n} ) \\
+R_{rel,total} & = && 1 - \sum_{n} ( 1 - R_{rel,n} ) \\
+\Delta Q_{total} & = && \sum_{n} \Delta Q_n \\
+\f}
+
+Complete Procedure
+----
+
diff --git a/doxygen/simulink_converter.md b/doxygen/simulink_converter.md
new file mode 100644
index 0000000000000000000000000000000000000000..91aeeb6484004d1b1f757477cfd493fb8f9fb823
--- /dev/null
+++ b/doxygen/simulink_converter.md
@@ -0,0 +1,66 @@
+Simulink Converter {#simulink_converter}
+========================================
+
+The framework can be used with Simulink in two different ways: by using the [s-Functions](xmlcinterface.html), or by using the simulink converter. The converter reads a configuration from an XML file and turns it into a Simulink model that uses only native Simulink blocks.
+
+Running the converter
+---------------------
+The converter and all necessary files can be downloaded from Gitlab. Alternative, the s-Functions used for the converter can be compiled and copied to the folder simulink_model_creator.
+
+The converter is executed with the following matlab commands:
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+configstr = fileread('file.xml');
+CreateSimulinkModel(configstr, 1)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This will create the simulink model and open it.
+The complete signature of CreateSimulinkModel is:
+
+CreateSimulinkModel(configstring, modelType, modelLocation, initialStateStruct)
+
+* configstring: The contents of an XML file describing the system
+* modelType: type of the simulink model, 0 = CircuitModel (currently broken), 1 = MatrixModel
+* modelLocation: System that the model will be built in
+* initialStateStruct: workspace variable that contains the initial state of the model
+
+Additional functions
+====================
+
+A few additional functions are available to modify the model after it was created.
+
+LoadObjectValues
+----------------
+
+This function can be used to modify the values used in lookup tables after the model has been created. Apart from the values in the lookup tables, the model must be the same.
+
+LoadObjectValues(configstring, modelLocation='BuildMatrixModel')
+Loads the object values from the specified xml string to the simulink model previously created with CreateSimulinkModel.
+* configstring: The contents of an XML file describing the system
+* modelLocation: System that the model was built in
+
+LoadInitialState
+----------------
+
+This function is used to update the intial state of the model if it has changed in the XML file. Apart from the initial state, the model must be the same.
+
+Usage: LoadInitialState(configstring, initialStateStruct='MDL.battery.initialState')
+Loads the initial state from the specified xml string to the workspace for a simulink model previously created with CreateSimulinkModel.
+* configstring: The contents of an XML file describing the system
+* initialStateStruct: workspace variable that contains the initial state of the model
+
+AddSocInput
+-----------
+
+This function adds an additional input to the model that is used to set the initial SOC instead of reading it from the workspace.
+
+AddSocInput(modelLocation='BuildMatrixModel')
+* modelLocation: System that the model was built in
+
+Discretize
+----------
+
+Tis function discretizes the created model by replacing all continuous integrators with discrete-time integrators.
+
+Discretize(modelLocation='BuildMatrixModel')
+* modelLocation: System that the model was built in
\ No newline at end of file
diff --git a/doxygen/system.md b/doxygen/system.md
deleted file mode 100644
index 2f225e38b495b28b0e86a636a190e7801bb301e2..0000000000000000000000000000000000000000
--- a/doxygen/system.md
+++ /dev/null
@@ -1,45 +0,0 @@
-Solver system {#system}
-============
-
-\~German
-
-Das Solversystem berechnet ein elektrisches Netzwerk ausgehend von den Maschen- und Differentialgleichungen.<br/>
-Dafür wird der Zustandvektor des Zustandsraummodells für einen Simulationszyklus neuberechnet.
-
-Über den Konstruktor werden der Klasse die systm::StateSystemGroup und der Wert für dT übergeben.<br/>
-Dabei ist dT die Dauer eines einzelnen Simulationschrittes.
-
-__Wichtig:__ Für dT gleich Null wird ein Solver mit __variabler Schrittweite__ eingesetzt.
-
-Der Konstruktor der Klasse systm::System:
-
-~~~~~~~~~~~~~
-System(StateSystemGroup< T >* stateSystemGroup, double dt = 0);
-~~~~~~~~~~~~~
-
-
-Hier ein Codebeispiel für die Verwendung der Klasse systm::System:
-
-\htmlinclude examples/solverbsp_color.xml
-\endif
-
-
-\~English
-
-The equation solver computes an electrical network based on mash equations and linear differential equations.<br/>
-In order to do this, the state vector of the state space model is recalculated for the next simulation iteration.
-
-Via the constructor the class gets systm::StateSystemGroup and the value of dT.<br/>
-dT is the size of a single simulation step.
-
-__Important:__ If dT equals zero, a solver with __variable step size__ is used.
-
-The constructor of the class systm::System:
-
-~~~~~~~~~~~~~
-System(StateSystemGroup< T >* stateSystemGroup, double dt = 0);
-~~~~~~~~~~~~~
-
-This is an example for a code for the usage of the class systm::System:
-
-\htmlinclude examples/solverbsp_color.xml
diff --git a/doxygen/visualization.md b/doxygen/visualization.md
index feea1afacde9b2fa57ae0d184c5d80ac2d76285c..7fd732568a7e78da84cee96595897237880b5911 100644
--- a/doxygen/visualization.md
+++ b/doxygen/visualization.md
@@ -1,39 +1,9 @@
Visualization {#visualization}
==========
-\~German
-
-Die folgenden Matlab-Funktionen dienen dazu, die von der Simulation erstellten Daten anschaulich darzustellen.
-Sie sind im Ordner auswertung zu finden.
-
-Eine Beschreibung der Funktion befindet sich ebenfalls in der Datei, in der die Funktion abgespeichert ist.
-\ifnot RELEASE_DOCU
-- MakePlotsForCellData.m, stellt die Ausgabe der executable da
-
-\endif
-Die folgenden Funktionen benötigen als Inputparameter die Ergebnisse der Simulation, abgespeichert in den folgenden Dateien:<br/>
-Patch_Areas.csv <br/>
-Patch_Vertices.csv <br/>
-Patch_Temperatures.csv <br/>
-Diese werden erzeugt, wenn der ThermalVisualizer-Tag in den [Options](xmloption.html) der Konfigurationsdatei vorhanden ist.
-
-
-- VisualizeCreatingPictures.m, erzeugt eine Folge von Bildern des BatteryPacks und speichert diese als Bilder
-- VisualizeMakingMovie.m, erzeugt aus den Simulationsergebnissen eine Videodatei (mpeg4)
-- VisualizePlayingVideos.m, erzeugt verschiedene Matlabplots hintereinander, sodass sich der Eindruck eines Videos ergibt
-
-- PlotInit.m, zeigt den thermischen Initialisierungszustand des Packs an (Skript benötigt die **quickvisualize.exe** im selben Verzeichnis. Diese ist aus dem bin Ordner zu kopieren.)
-- PlotVideo.m, zeigt ähnlich wie VisualizePlayingVideos.m eine Folge von Matlabplots
-
-\~English
-
The following Matlab functions shall give a demonstrative view on the data generated by the simulation.
-They can be found in the folder auswertung.
+They can be found in the folder analysis.
In the same folder the function is in, a desciption of the function is saved.
-\ifnot RELEASE_DOCU
-- MakePlotsForCellData.m, this is the output of the executable
-
-\endif
The following functions need the inputparameters of the simulation solution, saved in the following files:<br/>
Patch_Areas.csv <br/>
Patch_Vertices.csv <br/>
diff --git a/doxygen/xmlcinterface.md b/doxygen/xmlcinterface.md
deleted file mode 100644
index b84b5b86cf59b87b09f13c33952d57da4d7913bd..0000000000000000000000000000000000000000
--- a/doxygen/xmlcinterface.md
+++ /dev/null
@@ -1,230 +0,0 @@
-Using the simulink model {#xmlcinterface}
-===============
-
-\~German
-Weitere Themen:
-- [Zusätzliche Simulink Bibliothek](bibs.html)
-- [\<Options\>-Knoten](xmloption.html)
-
-
-Simulink Multicell-Interface
-=========
-Das Multicell-Interface definiert die Schnittstelle von Simulink zum Framework. Innerhalb des MultiCellInterface liegt die S-Function, welche die unterschiedliche C++ Funktionen gekapselt, die das Verhalten des zu simulierenden Batteriesystem bestimmen.
-Konfiguriert werden kann das Modell über einen Konfigurationstring der im Matlab Workspace hinterlegt ist. Prinzipiell gibt es drei verschiedene MultiCellInterfaces für die Anwendungsfälle rein elektrische Simulation,
-rein thermische Simulation und gekoppelte thermische/elektrische Simulation. Die gekoppelte Variante steht sowohl als kontinuierlicher Matlab-Block als auch als diskreter Block zur Verfügung.
-
-
-
-S-Function Argumente
----------
-Die S-Funktion erwartet 4 Argumente, CONFIG_STR_A, CONFIG_STR_B, CONFIG_STR_C und DISPLAY_VERSION.
-Die ersten drei stellen dabei Variablen für die Konfigurationsdatei dar und werden vor begin der Simulation konkatiniert und ausgewertet.
-In einer reinen Simulink-Simulation ist es aussreichend in den CONFIG_STR_A den Konfigurationsstring zu hinterlegen und die Anderen als leer zu kennzeichnen.
-<pre>
- CONFIG_STR_A = fileread('XYL.xml');
- CONFIG_STR_B = '';
- CONFIG_STR_C = '';
-</pre>
-
-
-<b> ACHTUNG </b>
-
-Für das Echtzeitboard ist es erforderlich, dass die Strings zu Doubles konvertiert werden. Es muss darauf geachtet werden, dass die einzelnen Konfigurationsstrings nicht zu lang sind.
-
-<pre>
- CONFIG_STR_A = convert2double( fileread('XYL.xml') );
- CONFIG_STR_B = '';
- CONFIG_STR_C = '';
-</pre>
-
-
-
-
-Inputports
----------
-
-Die Inputports der verschiedenen MultiCellInterfaces sind in der folgenden Tabelle angegeben:
-
-
-|Input Ports | Elektrisches \n Modell | Thermisches \n Modell | Thermisch-Elektrisches \n Modell | Beschreibung |
-|------------------| :--------------------: | :-------------------: | :------------------------------: | :----------- |
-|Reset | x | x | x | Wenn Reset=0 ist, passiert nichts. Andernfalls wird das Modell zurückgesetzt. \n Das bedeutet, dass die laufende Simulation endet und das Modell komplett neu mit Hilfe der xml-Datei aufgebaut wird. |
-|I_Bat_Source | x | o | x | Der Ladestrom in die Batterie zum jeweiligen Zeitpunkt. |
-|T_Ambient | o | x | x | Die Umgebungstemperatur zum jeweiligen Zeitpunkt. |
-|P_Thermal | o | x | o | Die Verlustleistung der Batteriezellen zum jeweiligen Zeitpunkt. \n Die Dimension dieses Inputports ist die Anzahl der Zellen in der Batterie. |
-|I_Delta_Multicell | x | o | x | Der Ausgleichsstrom (Balancing Current) zwischen den Zellen der Batterie zum jeweiligen Zeitpunkt. \n Dies ist der Strom, der von einem BMS zusätzlich in die einzelne Zelle geladen wird. \n Die Dimension dieses Inputports ist die Anzahl der Zellen in der Batterie. |
-
-
-x = Port vorhanden,
-o = Port vorhanden und ohne Funktion,
-"leer" = Port nicht vorhanden
-
-
-Outputports
----------
-
-|Output Ports | Elektrisches \n Modell | Thermisches \n Modell | Thermisch-Elektrisches \n Modell | Beschreibung |
-|------------------| :--------------------: | :-------------------: | :------------------------------: | :----------- |
-|SignalBus | x | x | x | Fasst mehrere Signale in einem Bus zusammen. \n **Details siehe unten.** |
-|V_Bat | x | x | x | Spannung über das gesamte Batteriepack. |
-|V_Batt_Cell | x | x | x | Spannung über die einzelnen Batteriezellen. \n Die Dimension dieses Outports ist die Anzahl der Zellen in der Batterie. |
-
-
-x = Port vorhanden,
-o = Port vorhanden und ohne Funktion,
-"leer" = Port nicht vorhanden
-
-
-|SignalBus | Elektrisches \n Modell | Thermisches \n Modell | Thermisch-Elektrisches \n Modell | Beschreibung |
-|------------------| :--------------------: | :-------------------: | :------------------------------: | :----------- |
-|Current vector | x | | x | Strom in die einzelnen Batteriezellen. \n Die Dimension dieses Outports ist die Anzahl der Zellen in der Batterie. |
-|Ohmic heat \n generation vector | x | | x | Verlustleistung produziert in den einzelnen Batteriezellen. \n Die Dimension dieses Outports ist die Anzahl der Zellen in der Batterie. |
-|State of charge Vector | x | | x | State of Charge der einzelnen Batteriezellen. \n Die Dimension dieses Outports ist die Anzahl der Zellen in der Batterie. |
-|Surface SOC vector | x | | x | Oberflächen-State-of-Charge der einzelnen Batteriezellen. \n Die Dimension dieses Outports ist die Anzahl der Zellen in der Batterie. |
-|MEM_USED_OR_FRAGMENTED | x | x | x | Wenn diese Funktionalität nicht implementiert ist, wird immer 0 angezeigt. |
-|Total Current | x | | x | Strom in das gesamte Batteriepack. |
-|Total heat generation | x | | x | Gesamtverlustleistung des Batteriepacks. |
-|Total amount of Batteries | x | | x | Anzahl der Batteriezellen in dem Batteriepack. |
-|Number of used states | x | x | x | Anzahl der verwendeten Zustände für den Gleichungslöser. |
-|Emplacement points | | x | | Anzahl der verwendeten Zustände für den Gleichungslöser. |
-|Cell temperature vector | | x | | Temperaturen der einzelnen Zellelemente. |
-|Temperature vector | | | x | Temperaturen der einzelnen Zellelemente. |
-
-x = Signal vorhanden,
-"leer" = Signal nicht vorhanden
-
-
-\ifnot RELEASE_DOCU
-Falls mit Ausgabe der internen Zustände kompiliert, erhält die S-Function innerhalb des MulticellInterface zwei weitere Ausgänge:
-- **State vector:** Die Zustände, die dem Gleichungslöser übergeben werden.
-- **Dxdt vector:** Die Zustandsableitungen nach der Zeit, die dem Gleichungslöser übergeben werden.
-\endif
-
-
-Konfigurationsstring
-=====
-Der Konfigurationsstring entspricht der als char-Array eingelesenen XML-Datei. Für die Echtzeitberechnung muss der Konfigurationsstring (XML-Konfigurationsdatei) @b zu einem double array konvertiert werden.
-Dies ist der Eigenschaft vom Simulink zuzuschreiben, bei der im realtime Betrieb die mxArray Klasse keine Unterscheidung zwischen mx_CHAR_CLASS und mx_DOUBLE_CLASS mehr zulässt.
-Jeglicher Datentyp wird als mx_DOUBLE_CLASS dargestellt, obwohl dieser zur Kompilierzeit eine andere Größe haben könnte. Dieses kann zu Fehlern führen.
-Zur Konvertierung kann das Skript convert2double.m genutzt werden.
-
-Besonderheiten bei \<Options\>-Knoten
-===============
-\ifnot RELEASE_DOCU
-Im <**AirTemperature**>-Knoten darf keine Datei eingelesen werden (ReadFromFile="false" oder ReadFromFile-Attribut existiert nicht).
-\endif
-Der Inputport für die Außentemperatur muss verbunden und gesetzt sein. Der Wert in <**AirTemperature**> wird ignoriert.
-
-
-\~English
-Further topics:
-- [Additional Simulink libraries](bibs.html)
-- [\<Options\>-node](xmloption.html)
-
-
-Simulink multicell-interface
-=========
-The multicell interface defines the interface of simulink with the framework. The S-function, which wraps various C++-functions, determining the behaviour of the simulated battery system, is defined within the MultiCellInterface.
-The model can be configured via a configuration string, stored in the Matlab workspace. There are three different MultiCellInterfaces for the use in a pure electrical simulation,
-pure thermal or coupled electrical/thermal simulation. The coupled version can be configured as a continuously Matlab-block or as a discrete block.
-
-
-
-S-function arguments
----------
-The s-function expects 4 arguments, CONFIG_STR_A, CONFIG_STR_B, CONFIG_STR_C and DISPLAY_VERSION.
-The first three arguments represent variables for the configuration file and are concatenated and evaluated at the beginning.
-Within a pure Simulink-simulation, the following usage is perfectly valid (configuration string as first argument, CONFIG_STR_B and CONFIG_STR_C empty).
-<pre>
- CONFIG_STR_A = fileread('XYL.xml');
- CONFIG_STR_B = '';
- CONFIG_STR_C = '';
-</pre>
-
-
-<b> ATTENTION </b>
-
-During execution on the real-time board, it is necessary to convert the chars to doubles. It is necessary to ensure that separate strings are short enough.
-
-<pre>
- CONFIG_STR_A = convert2double( fileread('XYL.xml') );
- CONFIG_STR_B = '';
- CONFIG_STR_C = '';
-</pre>
-
-
-
-
-Input ports
----------
-
-The input ports of different MultiCellInterfaces are given in the following table:
-
-
-|Input ports | Electrical \n model | Thermal \n model | Thermal and electrical \n model | Description |
-|------------------| :--------------------: | :-------------------: | :------------------------------: | :----------- |
-|Reset | x | x | x | If Reset=0, nothing will happen. Otherwise, the model will be reset. \n This means, that the running simulation will be closed and the model will be completely rebuild with the help of the xml file. |
-|I_Bat_Source | x | o | x | The charging current of the battery at the respective time|
-|T_Ambient | o | x | x | The ambient temperature at the respective time. |
-|P_Thermal | o | x | o | The power loss at the respective time. \n The dimension of this input port is the number of cells in the battery pack. |
-|I_Delta_Multicell | x | o | x | The balancing current inbetween the cell of the battery at the respective time. \n This is the current, which is applied additionally from a BMS. \n The dimension of this input port is the number of cells in the battery pack. |
-
-
-x = port available,
-o = port available but without use,
-"empty" = port not available
-
-
-Output ports
----------
-
-|Output ports | Electrical \n model | Thermal \n model | Thermal and electrical \n model | Description |
-|------------------| :--------------------: | :-------------------: | :------------------------------: | :----------- |
-|SignalBus | x | x | x | Aggregates several signals in a single bus. \n **Details see below** |
-|V_Bat | x | x | x | Voltage across the whole battery pack. |
-|V_Batt_Cell | x | x | x | Voltage across single cells. \n The dimension of this port is the number of cells in the battery. |
-
-
-x = port available,
-o = port available but without use,
-"empty" = port not available
-
-
-|SignalBus | Electrical \n model | Thermal \n model | Thermal and electrical \n model | Description |
-|------------------| :--------------------: | :-------------------: | :------------------------------: | :----------- |
-|Current vector | x | | x | Current in the individual cells. \n The dimension of this port is the number of cells in the battery. |
-|Ohmic heat \n generation vector | x | | x | Power loss produced in the individual cells. \n The dimension of this port is the number of cells in the battery. |
-|State of charge Vector | x | | x | State of charge of the individual cells. \n The dimension of this port is the number of cells in the battery. |
-|Surface SOC vector | x | | x | Surface-state-of-charge of the individual cells. \n The dimension of this port is the number of cells in the battery. |
-|MEM_USED_OR_FRAGMENTED | x | x | x | If this function is not implemented, "0" will be displayed at all times. |
-|Total Current | x | | x | Current fed into the battery. |
-|Total heat generation | x | | x | Overall power loss of the battery pack. |
-|Total amount of Batteries | x | | x | Number of cells in the pack. |
-|Number of used states | x | x | x | Number of used states for the equation solver. |
-|Emplacement points | | x | | Number of used states for the equation solver. |
-|Cell temperature vector | | x | | Temperatures of the individual cell elements. |
-|Temperature vector | | | x | Temperatures of the individual cell elements. |
-
-x = signal available,
-"leer" = signal not available
-
-
-\ifnot RELEASE_DOCU
-If compiled with output of the internal states, the S-function will contain two additional ports within the MultiCellInterface:
-- **State vector:** The states, which are passed to the equation solver.
-- **Dxdt vector:** The time derivatives of the states, which are passed to the equation solver.
-\endif
-
-
-Configuration string
-=====
-The configuration string is equal with the xml file read as a char-array. The configuration string (XML configuration file) @b has to be converted to a double array, in order to do real time calculation.
-This is caused by the property of Simulink in real-time mode, which nullifies the possibility to distinguish inbetween mx_CHAR_CLASS and mx_DOUBLE_CLASS within the mxArray class.
-The script convert2double.m can be used for conversion.
-
-Characteristics of the \<Options\>-node
-===============
-\ifnot RELEASE_DOCU
-No files can be read within the <**AirTemperature**>-node (ReadFromFile="false" or ReadFromFile-attribute is not existing).
-\endif
-The input port for the ambient temperature has to be connected and set. The value within <**AirTemperature**> is ignored.
diff --git a/doxygen/xmlcooling.md b/doxygen/xmlcooling.md
index aaac5ff0790090b3a25904ea819f23880802c870..c6fa951b1ccc26ac84483034818db1297e4747d3 100644
--- a/doxygen/xmlcooling.md
+++ b/doxygen/xmlcooling.md
@@ -1,91 +1,6 @@
Coolings {#xmlcooling}
===================
-\~German
-
-Nachfolgend sind alle Kühlungen, die im thermischen Modell verwendet werden können, aufgelistet.
-Für jede Kühlung wird der Aufbau des dazugehörigen XML-Elementes beschrieben und ein Codebeispiel gegeben.
-
-<br/>
-
-Allgemein
-=========
-Jede Kühlung hat einen geometrischen Teil (Lage im Raum) und einen physikalischen Teil (Parametrierung der Stärke der Kühlung).
-Der geometrische Teil, der den Standort der Kühlung definiert, ist in einem der Kinder-Knoten eines <**CoolingBlocks**>-Knotens gegeben.
-Der physikalische Teil ist der <**Cooling**>-Knoten darin.
-Für beide Teile kann durch das Attribut "class" die jeweilige Art der Kühlung definiert werden, so dass beliebige Geometrien and Parametrierungen der Stärke der Kühlung miteinander kombiniert werden können.
-
-<br/>
-
-Geometrischer Teil
-==========
-
-<br/>
-
-Prismatische Geometrie
-----------
-
-__Objekttyp: "CoolingPrismatic"__
-
-<**Vertices**>: Eckpunkte des Polygons, das die Grundfläche des Prismas ist und das parallel zur xy-Ebene verläuft, in globalen kartesischen Koordinaten
-
-<**LowerZCoordinate**>: z-Koordinate der Grundfläche des Prismas
-
-<**UpperZCoordinate**>: z-Koordinate der Deckfläche des Prismas
-
-<**Cooling**>: Physikalischer Teil (Parametrierung der Stärke) der Kühlung
-
-
-Ein Prisma, dessen Grundfläche parallel zur xy-Ebene und deren Höhe parallel zur z-Achse verläuft.
-\htmlinclude waterCooling_color.xml
-
-Physikalischer Teil
-==========
-
-<br/>
-
-Neumann-Randbedingung (konstante Wärmestromdichte [W/m²] durch die Kühlung)
-----------
-
-__Objekttyp: "CoolingByConstantValue"__
-
-<**Value**>: Stärke der Kühlung in W/m²
-
-
-\htmlinclude cooling_by_constant_color.xml
-
-
-Look-Up-Tabelle: Wärmestromdichte abhängig von der Temperatur an der Grenzfläche Kühlung/thermischer Block.
-----------
-
-__Objekttyp: "CoolingByLookUp"__
-
-<**LookUpTable**>: [Parameterobjekt](xmlobject.html) mit Definitionen der Messpunkte in W/m² für die Look-Up-Tabelle
-
-
-Zwischen den Messpunkten der Look-Up-Tabelle wird linear interpoliert, wobei bei den Übergängen über einen Messpunkt leicht gerundet wird. Bei den Messpunkten handelt es sich um Temperaturen in °C.
-\htmlinclude cooling_lookuptable_color.xml
-
-
-Thermische Isolation
-----------
-
-__Objekttyp: "CoolingByLookUp"__
-
-Kein Kontakt zur Umgebung, somit kein Wärmeübergang (adiabat).
-\htmlinclude cooling_isolation_color.xml
-
-
-Dirichlet-Randbedingung (vorgegebene Randtemperatur)
-----------
-
-__Objekttyp: "DirichletBoundaryCondition"__
-
-Die Außenfläche, an der die Kühlung anliegt, wird konstant auf der vorgegebenen Temperatur gehalten.
-\htmlinclude cooling_dirichlet_boundary_condition_color.xml
-
-\~English
-
Consecutively all coolings, that are available in the thermal model, are listed.
For every cooling the structure of particular XML-file is described and an example for the code is given.
<br/>
@@ -109,46 +24,42 @@ Prismatic Geometry
__Objecttype: "CoolingPrismatic"__
-<**Vertices**>: Corner points of the polygon, which builds the the base of the prism and lies parallel to the xy-plane, in global cartesian coordinates.
-
-<**LowerZCoordinate**>: z-coordinate of the base of the prism
-
-<**UpperZCoordinate**>: z-coordinate of the top prism surface
-
-<**Cooling**>: Physical part (parametrization of the power) of the cooling
-
+XML Tag | Type | Explanation
+-------------------------|-------------------------------------|----------------------------
+Vertices | comma-separated doubles | corner points of the polygon that builds the the base of the prism and lies parallel to the xy-plane, in global cartesian coordinates.
+LowerZCoordinate | double | z coordinate of the base of the prism
+UpperZCoordinate | double | z coordinate of the top of the prism
+Cooling | [cooling](#physical) | physical part (parametrization of the power) of the cooling
A prism, whose base lies parallel to the xy-plane and whose hight runs parallel to th z-axis.
\htmlinclude waterCooling_color.xml
-Physical part
+Physical part {#physical}
==========
-<br/>
-
Neumann-boundary-value (constant heat flow density [W/m²] by the cooling)
----------
__Objecttype: "CoolingByConstantValue"__
-<**Value**>: power of the cooling in W/m²
-
+XML Tag | Type | Explanation
+-------------------------|-------------------------------------|----------------------------
+Value | double | power of the cooling in W/m²
\htmlinclude cooling_by_constant_color.xml
-
Look-Up-table: heat flow density is dependant on the temperature of the boundary surface between cooling and thermal block.
----------
__Objecttype: "CoolingByLookUp"__
-<**LookUpTable**>: [Parameterobject](xmlobject.html) with definitions of the measurement points in W/m² for the look-up-table
-
+XML Tag | Type | Explanation
+-------------------------|-------------------------------------|----------------------------
+LookUpTable | [parameter object](xmlobject.html) | sets the cooling power in W/m²
Between the measurements points of the look-up-table the curve is interpolated and is smoothed slightly at the measurement points. The measurement points are temperatures given in °C.
\htmlinclude cooling_lookuptable_color.xml
-
thermal isolation
----------
@@ -163,5 +74,9 @@ Dirichlet-boundary-condition (given boundary temperature)
__Objecttype: "DirichletBoundaryCondition"__
+XML Tag | Type | Explanation
+-------------------------|-------------------------------------|----------------------------
+SurfaceTemperature | double | surface temperature in °C
+
The outer surface, on wich the cooling is connected to, is held on a constant temperature.
\htmlinclude cooling_dirichlet_boundary_condition_color.xml
diff --git a/doxygen/xmlelectrical.md b/doxygen/xmlelectrical.md
index 3b567288dcb1644a8147022955f14f25a5df08cc..b534ece3ffb3823a5a96ad7d429a64b46f8e9128 100644
--- a/doxygen/xmlelectrical.md
+++ b/doxygen/xmlelectrical.md
@@ -1,213 +1,34 @@
Electrical Objects {#xmlelectrical}
===================
-\~German
-
-Nachfolgend sind alle elektrischen Objekttypen, aus denen ein Netzwerk aufgebaut werden kann, aufgelistet.
-Für jeden Objekttyp wird der Aufbau des dazugehörigen XML-Elementes beschrieben und ein Codebeispiel gegeben.
-
-<br/>
-
-Allgemein
-=========
-
-Jedes XML-Element, das in der Konfiguration ein elektrisches Objekt repräsentiert, besitzt das Attribut "class".
-Ãœber dieses Attribut wird der Objekttyp zugeordnet.
-Außerdem kann jedes XML-Element das Attribut "observable='true'" besitzen.
-Durch dieses Attribut werden Strom, Spannung, Verlustleistung und ggf. Soc des Objektes berechnet und bei Verwendung des Datenloggers mit ausgegeben.
-
-<br/>
-
-Grundtypen
-==========
-
-<br/>
-
-Widerstand
-----------
-
-__Objekttyp: "OhmicResistance"__
-
-<**Object**>: [Parameterobjekt](xmlobject.html) mit Widerstandswert
-
-Definition eines Widerstandes mit konstantem Widerstandswert:
-\htmlinclude ohmic_color.xml
-
-
-Kondensator
-----------
-
-__Objekttyp: "Capacity"__
-
-<**Object**>: [Parameterobjekt](xmlobject.html) mit Kapazitätswert
-
-Definition eines Kondensators mit konstantem Kapazitätswert:
-\htmlinclude capacity_color.xml
-
-
-Spannungsquelle
-----------
-
-__Objekttyp: "VoltageSource"__
-
-<**Object**>: [Parameterobjekt](xmlobject.html) mit Spannungswert
-
-Definition einer Spannungsquelle mit konstantem Spannungswert:
-\htmlinclude voltage_color.xml
-
-
-Parallelschaltung
-----------
-
-__Objekttyp: "ParallelTwoPort"__
-
-<**Children**>: Enthält weitere XML-Elemente. Eines für jeden Zweig der Parallelschaltung.
-
-Definition einer Parallelschaltung aus einem Kondensator und einem Widerstand:
-\htmlinclude parallel_color.xml
-
-
-Serienschaltung
-----------
-
-__Objekttyp: "SerialTwoPort"__
-
-<**Children**>: Enthält weitere XML-Elemente, die in Serie verschaltet sind.
-
-Definition einer Serienschaltung aus einem Kondensator und einem Widerstand:
-\htmlinclude serial_color.xml
-
-<br/><br/>
-
-Komplexere Bauelemente
-======================
-
-<br/>
-
-Zarc-Element
-----------
-
-__Objekttyp: "ZarcElement"__
-
-<**LookupTau**>: [Parameterobjekt](xmlobject.html) für Tau. Dieses Parameterobjekt verwendet tyÂÂpiÂÂscherÂÂweiÂÂse die zwei [Zustände](xmlstate.html) "ThermalState" und "Soc" des übergeordneten "CellElements".
-
-<**LookupOhmicResistance**>: [Parameterobjekt](xmlobject.html) für Widerstand. Dieses Parameterobjekt verwendet tyÂÂpiÂÂscherÂÂweiÂÂse die zwei [Zustände](xmlstate.html) "ThermalState" und "Soc" des übergeordneten "CellElements".
-
-<**LookupPhi**>: [Parameterobjekt](xmlobject.html) für Phi. Dieses Parameterobjekt verwendet tyÂÂpiÂÂscherÂÂweiÂÂse die zwei [Zustände](xmlstate.html) "ThermalState" und "Soc" des übergeordneten "CellElements".
-
-Bei der Verwendung von Zarc-Elementen sollte der Benutzer die minimale Samplerate als [Option](xmloption.html) <**SampleRate**> festlegen:
-\htmlinclude examples/samplerate_color.xml
-
-Definition eines Zarc-Elementes:
-\htmlinclude examples/zarc_color.xml
-
-Diffusion - Cotanh
-----------
-
-__Objekttyp: "WarburgCotanh"__
-Attribut "WithCapacity": "True" (default)
-Wenn das Attribut **WithCapacity** auf false gesetzt wird, dann wird keine zusätzliche Kapazität zum Ersatzschaltbild hinzugefügt und diese kann über eine Spannungsquelle modelliert werden.
-
-Attribut "RCCounter": "5" (default)
-Über das Attribut **RCCounter** kann die Genauigkeit der Approximation des Diffusionelementes eingestellt werden. Je höher dieser Wert ist, desto genau die Approximation. Die SampleRate limitiert hierbei auch die Anzahl der RC-Glieder.
-
-<**Sigma**>: [Parameterobjekt](xmlobject.html) für Sigma. Dieses Parameterobjekt verwendet tyÂÂpiÂÂscherÂÂweiÂÂse die zwei [Zustände](xmlstate.html) "ThermalState" und "Soc" des übergeordneten "CellElements".
-
-<**Clim**>: [Parameterobjekt](xmlobject.html) für limiting Capacity. Dieses Parameterobjekt verwendet tyÂÂpiÂÂscherÂÂweiÂÂse die zwei [Zustände](xmlstate.html) "ThermalState" und "Soc" des übergeordneten "CellElements".
-
-
-Bei der Verwendung von Cotanh-Elementen sollte der Benutzer die minimale Samplerate als [Option](xmloption.html) <**SampleRate**> festlegen:
-\htmlinclude examples/samplerate_color.xml
-
-Definition eines Warburg-Cotanh:
-\htmlinclude examples/warburg_coth_color.xml
-
-Diffusion - Tanh
-----------
-
-__Objekttyp: "WarburgTanh"__
-
-Attribut "RCCounter": "5" (default)
-Über das Attribut **RCCounter** kann die Genauigkeit der Approximation des Diffusionelementes eingestellt werden. Je höher dieser Wert ist, desto genauer die Approximation. Die SampleRate limitiert hierbei auch die Anzahl der RC-Glieder.
-
-<**OhmicResistance**>: [Parameterobjekt](xmlobject.html) für den Ohmschen Anteil. Dieses Parameterobjekt verwendet tyÂÂpiÂÂscherÂÂweiÂÂse die zwei [Zustände](xmlstate.html) "ThermalState" und "Soc" des übergeordneten "CellElements".
-
-<**Tau**>: [Parameterobjekt](xmlobject.html) für die Relaxationskonstante. Dieses Parameterobjekt verwendet tyÂÂpiÂÂscherÂÂweiÂÂse die zwei [Zustände](xmlstate.html) "ThermalState" und "Soc" des übergeordneten "CellElements".
-
-
-Bei der Verwendung von Tanh-Elementen sollte der Benutzer die minimale Samplerate als [Option](xmloption.html) <**SampleRate**> festlegen:
-\htmlinclude examples/samplerate_color.xml
-
-Definition eines Warburg-Tanh:
-\htmlinclude examples/warburg_tanh_color.xml
-
-
-
-
-Batterie
-----------
-
-__Objekttyp: "CellElement"__
-
-<**ThermalState**>: [Zustandsobjekt](xmlstate.html) vom Typ "ThermalState". Dieses Objekt sollte im Cache zwischengespeichert werden, damit es für die Nachschlagetabellen weiterverwendet werden kann.
-
-<**Soc**>: [Zustandsobjekt](xmlstate.html) vom Typ "Soc". Dieses Objekt sollte im Cache zwischengespeichert werden, damit es für die Nachschlagetabellen weiterverwendet werden kann.
-
-<**Children**>: Enthält weitere XML-Elemente, die in Serie verschaltet sind. Eine Batterie kann aus beliebigen elektrischen Bauteilen aufgebaut sein.
-
-<**ReversibleHeat**/> Beschreibt die reversible Wärmegeneration siehe auch [thermischesModell](xmlthermalmodel.html)
-
-Definition einer Beispielbatterie in Vollzellendarstellung:
-\htmlinclude examples/cellelement_color.xml
-
-Definition einer Beispielbatterie in Halbzellendarstellung:
-\htmlinclue example/cellelement_halfcell_color.xml
-
-
-Anodenpartikel
---------------
-
-__Objekttyp: "AnodeElement"__
-
-<**Children**>: Enthält weitere XML-Elemente, die in Serie verschaltet sind. Darf nur elektrische Bauelement beinhalten und keine Verschaltungselemente (SerialTwoPort, ParallelTwoPort)
-
-
-Kathodenpartikel
-----------------
-
-__Objekttyp: "CathodeElement"__
-
-<**Children**>: Enthält weitere XML-Elemente, die in Serie verschaltet sind. Darf nur elektrische Bauelement beinhalten und keine Verschaltungselemente (SerialTwoPort, ParallelTwoPort)
-
-\~English
-
This page lists all types of electrical objects that can be used to build a network, including the structure of the XML elements.
General
=========
-Each XML-element that describes an electrical object has the attribute "class". This attribute is used to determine the object type. Additionally, the attribute "observale" can be set to true. This causes current, voltage, dissipation power and (if applicable) soc to be calculated and added to the simulation output.
+Each XML element that describes an electrical object has the attribute "class". This attribute is used to determine the object type. Additionally, the attribute "observale" can be set to true. This causes current, voltage, dissipation power and (if applicable) soc to be calculated and added to the simulation output.
Basic types
==========
Resistance
----------
+A resistance is added by setting the "class" attribute to **OhmicResistance**.
-__Object type: "OhmicResistance"__
-
-<**Object**>: [Parameter object](xmlobject.html) with resistance value
+XML Tag | Unit | Type | Explanation
+----------------------------------------|------|--------------------------|--------------------------------------------------------------------------------
+Object | Ohm | [Object](xmlobject.html) | Value of the resistance
Definition of a resistance with constant value:
\htmlinclude ohmic_color.xml
-
Capacity
----------
+A resistance is added by setting the "class" attribute to **Capacity**.
-__Object type: "Capacity"__
-
-<**Object**>: [Parameter object](xmlobject.html) with capacity value
+XML Tag | Unit | Type | Explanation
+----------------------------------------|-------|--------------------------|--------------------------------------------------------------------------------
+Object | Farad | [Object](xmlobject.html) | Value of the capacitor
Definition of a capacity with constant value:
\htmlinclude capacity_color.xml
@@ -215,53 +36,55 @@ Definition of a capacity with constant value:
Voltage Source
----------
+A voltage source is added by setting the "class" attribute to **VoltageSource**.
-__Object type: "VoltageSource"__
-
-<**Object**>: [Parameter object](xmlobject.html) with voltage value
+XML Tag | Unit | Type | Explanation
+----------------------------------------|-------|--------------------------|--------------------------------------------------------------------------------
+Object | V | [Object](xmlobject.html) | Value of the voltage source
Definition of a voltage source with constant value:
\htmlinclude voltage_color.xml
-
Parallel Connection
----------
+A parallel connection of elements is added by setting the "class" attribute to **ParallelTwoPort**.
-__Object type: "ParallelTwoPort"__
-
-<**Children**>: Contains child elements that are connected in parallel
+XML Tag | Type | Default value | Explanation
+----------------------------------------|------------------|---------------|--------------------------------------------------------------------------------
+Children | List of twoports | | List of child elements that are connected in parallel
+- Attribute count | int > 0 | 1 | Number of times each child is added
Definition of a parallel connection of a capacitor and a resistor:
\htmlinclude parallel_color.xml
-
Serial Connection
----------
+A serial connection of elements is added by setting the "class" attribute to **SerialTwoPort**.
-__Object type: "SerialTwoPort"__
-
-<**Children**>: Contains child elements that are connected in series
+XML Tag | Type | Default value | Explanation
+----------------------------------------|------------------|---------------|-----------------------------------------------------
+Children | List of twoports | | List of child elements that are connected in series
+- Attribute count | int > 0 | 1 | Number of times each child is added
Definition of a serial connection of a capacitor and a resistor:
\htmlinclude serial_color.xml
-<br/><br/>
-
More complex elements
======================
-<br/>
-
Zarc Element
----------
+A zarc element is added by setting the "class" attribute to **ZarcElement**.
+It describes an element with an impedance value of
+\f[
+\underline{Z}_{Zarc} = \frac{R}{1 + (j\omega\tau)^\phi}
+\f]
-__Object type: "ZarcElement"__
-
-<**LookupTau**>: [Parameter object](xmlobject.html) for the time constant tau. This parameter object typically uses the two [states](xmlstate.html) "ThermalState" and "Soc" of the containing "CellElements".
-
-<**LookupOhmicResistance**>: [Parameter object](xmlobject.html) for the resistance. This parameter object typically uses the two [states](xmlstate.html) "ThermalState" and "Soc" of the containing "CellElements".
-
-<**LookupPhi**>: [Parameter object](xmlobject.html) for phi. This parameter object typically uses the two [states](xmlstate.html) "ThermalState" and "Soc" of the containing "CellElements".
+XML Tag | Unit | Type | Explanation
+----------------------------------------|------|--------------------------|--------------------------------------------------------------------------------
+LookupTau | s | [Object](xmlobject.html) | Value of tau
+LookupOhmicResistance | Ohm | [Object](xmlobject.html) | Value of the resistance R
+LookupPhi | | [Object](xmlobject.html) | Value of phi
If zarc elements are used, the minimal sample rate should be set by using the [option](xmloption.html) <**SampleRate**>:
\htmlinclude examples/samplerate_color.xml
@@ -271,18 +94,14 @@ Definition of a zarc element:
Diffusion - Cotanh
----------
+A warburg element with reflective boundary is added by setting the "class" attribute to **WarburgCotanh**.
-__Object type: "WarburgCotanh"__
-Attribute "WithCapacity": "True" (default)
-If the attribute **WithCapacity** is set to false, no additional capacity is added to the ECM and the capacity can be modeled with a voltage source.
-
-Attribute "RCCounter": "5" (default)
-The argument **RCCounter** can be used to adjust how accurately the diffusion element is approximated. The higher this value is, the more exact the approximation gets. The number of RC elements is limited by the SampleRate option.
-
-<**Sigma**>: [Parameter object](xmlobject.html) for sigma. This parameter object typically uses the two [states](xmlstate.html) "ThermalState" and "Soc" of the containing "CellElements".
-
-<**Clim**>: [Parameter object](xmlobject.html) for the limiting capacity. This parameter object typically uses the two [states](xmlstate.html) "ThermalState" and "Soc" of the containing "CellElements".
-
+XML Tag | Unit | Type | Default value | Explanation
+------------------------|------|--------------------------|---------------|-----------------------------------------------------
+Attribute WithCapacity | | bool | true | If set to false, no additional capacity is added to the ECM and the capacity can be modeled with a voltage source
+Attribute RCCounter | | int > 0 | 5 | Number of RC elements to be added
+Sigma | | [Object](xmlobject.html) | | Value of sigma
+Clim | | [Object](xmlobject.html) | | Value of the limiting capacity
If cotanh elements are used, the minimal sample rate should be set by using the [option](xmloption.html) <**SampleRate**>:
\htmlinclude examples/samplerate_color.xml
@@ -292,57 +111,57 @@ Definition of a Warburg-Cotanh:
Diffusion - Tanh
----------
+A warburg element with transmissive boundary is added by setting the "class" attribute to **WarburgTanh**.
-__Object type: "WarburgTanh"__
-
-Attribute "RCCounter": "5" (default)
-The argument **RCCounter** can be used to adjust how accurately the diffusion element is approximated. The higher this value is, the more exact the approximation gets. The number of RC elements is limited by the SampleRate option.
-
-<**OhmicResistance**>: [Parameter object](xmlobject.html) for the resistance. This parameter object typically uses the two [states](xmlstate.html) "ThermalState" and "Soc" of the containing "CellElements".
+XML Tag | Unit | Type | Default value | Explanation
+------------------------|------|--------------------------|---------------|-----------------------------------------------------
+Attribute RCCounter | | int > 0 | 5 | Number of RC elements to be added
+OhmicResistance | Ohm | [Object](xmlobject.html) | | Value of sigma
+Tau | s | [Object](xmlobject.html) | | Value of tau
-<**Tau**>: [Parameter object](xmlobject.html) for the time constant tau. This parameter object typically uses the two [states](xmlstate.html) "ThermalState" and "Soc" of the containing "CellElements".
-
-
-If cotanh elements are used, the minimal sample rate should be set by using the [option](xmloption.html) <**SampleRate**>:
+If tanh elements are used, the minimal sample rate should be set by using the [option](xmloption.html) <**SampleRate**>:
\htmlinclude examples/samplerate_color.xml
Definition of a Warburg-Tanh:
\htmlinclude examples/warburg_tanh_color.xml
-
-
-
Battery
----------
+This element represents a battery cell and is added by setting the "class" attribute to **CellElement**.
-__Object type: "CellElement"__
-
-<**ThermalState**>: [State object](xmlstate.html) of type "ThermalState". This object should be stored in the cache so that it can be used as a parameter for lookup tables.
-
-<**Soc**>: [State object](xmlstate.html) of type "Soc". This object should be stored in the cache so that it can be used as a parameter for lookup tables.
-
-<**Children**>: Contains elements that are connected in series. A battery can contains arbitrary electrical elements.
-
-<**ReversibleHeat**/> Describes the reversible heat generation, see the [thermal model](xmlthermalmodel.html)
+XML Tag | Unit | Type | Default value | Explanation
+------------------------|----- |-------------------------------------------------------|--------------- |-----------------------------------------------------
+ThermalState | | [State object](xmlstate.html) of class "ThermalState" | | [Thermal state](xmlstate.html) of the cell, should be cached and used as parameter for lookup tables
+Soc | | [State object](xmlstate.html) of class "Soc" | | [Soc](xmlstate.html) of the cell, should be cached and used as parameter for lookup tables
+Children | | List of twoports | | List of child elements that are connected in series
+ReversibleHeat | W / (K * A) | [Object](xmlobject.html) | no reversible heat generation | Reversible heat generated by the cell
Definition of an example battery in full cell configuration:
\htmlinclude examples/cellelement_color.xml
-Definition of an example battery in half cell configuration:
-\htmlinclue example/cellelement_halfcell_color.xml
-
+Definition of an example battery in half cell configuration (see [halfcell simulation](xmlhalfcell.md)):
+\htmlinclude examples/cellelement_halfcell_color.xml
Anode particle
--------------
+This element represents an anode particle in a [halfcell simulation](xmlhalfcell.md) and is added by setting the "class" attribute to **AnodeElement**.
-__Object type: "AnodeElement"__
-
-<**Children**>: Contains elements that are connected in series. Can only contain electrical elements and no serial or parallel connection elements.
+XML Tag | Type | Default value | Explanation
+------------------------|----------------------------------------------|-----------------------------------|-----------------------------------------------------------------
+Children | List of twoports | | List of child elements that are connected in series
+Soc | [State object](xmlstate.html) of class "Soc" | Soc of the parent cell, see below | [Soc](xmlstate.html) of the anode element, should be cached and used as parameter for lookup tables
+If no soc is given, the capacity of the anode element will be equal to the capacity of the parent cell divided by the number of anode elements and the initial soc will be the same as that of the parent cell.
+The children of this element must not be additional serial or parallel connections, only electrical elements are allowed. The values of voltage sources will be inverted, so that the cell OCV is the difference between the cathode and anode OCVs.
Cathode particle
----------------
+This element represents a cathode particle in a [halfcell simulation](xmlhalfcell.md) and is added by setting the "class" attribute to **CathodeElement**.
-__Object type: "CathodeElement"__
+XML Tag | Type | Default value | Explanation
+------------------------|----------------------------------------------|-----------------------------------|-----------------------------------------------------------------
+Children | List of twoports | | List of child elements that are connected in series
+Soc | [State object](xmlstate.html) of class "Soc" | Soc of the parent cell, see below | [Soc](xmlstate.html) of the anode element, should be cached and used as parameter for lookup tables
-<**Children**>: Contains elements that are connected in series. Can only contain electrical elements and no serial or parallel connection elements.
\ No newline at end of file
+If no soc is given, the capacity of the cathode element will be equal to the capacity of the parent cell divided by the number of cathode elements and the initial soc will be the same as that of the parent cell.
+The children of this element must not be additional serial or parallel connections, only electrical elements are allowed.
\ No newline at end of file
diff --git a/doxygen/xmlexecutable.md b/doxygen/xmlexecutable.md
index 6e41b2ea53dd7f4a0eeb933336d7eaaaa8085c29..954092410e1962a4ffd835891de6faeb57719c35 100644
--- a/doxygen/xmlexecutable.md
+++ b/doxygen/xmlexecutable.md
@@ -47,13 +47,11 @@ Executable TestShowBattery.xml Stromprofil.txt
\~English
-Abstract
-=========
The electrical/thermal simulation is run with a variable step solver.
The electrical and thermal simulations are run alternately.
-Firstly, the electrical model is simulating a certain period. Afterwards, the thermal model is simulating exactly the same period.
-If the changes of the SoC or of the temperature are crossing the limits, a premature switch between the two models is forced.
+Firstly, the electrical model is simulated for a certain period. Afterwards, the thermal model is simulated for exactly the same period.
+If the change of any SoC or temperature exceeds a limit set in the [XML options](xmloption.html), a premature switch between the two models is forced.
Execution
=========
diff --git a/doxygen/xmlfactory.md b/doxygen/xmlfactory.md
deleted file mode 100644
index 2f3355c2c37b723467eb5566734f099a599fa9db..0000000000000000000000000000000000000000
--- a/doxygen/xmlfactory.md
+++ /dev/null
@@ -1,25 +0,0 @@
-Factory and parser {#factory}
-==================
-
-\~German
-
-Factory und Parser sind zwei Programmkomponenten des Frameworks.<br/>
-Diese Programmkomponenten können eine XML-Konfigurationsdatei einlesen und verarbeiten.<br/>
-Die XML-Datei wird durch den Parser geprüft und vorverarbeitet.<br/>
-Das in der XML-Datei beschriebene elektrische Netzwerk wird von der Factory aus miteinander verknüpften Objekten erzeugt.
-
-An dieser Stelle sollen die Methodenaufrufe für diesen Vorgang beschrieben werden.<br/>
-Im folgenden Codeausschnitt wird eine Methode zur Erzeugung eines elektrischen Netzwerkes aus einer XML-Datei vorgestellt:
-
-\htmlinclude factory_color.xml
-\~English
-
-Factory and parser are two program components of the framework.<br/>
-These program components can parse and process a XML configuration file.<br/>
-The XML file is validated and pre-processed by the parser.<br/>
-The electrical network, which is described in the XML file, is generated by the factory as a cluster of interconnected objects.
-
-The method calls for this process should be described at this point.<br/>
-A method which generates an electrical network from an XML file is described in the following code snippet:
-
-\htmlinclude factory_color.xml
diff --git a/doxygen/xmlhalfcell.md b/doxygen/xmlhalfcell.md
index 4c75901feb6d426f8757c25b711a56244454dcc8..f1d74720626cf29b0d8c567eb3ac1891128ff567 100644
--- a/doxygen/xmlhalfcell.md
+++ b/doxygen/xmlhalfcell.md
@@ -1,29 +1,6 @@
Half cell simulation {#xmlhalfcell}
====================
-\~German
-
-Mit der Halbzellensimulation wird eine elektrodenaufgelöste Beschreibung einer Batteriezelle gegeben. Das elektrische Ersatzschaltbild wird für die Halbzellensimulation dahingehend erweitert, dass die Ruhespanung der Vollzelle über eine Superposition der Potentialwerte von anodischer und kathodischer Halbzelle abgebildet wird. Zusäztlich erfolgt eine anoden- und kathodenseitige Zerlegung der Zellimpedanz.
-
-<br/>
-
-XML-Aufbau
-==========
-
-\htmlinclude halfcell_example.xml
-
-<**Anode**> Ãœber diesen Knoten werden alle elektrischen Bauelemente gegeben, die die Anode beschreiben.
-
-<**AnodeElement**> Jedes Element mit dem Attribut "class=AnodeElement" beschreibt einen einzelnen Anodenpartikel, dem ein eigener SOC zur Beschreibung des Lithiierungsgrades zugewiesen wird. Die Kapazität der Vollzelle wird dabei gleichmäßig über die einzelnen Anodenpartikel verteilt. In gegebenen Beispiel wird die Anode der Zelle durch die parallele Verschaltung zweier Anodenpartikel beschrieben.
-
-<**Cathode**> Ãœber diesen Knoten werden alle elektrischen Bauelemente gegeben, die die Kathode beschreiben.
-
-<**CathodeElement**> Jedes Element mit dem Attribut "class=CathodeElement" beschreibt einen einzelnen Kathodenpartikel, dem ein eigener SOC zur Beschreibung des Lithiierungsgrades zugewiesen wird. Die Kapazität der Vollzelle wird analog zur Anode gleichmäßig über die einzelnen Kathodenpartikel verteilt. In gegebenen Beispiel wird die Kathode der Zelle durch einen einzelnen Kathodenpartikel beschrieben.
-
-Eine ausführbare Beispieldatei für die Halbzellensimulation findet sich unter scenarions/thermal_electrical/tesla_halfcell_color.xml
-
-\~English
-
The half cell simulation enables a description of a battery cell that is aware of the electrodes. The ECM is altered so that the open circuit voltage of the full cell is a superposition of anode and cathode potential. The cell's impedance is also diviced into anode and cathode.
<br/>
@@ -31,14 +8,14 @@ The half cell simulation enables a description of a battery cell that is aware o
XML structure
==========
-\htmlinclude halfcell_example.xml
+\htmlinclude examples/halfcell_example_color.xml
<**Anode**> This element contains all electrical elements describing the anode
-<**AnodeElement**> Each element with the class "AnodeElement" describt a single anode particle with its own SOC to describe the degree of lithiation. The capacity of the cell is equally distributed among all anode particles. In the example above, the anode is described by two anode particles that are connected in parallel.
+<**AnodeElement**> Each element with the class "AnodeElement" describes a single anode particle with its own SOC to describe the degree of lithiation. The capacity of the cell is equally distributed among all anode particles. In the example above, the anode is described by two anode particles that are connected in parallel.
<**Cathode**> This element contains all electrical elements describing the cathode
-<**CathodeElement**> Each element with the class "CathodeElement" describt a single cathode particle with its own SOC to describe the degree of lithiation. The capacity of the cell is equally distributed among all cathode particles. In the example above, the cathode is described by a single particle.
+<**CathodeElement**> Each element with the class "CathodeElement" describes a single cathode particle with its own SOC to describe the degree of lithiation. The capacity of the cell is equally distributed among all cathode particles. In the example above, the cathode is described by a single particle.
An in-depth example for a half cell simulation can be found in scenarions/thermal_electrical/tesla_halfcell_color.xml
diff --git a/doxygen/xmllookuptype.md b/doxygen/xmllookuptype.md
index a6d44d574f555f0594333e85eb5f6780dc636d74..d8e1713c696c1df7d53a82e32e265f6a4273f4cf 100644
--- a/doxygen/xmllookuptype.md
+++ b/doxygen/xmllookuptype.md
@@ -2,7 +2,7 @@ LookupType {#xmllookuptype}
================
\~German
-[Parameterobjekte] (xmlobject.html) mit ein- oder zweidimensionalen Nachschlagetabellen besitzen das Attribut LookupType. Für dieses sind die folgenden Parameter möglich:
+[Parameterobjekte](xmlobject.html) mit ein- oder zweidimensionalen Nachschlagetabellen besitzen das Attribut LookupType. Für dieses sind die folgenden Parameter möglich:
- "LinearInterpolation" (Lineare Interpolation der Stützwerte zwischen je zwei Stützstellen.) Wird das Attribut LookupType nicht gesetzt, wird per default "LinearInterpolation" angenommen.
- "NearestNeighbour" (Wählt den Stützwert, der der aktuellen Stützstelle am nächsten ist.)
@@ -11,7 +11,7 @@ LookupType {#xmllookuptype}
\~English
-[Parameter objects] (xmlobject.html) with one or two-dimensional lookup tables possess the attribute LookupType. For these the following parameters are possible:
+[Parameter objects](xmlobject.html) with one or two-dimensional lookup tables possess the attribute LookupType. For these the following values are possible:
- "LinearInterpolation" (linear interpolation of the supporting values between two grid points) The default parameter "LinearInterpolation" will be used, if no Lookuptype attribute is set.
- "NearestNeighbour" (chooses the next possible supporting value to the recent grid point)
diff --git a/doxygen/xmlobject.md b/doxygen/xmlobject.md
index e29864cbf214588d66fcbc0eea4247f1a2cebbba..d163a6b16cd0e078d2ef4f3556813640fee4ba99 100644
--- a/doxygen/xmlobject.md
+++ b/doxygen/xmlobject.md
@@ -1,200 +1,68 @@
Parameter objects {#xmlobject}
================
-\~German
-Parameterobjekte werden zur Parametrierung elektrischer Objekte verwendet.
+Parameter objects are used for the parameterization of electrical objects. This makes it possible for elements of the ECM to change during the simulation depending on the state of the battery. Each xml element describing a parameter object has the attribute "class" to determine the object type. To make object values dependent on the battery state, [object referencing](xmlsprache.html#xml_object_refs) is used.
-Diese Objektgruppe enthält verschiedene Arten von Parameterobjekten:
-+ Konstanter Parameterwert
-+ Parameterwert nach gegebener Funktion berechnet
-+ Nachschlagetabellen
-+ Zustandsabhängige Nachschlagetabellen
+Constant value
+==========================
+An object with constant value is added by setting the "class" attribute to **ConstObj**.
-<br/>
-
-Allgemein
-=========
-
-Jedes XML-Element, das in der Konfiguration ein Parameterobjekt repräsentiert, besitzt das Attribut "class".
-Ãœber dieses Attribut wird der Objekttyp zugeordnet.
-Parameterobjekte verwenden oft im Cache zwischengespeicherte Zustände für den Nachschlagevorgang.
-
-<br/>
-
-Parameterobjekte ohne Nachschlagetabelle
-==========
-
-<br/>
-
-Konstantes Parameterobjekt
---------------------------
-
-__Objekttyp: "ConstObj"__
-
-<**Value**>: Wert
-
-Definition eines konstanten Parameterobjektes:
-\htmlinclude constobj_color.xml
-
-<br/><br/>
-
-Parameterobjekte mit eindimensionaler Nachschlagetabelle
-========================================================
-
-<br/>
-
-1D-Parameterobjekt mit Zustandsbindung
-----------
-
-__Objekttyp: "LookupObj1dWithState"__ Attribut: LookupType = "LinearInterpolation" (default)
-
-Für weitere Informationen zu LookupType siehe [LookupType](xmllookuptype.html)
-
-<**State**>: [Zustandsobjekt](xmlstate.html). Muss per Objektreferenzierung übergeben werden (cacheref-Attribut).
-
-<**LookupData**>: Kommaseparierte Messpunkte
-
-<**MeasurementPoints**>: Kommaseparierte Messpunkte
-
-Definition eines 1D-Parameterobjektes mit Zustandsbindung:
-\htmlinclude 1dlookup_color.xml
-
-<br/><br/>
-
-Parameterobjekte mit zweidimensionaler Nachschlagetabelle
-========================================================
-
-<br/>
-
-2D-Parameterobjekt mit Zustandsbindung
-----------
-
-__Objekttyp: "LookupObj2dWithState"__ Attribut: LookupType = "LinearInterpolation" (default)
-
-Für weitere Informationen zu LookupType siehe [LookupType](xmllookuptype.html)
-
-<**RowState**>: [Zustandsobjekt](xmlstate.html). Muss per Objektreferenzierung übergeben werden (cacheref-Attribut).
-
-<**ColState**>: [Zustandsobjekt](xmlstate.html). Muss per Objektreferenzierung übergeben werden (cacheref-Attribut).
-
-<**LookupData**>: Kommaseparierte Messpunkte in einer Tabellenzeile. Zeilen sind über Semikolon voneinander getrennt.
-
-<**MeasurementPointsRow**>: Kommaseparierte Messpunkte der Zeilen
-
-<**MeasurementPointsColumn**>: Kommaseparierte Messpunkte der Spalten
-
-
-Definition eines 2D-Parameterobjektes mit Zustandsbindung:
-
-\htmlinclude 2dlookup_color.xml
-
-Multi Parameterobjekt
---------------------------
-
-__Objekttyp: "MultiObj"__ Attribut: Operation = "Add", "Divide", "Multiply"
-
-<**Children**>: Objekte wie oben beschrieben
-
-Definierung eines Objektes, dass sich zur Laufzeit aus verschiedenen Objekten berechnet
-
-\htmlinclude multiobj_color.xml
-
-
-\~English
-
-Parameter objects are used for the parameterization of electrical objects.
-
-Those object groups contain several types of parameter objects:
-+ Constant parameter values
-+ Parameter values evaluated according to given functions
-+ Lookup tables
-+ Stateful lookup tables
-
-<br/>
-
-Abstract
-=========
-
-Each xml-element, which represents a parameter object in the configuration, possesses the attribute "class".
-The object type is assigned via this attribute.
-Parameter objects often use a cached state for the lookup process.
-
-<br/>
-
-Parameter objects without lookup tables
-==========
-
-<br/>
-
-Constant parameter objects
---------------------------
-
-__Object type: "ConstObj"__
-
-<**Value**>: Value
+XML Tag | Type | Explanation
+--------|--------|----------------------------------------
+Value | double | constant value of the parameter object
Definition of a constant parameter object:
\htmlinclude constobj_color.xml
-<br/><br/>
-
-Parameter objects with one-dimensional lookup tables
-====================================================
-
-<br/>
-
-1D parameter objects with state binding
-----------
-
-__Object type: "LookupObj1dWithState"__ attribute: LookupType = "LinearInterpolation" (default)
-
-For further details on LookupType, see [LookupType](xmllookuptype.html)
-
-<**State**>: [State object](xmlstate.html). Has to be passed via object reference (cacheref attribute).
-
-<**LookupData**>: comma separated measurement points
-
-<**MeasurementPoints**>: comma separated measurement points
+1D lookup parameter object with state binding
+==========
+XML Tag | Type | Default value | Explanation
+------------------------|-----------------------------------|---------------------|----------------------------------------------------
+Attribute LookupType | [Lookup type](xmllookuptype.html) | LinearInterpolation | type of interpolation between data points
+State | [State object](xmlstate.html) | | state that determines the position in the 1D lookup
+LookupData | comma-separated doubles | | values of the lookup
+MeasurementPoints | comma-separated doubles | | measurement points of the lookup
Definition of a 1D parameter object with state binding:
-\htmlinclude 1dlookup_color.xml
-
-<br/><br/>
-
-Parameter objects with two-dimensional lookup tables
-========================================================
-
-<br/>
-
-2D parameter objects with state binding:
-----------
-__Object type: "LookupObj2dWithState"__ attribute: LookupType = "LinearInterpolation" (default)
-
-For further details on LookupType, see [LookupType](xmllookuptype.html)(xmllookuptype.html)
-
-<**RowState**>: [State object](xmlstate.html). Has to be passed via object reference(cacheref attribute).
-
-<**ColState**>: [State object](xmlstate.html). Has to be passed via object reference(cacheref attribute).
-
-<**LookupData**>: comma separated measurement points in a table row. Rows are separated via semicolon.
-
-<**MeasurementPointsRow**>: comma separated measurement points of the rows
-
-<**MeasurementPointsColumn**>: comma separated measurement points of the columns
+\htmlinclude 1dlookup_color.xml
+2D lookup parameter object with state binding
+==========
+XML Tag | Type | Default value | Explanation
+------------------------|-----------------------------------|---------------------|----------------------------------------------------
+Attribute LookupType | [Lookup type](xmllookuptype.html) | LinearInterpolation | type of interpolation between data points
+RowState | [State object](xmlstate.html) | | state that is contant along each row of the table
+ColState | [State object](xmlstate.html) | | state that is constant along each column of the table
+LookupData | comma-separated doubles | | values of the lookup table, rows of the table are seperated by semicolons
+MeasurementPointsRow | comma-separated doubles | | measurement points of the lookup table columns
+MeasurementPointsColumn | comma-separated doubles | | measurement points of the lookup table rows
Definition of a 2D parameter object with state binding:
\htmlinclude 2dlookup_color.xml
-Multi parameter object
---------------------------
+Expression object
+=================
+This object can be used to get a value from a mathematical expression.
+
+XML Tag | Type | Explanation
+------------------------|----------------------------------------|----------------------------------------------------
+Expression | mathematical expression | expression that is evaluated each time the object value is needed
+Parameters | list of [state objects](xmlstate.html) | list of states that are used as parameters in the expression
+- Attribute name | string | variable name used in the expression. If this attribute is not set, but the attribute cacheref is used, that name is used instead
+
+To evaluate the expressions, the library [exprtk](https://github.com/ArashPartow/exprtk) is used. The documentation provides a list of operations that can be used in the expressions.
-__Objekttyp: "MultiObj"__ Attribut: Operation = "Add", "Divide", "Multiply"
+\htmlinclude expression_obj_color.xml
-<**Children**>: can be any object as described above
+Combination of objects
+==========================
+The values of multiple objects can be combined to produce a single value.
-Definition of a multi Object that is calculated during runtime
+XML Tag | Type | Explanation
+------------------------|-----------------------------------|----------------------------------------------------
+Attribute Operation | Add, Multiply or Divide | specifies how the object values are combined
+Children | list of parameter objects | objects that are combined
-\htmlinclude multiobj_color.xml
+\htmlinclude multiobj_color.xml
\ No newline at end of file
diff --git a/doxygen/xmlobserer.md b/doxygen/xmlobserer.md
deleted file mode 100644
index b3f461559eea696e2bad02a33f895a49a16f08f1..0000000000000000000000000000000000000000
--- a/doxygen/xmlobserer.md
+++ /dev/null
@@ -1,142 +0,0 @@
-Observer {#xmlobserver}
-=======================
-
-\~German
-
-Nachfolgend sind alle Observerfilter aufgeführt.
-
-<br/>
-
-Allgemein
-=========
-Die Ausgabe der elektrischen Simulation läßt sich ausser im Falle von Simulink per XML-Datei beeinflussen, über sogenannte Filter.
-Die Filter werden dabei seriell abgearbeitet vom ersten Filter bis zum letzten.
-
-
-<br/>
-
-Dazu muss in der XML-Datei der unter dem Knoten <Configuration> das Element <Observer> erstellt werden.
-Innerhalb des <Observer>-Tags können eine beliebige Anzahl an Filtern hinzugefügt.
-
-
-
-<br/>
-CSV-Filter
-==========
-
-Der CSV-Filter generiert eine CSV-Datei mit den Werten im folgende Format:
-
-<pre>
-#Time; Elementnr; Voltage; Current; Power; SOC
-#s; Number ; Voltage / V; Current / A; Power / W; SOC / %
-</pre>
-
-\arg Time: aktuelle Simulationzeit in Sekunden
-\arg Elementnr: Nummer des elektrisches Element für den die folgenden Werte gelten
-\arg Voltage: Spannung in Volt
-\arg Current: Strom in Ampere
-\arg Power: thermische Leistung in Watt
-\arg SOC: Ladezustand (state of charge) in %
-
-\htmlinclude csvfilter_color.xml
-
-<br/>
-STDOut-Filter
-==========
-Der STDOut-Filter gibt die Werte in ähnlicher Art und Weise wie der CSV-Filter aus.
-Jedoch werden die Daten nicht in einer Datei gespeichert sondern direkt über die Standarausgabe ausgegeben.
-
-\htmlinclude stdoutfilter_color.xml
-<br/>
-
-Dezimierungs-Filter
-========
-Der Dezimierungsfilter verhindert, dass zu viele Daten ausgegeben werden. Es werden nur Daten mit einem Simulationszeitstempel, die einen zeitlichen Mindestabstand einhalten durchgelassen (dezimiert).
-Dies ist sinnvoll wenn man mit sehr vielen Daten Rechnen muss, ohne dass diese Daten viel mehr Information bringen.
-
-
-\htmlinclude decimatefilter_color.xml
-
-<br/>
-Matlab-Filter
-========
-Die Daten werden im Matlab Format (.mat) abgespeichert. Die Daten werden dabei gezippt, sind damit sehr viel platzsparender als im CSV-Format und können direkt über Matlab eingelesen werden.
-Die maximale Dateigröße in Samplen kann über den Parameter "maxSampleSize" gesteuert werden.
-
-
-\htmlinclude matlabFilter_color.xml
-
-<br/>
-Beispiel: Verkettung von Filtern
-======
-Im folgenden wird eine Filterkette aus einer Matlab Ausgabe, einer Dezimierung, Stdout-Filter sowie einem CSV-Filter gebildet.<br/>
-Dabei werden alle Ausgaben des Modells in der Matlab zwischengespeichert. <br/>
-Danach wird eine Dezimierung der Daten durchgeführt, die einen zeitlichen Mindestetabstand von 0.1 Sekunden der Datenpunkte garantiert.<br/>
-Diese Daten werden dann auf die Standardausgabe ausgeben und in eine CSV-Datei gespeichert<br/>
-
-\htmlinclude filterChain_color.xml
-
-\~English
-
-This page lists all filters can be used for simulation output.
-
-<br/>
-
-General
-=========
-The simulation output can be controlled in the XML file using filters, except when the simulink model is used.
-The filters are executed serially from the first filter to the last one.
-
-
-<br/>
-
-Filters are added in an <Observer> element inside the <Configuration> element. The <Observer> element can contain the elements <Electrcal>, <Thermal> and <Aging>. Filters for the three parts of the model are added in the appropriate element.
-
-<br/>
-CSV filter
-==========
-
-The CSV filter generates a CSV file that used the following format:
-
-<pre>
-#Time; Elementnr; Voltage; Current; Power; SOC
-#s; Number ; Voltage / V; Current / A; Power / W; SOC / %
-</pre>
-
-\arg Time: current simulation time in seconds
-\arg Elementnr: number of the electrical element
-\arg Voltage: Voltage in Volt
-\arg Current: Current in Ampere
-\arg Power: Thermal dissipation power in Watt
-\arg SOC: State of charge in %
-
-\htmlinclude csvfilter_color.xml
-
-<br/>
-STDOut filter
-==========
-The STDOut filter writes values to the standard outpt.
-
-\htmlinclude stdoutfilter_color.xml
-<br/>
-
-Decimation filter
-========
-The decimation filter can be used to prevent too much output data. Data is only passed on to the next filter in the chain if a certain amount of time has passed since the last data point.
-
-\htmlinclude decimatefilter_color.xml
-
-<br/>
-Matlab filter
-========
-Data is stored in matlab files (.mat files). The files are compressed and use much less disc space than CSV files. The maximum number of samples in one file can be controlled with the attribute "maxSampleSize".
-
-\htmlinclude matlabFilter_color.xml
-
-<br/>
-Example: Chain of filters
-======
-The following example shows a filter chain with matlab output, decimation, STDOut-Filter and CSV output.
-All simulation output is stored in the matlab output file. Afterwards the data is decimated so that the minimum time between two samples is 0.1 seconds. This data is then written to the standard output and saved in a CSV file.
-
-\htmlinclude filterChain_color.xml
\ No newline at end of file
diff --git a/doxygen/xmlobserver.md b/doxygen/xmlobserver.md
new file mode 100644
index 0000000000000000000000000000000000000000..38203b001913d72521a98d9f7769166dd7d271d9
--- /dev/null
+++ b/doxygen/xmlobserver.md
@@ -0,0 +1,66 @@
+Observer {#xmlobserver}
+=======================
+
+General
+=========
+The simulation output can be controlled in the XML file using filters, except when the simulink model is used.
+The filters are executed serially from the first filter to the last one.
+
+
+<br/>
+
+Filters are added in an <**Observer**> element inside the <**Configuration**> element. The <**Observer**> element can contain the elements <**Electrical**>, <**Thermal**> and <**Aging**>. Filters for the three parts of the model are added in the appropriate element.
+
+<br/>
+CSV filter
+==========
+
+The CSV filter generates a CSV file that uses the following format:
+
+<pre>
+\#Time; Elementnr; Voltage; Current; Power; SOC
+\#s; Number ; Voltage / V; Current / A; Power / W; SOC / %
+</pre>
+
+\arg Time: current simulation time in seconds
+\arg Elementnr: number of the electrical element
+\arg Voltage: Voltage in Volt
+\arg Current: Current in Ampere
+\arg Power: Thermal dissipation power in Watt
+\arg SOC: State of charge in %
+
+XML Tag | Type | Default value | Explanation
+------------|--------|---------------|------------------------
+printHeader | bool | true | determines if a header is included in the CSV file
+Filename | string | | filename of the CSV output
+
+\htmlinclude csvfilter_color.xml
+
+<br/>
+STDOut filter
+==========
+The STDOut filter writes values to the standard outpt.
+
+\htmlinclude stdoutfilter_color.xml
+<br/>
+
+Decimation filter
+========
+The decimation filter can be used to prevent too much output data. Data is only passed on to the next filter in the chain if a certain amount of time has passed since the last data point.
+
+\htmlinclude decimatefilter_color.xml
+
+<br/>
+Matlab filter
+========
+Data is stored in matlab files (.mat files). The files are compressed and use much less disc space than CSV files. The maximum number of samples in one file can be controlled with the attribute "maxSampleSize".
+
+\htmlinclude matlabFilter_color.xml
+
+<br/>
+Example: Chain of filters
+======
+The following example shows a filter chain with matlab output, decimation, STDOut-Filter and CSV output.
+All simulation output is stored in the matlab output file. Afterwards the data is decimated so that the minimum time between two samples is 0.1 seconds. This data is then written to the standard output and saved in a CSV file.
+
+\htmlinclude filterChain_color.xml
\ No newline at end of file
diff --git a/doxygen/xmloptionen.md b/doxygen/xmloptionen.md
index 4b5c7beafaffce1536d34f40164803309c58115e..ecb67a7445dcc295acff607250a44c5a03fc49ee 100644
--- a/doxygen/xmloptionen.md
+++ b/doxygen/xmloptionen.md
@@ -1,73 +1,39 @@
XML options {#xmloption}
===============
-\~German
-Im <**Options**>-Knoten können globale Optionen eingestellt werden. Je nach Art der Simulation werden folgende Optionen eingestellt:
-
-Elektrisches Modell
-===============
-- <**SampleRate**>: Hier wird die [minimale Samplerate](xmlvereinfachung.html) definiert.
-- <**PowerStopCriterion**>: Wenn ein Leistungsprofil verwendet wird, wird hiermit das Leistungs-Stop-Kriterium in Prozent festgelegt. Wenn während eines Simulationsschrittes die prozentuale Abweichung der Leistung vom vorgegeben Wert höher ist als durch das Kriterium zugelassen, wird der Simulationsschritt unterbrochen, um den erforderlichen Strom neu zu berechnen. Ist dieser Knoten nicht vorhanden, wird 1.0 Prozent angenommen.
-
-Thermisches Modell
-===============
-
-\ifnot RELEASE_DOCU
-- <**AirTemperature** **ReadFromFile**= @b "false" >: Gibt die Temperatur der Umgebung an. Wenn ReadFromFile false ist, wird der Wert in °C direkt angegeben. Wenn ReadFromFile true ist, wird die Adresse der Datei angegeben, in der eine mit der Zeit veränderliche Außentemperatur angegeben ist.
-\endif
-- <**ConvectionActivated**>: De-/aktiviert freie Konvektion als Standardkühlung.
- - Attribut advancedAreaAggregation: Wenn auf false gesetzt, werden jeweils alle koplanaren Außenflächen zu Gesamtflächen zusammengefasst, von denen die charakteristischen Längen berechnet werden.
- Wenn auf true gesetzt, wird zusätzlich die Positionierung der thermischen Blöcke, auf denen die Außenflächen liegen, betrachtet, um koplanare Flächen, die nicht miteinander verbunden sind, bei der Berechnung zu trennen.
- Wenn nicht explizit gesetzt, wird true als Defaultwetrt gesetzt.
-- <**RadiationActivated**>: De-/aktiviert Wärmestrahlung als Standardkühlung.
-\ifnot RELEASE_DOCU
-- <**SocStopCriterionInPercent**>: Wenn dieser xml-Knoten existiert, wird der hierin enthaltene Wert als SoC-Stopp-Kriterium verwendet: Wenn sich während eines Simulationsschrittes der SoC eines Zellelements um diesen Betrag ändert, wird eine Neuberechnung des Gleichungssystems erzwungen. Wenn dieser xml-Knoten nicht existiert, wird hierfür 5.0 Prozent angenommen.
-- <**ThermalStopCriterionInDegreeC**>: Wenn dieser xml-Knoten existiert, wird der hierin enthaltene Wert als Temperatur-Stopp-Kriterium verwendet: Wenn sich während eines Simulationsschrittes die Temperatur eines Zellelements um diesen Betrag ändert, wird eine Neuberechnung des Gleichungssystems erzwungen. Wenn dieser xml-Knoten nicht existiert, wird hierfür 5.0 Grad Celsius angenommen.
-\endif
-- <**GeometricalTolerance length="0.000001" angleInDegrees="0.001" percentOfQuantity="0.1"**>: Wenn dieser Knoten existiert, werden hier die Toleranzen gesetzt, die beim Aufbau des [thermischen Modells](xmlthermalmodel.xml) verwendet werden. Folgende Attribute werden verwendet:
- - length: Dieser Wert ist die maximale Entfernung zwischen zwei geometrischen Objekten, mit der beide Objekte noch als einander berührend betrachtet werden. Die Einheit ist Meter. Der Default-Wert ist 0.000001.
- - angleInDegrees: Dieser Wert ist die maximale Winkeldifferenz zwischen zwei Richtungen, mit dem beide Richtungen noch als gleich betrachtet werden. Die Einheit ist Grad. Der Default-Wert ist 0.001.
- - percentOfQuantity: Dieser Wert ist die maximale Differenz zwischen zwei (physikalischen) Größen, mit dem beide Größen noch als gleich betrachtet werden. Die Einheit ist Prozent. Der Default-Wert ist 0.1.
-- <**ThermalVisualizer**><br/>: Gültig nur fuer Simulink; bei der Executable werden immer 1000 Frames mit gleichem zeitlichen Abstand über die gesamte Simulationszeit abgespeichert.
-<**MaxNumberOfFrames**>1000</ **MaxNumberOfFrames**> Maximale Anzahl der Bilder, die fuer die Visualisierung aufgenommen werden<br/>
-<**TimeBetweenFramesInSec**>1</ **TimeBetweenFramesInSec**> Zeit zwischen der Aufnahme von zwei Bildern fuer die Visualisierung<br/>
-</ **ThermalVisualizer**><br/>
-TimeBetweenFramesInSec = 0, kein csv-Output<br/>
-TimeBetweenFramesInSec = -1, jeden Zeitschritt <br/>
-TimeBetweenFramesInSec > x, Output immer nachdem mindestens x Sekunden verstrichen sind<br/>
-MaxNumberOfFrames = 0 und TimeBetweenFramesInSec > 0, schreibt nur Anfangs- und Endzustand der Simulation<br/>
-
-\~English
-Global options can be set within the <**Options**>-node. According to the simulation type, following options can be set:
+Global options can be set within the <**Options**> node. Depending on the simulation type, the following options can be set:
Electrical model
===============
-- <**SampleRate**>: definition of the [minimal sample rate](xmlvereinfachung.html).
-- <**PowerStopCriterion**>: If a power profile is used, this sets the power stop criterion in percent. If the power deviation in percent from the value given in the profile is greater than specified in the criterion, the simulation step is aborted to recalculate the required current. If this node does not exist, a value of 1.0 percent is assumed.
+XML Tag | Unit/Type | Default value | Explanation
+----------------------------------------|-----------|---------------|------------------------------------------------------------------------
+StepTime | s | 1.0 | Maximum time that is simulated electrically before switching to the thermal model, see the [simulation cycle](simulation_cycle.html)
+PowerStopCriterion | % | 1.0 | If a [power profile](xmlexecutable.html) is used, this determines the maximum deviation from the power value given in the profile before the simulation step is stopped and the current is readjusted.
+SocStopCriterion | % | 5.0 | Maximum value any SOC can change by during an electrical simulation step before switching to the thermal model. This is a percentage of the cell capacity, not of the SOC value at the beginning of the timestep.
+ThermalStopCriterionInDegreeC | °C | 5.0 | Maximum temperature change in any thermal state during a thermal simulation step before the electrcal simulation is reset.
+Cycles | int > 0 | 1 | Gives the number of times the current/power profile is executed by the [thermal-electrical standalone](xmlexecutable.html)
+SampleRate | Hz | 1.0e6 | Sample rate for the automatic simplification of fast time constants, see [automatic simplification](xmlvereinfachung.html)
Thermal model
===============
+XML Tag | Unit/Type | Default value | Explanation
+----------------------------------------|-----------|---------------|------------------------------------------------------------------------
+AirTemperature | °C | | Ambient temperature
+- Attribute ReadFromFile | bool | | If this attribute is given, the air temperature is read as a profile from the specified file. The file has to be in CSV format, similarly to the current/power profile.
+ConvectionActivated | bool | | De-/activates free convection as default cooling mechanism
+- Attribute anvancedAreaAggregation | bool | true | If set to false, all coplanar areas are combined to one single area and its specific dimensions are calculated. If set to true, the position of the thermal block is analyzed to separate the calculations for coplanar but unconnected areas.
+RadiationActivated | bool | | De-/activates thermal radiation as standard cooling
+GeometricalTolerance | | | Sets the geometrical tolerance of the thermal model
+- Attribute length | m | 1.0e-6 | Maximum distance between two objects to be assumed as connected
+- Attribute angleInDegrees | ° | 1.0e-3 | Maximum difference between two angles to be regarded as equal
+- Attribute percentOfQuantity | % | 0.1 | Maximum difference between two quantities to be regarded as equal
+
+Aging model {#aging}
+============
+These options for the aging simulation must be added in <**Configuration**><**Options**><**Aging**>.
-\ifnot RELEASE_DOCU
-- <**AirTemperature** **ReadFromFile**= @b "false" >: Specifies the ambient temperature. If ReadFromFile is false, the value in °C will be given directly. Otherwise, the path to a file with varying temperatures at specific times is given.
-\endif
-- <**ConvectionActivated**>: De-/activates free connections as default cooling mechanism.
- - attribute advancedAreaAggregation: If set to false, all coplanar areas combined to one single area and its specific dimensions are calculated.
- If set to true, the position of the thermal block is analyzed to separate the calculations for coplanar but unconnected areas.
- If not set explicitly, true will be used as default.
-- <**RadiationActivated**>: De-/activates thermal radiation as standard cooling.
-\ifnot RELEASE_DOCU
-- <**SocStopCriterionInPercent**>: If this XML node exists, the belonging value is used as SoC stop criteria: If the SoC of a cell-element changes more than this amount, a recalculation of the system of equations is forced. If the node does not exist, 5.0 percents are used.
-- <**ThermalStopCriterionInDegreeC**>: If this XML node exists, the belonging value is used as temperature stop criteria: If the temperature of a cell-element changes more than this amount, a recalculation of the system of equations is forced. If the node does not exist, 5.0 degrees Celsius are used.
-\endif
-- <**GeometricalTolerance length="0.000001" angleInDegrees="0.001" percentOfQuantity="0.1"**>: If this node exists, the tolerances are set, which are used in the construction of the [thermal model](xmlthermalmodel.xml). Following attributes are used:
- - length: the maximal distance between to object which are then assumed as connected. The unit is metre. The default value is 0.000001.
- - angleInDegrees: this value is the maximum angle of two directions which are then assumed as the same. The unit is degree. The default value is 0.001.
- - percentOfQuantity: this value is the maximal difference between two(physical) quantities which are then assumed as the same. The unit is percent. The default value is 0.1.
-- <**ThermalVisualizer**><br/>: only valid for Simulink; within the executable 1000 frames with equidistant time steps are saved throughout the whole simulation.
-<**MaxNumberOfFrames**>1000</ **MaxNumberOfFrames**> maximum number of frames saved during the simulation<br/>
-<**TimeBetweenFramesInSec**>1</ **TimeBetweenFramesInSec**> time between two frames in seconds<br/>
-</ **ThermalVisualizer**><br/>
-TimeBetweenFramesInSec = 0, no csv-output<br/>
-TimeBetweenFramesInSec = -1, every time step <br/>
-TimeBetweenFramesInSec > x, output after a minimum of x seconds passed<br/>
-MaxNumberOfFrames = 0 and TimeBetweenFramesInSec > 0, only writes start and endpoint<br/>
\ No newline at end of file
+XML Tag | Unit/Type | Default value | Explanation
+----------------------------------------|---------------|---------------|----------------------------------------------------------------------------------------
+CalculationCycles | int > 0 | 1 | Number of times the current or power profile is simulated before each aging step
+SteadyStateCycles | CalculationCycles > int >= 0 | 0 | Number of cycles in CalculationCycles that are simulated without collecting data for aging
+AgingSteps | int > 0 | 1 | Number of aging steps
+AgingStepTime | days | | Duration of each aging step
\ No newline at end of file
diff --git a/doxygen/xmlstate.md b/doxygen/xmlstate.md
index 802e148222dc56f5159ae94563bc43376df1194d..60ea1403c1568536439365aab5fc6fb7f8e4c85e 100644
--- a/doxygen/xmlstate.md
+++ b/doxygen/xmlstate.md
@@ -1,80 +1,10 @@
State objects {#xmlstate}
===============
-\~German
-Es existieren zwei Arten von Zustandsobjekten: Ein thermischer Zustand (Temperatur und Wärmeerzeugung) und ein Ladezustand (SoC).
-Die Zustandsobjekte werden im Zusammenhang mit einer Batterie verwendet.
-Neben der Beschreibung des gegenwärtigen Zustandes einer Batterie, werden diese Zustände auch für [Parameterobjekte](xmlobject.html) mit Nachschlagetabellen verwendet.
-Dadurch können die Parameter der elektrischen Objekte in Abhängigkeit der Batterietemperatur und des Ladezustandes berechnet werden.
-
-<br/>
-
-Allgemein
-=========
-
-Jedes XML-Element, das in der Konfiguration ein Zustandsobjekt repräsentiert, besitzt das Attribut "class".
-Ãœber dieses Attribut wird der Objekttyp zugeordnet.
-Zustandsobjekte werden normalerweise im Cache zwischengespeichert und über die Objektreferenzierung mehrmals für Parameterobjekte mit Nachschlagetabellen verwendet.
-
-<br/>
-
-Grundtypen
-==========
-
-<br/>
-
-Thermischer Zustand
-----------
-
-Dieser Zustand speichert die Wärmeerzeugung durch elektrische Verlustleistung und die Temperatur.
-
-__Objekttyp: "ThermalState"__
-
-<**InitialTemperature**>: Wert der anfänglichen Temperatur in °C
-
-Definition eines thermischen Zustandes:
-\htmlinclude thermalstate_color.xml
-
-
-Ladezustand
-----------
-
-__Objekttyp: "Soc"__
-
-<**InitialCapacity**>: Wert der maximalen Kapazität in Ah
-
-<**InitialSoc**>: Wert des anfänglichen Ladezustandes in Prozent (0 bis 100)
-
-Aktuell können auch SOC-Werte höher als 100 % oder kleiner als 0 % in der Simulation vorkommen. Die Limits für den SOC wurden aufgehoben
-
-Definition eines Ladezustandes:
-\htmlinclude socstate_color.xml
-
-Strom, Spannung
-----------
-
-__Object type: "ElectricalState"__
-
-Zusätzliche Attribut:
-
-**StateType='Current'**
-
-oder
-
-**StateType='Voltage'**
-
-Strom und Spannung der elektrischen Komponenten können als weiterer State genutzt werden. Damit kann z.B. das Verhalten der Butler–Volmer Gleichung nachgestellt werden.
-
-\htmlinclude xmlCurrentState_color.xml
-
-
-\~English
There are two different types of state objects: A thermal state (temperature and heat generation) and a state of charge (SoC).
The state objects are used in connection with a battery.
Apart from the description of the current battery condition, these states are also used for [parameter objects](xmlobject.html) with lookup tables.
As a result, the parameters of the electrical object could be calculated as a function of battery temperature and SoC.
-<br/>
-
Abstract
=========
@@ -82,54 +12,45 @@ Each xml element, which represents a state object in the configuration, possesse
The object type is defined by this attribute.
State objects are normally stored in the cache and are used multiple times via object references for parameter objects with lookup tables.
-<br/>
-
-Basic types
-==========
-
-<br/>
-
Thermal state
-----------
+=========
This state stores the heat generation by electrical power loss and the temperature.
-__Object type: "ThermalState"__
+Object type: __"ThermalState"__
-<**InitialTemperature**>: Value of the initial temperature °C
+XML Tag | Unit | Type | Explanation
+----------------------------------------|------|--------------------------|--------------------------------------------------------------------------------
+InitialTemperature | °C | double | Value of the initial temperature
Definition of a thermal state:
\htmlinclude thermalstate_color.xml
State of charge
-----------
-
-__Object type: "Soc"__
+=========
-<**InitialCapacity**>: Value of the initial capacity in Ah
+Object type: __"Soc"__
-<**InitialSoc**>: Value of the initial charge in percent (0 to 100)
+XML Tag | Unit | Type | Explanation
+----------------------------------------|------|--------------------------|--------------------------------------------------------------------------------
+InitialCapacity | Ah | double | Initial capacity. The value will only change during the simulation if the aging model is used.
+InitialSoc | % | double | Initial state of charge from 0 to 100
-Current SOC values can be greater than 100% or smaller than 0%. The limits have been lifted.
+SOC values are not limited and can be greater than 100% or smaller than 0%.
Definition of a state of charge:
\htmlinclude socstate_color.xml
Current, Voltage
-----------
-
-__Object type: "ElectricalState"__
-
-Additional attributes:
-
-**StateType='Current'**
-
-or
-
-**StateType='Voltage'**
+=========
The current and voltage of an electric component can be used as an input for lookups. Therefore non-linear behavior e.g. for the Butler–Volmer equation can be approximated.
+Object type: **"ElectricalState"**
+
+XML Tag | Type | Explanation
+----------------------------------------|--------|--------------------------------------------------------------------------------
+Attribute StateType | string | "current", "voltage" or "power".
\htmlinclude xmlCurrentState_color.xml
diff --git a/doxygen/xmlstructure.md b/doxygen/xmlstructure.md
index 0a7df111954655ffe9a79b80437feefb9d608ad7..bde4df73ab5594c74d876267e0543299b7d01511 100644
--- a/doxygen/xmlstructure.md
+++ b/doxygen/xmlstructure.md
@@ -1,126 +1,5 @@
XML description language {#xmlsprache}
========================
-
-\~German
-Die Konfiguration der Simulationsszenarien erfolgt mit Hilfe einer speziellen XML-Sprache.
-Für jedes Simulationsszenario legt der Benutzer eine XML-Datei an.
-Diese XML-Datei kann dann vom Programm eingelesen und verarbeitet werden.
-
-Beschreibungen der verschiedenen Objektgruppen:
-- [Elektrische Objekte](xmlelectrical.html)
-- [Parameterobjekte](xmlobject.html)
-- [Zustandsobjekte](xmlstate.html)
-- [Thermische Blöcke](xmlthermalblock.html)
-- [Kühlungen](xmlcooling.html)
-- [Thermische Materialien](xmlthermalmaterial.html)
-- [Optionen](xmloption.html)
-
-
-Dazu:
-- Die Beschreibung der XML-Parametrierung und des Einlesevorgangs des [thermischen Modells](xmlthermalmodel.html), die die hier gezeigten XML-Strukturen ergänzen.
-- Die Besonderheiten beim [Benutzen des Simulink-Modells](xmlcinterface.html).
-
-<br/>
-
-Grundaufbau
-===========
-
-__Der Grundaufbau einer solchen Konfigurationsdatei:__
-\htmlinclude xmlstructure_color.xml
-
-
-__Die Konfigurationsdatei kann in drei Abschnitte unterteilt werden:__
-
-- **Options**<br/>
- In den [Options](xmloption.html) können globale Einstellungen vorgenommen werden.
-
-- **CustomDefinitions**<br/>
- In diesem Element können sogenannte Muster definiert werden.
- Später können diese Muster im [elektrischen Netzwerk](xmlelectrical.html) und im [thermischen Aufbau](xmlthermalblock.html) verwendet werden.
-
-- **RootElement**<br/>
- Das RootElement ist das Wurzelelement des elektrischen Netzwerkes.
- Ãœber das Attribut "class" wird das assoziierte Objekt definiert.
- Meist ist dieses Objekt ein ParallelTwoport oder ein SerialTwoport.
-
-Nur nötig, wenn das [thermische Modell](thermalmodel.xml) verwendet wird:
-- **ThermalMaterials**<br/>
- Enthält alle [Materialien](xmlthermalmaterial.html), die für das thermische Modell verwendet werden.
-
-- **CachedCoolings**<br/>
- Hier können die <**Cooling**>-Tags, die in den Kühlblöcken die Art und Stärke der Külung bestimmen, gecahcet werden.
-
-
-- **CoolingBlocks**<br/>
- Enthält [Kühlungen](xmlcooling.html), die für das thermische Modell verwendet werden.
- Diese werden hier erstellt, um an anderer Stelle per Objektreferenzierung übergeben zu werden.
- Also muss bei allen das Attribut cache="true" gesetzt werden.
- Kühlungen können auch innerhalb des RootElement definiert werden.
-
-
-
-Das elektrische Netzwerk wird aus verschiedenen Objekten (Basisklasse TwoPort) aufgebaut.
-Jedes Objekt wird in der Konfigurationsdatei durch ein XML-Element repräsentiert.
-Die XML-Elemente besitzen, in Abhängigkeit des zu beschreibenen Objektes, unterschiedliche Attribute und Kindelemente.
-Beispielsweise besitzt ein XML-Element für ein Objekt des Typs "ParallelTwoport" ein Kindelement "Children".
-Dieses Element enthält seinerseits mehrere Kindelemente als Zweige der Parallelschaltung.
-Eine Auflistung aller unterstützten elektrischen Objekttypen und die Beschreibung der jeweiligen XML-Elemente kann [hier nachgelesen werden](xmlelectrical.html).
-
-
-__Neben den elektrischen Objekten werden auch weitere Objekttypen angeboten:__
-
-- **Zustandsobjekte (States)**<br/>
- Es existieren zwei unterschiedliche Zustandsobjekte:
- + Soc <br/>
- Das Objekt Soc speichert den Ladezustand einer Batterie.
- + ThermalState <br/>
- Das Objekt ThermalState (thermischer Zustand) speichert die Wärmeerzeugung durch Verlustleistung und die Temperatur eines elektrischen Bauteils.
-<br/><br/>
-- **Parameterobjekte (Object)**<br/>
- Ein Parameterobjekt beschreibt Parameter wie beispielsweise den Widerstandswert eines Widerstands oder den Spannungswert einer Spannungsquelle.<br/>
- Diese Objektgruppe enthält verschiedene Arten von Parameterobjekten:
- + Konstanter Parameterwert
- + Parameterwert nach gegebener Funktion berechnet
- + Nachschlagetabellen (abhängig von Soc oder Temperatur oder Soc und Temperatur)
-
-
-Musterreferenzierung
-====================
-
-Für die Erstellung eines Musters wird das XML-Element im Abschnitt "CustomDefinitions" eingefügt.
-Der Name des Elementes muss eindeutig sein.
-Dannach kann das Muster an anderer Stelle (innerhalb "CustomDefinitions" und "RootElement") über das Attribut "ref" referenziert werden.
-
-Hier ein Beispiel:
-\htmlinclude basic_example_color.xml
-
-Objektreferenzierung
-============
-
-Die XML-Beschreibungssprache erlaubt eine Objektreferenzierung.
-Bei der Objektreferenzierung wird dasselbe Objekt an mehrere andere Objekte übergeben.
-Das ist vor allem bei der Verwendung von Zustandsobjekten sinnvoll.
-
-Damit ein Objekt referenziert werden kann, muss bei seiner Definition im XML-Element das Attribut "cache='True'" angegeben werden.
-Dadurch wird das Objekt unter seinem Elementnamen im Cache zwischengespeichert.
-An anderer Stelle kann dieses Objekt wieder über das Attribut "cacheref" referenziert werden.
-Bei der erneuten Zwischenspeicherung eines Objektes gleichen Namens wird das vorherige Objekt im Cache überschrieben (nur der Zeiger auf dieses Objekt).
-
-Hier ein Beispiel:
-\htmlinclude xmlobject_ref_color.xml
-
-In diesem Beispiel werden die beiden Zustandsobjekte "ThermalState" und "Soc" im Cache zwischengespeichert.
-Die Parameterobjekte "LookupTau", "LookupOhmicResistance", "LookupPhi" verwenden diese Zustandsobjekte.
-Im Gegensatz zu einer Musterreferenzierung werden bei der Objektreferenzierung keine neuen Objekte erzeugt.
-
-
-Beispiel Konfigurationsdatei
-============================
-
-Ein einfaches Simulationsszenario für rein elektrische Simulation mit insgesamt 16 Batterien:
-\htmlinclude testconfig_color.xml
-
-\~English
The configuration of the simulation scenarios is done via a particular xml language.
For each scenario, a xml file has to be created by the user.
This xml file can be read and evaluated by the program.
@@ -133,6 +12,7 @@ Description of the different object groups:
- [Coolings](xmlcooling.html)
- [Thermal materials](xmlthermalmaterial.html)
- [Options](xmloption.html)
+- [Observer Filters](xmlobserver.html)
Furthermore:
@@ -213,7 +93,7 @@ Afterwards, the template can be referenced at other points (within "CustomDefini
An example:
\htmlinclude basic_example_color.xml
-Object referencing
+Object referencing {#xml_object_refs}
============
The xml language permits object referencing.
diff --git a/doxygen/xmlthermalblock.md b/doxygen/xmlthermalblock.md
index 8c493c994c4712d975dc71eaecca84708a762de5..6b3184bfeceeb8e11b6acbc878b79961efe01567 100644
--- a/doxygen/xmlthermalblock.md
+++ b/doxygen/xmlthermalblock.md
@@ -1,177 +1,14 @@
Thermal blocks {#xmlthermalblock}
===================
-\~German
-Nachfolgend sind alle thermischen Blöcke, die im thermischen Modell verwendet werden können, aufgelistet.
-Für jeden thermischen Block wird der Aufbau des dazugehörigen XML-Elementes beschrieben und ein Codebeispiel gegeben.
-
-<br/>
-
-Allgemein
-=========
-
-Jeder thermische Block kann mit dem Attribut "class" spezifiziert werden.
-
-Jeder thermische Block kann das XML-Tag <**Heat**> haben.
-Der darin angegebene Wert ist die Verlustleistung im Block in Watt.
-Wenn die Verlustleistung an anderer Stelle der Simulation gesetzt wird (z.B. durch das elektrische Modell oder als Eingang der Simulink-S-Function), wird <**Heat**> ignoriert.
-
-<br/>
-
-Grundtypen
-==========
-
-<br/>
-
-Quaderförmiger thermischer Block
-----------
-
-
-__Objekttyp: "RectangularBlock"__
-
-<**Material**>: [Material](xmlthermalmaterial.html) des Quaders
-
-<**Dimensions**>: Die drei Längen des Quaders in x-, y- und z-Richtung
-
-<**SizeX**>: Diskretisierung des Quaders in finite Volumen in x-Richtung
-
-<**SizeY**>: Diskretisierung des Quaders in finite Volumen in y-Richtung
-
-<**SizeZ**>: Diskretisierung des Quaders in finite Volumen in z-Richtung
-
-<**InitialTemperature**>: Anfangstemperatur im thermischen Block in °C
-
-<**ElectricalDiscretization**>: Einteilung der elektrischen [Zellelemente](xmlelectrical.html) im thermischen Block. Diese muss für jede Dimension in die thermische Diskretisierung passen (z.B. für x-Dimension: SizeX modulo x == 0). Wenn <**ElectricalDiscretization**> nicht vorhanden ist, ist diesem Block nur ein Zellelement zugeordnet. Falls eines der Attribute x, y oder z fehlt, wird für dieses "1" angenommen.
-
-\htmlinclude xmlrectangular_color.xml
-
-
-Batteriezelle umgeben mit Füllmaterial in einem quaderförmigen Block
-----------
-
-__Objekttyp: "QuadraticCellBlock"__
-
-<**Length**>: Länge der quadratischen Grundfläche
-
-<**RadiusCell**>: Radius der Batteriezelle, die mittig im thermischen Block liegt
-
-<**Height**>: Höhe (Länge in z-Richtung) des thermischen Blocks
-
-<**CellRhoDivision**>: Diskretisierung der Batteriezelle in ρ-Richtung
-
-<**PhiDivision**>: Diskretisierung des thermischen Blocks in φ-Richtung
-
-<**HeightDivision**>: Diskretisierung des thermischen Blocks in z-Richtung
-
-<**ArcPolygonization**>: Vorgeschlagene Strecke für die Polygonisierung der vorhandenen Bögen und Kreise
-
-<**CellMaterial**>: [Material](xmlthermalmaterial.html) der Zelle
-
-<**FillMaterial**>: [Material](xmlthermalmaterial.html) des Füllmaterials
-
-<**InitialTemperature**>: Anfangstemperatur im thermischen Block in °C
-
-<**ElectricalDiscretization**>: Einteilung der elektrischen [Zellelemente](xmlelectrical.html) im thermischen Block. Diese muss für jede dimension in die thermische Diskretisierung passen (z.B. für z-Dimension: HeightDivision modulo z == 0). Wenn <**ElectricalDiscretization**> nicht vorhanden ist, ist diesem Block nur ein Zellelement zugeordnet. Falls eines der Attribute phi oder z fehlt, wird für dieses "1" angenommen.
-
-\htmlinclude xmlquadratic_color.xml
-
-
-Supercapzelle mit Wickel aus zwei radialen Schichten umgeben mit Füllmaterial in einem quaderförmigen Block
-----------
-
-
-
-__Objekttyp: "Supercap"__
-
-<**Length**>: Länge der quadratischen Grundfläche
-
-<**InnerRadiusCell**>: Radius der Grenze zwischen innerer and äußerer Schicht des Wickels
-
-<**OuterRadiusCell**>: Radius der Supercapzelle, die mittig im thermischen Block liegt
-
-<**Height**>: Höhe (Länge in z-Richtung) des thermischen Blocks
-
-<**PhiDivision**>: Diskretisierung des thermischen Blocks in φ-Richtung
-
-<**HeightDivision**>: Diskretisierung des thermischen Blocks in z-Richtung
-
-<**ArcPolygonization**>: Vorgeschlagene Strecke für die Polygonisierung der vorhandenen Bögen und Kreise
-
-<**InnerCellMaterial**>: [Material](xmlthermalmaterial.html) der inneren Schicht der Supercapzelle
-
-<**OuterCellMaterial**>: [Material](xmlthermalmaterial.html) der äußeren Schicht der Supercapzelle
-
-<**FillMaterial**>: [Material](xmlthermalmaterial.html) des Füllmaterials
-
-<**InitialTemperature**>: Anfangstemperatur im thermischen Block in °C
-
-<**ElectricalDiscretization**>: Einteilung der elektrischen [Zellelemente](xmlelectrical.html) im thermischen Block. Diese muss für jede dimension in die thermische Diskretisierung passen (z.B. für z-Dimension: HeightDivision modulo z == 0). Wenn <**ElectricalDiscretization**> nicht vorhanden ist, ist diesem Block nur ein Zellelement zugeordnet. Falls eines der Attribute phi oder z fehlt, wird für dieses "1" angenommen.
-
-\htmlinclude xmlsupercap_color.xml
-
-Batteriezelle umgeben mit Füllmaterial in einem hexagonal prismatischen Block
-----------
-
-
-
-__Objekttyp: "HexagonalCellBlock"__
-
-<**Length**>: Kantenlänge des gleichmäßigen Sechsecks, das die Grundfläche des thermischen Blocks bildet
-
-<**RadiusCell**>: Radius der Batteriezelle, die mittig im thermischen Block liegt
-
-<**Height**>: Höhe (Länge in z-Richtung) des thermischen Blocks
-
-<**CellRhoDivision**>: Diskretisierung der Batteriezelle in ρ-Richtung
-
-<**PhiDivision**>: Diskretisierung des thermischen Blocks in φ-Richtung
-
-<**HeightDivision**>: Diskretisierung des thermischen Blocks in z-Richtung
-
-<**ArcPolygonization**>: Vorgeschlagene Strecke für die Polygonisierung der vorhandenen Bögen und Kreise
-
-<**CellMaterial**>: [Material](xmlthermalmaterial.html) der Zelle
-
-<**FillMaterial**>: [Material](xmlthermalmaterial.html) des Füllmaterials
-
-<**InitialTemperature**>: Anfangstemperatur im thermischen Block in °C
-
-<**ElectricalDiscretization**>: Einteilung der elektrischen [Zellelemente](xmlelectrical.html) im thermischen Block. Diese muss für jede dimension in die thermische Diskretisierung passen (z.B. für z-Dimension: HeightDivision modulo z == 0). Wenn <**ElectricalDiscretization**> nicht vorhanden ist, ist diesem Block nur ein Zellelement zugeordnet. Falls eines der Attribute phi oder z fehlt, wird für dieses "1" angenommen.
-
-\htmlinclude xmlhexagonal_color.xml
-
-
-Dreiecksprismaförmiger thermischer Block
-----------
-
-
-__Objekttyp: "TriangularPrismBlock"__
-
-<**Vertices**>: Eckpunkte des Dreiecks, das die Grundfläche bildet, in xy-Koordinaten
-
-<**Height**>: Höhe (Länge in z-Richtung) des Prismas
-
-<**HeightDivision**>: Diskretisierung des Prismas in finite Volumen in z-Richtung
-
-<**Material**>: [Material](xmlthermalmaterial.html) des Prismas
-
-<**InitialTemperature**>: Anfangstemperatur im thermischen Block in °C
-
-<**ElectricalDiscretization**>: Einteilung der elektrischen [Zellelemente](xmlelectrical.html) im thermischen Block in z-Richtung. Diese muss in die thermische Diskretisierung passen, also HeightDivision modulo z == 0. Wenn <**ElectricalDiscretization**> nicht vorhanden ist, ist diesem Block nur ein Zellelement zugeordnet. Falls das Attribut z fehlt, wird für dieses "1" angenommen.
-
-\htmlinclude xmltri_color.xml
-
-\~English
-All thermal blocks, which are used in the thermal model, are listed in the section below.
+All thermal blocks that are used in the thermal model are listed in the section below.
The structure of the corresponding xml element and a code example is given for each block.
-<br/>
-
Abstract
=========
-Each thermal block can be specified by the attribute "class".
+Each thermal block can be specified by the attribute "class".
Each thermal block can posses the xml tag <**Heat**>.
The value indicated therein indicates the power loss in Watt.
If the power loss is set at another point in the simulation (e.g. in the electrical model or as input of the Simulink S-function), this value will be ignored.
@@ -189,53 +26,44 @@ Rectangular thermal block
__Object type: "RectangularBlock"__
-<**Material**>: [Material](xmlthermalmaterial.html) of the cuboid
-
-<**Dimensions**>: The three dimensions of the cuboid in x-, y-, and z-direction
-
-<**SizeX**>: Discretization of the cuboid in finite volumes in x-direction
-
-<**SizeY**>: Discretization of the cuboid in finite volumes in y-direction
-
-<**SizeZ**>: Discretization of the cuboid in finite volumes in z-direction
-
-<**InitialTemperature**>: Initial temperature within the thermal block in °C
-
-<**ElectricalDiscretization**>: Discretization of the electrical [cell elements](xmlelectrical.html) within the thermal block. These has to fit into the thermal discretization in each dimension (e.g x-dimension: SizeX modulo x == o). If <**ElectricalDiscretization**> is not existing, a single cell element will be addressed to this block. If one of the attributes x, y or z is missing, "1" will be used as default.
+XML Tag | Type | Explanation
+------------------------ |-------------------------------------|----------------------------
+Material | [material](xmlthermalmaterial.html) | material of the thermal block
+Dimensions | comma-separated doubles | size of the thermal block in x, y, and z direction in meters
+SizeX | integer | discretization of the thermal block in finite volumes in x direction
+SizeY | integer | discretization of the thermal block in finite volumes in y direction
+SizeZ | integer | discretization of the thermal block in finite volumes in z direction
+InitialTemperature | double | initial temperature of the thermal block in °C
+ElectricalDiscretization | double | discretization of the electrical [cell elements](xmlelectrical.html) within the thermal block. These have to fit into the thermal discretization in each dimension (e.g z-dimension: SizeZ modulo z == 0). If ElectricalDiscretization is not used, a single cell element will be addressed to this block. If one of the attributes x, y or z is missing, 1 will be used as the default value.
+- Attribute x | integer | electrical discretization in x direction
+- Attribute y | integer | electrical discretization in x direction
+- Attribute z | integer | electrical discretization in x direction
\htmlinclude xmlrectangular_color.xml
-
-Battery cell surrounded by fill material within a rectangular block
+Cylindrical cell surrounded by a rectangular block of fill material
----------
__Object type: "QuadraticCellBlock"__
-<**Length**>: Length of the quadratic base area
-
-<**RadiusCell**>: Radius of the battery cell, which is placed centrical within the thermal block.
-
-<**Height**>: Height (length in z-direction) of the thermal block
-
-<**CellRhoDivision**>: Discretization of the battery cell in ρ-direction
-
-<**PhiDivision**>: Discretization of the thermal block in φ-direction
-
-<**HeightDivision**>: Discretization of the thermal block in z-direction
-
-<**ArcPolygonization**>: Suggested route for the polygonization of the existing arcs and circles
-
-<**CellMaterial**>: [Material](xmlthermalmaterial.html) of the cell
-
-<**FillMaterial**>: [Material](xmlthermalmaterial.html) of the fill material
-
-<**InitialTemperature**>: Initial temperature of the thermal block in °C
-
-<**ElectricalDiscretization**>: Discretization of the electrical [cell elements](xmlelectrical.html) within the thermal block. These has to fit into the thermal discretization in each dimension (e.g. z-dimension: HeightDivision modulo z == 0). If <**ElectricalDiscretization**> is not existing, a single cell element will be addressed to this block. If one of the attributes phi or z is missing, "1" will be used as default.
+XML Tag | Type | Explanation
+------------------------ |-------------------------------------|----------------------------
+CellMaterial | [material](xmlthermalmaterial.html) | material of the cell
+FillMaterial | [material](xmlthermalmaterial.html) | material of the block surrounding the cell
+Length | double | length of the quadratic base area in meters
+RadiusCell | double | radius of the cell in meters. The cell is placed centrally within the thermal block.
+Height | double | height (in z direction) of the thermal block in meters
+CellRhoDivision | integer | discretization of the battery cell in ρ direction
+PhiDivision | integer | discretization of the thermal block in φ direction
+HeightDivision | integer | discretization of the thermal block in z direction
+InitialTemperature | double | initial temperature of the thermal block in °C
+ArcPolygonization | double | suggested route for the polygonization of the existing arcs and circles
+ElectricalDiscretization | double | discretization of the electrical [cell elements](xmlelectrical.html) within the thermal block. These have to fit into the thermal discretization in each dimension (e.g z-dimension: SizeZ modulo z == 0). If ElectricalDiscretization is not used, a single cell element will be addressed to this block. If one of the attributes phi or z is missing, 1 will be used as the default value.
+- Attribute phi | integer | electrical discretization in phi direction
+- Attribute z | integer | electrical discretization in x direction
\htmlinclude xmlquadratic_color.xml
-
Supercap cell with two radial layers surrounded by fill material within a rectangular block
----------
@@ -243,81 +71,65 @@ Supercap cell with two radial layers surrounded by fill material within a rectan
__Object type: "Supercap"__
-<**Length**>: Length of the quadratic base area
-
-<**InnerRadiusCell**>: Radius of the boundary between the inner and outer layer
-
-<**OuterRadiusCell**>: Radius of the supercap cell, which is placed centrical within the thermal block
-
-<**Height**>: Height (length in z-direction) of the thermal block
-
-<**PhiDivision**>: Discretization of the thermal block in φ-direction
-
-<**HeightDivision**>: Discretization of the thermal block in z-direction
-
-<**ArcPolygonization**>: Suggested route for the polygonization of the existing arcs and circles
-
-<**InnerCellMaterial**>: [Material](xmlthermalmaterial.html) of the inner layer of the supercap cell
-
-<**OuterCellMaterial**>: [Material](xmlthermalmaterial.html) of the outer layer of the supercap cell
-
-<**FillMaterial**>: [Material](xmlthermalmaterial.html) of the fill material
-
-<**InitialTemperature**>: Initial temperature of the thermal block in °C
-
-<**ElectricalDiscretization**>: Discretization of the electrical [cell elements](xmlelectrical.html) within the thermal block. These has to fit into the thermal discretization in each dimension (e.g. z-dimension: HeightDivision modulo z == 0). These has to fit into the thermal discretization in each dimension (e.g. z-dimension: HeightDivision modulo z == 0). If <**ElectricalDiscretization**> is not existing, a single cell element will be addressed to this block. If one of the attributes phi or z is missing, "1" will be used as default.
+XML Tag | Type | Explanation
+------------------------ |-------------------------------------|----------------------------
+InnerCellMaterial | [material](xmlthermalmaterial.html) | material of the inner layer of the cell
+OuterCellMaterial | [material](xmlthermalmaterial.html) | material of the outer layer of the cell
+FillMaterial | [material](xmlthermalmaterial.html) | material of the block surrounding the cell
+Length | double | length of the quadratic base area in meters
+InnerRadiusCell | double | radius of the boundary between the inner and outer layer in meters
+OuterRadiusCell | double | radius of the supercap in meters. The cell is placed centrally within the thermal block.
+Height | double | height (in z direction) of the thermal block in meters
+PhiDivision | integer | discretization of the thermal block in φ direction
+HeightDivision | integer | discretization of the thermal block in z direction
+InitialTemperature | double | initial temperature of the thermal block in °C
+ArcPolygonization | double | suggested route for the polygonization of the existing arcs and circles
+ElectricalDiscretization | double | discretization of the electrical [cell elements](xmlelectrical.html) within the thermal block. These have to fit into the thermal discretization in each dimension (e.g z-dimension: SizeZ modulo z == 0). If ElectricalDiscretization is not used, a single cell element will be addressed to this block. If one of the attributes phi or z is missing, 1 will be used as the default value.
+- Attribute phi | integer | electrical discretization in phi direction
+- Attribute z | integer | electrical discretization in x direction
\htmlinclude xmlsupercap_color.xml
-Battery cell surrounded with fill material in an hexagonal prismatic block
+Cylindrical cell surrounded by a hexagonal prismatic block of fill material
----------
__Object type: "HexagonalCellBlock"__
-<**Length**>: Edge length of the regular hexagon, which provides the base area of the block
-
-<**RadiusCell**>: Radius of the cell, which is placed centrical within the thermal block
-
-<**Height**>: Height (length in z-direction) of the thermal block
-
-<**CellRhoDivision**>: Discretization of the battery cell in ρ-direction
-
-<**PhiDivision**>: Discretization of the thermal block in φ-direction
-
-<**HeightDivision**>: Discretization of the thermal block in z-direction
-
-<**ArcPolygonization**>: Suggested route for the polygonization of the existing arcs and circles
-
-<**CellMaterial**>: [Material](xmlthermalmaterial.html) of the cell
-
-<**FillMaterial**>: [Material](xmlthermalmaterial.html) of the fill material
-
-<**InitialTemperature**>: Initial temperature of the thermal block°C
-
-<**ElectricalDiscretization**>: Discretization of the electric [cell elements](xmlelectrical.html) within the thermal block. These has to fit into the thermal discretization in each dimension (e.g. z-dimension: HeightDivision modulo z == 0).If <**ElectricalDiscretization**> is not existing, a single cell element will be addressed to this block. If one of the attributes phi or z is missing, "1" will be used as default.
+XML Tag | Type | Explanation
+------------------------ |-------------------------------------|----------------------------
+CellMaterial | [material](xmlthermalmaterial.html) | material of the cell
+FillMaterial | [material](xmlthermalmaterial.html) | material of the block surrounding the cell
+Length | double | edge length of the regular hexagonal base area of the thermal block in meters
+RadiusCell | double | radius of the cell in meters. The cell is placed centrally within the thermal block.
+Height | double | height (in z direction) of the thermal block in meters
+CellRhoDivision | integer | discretization of the battery cell in ρ direction
+PhiDivision | integer | discretization of the thermal block in φ direction
+HeightDivision | integer | discretization of the thermal block in z direction
+InitialTemperature | double | initial temperature of the thermal block in °C
+ArcPolygonization | double | suggested route for the polygonization of the existing arcs and circles
+ElectricalDiscretization | double | discretization of the electrical [cell elements](xmlelectrical.html) within the thermal block. These have to fit into the thermal discretization in each dimension (e.g z-dimension: SizeZ modulo z == 0). If ElectricalDiscretization is not used, a single cell element will be addressed to this block. If one of the attributes phi or z is missing, 1 will be used as the default value.
+- Attribute phi | integer | electrical discretization in phi direction
+- Attribute z | integer | electrical discretization in x direction
\htmlinclude xmlhexagonal_color.xml
-
Triangular prismatic thermal block
----------
__Object type: "TriangularPrismBlock"__
-<**Vertices**>: Vertices of the triangle, which forms the base are; in xy-coordinates
-
-<**Height**>: Height (length in z-direction) of the prism
-
-<**HeightDivision**>: Discretization of the prism in finite volumes in z-direction
-
-<**Material**>: [Material](xmlthermalmaterial.html) of the prism
-
-<**InitialTemperature**>: Initial temperature of the thermal block in °C
-
-<**ElectricalDiscretization**>: Discretization of the electric [cell elements](xmlelectrical.html) within the thermal block in z-direction. This has to fit into the thermal discretization (HeightDivision modulo z == 0) . If <**ElectricalDiscretization**> is not existing a single cell element will be addressed to this block. It the attribute z is missing, "1" will be used as default.
+XML Tag | Type | Explanation
+------------------------ |-------------------------------------|----------------------------
+Material | [material](xmlthermalmaterial.html) | material of the prism
+Vertices | comma-separated doubles | vertices of the triangle that forms the base of the thermal block in xy coordinates.
+Height | double | height (in z direction) of the thermal block in meters
+HeightDivision | integer | discretization of the thermal block in z direction
+InitialTemperature | double | initial temperature of the thermal block in °C
+ElectricalDiscretization | double | discretization of the electrical [cell elements](xmlelectrical.html) within the thermal block. These have to fit into the thermal discretization in each dimension (e.g z-dimension: SizeZ modulo z == 0). If ElectricalDiscretization is not used, a single cell element will be addressed to this block. If the attribute z is missing, 1 will be used as the default value.
+- Attribute z | integer | electrical discretization in x direction
\htmlinclude xmltri_color.xml
diff --git a/doxygen/xmlthermalmaterial.md b/doxygen/xmlthermalmaterial.md
index 3e1901b2f40ea9950617abd4f5424d1442966720..73cefa2d908c9411af2a99f7ccf4b5dbbfd683cc 100644
--- a/doxygen/xmlthermalmaterial.md
+++ b/doxygen/xmlthermalmaterial.md
@@ -1,85 +1,6 @@
Thermal materials {#xmlthermalmaterial}
===================
-\~German
-Nachfolgend sind alle Materialien, die im thermischen Modell verwendet werden können, aufgelistet.
-Für jedes Material wird der Aufbau des dazugehörigen XML-Elementes beschrieben und ein Codebeispiel gegeben.
-
-<br/>
-
-Allgemein
-=========
-
-Alle Materialien sind im <**ThermalMaterials**>-Knoten, der im Wurzelknoten der XML-Datei (im <**Configurations**>-Knoten) zu finden ist, aufgelistet.
-Alle Materialien müssen das Attribut "cache='true'" gesetzt haben.
-
-<br/>
-
-Thermische Materialien
-==========
-
-<br/>
-
-Material mit isotroper Wärmeleitfähgkeit
-----------
-
-__Objekttyp: "Material"__
-
-<**Density**>: Dichte in kg/m³
-
-<**SpecificCapacity**>: Spezifische Wärmekapazität in J/(kg·K)
-
-<**Conductivity**>: Wärmeleitfähigkeit in W/(m·K)
-
-<**Emissivity**>: Emissionsgrad ohne Einheit
-
-\htmlinclude thermalmaterial_color.xml
-
-<br/>
-
-
-Material mit anisotroper Wärmeleitfähigkeit gegeben in kartesischen Koordinaten
-----------
-
-__Objekttyp: "MaterialCartesian"__
-
-<**Density**>: Dichte in kg/m³
-
-<**SpecificCapacity**>: Spezifische Wärmekapazität in J/(kg·K)
-
-<**ConductivityX**>: Wärmeleitfähigkeit in x-Richtung in W/(m·K)
-
-<**ConductivityY**>: Wärmeleitfähigkeit in y-Richtung in W/(m·K)
-
-<**ConductivityZ**>: Wärmeleitfähigkeit in z-Richtung in W/(m·K)
-
-<**Emissivity**>: Emissionsgrad ohne Einheit
-
-\htmlinclude thermalmaterialcartesian_color.xml
-
-<br/>
-
-
-Material mit anisotroper Wärmeleitfähigkeit gegeben in zylindirschen Koordinaten
-----------
-
-__Objekttyp: "MaterialCylindric"__
-
-<**Density**>: Dichte in kg/m³
-
-<**SpecificCapacity**>: Spezifische Wärmekapazität in J/(kg·K)
-
-<**ConductivityRho**>: Wärmeleitfähigkeit in ρ-Richtung in W/(m·K)
-
-<**ConductivityPhi**>: Wärmeleitfähigkeit in φ-Richtung in W/(m·K)
-
-<**ConductivityZ**>: Wärmeleitfähigkeit in z-Richtung in W/(m·K)
-
-<**Emissivity**>: Emissionsgrad ohne Einheit
-
-\htmlinclude thermalmaterialcylindric_color.xml
-
-\~English
All materials, which are used in the thermal model, are listed below.
The structure of the corresponding xml elements and a code snippet are given for each material.
@@ -88,7 +9,7 @@ The structure of the corresponding xml elements and a code snippet are given for
Abstract
=========
-All material are listed in the <**ThermalMaterials**>-node, which could be found in the root node of the xml file (within the <**Configurations**>-node).
+All material are listed in the <**ThermalMaterials**>-node, which can be found in the root node of the xml file (within the <**Configurations**>-node).
The attribute "cache='true'" has to be set for all materials.
<br/>
@@ -103,36 +24,28 @@ Material with isotropic thermal conductivity
__Object type: "Material"__
-<**Density**>: density in kg/m³
-
-<**SpecificCapacity**>: specific heat capacity in J/(kg·K)
-
-<**Conductivity**>: thermal conductivity in W/(m·K)
-
-<**Emissivity**>: Emissivity without unit
+XML Tag | Type | Explanation
+-------------------------|-------------------------------------|----------------------------
+Density | double | density in kg/m³
+SpecificCapacity | double | specific heat capacity in J/(kg*K)
+Conductivity | double | thermal conductivity in W/(m*K)
+Emissivity | double | emissivity (0 to 1)
\htmlinclude thermalmaterial_color.xml
-<br/>
-
-
-Material with anisotropic thermal conductivity in Cartesian coordinates
+Material with anisotropic thermal conductivity in cartesian coordinates
----------
__Object type: "MaterialCartesian"__
-<**Density**>: density in kg/m³
-
-<**SpecificCapacity**>: specific heat capacity in J/(kg·K)
-
-<**ConductivityX**>: thermal conductivity in x-direction in W/(m·K)
-
-<**ConductivityY**>: thermal conductivity in y-direction in W/(m·K)
-
-<**ConductivityZ**>: thermal conductivity in z-direction in W/(m·K)
-
-<**Emissivity**>: Emissivity without unit
-
+XML Tag | Type | Explanation
+-------------------------|-------------------------------------|----------------------------
+Density | double | density in kg/m³
+SpecificCapacity | double | specific heat capacity in J/(kg*K)
+ConductivityX | double | thermal conductivity in x direction in W/(m*K)
+ConductivityY | double | thermal conductivity in y direction in W/(m*K)
+ConductivityZ | double | thermal conductivity in z direction in W/(m*K)
+Emissivity | double | emissivity (0 to 1)
\htmlinclude thermalmaterialcartesian_color.xml
@@ -144,16 +57,14 @@ Material with anisotropic thermal conductivity in cylindrical coordinates
__Objekttyp: "MaterialCylindric"__
-<**Density**>: density in kg/m³
-
-<**SpecificCapacity**>: specific heat capacity in J/(kg·K)
-
-<**ConductivityRho**>: thermal conductivity in ρ-direction in W/(m·K)
-
-<**ConductivityPhi**>: thermal conductivity in φ-direction in W/(m·K)
-
-<**ConductivityZ**>: thermal conductivity in z-direction in W/(m·K)
+XML Tag | Type | Explanation
+-------------------------|-------------------------------------|----------------------------
+Density | double | density in kg/m³
+SpecificCapacity | double | specific heat capacity in J/(kg*K)
+ConductivityRho | double | thermal conductivity in ρ direction in W/(m*K)
+ConductivityPhi | double | thermal conductivity in φ direction in W/(m*K)
+ConductivityZ | double | thermal conductivity in z direction in W/(m*K)
+Emissivity | double | emissivity (0 to 1)
-<**Emissivity**>: Emissivity without unit
\htmlinclude thermalmaterialcylindric_color.xml
diff --git a/misc/images/Logo_V3.jpg b/misc/images/logo.jpg
similarity index 100%
rename from misc/images/Logo_V3.jpg
rename to misc/images/logo.jpg
diff --git a/misc/images/Logo_V3.pdf b/misc/images/logo.pdf
similarity index 100%
rename from misc/images/Logo_V3.pdf
rename to misc/images/logo.pdf
diff --git a/misc/images/logo.png b/misc/images/logo_isea.png
similarity index 100%
rename from misc/images/logo.png
rename to misc/images/logo_isea.png
diff --git a/src/aging/calendarian_aging.cpp b/src/aging/calendarian_aging.cpp
index 5347180683b4115d8b34c3460459def66a3ed2c8..9b32444fcdd22d74854370ddc143f105f868903a 100644
--- a/src/aging/calendarian_aging.cpp
+++ b/src/aging/calendarian_aging.cpp
@@ -53,6 +53,7 @@ void CalendarianAging::CalculateAging( const TwoportState& twoportState, double
double timestepDays = timestep * scaleFactor / 86400;
+ double previousCapFactor = this->mCapacityFactor;
this->mCapacityFactor = 1 - pow( pow( 1 - this->mCapacityFactor, 1 / this->mTimeExponent ) +
( timestepDays * pow( this->mStressFactorCapacity, 1 / this->mTimeExponent ) ),
this->mTimeExponent );
@@ -61,7 +62,7 @@ void CalendarianAging::CalculateAging( const TwoportState& twoportState, double
( timestepDays * pow( this->mStressFactorResistance, 1 / this->mTimeExponent ) ),
this->mTimeExponent );
- this->CalculateChargeLoss( twoportState );
+ this->CalculateChargeLoss( twoportState, previousCapFactor );
mTimeValues.clear();
mVoltageValues.clear();
diff --git a/src/aging/cyclical_aging.cpp b/src/aging/cyclical_aging.cpp
index 1e9dfd7aed2588d60320264d28c860bb634c8aa8..9907171ab54ccebaf752bd2bbb6e480fe165e0a2 100644
--- a/src/aging/cyclical_aging.cpp
+++ b/src/aging/cyclical_aging.cpp
@@ -1,4 +1,5 @@
#include "cyclical_aging.h"
+#include "../misc/rainflow.h"
#include <fstream>
#include <iostream>
@@ -66,6 +67,7 @@ void CyclicalAging::CalculateAging( const TwoportState& twoportState, double tim
// rest of the aging step.
additionalChargeThroughput = chargeThroughput * scaleFactor;
+ double previousCapFactor = this->mCapacityFactor;
this->mCapacityFactor =
1 - pow( pow( 1 - this->mCapacityFactor, 1 / this->mChargeThroughputExponentCapacity ) +
( additionalChargeThroughput * pow( this->mStressFactorCapacity, 1 / this->mChargeThroughputExponentCapacity ) ),
@@ -76,7 +78,7 @@ void CyclicalAging::CalculateAging( const TwoportState& twoportState, double tim
( additionalChargeThroughput * pow( this->mStressFactorResistance, 1 / this->mChargeThroughputExponentResistance ) ),
this->mChargeThroughputExponentResistance );
- this->CalculateChargeLoss( twoportState );
+ this->CalculateChargeLoss( twoportState, previousCapFactor );
}
this->mTimeValues.clear();
diff --git a/src/aging/cyclical_aging.h b/src/aging/cyclical_aging.h
index da4f8e317c63354ff809d8cc7aeba1a4e51950c8..bb83a99b9e8b3243c0899a2de3763cda517a8e7d 100644
--- a/src/aging/cyclical_aging.h
+++ b/src/aging/cyclical_aging.h
@@ -5,7 +5,6 @@
#define _CYCLICAL_AGING_
#include "../electrical/cellelement.h"
-#include "../misc/rainflow.h"
#include "../state/soc.h"
#include "empirical_aging.h"
diff --git a/src/aging/empirical_aging.cpp b/src/aging/empirical_aging.cpp
index f50542a49409cf1824db744398af717903296ea6..6731f5d16cd34500914fdaf43db4e77b08e88663 100644
--- a/src/aging/empirical_aging.cpp
+++ b/src/aging/empirical_aging.cpp
@@ -18,10 +18,10 @@ EmpiricalAging::EmpiricalAging( const double agingStepTime, const double minStre
{
}
-void EmpiricalAging::CalculateChargeLoss( const TwoportState& twoportState )
+void EmpiricalAging::CalculateChargeLoss( const TwoportState& twoportState, double previousCapFactor )
{
- this->mChargeLoss = ( 1 - this->mCapacityFactor ) *
- twoportState.mSocState->template GetInitialCapacity< state::SocGetFormat::AS >() *
- twoportState.mSocState->template GetValue< state::SocGetFormat::PERCENT >() / 100;
+ this->mChargeLoss += ( previousCapFactor - this->mCapacityFactor ) *
+ twoportState.mSocState->template GetInitialCapacity< state::SocGetFormat::AS >() *
+ twoportState.mSocState->template GetValue< state::SocGetFormat::PERCENT >() / 100;
}
} // namespace aging
diff --git a/src/aging/empirical_aging.h b/src/aging/empirical_aging.h
index 571be0d6ccd8f23214e7c313481e79feea1c7284..d95126ecb8b7cb6d5d8f43a0967316f0bb253529 100644
--- a/src/aging/empirical_aging.h
+++ b/src/aging/empirical_aging.h
@@ -26,7 +26,7 @@ class EmpiricalAging : public AgingBase
virtual double GetStressFactorResistance() { return mStressFactorResistance; };
protected:
- virtual void CalculateChargeLoss( const TwoportState& twoportState );
+ virtual void CalculateChargeLoss( const TwoportState& twoportState, double previousCapFactor );
double mCapacityFactor;
double mResistanceFactor;
diff --git a/src/cinterface/cinterface.cpp b/src/cinterface/cinterface.cpp
index f997a92a1254dd11e666dab2b1e301212a5969e1..4f9f3d4cac39680d206148b0094133d1130dee4d 100644
--- a/src/cinterface/cinterface.cpp
+++ b/src/cinterface/cinterface.cpp
@@ -111,7 +111,7 @@ extern "C"
{
// Reorder the observed twoports so that all elements inside one cell end up in the same row in the output
// matrix. The vector is interpreted as a column-major matrix with the number of rows equal to the number of cells
- std::vector< boost::shared_ptr< electrical::TwoPort< myMatrixType > > > twoportVector( observedTwoports.size() );
+ std::vector< boost::shared_ptr< electrical::TwoPort< myMatrixType > > > twoportVector( observedTwoports.size(), nullptr );
size_t outputRows = numberOfCellelements;
size_t outputColumns = std::ceil( (double)observedTwoports.size() / outputRows );
// first column has all the cellements, so they can just be copied
@@ -123,7 +123,7 @@ extern "C"
{
size_t row = ( i - numberOfCellelements ) / ( outputColumns - 1 );
size_t column = ( i - numberOfCellelements ) % ( outputColumns - 1 ) + 1;
- twoportVector[row * outputRows + column] = observedTwoports[i];
+ twoportVector[column * outputRows + row] = observedTwoports[i];
}
pointerStructure->mElectricalSimulation->mObserver =
CreateTwoPortObserver< std::vector< boost::shared_ptr< electrical::TwoPort< myUnit > > >, myUnit, false >(
diff --git a/src/cinterface/cinterface_Aging.cpp b/src/cinterface/cinterface_Aging.cpp
new file mode 100644
index 0000000000000000000000000000000000000000..fff02b066199afa795264e387894fadb4d162ea2
--- /dev/null
+++ b/src/cinterface/cinterface_Aging.cpp
@@ -0,0 +1,144 @@
+#include "cinterface_Aging.h"
+#include "pointer_structure.h"
+
+#include "../aging/aging_simulation.h"
+#include "../aging/aging_twoport.h"
+#include "../factory/factorybuilder_without_electrical_elements.h"
+#include "../misc/matrixInclude.h"
+#include "../thermal/simulation_data_outline.h"
+#include "../xmlparser/tinyxml2/xmlparserimpl.h"
+
+#include <boost/scoped_ptr.hpp>
+
+#ifndef _SYMBOLIC_
+
+typedef myMatrixType myUnit;
+typedef double myScalar;
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+ void InitializeSystem_Aging( const char *configStr, size_t *pointerStructureAddress, real_T *agingStepTime )
+ {
+ xmlparser::tinyxml2::XmlParserImpl parser;
+ parser.ReadFromMem( configStr );
+ boost::shared_ptr< xmlparser::XmlParameter > rootXmlNode = parser.GetRoot();
+
+ double xmlAgingSteptime =
+ rootXmlNode->GetElementChild( "Options" )->GetElementChild( "Aging" )->GetElementDoubleValue( "AgingStepTime" );
+
+ PointerStructure_Aging *pointerStructure = new PointerStructure_Aging;
+ *pointerStructureAddress = (size_t)pointerStructure;
+ factory::FactoryBuilderWithoutElectricalElements< myUnit, myScalar > factoryBuilder;
+
+ auto electricalSimulation =
+ boost::make_shared< simulation::ElectricalSimulation< myUnit, myScalar, false > >( rootXmlNode, 0.0, 0.0, 0.0,
+ nullptr, &factoryBuilder );
+
+ pointerStructure->mAgingSimulation.reset(
+ new simulation::AgingSimulation< myUnit, myScalar, false >( rootXmlNode, electricalSimulation, nullptr, {},
+ xmlAgingSteptime, &factoryBuilder ) );
+
+ if ( agingStepTime )
+ *agingStepTime = xmlAgingSteptime;
+ }
+
+ void DeleteSystem_Aging( size_t *pointerStructureAddress )
+ {
+ if ( !pointerStructureAddress )
+ return;
+
+ PointerStructure_Aging *pointerStructure = (PointerStructure_Aging *)*pointerStructureAddress;
+ delete pointerStructure;
+ *pointerStructureAddress = 0;
+ }
+
+ void ResetSystem_Aging( const char *configStr, size_t *pointerStructureAddress )
+ {
+ DeleteSystem_Aging( pointerStructureAddress );
+ InitializeSystem_Aging( configStr, pointerStructureAddress, nullptr );
+ }
+
+ void GetRealSizes_Aging( const char *configStr, const size_t *pointerStructureAddress, size_t *agingTwoportSize )
+ {
+ xmlparser::tinyxml2::XmlParserImpl parser;
+ parser.ReadFromMem( configStr );
+ boost::shared_ptr< xmlparser::XmlParameter > rootXmlNode = parser.GetRoot();
+
+ if ( pointerStructureAddress )
+ {
+ PointerStructure_Aging *pointerStructure = (PointerStructure_Aging *)*pointerStructureAddress;
+ *agingTwoportSize = pointerStructure->mAgingSimulation->mAgingTwoPorts.size();
+ }
+ else
+ {
+ PointerStructure_Aging pointerStructure;
+
+ factory::FactoryBuilderWithoutElectricalElements< myUnit, myScalar > factoryBuilder;
+ auto electricalSimulation =
+ boost::make_shared< simulation::ElectricalSimulation< myUnit, myScalar, false > >( rootXmlNode, 0.0, 0.0, 0.0,
+ nullptr, &factoryBuilder );
+
+ pointerStructure.mAgingSimulation.reset(
+ new simulation::AgingSimulation< myUnit, myScalar, false >( rootXmlNode, electricalSimulation, nullptr, {},
+ 0.0, &factoryBuilder ) );
+ *agingTwoportSize = pointerStructure.mAgingSimulation->mAgingTwoPorts.size();
+ }
+ }
+
+ void CollectData_Aging( const size_t *pointerStructureAddress, const real_T *voltageVector, const real_T *currentVector,
+ const real_T *socVector, const real_T *temperatureVector, const real_T dt )
+ {
+ PointerStructure_Aging *pointerStructure = (PointerStructure_Aging *)*pointerStructureAddress;
+ for ( size_t i = 0; i < pointerStructure->mAgingSimulation->mAgingTwoPorts.size(); ++i )
+ {
+ electrical::TwoPortWithState< myUnit > &twoport =
+ *pointerStructure->mAgingSimulation->mAgingTwoPorts[i]->GetTwoPort();
+ twoport.LoadInternalData( currentVector[i], voltageVector[i], 0.0 );
+ twoport.GetSoc()->SetStoredEnergy< state::SocSetFormat::FACTOR >( socVector[i] / 100.0 );
+ twoport.GetThermalState()->SetTemperature( temperatureVector[i] );
+
+ pointerStructure->mAgingSimulation->mAgingTwoPorts[i]->CollectData( dt );
+ }
+ }
+
+ void ResetToPointInTime_Aging( const size_t *pointerStructureAddress, const real_T time )
+ {
+ PointerStructure_Aging *pointerStructure = (PointerStructure_Aging *)*pointerStructureAddress;
+ pointerStructure->mAgingSimulation->ResetToPointInTime( time );
+ }
+
+ void Calculate_Aging( const size_t *pointerStructureAddress, real_T *relCapVector, real_T *relResVector,
+ real_T *socOffsetVector, real_T timestep )
+ {
+ PointerStructure_Aging *pointerStructure = (PointerStructure_Aging *)*pointerStructureAddress;
+ pointerStructure->mAgingSimulation->CalculateAging( timestep, true );
+ for ( size_t i = 0; i < pointerStructure->mAgingSimulation->mAgingTwoPorts.size(); ++i )
+ {
+ state::AgingState &agingState = *pointerStructure->mAgingSimulation->mAgingTwoPorts[i]->GetAgingState();
+ relCapVector[i] = agingState.mCapacityFactor;
+ relResVector[i] = agingState.mResistanceFactor;
+ socOffsetVector[i] = agingState.mSocOffset;
+ }
+ }
+
+ void Calculate_Aging_Variable_Steptime( const size_t *pointerStructureAddress, real_T *relCapVector, real_T *relResVector,
+ real_T *socOffsetVector, real_T timestep, real_T scaleFactor )
+ {
+ PointerStructure_Aging *pointerStructure = (PointerStructure_Aging *)*pointerStructureAddress;
+ pointerStructure->mAgingSimulation->CalculateAging( timestep, scaleFactor );
+ for ( size_t i = 0; i < pointerStructure->mAgingSimulation->mAgingTwoPorts.size(); ++i )
+ {
+ state::AgingState &agingState = *pointerStructure->mAgingSimulation->mAgingTwoPorts[i]->GetAgingState();
+ relCapVector[i] = agingState.mCapacityFactor;
+ relResVector[i] = agingState.mResistanceFactor;
+ socOffsetVector[i] = agingState.mSocOffset;
+ }
+ }
+
+#ifdef __cplusplus
+}
+#endif
+#endif
diff --git a/src/cinterface/cinterface_Aging.h b/src/cinterface/cinterface_Aging.h
new file mode 100644
index 0000000000000000000000000000000000000000..ed2b2b80eb364aac207fd216284c085e80c1d88e
--- /dev/null
+++ b/src/cinterface/cinterface_Aging.h
@@ -0,0 +1,37 @@
+#ifndef _CINTERFACE_AGING_
+#define _CINTERFACE_AGING_
+
+#include "cinterface_common_functions.h"
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+ /// Initializes a system and returns the adress of the DAE system as a size_t
+ void InitializeSystem_Aging( const char *configStr, size_t *pointerStructureAddress, real_T *agingStepTime );
+
+ /// Resets the system. Meaning the old system will be deleted and a new one initialized
+ void ResetSystem_Aging( const char *configStr, size_t *pointerStructureAddress );
+
+ void GetRealSizes_Aging( const char *configStr, const size_t *pointerStructureAddress, size_t *agingTwoportSize );
+
+ void CollectData_Aging( const size_t *pointerStructureAddresst, const real_T *voltageVector, const real_T *currentVector,
+ const real_T *socVector, const real_T *temperatureVector, const real_T d );
+
+ void ResetToPointInTime_Aging( const size_t *pointerStructureAddress, const real_T time );
+
+ void Calculate_Aging( const size_t *pointerStructureAddress, real_T *relCapVector, real_T *relResVector,
+ real_T *socOffsetVector, real_T timestep );
+
+ void Calculate_Aging_Variable_Steptime( const size_t *pointerStructureAddress, real_T *relCapVector, real_T *relResVector,
+ real_T *socOffsetVector, real_T timestep, real_T scaleFactor );
+
+ void DeleteSystem_Aging( size_t *pointerStructureAddress );
+
+#ifdef __cplusplus
+}
+#endif
+
+/// DESCRIPTION
+#endif /* _CINTERFACE_AGING_ */
diff --git a/src/cinterface/cinterface_ThEl.cpp b/src/cinterface/cinterface_ThEl.cpp
index 7b196cd590386b217fe3ff86c3bfd0a046305e67..8e50d2104aa51ac30e7044a685c00a6cf6f78765 100644
--- a/src/cinterface/cinterface_ThEl.cpp
+++ b/src/cinterface/cinterface_ThEl.cpp
@@ -17,10 +17,10 @@ _._._._._._._._._._._._._._._._._._._._._.*/
#include "../observer/filter/filter.h"
#include "../operators/vectorOperator.h"
+#include "../electrical/electrical_simulation.h"
#include "../export/esbVisualizer.h"
#include "../export/spiceExport.h"
#include "../observer/filter/vcpfilter.h"
-#include "../electrical/electrical_simulation.h"
#include "../thermal/simulation_data_outline.h"
#include "../thermal/thermal_simulation.h"
#include "../xmlparser/tinyxml2/xmlparserimpl.h"
@@ -157,10 +157,36 @@ extern "C"
{
PointerStructure_ThEl *pointerStructure = (PointerStructure_ThEl *)*pointerStructureAddress;
- pointerStructure->mElectricalSimulation->mObserver =
- CreateTwoPortObserver< std::vector< boost::shared_ptr< electrical::TwoPort< myUnit > > >, myUnit, false >(
- &pointerStructure->mElectricalSimulation->mObserver->GetObservedTwoPorts(), 0, voltageOutputVec,
- currentOutputVec, powerOutputVec, socOutputVec, socSurfaceOutputVec );
+ size_t numberOfCellelements = pointerStructure->mElectricalSimulation->mCellElements.size();
+ const auto &observedTwoports = pointerStructure->mElectricalSimulation->mObserver->GetObservedTwoPorts();
+ if ( observedTwoports.size() > numberOfCellelements )
+ {
+ // Reorder the observed twoports so that all elements inside one cell end up in the same row in the output
+ // matrix. The vector is interpreted as a column-major matrix with the number of rows equal to the number of cells
+ std::vector< boost::shared_ptr< electrical::TwoPort< myMatrixType > > > twoportVector( observedTwoports.size(), nullptr );
+ size_t outputRows = numberOfCellelements;
+ size_t outputColumns = std::ceil( (double)observedTwoports.size() / outputRows );
+ // first column has all the cellements, so they can just be copied
+ for ( size_t i = 0; i < numberOfCellelements; ++i )
+ {
+ twoportVector[i] = observedTwoports[i];
+ }
+ for ( size_t i = numberOfCellelements; i < observedTwoports.size(); ++i )
+ {
+ size_t row = ( i - numberOfCellelements ) / ( outputColumns - 1 );
+ size_t column = ( i - numberOfCellelements ) % ( outputColumns - 1 ) + 1;
+ twoportVector[column * outputRows + row] = observedTwoports[i];
+ }
+ pointerStructure->mElectricalSimulation->mObserver =
+ CreateTwoPortObserver< std::vector< boost::shared_ptr< electrical::TwoPort< myUnit > > >, myUnit, false >(
+ &twoportVector, 0, voltageOutputVec, currentOutputVec, powerOutputVec, socOutputVec, socSurfaceOutputVec );
+ }
+ else
+ {
+ pointerStructure->mElectricalSimulation->mObserver =
+ CreateTwoPortObserver< std::vector< boost::shared_ptr< electrical::TwoPort< myUnit > > >, myUnit, false >(
+ &observedTwoports, 0, voltageOutputVec, currentOutputVec, powerOutputVec, socOutputVec, socSurfaceOutputVec );
+ }
}
void GetRealSizes_ThEl( const char *configStr, const size_t *pointerStructureAddress, size_t *stateSize,
diff --git a/src/cinterface/cinterface_ThEl_Aging.cpp b/src/cinterface/cinterface_ThEl_Aging.cpp
new file mode 100644
index 0000000000000000000000000000000000000000..021b4046e13c3ea44c1fcf431875a0265f1122cb
--- /dev/null
+++ b/src/cinterface/cinterface_ThEl_Aging.cpp
@@ -0,0 +1,192 @@
+#include "cinterface_ThEl_Aging.h"
+#include "cinterface_ThEl.h"
+#include "pointer_structure.h"
+
+#include "../aging/aging_simulation.h"
+#include "../aging/aging_twoport.h"
+#include "../factory/factorybuilder_for_aging.h"
+#include "../misc/matrixInclude.h"
+#include "../thermal/simulation_data_outline.h"
+#include "../xmlparser/tinyxml2/xmlparserimpl.h"
+
+#include <boost/scoped_ptr.hpp>
+
+#ifndef _SYMBOLIC_
+
+typedef myMatrixType myUnit;
+typedef double myScalar;
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+ void InitializeSystem_ThEl_Aging( const char *configStr, size_t *pointerStructureAddress, real_T *stateVector )
+ {
+ xmlparser::tinyxml2::XmlParserImpl parser;
+ parser.ReadFromMem( configStr );
+ boost::shared_ptr< xmlparser::XmlParameter > rootXmlNode = parser.GetRoot();
+
+
+ PointerStructure_ThEl_Aging *pointerStructure = new PointerStructure_ThEl_Aging;
+ *pointerStructureAddress = (size_t)pointerStructure;
+
+ factory::FactoryBuilderForAging< myUnit, myScalar > factoryBuilder;
+ pointerStructure->mElectricalSimulation.reset(
+ new simulation::ElectricalSimulation< myUnit, myScalar, false >( rootXmlNode, 0.0, 0.0, 0.0, nullptr, &factoryBuilder ) );
+
+ pointerStructure->mThermalSimulation.reset(
+ new simulation::ThermalSimulation< myUnit, myScalar, false >( rootXmlNode, 0.0, 0.0, 0.0, &pointerStructure->mThermalVisualizer,
+ &pointerStructure->mElectricalSimulation->mThermalStates, 0 ) );
+
+ pointerStructure->mAgingSimulation.reset(
+ new simulation::AgingSimulation< myUnit, myScalar, false >( rootXmlNode, pointerStructure->mElectricalSimulation,
+ pointerStructure->mThermalSimulation, {}, 0.0, &factoryBuilder ) );
+
+ if ( rootXmlNode->GetElementChild( "Options" )->HasElementDirectChild( "ThermalVisualizer" ) )
+ {
+ pointerStructure->mVisualizerCounter = 1;
+ boost::shared_ptr< xmlparser::XmlParameter > visualizerNode =
+ rootXmlNode->GetElementChild( "Options" )->GetElementChild( "ThermalVisualizer" );
+ pointerStructure->mVisualizerTimeDiffFrames =
+ visualizerNode->GetElementDoubleValue( "TimeBetweenFramesInSec" );
+ pointerStructure->mVisualizerMaxNumberOfFrames = visualizerNode->GetElementIntValue( "MaxNumberOfFrames" );
+ }
+ else
+ {
+ pointerStructure->mVisualizerCounter = 0;
+ pointerStructure->mVisualizerTimeDiffFrames = 0.0;
+ pointerStructure->mVisualizerMaxNumberOfFrames = 0;
+ }
+
+ if ( stateVector )
+ {
+ const size_t electricalElements = pointerStructure->mElectricalSimulation->mStateSystemGroup.mStateVector.rows() - 1;
+ misc::FastCopyMatrix( stateVector, pointerStructure->mElectricalSimulation->mStateSystemGroup.mStateVector,
+ electricalElements );
+ memcpy( &( stateVector[electricalElements] ), &( pointerStructure->mThermalSimulation->mTemperatures[0] ),
+ pointerStructure->mThermalSimulation->mTemperatures.size() * sizeof( myScalar ) );
+ }
+ }
+
+ void ResetSystem_ThEl_Aging( const char *configStr, size_t *pointerStructureAddress, real_T *stateVector,
+ real_T *voltageOutputVec, real_T *currentOutputVec, real_T *powerOutputVec,
+ real_T *socOutputVec, real_T *socSurfaceOutputVec )
+ {
+ DeleteSystem_ThEl( pointerStructureAddress );
+ InitializeSystem_ThEl_Aging( configStr, pointerStructureAddress, stateVector );
+ SetOutputVectors_ThEl( pointerStructureAddress, voltageOutputVec, currentOutputVec, powerOutputVec,
+ socOutputVec, socSurfaceOutputVec );
+ }
+
+ void SetOutputVectors_ThEl_Aging( const size_t *pointerStructureAddress, real_T *voltageOutputVec, real_T *currentOutputVec,
+ real_T *powerOutputVec, real_T *socOutputVec, real_T *socSurfaceOutputVec )
+ {
+ PointerStructure_ThEl_Aging *pointerStructure = (PointerStructure_ThEl_Aging *)*pointerStructureAddress;
+
+ std::vector< boost::shared_ptr< electrical::TwoPort< myUnit > > > outputTwoports;
+ const auto &agingTwoports = pointerStructure->mAgingSimulation->mAgingTwoPorts;
+ outputTwoports.reserve( agingTwoports.size() );
+ for ( const auto &twoport : agingTwoports )
+ {
+ outputTwoports.push_back( twoport->GetTwoPort() );
+ }
+
+ pointerStructure->mElectricalSimulation->mObserver =
+ CreateTwoPortObserver< std::vector< boost::shared_ptr< electrical::TwoPort< myUnit > > >, myUnit, false >(
+ &outputTwoports, 0, voltageOutputVec, currentOutputVec, powerOutputVec, socOutputVec, socSurfaceOutputVec );
+ }
+
+ void GetRealSizes_ThEl_Aging( const char *configStr, const size_t *pointerStructureAddress, size_t *stateSize,
+ size_t *numberOfCells, size_t *probeSize, size_t *agingTwoportSize )
+ {
+ xmlparser::tinyxml2::XmlParserImpl parser;
+ parser.ReadFromMem( configStr );
+ boost::shared_ptr< xmlparser::XmlParameter > rootXmlNode = parser.GetRoot();
+
+ size_t themalStateSize = 0, electricalStateSize = 0;
+
+ simulation::ThermalModelOutline< double >( rootXmlNode, numberOfCells, &themalStateSize, 0, probeSize );
+ if ( pointerStructureAddress )
+ {
+ PointerStructure_ThEl_Aging *pointerStructure = (PointerStructure_ThEl_Aging *)*pointerStructureAddress;
+ electricalStateSize = pointerStructure->mElectricalSimulation->mStateSystemGroup.GetStateCount();
+ *agingTwoportSize = pointerStructure->mAgingSimulation->mAgingTwoPorts.size();
+ }
+ else
+ {
+ PointerStructure_ThEl_Aging pointerStructure;
+ factory::FactoryBuilderForAging< myUnit, myScalar > factoryBuilder;
+ pointerStructure.mElectricalSimulation.reset(
+ new simulation::ElectricalSimulation< myUnit, myScalar, false >( rootXmlNode, 0.0, 0.0, 0.0, nullptr, &factoryBuilder ) );
+ pointerStructure.mAgingSimulation.reset(
+ new simulation::AgingSimulation< myUnit, myScalar, false >( rootXmlNode, pointerStructure.mElectricalSimulation,
+ nullptr, {}, 0, &factoryBuilder ) );
+ electricalStateSize = pointerStructure.mElectricalSimulation->mStateSystemGroup.GetStateCount();
+ *agingTwoportSize = pointerStructure.mAgingSimulation->mAgingTwoPorts.size();
+ }
+ if ( stateSize )
+ *stateSize = themalStateSize + electricalStateSize;
+ }
+
+ void SetAging_ThEl_Aging( const size_t *pointerStructureAddress, const real_T *capFactors, const real_T *resFactors,
+ const real_T *socOffsets, const real_T dt )
+ {
+ PointerStructure_ThEl_Aging *pointerStructure = (PointerStructure_ThEl_Aging *)*pointerStructureAddress;
+ for ( size_t i = 0; i < pointerStructure->mAgingSimulation->mAgingTwoPorts.size(); ++i )
+ {
+ double cap = capFactors[i];
+ double res = resFactors[i];
+ double offset = socOffsets[i];
+ // if the factors are zero, assume the inputs are unconnected
+ if ( cap == 0.0 )
+ cap = 1.0;
+ if ( res == 0.0 )
+ res = 1.0;
+ pointerStructure->mAgingSimulation->mAgingTwoPorts[i]->CollectData( dt );
+ pointerStructure->mAgingSimulation->mAgingTwoPorts[i]->SetAging( cap, res, offset, dt );
+ }
+ }
+
+ void OutputAgingData_ThEl_Aging( const size_t *pointerStructureAddress, real_T *capVector, real_T *ctpVector, real_T *socOffsetVector )
+ {
+ PointerStructure_ThEl_Aging *pointerStructure = (PointerStructure_ThEl_Aging *)*pointerStructureAddress;
+ const auto &agingPorts = pointerStructure->mAgingSimulation->mAgingTwoPorts;
+ for ( size_t i = 0; i < agingPorts.size(); ++i )
+ {
+ capVector[i] = agingPorts[i]->GetTwoPort()->GetTotalCapacity();
+ ctpVector[i] = agingPorts[i]->GetAgingState()->GetChargeThroughput();
+ socOffsetVector[i] = agingPorts[i]->GetAgingState()->GetSocOffset();
+ }
+ }
+
+ void TriggerObserverAndTemperatureOutput_ThEl_Aging( const size_t *pointerStructureAddress, double t,
+ real_T *temperatureOutputVector, real_T *thermalProbeOutputVector )
+ {
+ PointerStructure_ThEl_Aging *pointerStructure = (PointerStructure_ThEl_Aging *)*pointerStructureAddress;
+ pointerStructure->mElectricalSimulation->mObserver->operator()( t );
+
+ const auto &agingTwoports = pointerStructure->mAgingSimulation->mAgingTwoPorts;
+
+ if ( temperatureOutputVector )
+ for ( size_t i = 0; i < agingTwoports.size(); ++i )
+ temperatureOutputVector[i] =
+ static_cast< real_T >( agingTwoports[i]->GetTwoPort()->GetThermalState()->GetValue() );
+
+ if ( thermalProbeOutputVector )
+ {
+ size_t counter = 0;
+ for ( std::vector< ::probe::ThermalProbe >::const_iterator probe =
+ pointerStructure->mThermalSimulation->mThermalProbes->begin();
+ probe != pointerStructure->mThermalSimulation->mThermalProbes->end(); ++probe )
+ {
+ thermalProbeOutputVector[counter] = probe->GetTemperature();
+ ++counter;
+ }
+ }
+ }
+
+#ifdef __cplusplus
+}
+#endif
+#endif
diff --git a/src/cinterface/cinterface_ThEl_Aging.h b/src/cinterface/cinterface_ThEl_Aging.h
new file mode 100644
index 0000000000000000000000000000000000000000..30257a6b572f52b7d09a9f4cf4b7be9e8472ba68
--- /dev/null
+++ b/src/cinterface/cinterface_ThEl_Aging.h
@@ -0,0 +1,44 @@
+#ifndef _CINTERFACE_TH_EL_AGING_
+#define _CINTERFACE_TH_EL_AGING_
+
+#include "cinterface_common_functions.h"
+
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+ /// Initializes a system and returns the adress of the DAE system as a size_t
+ void InitializeSystem_ThEl_Aging( const char *configStr, size_t *pointerStructureAddress, real_T *stateVector = 0 );
+
+ /// Resets the system. Meaning the old system will be deleted and a new one initialized
+ void ResetSystem_ThEl_Aging( const char *configStr, size_t *pointerStructureAddress, real_T *stateVector = 0,
+ real_T *voltageOutputVec = 0, real_T *currentOutputVec = 0, real_T *powerOutputVec = 0,
+ real_T *socOutputVec = 0, real_T *socSurfaceOutputVec = 0 );
+
+ /// Late Binding for the output vectors addresses
+ void SetOutputVectors_ThEl_Aging( const size_t *pointerStructureAddress, real_T *voltageOutputVec, real_T *currentOutputVec,
+ real_T *powerOutputVec, real_T *socOutputVec, real_T *socSurfaceOutputVec );
+
+ void GetRealSizes_ThEl_Aging( const char *configStr, const size_t *pointerStructureAddress, size_t *stateSize,
+ size_t *numberOfCells, size_t *probeSize, size_t *agingTwoportSize );
+
+ /// Apply the aging input to the cells
+ void SetAging_ThEl_Aging( const size_t *pointerStructureAddress, const real_T *capFactors, const real_T *resFactors,
+ const real_T *socOffsets, const real_T dt );
+
+ /// Write aging data to the output vectors
+ void OutputAgingData_ThEl_Aging( const size_t *pointerStructureAddress, real_T *capVector, real_T *ctpVector,
+ real_T *socOffsetVector );
+
+ /// set output vectors for temperatures and thermal probes
+ void TriggerObserverAndTemperatureOutput_ThEl_Aging( const size_t *pointerStructureAddress, double t,
+ real_T *temperatureOutputVector, real_T *thermalProbeOutputVector );
+
+#ifdef __cplusplus
+}
+#endif
+
+/// DESCRIPTION
+#endif /* _CINTERFACE_TH_EL_ */
diff --git a/src/cinterface/pointer_structure.h b/src/cinterface/pointer_structure.h
index 20097de02585ca7d4e4eb2b290adb6c32559ca49..d8588ce3e017da3b074bf63096fc68ae583984a3 100644
--- a/src/cinterface/pointer_structure.h
+++ b/src/cinterface/pointer_structure.h
@@ -12,6 +12,9 @@ class ElectricalSimulation;
template < typename Matrix, typename Scalar, bool filterTypeChoice >
class ThermalSimulation;
+
+template < typename Matrix, typename Scalar, bool filterTypeChoice >
+class AgingSimulation;
} // namespace simulation
namespace observer
@@ -47,5 +50,18 @@ struct PointerStructure_ThEl
size_t mVisualizerMaxNumberOfFrames;
};
+#ifdef BUILD_AGING_SIMULATION
+
+struct PointerStructure_ThEl_Aging : PointerStructure_ThEl
+{
+ boost::scoped_ptr< simulation::AgingSimulation< myMatrixType, double, false > > mAgingSimulation;
+};
+
+struct PointerStructure_Aging
+{
+ boost::scoped_ptr< simulation::AgingSimulation< myMatrixType, double, false > > mAgingSimulation;
+};
+
+#endif
#endif
#endif
diff --git a/src/cinterface/simulink_common.h b/src/cinterface/simulink_common.h
index 5112e406a44da133268506656dcfa9cc4dee91c8..67036757c51fc824cdc6a78f72bbe74223cce973 100644
--- a/src/cinterface/simulink_common.h
+++ b/src/cinterface/simulink_common.h
@@ -30,8 +30,10 @@ enum FcnParameters
};
#include "cinterface.h"
+#include "cinterface_Aging.h"
#include "cinterface_Th.h"
#include "cinterface_ThEl.h"
+#include "cinterface_ThEl_Aging.h"
#include "cinterface_common_functions.h"
#ifdef _MOCK_ // This has to be included out of the __cplusplus scope
diff --git a/src/electrical/electrical_simulation.h b/src/electrical/electrical_simulation.h
index d8ef88ef6c2d1a8bfb8a11c1d3b512f241377789..295d8244dad23158af984cf88e6fbe72b351cfec 100644
--- a/src/electrical/electrical_simulation.h
+++ b/src/electrical/electrical_simulation.h
@@ -1,479 +1,479 @@
-#ifndef _ELECTRICAL_SIMULATION_
-#define _ELECTRICAL_SIMULATION_
-
-#include <boost/scoped_ptr.hpp>
-#include <boost/shared_ptr.hpp>
-
-#include "../factory/electricalEquationSystem/chooseElectricSystemType.h"
-#include "../factory/factorybuilder.h"
-
-#include "../system/dae_sys.h"
-
-#include "../exceptions/error_proto.h"
-#include "../factory/observer/createObserver.h"
-#include "../observer/filter/csvfilter.h"
-#include "../observer/filter/filter.h"
-#include "../observer/observer.h"
-#include "../observer/observerException.h"
-
-namespace thermal
-{
-extern const double globalMaxValue;
-}
-
-class TestSimulation;
-
-namespace simulation
-{
-
-template < typename Matrix, typename T, bool filterTypeChoice >
-class ElectricalSimulation
-{
- friend class ::TestSimulation;
-
- public:
- /**
- * @param[in] rootXmlNode Root node of xml-file to parse
- * @param[in] maxSimulationStepDuration Recalculation of equation system is triggered if maxSimulationStepDuration
- * seconds have been passed since last calculation, forcing a new simulation step
- * @param[in] simulationDuration Duration of the whole simulation in sec
- * @param[in] socStopCriterion Recalculation of equation system is triggered if the SoC of any cell element has
- * changed by socStopCriterion percent
- * @param[out] cells Returns all created cells if it is not null
- */
- ElectricalSimulation( const boost::shared_ptr< xmlparser::XmlParameter > &rootXmlNode, T maxSimulationStepDuration,
- T simulationDuration, double socStopCriterion,
- std::vector< boost::shared_ptr< ::electrical::TwoPort< Matrix > > > *cells,
- factory::FactoryBuilder< Matrix, T > *factoryBuilder = nullptr );
- /// Updates electrical equation system
- void UpdateSystem();
- /// Updates physical quantities in electrical two ports
- void UpdateSystemValues();
- /// Returns true if current simulation step needs to end, if so it resets mDeltaTime for the next simulation step
- bool CheckLoopConditionAndSetDeltaTime( T currentChangeTime );
- /// Returns true if mTime has exceeded mSimulationDuration
- bool CheckIfSimulationTimeHasEnded();
- /// Gets the time passed since mLoopStartTime (mLoopStartTime is the start time of this simulation step)
- T GetCurrentSimulationStepTime() const;
- /// Executes actions needed at the end of a simulation step
- void FinshStep();
- /// Saves power and time of all cell elements into their thermal states
- void UpdateAllThermalStatesPowerDissipation();
- /// Saves power of all cell elements into their thermal states
- void UpdateAllThermalStatesPowerDissipationWithoutTime();
- /// Clears power dissipation of all thermal states
- void ResetAllThermalStatesPowerDissipation();
- /// Initializes stop criterions and sets the step start time
- void StartNewTimeStep();
- /// Returns true if SoC or power stop criterion is met
- bool IsStopCriterionFulfilled() const;
- /// Saves states if stop criterion of thermal simulation is triggered
- void SaveStatesForLaterReset();
- /// Resets states and SoCs to states saved at a certain point of time
- void ResetStatesToPointOfTime( T time );
- /// Resets all SoC states to their initial value
- void ResetSocStates();
- /// Resets all system states to zero
- void ResetSystemStates();
- /// Sets a maximul deviation in total power generation in percent. 0 means no stop criterion.
- void SetPowerStopCriterion( T maximumDeviation );
-
- void UpdateSimulationDuration( const T &simulationDuration ) { mSimulationDuration = simulationDuration; }
-
- void LoadCapacityForLaterReset();
- void SaveCapacityForLaterReset();
- std::vector< T > mCapcityValues;
-
- // Internal data
- boost::shared_ptr< electrical::TwoPort< Matrix > > mRootTwoPort;
- std::vector< boost::shared_ptr< ::electrical::Cellelement< Matrix > > > mCellElements;
- std::vector< boost::shared_ptr< state::Soc > > mSocStates;
- std::vector< boost::shared_ptr< state::ThermalState< double > > > mThermalStates;
- // Electrical system with states
- boost::shared_ptr< systm::GeneralizedSystem< Matrix > > mEqSystem;
- boost::shared_ptr< observer::TwoPortObserver< Matrix > > mObserver;
- // boost::scoped_ptr<systm::DifferentialAlgebraicSystem< Matrix > > mEqSystem;
- systm::StateSystemGroup< myMatrixType > mStateSystemGroup;
- // Simulation times
- T mTime;
- T mDeltaTime;
- T mSimulationDuration;
- size_t mNumberOfObjects; // number of instances the object factory has created
-
- private:
- T mLastUnconstrainedDeltaTime;
- T mMaxSimulationStepDuration;
- T mStepStartTime;
- // Soc stop criterion
- double mSocStopCriterion;
- // Stop criterion if following a power profile
- double mPowerStopCriterion;
- std::vector< std::vector< T > > mSocValuesSteps;
- // If electrical is supposed to be resettable
- std::vector< Matrix > mStatesSteps;
- std::vector< T > mTimeSteps;
- size_t mNumberOfSteps;
- // Power value of the root port at the beginning of the time step
- T mInitialPowerValue;
-};
-
-template < typename Matrix, typename T, bool filterTypeChoice >
-ElectricalSimulation< Matrix, T, filterTypeChoice >::ElectricalSimulation(
- const boost::shared_ptr< xmlparser::XmlParameter > &rootXmlNode, T maxSimulationStepDuration, T simulationDuration,
- double socStopCriterion, std::vector< boost::shared_ptr< ::electrical::TwoPort< Matrix > > > *cells,
- factory::FactoryBuilder< Matrix, T > *factoryBuilder )
- : mTime( 0.0 )
- , mDeltaTime( maxSimulationStepDuration )
- , mSimulationDuration( simulationDuration )
- , mLastUnconstrainedDeltaTime( maxSimulationStepDuration )
- , mMaxSimulationStepDuration( maxSimulationStepDuration )
- , mStepStartTime( 0.0 )
- , mSocStopCriterion( socStopCriterion )
- , mPowerStopCriterion( 0.0 )
- , mNumberOfSteps( 0 )
-{
- // if no FactoryBuilder is passed, create a local one in this scope
- boost::scoped_ptr< factory::FactoryBuilder< Matrix, T > > scopedFactoryBuilder;
- if ( !factoryBuilder )
- {
- scopedFactoryBuilder.reset( new factory::FactoryBuilder< Matrix, T >() );
- factoryBuilder = scopedFactoryBuilder.get();
- }
-
- factory::Factory< state::State, factory::ArgumentTypeState > *stateFactory = factoryBuilder->BuildStateFactory();
- factory::Factory< object::Object< double >, factory::ArgumentTypeObject< double > > *objectFactory =
- factoryBuilder->BuildObjectFactory();
- factory::Factory< electrical::TwoPort< Matrix >, factory::ArgumentTypeElectrical > *electricalFactory =
- factoryBuilder->BuildElectricalFactory();
-
- // Evaluate Options node
- boost::shared_ptr< xmlparser::XmlParameter > optionsNode = rootXmlNode->GetElementChild( "Options" );
- bool observeAllElectricalElements = false;
- if ( optionsNode->HasElementDirectChild( "ObserveAllElectricalElements" ) )
- observeAllElectricalElements = optionsNode->GetElementBoolValue( "ObserveAllElectricalElements" );
-
- // Create electrical system
- factory::ArgumentTypeElectrical factoryArg;
- factoryArg.mMakeAllECMElementsObservable = observeAllElectricalElements;
- mRootTwoPort = electricalFactory->CreateInstance( rootXmlNode->GetElementChild( "RootElement" ), &factoryArg );
-
- std::vector< boost::shared_ptr< electrical::TwoPort< Matrix > > > electricalElements;
- electricalFactory->GetObjects( electricalElements );
-
- // create observer and give out cells if wanted
- if ( cells )
- {
- *cells = electricalFactory->GetObjectsOfClass( "Cellelement" );
- std::vector< boost::shared_ptr< electrical::TwoPort< Matrix > > > observableTwoports = *cells;
- FindObservableTwoports( observableTwoports, mRootTwoPort );
-
- mObserver = CreateTwoPortObserver< std::vector< boost::shared_ptr< ::electrical::TwoPort< Matrix > > >, Matrix, filterTypeChoice >(
- &observableTwoports, rootXmlNode.get(), 0, 0, 0, 0, 0, mRootTwoPort );
- }
- else
- {
- mObserver = CreateTwoPortObserver< std::vector< boost::shared_ptr< electrical::TwoPort< Matrix > > >, Matrix, filterTypeChoice >(
- 0, rootXmlNode.get(), 0, 0, 0, 0, 0, mRootTwoPort );
- }
-
-#ifdef _SYMBOLIC_
- mRootTwoPort->SetID( 0 );
- size_t iDCounter = 1;
-
- for ( size_t i = 0; i < electricalElements.size(); ++i )
- if ( electricalElements.at( i ).get() != mRootTwoPort.get() )
- electricalElements.at( i )->SetID( iDCounter++ );
-
- try
- {
- BOOST_FOREACH ( boost::shared_ptr< electrical::TwoPort< Matrix > > &elem, electricalFactory->GetObjectsOfClass( "WarburgCotanh" ) )
- {
- SerialTwoPort< Matrix > *serialTwoPort = dynamic_cast< SerialTwoPort< Matrix > * >( elem.get() );
- for ( size_t i = 0; i < serialTwoPort->size(); ++i )
- serialTwoPort->at( i )->SetID( iDCounter++ );
- }
- }
- catch ( ... )
- {
- }
- try
- {
- BOOST_FOREACH ( boost::shared_ptr< electrical::TwoPort< Matrix > > &elem, electricalFactory->GetObjectsOfClass( "WarburgTanh" ) )
- {
- SerialTwoPort< Matrix > *serialTwoPort = dynamic_cast< SerialTwoPort< Matrix > * >( elem.get() );
- for ( size_t i = 0; i < serialTwoPort->size(); ++i )
- serialTwoPort->at( i )->SetID( iDCounter++ );
- }
- }
- catch ( ... )
- {
- }
- try
- {
- BOOST_FOREACH ( boost::shared_ptr< electrical::TwoPort< Matrix > > &elem, electricalFactory->GetObjectsOfClass( "Rmphn" ) )
- {
- SerialTwoPort< Matrix > *serialTwoPort = dynamic_cast< SerialTwoPort< Matrix > * >( elem.get() );
- for ( size_t i = 0; i < serialTwoPort->size(); ++i )
- serialTwoPort->at( i )->SetID( iDCounter++ );
- }
- }
- catch ( ... )
- {
- }
- for ( size_t i = 0; i < this->mStateSystemGroup.GetStateCount(); ++i )
- this->mStateSystemGroup.mStateVector.coeffRef( i, 0 ) = ScalarUnit( misc::StrCont( "State" ) + misc::StrCont( i + 1 ) );
-
-#endif
- mNumberOfObjects = objectFactory->GetNumberOfObjects();
- mRootTwoPort->SetSystem( &mStateSystemGroup );
- mStateSystemGroup.Initialize();
-#ifndef _SYMBOLIC_
- mRootTwoPort->SetInitialCurrent( 0.0 );
-#else
- mRootTwoPort->SetInitialCurrent( ScalarUnit( "InputCurrent" ) );
-#endif
- mRootTwoPort->UpdateStateSystemGroup();
- mEqSystem = factory::ChooseElectricEquationSystemType( &mStateSystemGroup );
-
- // Store thermal states, SoC states and cell elements from electrical state factory
- mThermalStates.reserve( stateFactory->GetObjectsOfClass( "ThermalState" ).size() );
- BOOST_FOREACH ( const boost::shared_ptr< state::State > &thermalStateFromFactory, stateFactory->GetObjectsOfClass( "ThermalState" ) )
- mThermalStates.push_back( boost::static_pointer_cast< state::ThermalState< double >, state::State >( thermalStateFromFactory ) );
-
- const size_t numberOfSocObject = stateFactory->GetObjectsOfClass( "Soc" ).size();
- mSocStates.reserve( numberOfSocObject );
- mCapcityValues.resize( numberOfSocObject );
-
- BOOST_FOREACH ( const boost::shared_ptr< state::State > &socStateFromFactory,
- stateFactory->GetObjectsOfClass( "Soc" ) )
- mSocStates.push_back( boost::static_pointer_cast< state::Soc, state::State >( socStateFromFactory ) );
-
- mCellElements.reserve( electricalFactory->GetObjectsOfClass( "CellElement" ).size() );
- BOOST_FOREACH ( const boost::shared_ptr< ::electrical::TwoPort< Matrix > > &twoPortFromFactory,
- electricalFactory->GetObjectsOfClass( "CellElement" ) )
- {
- if ( twoPortFromFactory->IsCellelement() )
- mCellElements.push_back(
- boost::static_pointer_cast< ::electrical::Cellelement< Matrix >, ::electrical::TwoPort< Matrix > >( twoPortFromFactory ) );
- else
- {
- ::electrical::ParallelTwoPort< Matrix > *cellFromFactory =
- static_cast< ::electrical::ParallelTwoPort< Matrix > * >( twoPortFromFactory.get() );
- for ( size_t i = 0; i < cellFromFactory->GetParallelChildren(); ++i )
- mCellElements.push_back(
- boost::static_pointer_cast< ::electrical::Cellelement< Matrix > >( cellFromFactory->shared_at( i ) ) );
- }
- }
-
- // SocStopCriterion
- if ( optionsNode->HasElementDirectChild( "SocStopCriterionInPercent" ) )
- {
- mSocStopCriterion = optionsNode->GetElementDoubleValue( "SocStopCriterionInPercent" );
- if ( mSocStopCriterion <= 0.0 )
- ErrorFunction< std::runtime_error >( __FUNCTION__, __LINE__, __FILE__, "SocStopCriterionInPercentNegative" );
- }
-}
-
-template < typename Matrix, typename T, bool filterTypeChoice >
-void ElectricalSimulation< Matrix, T, filterTypeChoice >::UpdateSystem()
-{
- // Current must be set before this function
- mRootTwoPort->UpdateStateSystemGroup();
- mEqSystem->PrepareEquationSystem();
-}
-
-template < typename Matrix, typename T, bool filterTypeChoice >
-void ElectricalSimulation< Matrix, T, filterTypeChoice >::UpdateSystemValues()
-{
- mRootTwoPort->CalculateStateDependentValues();
-#if defined( _ARMADILLO_ ) && defined( SPARSE_MATRIX_FORMAT )
- mStateSystemGroup.ResetSystem();
-#endif
-}
-
-template < typename Matrix, typename T, bool filterTypeChoice >
-bool ElectricalSimulation< Matrix, T, filterTypeChoice >::CheckLoopConditionAndSetDeltaTime( T currentChangeTime )
-{
- if ( mTime < mStepStartTime + mMaxSimulationStepDuration && mTime < currentChangeTime )
- {
- mLastUnconstrainedDeltaTime = mDeltaTime;
- mDeltaTime = std::min( currentChangeTime - mTime, mLastUnconstrainedDeltaTime );
- mDeltaTime = std::min( mStepStartTime + mMaxSimulationStepDuration - mTime, mDeltaTime );
- return true;
- }
-
- return false;
-}
-
-template < typename Matrix, typename T, bool filterTypeChoice >
-bool ElectricalSimulation< Matrix, T, filterTypeChoice >::CheckIfSimulationTimeHasEnded()
-{
- return mTime >= mSimulationDuration;
-}
-
-template < typename Matrix, typename T, bool filterTypeChoice >
-T ElectricalSimulation< Matrix, T, filterTypeChoice >::GetCurrentSimulationStepTime() const
-{
- return mTime - mStepStartTime;
-}
-
-template < typename Matrix, typename T, bool filterTypeChoice >
-void ElectricalSimulation< Matrix, T, filterTypeChoice >::FinshStep()
-{
-}
-
-template < typename Matrix, typename T, bool filterTypeChoice >
-void ElectricalSimulation< Matrix, T, filterTypeChoice >::UpdateAllThermalStatesPowerDissipation()
-{
- BOOST_FOREACH ( boost::shared_ptr< electrical::Cellelement< Matrix > > &elem, mCellElements )
- elem->UpdateThermalStatePowerDissipation( mTime );
-}
-
-template < typename Matrix, typename T, bool filterTypeChoice >
-void ElectricalSimulation< Matrix, T, filterTypeChoice >::UpdateAllThermalStatesPowerDissipationWithoutTime()
-{
- BOOST_FOREACH ( boost::shared_ptr< electrical::Cellelement< Matrix > > &elem, mCellElements )
- elem->UpdateThermalStatePowerDissipation();
-}
-
-template < typename Matrix, typename T, bool filterTypeChoice >
-void ElectricalSimulation< Matrix, T, filterTypeChoice >::ResetAllThermalStatesPowerDissipation()
-{
- BOOST_FOREACH ( boost::shared_ptr< electrical::Cellelement< Matrix > > &elem, mCellElements )
- elem->ResetThermalStatePowerDissipation();
-}
-
-template < typename Matrix, typename T, bool filterTypeChoice >
-void ElectricalSimulation< Matrix, T, filterTypeChoice >::StartNewTimeStep()
-{
- ResetAllThermalStatesPowerDissipation();
- mStepStartTime = mTime;
- mNumberOfSteps = 0;
- SaveStatesForLaterReset();
-#ifndef _SYMBOLIC_
- mInitialPowerValue = mRootTwoPort->GetCurrentValue() * mRootTwoPort->GetVoltageValue();
-#endif
-}
-
-template < typename Matrix, typename T, bool filterTypeChoice >
-bool ElectricalSimulation< Matrix, T, filterTypeChoice >::IsStopCriterionFulfilled() const
-{
- bool isStop = false;
- for ( size_t i = 0; i < mSocStates.size(); ++i )
- {
- if ( fabs( mSocValuesSteps[0][i] - mSocStates[i]->GetValue() ) > mSocStopCriterion )
- {
- isStop = true;
- break;
- }
- }
-
-#ifndef _SYMBOLIC_
- if ( mPowerStopCriterion > 0.0 )
- {
- double power = mRootTwoPort->GetCurrentValue() * mRootTwoPort->GetVoltageValue();
- double powerDeviation = ( std::abs( mInitialPowerValue - power ) / mInitialPowerValue ) - 1;
- if ( powerDeviation > mPowerStopCriterion )
- isStop = true;
- }
-#endif
-
- return isStop;
-}
-
-template < typename Matrix, typename T, bool filterTypeChoice >
-void ElectricalSimulation< Matrix, T, filterTypeChoice >::SaveStatesForLaterReset()
-{
- if ( mTimeSteps.size() == mNumberOfSteps )
- mTimeSteps.resize( mNumberOfSteps + 1 );
- if ( mStatesSteps.size() == mNumberOfSteps )
- mStatesSteps.resize( mNumberOfSteps + 1 );
- if ( mSocValuesSteps.size() == mNumberOfSteps )
- {
- mSocValuesSteps.resize( mNumberOfSteps + 1 );
- mSocValuesSteps[mNumberOfSteps].resize( mSocStates.size() );
- }
-
- mTimeSteps[mNumberOfSteps] = mTime;
- mStatesSteps[mNumberOfSteps] = mStateSystemGroup.mStateVector;
- for ( size_t i = 0; i < mSocStates.size(); ++i )
- mSocValuesSteps[mNumberOfSteps][i] = mSocStates[i]->GetValue();
-
- mNumberOfSteps++;
-}
-
-template < typename Matrix, typename T, bool filterTypeChoice >
-void ElectricalSimulation< Matrix, T, filterTypeChoice >::ResetStatesToPointOfTime( T time )
-{
- if ( time <= mTimeSteps[0] || time > mTimeSteps[mNumberOfSteps - 1] || mNumberOfSteps < 2 )
- ErrorFunction< std::runtime_error >( __FUNCTION__, __LINE__, __FILE__,
- "errorResetStatesToPointOfTimeExecution" );
- if ( time == mTimeSteps[mNumberOfSteps - 1] ) // No need to reset if thermal stop criterion is triggered after
- // full step time time has been simulated
- return;
-
- // Get index, which is the index for the vectors mStateSystemGroup and mSocValuesSteps before time
- size_t index = 0;
- for ( size_t i = 1; i < mNumberOfSteps; ++i )
- if ( mTimeSteps[i] > time )
- {
- index = i - 1;
- break;
- }
-
- // Calculate factor1 and factor2, which are used to scale linearly between the point of time for index and (index+1)
- const T deltaTime = mTimeSteps[index + 1] - mTimeSteps[index];
- const T factor1 = ( mTimeSteps[index + 1] - time ) / deltaTime;
- const T factor2 = ( time - mTimeSteps[index] ) / deltaTime;
-
- // Reset time, states and SoCs
- mTime = time;
- mStateSystemGroup.mStateVector = mStatesSteps[index] * factor1 + mStatesSteps[index] * factor2;
- for ( size_t i = 0; i < mSocStates.size(); ++i )
- {
- const T newSocValue = mSocValuesSteps[index][i] * factor1 + mSocValuesSteps[index + 1][i] * factor2;
- const T deltaCapacityASec =
- ( newSocValue - mSocValuesSteps[mNumberOfSteps - 1][i] ) / 100.0 * mSocStates[i]->GetActualCapacity();
- mSocStates[i]->SetStoredEnergy< state::SocSetFormat::DELTA >( deltaCapacityASec );
- }
- UpdateSystemValues();
- UpdateSystem();
-
- BOOST_FOREACH ( boost::shared_ptr< state::ThermalState< double > > &thermalState, mThermalStates )
- thermalState->ResetPowerDissipationToTime( time );
-}
-
-template < typename Matrix, typename T, bool filterTypeChoice >
-void ElectricalSimulation< Matrix, T, filterTypeChoice >::SaveCapacityForLaterReset()
-{
- for ( size_t i = 0; i < mSocStates.size(); ++i )
- mCapcityValues[i] = mSocStates[i]->template GetValue< state::SocGetFormat::AS >();
-}
-
-template < typename Matrix, typename T, bool filterTypeChoice >
-void ElectricalSimulation< Matrix, T, filterTypeChoice >::LoadCapacityForLaterReset()
-{
- for ( size_t i = 0; i < mSocStates.size(); ++i )
- mSocStates[i]->template SetStoredEnergy< state::SocSetFormat::ABSOLUT >( mCapcityValues[i] );
-}
-
-template < typename Matrix, typename T, bool filterTypeChoice >
-void ElectricalSimulation< Matrix, T, filterTypeChoice >::ResetSocStates()
-{
- for ( size_t i = 0; i < mCellElements.size(); ++i )
- mCellElements[i]->ResetSocValue();
-}
-
-template < typename Matrix, typename T, bool filterTypeChoice >
-void ElectricalSimulation< Matrix, T, filterTypeChoice >::ResetSystemStates()
-{
- mStateSystemGroup.ResetStates();
-}
-
-template < typename Matrix, typename T, bool filterTypeChoice >
-void ElectricalSimulation< Matrix, T, filterTypeChoice >::SetPowerStopCriterion( T maximumDeviation )
-{
- mPowerStopCriterion = maximumDeviation / 100;
-}
-} // namespace simulation
-#endif
+#ifndef _ELECTRICAL_SIMULATION_
+#define _ELECTRICAL_SIMULATION_
+
+#include <boost/scoped_ptr.hpp>
+#include <boost/shared_ptr.hpp>
+
+#include "../factory/electricalEquationSystem/chooseElectricSystemType.h"
+#include "../factory/factorybuilder.h"
+
+#include "../system/dae_sys.h"
+
+#include "../exceptions/error_proto.h"
+#include "../factory/observer/createObserver.h"
+#include "../observer/filter/csvfilter.h"
+#include "../observer/filter/filter.h"
+#include "../observer/observer.h"
+#include "../observer/observerException.h"
+
+namespace thermal
+{
+extern const double globalMaxValue;
+}
+
+class TestSimulation;
+
+namespace simulation
+{
+
+template < typename Matrix, typename T, bool filterTypeChoice >
+class ElectricalSimulation
+{
+ friend class ::TestSimulation;
+
+ public:
+ /**
+ * @param[in] rootXmlNode Root node of xml-file to parse
+ * @param[in] maxSimulationStepDuration Recalculation of equation system is triggered if maxSimulationStepDuration
+ * seconds have been passed since last calculation, forcing a new simulation step
+ * @param[in] simulationDuration Duration of the whole simulation in sec
+ * @param[in] socStopCriterion Recalculation of equation system is triggered if the SoC of any cell element has
+ * changed by socStopCriterion percent
+ * @param[out] cells Returns all created cells if it is not null
+ */
+ ElectricalSimulation( const boost::shared_ptr< xmlparser::XmlParameter > &rootXmlNode, T maxSimulationStepDuration,
+ T simulationDuration, double socStopCriterion,
+ std::vector< boost::shared_ptr< ::electrical::TwoPort< Matrix > > > *cells,
+ factory::FactoryBuilder< Matrix, T > *factoryBuilder = nullptr );
+ /// Updates electrical equation system
+ void UpdateSystem();
+ /// Updates physical quantities in electrical two ports
+ void UpdateSystemValues();
+ /// Returns true if current simulation step needs to end, if so it resets mDeltaTime for the next simulation step
+ bool CheckLoopConditionAndSetDeltaTime( T currentChangeTime );
+ /// Returns true if mTime has exceeded mSimulationDuration
+ bool CheckIfSimulationTimeHasEnded();
+ /// Gets the time passed since mLoopStartTime (mLoopStartTime is the start time of this simulation step)
+ T GetCurrentSimulationStepTime() const;
+ /// Executes actions needed at the end of a simulation step
+ void FinshStep();
+ /// Saves power and time of all cell elements into their thermal states
+ void UpdateAllThermalStatesPowerDissipation();
+ /// Saves power of all cell elements into their thermal states
+ void UpdateAllThermalStatesPowerDissipationWithoutTime();
+ /// Clears power dissipation of all thermal states
+ void ResetAllThermalStatesPowerDissipation();
+ /// Initializes stop criterions and sets the step start time
+ void StartNewTimeStep();
+ /// Returns true if SoC or power stop criterion is met
+ bool IsStopCriterionFulfilled() const;
+ /// Saves states if stop criterion of thermal simulation is triggered
+ void SaveStatesForLaterReset();
+ /// Resets states and SoCs to states saved at a certain point of time
+ void ResetStatesToPointOfTime( T time );
+ /// Resets all SoC states to their initial value
+ void ResetSocStates();
+ /// Resets all system states to zero
+ void ResetSystemStates();
+ /// Sets a maximul deviation in total power generation in percent. 0 means no stop criterion.
+ void SetPowerStopCriterion( T maximumDeviation );
+
+ void UpdateSimulationDuration( const T &simulationDuration ) { mSimulationDuration = simulationDuration; }
+
+ void LoadCapacityForLaterReset();
+ void SaveCapacityForLaterReset();
+ std::vector< T > mSavedSocValues;
+ std::vector< T > mSavedSocOffsets;
+
+ // Internal data
+ boost::shared_ptr< electrical::TwoPort< Matrix > > mRootTwoPort;
+ std::vector< boost::shared_ptr< ::electrical::Cellelement< Matrix > > > mCellElements;
+ std::vector< boost::shared_ptr< state::Soc > > mSocStates;
+ std::vector< boost::shared_ptr< state::ThermalState< double > > > mThermalStates;
+ // Electrical system with states
+ boost::shared_ptr< systm::GeneralizedSystem< Matrix > > mEqSystem;
+ boost::shared_ptr< observer::TwoPortObserver< Matrix > > mObserver;
+ // boost::scoped_ptr<systm::DifferentialAlgebraicSystem< Matrix > > mEqSystem;
+ systm::StateSystemGroup< myMatrixType > mStateSystemGroup;
+ // Simulation times
+ T mTime;
+ T mDeltaTime;
+ T mSimulationDuration;
+ size_t mNumberOfObjects; // number of instances the object factory has created
+
+ private:
+ T mLastUnconstrainedDeltaTime;
+ T mMaxSimulationStepDuration;
+ T mStepStartTime;
+ // Soc stop criterion
+ double mSocStopCriterion;
+ // Stop criterion if following a power profile
+ double mPowerStopCriterion;
+ std::vector< std::vector< T > > mSocValuesSteps;
+ // If electrical is supposed to be resettable
+ std::vector< Matrix > mStatesSteps;
+ std::vector< T > mTimeSteps;
+ size_t mNumberOfSteps;
+ // Power value of the root port at the beginning of the time step
+ T mInitialPowerValue;
+};
+
+template < typename Matrix, typename T, bool filterTypeChoice >
+ElectricalSimulation< Matrix, T, filterTypeChoice >::ElectricalSimulation(
+ const boost::shared_ptr< xmlparser::XmlParameter > &rootXmlNode, T maxSimulationStepDuration, T simulationDuration,
+ double socStopCriterion, std::vector< boost::shared_ptr< ::electrical::TwoPort< Matrix > > > *cells,
+ factory::FactoryBuilder< Matrix, T > *factoryBuilder )
+ : mTime( 0.0 )
+ , mDeltaTime( maxSimulationStepDuration )
+ , mSimulationDuration( simulationDuration )
+ , mLastUnconstrainedDeltaTime( maxSimulationStepDuration )
+ , mMaxSimulationStepDuration( maxSimulationStepDuration )
+ , mStepStartTime( 0.0 )
+ , mSocStopCriterion( socStopCriterion )
+ , mPowerStopCriterion( 0.0 )
+ , mNumberOfSteps( 0 )
+{
+ // if no FactoryBuilder is passed, create a local one in this scope
+ boost::scoped_ptr< factory::FactoryBuilder< Matrix, T > > scopedFactoryBuilder;
+ if ( !factoryBuilder )
+ {
+ scopedFactoryBuilder.reset( new factory::FactoryBuilder< Matrix, T >() );
+ factoryBuilder = scopedFactoryBuilder.get();
+ }
+
+ factory::Factory< state::State, factory::ArgumentTypeState > *stateFactory = factoryBuilder->BuildStateFactory();
+ factory::Factory< object::Object< double >, factory::ArgumentTypeObject< double > > *objectFactory =
+ factoryBuilder->BuildObjectFactory();
+ factory::Factory< electrical::TwoPort< Matrix >, factory::ArgumentTypeElectrical > *electricalFactory =
+ factoryBuilder->BuildElectricalFactory();
+
+ // Create electrical system
+ mRootTwoPort = electricalFactory->CreateInstance( rootXmlNode->GetElementChild( "RootElement" ) );
+#ifdef _SYMBOLIC_
+ mRootTwoPort->SetID( 0 );
+ size_t iDCounter = 1;
+
+ std::vector< boost::shared_ptr< electrical::TwoPort< Matrix > > > electricalElements;
+ electricalFactory->GetObjects( electricalElements );
+ for ( size_t i = 0; i < electricalElements.size(); ++i )
+ if ( electricalElements.at( i ).get() != mRootTwoPort.get() )
+ electricalElements.at( i )->SetID( iDCounter++ );
+
+ try
+ {
+ BOOST_FOREACH ( boost::shared_ptr< electrical::TwoPort< Matrix > > &elem, electricalFactory->GetObjectsOfClass( "WarburgCotanh" ) )
+ {
+ SerialTwoPort< Matrix > *serialTwoPort = dynamic_cast< SerialTwoPort< Matrix > * >( elem.get() );
+ for ( size_t i = 0; i < serialTwoPort->size(); ++i )
+ serialTwoPort->at( i )->SetID( iDCounter++ );
+ }
+ }
+ catch ( ... )
+ {
+ }
+ try
+ {
+ BOOST_FOREACH ( boost::shared_ptr< electrical::TwoPort< Matrix > > &elem, electricalFactory->GetObjectsOfClass( "WarburgTanh" ) )
+ {
+ SerialTwoPort< Matrix > *serialTwoPort = dynamic_cast< SerialTwoPort< Matrix > * >( elem.get() );
+ for ( size_t i = 0; i < serialTwoPort->size(); ++i )
+ serialTwoPort->at( i )->SetID( iDCounter++ );
+ }
+ }
+ catch ( ... )
+ {
+ }
+ try
+ {
+ BOOST_FOREACH ( boost::shared_ptr< electrical::TwoPort< Matrix > > &elem, electricalFactory->GetObjectsOfClass( "Rmphn" ) )
+ {
+ SerialTwoPort< Matrix > *serialTwoPort = dynamic_cast< SerialTwoPort< Matrix > * >( elem.get() );
+ for ( size_t i = 0; i < serialTwoPort->size(); ++i )
+ serialTwoPort->at( i )->SetID( iDCounter++ );
+ }
+ }
+ catch ( ... )
+ {
+ }
+ for ( size_t i = 0; i < this->mStateSystemGroup.GetStateCount(); ++i )
+ this->mStateSystemGroup.mStateVector.coeffRef( i, 0 ) = ScalarUnit( misc::StrCont( "State" ) + misc::StrCont( i + 1 ) );
+
+#endif
+ mNumberOfObjects = objectFactory->GetNumberOfObjects();
+ mRootTwoPort->SetSystem( &mStateSystemGroup );
+ mStateSystemGroup.Initialize();
+#ifndef _SYMBOLIC_
+ mRootTwoPort->SetInitialCurrent( 0.0 );
+#else
+ mRootTwoPort->SetInitialCurrent( ScalarUnit( "InputCurrent" ) );
+#endif
+ mRootTwoPort->UpdateStateSystemGroup();
+ mEqSystem = factory::ChooseElectricEquationSystemType( &mStateSystemGroup );
+
+ // Store thermal states, SoC states and cell elements from electrical state factory
+ mThermalStates.reserve( stateFactory->GetObjectsOfClass( "ThermalState" ).size() );
+ BOOST_FOREACH ( const boost::shared_ptr< state::State > &thermalStateFromFactory, stateFactory->GetObjectsOfClass( "ThermalState" ) )
+ mThermalStates.push_back( boost::static_pointer_cast< state::ThermalState< double >, state::State >( thermalStateFromFactory ) );
+
+ const size_t numberOfSocObject = stateFactory->GetObjectsOfClass( "Soc" ).size();
+ mSocStates.reserve( numberOfSocObject );
+ mSavedSocValues.resize( numberOfSocObject );
+ mSavedSocOffsets.resize( numberOfSocObject );
+
+ BOOST_FOREACH ( const boost::shared_ptr< state::State > &socStateFromFactory,
+ stateFactory->GetObjectsOfClass( "Soc" ) )
+ mSocStates.push_back( boost::static_pointer_cast< state::Soc, state::State >( socStateFromFactory ) );
+
+ mCellElements.reserve( electricalFactory->GetObjectsOfClass( "CellElement" ).size() );
+ BOOST_FOREACH ( const boost::shared_ptr< ::electrical::TwoPort< Matrix > > &twoPortFromFactory,
+ electricalFactory->GetObjectsOfClass( "CellElement" ) )
+ {
+ if ( twoPortFromFactory->IsCellelement() )
+ mCellElements.push_back(
+ boost::static_pointer_cast< ::electrical::Cellelement< Matrix >, ::electrical::TwoPort< Matrix > >( twoPortFromFactory ) );
+ else
+ {
+ ::electrical::ParallelTwoPort< Matrix > *cellFromFactory =
+ static_cast< ::electrical::ParallelTwoPort< Matrix > * >( twoPortFromFactory.get() );
+ for ( size_t i = 0; i < cellFromFactory->GetParallelChildren(); ++i )
+ mCellElements.push_back(
+ boost::static_pointer_cast< ::electrical::Cellelement< Matrix > >( cellFromFactory->shared_at( i ) ) );
+ }
+ }
+
+ // Evaluate Options node
+ boost::shared_ptr< xmlparser::XmlParameter > optionsNode = rootXmlNode->GetElementChild( "Options" );
+
+ // SocStopCriterion
+ if ( optionsNode->HasElementDirectChild( "SocStopCriterionInPercent" ) )
+ {
+ mSocStopCriterion = optionsNode->GetElementDoubleValue( "SocStopCriterionInPercent" );
+ if ( mSocStopCriterion <= 0.0 )
+ ErrorFunction< std::runtime_error >( __FUNCTION__, __LINE__, __FILE__, "SocStopCriterionInPercentNegative" );
+ }
+
+ // Give out cells if wanted
+ if ( cells )
+ *cells = electricalFactory->GetObjectsOfClass( "Cellelement" );
+
+ if ( cells )
+ {
+ mObserver = CreateTwoPortObserver< std::vector< boost::shared_ptr< ::electrical::TwoPort< Matrix > > >, Matrix, filterTypeChoice >(
+ cells, rootXmlNode.get(), 0, 0, 0, 0, 0, mRootTwoPort );
+ }
+ else
+ {
+ mObserver = CreateTwoPortObserver< std::vector< boost::shared_ptr< electrical::TwoPort< Matrix > > >, Matrix, filterTypeChoice >(
+ 0, rootXmlNode.get(), 0, 0, 0, 0, 0, mRootTwoPort );
+ }
+}
+
+template < typename Matrix, typename T, bool filterTypeChoice >
+void ElectricalSimulation< Matrix, T, filterTypeChoice >::UpdateSystem()
+{
+ // Current must be set before this function
+ mRootTwoPort->UpdateStateSystemGroup();
+ mEqSystem->PrepareEquationSystem();
+}
+
+template < typename Matrix, typename T, bool filterTypeChoice >
+void ElectricalSimulation< Matrix, T, filterTypeChoice >::UpdateSystemValues()
+{
+ mRootTwoPort->CalculateStateDependentValues();
+#if defined( _ARMADILLO_ ) && defined( SPARSE_MATRIX_FORMAT )
+ mStateSystemGroup.ResetSystem();
+#endif
+}
+
+template < typename Matrix, typename T, bool filterTypeChoice >
+bool ElectricalSimulation< Matrix, T, filterTypeChoice >::CheckLoopConditionAndSetDeltaTime( T currentChangeTime )
+{
+ if ( mTime < mStepStartTime + mMaxSimulationStepDuration && mTime < currentChangeTime )
+ {
+ mLastUnconstrainedDeltaTime = mDeltaTime;
+ mDeltaTime = std::min( currentChangeTime - mTime, mLastUnconstrainedDeltaTime );
+ mDeltaTime = std::min( mStepStartTime + mMaxSimulationStepDuration - mTime, mDeltaTime );
+ return true;
+ }
+
+ return false;
+}
+
+template < typename Matrix, typename T, bool filterTypeChoice >
+bool ElectricalSimulation< Matrix, T, filterTypeChoice >::CheckIfSimulationTimeHasEnded()
+{
+ return mTime >= mSimulationDuration;
+}
+
+template < typename Matrix, typename T, bool filterTypeChoice >
+T ElectricalSimulation< Matrix, T, filterTypeChoice >::GetCurrentSimulationStepTime() const
+{
+ return mTime - mStepStartTime;
+}
+
+template < typename Matrix, typename T, bool filterTypeChoice >
+void ElectricalSimulation< Matrix, T, filterTypeChoice >::FinshStep()
+{
+}
+
+template < typename Matrix, typename T, bool filterTypeChoice >
+void ElectricalSimulation< Matrix, T, filterTypeChoice >::UpdateAllThermalStatesPowerDissipation()
+{
+ BOOST_FOREACH ( boost::shared_ptr< electrical::Cellelement< Matrix > > &elem, mCellElements )
+ elem->UpdateThermalStatePowerDissipation( mTime );
+}
+
+template < typename Matrix, typename T, bool filterTypeChoice >
+void ElectricalSimulation< Matrix, T, filterTypeChoice >::UpdateAllThermalStatesPowerDissipationWithoutTime()
+{
+ BOOST_FOREACH ( boost::shared_ptr< electrical::Cellelement< Matrix > > &elem, mCellElements )
+ elem->UpdateThermalStatePowerDissipation();
+}
+
+template < typename Matrix, typename T, bool filterTypeChoice >
+void ElectricalSimulation< Matrix, T, filterTypeChoice >::ResetAllThermalStatesPowerDissipation()
+{
+ BOOST_FOREACH ( boost::shared_ptr< electrical::Cellelement< Matrix > > &elem, mCellElements )
+ elem->ResetThermalStatePowerDissipation();
+}
+
+template < typename Matrix, typename T, bool filterTypeChoice >
+void ElectricalSimulation< Matrix, T, filterTypeChoice >::StartNewTimeStep()
+{
+ ResetAllThermalStatesPowerDissipation();
+ mStepStartTime = mTime;
+ mNumberOfSteps = 0;
+ SaveStatesForLaterReset();
+#ifndef _SYMBOLIC_
+ mInitialPowerValue = mRootTwoPort->GetCurrentValue() * mRootTwoPort->GetVoltageValue();
+#endif
+}
+
+template < typename Matrix, typename T, bool filterTypeChoice >
+bool ElectricalSimulation< Matrix, T, filterTypeChoice >::IsStopCriterionFulfilled() const
+{
+ bool isStop = false;
+ for ( size_t i = 0; i < mSocStates.size(); ++i )
+ {
+ if ( fabs( mSocValuesSteps[0][i] - mSocStates[i]->GetValue() ) > mSocStopCriterion )
+ {
+ isStop = true;
+ break;
+ }
+ }
+
+#ifndef _SYMBOLIC_
+ if ( mPowerStopCriterion > 0.0 )
+ {
+ double power = mRootTwoPort->GetCurrentValue() * mRootTwoPort->GetVoltageValue();
+ double powerDeviation = ( std::abs( mInitialPowerValue - power ) / mInitialPowerValue ) - 1;
+ if ( powerDeviation > mPowerStopCriterion )
+ isStop = true;
+ }
+#endif
+
+ return isStop;
+}
+
+template < typename Matrix, typename T, bool filterTypeChoice >
+void ElectricalSimulation< Matrix, T, filterTypeChoice >::SaveStatesForLaterReset()
+{
+ if ( mTimeSteps.size() == mNumberOfSteps )
+ mTimeSteps.resize( mNumberOfSteps + 1 );
+ if ( mStatesSteps.size() == mNumberOfSteps )
+ mStatesSteps.resize( mNumberOfSteps + 1 );
+ if ( mSocValuesSteps.size() == mNumberOfSteps )
+ {
+ mSocValuesSteps.resize( mNumberOfSteps + 1 );
+ mSocValuesSteps[mNumberOfSteps].resize( mSocStates.size() );
+ }
+
+ mTimeSteps[mNumberOfSteps] = mTime;
+ mStatesSteps[mNumberOfSteps] = mStateSystemGroup.mStateVector;
+ for ( size_t i = 0; i < mSocStates.size(); ++i )
+ mSocValuesSteps[mNumberOfSteps][i] = mSocStates[i]->GetValue();
+
+ mNumberOfSteps++;
+}
+
+template < typename Matrix, typename T, bool filterTypeChoice >
+void ElectricalSimulation< Matrix, T, filterTypeChoice >::ResetStatesToPointOfTime( T time )
+{
+ if ( time <= mTimeSteps[0] || time > mTimeSteps[mNumberOfSteps - 1] || mNumberOfSteps < 2 )
+ ErrorFunction< std::runtime_error >( __FUNCTION__, __LINE__, __FILE__,
+ "errorResetStatesToPointOfTimeExecution" );
+ if ( time == mTimeSteps[mNumberOfSteps - 1] ) // No need to reset if thermal stop criterion is triggered after
+ // full step time time has been simulated
+ return;
+
+ // Get index, which is the index for the vectors mStateSystemGroup and mSocValuesSteps before time
+ size_t index = 0;
+ for ( size_t i = 1; i < mNumberOfSteps; ++i )
+ if ( mTimeSteps[i] > time )
+ {
+ index = i - 1;
+ break;
+ }
+
+ // Calculate factor1 and factor2, which are used to scale linearly between the point of time for index and (index+1)
+ const T deltaTime = mTimeSteps[index + 1] - mTimeSteps[index];
+ const T factor1 = ( mTimeSteps[index + 1] - time ) / deltaTime;
+ const T factor2 = ( time - mTimeSteps[index] ) / deltaTime;
+
+ // Reset time, states and SoCs
+ mTime = time;
+ mStateSystemGroup.mStateVector = mStatesSteps[index] * factor1 + mStatesSteps[index] * factor2;
+ for ( size_t i = 0; i < mSocStates.size(); ++i )
+ {
+ const T newSocValue = mSocValuesSteps[index][i] * factor1 + mSocValuesSteps[index + 1][i] * factor2;
+ const T deltaCapacityASec =
+ ( newSocValue - mSocValuesSteps[mNumberOfSteps - 1][i] ) / 100.0 * mSocStates[i]->GetActualCapacity();
+ mSocStates[i]->SetStoredEnergy< state::SocSetFormat::DELTA >( deltaCapacityASec );
+ }
+ UpdateSystemValues();
+ UpdateSystem();
+
+ BOOST_FOREACH ( boost::shared_ptr< state::ThermalState< double > > &thermalState, mThermalStates )
+ thermalState->ResetPowerDissipationToTime( time );
+}
+
+template < typename Matrix, typename T, bool filterTypeChoice >
+void ElectricalSimulation< Matrix, T, filterTypeChoice >::SaveCapacityForLaterReset()
+{
+ for ( size_t i = 0; i < mSocStates.size(); ++i )
+ {
+ mSavedSocValues[i] = mSocStates[i]->template GetValue< state::SocGetFormat::AS >();
+ mSavedSocOffsets[i] = mSocStates[i]->template GetOffset< state::SocGetFormat::AS >();
+ }
+}
+
+template < typename Matrix, typename T, bool filterTypeChoice >
+void ElectricalSimulation< Matrix, T, filterTypeChoice >::LoadCapacityForLaterReset()
+{
+ for ( size_t i = 0; i < mSocStates.size(); ++i )
+ {
+ mSocStates[i]->template SetOffset< state::SocSetFormat::ABSOLUT >( mSavedSocOffsets[i] );
+ mSocStates[i]->template SetStoredEnergy< state::SocSetFormat::ABSOLUT >( mSavedSocValues[i] );
+ }
+}
+
+template < typename Matrix, typename T, bool filterTypeChoice >
+void ElectricalSimulation< Matrix, T, filterTypeChoice >::ResetSocStates()
+{
+ for ( size_t i = 0; i < mCellElements.size(); ++i )
+ mCellElements[i]->ResetSocValue();
+}
+
+template < typename Matrix, typename T, bool filterTypeChoice >
+void ElectricalSimulation< Matrix, T, filterTypeChoice >::ResetSystemStates()
+{
+ mStateSystemGroup.ResetStates();
+}
+
+template < typename Matrix, typename T, bool filterTypeChoice >
+void ElectricalSimulation< Matrix, T, filterTypeChoice >::SetPowerStopCriterion( T maximumDeviation )
+{
+ mPowerStopCriterion = maximumDeviation / 100;
+}
+} // namespace simulation
+#endif
diff --git a/src/export/matrix_simulink_model.h b/src/export/matrix_simulink_model.h
index 956f02cd1cc2489b6dc446adb10c7cd23fdce527..6524723370b2796ae0a6508495791bc5b781b7e8 100644
--- a/src/export/matrix_simulink_model.h
+++ b/src/export/matrix_simulink_model.h
@@ -310,8 +310,8 @@ void MatrixSimulinkModel< Matrix, T >::CreateElectricalModel()
myMatrixType totalValuesMatrix( 3, 1 );
current = mElectricalSimulation->mRootTwoPort->GetCurrent() * mElectricalSimulation->mStateSystemGroup.mStateVector;
voltage = *mElectricalSimulation->mRootTwoPort->GetVoltage() * mElectricalSimulation->mStateSystemGroup.mStateVector;
- totalValuesMatrix.coeffRef( 0, 0 ) = current.coeffRef( 0, 0 );
- totalValuesMatrix.coeffRef( 1, 0 ) = voltage.coeffRef( 0, 0 );
+ totalValuesMatrix.coeffRef( 0, 0 ) = current.coeff( 0, 0 );
+ totalValuesMatrix.coeffRef( 1, 0 ) = voltage.coeff( 0, 0 );
totalValuesMatrix.coeffRef( 2, 0 ) = mElectricalSimulation->mRootTwoPort->GetPowerValue();
MakeMatrix( totalValuesMatrix, misc::StrCont( mSimulinkModel ) + misc::StrCont( "/TotalValues" ) );
prhs.at( 0 ) = mxCreateString( mSimulinkModel );
@@ -928,7 +928,7 @@ void MatrixSimulinkModel< Matrix, T >::MakeStateResetMatrix( const Matrix &matri
UNUSED( StateMatrix );
for ( size_t i = 0; i < matrix.n_rows; ++i )
for ( size_t j = 0; j < matrix.n_cols; ++j )
- if ( !matrix( i, j ).IsEmpty() )
+ if ( !matrix.coeff( i, j ).IsEmpty() )
{
mxArray **plhs = 0;
boost::array< mxArray *, 6 > prhs;
@@ -1000,7 +1000,7 @@ void MatrixSimulinkModel< Matrix, T >::LoadInitialState()
temperatureDoubles[i] = cell->GetThermalState()->GetValue();
}
mxArray **plhs = 0;
- boost::array< mxArray *, 3 > prhs{mxCreateString( mInitialStateStruct ), socArray, temperatureArray};
+ boost::array< mxArray *, 3 > prhs{ mxCreateString( mInitialStateStruct ), socArray, temperatureArray };
if ( mexCallMATLAB( 0, plhs, 3, prhs.data(), "LoadInitialStateToWorkspace" ) != 0 )
ErrorFunction< std::runtime_error >( __FUNCTION__, __LINE__, __FILE__, "ErrorMatrixModel",
"loading initial state" );
@@ -1111,8 +1111,8 @@ void MatrixSimulinkModel< Matrix, T >::LoadObjectValues()
{
auto rootPort = mElectricalSimulation->mRootTwoPort.get();
size_t index = 0;
- mwSize arraySize[1] = {this->mElectricalSimulation->mNumberOfObjects};
- const char *fieldnames[4] = {"destination", "rowPoints", "colPoints", "values"};
+ mwSize arraySize[1] = { this->mElectricalSimulation->mNumberOfObjects };
+ const char *fieldnames[4] = { "destination", "rowPoints", "colPoints", "values" };
// const char** fieldnamePtr = &fieldnames[0];
mxArray *data = mxCreateStructArray( 1, arraySize, 4, (const char **)fieldnames );
GetObjectValues( rootPort, data, mSimulinkModel + "/ElectricalCircuit/" + rootPort->GetName() + "_Elem1", index );
diff --git a/src/export/mex/CreateSimulinkModel.cpp b/src/export/mex/CreateSimulinkModel.cpp
index 0e2ff6f21feb32ab1cc569ddc4bcdf516d4a0690..ffe7e0535c83446a1613cd48833f97e8ba7c7f0c 100644
--- a/src/export/mex/CreateSimulinkModel.cpp
+++ b/src/export/mex/CreateSimulinkModel.cpp
@@ -12,9 +12,9 @@ void mexFunction( int nlhs, mxArray *plhs[], int nrhs, const mxArray *prhs[] )
{
mexPrintf( "%s\n",
"Usage: CreateSimulinkModel(configstring, modelType, modelLocation='BuildMatrixModel', "
- "initialStateStruct='MDL.battery.initialState'\nCreates a simulink model from the specified config "
+ "initialStateStruct='MDL.battery.initialState')\nCreates a simulink model from the specified config "
"string.\nconfigstring: The contents of an XML file describing the system\nmodelType: type of the "
- "simulink model, 0 = CircuitModel (currently broken), 1 = MatrixModel\nmodelLocation: System that "
+ "simulink model, 0 = CircuitModel (currently broken), 1 = MatrixModel\nmodelLocation: system that "
"the model will be built in\ninitialStateStruct: workspace variable that contains the initial state "
"of the model\n" );
return;
diff --git a/src/factory/object/objectclasswrapper.h b/src/factory/object/objectclasswrapper.h
index abf327a7738ec8789da92fd8e4fe137631f51c30..c90ad8aac0fb7d0492ace17e54632fdc73bc7ec0 100644
--- a/src/factory/object/objectclasswrapper.h
+++ b/src/factory/object/objectclasswrapper.h
@@ -142,10 +142,9 @@ class ObjectClassWrapperBase : public ClassWrapperBase< Object< ValueT >, Argume
/** Get the LookupType from xml file, e.g. LinearInterpolation
* @param param Pointer of type xmlparser::XmlParameter. This is the desired LookupType in the xml-file.
- * @return Integer representing a LookupType: 0 => "LinearInterpolation", 1 => NearestNeighbour", 2 =>
- * ConstantUntilThreshold, 3 => SplineInterpolation
+ * @return Type of the lookup, defaults to LinearInterpolation
*/
- int GetLookupType( const xmlparser::XmlParameter* param )
+ lookup::LookupType GetLookupType( const xmlparser::XmlParameter* param )
{
if ( !param )
{
@@ -159,20 +158,20 @@ class ObjectClassWrapperBase : public ClassWrapperBase< Object< ValueT >, Argume
const char* myLookupTypeString = param->GetElementAttributeCharPtrValue( "LookupType" );
misc::equal_str myCompareObject;
if ( myCompareObject( myLookupTypeString, "LinearInterpolation" ) )
- return 0;
+ return lookup::LookupType::LINEAR_INTERPOLATION;
else if ( myCompareObject( myLookupTypeString, "NearestNeighbour" ) )
- return 1;
+ return lookup::LookupType::NEAREST_NEIGHBOUR;
else if ( myCompareObject( myLookupTypeString, "ConstantUntilThreshold" ) )
- return 2;
+ return lookup::LookupType::CONSTANT_UNTIL_THRESHOLD;
else if ( myCompareObject( myLookupTypeString, "SplineInterpolation" ) )
- return 3;
+ return lookup::LookupType::SPLINE_INTERPOLATION;
else
{
ErrorFunction< std::runtime_error >( __FUNCTION__, __LINE__, __FILE__, "UnknownLookupType" );
}
}
}
- return 0; // Set LookupType to default 0 = LinearInterpolation
+ return lookup::LookupType::LINEAR_INTERPOLATION; // Set LookupType to default LinearInterpolation
}
private:
diff --git a/src/lookup/lookupType.h b/src/lookup/lookupType.h
index ed1d964bb254c0e7ab38a7456a42cf9386345a78..c2e89a9e324c9d04f86506316e2f7103ebf53203 100644
--- a/src/lookup/lookupType.h
+++ b/src/lookup/lookupType.h
@@ -7,12 +7,12 @@ _._._._._._._._._._._._._._._._._._._._._.*/
#ifndef _LOOKUPTYPE_
#define _LOOKUPTYPE_
-//STD
-#include <iostream>
-#include <vector>
-#include <cmath>
+// STD
#include <algorithm>
+#include <cmath>
+#include <iostream>
#include <limits>
+#include <vector>
class TestLookup;
@@ -21,124 +21,120 @@ namespace lookup
{
enum LookupType
{
- LINEAR_INTERPOLATION = 0
- , NEAREST_NEIGHBOUR = 1
- , CONSTANT_UNTIL_THRESHOLD = 2
- , SPLINE_INTERPOLATION = 3
- , NUMBER_OF_LOOKUPTYPES = 4
+ LINEAR_INTERPOLATION = 0,
+ NEAREST_NEIGHBOUR = 1,
+ CONSTANT_UNTIL_THRESHOLD = 2,
+ SPLINE_INTERPOLATION = 3,
+ NUMBER_OF_LOOKUPTYPES = 4
};
/// This class contains measurement point and data to determine the lookup
-template<typename T>
+template < typename T >
class LookupType1D
{
-public:
- LookupType1D(const std::vector<T> &lookupData, const std::vector<T> &measurementPoints)
- : mLookup(lookupData)
- , mMeasurementPoints(measurementPoints)
- , mCurrentMeasurementPointIndex(0)
- , mMinValue(measurementPoints.front())
- , mMaxValue(measurementPoints.back())
- { };
- const std::vector<T>& GetLookup() const { return mLookup;};
+ public:
+ LookupType1D( const std::vector< T > &lookupData, const std::vector< T > &measurementPoints )
+ : mLookup( lookupData )
+ , mMeasurementPoints( measurementPoints )
+ , mCurrentMeasurementPointIndex( 0 )
+ , mMinValue( measurementPoints.front() )
+ , mMaxValue( measurementPoints.back() ){};
+ const std::vector< T > &GetLookup() const { return mLookup; };
virtual ~LookupType1D(){};
- virtual T DoLookup(T lookupPoint) = 0 ;
- virtual T GetMinValueOfLookup() const
- {
- return *std::min_element(mLookup.begin(), mLookup.end());
- }
- virtual T GetMaxValueOfLookup() const
- {
- return *std::max_element(mLookup.begin(), mLookup.end());
- }
- inline const std::vector<T>& GetPoints() const
- {
- return mMeasurementPoints;
- }
-protected:
- size_t GetLowerBound(T value)
+ virtual T DoLookup( T lookupPoint ) = 0;
+ virtual T GetMinValueOfLookup() const { return *std::min_element( mLookup.begin(), mLookup.end() ); }
+ virtual T GetMaxValueOfLookup() const { return *std::max_element( mLookup.begin(), mLookup.end() ); }
+ inline const std::vector< T > &GetPoints() const { return mMeasurementPoints; }
+
+ protected:
+ size_t GetLowerBound( T value )
{
- while( (mCurrentMeasurementPointIndex < mMeasurementPoints.size() - 1) && (value > mMeasurementPoints[mCurrentMeasurementPointIndex + 1]) )
+ while ( ( mCurrentMeasurementPointIndex < mMeasurementPoints.size() - 1 ) &&
+ ( value > mMeasurementPoints[mCurrentMeasurementPointIndex + 1] ) )
++mCurrentMeasurementPointIndex;
- while( (mCurrentMeasurementPointIndex > 0) && (value < mMeasurementPoints[mCurrentMeasurementPointIndex]) )
+ while ( ( mCurrentMeasurementPointIndex > 0 ) && ( value < mMeasurementPoints[mCurrentMeasurementPointIndex] ) )
--mCurrentMeasurementPointIndex;
return mCurrentMeasurementPointIndex;
}
- std::vector<T> mLookup;
- std::vector<T> mMeasurementPoints;
+ std::vector< T > mLookup;
+ std::vector< T > mMeasurementPoints;
size_t mCurrentMeasurementPointIndex;
T mMinValue;
T mMaxValue;
};
/// This class contains the nearest neighbour behaviour for 1D lookups
-template<typename T>
-class NearestNeighbour1D: public LookupType1D<T>
+template < typename T >
+class NearestNeighbour1D : public LookupType1D< T >
{
-public:
- NearestNeighbour1D(const typename std::vector<T> &lookupData, const typename std::vector<T> &measurementPoints)
- : LookupType1D<T>(lookupData, measurementPoints){ };
+ public:
+ NearestNeighbour1D( const typename std::vector< T > &lookupData, const typename std::vector< T > &measurementPoints )
+ : LookupType1D< T >( lookupData, measurementPoints ){};
virtual ~NearestNeighbour1D(){};
- virtual T DoLookup(T lookupPoint)
+ virtual T DoLookup( T lookupPoint )
{
- //Boundary
- if (lookupPoint <= this->mMinValue)
+ // Boundary
+ if ( lookupPoint <= this->mMinValue )
return this->mLookup.front();
- else if (lookupPoint >= this->mMaxValue)
+ else if ( lookupPoint >= this->mMaxValue )
return this->mLookup.back();
- const size_t i = LookupType1D<T>::GetLowerBound( lookupPoint );
- if (std::abs(this->mMeasurementPoints.at(i) - lookupPoint) < std::abs(this->mMeasurementPoints.at( i + 1 ) - lookupPoint))
- return this->mLookup.at(i);
+ const size_t i = LookupType1D< T >::GetLowerBound( lookupPoint );
+ if ( std::abs( this->mMeasurementPoints.at( i ) - lookupPoint ) < std::abs( this->mMeasurementPoints.at( i + 1 ) - lookupPoint ) )
+ return this->mLookup.at( i );
else
- return this->mLookup.at(i+1);
+ return this->mLookup.at( i + 1 );
};
};
/// This class contains an linear interpolation behaviour for 1D lookups
-template<typename T>
-class Linear1DInterpolation: public LookupType1D<T>
+template < typename T >
+class Linear1DInterpolation : public LookupType1D< T >
{
-public:
- Linear1DInterpolation(const std::vector<T> &lookupData, const std::vector<T> &measurementPoints)
- : LookupType1D<T>(lookupData, measurementPoints ){ };
+ public:
+ Linear1DInterpolation( const std::vector< T > &lookupData, const std::vector< T > &measurementPoints )
+ : LookupType1D< T >( lookupData, measurementPoints ){};
virtual ~Linear1DInterpolation(){};
- virtual T DoLookup(T lookupPoint)
+ virtual T DoLookup( T lookupPoint )
{
- //Boundary
- if (lookupPoint <= this->mMinValue)
+ // Boundary
+ if ( lookupPoint <= this->mMinValue )
return this->mLookup.front();
- else if (lookupPoint >= this->mMaxValue)
+ else if ( lookupPoint >= this->mMaxValue )
return this->mLookup.back();
- const size_t i = LookupType1D<T>::GetLowerBound( lookupPoint );
- return this->mLookup.at(i) + ( lookupPoint - this->mMeasurementPoints.at(i)) * (this->mLookup.at(i+1) - this->mLookup.at(i)) / (this->mMeasurementPoints.at(i+1) - this->mMeasurementPoints.at(i));
+ const size_t i = LookupType1D< T >::GetLowerBound( lookupPoint );
+ return this->mLookup.at( i ) + ( lookupPoint - this->mMeasurementPoints.at( i ) ) *
+ ( this->mLookup.at( i + 1 ) - this->mLookup.at( i ) ) /
+ ( this->mMeasurementPoints.at( i + 1 ) - this->mMeasurementPoints.at( i ) );
};
-private:
-protected:
+
+ private:
+ protected:
};
/// This class contains constant until threshold behaviour for 1D lookups
-template<typename T>
-class ConstantUntilThreshold1D: public LookupType1D<T>
+template < typename T >
+class ConstantUntilThreshold1D : public LookupType1D< T >
{
-public:
- ConstantUntilThreshold1D(const typename std::vector<T> &lookupData, const typename std::vector<T> &measurementPoints)
- : LookupType1D<T>(lookupData, measurementPoints){ };
+ public:
+ ConstantUntilThreshold1D( const typename std::vector< T > &lookupData, const typename std::vector< T > &measurementPoints )
+ : LookupType1D< T >( lookupData, measurementPoints ){};
virtual ~ConstantUntilThreshold1D(){};
- virtual T DoLookup(T lookupPoint)
+ virtual T DoLookup( T lookupPoint )
{
- //Boundary
- if (lookupPoint <= this->mMinValue)
+ // Boundary
+ if ( lookupPoint <= this->mMinValue )
return this->mLookup.front();
- else if (lookupPoint >= this->mMaxValue)
+ else if ( lookupPoint >= this->mMaxValue )
return this->mLookup.back();
// Get index of lower bound
- const size_t i = LookupType1D<T>::GetLowerBound( static_cast<long> (lookupPoint + 1) ); // cast is used to get only integers, e.g. lookupPoint = 9.9 -> lookupPoint 9.0
+ const size_t i = LookupType1D< T >::GetLowerBound( static_cast< long >(
+ lookupPoint + 1 ) ); // cast is used to get only integers, e.g. lookupPoint = 9.9 -> lookupPoint 9.0
// Return lookup data at this very index
return this->mLookup[i];
@@ -148,28 +144,28 @@ public:
/** This class contains spline interpolation for 1D lookups.
Algorithm is based on en.wikipedia.org/w/index.php?title=Spline_%28mathematics%29&oldid=288288033#Algorithm_for_computing_natural_cubic_splines
*/
-template<typename T>
-class SplineInterpolation1D: public LookupType1D<T>
+template < typename T >
+class SplineInterpolation1D : public LookupType1D< T >
{
// friend class
friend class ::TestLookup;
-public:
- SplineInterpolation1D(const typename std::vector<T> &lookupData, const typename std::vector<T> &measurementPoints)
- : LookupType1D<T>(lookupData, measurementPoints)
+ public:
+ SplineInterpolation1D( const typename std::vector< T > &lookupData, const typename std::vector< T > &measurementPoints )
+ : LookupType1D< T >( lookupData, measurementPoints )
// Coefficients
- , mCoefficientB(measurementPoints.size() - 1, 0)
- , mCoefficientC(measurementPoints.size(), 0)
- , mCoefficientD(measurementPoints.size() - 1, 0)
+ , mCoefficientB( measurementPoints.size() - 1, 0 )
+ , mCoefficientC( measurementPoints.size(), 0 )
+ , mCoefficientD( measurementPoints.size() - 1, 0 )
// Auxiliary variables
- , mAuxiliaryAlpha(measurementPoints.size() - 1, 0) // alpha in Wiki
- , mAuxiliaryBeta(measurementPoints.size() - 1, 0) // h in Wiki
- , mAuxiliaryGamma(measurementPoints.size(), 1) // l in Wiki
- , mAuxiliaryDelta(measurementPoints.size(), 0) // my in Wiki
- , mAuxiliaryEpsilon(measurementPoints.size(), 0) // z in Wiki
+ , mAuxiliaryAlpha( measurementPoints.size() - 1, 0 ) // alpha in Wiki
+ , mAuxiliaryBeta( measurementPoints.size() - 1, 0 ) // h in Wiki
+ , mAuxiliaryGamma( measurementPoints.size(), 1 ) // l in Wiki
+ , mAuxiliaryDelta( measurementPoints.size(), 0 ) // my in Wiki
+ , mAuxiliaryEpsilon( measurementPoints.size(), 0 ) // z in Wiki
{
// Constructor functions
@@ -177,74 +173,75 @@ public:
GetCoefficients();
};
- virtual ~SplineInterpolation1D()
- {
- // Destructor functions: empty
+ virtual ~SplineInterpolation1D(){
+ // Destructor functions: empty
};
/// Get auxiliary variables alpha, beta, gamma, delta, epsilon
void GetAuxiliaryVariables()
{
- for (size_t i = 0; i < this->mMeasurementPoints.size() - 1; ++i)
+ for ( size_t i = 0; i < this->mMeasurementPoints.size() - 1; ++i )
{
- this->mAuxiliaryBeta.at(i) = this->mMeasurementPoints.at(i + 1) - this->mMeasurementPoints.at(i); // Guaranteed not zero because mMeasurementPoints.at(i+1) > mMeasurementPoints.at(i)
+ this->mAuxiliaryBeta.at( i ) = this->mMeasurementPoints.at( i + 1 ) - this->mMeasurementPoints.at( i ); // Guaranteed not zero because mMeasurementPoints.at(i+1) > mMeasurementPoints.at(i)
}
- for (size_t i = 1; i < this->mMeasurementPoints.size() - 1; ++i)
+ for ( size_t i = 1; i < this->mMeasurementPoints.size() - 1; ++i )
{
- this->mAuxiliaryAlpha.at(i) = 3 / this->mAuxiliaryBeta.at(i) * (this->mLookup.at(i + 1) - this->mLookup.at(i))
- - 3 / this->mAuxiliaryBeta.at(i - 1) * (this->mLookup.at(i) - this->mLookup.at(i - 1));
+ this->mAuxiliaryAlpha.at( i ) =
+ 3 / this->mAuxiliaryBeta.at( i ) * ( this->mLookup.at( i + 1 ) - this->mLookup.at( i ) ) -
+ 3 / this->mAuxiliaryBeta.at( i - 1 ) * ( this->mLookup.at( i ) - this->mLookup.at( i - 1 ) );
- this->mAuxiliaryGamma.at(i) = 2 * (this->mMeasurementPoints.at(i + 1) - this->mMeasurementPoints.at(i - 1))
- - this->mAuxiliaryBeta.at(i - 1) * this->mAuxiliaryDelta.at(i - 1); // Guaranteed not zero because mMeasurementPoints.at(i+1) > mMeasurementPoints.at(i)
+ this->mAuxiliaryGamma.at( i ) = 2 * ( this->mMeasurementPoints.at( i + 1 ) - this->mMeasurementPoints.at( i - 1 ) ) -
+ this->mAuxiliaryBeta.at( i - 1 ) * this->mAuxiliaryDelta.at( i - 1 ); // Guaranteed not zero because mMeasurementPoints.at(i+1) > mMeasurementPoints.at(i)
- this->mAuxiliaryDelta.at(i) = this->mAuxiliaryBeta.at(i) / this->mAuxiliaryGamma.at(i);
+ this->mAuxiliaryDelta.at( i ) = this->mAuxiliaryBeta.at( i ) / this->mAuxiliaryGamma.at( i );
- this->mAuxiliaryEpsilon.at(i) = ( this->mAuxiliaryAlpha.at(i) - this->mAuxiliaryBeta.at(i - 1) * this->mAuxiliaryEpsilon.at(i - 1) ) / this->mAuxiliaryGamma.at(i);
+ this->mAuxiliaryEpsilon.at( i ) =
+ ( this->mAuxiliaryAlpha.at( i ) - this->mAuxiliaryBeta.at( i - 1 ) * this->mAuxiliaryEpsilon.at( i - 1 ) ) /
+ this->mAuxiliaryGamma.at( i );
}
}
/// Get coefficients b, c, d. a is not needed, since a = lookupData
void GetCoefficients()
{
- for (int i = this->mMeasurementPoints.size() - 2; i >= 0; --i) // Cannot use size_t here because i will be < 0. Using int instead
+ for ( int i = this->mMeasurementPoints.size() - 2; i >= 0; --i ) // Cannot use size_t here because i will be < 0. Using int instead
{
- this->mCoefficientC.at(i) = this->mAuxiliaryEpsilon.at(i) - this->mAuxiliaryDelta.at(i) * this->mCoefficientC.at(i + 1);
+ this->mCoefficientC.at( i ) =
+ this->mAuxiliaryEpsilon.at( i ) - this->mAuxiliaryDelta.at( i ) * this->mCoefficientC.at( i + 1 );
- this->mCoefficientB.at(i) = ( this->mLookup.at(i + 1) - this->mLookup.at(i) ) / this->mAuxiliaryBeta.at(i)
- - this->mAuxiliaryBeta.at(i) * ( this->mCoefficientC.at(i + 1) + 2 * this->mCoefficientC.at(i) ) / 3;
+ this->mCoefficientB.at( i ) =
+ ( this->mLookup.at( i + 1 ) - this->mLookup.at( i ) ) / this->mAuxiliaryBeta.at( i ) -
+ this->mAuxiliaryBeta.at( i ) * ( this->mCoefficientC.at( i + 1 ) + 2 * this->mCoefficientC.at( i ) ) / 3;
- this->mCoefficientD.at(i) = ( this->mCoefficientC.at(i + 1) - this->mCoefficientC.at(i) ) / ( 3 * mAuxiliaryBeta.at(i) ) ;
+ this->mCoefficientD.at( i ) =
+ ( this->mCoefficientC.at( i + 1 ) - this->mCoefficientC.at( i ) ) / ( 3 * mAuxiliaryBeta.at( i ) );
}
}
/// Lookup function SplineInterpolation1D
- virtual T DoLookup(T lookupPoint)
+ virtual T DoLookup( T lookupPoint )
{
- //Boundary
- if (lookupPoint <= this->mMinValue)
+ // Boundary
+ if ( lookupPoint <= this->mMinValue )
return this->mLookup.front();
- else if (lookupPoint >= this->mMaxValue)
+ else if ( lookupPoint >= this->mMaxValue )
return this->mLookup.back();
// Get index of lower bound
- const size_t i = LookupType1D<T>::GetLowerBound( lookupPoint );
+ const size_t i = LookupType1D< T >::GetLowerBound( lookupPoint );
// Calculate value at lookup point
- return this->mLookup.at(i)
- + mCoefficientB.at(i) * ( lookupPoint - this->mMeasurementPoints[i] )
- + mCoefficientC.at(i) * std::pow( (lookupPoint - this->mMeasurementPoints[i]), 2.0 )
- + mCoefficientD.at(i) * std::pow( (lookupPoint - this->mMeasurementPoints[i]), 3.0 );
+ return this->mLookup.at( i ) + mCoefficientB.at( i ) * ( lookupPoint - this->mMeasurementPoints[i] ) +
+ mCoefficientC.at( i ) * std::pow( ( lookupPoint - this->mMeasurementPoints[i] ), 2.0 ) +
+ mCoefficientD.at( i ) * std::pow( ( lookupPoint - this->mMeasurementPoints[i] ), 3.0 );
};
-private:
-
-protected:
-
+ private:
+ protected:
/// Attributes
- std::vector<T> mCoefficientB, mCoefficientC, mCoefficientD; // Coefficients
- std::vector<T> mAuxiliaryAlpha, mAuxiliaryBeta, mAuxiliaryGamma, mAuxiliaryDelta, mAuxiliaryEpsilon; // Auxiliary variables
-
+ std::vector< T > mCoefficientB, mCoefficientC, mCoefficientD; // Coefficients
+ std::vector< T > mAuxiliaryAlpha, mAuxiliaryBeta, mAuxiliaryGamma, mAuxiliaryDelta, mAuxiliaryEpsilon; // Auxiliary variables
};
//-------------------------------------------------
@@ -252,35 +249,36 @@ protected:
//-------------------------------------------------
/// This class contains measurement points and data to determine the lookup
-template<typename T>
+template < typename T >
class LookupType2D
{
// friend class
friend class ::TestLookup;
-public:
- LookupType2D(const std::vector< std::vector<T> > &lookupData, const std::vector<T> &measurementPointsRow, const std::vector<T> &measurementPointsColumn)
+ public:
+ LookupType2D( const std::vector< std::vector< T > > &lookupData, const std::vector< T > &measurementPointsRow,
+ const std::vector< T > &measurementPointsColumn )
// Input data
- : mLookupData(lookupData)
- , mMeasurementPointsRow(measurementPointsRow)
- , mMeasurementPointsColumn(measurementPointsColumn)
- , mCurrentMeasurementPointRowIndex(0)
- , mCurrentMeasurementPointColumnIndex(0)
+ : mLookupData( lookupData )
+ , mMeasurementPointsRow( measurementPointsRow )
+ , mMeasurementPointsColumn( measurementPointsColumn )
+ , mCurrentMeasurementPointRowIndex( 0 )
+ , mCurrentMeasurementPointColumnIndex( 0 )
- {};
+ {};
virtual ~LookupType2D(){};
- virtual T DoLookup(T lookupPointRow, T lookupPointColumn) = 0 ;
+ virtual T DoLookup( T lookupPointRow, T lookupPointColumn ) = 0;
- const std::vector< std::vector<T> >& GetLookup() const { return mLookupData;};
+ const std::vector< std::vector< T > > &GetLookup() const { return mLookupData; };
virtual T GetMinValueOfLookup() const
{
- T minvalue = mLookupData.at(0).at(0);
- for( size_t i = 0; i < mLookupData.size() ; ++i )
+ T minvalue = mLookupData.at( 0 ).at( 0 );
+ for ( size_t i = 0; i < mLookupData.size(); ++i )
{
- T minValueOfLookupVector = *std::min_element(mLookupData[i].begin(), mLookupData[i].end());
- if (minValueOfLookupVector < minvalue)
+ T minValueOfLookupVector = *std::min_element( mLookupData[i].begin(), mLookupData[i].end() );
+ if ( minValueOfLookupVector < minvalue )
minvalue = minValueOfLookupVector;
}
return minvalue;
@@ -288,151 +286,156 @@ public:
virtual T GetMaxValueOfLookup() const
{
- T maxvalue = mLookupData.at(0).at(0);
- for( size_t i = 0; i < mLookupData.size() ; ++i )
+ T maxvalue = mLookupData.at( 0 ).at( 0 );
+ for ( size_t i = 0; i < mLookupData.size(); ++i )
{
- T maxValueOfLookupVector = *std::max_element(mLookupData[i].begin(), mLookupData[i].end());
- if (maxValueOfLookupVector > maxvalue)
+ T maxValueOfLookupVector = *std::max_element( mLookupData[i].begin(), mLookupData[i].end() );
+ if ( maxValueOfLookupVector > maxvalue )
maxvalue = maxValueOfLookupVector;
}
return maxvalue;
}
- inline const std::vector<T>& GetPointsRow() const
- {
- return mMeasurementPointsRow;
- }
- inline const std::vector<T>& GetPointsCol() const
- {
- return mMeasurementPointsColumn;
- }
+ inline const std::vector< T > &GetPointsRow() const { return mMeasurementPointsRow; }
+ inline const std::vector< T > &GetPointsCol() const { return mMeasurementPointsColumn; }
-protected:
+ protected:
// Get lower bound of row or column, return the index
- size_t GetLowerBound(const T value, size_t& currentMeasurementPointIndex, const std::vector<T>& measurementPoints)
+ size_t GetLowerBound( const T value, size_t ¤tMeasurementPointIndex, const std::vector< T > &measurementPoints )
{
- while( (currentMeasurementPointIndex < measurementPoints.size() - 1) && (value > measurementPoints[currentMeasurementPointIndex + 1]) )
+ while ( ( currentMeasurementPointIndex < measurementPoints.size() - 1 ) &&
+ ( value > measurementPoints[currentMeasurementPointIndex + 1] ) )
++currentMeasurementPointIndex;
- while( (currentMeasurementPointIndex > 0) && (value < measurementPoints[currentMeasurementPointIndex]) )
+ while ( ( currentMeasurementPointIndex > 0 ) && ( value < measurementPoints[currentMeasurementPointIndex] ) )
--currentMeasurementPointIndex;
return currentMeasurementPointIndex;
}
// Attributes
- std::vector< std::vector<T> > mLookupData;
- std::vector<T> mMeasurementPointsRow;
- std::vector<T> mMeasurementPointsColumn;
+ std::vector< std::vector< T > > mLookupData;
+ std::vector< T > mMeasurementPointsRow;
+ std::vector< T > mMeasurementPointsColumn;
size_t mCurrentMeasurementPointRowIndex;
size_t mCurrentMeasurementPointColumnIndex;
};
/// This class contains the nearest neighbour behaviour for 2D lookups
-template<typename T>
-class NearestNeighbour2D: public LookupType2D<T>
+template < typename T >
+class NearestNeighbour2D : public LookupType2D< T >
{
-public:
- NearestNeighbour2D(const typename std::vector< std::vector<T> > &lookupData, const typename std::vector<T> &measurementPointsRow , const typename std::vector<T> &measurementPointsColumn)
- : LookupType2D<T>(lookupData, measurementPointsRow, measurementPointsColumn)
-
- { };
+ public:
+ NearestNeighbour2D( const typename std::vector< std::vector< T > > &lookupData,
+ const typename std::vector< T > &measurementPointsRow, const typename std::vector< T > &measurementPointsColumn )
+ : LookupType2D< T >( lookupData, measurementPointsRow, measurementPointsColumn )
+
+ {};
virtual ~NearestNeighbour2D(){};
- virtual T DoLookup(T lookupPointRow, T lookupPointColumn)
+ virtual T DoLookup( T lookupPointRow, T lookupPointColumn )
{
- size_t i = LookupType2D<T>::GetLowerBound( lookupPointRow, this->mCurrentMeasurementPointRowIndex, this->mMeasurementPointsRow );
- size_t j = LookupType2D<T>::GetLowerBound( lookupPointColumn, this->mCurrentMeasurementPointColumnIndex, this->mMeasurementPointsColumn );
+ size_t i = LookupType2D< T >::GetLowerBound( lookupPointRow, this->mCurrentMeasurementPointRowIndex, this->mMeasurementPointsRow );
+ size_t j = LookupType2D< T >::GetLowerBound( lookupPointColumn, this->mCurrentMeasurementPointColumnIndex,
+ this->mMeasurementPointsColumn );
- if (std::abs(this->mMeasurementPointsRow.at(i + 1) - lookupPointRow) < std::abs(this->mMeasurementPointsRow.at( i ) - lookupPointRow))
+ if ( std::abs( this->mMeasurementPointsRow.at( i + 1 ) - lookupPointRow ) <
+ std::abs( this->mMeasurementPointsRow.at( i ) - lookupPointRow ) )
i++;
- if (std::abs(this->mMeasurementPointsColumn.at(j + 1) - lookupPointColumn) < std::abs(this->mMeasurementPointsColumn.at( j ) - lookupPointColumn))
+ if ( std::abs( this->mMeasurementPointsColumn.at( j + 1 ) - lookupPointColumn ) <
+ std::abs( this->mMeasurementPointsColumn.at( j ) - lookupPointColumn ) )
j++;
- return this->mLookupData.at(j).at(i);
+ return this->mLookupData.at( j ).at( i );
};
-private:
-protected:
+ private:
+ protected:
};
/// This class contains a linear interpolation behaviour for 2D lookups
-template<typename T>
-class Linear2DInterpolation: public LookupType2D<T>
+template < typename T >
+class Linear2DInterpolation : public LookupType2D< T >
{
// friend class
friend class ::TestLookup;
-public:
- Linear2DInterpolation(const std::vector< std::vector<T> > &lookupData, const std::vector<T> &measurementPointsRow, const std::vector<T> &measurementPointsColumn)
- : LookupType2D<T>(lookupData, measurementPointsRow, measurementPointsColumn)
+
+ public:
+ Linear2DInterpolation( const std::vector< std::vector< T > > &lookupData,
+ const std::vector< T > &measurementPointsRow, const std::vector< T > &measurementPointsColumn )
+ : LookupType2D< T >( lookupData, measurementPointsRow, measurementPointsColumn )
// Extended input data
- , mExtendedMeasurementPointsRow(measurementPointsRow.size() + 2, 0) // + 2 because two points are added
- , mExtendedMeasurementPointsColumn(measurementPointsColumn.size() + 2, 0) // + 2 because two points are added
- , mExtendedLookupData(measurementPointsColumn.size() + 2, std::vector<double>(measurementPointsRow.size() + 2, 0)) // + 2 because two points are added
+ , mExtendedMeasurementPointsRow( measurementPointsRow.size() + 2, 0 ) // + 2 because two points are added
+ , mExtendedMeasurementPointsColumn( measurementPointsColumn.size() + 2, 0 ) // + 2 because two points are added
+ , mExtendedLookupData( measurementPointsColumn.size() + 2, std::vector< double >( measurementPointsRow.size() + 2, 0 ) ) // + 2 because two points are added
// Slopes which are calculated only once
- , mRowSlopes(measurementPointsColumn.size() + 2, std::vector<T>(measurementPointsRow.size() + 1, 0)) // + 1 because there are (n - 1) row slopes for n row points
- , mColumnSlopes(measurementPointsColumn.size() + 1, std::vector<T>(measurementPointsRow.size() + 2, 0)) // + 1 because there are (n - 1) column slopes for n column points
- , mDifferenceOfQuotientOfSlopes(measurementPointsColumn.size() + 2, std::vector<T>(measurementPointsRow.size() + 1, 0)) // + 1 because there are (n - 1) quotients of column slopes for n row points
-
+ , mRowSlopes( measurementPointsColumn.size() + 2, std::vector< T >( measurementPointsRow.size() + 1, 0 ) ) // + 1 because there are (n - 1) row slopes for n row points
+ , mColumnSlopes( measurementPointsColumn.size() + 1, std::vector< T >( measurementPointsRow.size() + 2, 0 ) ) // + 1 because there are (n - 1) column slopes for n column points
+ , mDifferenceOfQuotientOfSlopes( measurementPointsColumn.size() + 2, std::vector< T >( measurementPointsRow.size() + 1, 0 ) ) // + 1 because there are (n - 1) quotients of column slopes for n row points
+
{
// Constructor functions
- CreateExtendedRowsOrColumns(this->mExtendedMeasurementPointsRow, this->mMeasurementPointsRow); // Create extended row vector
- CreateExtendedRowsOrColumns(this->mExtendedMeasurementPointsColumn, this->mMeasurementPointsColumn); // Create extended column vector
+ CreateExtendedRowsOrColumns( this->mExtendedMeasurementPointsRow, this->mMeasurementPointsRow ); // Create extended row vector
+ CreateExtendedRowsOrColumns( this->mExtendedMeasurementPointsColumn, this->mMeasurementPointsColumn ); // Create extended column vector
CreateExtendedLookupData();
CalculateRowSlopes();
CalculateColumnSlopes();
CalculateDifferenceOfQuotientsOfSlopes();
};
- virtual ~Linear2DInterpolation()
- {
- // Destructor functions: empty
+ virtual ~Linear2DInterpolation(){
+ // Destructor functions: empty
};
/// Create extended row vector or column vector
- void CreateExtendedRowsOrColumns(std::vector<T>& extendedMeasurementPoints, const std::vector<T>& measurementPoints)
+ void CreateExtendedRowsOrColumns( std::vector< T > &extendedMeasurementPoints, const std::vector< T > &measurementPoints )
{
// Boundary points for row and column points
- const T mySmallNumber = - std::numeric_limits<T>::max();
- const T myBigNumber = std::numeric_limits<T>::max();
+ const T mySmallNumber = -std::numeric_limits< T >::max();
+ const T myBigNumber = std::numeric_limits< T >::max();
- extendedMeasurementPoints.front() = mySmallNumber; // Fill first element
- for (size_t i = 0; i < measurementPoints.size(); ++i) // Fill all but first and last element
+ extendedMeasurementPoints.front() = mySmallNumber; // Fill first element
+ for ( size_t i = 0; i < measurementPoints.size(); ++i ) // Fill all but first and last element
{
- extendedMeasurementPoints.at(i + 1) = measurementPoints.at(i);
+ extendedMeasurementPoints.at( i + 1 ) = measurementPoints.at( i );
}
- extendedMeasurementPoints.back() = myBigNumber; // Fill last element
+ extendedMeasurementPoints.back() = myBigNumber; // Fill last element
}
/// Create extended lookup data
void CreateExtendedLookupData()
{
// Copy the rows and add two values, one at the beginning, one at the and
- for (size_t i = 0; i < this->mMeasurementPointsColumn.size(); ++i)
+ for ( size_t i = 0; i < this->mMeasurementPointsColumn.size(); ++i )
{
- this->mExtendedLookupData.at(i + 1).front() = this->mLookupData.at(i).front(); // Copy first element
- for (size_t j = 0; j < this->mMeasurementPointsRow.size(); ++j) // Copy all elements except first and last
+ this->mExtendedLookupData.at( i + 1 ).front() = this->mLookupData.at( i ).front(); // Copy first element
+ for ( size_t j = 0; j < this->mMeasurementPointsRow.size(); ++j ) // Copy all elements except first and last
{
- this->mExtendedLookupData.at(i + 1).at(j + 1) = this->mLookupData.at(i).at(j);
+ this->mExtendedLookupData.at( i + 1 ).at( j + 1 ) = this->mLookupData.at( i ).at( j );
}
- this->mExtendedLookupData.at(i + 1).back() = this->mLookupData.at(i).back(); // Copy last element
+ this->mExtendedLookupData.at( i + 1 ).back() = this->mLookupData.at( i ).back(); // Copy last element
}
// Copy the first and the last row
- this->mExtendedLookupData.front().assign( this->mExtendedLookupData.at(1).begin(), this->mExtendedLookupData.at(1).end() ); // Copy first row
+ this->mExtendedLookupData.front().assign( this->mExtendedLookupData.at( 1 ).begin(),
+ this->mExtendedLookupData.at( 1 ).end() ); // Copy first row
const size_t extendedColumnSizeMinus2 = this->mExtendedMeasurementPointsColumn.size() - 2;
- this->mExtendedLookupData.back().assign( this->mExtendedLookupData.at(extendedColumnSizeMinus2).begin(), this->mExtendedLookupData.at(extendedColumnSizeMinus2).end() ); // Copy last row
+ this->mExtendedLookupData.back().assign( this->mExtendedLookupData.at( extendedColumnSizeMinus2 ).begin(),
+ this->mExtendedLookupData.at( extendedColumnSizeMinus2 ).end() ); // Copy last row
}
/// Calculate row slopes
void CalculateRowSlopes()
{
- for (size_t i = 0; i < this->mExtendedMeasurementPointsColumn.size(); ++i)
+ for ( size_t i = 0; i < this->mExtendedMeasurementPointsColumn.size(); ++i )
{
- for (size_t j = 0; j < this->mExtendedMeasurementPointsRow.size() - 1; ++j) // - 1 because there are n - 1 row slopes for n row points
+ for ( size_t j = 0; j < this->mExtendedMeasurementPointsRow.size() - 1;
+ ++j ) // - 1 because there are n - 1 row slopes for n row points
{
- this->mRowSlopes.at(i).at(j) = (this->mExtendedLookupData.at(i).at(j + 1) - this->mExtendedLookupData.at(i).at(j)) / (this->mExtendedMeasurementPointsRow.at(j + 1) - this->mExtendedMeasurementPointsRow.at(j));
+ this->mRowSlopes.at( i ).at( j ) =
+ ( this->mExtendedLookupData.at( i ).at( j + 1 ) - this->mExtendedLookupData.at( i ).at( j ) ) /
+ ( this->mExtendedMeasurementPointsRow.at( j + 1 ) - this->mExtendedMeasurementPointsRow.at( j ) );
}
}
}
@@ -440,12 +443,14 @@ public:
/// Calculate column slopes
void CalculateColumnSlopes()
{
- for (size_t i = 0; i < this->mExtendedMeasurementPointsColumn.size() - 1; ++i)
+ for ( size_t i = 0; i < this->mExtendedMeasurementPointsColumn.size() - 1; ++i )
{
// Calculate column slopes
- for (size_t j = 0; j < this->mExtendedMeasurementPointsRow.size(); ++j) // - 1 because there are n - 1 row slopes for n row points
+ for ( size_t j = 0; j < this->mExtendedMeasurementPointsRow.size(); ++j ) // - 1 because there are n - 1 row slopes for n row points
{
- this->mColumnSlopes.at(i).at(j) = (this->mExtendedLookupData.at(i+1).at(j) - this->mExtendedLookupData.at(i).at(j)) / (this->mExtendedMeasurementPointsColumn.at(i + 1) - this->mExtendedMeasurementPointsColumn.at(i));
+ this->mColumnSlopes.at( i ).at( j ) =
+ ( this->mExtendedLookupData.at( i + 1 ).at( j ) - this->mExtendedLookupData.at( i ).at( j ) ) /
+ ( this->mExtendedMeasurementPointsColumn.at( i + 1 ) - this->mExtendedMeasurementPointsColumn.at( i ) );
}
}
}
@@ -453,160 +458,177 @@ public:
/// Calculate difference of quotients of slopes
void CalculateDifferenceOfQuotientsOfSlopes()
{
- for(size_t i = 0; i < this-> mExtendedMeasurementPointsColumn.size() - 1; ++i)
+ for ( size_t i = 0; i < this->mExtendedMeasurementPointsColumn.size() - 1; ++i )
{
- for (size_t j = 0; j < this->mExtendedMeasurementPointsRow.size() - 1; ++j)
+ for ( size_t j = 0; j < this->mExtendedMeasurementPointsRow.size() - 1; ++j )
{
- this->mDifferenceOfQuotientOfSlopes.at(i).at(j) = (this->mColumnSlopes.at(i).at(j+1) - this->mColumnSlopes.at(i).at(j)) / (this->mExtendedMeasurementPointsRow.at(j + 1) - this->mExtendedMeasurementPointsRow.at(j));
+ this->mDifferenceOfQuotientOfSlopes.at( i ).at( j ) =
+ ( this->mColumnSlopes.at( i ).at( j + 1 ) - this->mColumnSlopes.at( i ).at( j ) ) /
+ ( this->mExtendedMeasurementPointsRow.at( j + 1 ) - this->mExtendedMeasurementPointsRow.at( j ) );
}
}
}
/// Calculate 2d lookup
- virtual T DoLookup(T lookupPointRow, T lookupPointColumn)
+ virtual T DoLookup( T lookupPointRow, T lookupPointColumn )
{
// Get the index of the relevant measurement points for this lookup point. Take the lower index, not the upper.
- const size_t j = LookupType2D<T>::GetLowerBound(lookupPointRow, this->mCurrentMeasurementPointRowIndex, this->mExtendedMeasurementPointsRow);
- const size_t i = LookupType2D<T>::GetLowerBound(lookupPointColumn, this->mCurrentMeasurementPointColumnIndex, this->mExtendedMeasurementPointsColumn);
+ const size_t j = LookupType2D< T >::GetLowerBound( lookupPointRow, this->mCurrentMeasurementPointRowIndex,
+ this->mExtendedMeasurementPointsRow );
+ const size_t i = LookupType2D< T >::GetLowerBound( lookupPointColumn, this->mCurrentMeasurementPointColumnIndex,
+ this->mExtendedMeasurementPointsColumn );
// Calculate the lookup
- const T res = this->mExtendedLookupData[i][j]
- + this->mRowSlopes[i][j] * (lookupPointRow - this->mExtendedMeasurementPointsRow[j])
- + (this->mColumnSlopes[i][j] + (lookupPointRow - this->mExtendedMeasurementPointsRow[j]) * this->mDifferenceOfQuotientOfSlopes[i][j]) * (lookupPointColumn - this->mExtendedMeasurementPointsColumn[i]);
+ const T res = this->mExtendedLookupData[i][j] +
+ this->mRowSlopes[i][j] * ( lookupPointRow - this->mExtendedMeasurementPointsRow[j] ) +
+ ( this->mColumnSlopes[i][j] + ( lookupPointRow - this->mExtendedMeasurementPointsRow[j] ) *
+ this->mDifferenceOfQuotientOfSlopes[i][j] ) *
+ ( lookupPointColumn - this->mExtendedMeasurementPointsColumn[i] );
return res;
};
-private:
-
-protected:
+ private:
+ protected:
// Attributes
- std::vector<T> mExtendedMeasurementPointsRow;
- std::vector<T> mExtendedMeasurementPointsColumn;
- std::vector< std::vector<T> > mExtendedLookupData; // matrix
-
- std::vector< std::vector<T> > mRowSlopes; // matrix
- std::vector< std::vector<T> > mColumnSlopes; // matrix
- std::vector< std::vector<T> > mDifferenceOfQuotientOfSlopes; // matrix
+ std::vector< T > mExtendedMeasurementPointsRow;
+ std::vector< T > mExtendedMeasurementPointsColumn;
+ std::vector< std::vector< T > > mExtendedLookupData; // matrix
+ std::vector< std::vector< T > > mRowSlopes; // matrix
+ std::vector< std::vector< T > > mColumnSlopes; // matrix
+ std::vector< std::vector< T > > mDifferenceOfQuotientOfSlopes; // matrix
};
/// This class contains constant until threshhold behaviour for 2D lookups
-template<typename T>
-class ConstantUntilThreshold2D : public LookupType2D<T>
+template < typename T >
+class ConstantUntilThreshold2D : public LookupType2D< T >
{
-public:
- ConstantUntilThreshold2D(const typename std::vector< std::vector<T> > &lookupData, const typename std::vector<T> &measurementPointsRow , const typename std::vector<T> &measurementPointsColumn)
- : LookupType2D<T>(lookupData, measurementPointsRow, measurementPointsColumn)
+ public:
+ ConstantUntilThreshold2D( const typename std::vector< std::vector< T > > &lookupData,
+ const typename std::vector< T > &measurementPointsRow,
+ const typename std::vector< T > &measurementPointsColumn )
+ : LookupType2D< T >( lookupData, measurementPointsRow, measurementPointsColumn )
- { };
+ {};
virtual ~ConstantUntilThreshold2D(){};
- virtual T DoLookup(T lookupPointRow, T lookupPointColumn)
+ virtual T DoLookup( T lookupPointRow, T lookupPointColumn )
{
// cast is used to get only integers, e.g. lookupPoint = 9.9 -> lookupPoint 9.0
- size_t j = LookupType2D<T>::GetLowerBound( static_cast<long> (lookupPointRow+1), this->mCurrentMeasurementPointRowIndex, this->mMeasurementPointsRow );
- size_t i = LookupType2D<T>::GetLowerBound( static_cast<long> (lookupPointColumn+1), this->mCurrentMeasurementPointColumnIndex, this->mMeasurementPointsColumn );
+ size_t j = LookupType2D< T >::GetLowerBound( static_cast< long >( lookupPointRow + 1 ),
+ this->mCurrentMeasurementPointRowIndex, this->mMeasurementPointsRow );
+ size_t i = LookupType2D< T >::GetLowerBound( static_cast< long >( lookupPointColumn + 1 ),
+ this->mCurrentMeasurementPointColumnIndex, this->mMeasurementPointsColumn );
return this->mLookupData[i][j];
};
-private:
-protected:
+
+ private:
+ protected:
};
/// This class contains bicubic interpolation behaviour for 2D lookups. Algorithm is based on the book "Numerical Recipes".
-template<typename T>
-class BicubicInterpolation2D : public LookupType2D<T>
+template < typename T >
+class BicubicInterpolation2D : public LookupType2D< T >
{
// friend class
friend class ::TestLookup;
-public:
- BicubicInterpolation2D(const typename std::vector< std::vector<T> > &lookupData, const typename std::vector<T> &measurementPointsRow, const typename std::vector<T> &measurementPointsColumn)
- : LookupType2D<T>(lookupData, measurementPointsRow, measurementPointsColumn)
- , myLinear2DInterpolation(lookupData, measurementPointsRow, measurementPointsColumn) // Create Linear2DInterpolation for lookup outside the given measurement points.
- {};
+ public:
+ BicubicInterpolation2D( const typename std::vector< std::vector< T > > &lookupData,
+ const typename std::vector< T > &measurementPointsRow, const typename std::vector< T > &measurementPointsColumn )
+ : LookupType2D< T >( lookupData, measurementPointsRow, measurementPointsColumn )
+ , myLinear2DInterpolation( lookupData, measurementPointsRow,
+ measurementPointsColumn ) // Create Linear2DInterpolation for lookup outside the given measurement points.
+
+ {};
- virtual ~BicubicInterpolation2D() {};
+ virtual ~BicubicInterpolation2D(){};
/// Get knwonVectorBeta
- std::vector<T> GetKnownVectorBeta(size_t rowCoordinate, size_t columnCoordinate)
+ std::vector< T > GetKnownVectorBeta( size_t rowCoordinate, size_t columnCoordinate )
{
- std::vector<T> knownVectorBeta(4, 0);
+ std::vector< T > knownVectorBeta( 4, 0 );
- knownVectorBeta.at(0) = this->mLookupData[rowCoordinate][columnCoordinate];
- knownVectorBeta.at(1) = this->mLookupData[rowCoordinate][columnCoordinate+1];
- knownVectorBeta.at(2) = this->mLookupData[rowCoordinate+1][columnCoordinate+1];
- knownVectorBeta.at(3) = this->mLookupData[rowCoordinate+1][columnCoordinate];
+ knownVectorBeta.at( 0 ) = this->mLookupData[rowCoordinate][columnCoordinate];
+ knownVectorBeta.at( 1 ) = this->mLookupData[rowCoordinate][columnCoordinate + 1];
+ knownVectorBeta.at( 2 ) = this->mLookupData[rowCoordinate + 1][columnCoordinate + 1];
+ knownVectorBeta.at( 3 ) = this->mLookupData[rowCoordinate + 1][columnCoordinate];
return knownVectorBeta;
}
/// Get neededCoefficientsAlpha
- std::vector<T> GetNeededCoefficientsAlpha(const std::vector<T> &knownVectorBeta)
+ std::vector< T > GetNeededCoefficientsAlpha( const std::vector< T > &knownVectorBeta )
{
- std::vector<T> neededCoefficientsAlpha(9, 0);
+ std::vector< T > neededCoefficientsAlpha( 9, 0 );
neededCoefficientsAlpha[0] = ( knownVectorBeta[0] );
- neededCoefficientsAlpha[1] = ( - 3 * knownVectorBeta[0] + 3 * knownVectorBeta[3] );
+ neededCoefficientsAlpha[1] = ( -3 * knownVectorBeta[0] + 3 * knownVectorBeta[3] );
neededCoefficientsAlpha[2] = ( 2 * knownVectorBeta[0] - 2 * knownVectorBeta[3] );
- neededCoefficientsAlpha[3] = ( - 3 * knownVectorBeta[0] + 3 * knownVectorBeta[1] );
- neededCoefficientsAlpha[4] = ( 9 * knownVectorBeta[0] - 9 * knownVectorBeta[1] + 9 * knownVectorBeta[2] - 9 * knownVectorBeta[3] );
- neededCoefficientsAlpha[5] = ( - 6 * knownVectorBeta[0] + 6 * knownVectorBeta[1] - 6 * knownVectorBeta[2] + 6 * knownVectorBeta[3] );
+ neededCoefficientsAlpha[3] = ( -3 * knownVectorBeta[0] + 3 * knownVectorBeta[1] );
+ neededCoefficientsAlpha[4] =
+ ( 9 * knownVectorBeta[0] - 9 * knownVectorBeta[1] + 9 * knownVectorBeta[2] - 9 * knownVectorBeta[3] );
+ neededCoefficientsAlpha[5] =
+ ( -6 * knownVectorBeta[0] + 6 * knownVectorBeta[1] - 6 * knownVectorBeta[2] + 6 * knownVectorBeta[3] );
neededCoefficientsAlpha[6] = ( 2 * knownVectorBeta[0] - 2 * knownVectorBeta[1] );
- neededCoefficientsAlpha[7] = ( - 6 * knownVectorBeta[0] + 6 * knownVectorBeta[1] - 6 * knownVectorBeta[2] + 6 * knownVectorBeta[3] );
- neededCoefficientsAlpha[8] = ( 4 * knownVectorBeta[0] - 4 * knownVectorBeta[1] + 4 * knownVectorBeta[2] - 4 * knownVectorBeta[3] );
+ neededCoefficientsAlpha[7] =
+ ( -6 * knownVectorBeta[0] + 6 * knownVectorBeta[1] - 6 * knownVectorBeta[2] + 6 * knownVectorBeta[3] );
+ neededCoefficientsAlpha[8] =
+ ( 4 * knownVectorBeta[0] - 4 * knownVectorBeta[1] + 4 * knownVectorBeta[2] - 4 * knownVectorBeta[3] );
return neededCoefficientsAlpha;
}
/// Calculate lookup
- virtual T DoLookup(T lookupPointRow, T lookupPointColumn)
+ virtual T DoLookup( T lookupPointRow, T lookupPointColumn )
{
// Get the index of the relevant measurement points for this lookup point. Take the lower index, not the upper.
- const size_t rowIndex = LookupType2D<T>::GetLowerBound(lookupPointRow, this->mCurrentMeasurementPointRowIndex, this->mMeasurementPointsRow);
- const size_t columnIndex = LookupType2D<T>::GetLowerBound(lookupPointColumn, this->mCurrentMeasurementPointColumnIndex, this->mMeasurementPointsColumn);
+ const size_t rowIndex = LookupType2D< T >::GetLowerBound( lookupPointRow, this->mCurrentMeasurementPointRowIndex,
+ this->mMeasurementPointsRow );
+ const size_t columnIndex = LookupType2D< T >::GetLowerBound( lookupPointColumn, this->mCurrentMeasurementPointColumnIndex,
+ this->mMeasurementPointsColumn );
// Bicubic interpolation inside the boundaries
- if( lookupPointRow >= this->mMeasurementPointsRow.front() && lookupPointRow <= this->mMeasurementPointsRow.back()
- && lookupPointColumn >= this->mMeasurementPointsColumn.front() && lookupPointColumn <= this->mMeasurementPointsColumn.back() )
+ if ( lookupPointRow >= this->mMeasurementPointsRow.front() && lookupPointRow <= this->mMeasurementPointsRow.back() &&
+ lookupPointColumn >= this->mMeasurementPointsColumn.front() &&
+ lookupPointColumn <= this->mMeasurementPointsColumn.back() )
{
- // Auxiliary Slopes
- T u = 0; T t = 0;
- t = ( lookupPointRow - this->mMeasurementPointsRow[rowIndex] ) / (this->mMeasurementPointsRow[rowIndex+1] - this->mMeasurementPointsRow[rowIndex] );
- u = ( lookupPointColumn - this->mMeasurementPointsColumn[columnIndex] ) / (this->mMeasurementPointsColumn[columnIndex+1] - this->mMeasurementPointsColumn[columnIndex] );
+ // Auxiliary Slopes
+ T u = 0;
+ T t = 0;
+ t = ( lookupPointRow - this->mMeasurementPointsRow[rowIndex] ) /
+ ( this->mMeasurementPointsRow[rowIndex + 1] - this->mMeasurementPointsRow[rowIndex] );
+ u = ( lookupPointColumn - this->mMeasurementPointsColumn[columnIndex] ) /
+ ( this->mMeasurementPointsColumn[columnIndex + 1] - this->mMeasurementPointsColumn[columnIndex] );
- const std::vector<T> beta = GetKnownVectorBeta(columnIndex, rowIndex);
- const std::vector<T> alpha = GetNeededCoefficientsAlpha(beta);
+ const std::vector< T > beta = GetKnownVectorBeta( columnIndex, rowIndex );
+ const std::vector< T > alpha = GetNeededCoefficientsAlpha( beta );
- const T powU2 = std::pow(u, 2.0); // Used in the following
- const T powU3 = powU2 * u;
+ const T powU2 = std::pow( u, 2.0 ); // Used in the following
+ const T powU3 = powU2 * u;
- return alpha[0] + alpha[1] * powU2 + alpha[2] * powU3
- + std::pow(t, 2.0) *
- (
- (alpha[3] + alpha[4] * powU2 + alpha[5] * powU3)
- + t * (alpha[6] + alpha[7] * powU2 + alpha[8] * powU3)
- );
+ return alpha[0] + alpha[1] * powU2 + alpha[2] * powU3 +
+ std::pow( t, 2.0 ) * ( ( alpha[3] + alpha[4] * powU2 + alpha[5] * powU3 ) +
+ t * ( alpha[6] + alpha[7] * powU2 + alpha[8] * powU3 ) );
}
else
{
// LinearInterpolation outside the boundaries
- return this->myLinear2DInterpolation.DoLookup(lookupPointRow, lookupPointColumn);
+ return this->myLinear2DInterpolation.DoLookup( lookupPointRow, lookupPointColumn );
}
}
-private:
-protected:
-
+ private:
+ protected:
// Attributes
- lookup::Linear2DInterpolation<T> myLinear2DInterpolation;
-
+ lookup::Linear2DInterpolation< T > myLinear2DInterpolation;
};
-}; // namespace lookup
+}; // namespace lookup
#endif /* _LOOKUPTYPE_ */
diff --git a/src/misc/rainflow.cpp b/src/misc/rainflow.cpp
index a50ec0664209a6a3c58d85eb65adab84babce3d5..bb60829edd49e1fab0fc16be57d5460d7612f6c5 100644
--- a/src/misc/rainflow.cpp
+++ b/src/misc/rainflow.cpp
@@ -8,7 +8,7 @@ namespace rainflow
typedef std::vector< double >::const_iterator valuesIt;
typedef std::vector< std::vector< double >::const_iterator >::iterator reversalsIt;
-// rainflow implementation according to ASTM E1049-85
+/// rainflow implementation according to ASTM E1049-85
std::vector< Cycle > countCycles( const std::vector< double > &values )
{
if ( values.size() < 2 )
@@ -136,4 +136,4 @@ std::vector< Cycle > countCycles( const std::vector< double > &values )
return cycles;
}
-}
+} // namespace rainflow
diff --git a/src/state/soc.h b/src/state/soc.h
index 6975228adfd16443b79858b3e8edcc8a423d8203..8f82571d4552b68040ae5149062fd9a616992f57 100644
--- a/src/state/soc.h
+++ b/src/state/soc.h
@@ -89,7 +89,7 @@ class Soc : public State
double mActualCapacity; // [As]
double mActualSoc; // [%]
- // portion of the soc that is caused by an offset from aging. This offset is already included in mActualSoc.
+ /// portion of the soc that is caused by an offset from aging. This offset is already included in mActualSoc.
double mOffset; // [%]
const double mMinimumValue;
diff --git a/src/thermal/thermal_simulation.h b/src/thermal/thermal_simulation.h
index d2480043ccde12530d92a1182ec378d5207e618a..12e488b651652ddc04afa35aae8fa2e1ebf01818 100644
--- a/src/thermal/thermal_simulation.h
+++ b/src/thermal/thermal_simulation.h
@@ -310,11 +310,11 @@ ThermalSimulation< Matrix, T, filterTypeChoice >::ThermalSimulation(
if ( mThermalSystem->GetOdeSystemSize() > maxOdeSize ) // Arbitrary limit for conductivty matrix
{
// Not feasable!! Memory is not cheap enough
- *conductivity = {1, std::vector< double >( 1, 0 )};
+ *conductivity = { 1, std::vector< double >( 1, 0 ) };
}
else
{
- *conductivity = {mThermalSystem->GetOdeSystemSize(), std::vector< double >( mThermalSystem->GetOdeSystemSize(), 0 )};
+ *conductivity = { mThermalSystem->GetOdeSystemSize(), std::vector< double >( mThermalSystem->GetOdeSystemSize(), 0 ) };
const auto &conMat = mThermalSystem->GetA_th_Conductivity();
for ( size_t i = 0; i < mThermalSystem->GetOdeSystemSize(); ++i )
{
diff --git a/src/unittests/aging/TestCalendarianAging.cpp b/src/unittests/aging/TestCalendarianAging.cpp
index f11d2c3662858d7c976acf55c35b5e761dbe3d93..ed94cd3400688f923a41f357ce2a6eac4e6da666 100644
--- a/src/unittests/aging/TestCalendarianAging.cpp
+++ b/src/unittests/aging/TestCalendarianAging.cpp
@@ -73,7 +73,7 @@ void TestCalendarianAging::testAgingCalculation()
double alphaRes = ( ( 0.00015 * ( 3.8 + 300 - 300 ) ) * 3.0 + ( 0.00015 * ( 4.1 + 296 - 300 ) ) * 4.2 ) / ( 3.0 + 4.2 );
double cap = 1 - pow( pow( 1 - initialCap, 1 / exponent ) + ( steptime * pow( alphaCap, 1 / exponent ) ), exponent );
double res = 1 + pow( pow( initialRes - 1, 1 / exponent ) + ( steptime * pow( alphaRes, 1 / exponent ) ), exponent );
- double socOffset = 3600 * ( cap - 1.0 ) * totalCap * soc / 100;
+ double socOffset = 3600 * ( cap - initialCap ) * totalCap * soc / 100;
TS_ASSERT_DELTA( aging.GetCapacityFactor(), cap, 1e-6 );
TS_ASSERT_DELTA( aging.GetSocOffset(), socOffset, 1e-6 );
@@ -134,7 +134,7 @@ void TestCalendarianAging::testReset()
double alphaRes = ( ( 0.00015 * ( 3.8 + 300 - 300 ) ) * 3 + ( 0.00015 * ( 4.1 + 296 - 300 ) ) * 4.2 ) / ( 3 + 4.2 );
double cap = 1 - pow( pow( 1 - initialCap, 1 / exponent ) + ( steptime * pow( alphaCap, 1 / exponent ) ), exponent );
double res = 1 + pow( pow( initialRes - 1, 1 / exponent ) + ( steptime * pow( alphaRes, 1 / exponent ) ), exponent );
- double socOffset = 3600 * ( cap - 1.0 ) * totalCap * soc / 100;
+ double socOffset = 3600 * ( cap - initialCap ) * totalCap * soc / 100;
TS_ASSERT_DELTA( aging.GetCapacityFactor(), cap, 1e-6 );
TS_ASSERT_DELTA( aging.GetSocOffset(), socOffset, 1e-6 );
diff --git a/src/unittests/aging/TestCyclicalAging.cpp b/src/unittests/aging/TestCyclicalAging.cpp
index d77bcdbb2c58f615d53084a9ad0cb68557aabbd5..2de619b4a0f5975309538a21d653a2158648fad5 100644
--- a/src/unittests/aging/TestCyclicalAging.cpp
+++ b/src/unittests/aging/TestCyclicalAging.cpp
@@ -84,7 +84,7 @@ void TestCyclicalAging::testAgingCalculation()
aging.CalculateAging( tpState, 16.2, steptime * 86400 / 16.2 );
double cap = 0.6599;
double res = 1.3458;
- double socOffset = 3600 * ( aging.GetCapacityFactor() - 1.0 ) * totalCap * soc / 100;
+ double socOffset = 3600 * ( aging.GetCapacityFactor() - initialCap ) * totalCap * soc / 100;
TS_ASSERT_DELTA( aging.GetCapacityFactor(), cap, 1e-3 );
TS_ASSERT_DELTA( aging.GetSocOffset(), socOffset, 1e-3 );
@@ -145,7 +145,7 @@ void TestCyclicalAging::testReset()
aging.CalculateAging( tpState, 16.2, steptime * 86400 / 16.2 );
double cap = 0.6599;
double res = 1.3458;
- double socOffset = 3600 * ( aging.GetCapacityFactor() - 1.0 ) * totalCap * soc / 100;
+ double socOffset = 3600 * ( aging.GetCapacityFactor() - initialCap ) * totalCap * soc / 100;
TS_ASSERT_DELTA( aging.GetCapacityFactor(), cap, 1e-3 );
TS_ASSERT_DELTA( aging.GetSocOffset(), socOffset, 1e-3 );