diff --git a/.gitignore b/.gitignore
index fc6db98a450eb3924d4a2d3fded0a8949f134b3c..989e864695220b1753aca73c87521cd5e1fb8a65 100644
--- a/.gitignore
+++ b/.gitignore
@@ -57,10 +57,6 @@ Sources/build_configuration_*
# Documentation
-Documentation/latex/Pdf
-Documentation/Doxygen/html
-Documentation/Doxygen/latex
-Documentation/Doxygen/my_happy_heart.dox
Documentation/*/*.out
Documentation/*/*.pdf
Documentation/*/*/*.pdf
@@ -73,3 +69,8 @@ Documentation/Uml/Png
# Typical model instance used to check XCode templates.
Sources/ModelInstances/TestXCodeTemplate
+
+# Doxygen: ignore the generated documentation folder.
+Documentation/Doxygen/Complete
+Documentation/Doxygen/Advanced
+Documentation/Doxygen/Basic
diff --git a/Documentation/Doxygen/README.md b/Documentation/Doxygen/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..2e1bd2f2eea8b220d19fb5717ac18a89e1c0a247
--- /dev/null
+++ b/Documentation/Doxygen/README.md
@@ -0,0 +1,16 @@
+There are three developer's guide present here:
+
+## Basic developer's guide
+
+This guide is for someone who intends to create a simple enough model, in which for instance all finite elements and all operators do already exist in the library. All the models given in ModelInstances qualify for this basic level!
+
+## Advanced developer's guide
+
+The following step is for developers already at ease with MoReFEM; in Advanced level you might for instance declare yourself a brand new operator.
+
+Within the code, all the new content is embraced in the _Advanced_ namespace.
+
+## Complete developer's guide
+
+This guide is intended to developers of Morefem library itself and documents anything related to MoReFEM, including under-the-hood mechanisms. It should be reserved only to developer who tinkers with the core of the library and to no use to a developer writing a Model.
+
diff --git a/Documentation/Doxygen/morefem.dox b/Documentation/Doxygen/advanced_dev_guide.dox
similarity index 99%
rename from Documentation/Doxygen/morefem.dox
rename to Documentation/Doxygen/advanced_dev_guide.dox
index 35cdb6a2509eb0fea8cf8e71f0fc9d9e99d967df..a3d2e7907cd621bb534b3e24806cf5f24ad00c6a 100644
--- a/Documentation/Doxygen/morefem.dox
+++ b/Documentation/Doxygen/advanced_dev_guide.dox
@@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.
-PROJECT_NAME = "MoReFEM
+PROJECT_NAME = "MoReFEM"
# 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
@@ -58,7 +58,7 @@ PROJECT_LOGO =
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.
-OUTPUT_DIRECTORY = /Volumes/Data/sebastien/Morefem/Doxygen
+OUTPUT_DIRECTORY = Advanced
# 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
@@ -497,7 +497,7 @@ HIDE_IN_BODY_DOCS = NO
# will be excluded. Set it to YES to include the internal documentation.
# The default value is: NO.
-INTERNAL_DOCS = YES
+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
@@ -754,7 +754,7 @@ WARN_FORMAT = "$file:$line: $text"
# messages should be written. If left blank the output is written to standard
# error (stderr).
-WARN_LOGFILE = "warnings.txt"
+WARN_LOGFILE = "advanced.log"
#---------------------------------------------------------------------------
# Configuration options related to the input files
@@ -766,18 +766,8 @@ WARN_LOGFILE = "warnings.txt"
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
-INPUT = ../../Sources/Utilities \
- ../../Sources/ThirdParty \
- ../../Sources/Core \
- ../../Sources/Geometry \
- ../../Sources/FiniteElement \
- ../../Sources/Parameters \
- ../../Sources/Operators \
- ../../Sources/ParameterInstances \
- ../../Sources/OperatorInstances \
- ../../Sources/FormulationSolver \
- ../../Sources/Model \
- ../../Sources/PostProcessing
+INPUT = ../../Sources \
+ ../../README.md
# 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
@@ -835,7 +825,7 @@ EXCLUDE_SYMLINKS = NO
# exclude all test directories for example use the pattern */test/*
EXCLUDE_PATTERNS = *ThirdParty/Source* \
- *ModelInstances*
+ */Internal/*
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
@@ -926,9 +916,9 @@ 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.
+# and want to reuse the introduction page also for the Doxygen output.
-USE_MDFILE_AS_MAINPAGE =
+USE_MDFILE_AS_MAINPAGE = ../../README.md
#---------------------------------------------------------------------------
# Configuration options related to source browsing
@@ -1558,7 +1548,7 @@ EXTERNAL_SEARCH = NO
# Searching" for details.
# This tag requires that the tag SEARCHENGINE is set to YES.
-SEARCHENGINE_URL =
+SEARCHENGINE_URL = doxysearch
# 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
@@ -1574,7 +1564,7 @@ SEARCHDATA_FILE = searchdata.xml
# projects and redirect the results back to the right project.
# This tag requires that the tag SEARCHENGINE is set to YES.
-EXTERNAL_SEARCH_ID =
+EXTERNAL_SEARCH_ID = MoReFEM
# 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
@@ -1593,7 +1583,7 @@ EXTRA_SEARCH_MAPPINGS =
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
# The default value is: YES.
-GENERATE_LATEX = NO
+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
diff --git a/Documentation/Doxygen/basic_dev_guide.dox b/Documentation/Doxygen/basic_dev_guide.dox
new file mode 100644
index 0000000000000000000000000000000000000000..bdcee76e6581f88d7a33b35d0deac7b928c992bd
--- /dev/null
+++ b/Documentation/Doxygen/basic_dev_guide.dox
@@ -0,0 +1,2405 @@
+# Doxyfile 1.8.11
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project.
+#
+# 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 (\" \").
+
+#---------------------------------------------------------------------------
+# 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.
+# 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
+# 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 = "MoReFEM"
+
+# 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 =
+
+# 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 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) 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 = Basic
+
+# 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 = YES
+
+# 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, 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, 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 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
+# 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
+# operators of the base classes will not be shown.
+# The default value is: NO.
+
+INLINE_INHERITED_MEMB = YES
+
+# 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
+
+# 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 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 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-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 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 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 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.
+# 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.
+# Minimum value: 1, maximum value: 16, default value: 4.
+
+TAB_SIZE = 4
+
+# 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 = "accessor{1}=\brief Constant accessor to \1 \n\n \return \1" \
+ "non_cst_accessor{1}=\brief Non constant accessor to \1 \n\n \return Reference to \1"
+
+# 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 = YES
+
+# 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. 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.
+# 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,
+# 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 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);
+# 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
+# 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 (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 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 = NO
+
+# 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
+
+# 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 = YES
+
+# 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).
+#
+# 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
+# types are typedef'ed and only the typedef is referenced, never the tag name.
+# The default value is: NO.
+
+TYPEDEF_HIDES_STRUCT = YES
+
+# 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 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 = NO
+
+# 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
+# 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 = 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. Does not have any effect
+# for Java sources.
+# The default value is: YES.
+
+EXTRACT_LOCAL_CLASSES = NO
+
+# 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 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 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, 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, 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, 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 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
+# and Mac users are advised to set this option to NO.
+# The default value is: system dependent.
+
+CASE_SENSE_NAMES = NO
+
+# 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 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 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 = 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.
+# The default value is: NO.
+
+FORCE_LOCAL_INCLUDES = NO
+
+# 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 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 = NO
+
+# 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 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 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 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.
+# 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 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 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 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 default value is: YES.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# 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 =
+
+# 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
+# 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 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 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. 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 =
+
+# 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
+#---------------------------------------------------------------------------
+
+# 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 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 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 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
+
+# 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 = YES
+
+# 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 standard
+# error (stderr).
+
+WARN_LOGFILE = "basic.log"
+
+#---------------------------------------------------------------------------
+# Configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# 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 = ../../Sources \
+ ../../README.md
+
+# 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 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, *.f90, *.f, *.for, *.tcl, *.vhd,
+# *.vhdl, *.ucf, *.qsf, *.as and *.js.
+
+FILE_PATTERNS = *.hpp \
+ *.doxygen
+
+# 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
+# run.
+
+EXCLUDE =
+
+# 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/*
+
+EXCLUDE_PATTERNS = *ThirdParty/Source* \
+ */Internal/* \
+ */Advanced/*
+
+# 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 = doxygen_hide_*
+
+# The EXAMPLE_PATH tag can be used to specify one or more files or directories
+# that contain example code fragments that are included (see the \include
+# command).
+
+EXAMPLE_PATH =
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
+# *.h) to filter out the source-files in the directories. If left blank all
+# files are included.
+
+EXAMPLE_PATTERNS =
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+# searched for input files to be used with the \include or \dontinclude commands
+# irrespective of the value of the RECURSIVE tag.
+# The default value is: NO.
+
+EXAMPLE_RECURSIVE = NO
+
+# 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 =
+
+# 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.
+
+FILTER_PATTERNS =
+
+# 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_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 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 = ../../README.md
+
+#---------------------------------------------------------------------------
+# 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 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,
+# classes and enums directly into the documentation.
+# The default value is: NO.
+
+INLINE_SOURCES = NO
+
+# 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.
+# 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.
+# The default value is: NO.
+
+REFERENCES_RELATION = NO
+
+# 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 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 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
+
+#---------------------------------------------------------------------------
+# 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.
+# The default value is: YES.
+
+ALPHABETICAL_INDEX = YES
+
+# 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 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
+#---------------------------------------------------------------------------
+
+# 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.
+# 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).
+# 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 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.
+# 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.
+# 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 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
+# 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.
+# 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 = YES
+
+# 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"
+
+# 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 = com.Inria.MoReFEM
+
+# 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 = com.Inria.M3DISIM
+
+# 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 = M3DISIM
+
+# 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
+
+# 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 =
+
+# 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 =
+
+# 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
+
+# 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 =
+
+# 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 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.
+# 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.
+# 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 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 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 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_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. 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 =
+
+# 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, 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. 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
+
+# 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. 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 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.
+# Minimum value: 0, maximum value: 1500, default value: 250.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+TREEVIEW_WIDTH = 250
+
+# 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. 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 = 10
+
+# 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 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 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://cdn.mathjax.org/mathjax/latest
+
+# 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 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 = doxysearch
+
+# 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 = MoReFEM
+
+# 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
+#---------------------------------------------------------------------------
+
+# 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.
+# 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.
+#
+# 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.
+# 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.
+# 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 (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 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.
+
+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, 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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_BATCHMODE = NO
+
+# 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 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
+#---------------------------------------------------------------------------
+
+# 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.
+# 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.
+# 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 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.
+#
+# 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. 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
+#---------------------------------------------------------------------------
+
+# 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. 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. 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
+
+# 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
+#---------------------------------------------------------------------------
+
+# 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.
+# The default directory is: xml.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_OUTPUT = xml
+
+# 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
+#---------------------------------------------------------------------------
+
+# 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.
+
+GENERATE_DOCBOOK = NO
+
+# 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.
+
+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
+#---------------------------------------------------------------------------
+
+# 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
+#---------------------------------------------------------------------------
+
+# 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.
+# 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.
+# 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.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# 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, 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.
+# 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 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.
+# 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.
+# 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 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 =
+
+# 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 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 options related to external references
+#---------------------------------------------------------------------------
+
+# 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 =
+
+# 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 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.
+# 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').
+# The default file (with absolute path) is: /usr/bin/perl.
+
+PERL_PATH = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+# 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
+# default search path.
+
+MSCGEN_PATH =
+
+# 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 (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: NO.
+
+HAVE_DOT = YES
+
+# 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
+
+# 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 (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 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 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 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 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
+# 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 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 = YES
+
+# 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 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 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 = NO
+
+# 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 = NO
+
+# 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 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. 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, jpg, gif, 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 = svg
+
+# 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 = YES
+
+# 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 =
+
+# 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).
+
+MSCFILE_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).
+
+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 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
+# 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).
+# 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 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 = YES
+
+# 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, 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/Documentation/Doxygen/complete_dev_guide.dox b/Documentation/Doxygen/complete_dev_guide.dox
new file mode 100644
index 0000000000000000000000000000000000000000..6bb1d47c7ef2301592f990a2abf3afc88444fa66
--- /dev/null
+++ b/Documentation/Doxygen/complete_dev_guide.dox
@@ -0,0 +1,2403 @@
+# Doxyfile 1.8.11
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project.
+#
+# 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 (\" \").
+
+#---------------------------------------------------------------------------
+# 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.
+# 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
+# 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 = "MoReFEM"
+
+# 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 =
+
+# 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 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) 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 = Complete
+
+# 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 = YES
+
+# 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, 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, 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 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
+# 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
+# operators of the base classes will not be shown.
+# The default value is: NO.
+
+INLINE_INHERITED_MEMB = YES
+
+# 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
+
+# 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 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 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-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 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 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 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.
+# 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.
+# Minimum value: 1, maximum value: 16, default value: 4.
+
+TAB_SIZE = 4
+
+# 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 = "accessor{1}=\brief Constant accessor to \1 \n\n \return \1" \
+ "non_cst_accessor{1}=\brief Non constant accessor to \1 \n\n \return Reference to \1"
+
+# 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 = YES
+
+# 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. 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.
+# 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,
+# 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 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);
+# 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
+# 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 (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 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 = NO
+
+# 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
+
+# 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 = YES
+
+# 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).
+#
+# 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
+# types are typedef'ed and only the typedef is referenced, never the tag name.
+# The default value is: NO.
+
+TYPEDEF_HIDES_STRUCT = YES
+
+# 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 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 = NO
+
+# 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
+# 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 = 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. Does not have any effect
+# for Java sources.
+# The default value is: YES.
+
+EXTRACT_LOCAL_CLASSES = NO
+
+# 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 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 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, 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, 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, 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 then the documentation
+# will be excluded. Set it to YES to include the internal documentation.
+# The default value is: NO.
+
+INTERNAL_DOCS = YES
+
+# 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 = NO
+
+# 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 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 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 = 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.
+# The default value is: NO.
+
+FORCE_LOCAL_INCLUDES = NO
+
+# 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 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 = NO
+
+# 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 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 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 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.
+# 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 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 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 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 default value is: YES.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# 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 =
+
+# 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
+# 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 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 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. 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 =
+
+# 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
+#---------------------------------------------------------------------------
+
+# 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 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 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 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
+
+# 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 = YES
+
+# 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 standard
+# error (stderr).
+
+WARN_LOGFILE = "complete.log"
+
+#---------------------------------------------------------------------------
+# Configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# 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 = ../../Sources \
+ ../../README.md
+
+# 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 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, *.f90, *.f, *.for, *.tcl, *.vhd,
+# *.vhdl, *.ucf, *.qsf, *.as and *.js.
+
+FILE_PATTERNS = *.hpp \
+ *.doxygen
+
+# 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
+# run.
+
+EXCLUDE =
+
+# 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/*
+
+EXCLUDE_PATTERNS = *ThirdParty/Source*
+
+# 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 = doxygen_hide_*
+
+# The EXAMPLE_PATH tag can be used to specify one or more files or directories
+# that contain example code fragments that are included (see the \include
+# command).
+
+EXAMPLE_PATH =
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
+# *.h) to filter out the source-files in the directories. If left blank all
+# files are included.
+
+EXAMPLE_PATTERNS =
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+# searched for input files to be used with the \include or \dontinclude commands
+# irrespective of the value of the RECURSIVE tag.
+# The default value is: NO.
+
+EXAMPLE_RECURSIVE = NO
+
+# 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 =
+
+# 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.
+
+FILTER_PATTERNS =
+
+# 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_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 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 = ../../README.md
+
+#---------------------------------------------------------------------------
+# 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 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,
+# classes and enums directly into the documentation.
+# The default value is: NO.
+
+INLINE_SOURCES = NO
+
+# 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.
+# 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.
+# The default value is: NO.
+
+REFERENCES_RELATION = NO
+
+# 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 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 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
+
+#---------------------------------------------------------------------------
+# 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.
+# The default value is: YES.
+
+ALPHABETICAL_INDEX = YES
+
+# 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 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
+#---------------------------------------------------------------------------
+
+# 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.
+# 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).
+# 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 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.
+# 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.
+# 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 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
+# 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.
+# 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 = YES
+
+# 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"
+
+# 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 = com.Inria.MoReFEM
+
+# 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 = com.Inria.M3DISIM
+
+# 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 = M3DISIM
+
+# 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
+
+# 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 =
+
+# 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 =
+
+# 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
+
+# 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 =
+
+# 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 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.
+# 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.
+# 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 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 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 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_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. 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 =
+
+# 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, 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. 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
+
+# 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. 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 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.
+# Minimum value: 0, maximum value: 1500, default value: 250.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+TREEVIEW_WIDTH = 250
+
+# 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. 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 = 10
+
+# 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 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 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://cdn.mathjax.org/mathjax/latest
+
+# 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 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 = doxysearch
+
+# 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 = MoReFEM
+
+# 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
+#---------------------------------------------------------------------------
+
+# 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.
+# 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.
+#
+# 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.
+# 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.
+# 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 (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 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.
+
+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, 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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_BATCHMODE = NO
+
+# 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 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
+#---------------------------------------------------------------------------
+
+# 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.
+# 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.
+# 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 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.
+#
+# 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. 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
+#---------------------------------------------------------------------------
+
+# 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. 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. 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
+
+# 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
+#---------------------------------------------------------------------------
+
+# 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.
+# The default directory is: xml.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_OUTPUT = xml
+
+# 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
+#---------------------------------------------------------------------------
+
+# 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.
+
+GENERATE_DOCBOOK = NO
+
+# 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.
+
+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
+#---------------------------------------------------------------------------
+
+# 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
+#---------------------------------------------------------------------------
+
+# 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.
+# 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.
+# 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.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# 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, 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.
+# 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 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.
+# 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.
+# 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 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 =
+
+# 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 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 options related to external references
+#---------------------------------------------------------------------------
+
+# 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 =
+
+# 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 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.
+# 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').
+# The default file (with absolute path) is: /usr/bin/perl.
+
+PERL_PATH = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+# 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
+# default search path.
+
+MSCGEN_PATH =
+
+# 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 (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: NO.
+
+HAVE_DOT = YES
+
+# 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
+
+# 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 (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 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 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 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 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
+# 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 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 = YES
+
+# 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 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 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 = NO
+
+# 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 = NO
+
+# 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 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. 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, jpg, gif, 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 = svg
+
+# 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 = YES
+
+# 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 =
+
+# 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).
+
+MSCFILE_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).
+
+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 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
+# 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).
+# 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 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 = YES
+
+# 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, 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/MoReFEM.xcodeproj/project.pbxproj b/MoReFEM.xcodeproj/project.pbxproj
index dfc9e3ded5c406d82a35da1ea3d7e0becff4e6e6..ef2a24d2de88c8dc5613e929b922a14d7a407bc3 100644
--- a/MoReFEM.xcodeproj/project.pbxproj
+++ b/MoReFEM.xcodeproj/project.pbxproj
@@ -1115,6 +1115,8 @@
BE7C949C1F605266003D2C52 /* GradPhiTauTauGradPhi.hxx in Headers */ = {isa = PBXBuildFile; fileRef = BE7C94961F605266003D2C52 /* GradPhiTauTauGradPhi.hxx */; };
BE80EE591DE72A88005502B4 /* ScalarTransientSource.hpp in Headers */ = {isa = PBXBuildFile; fileRef = BE80EE571DE72A88005502B4 /* ScalarTransientSource.hpp */; };
BE80EE5A1DE72A88005502B4 /* ScalarTransientSource.hxx in Headers */ = {isa = PBXBuildFile; fileRef = BE80EE581DE72A88005502B4 /* ScalarTransientSource.hxx */; };
+ BE83582B1FFD779E0009956E /* Sort.hpp in Headers */ = {isa = PBXBuildFile; fileRef = BE83582A1FFD779E0009956E /* Sort.hpp */; };
+ BE83582D1FFD78DE0009956E /* Sort.hxx in Headers */ = {isa = PBXBuildFile; fileRef = BE83582C1FFD78DD0009956E /* Sort.hxx */; };
BE8553A91BBD77BF00DB109E /* DofSource.cpp in Sources */ = {isa = PBXBuildFile; fileRef = BE8553A31BBD77BF00DB109E /* DofSource.cpp */; };
BE8553AA1BBD77BF00DB109E /* DofSource.hpp in Headers */ = {isa = PBXBuildFile; fileRef = BE8553A41BBD77BF00DB109E /* DofSource.hpp */; };
BE8553AB1BBD77BF00DB109E /* DofSource.hxx in Headers */ = {isa = PBXBuildFile; fileRef = BE8553A51BBD77BF00DB109E /* DofSource.hxx */; };
@@ -4534,6 +4536,7 @@
BE168F071CC97F120090AC88 /* Triangle6.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; lineEnding = 0; path = Triangle6.cpp; sourceTree = "<group>"; xcLanguageSpecificationIdentifier = xcode.lang.cpp; };
BE168F081CC97F120090AC88 /* Triangle6.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = Triangle6.hpp; sourceTree = "<group>"; };
BE1798131E316640004326D2 /* Traits.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = Traits.hpp; sourceTree = "<group>"; };
+ BE18EB0C2003A21E002FEC2C /* ModelInstances.doxygen */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = ModelInstances.doxygen; sourceTree = "<group>"; };
BE19AB511A37354100EAF725 /* SegmentP1.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = SegmentP1.cpp; sourceTree = "<group>"; };
BE19AB521A37354100EAF725 /* SegmentP1.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = SegmentP1.hpp; sourceTree = "<group>"; };
BE1ABAB71B9DC6FC00A7DBD8 /* TestInterpolatorP1_to_P2 */ = {isa = PBXFileReference; explicitFileType = "compiled.mach-o.executable"; includeInIndex = 0; path = TestInterpolatorP1_to_P2; sourceTree = BUILT_PRODUCTS_DIR; };
@@ -5163,8 +5166,11 @@
BE7DE82A19CC541D00D24C7D /* Comm.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = Comm.cpp; sourceTree = "<group>"; };
BE7DE82B19CC541D00D24C7D /* Comm.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = Comm.hpp; sourceTree = "<group>"; };
BE80308718E43CAE00B4CA03 /* Interface.hxx */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.h; path = Interface.hxx; sourceTree = "<group>"; };
+ BE8058C91FF7DA5C008E97D2 /* Test.doxygen */ = {isa = PBXFileReference; lastKnownFileType = text; path = Test.doxygen; sourceTree = "<group>"; };
BE80EE571DE72A88005502B4 /* ScalarTransientSource.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; name = ScalarTransientSource.hpp; path = Parameter/Source/ScalarTransientSource.hpp; sourceTree = "<group>"; };
BE80EE581DE72A88005502B4 /* ScalarTransientSource.hxx */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; name = ScalarTransientSource.hxx; path = Parameter/Source/ScalarTransientSource.hxx; sourceTree = "<group>"; };
+ BE83582A1FFD779E0009956E /* Sort.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = Sort.hpp; sourceTree = "<group>"; };
+ BE83582C1FFD78DD0009956E /* Sort.hxx */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = Sort.hxx; sourceTree = "<group>"; };
BE8553A31BBD77BF00DB109E /* DofSource.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = DofSource.cpp; sourceTree = "<group>"; };
BE8553A41BBD77BF00DB109E /* DofSource.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = DofSource.hpp; sourceTree = "<group>"; };
BE8553A51BBD77BF00DB109E /* DofSource.hxx */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = DofSource.hxx; sourceTree = "<group>"; };
@@ -7399,6 +7405,8 @@
BE110E8B1E114F1400D2D2C8 /* Internal */ = {
isa = PBXGroup;
children = (
+ BE83582A1FFD779E0009956E /* Sort.hpp */,
+ BE83582C1FFD78DD0009956E /* Sort.hxx */,
BE110E8C1E114F1400D2D2C8 /* TupleHelper.hpp */,
);
path = Internal;
@@ -8428,6 +8436,7 @@
BE372DCD18C47F0500127212 /* Test */ = {
isa = PBXGroup;
children = (
+ BE8058C91FF7DA5C008E97D2 /* Test.doxygen */,
BE6C215D19AF26AE00CC674B /* SConscript */,
BE372DDB18C4802900127212 /* main_test.cpp */,
BE436A151F694FBE003CE8E3 /* Tools */,
@@ -10513,6 +10522,7 @@
BEA0753A186052FB00E83E71 /* ModelInstances */ = {
isa = PBXGroup;
children = (
+ BE18EB0C2003A21E002FEC2C /* ModelInstances.doxygen */,
BE5BE50A19336DF6006BE2BF /* SConscript */,
BE5ECE1219AC852E00C636A7 /* Stokes */,
BE63B4911A31C20E003A6523 /* Elasticity */,
@@ -12430,6 +12440,7 @@
BE90E1CF1A2492AA00CCAFDE /* PetscSys.hpp in Headers */,
BE53FC1F1E0D7F0500C5D6F5 /* PrepareDefaultEntry.hpp in Headers */,
BE90E1AD1A24929A00CCAFDE /* MatrixPattern.hpp in Headers */,
+ BE83582B1FFD779E0009956E /* Sort.hpp in Headers */,
BE145A041E54BC49000A2BF5 /* HelpVisitor.h in Headers */,
BE5B6F911C3C16E9004A0284 /* ShellMatrix.hpp in Headers */,
BE53FC161E0D7C6800C5D6F5 /* TupleIteration.hxx in Headers */,
@@ -12474,6 +12485,7 @@
BE6E4EE21B2ABE8B0049BB2D /* AccessGhostContent.hpp in Headers */,
BE76F24F1D7D5D900061B50E /* LocalMatrixStorage.hxx in Headers */,
BE90E1621A24926E00CCAFDE /* Exception.hpp in Headers */,
+ BE83582D1FFD78DE0009956E /* Sort.hxx in Headers */,
BEDEB92A1C3C073100B1C71B /* Umfpack.hxx in Headers */,
BE90E16A1A24926E00CCAFDE /* Sort.hpp in Headers */,
135F21441E7ADB2A00B9E633 /* Viscoelasticity.hpp in Headers */,
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..102f9085fbcc4de8bdba78c2ff58e33dd0174472
--- /dev/null
+++ b/README.md
@@ -0,0 +1 @@
+A HPC finite element library developed for the implementation of the models of M3DISIM Inria team.
diff --git a/Sources/Core/Core.doxygen b/Sources/Core/Core.doxygen
index 1367e27bf678cfff9f17fc75da09bb2e7cd74837..3e3e03bcbeacaed2c1d7f9932d71d554ea100524 100644
--- a/Sources/Core/Core.doxygen
+++ b/Sources/Core/Core.doxygen
@@ -26,3 +26,119 @@
/// \namespace MoReFEM::TimeManagerNS::Policy
/// \brief Namespace that enclose time step policies related to TimeManager.
+
+
+
+/*!
+ *
+ * \class doxygen_hide_input_parameter_data_arg
+ *
+ * \param[in] input_parameter_data Object which hold the values of all the parameters defined in
+ * the input file.
+ */
+
+
+/*!
+ *
+ * \class doxygen_hide_morefem_data_param
+ *
+ * \param[in] morefem_data Object which hold few objects (mpi, input parameter file, Petsc helper and directory into
+ * which results are stored) that are almost global variables.
+ */
+
+
+/*!
+ * \class doxygen_hide_mesh_enum
+ *
+ * \brief Enum used to index the available meshes.
+ */
+
+
+/*!
+ * \class doxygen_hide_domain_enum
+ *
+ * \brief Enum used to index the available domains.
+ */
+
+
+/*!
+ * \class doxygen_hide_felt_space_enum
+ *
+ * \brief Enum used to index the available finite element spaces.
+ */
+
+
+/*!
+ * \class doxygen_hide_unknown_enum
+ *
+ * \brief Enum used to index the available unknowns.
+ */
+
+
+/*!
+ * \class doxygen_hide_solver_enum
+ *
+ * \brief Enum used to index the available solvers.
+ */
+
+
+/*!
+ * \class doxygen_hide_numbering_subset_enum
+ *
+ * \brief Enum used to index the available numbering subsets.
+ */
+
+/*!
+ * \class doxygen_hide_source_enum
+ *
+ * \brief Enum used to index the available sources.
+ */
+
+/*!
+ * \class doxygen_hide_boundary_condition_enum
+ *
+ * \brief Enum used to index the available boundary conditions.
+ */
+
+
+/*!
+ * \class doxygen_hide_input_parameter_tuple
+ *
+ * \brief Tuple which enumerates all the quantities that are addressed in the input file.
+ *
+ */
+
+
+/*!
+ * \class doxygen_hide_initial_condition_enum
+ *
+ * \brief Enum used to index the available initial conditions.
+ *
+ */
+
+
+/*!
+ * \class doxygen_hide_model_specific_input_parameter_list
+ *
+ * \brief The input parameter list object required for the current test or model.
+ *
+ */
+
+
+
+/*!
+ * \class doxygen_hide_fiber_enum
+ *
+ * \brief Enum used to index the available fibers.
+ *
+ */
+
+/*!
+ * \class doxygen_hide_morefem_data_type
+ *
+ * \brief The MoReFEMDataType object required for the current test or model.
+ *
+ */
+
+
+
diff --git a/Sources/Core/InitTimeKeepLog.cpp b/Sources/Core/InitTimeKeepLog.cpp
index b8d809cdbdd6dbe3af640b0ee66181fa5b2a32f2..fef2eb134c0f97ae507fe67f0c6bec0f2cb658d3 100644
--- a/Sources/Core/InitTimeKeepLog.cpp
+++ b/Sources/Core/InitTimeKeepLog.cpp
@@ -5,7 +5,9 @@
/// Created by Sebastien Gilles <sebastien.gilles@inria.fr> on the Wed, 7 Jan 2015 14:19:22 +0100
/// Copyright (c) Inria. All rights reserved.
///
-
+/// \ingroup CoreGroup
+/// \addtogroup CoreGroup
+/// \{
#include "InitTimeKeepLog.hpp"
@@ -34,3 +36,6 @@ namespace MoReFEM
} // namespace MoReFEM
+
+
+/// @} // addtogroup CoreGroup
diff --git a/Sources/Core/InputParameterData/InputParameterList.hpp b/Sources/Core/InputParameterData/InputParameterList.hpp
index c482f013079eba6886ac017dd39cbc339e79c75d..978377da2ac4c4912932dc452433ec76e64742d0 100644
--- a/Sources/Core/InputParameterData/InputParameterList.hpp
+++ b/Sources/Core/InputParameterData/InputParameterList.hpp
@@ -33,17 +33,6 @@ namespace MoReFEM
/// \addtogroup CoreGroup
///@{
-
- /*!
- *
- * \class doxygen_hide_input_parameter_data_arg
- *
- * \param[in] input_parameter_data Object which hold the values of all the parameters defined in
- * the input file.
- */
-
-
-
/*!
* \brief This class read the input parameters and then is in charge of holding the values read.
*
diff --git a/Sources/Core/MoReFEMData/MoReFEMData.hpp b/Sources/Core/MoReFEMData/MoReFEMData.hpp
index e3301f2d8b39f29eb09a3db9fe7eecabf6306ecd..180d36dd270d2a72c11c50b874715b27a28c3173 100644
--- a/Sources/Core/MoReFEMData/MoReFEMData.hpp
+++ b/Sources/Core/MoReFEMData/MoReFEMData.hpp
@@ -44,7 +44,8 @@ namespace MoReFEM
* an exception and hence allow the program to stop properly.
*
* \tparam AdditionalCommandLineArgumentsT If not std::false_type, this class must include a static method with
- * prototype
+ * prototype:
+ *
* \code
* static void AdditionalCommandLineArgumentsT::Add(TCLAP::CmdLine& command);
* \endcode
diff --git a/Sources/Core/NumberingSubset/Internal/FetchFunction.hpp b/Sources/Core/NumberingSubset/Internal/FetchFunction.hpp
index 2b397d1d1ba87df0c0d4fa24b61384f55f314541..4ecece1be1c9cb305d4b6f7e518d004a3a7ee8d9 100644
--- a/Sources/Core/NumberingSubset/Internal/FetchFunction.hpp
+++ b/Sources/Core/NumberingSubset/Internal/FetchFunction.hpp
@@ -49,12 +49,13 @@ namespace MoReFEM
/*!
* \brief Returns the requested numbering subset from \a object when T is a pointer or smart pointer.
*
- * \param[in] pointer Pointer or pointer-like to an object that must define a method with prototype
+ * \param[in] pointer Pointer or pointer-like to an object that must define a method with prototype:
+ *
* \code
* const NumberingSubset& GetNumberingSubset() const;
* \endcode
*
- * \return Reference returned by pointer->GetNUmberingSubset().
+ * \return Reference returned by pointer->GetNumberingSubset().
*/
template<class T>
std::enable_if_t
@@ -70,12 +71,13 @@ namespace MoReFEM
* \brief Returns the requested numbering subset from \a object when T is <b>not</b> a pointer or smart
* pointer.
*
- * \param[in] object Object that must define a method with prototype
+ * \param[in] object Object that must define a method with prototype:
+ *
* \code
* const NumberingSubset& GetNumberingSubset() const;
* \endcode
*
- * \return Object returned by object.GetNUmberingSubset().
+ * \return Object returned by object.GetNumberingSubset().
*/
template<class T>
std::enable_if_t
@@ -92,6 +94,7 @@ namespace MoReFEM
*
* \param[in] pointer Pointer or pointer-like to an object that must define methods with following
* prototypes:
+ *
* \code
* const NumberingSubset& GetRowNumberingSubset() const;
* const NumberingSubset& GetColNumberingSubset() const;
@@ -114,6 +117,7 @@ namespace MoReFEM
* pointer.
*
* \param[in] object Object that must define methods with following prototypes:
+ *
* \code
* const NumberingSubset& GetRowNumberingSubset() const;
* const NumberingSubset& GetColNumberingSubset() const;
diff --git a/Sources/Core/TimeManager/TimeManager.doxygen b/Sources/Core/TimeManager/TimeManager.doxygen
index d4d752debf7e30e0af465bf76e79bb33f556b4a7..e7235140dbd978058c0b9887dec893e53ddd1d09 100644
--- a/Sources/Core/TimeManager/TimeManager.doxygen
+++ b/Sources/Core/TimeManager/TimeManager.doxygen
@@ -1,7 +1,7 @@
/*!
* \class doxygen_hide_time_manager_arg
*
- * \param[in] time_manager Object in charge of keeping track of the time-related informations.
+ * \param[in,out] time_manager Object in charge of keeping track of the time-related informations.
*/
@@ -11,4 +11,4 @@
* \brief Object in charge of keeping track of the time-related informations.
*
* \return Reference to the \a TimeManager.
- */
\ No newline at end of file
+ */
diff --git a/Sources/FiniteElement/RefFiniteElement/Internal/BasicRefFElt.hpp b/Sources/FiniteElement/RefFiniteElement/Internal/BasicRefFElt.hpp
index 63b56f2d55a552edc73f636be1050bcdb14ae6dd..39973373afb4f6a94d0e2c2842ac510592b47ad3 100644
--- a/Sources/FiniteElement/RefFiniteElement/Internal/BasicRefFElt.hpp
+++ b/Sources/FiniteElement/RefFiniteElement/Internal/BasicRefFElt.hpp
@@ -195,14 +195,17 @@ namespace MoReFEM
* finite element associated to a quadrangle:
* \param[in] orientation Index which gives away the orientation chosen. See \a OrientedEdge for more
* details.
- *
- * 3-----------2
- * | |
- * | | Edges: { { 0, 1 } },
- * | | { { 1, 2 } },
- * | | { { 3, 2 } },
- * | | { { 0, 3 } }
- * 0-----------1
+
+ \verbatim
+
+ 3-----------2
+ | |
+ | | Edges: { { 0, 1 } },
+ | | { { 1, 2 } },
+ | | { { 3, 2 } },
+ | | { { 0, 3 } }
+ 0-----------1
+ \endverbatim
*
* \return The LocalNode objects associated to this edge (its internal index is the one computed
* within current class).
diff --git a/Sources/FiniteElement/Unknown/EnumUnknown.hpp b/Sources/FiniteElement/Unknown/EnumUnknown.hpp
index 129a9012a5939a399fb4ed6e751e60f1aee09754..e2e33ab39b052cd75cd3db8082a3ac3c2e506964 100644
--- a/Sources/FiniteElement/Unknown/EnumUnknown.hpp
+++ b/Sources/FiniteElement/Unknown/EnumUnknown.hpp
@@ -20,11 +20,7 @@ namespace MoReFEM
namespace UnknownNS
{
-
- /// \addtogroup FiniteElementGroup
- ///@{
-
-
+
/*!
* \brief Possible values for the nature of a given Unknown.
*/
@@ -34,10 +30,7 @@ namespace MoReFEM
vectorial = 1
};
-
- ///@} // \addtogroup
-
-
+
} // namespace UnknownNS
diff --git a/Sources/FiniteElement/Unknown/ExtendedUnknown.hpp b/Sources/FiniteElement/Unknown/ExtendedUnknown.hpp
index a5ec74999f782fac05fa93e7675ca9d82a08586e..aa8e2ae3466fcb75815f9018e04e67f1e4919a15 100644
--- a/Sources/FiniteElement/Unknown/ExtendedUnknown.hpp
+++ b/Sources/FiniteElement/Unknown/ExtendedUnknown.hpp
@@ -19,12 +19,7 @@
namespace MoReFEM
{
-
- /// \addtogroup FiniteElementGroup
- ///@{
-
-
-
+
/*!
* \brief This class encapsulates an unknown in a given finite element space.
*
@@ -108,10 +103,6 @@ namespace MoReFEM
bool operator<(const ExtendedUnknown& lhs, const ExtendedUnknown& rhs);
-
- ///@} // \addtogroup
-
-
} // namespace MoReFEM
diff --git a/Sources/FiniteElement/Unknown/Unknown.hpp b/Sources/FiniteElement/Unknown/Unknown.hpp
index e3fe604531e8d0df45772509647d0bcf169be2f1..ec42738d0e48f46ace828172998c6000c10b0ee2 100644
--- a/Sources/FiniteElement/Unknown/Unknown.hpp
+++ b/Sources/FiniteElement/Unknown/Unknown.hpp
@@ -43,11 +43,7 @@ namespace MoReFEM
//! \endcond IGNORE_BLOCK_IN_DOXYGEN
// ============================
-
- /// \addtogroup FiniteElementGroup
- ///@{
-
-
+
/*!
* \brief Very generic informations about a given unknown.
*
@@ -143,9 +139,6 @@ namespace MoReFEM
const unsigned int mesh_dimension);
- ///@} // \addtogroup
-
-
} // namespace MoReFEM
diff --git a/Sources/FiniteElement/Unknown/UnknownManager.hpp b/Sources/FiniteElement/Unknown/UnknownManager.hpp
index 887f894ab3fb4320d9d7ba61a8eabc46f64c9e1c..a29e1a35d72d8dfb16763ee0a59733486b29148c 100644
--- a/Sources/FiniteElement/Unknown/UnknownManager.hpp
+++ b/Sources/FiniteElement/Unknown/UnknownManager.hpp
@@ -30,10 +30,6 @@ namespace MoReFEM
{
- /// \addtogroup FiniteElementGroup
- ///@{
-
-
/*!
* \brief Singleton that is aware of all considered unknown, regardless of GodOfDof.
*
@@ -152,9 +148,6 @@ namespace MoReFEM
void WriteUnknownList(const std::string& output_directory);
- ///@} // \addtogroup
-
-
} // namespace MoReFEM
diff --git a/Sources/FormulationSolver/VariationalFormulation.doxygen b/Sources/FormulationSolver/VariationalFormulation.doxygen
index 4c009fb756f688611f9ca656b98e7f3d1569d364..473ae32e8c705ca9e32b1c6c2e6498db456223b7 100644
--- a/Sources/FormulationSolver/VariationalFormulation.doxygen
+++ b/Sources/FormulationSolver/VariationalFormulation.doxygen
@@ -21,4 +21,27 @@
///@}
+/*!
+ * \class doxygen_hide_varf_constructor
+ *
+ * \copydoc doxygen_hide_morefem_data_param
+ * \copydoc doxygen_hide_time_manager_arg
+ * \param[in] god_of_dof \a GodOfDof upon which the variational formulation is defined.
+ * \param[in] boundary_condition_list List of Dirichlet boundary conditions to consider (please notice it is also
+ * possible to handle them directly; it is for conveniency it might be given here).
+ */
+
+
+/*!
+ * \class doxygen_hide_varf_suppl_init
+ *
+ * \brief Specific initialisation for derived class attributes.
+ *
+ * \internal <b><tt>[internal]</tt></b> This method is called by base class method VariationalFormulation::Init().
+ *
+ * \copydoc doxygen_hide_input_parameter_data_arg
+ */
+
+
+
diff --git a/Sources/Geometry/Domain/Advanced/LightweightDomainList.hpp b/Sources/Geometry/Domain/Advanced/LightweightDomainList.hpp
index b2338434e5755ca21f36372ec2754beb171bcf6c..fca723e9ceeaf9847f6d1c22ef39e4832fce361d 100644
--- a/Sources/Geometry/Domain/Advanced/LightweightDomainList.hpp
+++ b/Sources/Geometry/Domain/Advanced/LightweightDomainList.hpp
@@ -116,13 +116,13 @@ namespace MoReFEM
* Let's illustrate this by an example:
*
* \verbatim
- * LightweightDomainList1 = {
- *
- * mesh_label_list = { 0, 1, 1, 2, 3, 2, 3 },
- * domain_index_list = { 3, 4, 5, 6 },
- * number_in_domain_list = { 2, 3, 1, 1 }
- * } -- LightweightDomainList1
- * \endverbatim
+ LightweightDomainList1 = {
+
+ mesh_label_list = { 0, 1, 1, 2, 3, 2, 3 },
+ domain_index_list = { 3, 4, 5, 6 },
+ number_in_domain_list = { 2, 3, 1, 1 }
+ } -- LightweightDomainList1
+ \endverbatim
*
* Means that:
* - Domain 3 is composed of \a MeshLabel 0 and 1.
diff --git a/Sources/Geometry/GeometricElt/Advanced/ComputeJacobian.hpp b/Sources/Geometry/GeometricElt/Advanced/ComputeJacobian.hpp
index ee8683548291789007362afd88b93278cf26fd78..12a087bf3abce37a138d4eaf2b29adb7b349ad7a 100644
--- a/Sources/Geometry/GeometricElt/Advanced/ComputeJacobian.hpp
+++ b/Sources/Geometry/GeometricElt/Advanced/ComputeJacobian.hpp
@@ -121,8 +121,8 @@ namespace MoReFEM
LocalMatrix& GetNonCstJacobian() noexcept;
/*!
- * \brief Non constant accessor to the values of the first derivates of the shape function, updated
- * along jacobian_.
+ * \brief Non constant accessor to the values of the first derivates of the shape function,
+ * updated along \a jacobian_.
*
* Likewise, it should not be accessed publicly.
*
diff --git a/Sources/Geometry/Mesh/Internal/Format/Format.doxygen b/Sources/Geometry/Mesh/Internal/Format/Format.doxygen
index da3c78935ad2ced4e2fd5bd665e01f848112caf0..548041a50b4da4d8ffa41594c2154235d661cd99 100644
--- a/Sources/Geometry/Mesh/Internal/Format/Format.doxygen
+++ b/Sources/Geometry/Mesh/Internal/Format/Format.doxygen
@@ -7,7 +7,7 @@
* there only because a reference to the mnesh is required to build a \a MeshLabel.
* \param[in] file Path to the file being read.
* \copydoc doxygen_hide_space_unit_arg
- * \param[out] dimension NUmber of components considered in the Coords objects. It is format_dependant: Ensight
+ * \param[out] dimension Number of components considered in the Coords objects. It is format_dependant: Ensight
* always returns 3 regarless of rthe mesh considered whereas Medit may return 2 or 3.
* \param[out] unsort_element_list List of geometric elements read in the file. No specific order is expected here;
* \a GeometricMeshRegion will anyway reorder them for its own needs.
@@ -44,4 +44,4 @@
* \internal <b><tt>[internal]</tt></b> The parent true_type is extremely important: the operator bool()
* it defines is used within TGeometricElt to check whether the GeometricElt can be manipulated by
* Medit or not.
- */
\ No newline at end of file
+ */
diff --git a/Sources/Geometry/RefGeometricElt/Instances/Hexahedron/Hexahedron20.hpp b/Sources/Geometry/RefGeometricElt/Instances/Hexahedron/Hexahedron20.hpp
index c4ddc5608a1a4491343cbb1f88e5f9a580946331..e404fa66341196084f5263a9e4952d2994039d20 100644
--- a/Sources/Geometry/RefGeometricElt/Instances/Hexahedron/Hexahedron20.hpp
+++ b/Sources/Geometry/RefGeometricElt/Instances/Hexahedron/Hexahedron20.hpp
@@ -44,7 +44,7 @@ namespace MoReFEM
* \endcode
*
* or to be a template parameter to MoReFEM::RefGeomEltNS::Hexahedron20 class (current class is in an
- * additional layer of namespace:
+ * additional layer of namespace):
*
* \code
* MoReFEM::RefGeomEltNS::Traits::Hexahedron20
diff --git a/Sources/Geometry/RefGeometricElt/Instances/Hexahedron/Hexahedron27.hpp b/Sources/Geometry/RefGeometricElt/Instances/Hexahedron/Hexahedron27.hpp
index fac851951e3aa18f49249733e24380366b99b2a1..4962dc6428b2040e6bd7517c793fbd1c22520bf4 100644
--- a/Sources/Geometry/RefGeometricElt/Instances/Hexahedron/Hexahedron27.hpp
+++ b/Sources/Geometry/RefGeometricElt/Instances/Hexahedron/Hexahedron27.hpp
@@ -48,7 +48,7 @@ namespace MoReFEM
* \endcode
*
* or to be a template parameter to MoReFEM::RefGeomEltNS::Hexahedron27 class (current class is in an
- * additional layer of namespace:
+ * additional layer of namespace):
*
* \code
* MoReFEM::RefGeomEltNS::Traits::Hexahedron27
diff --git a/Sources/Geometry/RefGeometricElt/Instances/Hexahedron/Hexahedron8.hpp b/Sources/Geometry/RefGeometricElt/Instances/Hexahedron/Hexahedron8.hpp
index 52b812f59ef90f25bec4374b2321cd8757762ee9..c7ba6583eeefae972eb37ade7fa1829f499fed8a 100644
--- a/Sources/Geometry/RefGeometricElt/Instances/Hexahedron/Hexahedron8.hpp
+++ b/Sources/Geometry/RefGeometricElt/Instances/Hexahedron/Hexahedron8.hpp
@@ -44,7 +44,7 @@ namespace MoReFEM
* \endcode
*
* or to be a template parameter to MoReFEM::RefGeomEltNS::Hexahedron8 class (current class is in an
- * additional layer of namespace:
+ * additional layer of namespace):
*
* \code
* MoReFEM::RefGeomEltNS::Traits::Hexahedron8
diff --git a/Sources/Geometry/RefGeometricElt/Instances/Point/Point1.hpp b/Sources/Geometry/RefGeometricElt/Instances/Point/Point1.hpp
index 378d082832e2d518c5daa413a05d6604edfea06b..b4f7ebec9858515c2e5e24838c5d12e43cad961c 100644
--- a/Sources/Geometry/RefGeometricElt/Instances/Point/Point1.hpp
+++ b/Sources/Geometry/RefGeometricElt/Instances/Point/Point1.hpp
@@ -45,7 +45,7 @@ namespace MoReFEM
* \endcode
*
* or to be a template parameter to MoReFEM::RefGeomEltNS::Point1 class (current class is in an
- * additional layer of namespace:
+ * additional layer of namespace):
*
* \code
* MoReFEM::RefGeomEltNS::Traits::Point1
diff --git a/Sources/Geometry/RefGeometricElt/Instances/Quadrangle/Quadrangle4.hpp b/Sources/Geometry/RefGeometricElt/Instances/Quadrangle/Quadrangle4.hpp
index b03d808435b4386dde5d5501481b948cefe37c46..a02926f964191e8eb5cc4e718124b44c0c402771 100644
--- a/Sources/Geometry/RefGeometricElt/Instances/Quadrangle/Quadrangle4.hpp
+++ b/Sources/Geometry/RefGeometricElt/Instances/Quadrangle/Quadrangle4.hpp
@@ -45,7 +45,7 @@ namespace MoReFEM
* \endcode
*
* or to be a template parameter to MoReFEM::RefGeomEltNS::Quadrangle4 class (current class is in an
- * additional layer of namespace:
+ * additional layer of namespace):
*
* \code
* MoReFEM::RefGeomEltNS::Traits::Quadrangle4
diff --git a/Sources/Geometry/RefGeometricElt/Instances/Quadrangle/Quadrangle8.hpp b/Sources/Geometry/RefGeometricElt/Instances/Quadrangle/Quadrangle8.hpp
index dac9242a4099aa64c994de8d652d499c1a400cca..333712a7c5c6df34ef0ac1dd6b70a6fe1b754cb4 100644
--- a/Sources/Geometry/RefGeometricElt/Instances/Quadrangle/Quadrangle8.hpp
+++ b/Sources/Geometry/RefGeometricElt/Instances/Quadrangle/Quadrangle8.hpp
@@ -45,7 +45,7 @@ namespace MoReFEM
* \endcode
*
* or to be a template parameter to MoReFEM::RefGeomEltNS::Quadrangle8 class (current class is in an
- * additional layer of namespace:
+ * additional layer of namespace):
*
* \code
* MoReFEM::RefGeomEltNS::Traits::Quadrangle8
diff --git a/Sources/Geometry/RefGeometricElt/Instances/Quadrangle/Quadrangle9.hpp b/Sources/Geometry/RefGeometricElt/Instances/Quadrangle/Quadrangle9.hpp
index 1fb580ce77bf951a9cc50f76153932c7f803ebf6..0fcf7e8956dbc483cbe03b6e98693b6cc70184c1 100644
--- a/Sources/Geometry/RefGeometricElt/Instances/Quadrangle/Quadrangle9.hpp
+++ b/Sources/Geometry/RefGeometricElt/Instances/Quadrangle/Quadrangle9.hpp
@@ -44,7 +44,7 @@ namespace MoReFEM
* \endcode
*
* or to be a template parameter to MoReFEM::RefGeomEltNS::Quadrangle9 class (current class is in an
- * additional layer of namespace:
+ * additional layer of namespace):
*
* \code
* MoReFEM::RefGeomEltNS::Traits::Quadrangle9
diff --git a/Sources/Geometry/RefGeometricElt/Instances/Segment/Segment2.hpp b/Sources/Geometry/RefGeometricElt/Instances/Segment/Segment2.hpp
index b729fba5a38c7e568ec08316e1c54263aaf979b3..ddb81b01183c23d5575ffbcb776ca0c7d0d2e734 100644
--- a/Sources/Geometry/RefGeometricElt/Instances/Segment/Segment2.hpp
+++ b/Sources/Geometry/RefGeometricElt/Instances/Segment/Segment2.hpp
@@ -47,7 +47,7 @@ namespace MoReFEM
* \endcode
*
* or to be a template parameter to MoReFEM::RefGeomEltNS::Segment2 class (current class is in an
- * additional layer of namespace:
+ * additional layer of namespace):
*
* \code
* MoReFEM::RefGeomEltNS::Traits::Segment2
diff --git a/Sources/Geometry/RefGeometricElt/Instances/Segment/Segment3.hpp b/Sources/Geometry/RefGeometricElt/Instances/Segment/Segment3.hpp
index 7130c7f93c004ff57c4843e9ea29e1ef55caab62..2e1d637e2dc3ee58c0a3eeb606c08771c5954b17 100644
--- a/Sources/Geometry/RefGeometricElt/Instances/Segment/Segment3.hpp
+++ b/Sources/Geometry/RefGeometricElt/Instances/Segment/Segment3.hpp
@@ -45,7 +45,7 @@ namespace MoReFEM
* \endcode
*
* or to be a template parameter to MoReFEM::RefGeomEltNS::Segment3 class (current class is in an
- * additional layer of namespace:
+ * additional layer of namespace):
*
* \code
* MoReFEM::RefGeomEltNS::Traits::Segment3
diff --git a/Sources/Geometry/RefGeometricElt/Instances/Tetrahedron/Tetrahedron10.hpp b/Sources/Geometry/RefGeometricElt/Instances/Tetrahedron/Tetrahedron10.hpp
index d2a9456f9af1d4104cfd2b58235539e37bd0b51f..e941514dcf89284dcc8d0e3c2e41a76e285d4d1d 100644
--- a/Sources/Geometry/RefGeometricElt/Instances/Tetrahedron/Tetrahedron10.hpp
+++ b/Sources/Geometry/RefGeometricElt/Instances/Tetrahedron/Tetrahedron10.hpp
@@ -47,7 +47,7 @@ namespace MoReFEM
* \endcode
*
* or to be a template parameter to MoReFEM::RefGeomEltNS::Tetrahedron10 class (current class is in an
- * additional layer of namespace:
+ * additional layer of namespace):
*
* \code
* MoReFEM::RefGeomEltNS::Traits::Tetrahedron10
diff --git a/Sources/Geometry/RefGeometricElt/Instances/Tetrahedron/Tetrahedron4.hpp b/Sources/Geometry/RefGeometricElt/Instances/Tetrahedron/Tetrahedron4.hpp
index 3b8764a2c6382b6dfbb936c7d8da56902fa9df27..9d166ec080dfe9c5ca8d395eb2b6b60f8948bec5 100644
--- a/Sources/Geometry/RefGeometricElt/Instances/Tetrahedron/Tetrahedron4.hpp
+++ b/Sources/Geometry/RefGeometricElt/Instances/Tetrahedron/Tetrahedron4.hpp
@@ -44,7 +44,7 @@ namespace MoReFEM
* \endcode
*
* or to be a template parameter to MoReFEM::RefGeomEltNS::Tetrahedron4 class (current class is in an
- * additional layer of namespace:
+ * additional layer of namespace):
*
* \code
* MoReFEM::RefGeomEltNS::Traits::Tetrahedron4
diff --git a/Sources/Geometry/RefGeometricElt/Instances/Triangle/Triangle3.hpp b/Sources/Geometry/RefGeometricElt/Instances/Triangle/Triangle3.hpp
index b416806a1a8fc40d164ba3fb5e42837548a430ec..13212a530ed87d24bbe00f7f3cbd90b0ba07859d 100644
--- a/Sources/Geometry/RefGeometricElt/Instances/Triangle/Triangle3.hpp
+++ b/Sources/Geometry/RefGeometricElt/Instances/Triangle/Triangle3.hpp
@@ -46,7 +46,7 @@ namespace MoReFEM
* \endcode
*
* or to be a template parameter to MoReFEM::RefGeomEltNS::Triangle3 class (current class is in an
- * additional layer of namespace:
+ * additional layer of namespace):
*
* \code
* MoReFEM::RefGeomEltNS::Traits::Triangle3
diff --git a/Sources/Geometry/RefGeometricElt/Instances/Triangle/Triangle6.hpp b/Sources/Geometry/RefGeometricElt/Instances/Triangle/Triangle6.hpp
index 11513bdb3990d2b86fa0a469297f4d20fbf00e14..fee28e9c948b534d2b368889818eb0b68fcc5642 100644
--- a/Sources/Geometry/RefGeometricElt/Instances/Triangle/Triangle6.hpp
+++ b/Sources/Geometry/RefGeometricElt/Instances/Triangle/Triangle6.hpp
@@ -44,7 +44,7 @@ namespace MoReFEM
* \endcode
*
* or to be a template parameter to MoReFEM::RefGeomEltNS::Triangle6 class (current class is in an
- * additional layer of namespace:
+ * additional layer of namespace):
*
* \code
* MoReFEM::RefGeomEltNS::Traits::Triangle6
diff --git a/Sources/Model/Model.doxygen b/Sources/Model/Model.doxygen
index 0aa071301ed4366777fa54831901a8b3079744b6..6efff33ab0920c44ed47d5d61e9cc55329455d96 100644
--- a/Sources/Model/Model.doxygen
+++ b/Sources/Model/Model.doxygen
@@ -18,5 +18,27 @@
///@}
+/*!
+ * \class doxygen_hide_model_SupplHasFinishedConditions_common
+ *
+ * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of
+ * maximum time).
+ *
+ */
+
+/*!
+* \class doxygen_hide_model_SupplHasFinishedConditions
+*
+* \copydoc doxygen_hide_model_SupplHasFinishedConditions_common
+*
+* \return True if one of the additional finish condition defined specifically in current \a Model is reached.
+*/
+/*!
+ * \class doxygen_hide_model_SupplHasFinishedConditions_always_true
+ *
+ * \copydoc doxygen_hide_model_SupplHasFinishedConditions_common
+ *
+ * \return Always true (no such additional condition in this Model).
+ */
diff --git a/Sources/ModelInstances/Elasticity/ElasticityModel.hpp b/Sources/ModelInstances/Elasticity/ElasticityModel.hpp
index 16e3898072b44fa3a040c9b9cb2bc16e1cbc8baa..46accf60703e07564cc9a24b923e894481eb015e 100644
--- a/Sources/ModelInstances/Elasticity/ElasticityModel.hpp
+++ b/Sources/ModelInstances/Elasticity/ElasticityModel.hpp
@@ -25,6 +25,7 @@ namespace MoReFEM
{
+ //! \copydoc doxygen_hide_simple_model
class ElasticityModel final : public Model<ElasticityModel, DoConsiderProcessorWiseLocal2Global::no>
{
@@ -52,7 +53,7 @@ namespace MoReFEM
/*!
* \brief Constructor.
*
- * \copydetails doxygen_hide_mpi_param
+ * \copydoc doxygen_hide_morefem_data_param
*/
ElasticityModel(const morefem_data_type& morefem_data);
@@ -82,6 +83,7 @@ namespace MoReFEM
* \brief Initialise the problem.
*
* This initialisation includes the resolution of the static problem.
+ * \copydoc doxygen_hide_morefem_data_param
*/
void SupplInitialize(const morefem_data_type& morefem_data);
@@ -113,12 +115,7 @@ namespace MoReFEM
- /*!
- * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of
- * maximum time).
- *
- * Returns always true (no such additional condition in this Model).
- */
+ //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true
bool SupplHasFinishedConditions() const;
diff --git a/Sources/ModelInstances/Elasticity/InputParameterList.hpp b/Sources/ModelInstances/Elasticity/InputParameterList.hpp
index 8bf51e1b6572fde9d821b27f3ee4347d8e6660cd..f48aedcf2022bfb7dae770038827aa5cd883d72d 100644
--- a/Sources/ModelInstances/Elasticity/InputParameterList.hpp
+++ b/Sources/ModelInstances/Elasticity/InputParameterList.hpp
@@ -32,12 +32,14 @@ namespace MoReFEM
{
+ //! \copydoc doxygen_hide_mesh_enum
enum class MeshIndex
{
mesh = 1 // only one mesh considered in current model!
};
+ //! \copydoc doxygen_hide_domain_enum
enum class DomainIndex
{
highest_dimension = 1,
@@ -47,6 +49,7 @@ namespace MoReFEM
};
+ //! \copydoc doxygen_hide_felt_space_enum
enum class FEltSpaceIndex
{
highest_dimension = 1,
@@ -54,24 +57,28 @@ namespace MoReFEM
};
+ //! \copydoc doxygen_hide_unknown_enum
enum class UnknownIndex
{
solid_displacement = 1
};
+ //! \copydoc doxygen_hide_solver_enum
enum class SolverIndex
{
solver = 1
};
+ //! \copydoc doxygen_hide_numbering_subset_enum
enum class NumberingSubsetIndex
{
monolithic = 1
};
+ //! \copydoc doxygen_hide_source_enum
enum class SourceIndex
{
volumic = 1,
@@ -79,12 +86,14 @@ namespace MoReFEM
};
+ //! \copydoc doxygen_hide_boundary_condition_enum
enum class BoundaryConditionIndex
{
sole = 1
};
+ //! \copydoc doxygen_hide_input_parameter_tuple
using InputParameterTuple = std::tuple
<
InputParameter::TimeManager,
@@ -119,8 +128,10 @@ namespace MoReFEM
>;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = InputParameterList<InputParameterTuple>;
+ //! \copydoc doxygen_hide_morefem_data_type
using morefem_data_type = MoReFEMData<InputParameterList>;
diff --git a/Sources/ModelInstances/Elasticity/VariationalFormulationElasticity.hpp b/Sources/ModelInstances/Elasticity/VariationalFormulationElasticity.hpp
index 56d1a3ba6d6f7dee933c50cc35747fe705b6da21..bdf053e209bdc1cd8ce8ccb1c1e494871281ee14 100644
--- a/Sources/ModelInstances/Elasticity/VariationalFormulationElasticity.hpp
+++ b/Sources/ModelInstances/Elasticity/VariationalFormulationElasticity.hpp
@@ -35,6 +35,7 @@ namespace MoReFEM
{
+ //! \copydoc doxygen_hide_simple_varf
class VariationalFormulationElasticity final
: public VariationalFormulation
<
@@ -53,8 +54,10 @@ namespace MoReFEM
private:
+ //! Alias to self.
using self = VariationalFormulationElasticity;
+ //! Alias to parent class.
using parent = VariationalFormulation<self, EnumUnderlyingType(SolverIndex::solver)>;
//! Friendship to parent class, so this one can access private methods defined below through CRTP.
@@ -65,7 +68,7 @@ namespace MoReFEM
//! Alias to unique pointer.
using unique_ptr = std::unique_ptr<self>;
-
+ //! Alias to the appropriate \a ScalarParameter used to describe the solid.
using solid_scalar_parameter = ScalarParameter<ParameterNS::TimeDependencyNS::None>;
//! Alias on a pair of Unknown.
@@ -76,11 +79,7 @@ namespace MoReFEM
/// \name Special members.
///@{
- /*!
- * \brief Constructor.
- *
- * \copydetails doxygen_hide_mpi_param
- */
+ //! copydoc doxygen_hide_varf_constructor
explicit VariationalFormulationElasticity(const morefem_data_type& morefem_data,
const FEltSpace& main_felt_space,
const FEltSpace& neumann_felt_space,
@@ -129,9 +128,11 @@ namespace MoReFEM
void UpdateDisplacementAndVelocity();
/*!
- * \brief Get the only numbering subset relevant for this VariationalFormulation
+ * \brief Get the only numbering subset relevant for this VariationalFormulation.
*
* There is a more generic accessor in the base class but is use is more unwieldy.
+ *
+ * \return The only \a NumberingSubset present in this \a VariationalFormulation.
*/
const NumberingSubset& GetNumberingSubset() const noexcept;
@@ -177,6 +178,8 @@ namespace MoReFEM
* \brief Specific initialisation for derived class attributes.
*
* \internal <b><tt>[internal]</tt></b> This method is called by base class method VariationalFormulation::Init().
+ *
+ * \copydoc doxygen_hide_input_parameter_data_arg
*/
void SupplInit(const InputParameterList& input_parameter_data);
@@ -210,30 +213,42 @@ namespace MoReFEM
/// \name Accessors to vectors and matrices specific to the elastic problem.
///@{
+ //! Accessor to the \a GlobalVector which contains current displacement.
const GlobalVector& GetVectorCurrentDisplacement() const noexcept;
+ //! Non constant accessor to the \a GlobalVector which contains current displacement.
GlobalVector& GetNonCstVectorCurrentDisplacement() noexcept;
+ //! Accessor to the \a GlobalVector which contains current velocity.
const GlobalVector& GetVectorCurrentVelocity() const noexcept;
+ //! Non constant accessor to the \a GlobalVector which contains current velocity.
GlobalVector& GetNonCstVectorCurrentVelocity() noexcept;
+ //! Accessor to the \a GlobalMatrix used along displacement in the model.
const GlobalMatrix& GetMatrixCurrentDisplacement() const noexcept;
public: //todo #691
+ //! Non constant accessor to the \a GlobalMatrix used along displacement in the model.
GlobalMatrix& GetNonCstMatrixCurrentDisplacement() noexcept;
+ //! Accessor to the \a GlobalMatrix used along velocity in the model.
const GlobalMatrix& GetMatrixCurrentVelocity() const noexcept;
+ //! Non constant accessor to the \a GlobalMatrix used along velocity in the model.
GlobalMatrix& GetNonCstMatrixCurrentVelocity() noexcept;
+ //! Accessor to the mass matrix.
const GlobalMatrix& GetMass() const noexcept;
+ //! Non constant accessor to the mass matrix.
GlobalMatrix& GetNonCstMass() noexcept;
+ //! Accessor to the stiffness matrix.
const GlobalMatrix& GetStiffness() const noexcept;
+ //! Non constant accessor to the stiffness matrix.
GlobalMatrix& GetNonCstStiffness() noexcept;
///@}
diff --git a/Sources/ModelInstances/Elasticity/main.cpp b/Sources/ModelInstances/Elasticity/main.cpp
index 42a07da35833b0fcddcbb59106c82532e15a6682..f469eb72f188ac38a41922c3cb1eaea336e18fb5 100644
--- a/Sources/ModelInstances/Elasticity/main.cpp
+++ b/Sources/ModelInstances/Elasticity/main.cpp
@@ -21,7 +21,8 @@ using namespace MoReFEM;
int main(int argc, char** argv)
{
- using InputParameterList = ElasticityNS::InputParameterList;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = ElasticityNS::InputParameterList;
try
{
diff --git a/Sources/ModelInstances/Elasticity/main_ensight_output.cpp b/Sources/ModelInstances/Elasticity/main_ensight_output.cpp
index 9cfd815b39caad56561045270394494b70bb3c23..117c060d655346264b97b6c16346d30af29ff530 100644
--- a/Sources/ModelInstances/Elasticity/main_ensight_output.cpp
+++ b/Sources/ModelInstances/Elasticity/main_ensight_output.cpp
@@ -29,6 +29,7 @@ int main(int argc, char** argv)
try
{
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = ElasticityNS::InputParameterList;
MoReFEMData<InputParameterList, Utilities::InputParameterListNS::DoTrackUnusedFields::no> morefem_data(argc, argv);
diff --git a/Sources/ModelInstances/Heat/HeatModel.hpp b/Sources/ModelInstances/Heat/HeatModel.hpp
index 6bcedfbbc7be9659081c7616ace192ce1f02ceee..cbd285de4e8af28aaa82862e6e4e6411b64b3814 100644
--- a/Sources/ModelInstances/Heat/HeatModel.hpp
+++ b/Sources/ModelInstances/Heat/HeatModel.hpp
@@ -54,7 +54,7 @@ namespace MoReFEM
/*!
* \brief Constructor.
*
- * \copydetails doxygen_hide_mpi_param
+ * \copydoc doxygen_hide_morefem_data_param
*/
explicit HeatModel(const morefem_data_type& morefem_data);
@@ -84,6 +84,7 @@ namespace MoReFEM
* \brief Initialise the problem.
*
* This initialisation includes the resolution of the static problem.
+ * \copydoc doxygen_hide_morefem_data_param
*/
void SupplInitialize(const morefem_data_type& morefem_data);
@@ -119,12 +120,7 @@ namespace MoReFEM
private:
- /*!
- * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of
- * maximum time).
- *
- * Returns always true (no such additional condition in this Model).
- */
+ //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true
bool SupplHasFinishedConditions() const;
diff --git a/Sources/ModelInstances/Heat/HeatVariationalFormulation.hpp b/Sources/ModelInstances/Heat/HeatVariationalFormulation.hpp
index a8689b132865aa6dc54653eb8d2fe18689fe56f6..de0ec00526d72d1e45f5252d947bdbaf1a00336f 100644
--- a/Sources/ModelInstances/Heat/HeatVariationalFormulation.hpp
+++ b/Sources/ModelInstances/Heat/HeatVariationalFormulation.hpp
@@ -73,11 +73,7 @@ namespace MoReFEM
/// \name Special members.
///@{
- /*!
- * \brief Constructor.
- *
- * \copydetails doxygen_hide_mpi_param
- */
+ //! copydoc doxygen_hide_varf_constructor
explicit HeatVariationalFormulation(const morefem_data_type& morefem_data,
const NumberingSubset& numbering_subset,
TimeManager& time_manager,
@@ -105,6 +101,7 @@ namespace MoReFEM
//! At each time iteration, compute the system Rhs.
void ComputeDynamicSystemRhs();
+ //! Accessor to the capacity matrix per time step.
const GlobalMatrix& GetMatrixCapacityPerTimeStep() const;
@@ -121,6 +118,7 @@ namespace MoReFEM
*
* StaticOrDynamic rhs is what changes between two time iterations, but toc ompute it the same matrices are used at
* each time iteration; they are also computed there.
+ * \copydoc doxygen_hide_input_parameter_data_arg
*/
void PrepareDynamicRuns(const InputParameterList& input_parameter_data);
@@ -166,6 +164,8 @@ namespace MoReFEM
* \brief Get the only numbering subset relevant for this VariationalFormulation.
*
* There is a more generic accessor in the base class but is use is more unwieldy.
+ *
+ * \return The only relevant \a NumberingSubset.
*/
const NumberingSubset& GetNumberingSubset() const;
@@ -175,17 +175,12 @@ namespace MoReFEM
/// \name CRTP-required methods.
///@{
- /*!
- * \brief Specific initialisation for derived class attributes.
- *
- * \internal <b><tt>[internal]</tt></b> This method is called by base class method VariationalFormulation::Init().
- */
+ //! \copydoc doxygen_hide_varf_suppl_init
void SupplInit(const InputParameterList& input_parameter_data);
/*!
* \brief Allocate the global matrices and vectors.
*/
-
void AllocateMatricesAndVectors();
diff --git a/Sources/ModelInstances/Heat/InputParameterList.hpp b/Sources/ModelInstances/Heat/InputParameterList.hpp
index 9af0a450411e6b3500edb129b4be5214f5202155..40392e53ce5c002af51fa93b87d02caf707bae1a 100644
--- a/Sources/ModelInstances/Heat/InputParameterList.hpp
+++ b/Sources/ModelInstances/Heat/InputParameterList.hpp
@@ -29,6 +29,7 @@ namespace MoReFEM
{
+ //! \copydoc doxygen_hide_source_enum
enum class ForceIndexList : unsigned int
{
volumic_source = 1,
@@ -37,13 +38,15 @@ namespace MoReFEM
};
- enum class MeshIndex
+ //! \copydoc doxygen_hide_mesh_enum
+ enum class MeshIndex
{
mesh = 1 // only one mesh considered in current model!
};
- enum class DomainIndex
+ //! \copydoc doxygen_hide_domain_enum
+ enum class DomainIndex
{
highest_dimension = 1,
neumann = 2,
@@ -54,6 +57,7 @@ namespace MoReFEM
};
+ //! \copydoc doxygen_hide_boundary_condition_enum
enum class BoundaryConditionIndex
{
first = 1,
@@ -61,7 +65,8 @@ namespace MoReFEM
};
- enum class FEltSpaceIndex
+ //! \copydoc doxygen_hide_felt_space_enum
+ enum class FEltSpaceIndex
{
highest_dimension = 1,
neumann = 2,
@@ -69,34 +74,43 @@ namespace MoReFEM
};
- enum class UnknownIndex
+ //! \copydoc doxygen_hide_unknown_enum
+ enum class UnknownIndex
{
temperature = 1
};
- enum class SolverIndex
+ //! \copydoc doxygen_hide_solver_enum
+ enum class SolverIndex
+
{
solver = 1
};
- enum class NumberingSubsetIndex
+ //! \copydoc doxygen_hide_numbering_subset_enum
+ enum class NumberingSubsetIndex
{
monolithic = 1
};
+
+ //! Index to tag the tensors involved.
enum class TensorIndex
{
diffusion_tensor = 1
};
+ //! \copydoc doxygen_hide_initial_condition_enum
enum class InitialConditionIndex
{
temperature_initial_condition = 1
};
+
+ //! \copydoc doxygen_hide_input_parameter_tuple
using InputParameterTuple = std::tuple
<
InputParameter::TimeManager,
@@ -138,8 +152,10 @@ namespace MoReFEM
>;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = InputParameterList<InputParameterTuple>;
+ //! \copydoc doxygen_hide_morefem_data_type
using morefem_data_type = MoReFEMData<InputParameterList>;
diff --git a/Sources/ModelInstances/Heat/main.cpp b/Sources/ModelInstances/Heat/main.cpp
index 6536151dd3ddfedb523c014afc92266b5e3f28f8..fdc2e9f057ea5cc11ed5f25f31277fd1c6e4bf97 100644
--- a/Sources/ModelInstances/Heat/main.cpp
+++ b/Sources/ModelInstances/Heat/main.cpp
@@ -21,7 +21,8 @@ using namespace MoReFEM;
int main(int argc, char** argv)
{
- using InputParameterList = HeatNS::InputParameterList;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = HeatNS::InputParameterList;
try
{
diff --git a/Sources/ModelInstances/Heat/main_ensight_output.cpp b/Sources/ModelInstances/Heat/main_ensight_output.cpp
index 8b13a152f5dd43542c6357b45f60b368f94e2ce2..1e572402f69357cdf24716cce57965a8ee21299c 100644
--- a/Sources/ModelInstances/Heat/main_ensight_output.cpp
+++ b/Sources/ModelInstances/Heat/main_ensight_output.cpp
@@ -29,6 +29,7 @@ int main(int argc, char** argv)
try
{
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = HeatNS::InputParameterList;
MoReFEMData<InputParameterList, Utilities::InputParameterListNS::DoTrackUnusedFields::no> morefem_data(argc, argv);
diff --git a/Sources/ModelInstances/Hyperelasticity/InputParameterList.hpp b/Sources/ModelInstances/Hyperelasticity/InputParameterList.hpp
index df3a2107e73ec2ebd7677be64291a412c2267d4f..3e038e648fb60a799aaa811f30e06288b5aa6889 100644
--- a/Sources/ModelInstances/Hyperelasticity/InputParameterList.hpp
+++ b/Sources/ModelInstances/Hyperelasticity/InputParameterList.hpp
@@ -31,22 +31,26 @@ namespace MoReFEM
{
- enum class NumberingSubsetIndex
+ //! \copydoc doxygen_hide_numbering_subset_enum
+ enum class NumberingSubsetIndex
{
displacement = 1
};
- enum class UnknownIndex
+ //! \copydoc doxygen_hide_unknown_enum
+ enum class UnknownIndex
{
displacement = 1
};
- enum class MeshIndex
+ //! \copydoc doxygen_hide_mesh_enum
+ enum class MeshIndex
{
mesh = 1
};
- enum class DomainIndex
+ //! \copydoc doxygen_hide_domain_enum
+ enum class DomainIndex
{
full_mesh = 1,
volume = 2,
@@ -54,28 +58,34 @@ namespace MoReFEM
dirichlet = 4,
};
+ //! \copydoc doxygen_hide_boundary_condition_enum
enum class BoundaryConditionIndex
{
clamped = 1
};
- enum class FEltSpaceIndex
+ //! \copydoc doxygen_hide_felt_space_enum
+ enum class FEltSpaceIndex
{
volume = 1,
force = 2
};
- enum class SolverIndex
+ //! \copydoc doxygen_hide_solver_enum
+ enum class SolverIndex
+
{
solver = 1
};
+ //! \copydoc doxygen_hide_source_enum
enum class ForceIndexList
{
surfacic = 1
};
+ //! \copydoc doxygen_hide_input_parameter_tuple
using InputParameterTuple = std::tuple
<
InputParameter::TimeManager,
@@ -109,8 +119,10 @@ namespace MoReFEM
>;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = InputParameterList<InputParameterTuple>;
+ //! \copydoc doxygen_hide_morefem_data_type
using morefem_data_type = MoReFEMData<InputParameterList>;
diff --git a/Sources/ModelInstances/Hyperelasticity/Model.hpp b/Sources/ModelInstances/Hyperelasticity/Model.hpp
index d76a9a0af93df8396487ed7e4dfc3f697728bdd8..95ac2d2af33666348f7ab1db2e9fa1b14f679391 100644
--- a/Sources/ModelInstances/Hyperelasticity/Model.hpp
+++ b/Sources/ModelInstances/Hyperelasticity/Model.hpp
@@ -27,9 +27,7 @@ namespace MoReFEM
{
- /*!
- * \brief Model for pre-stress cardiac mechanics.
- */
+ //! \copydoc doxygen_hide_simple_model
class Model : public MoReFEM::Model<Model, DoConsiderProcessorWiseLocal2Global::yes>
{
@@ -57,7 +55,7 @@ namespace MoReFEM
/*!
* \brief Constructor.
*
- * \copydetails doxygen_hide_mpi_param
+ * \copydoc doxygen_hide_morefem_data_param
*/
Model(const morefem_data_type& morefem_data);
@@ -87,6 +85,7 @@ namespace MoReFEM
* \brief Initialise the problem.
*
* This initialisation includes the resolution of the static problem.
+ * \copydoc doxygen_hide_morefem_data_param
*/
void SupplInitialize(const morefem_data_type& morefem_data);
@@ -112,12 +111,7 @@ namespace MoReFEM
private:
- /*!
- * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of
- * maximum time).
- *
- * Returns always true (no such additional condition in this Model).
- */
+ //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true
bool SupplHasFinishedConditions() const;
diff --git a/Sources/ModelInstances/Hyperelasticity/VariationalFormulation.hpp b/Sources/ModelInstances/Hyperelasticity/VariationalFormulation.hpp
index 553cc0a2b1a79b1ce6cda056d3dfed7100af8c93..7d9dbfb2f302f92f6ae245eb6fbe021750d044ad 100644
--- a/Sources/ModelInstances/Hyperelasticity/VariationalFormulation.hpp
+++ b/Sources/ModelInstances/Hyperelasticity/VariationalFormulation.hpp
@@ -44,6 +44,7 @@ namespace MoReFEM
{
+ //! \copydoc doxygen_hide_simple_varf
class VariationalFormulation
: public MoReFEM::VariationalFormulation
<
@@ -86,10 +87,12 @@ namespace MoReFEM
using ActiveStressPolicy =
GlobalVariationalOperatorNS::SecondPiolaKirchhoffStressTensorNS::ActiveStressPolicyNS::None;
+ //! Alias to the hyperelasticity policy used.
using hyperelasticity_policy =
GlobalVariationalOperatorNS::SecondPiolaKirchhoffStressTensorNS::HyperelasticityPolicyNS
::Hyperelasticity<typename hyperelastic_law_parent::hyperelastic_law_type>;
+ //! Alias to the type of the source parameter.
using force_parameter_type =
Parameter<ParameterNS::Type::vector, LocalCoords, ParameterNS::TimeDependencyNS::None>;
@@ -117,11 +120,7 @@ namespace MoReFEM
/// \name Special members.
///@{
- /*!
- * \brief Constructor.
- *
- * \copydetails doxygen_hide_mpi_param
- */
+ //! copydoc doxygen_hide_varf_constructor
explicit VariationalFormulation(const morefem_data_type& morefem_data,
const NumberingSubset& displacement_numbering_subset,
TimeManager& time_manager,
@@ -149,6 +148,8 @@ namespace MoReFEM
* \brief Get the displacement numbering subset relevant for this VariationalFormulation.
*
* There is a more generic accessor in the base class but its use is more unwieldy.
+ *
+ * \return \a NumberingSubset related to displacement.
*/
const NumberingSubset& GetDisplacementNumberingSubset() const;
@@ -163,11 +164,7 @@ namespace MoReFEM
/// \name CRTP-required methods.
///@{
- /*!
- * \brief Specific initialisation for derived class attributes.
- *
- * \internal <b><tt>[internal]</tt></b> This method is called by base class method VariationalFormulation::Init().
- */
+ //! \copydoc doxygen_hide_varf_suppl_init
void SupplInit(const InputParameterList& input_parameter_data);
/*!
@@ -199,12 +196,15 @@ namespace MoReFEM
*
* \param[in,out] snes SNES object. Not explicitly used but required by Petsc prototype.
* \param[in,out] petsc_vec_displacement_at_newton_iteration State at which to evaluate residual.
- * \param[in,out] residual Vector to put residual. What is used as residual in VariationalFormulation is #RHS().
+ * \param[in,out] residual Vector to put residual. What is used as residual in \a VariationalFormulation is
+ * \a GetSystemRHS().
* \param[in,out] context_as_void Optional user-defined function context. In our case a pointer to the
* VariationalFormulationT object.
*
+ * \return Petsc error code.
*/
- static PetscErrorCode Function(SNES snes, Vec petsc_vec_displacement_at_newton_iteration, Vec residual, void* context_as_void);
+ static PetscErrorCode Function(SNES snes, Vec petsc_vec_displacement_at_newton_iteration,
+ Vec residual, void* context_as_void);
/*!
@@ -217,6 +217,8 @@ namespace MoReFEM
* \param[in] norm Current L^2 norm.
* \param[in] context_as_void Optional user-defined function context. In our case is is a pointer to a
* VariationalFormulationT object.
+ *
+ * \return Petsc error code.
*/
static PetscErrorCode Viewer(SNES snes, PetscInt its, PetscReal norm, void* context_as_void);
@@ -224,9 +226,12 @@ namespace MoReFEM
/*!
* \brief This function is supposed to be given to SNES to compute the jacobian.
*
- * However the jacobian has already been computed within SnesFunctionImpl, so this function is mostly a dummy one...
+ * \copydoc doxygen_hide_snes_interface_common_arg
+ * \param[in,out] evaluation_state Most recent value of the quantity the solver tries to compute.
+ * \param[in,out] jacobian Jacobian matrix. Actually unused in our wrapper.
+ * \param[in,out] preconditioner Preconditioner matrix. Actually unused in our wrapper.
*/
- static PetscErrorCode Jacobian(SNES snes, Vec evaluationState, Mat jacobian , Mat preconditioner,
+ static PetscErrorCode Jacobian(SNES snes, Vec evaluation_state, Mat jacobian , Mat preconditioner,
void* context_as_void);
private:
@@ -310,6 +315,8 @@ namespace MoReFEM
/*!
* \brief Define the properties of all the static global variational operators involved.
+ *
+ * \copydoc doxygen_hide_input_parameter_data_arg
*/
void DefineStaticOperators(const InputParameterList& input_parameter_data);
@@ -324,8 +331,9 @@ namespace MoReFEM
//! Get the hyperelastic stiffness operator.
const StiffnessOperatorType& GetStiffnessOperator() const noexcept;
- //!
- const GlobalVariationalOperatorNS::TransientSource<ParameterNS::Type::vector>& GetSurfacicForceOperator() const noexcept;
+ //! Accessor to the surfacic source operator.
+ const GlobalVariationalOperatorNS::TransientSource<ParameterNS::Type::vector>&
+ GetSurfacicForceOperator() const noexcept;
private:
@@ -409,6 +417,8 @@ namespace MoReFEM
* \internal <b><tt>[internal]</tt></b> This accessor should not be used except in the Snes::Function() method: the point is to
* store the value given by Petsc internal Newton algorithm.
* Its value should be modified only through the call if \a UpdateDisplacementAtNewtonIteration().
+ *
+ * \return Reference to the vector ernclosing displacement at newton iteration.
*/
GlobalVector& GetNonCstVectorDisplacementAtNewtonIteration() noexcept;
diff --git a/Sources/ModelInstances/Hyperelasticity/main.cpp b/Sources/ModelInstances/Hyperelasticity/main.cpp
index b9241e8e2a056f987523676afcefe86c28c01220..a171e0765c3342315e6bb20cb0bf9045b14a8e47 100644
--- a/Sources/ModelInstances/Hyperelasticity/main.cpp
+++ b/Sources/ModelInstances/Hyperelasticity/main.cpp
@@ -19,7 +19,8 @@ using namespace MoReFEM;
int main(int argc, char** argv)
{
- using InputParameterList = MidpointHyperelasticityNS::InputParameterList;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = MidpointHyperelasticityNS::InputParameterList;
try
{
diff --git a/Sources/ModelInstances/Hyperelasticity/main_ensight_output.cpp b/Sources/ModelInstances/Hyperelasticity/main_ensight_output.cpp
index d6b3b8a0b6eaaca1b842bcdbeef3dbfcdfd2585a..03a64d74b1a34b070869ef99270cc81d1a2ac251 100644
--- a/Sources/ModelInstances/Hyperelasticity/main_ensight_output.cpp
+++ b/Sources/ModelInstances/Hyperelasticity/main_ensight_output.cpp
@@ -29,6 +29,7 @@ int main(int argc, char** argv)
try
{
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = MidpointHyperelasticityNS::InputParameterList;
MoReFEMData<InputParameterList, Utilities::InputParameterListNS::DoTrackUnusedFields::no> morefem_data(argc, argv);
diff --git a/Sources/ModelInstances/Laplacian/InputParameterList.hpp b/Sources/ModelInstances/Laplacian/InputParameterList.hpp
index daa26c9e6f9bb4646974b0bfe98b480b09cf4638..9996b4302ae4d1d1f6a7155d06bae6a510bfdf3b 100644
--- a/Sources/ModelInstances/Laplacian/InputParameterList.hpp
+++ b/Sources/ModelInstances/Laplacian/InputParameterList.hpp
@@ -28,23 +28,27 @@ namespace MoReFEM
{
- enum class MeshIndex
+ //! \copydoc doxygen_hide_mesh_enum
+ enum class MeshIndex
{
mesh = 1 // only one mesh considered in current model!
};
- enum class NumberingSubsetIndex
+ //! \copydoc doxygen_hide_numbering_subset_enum
+ enum class NumberingSubsetIndex
{
monolithic = 1
};
- enum class UnknownIndex
+ //! \copydoc doxygen_hide_unknown_enum
+ enum class UnknownIndex
{
pressure = 1
};
- enum class DomainIndex
+ //! \copydoc doxygen_hide_domain_enum
+ enum class DomainIndex
{
full_mesh = 1,
volume = 2,
@@ -52,32 +56,40 @@ namespace MoReFEM
};
+ //! \copydoc doxygen_hide_boundary_condition_enum
enum class BoundaryConditionIndex
{
first = 1
};
- enum class FEltSpaceIndex
+ //! \copydoc doxygen_hide_felt_space_enum
+ enum class FEltSpaceIndex
{
volume = 1
};
- enum class SolverIndex
+ //! \copydoc doxygen_hide_solver_enum
+ enum class SolverIndex
+
{
solver = 1
};
+ //! \copydoc doxygen_hide_source_enum
enum class SourceIndexList : unsigned int
{
volumic_source = 1
};
+
+ //! \copydoc doxygen_hide_initial_condition_enum
enum class InitialConditionIndex
{
initial_condition = 1
};
+ //! \copydoc doxygen_hide_input_parameter_tuple
using InputParameterTuple = std::tuple
<
InputParameter::TimeManager,
@@ -107,8 +119,10 @@ namespace MoReFEM
>;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = InputParameterList<InputParameterTuple>;
+ //! \copydoc doxygen_hide_morefem_data_type
using morefem_data_type = MoReFEMData<InputParameterList>;
diff --git a/Sources/ModelInstances/Laplacian/Model.hpp b/Sources/ModelInstances/Laplacian/Model.hpp
index 8afcc6c5e789874341de167e400c283dfde602b6..4d0eb0fc104dc08d387647161d4ef351304122f7 100644
--- a/Sources/ModelInstances/Laplacian/Model.hpp
+++ b/Sources/ModelInstances/Laplacian/Model.hpp
@@ -25,7 +25,7 @@ namespace MoReFEM
{
- //! Model that implements the heat problem in static and dynamic (backward Euler for time integration)
+ //! \copydoc doxygen_hide_simple_model
class Model final : public MoReFEM::Model<Model, DoConsiderProcessorWiseLocal2Global::yes>
{
@@ -54,7 +54,7 @@ namespace MoReFEM
/*!
* \brief Constructor.
*
- * \copydetails doxygen_hide_mpi_param
+ * \copydoc doxygen_hide_morefem_data_param
*/
explicit Model(const morefem_data_type& morefem_data);
@@ -84,6 +84,7 @@ namespace MoReFEM
* \brief Initialise the problem.
*
* This initialisation includes the resolution of the static problem.
+ * \copydoc doxygen_hide_morefem_data_param
*/
void SupplInitialize(const morefem_data_type& morefem_data);
@@ -118,12 +119,7 @@ namespace MoReFEM
private:
- /*!
- * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of
- * maximum time).
- *
- * Returns always true (no such additional condition in this Model).
- */
+ //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true
bool SupplHasFinishedConditions() const;
diff --git a/Sources/ModelInstances/Laplacian/VariationalFormulation.hpp b/Sources/ModelInstances/Laplacian/VariationalFormulation.hpp
index 993826f28eaa9e489a9491e55ff81adf869c7457..a35c0063cc48d3a466aa02e6e3c622cc0bf650d2 100644
--- a/Sources/ModelInstances/Laplacian/VariationalFormulation.hpp
+++ b/Sources/ModelInstances/Laplacian/VariationalFormulation.hpp
@@ -69,10 +69,7 @@ namespace MoReFEM
/// \name Special members.
///@{
- /*!
- * \brief Constructor.
- *
- */
+ //! copydoc doxygen_hide_varf_constructor
explicit VariationalFormulation(const morefem_data_type& morefem_data,
TimeManager& time_manager,
const GodOfDof& god_of_dof,
@@ -107,17 +104,12 @@ namespace MoReFEM
/// \name CRTP-required methods.
///@{
- /*!
- * \brief Specific initialisation for derived class attributes.
- *
- * \internal <b><tt>[internal]</tt></b> This method is called by base class method VariationalFormulation::Init().
- */
+ //! \copydoc doxygen_hide_varf_suppl_init
void SupplInit(const InputParameterList& input_parameter_data);
/*!
* \brief Allocate the global matrices and vectors.
*/
-
void AllocateMatricesAndVectors();
@@ -152,19 +144,6 @@ namespace MoReFEM
//! Get the volumic source operator.
const source_operator_type& GetVolumicSourceOperator() const noexcept;
- private:
-
- /// \name Accessors to vectors and matrices specific to the problem.
- ///@{
-
- ///@}
-
- /// \name Material parameters.
- ///@{
-
- ///@}
-
-
private:
@@ -191,26 +170,6 @@ namespace MoReFEM
- private:
-
- /// \name Global vectors and matrices specific to the problem.
- ///@{
-
- ///@}
-
-
- private:
-
- //! \name Material parameters.
- ///@{
-
- ///@}
-
-
-
- private:
-
-
};
diff --git a/Sources/ModelInstances/Laplacian/main.cpp b/Sources/ModelInstances/Laplacian/main.cpp
index dc24da50ac38423499797bb3cdd4c10ce9a91f42..4a33c068764f945b104ae86887a44f8ab7b623a2 100644
--- a/Sources/ModelInstances/Laplacian/main.cpp
+++ b/Sources/ModelInstances/Laplacian/main.cpp
@@ -21,7 +21,8 @@ using namespace MoReFEM;
int main(int argc, char** argv)
{
- using InputParameterList = LaplacianNS::InputParameterList;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = LaplacianNS::InputParameterList;
try
{
diff --git a/Sources/ModelInstances/Laplacian/main_ensight_output.cpp b/Sources/ModelInstances/Laplacian/main_ensight_output.cpp
index b01b2cb52568bd7b2d0020e07ec9417ad304b7be..57c0b4f65fd80fbb7269b7b3d5db436158e2dc2e 100644
--- a/Sources/ModelInstances/Laplacian/main_ensight_output.cpp
+++ b/Sources/ModelInstances/Laplacian/main_ensight_output.cpp
@@ -29,6 +29,7 @@ int main(int argc, char** argv)
try
{
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = LaplacianNS::InputParameterList;
MoReFEMData<InputParameterList, Utilities::InputParameterListNS::DoTrackUnusedFields::no> morefem_data(argc, argv);
diff --git a/Sources/ModelInstances/ModelInstances.doxygen b/Sources/ModelInstances/ModelInstances.doxygen
new file mode 100644
index 0000000000000000000000000000000000000000..777d1a715a418c5ad95ff99ba9047d123c4cc0a0
--- /dev/null
+++ b/Sources/ModelInstances/ModelInstances.doxygen
@@ -0,0 +1,14 @@
+
+/*!
+ * \class doxygen_hide_simple_varf
+ *
+ * \brief Variational formulation used in the model.
+ */
+
+
+
+/*!
+* \class doxygen_hide_simple_model
+*
+* \brief Model class.
+*/
diff --git a/Sources/ModelInstances/RivlinCube/InputParameterList.hpp b/Sources/ModelInstances/RivlinCube/InputParameterList.hpp
index 396a559480b1cadb503882213bd0272d43cda864..5495d2dd215bb8054eea3a2571bb8eafc84d5757 100644
--- a/Sources/ModelInstances/RivlinCube/InputParameterList.hpp
+++ b/Sources/ModelInstances/RivlinCube/InputParameterList.hpp
@@ -30,13 +30,15 @@ namespace MoReFEM
{
- enum class MeshIndex
+ //! \copydoc doxygen_hide_mesh_enum
+ enum class MeshIndex
{
mesh = 1
};
- enum class DomainIndex
+ //! \copydoc doxygen_hide_domain_enum
+ enum class DomainIndex
{
highest_dimension = 1,
face1 = 2,
@@ -50,6 +52,7 @@ namespace MoReFEM
};
+ //! \copydoc doxygen_hide_boundary_condition_enum
enum class BoundaryConditionIndex
{
face1 = 1,
@@ -58,36 +61,44 @@ namespace MoReFEM
};
- enum class FEltSpaceIndex
+ //! \copydoc doxygen_hide_felt_space_enum
+ enum class FEltSpaceIndex
{
highest_dimension = 1,
surface_pressure = 2
};
- enum class UnknownIndex
+ //! \copydoc doxygen_hide_unknown_enum
+ enum class UnknownIndex
{
displacement = 1
};
- enum class NumberingSubsetIndex
+ //! \copydoc doxygen_hide_numbering_subset_enum
+ enum class NumberingSubsetIndex
{
monolithic = 1
};
- enum class SolverIndex
+ //! \copydoc doxygen_hide_solver_enum
+ enum class SolverIndex
+
{
solver = 1
};
+
+ //! \copydoc doxygen_hide_initial_condition_enum
enum class InitialConditionIndex
{
displacement_initial_condition = 1
};
+ //! \copydoc doxygen_hide_input_parameter_tuple
using InputParameterTuple = std::tuple
<
InputParameter::TimeManager,
@@ -129,10 +140,13 @@ namespace MoReFEM
>;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = InputParameterList<InputParameterTuple>;
+ //! \copydoc doxygen_hide_morefem_data_type
using morefem_data_type = MoReFEMData<InputParameterList>;
+ //! \copydoc doxygen_hide_morefem_data_type
using morefem_data_type = MoReFEMData<InputParameterList>;
diff --git a/Sources/ModelInstances/RivlinCube/Model.hpp b/Sources/ModelInstances/RivlinCube/Model.hpp
index 85a7d45cbd003fe4e12e078cfe31da272a402c49..f4759899070a8842cc5fc5666a7c7fdb5d1c6c86 100644
--- a/Sources/ModelInstances/RivlinCube/Model.hpp
+++ b/Sources/ModelInstances/RivlinCube/Model.hpp
@@ -27,6 +27,7 @@ namespace MoReFEM
{
+ //! \copydoc doxygen_hide_simple_model
class Model : public MoReFEM::Model<Model, DoConsiderProcessorWiseLocal2Global::yes>
{
@@ -38,7 +39,7 @@ namespace MoReFEM
//! Convenient alias.
using parent = MoReFEM::Model<Model, DoConsiderProcessorWiseLocal2Global::yes>;
- //! Convenient alias.
+ //! \copydoc doxygen_hide_morefem_data_type
using morefem_data_type = MoReFEMData<InputParameterList>;
public:
@@ -57,7 +58,7 @@ namespace MoReFEM
/*!
* \brief Constructor.
*
- * \copydetails doxygen_hide_mpi_param
+ * \copydoc doxygen_hide_input_parameter_data_arg
*/
Model(const morefem_data_type& input_parameter_data);
@@ -87,6 +88,7 @@ namespace MoReFEM
* \brief Initialise the problem.
*
* This initialisation includes the resolution of the static problem.
+ * \copydoc doxygen_hide_morefem_data_param
*/
void SupplInitialize(const morefem_data_type& morefem_data);
@@ -121,12 +123,7 @@ namespace MoReFEM
private:
- /*!
- * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of
- * maximum time).
- *
- * Returns always true (no such additional condition in this Model).
- */
+ //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true
bool SupplHasFinishedConditions() const;
diff --git a/Sources/ModelInstances/RivlinCube/VariationalFormulation.hpp b/Sources/ModelInstances/RivlinCube/VariationalFormulation.hpp
index 3d679ba43a8be0109def24e861e932023eaf0100..1040b445a9e0953700b7bde0892573e126f5d491 100644
--- a/Sources/ModelInstances/RivlinCube/VariationalFormulation.hpp
+++ b/Sources/ModelInstances/RivlinCube/VariationalFormulation.hpp
@@ -63,6 +63,7 @@ namespace MoReFEM
{
+ //! \copydoc doxygen_hide_simple_varf
class VariationalFormulation
: public MoReFEM::VariationalFormulation
<
@@ -97,18 +98,23 @@ namespace MoReFEM
HyperelasticLawNS::MooneyRivlin
>;
+ //! Alias to hyperelastic law used.
using hyperelastic_law_type = HyperelasticLawNS::MooneyRivlin;
+ //! Alias to hyperelastic policy.
using hyperelasticity_policy =
GlobalVariationalOperatorNS::SecondPiolaKirchhoffStressTensorNS::HyperelasticityPolicyNS
::Hyperelasticity<hyperelastic_law_type>;
+ //! Alias to viscoelastic policy.
using ViscoelasticityPolicy =
GlobalVariationalOperatorNS::SecondPiolaKirchhoffStressTensorNS::ViscoelasticityPolicyNS::None;
+ //! Alias to acgtive stress policy.
using ActiveStressPolicy =
GlobalVariationalOperatorNS::SecondPiolaKirchhoffStressTensorNS::ActiveStressPolicyNS::None;
+ //! Alias to the type of the stiffness operator to use.
using StiffnessOperatorType =
GlobalVariationalOperatorNS::SecondPiolaKirchhoffStressTensor
<
@@ -130,10 +136,7 @@ namespace MoReFEM
/// \name Special members.
///@{
- /*!
- * \brief Constructor.
- *
- */
+ //! copydoc doxygen_hide_varf_constructor
explicit VariationalFormulation(const morefem_data_type& morefem_data,
const NumberingSubset& numbering_subset,
TimeManager& time_manager,
@@ -161,6 +164,8 @@ namespace MoReFEM
* \brief Get the only numbering subset relevant for this VariationalFormulation.
*
* There is a more generic accessor in the base class but is use is more unwieldy.
+ *
+ * \return Only \a NumberingSubset relevant for the variational formulation.
*/
const NumberingSubset& GetNumberingSubset() const;
@@ -172,11 +177,7 @@ namespace MoReFEM
/// \name CRTP-required methods.
///@{
- /*!
- * \brief Specific initialisation for derived class attributes.
- *
- * \internal <b><tt>[internal]</tt></b> This method is called by base class method VariationalFormulation::Init().
- */
+ //! \copydoc doxygen_hide_varf_suppl_init
void SupplInit(const InputParameterList& input_parameter_data);
/*!
@@ -208,10 +209,12 @@ namespace MoReFEM
*
* \param[in,out] snes SNES object. Not explicitly used but required by Petsc prototype.
* \param[in,out] evaluationState State at which to evaluate residual.
- * \param[in,out] residual Vector to put residual. What is used as residual in VariationalFormulation is #RHS().
+ * \param[in,out] residual Vector to put residual. What is used as residual in VariationalFormulation is
+ * \a GetSystemRHS().
* \param[in,out] context_as_void Optional user-defined function context. In our case a pointer to the
* VariationalFormulationT object.
*
+ * \return Petsc error code.
*/
static PetscErrorCode Function(SNES snes, Vec evaluationState, Vec residual, void* context_as_void);
@@ -226,6 +229,8 @@ namespace MoReFEM
* \param[in] norm Current L^2 norm.
* \param[in] context_as_void Optional user-defined function context. In our case is is a pointer to a
* VariationalFormulationT object.
+ *
+ * \return Petsc error code.
*/
static PetscErrorCode Viewer(SNES snes, PetscInt its, PetscReal norm, void* context_as_void);
@@ -233,9 +238,12 @@ namespace MoReFEM
/*!
* \brief This function is supposed to be given to SNES to compute the jacobian.
*
- * However the jacobian has already been computed within SnesFunctionImpl, so this function is mostly a dummy one...
+ * \copydoc doxygen_hide_snes_interface_common_arg
+ * \param[in,out] evaluation_state Most recent value of the quantity the solver tries to compute.
+ * \param[in,out] jacobian Jacobian matrix. Actually unused in our wrapper.
+ * \param[in,out] preconditioner Preconditioner matrix. Actually unused in our wrapper.
*/
- static PetscErrorCode Jacobian(SNES snes, Vec evaluationState, Mat jacobian , Mat preconditioner,
+ static PetscErrorCode Jacobian(SNES snes, Vec evaluation_state, Mat jacobian , Mat preconditioner,
void* context_as_void);
@@ -350,6 +358,8 @@ namespace MoReFEM
* \internal <b><tt>[internal]</tt></b> This accessor should not be used except in the Snes::Function() method: the point is to
* store the value given by Petsc internal Newton algorithm.
* Its value should be modified only through the call if \a UpdateEvaluationState().
+ *
+ * \return Reference to the evaluation state vector.
*/
GlobalVector& GetNonCstEvaluationState() noexcept;
@@ -382,9 +392,10 @@ namespace MoReFEM
private:
- /// \name NUmbering subsets used in the formulation.
+ /// \name Numbering subsets used in the formulation.
///@{
+ //! Only relevant \a NumberingSubset
const NumberingSubset& numbering_subset_;
///@}
diff --git a/Sources/ModelInstances/RivlinCube/main.cpp b/Sources/ModelInstances/RivlinCube/main.cpp
index dad39d5e215a8e46772d03bdab0beffd2d1fab32..af2cc7db8540e2b7f4ad93791062a27545f7a4ca 100644
--- a/Sources/ModelInstances/RivlinCube/main.cpp
+++ b/Sources/ModelInstances/RivlinCube/main.cpp
@@ -21,7 +21,8 @@ using namespace MoReFEM;
int main(int argc, char** argv)
{
- using InputParameterList = RivlinCubeNS::InputParameterList;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = RivlinCubeNS::InputParameterList;
try
{
diff --git a/Sources/ModelInstances/RivlinCube/main_ensight_output.cpp b/Sources/ModelInstances/RivlinCube/main_ensight_output.cpp
index fa15b8d70ccc1848dbc5a731a93a5c6c2647538e..4558d1ec9910590f05d4c59a5f7e041ff950e0c8 100644
--- a/Sources/ModelInstances/RivlinCube/main_ensight_output.cpp
+++ b/Sources/ModelInstances/RivlinCube/main_ensight_output.cpp
@@ -29,6 +29,7 @@ int main(int argc, char** argv)
try
{
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = RivlinCubeNS::InputParameterList;
MoReFEMData<InputParameterList, Utilities::InputParameterListNS::DoTrackUnusedFields::no> morefem_data(argc, argv);
diff --git a/Sources/ModelInstances/Stokes/InputParameterList.hpp b/Sources/ModelInstances/Stokes/InputParameterList.hpp
index fb2f320e7a3c3735d9cf73dba662279e7fe29cd4..e0c21e90f3166f487ad9f19ed2c093bb919f16c1 100644
--- a/Sources/ModelInstances/Stokes/InputParameterList.hpp
+++ b/Sources/ModelInstances/Stokes/InputParameterList.hpp
@@ -29,13 +29,15 @@ namespace MoReFEM
{
- enum class MeshIndex
+ //! \copydoc doxygen_hide_mesh_enum
+ enum class MeshIndex
{
mesh = 1 // only one mesh considered in current model!
};
- enum class DomainIndex
+ //! \copydoc doxygen_hide_domain_enum
+ enum class DomainIndex
{
highest_dimension = 1,
neumann = 2,
@@ -44,33 +46,39 @@ namespace MoReFEM
};
- enum class FEltSpaceIndex
+ //! \copydoc doxygen_hide_felt_space_enum
+ enum class FEltSpaceIndex
{
highest_dimension = 1,
neumann = 2
};
- enum class UnknownIndex
+ //! \copydoc doxygen_hide_unknown_enum
+ enum class UnknownIndex
{
velocity = 1,
pressure = 2
};
- enum class SolverIndex
+ //! \copydoc doxygen_hide_solver_enum
+ enum class SolverIndex
+
{
solver = 1
};
- enum class NumberingSubsetIndex
+ //! \copydoc doxygen_hide_numbering_subset_enum
+ enum class NumberingSubsetIndex
{
velocity_or_monolithic = 1,
pressure_or_irrelevant = 2
};
+ //! \copydoc doxygen_hide_source_enum
enum class SourceIndex
{
volumic = 1,
@@ -78,6 +86,7 @@ namespace MoReFEM
};
+ //! \copydoc doxygen_hide_boundary_condition_enum
enum class BoundaryConditionIndex
{
sole = 1
@@ -85,6 +94,7 @@ namespace MoReFEM
+ //! \copydoc doxygen_hide_input_parameter_tuple
using InputParameterTuple = std::tuple
<
InputParameter::TimeManager,
@@ -118,8 +128,12 @@ namespace MoReFEM
>;
+ //! \copydoc doxygen_hide_morefem_data_type
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = InputParameterList<InputParameterTuple>;
+ //! \copydoc doxygen_hide_morefem_data_type
+ //! \copydoc doxygen_hide_morefem_data_type
using morefem_data_type = MoReFEMData<InputParameterList>;
diff --git a/Sources/ModelInstances/Stokes/Model.hpp b/Sources/ModelInstances/Stokes/Model.hpp
index d18c256b0cf11c2b093c43ae49f18b01a0eebdf4..cfb66994ca983d1a7785935ef5dd71b21d798a6d 100644
--- a/Sources/ModelInstances/Stokes/Model.hpp
+++ b/Sources/ModelInstances/Stokes/Model.hpp
@@ -25,6 +25,7 @@ namespace MoReFEM
{
+ //! \copydoc doxygen_hide_simple_model
class Model final : public MoReFEM::Model<Model, DoConsiderProcessorWiseLocal2Global::no>
{
@@ -49,7 +50,7 @@ namespace MoReFEM
/*!
* \brief Constructor.
*
- * \copydetails doxygen_hide_mpi_param
+ * \copydoc doxygen_hide_morefem_data_param
*/
Model(const morefem_data_type& morefem_data);
@@ -79,6 +80,7 @@ namespace MoReFEM
* \brief Initialise the problem.
*
* This initialisation includes the resolution of the static problem.
+ * \copydoc doxygen_hide_morefem_data_param
*/
void SupplInitialize(const morefem_data_type& morefem_data);
@@ -111,12 +113,7 @@ namespace MoReFEM
- /*!
- * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of
- * maximum time).
- *
- * Returns always true (no such additional condition in this Model).
- */
+ //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true
bool SupplHasFinishedConditions() const;
diff --git a/Sources/ModelInstances/Stokes/VariationalFormulation.hpp b/Sources/ModelInstances/Stokes/VariationalFormulation.hpp
index cea00b6176d0b4a74ec9dffdf288e96ecb79af0e..5b799376e04d6072bafab6f48549f4fe0e9a7744 100644
--- a/Sources/ModelInstances/Stokes/VariationalFormulation.hpp
+++ b/Sources/ModelInstances/Stokes/VariationalFormulation.hpp
@@ -36,6 +36,7 @@ namespace MoReFEM
{
+ //! \copydoc doxygen_hide_simple_varf
class VariationalFormulation final
: public MoReFEM::VariationalFormulation
<
@@ -54,6 +55,7 @@ namespace MoReFEM
private:
+ //! Alias to the parent class.
using parent = MoReFEM::VariationalFormulation
<
VariationalFormulation,
@@ -72,6 +74,7 @@ namespace MoReFEM
//! Alias to shared pointer.
using unique_ptr = std::unique_ptr<self>;
+ //! Alias to the convenient flavor of \a ScalarParameter.
using scalar_parameter = ScalarParameter<ParameterNS::TimeDependencyNS::None>;
public:
@@ -79,11 +82,7 @@ namespace MoReFEM
/// \name Special members.
///@{
- /*!
- * \brief Constructor.
- *
- * \copydetails doxygen_hide_mpi_param
- */
+ //! copydoc doxygen_hide_varf_constructor
explicit VariationalFormulation(const morefem_data_type& morefem_data,
const NumberingSubset& velocity_numbering_subset,
const NumberingSubset& pressure_numbering_subset,
@@ -120,6 +119,8 @@ namespace MoReFEM
* Might be the same as the one for pressure for monolithic management.
*
* There is a more generic accessor in the base class but is use is more unwieldy.
+ *
+ * \return \a NumberingSubset in charge of the velocity unknown.
*/
const NumberingSubset& GetVelocityNumberingSubset() const;
@@ -129,6 +130,8 @@ namespace MoReFEM
* Might be the same as the one for velocity for monolithic management.
*
* There is a more generic accessor in the base class but is use is more unwieldy.
+ *
+ * \return \a NumberingSubset in charge of the pressure unknown.
*/
const NumberingSubset& GetPressureNumberingSubset() const;
@@ -139,13 +142,7 @@ namespace MoReFEM
/// \name CRTP-required methods.
///@{
-
-
- /*!
- * \brief Specific initialisation for derived class attributes.
- *
- * \internal <b><tt>[internal]</tt></b> This method is called by base class method VariationalFormulation::Init().
- */
+ //! \copydoc doxygen_hide_varf_suppl_init
void SupplInit(const InputParameterList& input_parameter_data);
/*!
diff --git a/Sources/ModelInstances/Stokes/main.cpp b/Sources/ModelInstances/Stokes/main.cpp
index c9e55d77c4ed698c16f0a4b9229c7f492fc91bcf..2ce0e7a7a2a231585f2585e7325338c70cfc88e5 100644
--- a/Sources/ModelInstances/Stokes/main.cpp
+++ b/Sources/ModelInstances/Stokes/main.cpp
@@ -21,7 +21,8 @@ using namespace MoReFEM;
int main(int argc, char** argv)
{
- using InputParameterList = StokesNS::InputParameterList;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = StokesNS::InputParameterList;
try
{
diff --git a/Sources/ModelInstances/Stokes/main_ensight_output_monolithic.cpp b/Sources/ModelInstances/Stokes/main_ensight_output_monolithic.cpp
index 9b440710f181807472b0b54e16bfab06f6082e87..0890fbfd1ff094749dc64ef56230badb05cd636c 100644
--- a/Sources/ModelInstances/Stokes/main_ensight_output_monolithic.cpp
+++ b/Sources/ModelInstances/Stokes/main_ensight_output_monolithic.cpp
@@ -29,6 +29,7 @@ int main(int argc, char** argv)
try
{
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = StokesNS::InputParameterList;
MoReFEMData<InputParameterList, Utilities::InputParameterListNS::DoTrackUnusedFields::no> morefem_data(argc, argv);
diff --git a/Sources/OperatorInstances/VariationalOperator/BilinearForm/Local/ScalarDivVectorial.hpp b/Sources/OperatorInstances/VariationalOperator/BilinearForm/Local/ScalarDivVectorial.hpp
index c72a8c3d69b85b26501ae10c03c4dc597acd144e..7704be467710b45365f799fb59c9c0e9ce90dc29 100644
--- a/Sources/OperatorInstances/VariationalOperator/BilinearForm/Local/ScalarDivVectorial.hpp
+++ b/Sources/OperatorInstances/VariationalOperator/BilinearForm/Local/ScalarDivVectorial.hpp
@@ -159,6 +159,7 @@ namespace MoReFEM
private:
//! Convenient enum to tag each of the two \a Unknowns considered.
+ //! \copydoc doxygen_hide_unknown_enum
enum class UnknownIndex
{
vectorial = 0,
diff --git a/Sources/OperatorInstances/VariationalOperator/BilinearForm/Local/Stokes.hpp b/Sources/OperatorInstances/VariationalOperator/BilinearForm/Local/Stokes.hpp
index 6353d2172e1cd03ab8cfb499187ac49429864a3a..959f85ceafb1e3523cab6ecf83b9c89ae94559d2 100644
--- a/Sources/OperatorInstances/VariationalOperator/BilinearForm/Local/Stokes.hpp
+++ b/Sources/OperatorInstances/VariationalOperator/BilinearForm/Local/Stokes.hpp
@@ -164,6 +164,7 @@ namespace MoReFEM
private:
//! Convenient enum to tag each of the two \a Unknowns considered.
+ //! \copydoc doxygen_hide_unknown_enum
enum class UnknownIndex
{
vectorial = 0,
diff --git a/Sources/OperatorInstances/VariationalOperator/LinearForm/Local/NonLinearSource/ReactionLaw/Instantiations/CourtemancheRamirezNattel.hpp b/Sources/OperatorInstances/VariationalOperator/LinearForm/Local/NonLinearSource/ReactionLaw/Instantiations/CourtemancheRamirezNattel.hpp
index 5dc223ce32f75f48af923e401d479c461a4aea5b..47557603ee505c121e99ab6ee66abf406ff1f3f2 100644
--- a/Sources/OperatorInstances/VariationalOperator/LinearForm/Local/NonLinearSource/ReactionLaw/Instantiations/CourtemancheRamirezNattel.hpp
+++ b/Sources/OperatorInstances/VariationalOperator/LinearForm/Local/NonLinearSource/ReactionLaw/Instantiations/CourtemancheRamirezNattel.hpp
@@ -204,7 +204,7 @@ namespace MoReFEM
* \param[in] index Index of the sought \a Parameter. To make the code more readable, use the enum class:
* \code
* decltype(auto) nsr_param = GetNonCstParameter(EnumUnderlyingType(parameter_index::nsr));
- * \endcode
+ \endcode
*
* \return Reference to the required \a Parameter.
*/
@@ -217,7 +217,7 @@ namespace MoReFEM
* \param[in] index Index of the sought \a Parameter. To make the code more readable, use the enum class:
* \code
* decltype(auto) nsr_param = GetParameter(EnumUnderlyingType(parameter_index::nsr));
- * \endcode
+ \endcode
*
* \return Constant reference to the required \a Parameter.
*/
diff --git a/Sources/Operators/ConformInterpolator/Advanced/SourceOrTargetData.hpp b/Sources/Operators/ConformInterpolator/Advanced/SourceOrTargetData.hpp
index bd23a73a837c2690f13744cd99c5ea69d5cd3101..5f53d8500954660cfc27c7a20934af6ebae9f95c 100644
--- a/Sources/Operators/ConformInterpolator/Advanced/SourceOrTargetData.hpp
+++ b/Sources/Operators/ConformInterpolator/Advanced/SourceOrTargetData.hpp
@@ -177,7 +177,7 @@ namespace MoReFEM
//! Numbering subset.
const NumberingSubset& numbering_subset_;
- //! NUmber of unknown components considered in the felt space/numbering subset.
+ //! Number of unknown components considered in the felt space/numbering subset.
int Nunknown_component_ = 0;
/*!
diff --git a/Sources/Operators/GlobalVariationalOperator/Internal/GlobalVariationalOperator.hpp b/Sources/Operators/GlobalVariationalOperator/Internal/GlobalVariationalOperator.hpp
index 01d53eab136cfd05ae45371379d579261d148776..145af118bfff1ca9aa1e5f3360727ddcd3d46231 100644
--- a/Sources/Operators/GlobalVariationalOperator/Internal/GlobalVariationalOperator.hpp
+++ b/Sources/Operators/GlobalVariationalOperator/Internal/GlobalVariationalOperator.hpp
@@ -212,7 +212,9 @@ namespace MoReFEM
*
* \copydoc doxygen_hide_operator_do_allocate_gradient_felt_phi_arg
* \param[in] args Variadic arguments that will be perfect-forwarded to the constructor of each
- * LocalVariationalOperator. For instance Force needs the definition of the force applied, so its prototype will be:
+ * LocalVariationalOperator. For instance Force needs the definition of the force applied, so its
+ * prototype will be:
+ *
* \code
* Force(const InputParameterDataT& input_parameter_data,
* const FEltSpace& felt_space,
diff --git a/Sources/Parameters/Policy/AtDof/AtDof.hxx b/Sources/Parameters/Policy/AtDof/AtDof.hxx
index 72846af26942ae011f649dd68c35f70579be2470..96ae8f02cad81079a1416afcca3ad13c52f54d23 100644
--- a/Sources/Parameters/Policy/AtDof/AtDof.hxx
+++ b/Sources/Parameters/Policy/AtDof/AtDof.hxx
@@ -9,7 +9,6 @@
/// \addtogroup ParametersGroup
/// \{
-
#ifndef MOREFEM_x_PARAMETERS_x_POLICY_x_AT_DOF_x_AT_DOF_HXX_
# define MOREFEM_x_PARAMETERS_x_POLICY_x_AT_DOF_x_AT_DOF_HXX_
diff --git a/Sources/Parameters/Policy/AtQuadraturePoint/AtQuadraturePoint.hpp b/Sources/Parameters/Policy/AtQuadraturePoint/AtQuadraturePoint.hpp
index 73f93f90c39495149ddcb29164df538e6357d9d5..018ffe8eba34babee956e48cebd6f4989f33bc9e 100644
--- a/Sources/Parameters/Policy/AtQuadraturePoint/AtQuadraturePoint.hpp
+++ b/Sources/Parameters/Policy/AtQuadraturePoint/AtQuadraturePoint.hpp
@@ -170,6 +170,7 @@ namespace MoReFEM
*
*
* \tparam UpdateFunctorT The expected prototype of the update_functor functor is:
+ *
* \code
* [](storage_value_type& value_to_modify) -> void
* \endcode
diff --git a/Sources/Parameters/TimeDependency/TimeDependency.hpp b/Sources/Parameters/TimeDependency/TimeDependency.hpp
index e5770458e8d98abcaf87396a4d77ed76b3de3459..fc4682eb147a03645062071a9b38e87f16b7ef40 100644
--- a/Sources/Parameters/TimeDependency/TimeDependency.hpp
+++ b/Sources/Parameters/TimeDependency/TimeDependency.hpp
@@ -180,7 +180,7 @@ namespace MoReFEM
/// \name Accessors
///@{
- //! Constant accessor to the value of TimeManager::NtimesModified() at the last Update() call.
+ //! Constant accessor to the value of \a TimeManager::NtimesModified() at the last \a Update() call.
unsigned int GetNtimesModifiedAtLastUpdate() const noexcept;
///@}
diff --git a/Sources/PostProcessing/ConvertLinearAlgebra/Freefem/MatrixConversion.hpp b/Sources/PostProcessing/ConvertLinearAlgebra/Freefem/MatrixConversion.hpp
index 820cd48d4474468c0b10a2496804a3b389c5d561..9c204f2d12519486ac618d2b537c20cdf7f3efd7 100644
--- a/Sources/PostProcessing/ConvertLinearAlgebra/Freefem/MatrixConversion.hpp
+++ b/Sources/PostProcessing/ConvertLinearAlgebra/Freefem/MatrixConversion.hpp
@@ -97,12 +97,13 @@ namespace MoReFEM
* through Matrix::ViewBinary() method.
* \param[in] freefem_numbering_informations_file Freefem proceeds to an ad hoc renumbering
* for shape functions other than P1; we need this information to map MoReFEM dofs to Freefem's.
+ *
* So we just need a file which gives the following information:
* \verbatim
- * 10 14 9 12
- * 10 9 6 5
- * ...
- * \endverbatim
+ 10 14 9 12
+ 10 9 6 5
+ ...
+ \endverbatim
* where each line provide the list of dofs for the geometric element that share the line number
* Dofs on vertex come first, then on edges, then on faces.
* See #936 discussion for more details (and for the informations from Freefem's author).
diff --git a/Sources/PostProcessing/RefineMeshQuadranglesSpectral/Model.hpp b/Sources/PostProcessing/RefineMeshQuadranglesSpectral/Model.hpp
index 8ac520818ea729be37b106c43e3016e53cdb0fb9..58019da9870d99a40882e9fa5f6d00d3da46ca32 100644
--- a/Sources/PostProcessing/RefineMeshQuadranglesSpectral/Model.hpp
+++ b/Sources/PostProcessing/RefineMeshQuadranglesSpectral/Model.hpp
@@ -117,13 +117,7 @@ namespace MoReFEM
private:
- /*!
- * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of
- * maximum time).
- *
- *
- * \return Always true (no such additional condition in this Model).
- */
+ //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true
bool SupplHasFinishedConditions() const;
diff --git a/Sources/PostProcessing/RefineMeshQuadranglesSpectral/RefineMesh.cpp b/Sources/PostProcessing/RefineMeshQuadranglesSpectral/RefineMesh.cpp
index 246091f7aa6fc2d4a2740b89bdc4d4dace67c0e3..8f1d6fa31b7dfd2e12d821c727420c800a5fe3b4 100644
--- a/Sources/PostProcessing/RefineMeshQuadranglesSpectral/RefineMesh.cpp
+++ b/Sources/PostProcessing/RefineMeshQuadranglesSpectral/RefineMesh.cpp
@@ -9,7 +9,6 @@
/// \addtogroup PostProcessingGroup
/// \{
-
#include <memory>
#include <vector>
diff --git a/Sources/PostProcessing/main_convert_matrix_to_freefem.cpp b/Sources/PostProcessing/main_convert_matrix_to_freefem.cpp
index 5658b62bd54bc1985d329bbdc3db3711d39586e5..678e928745bfbf0e280eba528ca54547d4c641b2 100644
--- a/Sources/PostProcessing/main_convert_matrix_to_freefem.cpp
+++ b/Sources/PostProcessing/main_convert_matrix_to_freefem.cpp
@@ -37,6 +37,7 @@ int main(int argc, char** argv)
{
using Mesh = InputParameter::Mesh<1>;
+ //! \copydoc doxygen_hide_input_parameter_tuple
using InputParameterTuple = std::tuple
<
InputParameter::Mesh<mesh_id>,
@@ -46,6 +47,7 @@ int main(int argc, char** argv)
InputParameter::Result::OutputDirectory
>;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = InputParameterList<InputParameterTuple>;
MoReFEMData<InputParameterList, Utilities::InputParameterListNS::DoTrackUnusedFields::no> morefem_data(argc, argv);
diff --git a/Sources/PostProcessing/main_refined_mesh_output.cpp b/Sources/PostProcessing/main_refined_mesh_output.cpp
index 699aa969b13ae2c2dd00c7716493b80cbc07d614..5e62f58290b655a3e2550c9a8e2f0eb85c3e2016 100644
--- a/Sources/PostProcessing/main_refined_mesh_output.cpp
+++ b/Sources/PostProcessing/main_refined_mesh_output.cpp
@@ -43,6 +43,7 @@ int main(int argc, char** argv)
{
+ //! \copydoc doxygen_hide_input_parameter_tuple
using InputParameterTuple = std::tuple
<
InputParameter::TimeManager,
@@ -60,6 +61,7 @@ int main(int argc, char** argv)
InputParameter::Result
>;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = InputParameterList<InputParameterTuple>;
MoReFEMData<InputParameterList, Utilities::InputParameterListNS::DoTrackUnusedFields::no> morefem_data(argc, argv);
diff --git a/Sources/Test/Core/VariableTimeStep/InputParameterList.hpp b/Sources/Test/Core/VariableTimeStep/InputParameterList.hpp
index 4b135c2e9030ecdd8b602cb9fad6890a58bede18..b2f27624a3c988664553bef94d76b367f1ff9016 100644
--- a/Sources/Test/Core/VariableTimeStep/InputParameterList.hpp
+++ b/Sources/Test/Core/VariableTimeStep/InputParameterList.hpp
@@ -25,42 +25,50 @@ namespace MoReFEM
{
- enum class MeshIndex
+ //! \copydoc doxygen_hide_mesh_enum
+ enum class MeshIndex
{
mesh = 1
};
- enum class DomainIndex
+ //! \copydoc doxygen_hide_domain_enum
+ enum class DomainIndex
{
full_mesh = 1
};
- enum class FEltSpaceIndex
+ //! \copydoc doxygen_hide_felt_space_enum
+ enum class FEltSpaceIndex
{
index = 1
};
- enum class UnknownIndex
+ //! \copydoc doxygen_hide_unknown_enum
+ enum class UnknownIndex
{
scalar = 1
};
- enum class SolverIndex
+ //! \copydoc doxygen_hide_solver_enum
+ enum class SolverIndex
+
{
solver = 1
};
- enum class NumberingSubsetIndex
+ //! \copydoc doxygen_hide_numbering_subset_enum
+ enum class NumberingSubsetIndex
{
scalar = 1
};
+ //! \copydoc doxygen_hide_input_parameter_tuple
using InputParameterTuple = std::tuple
<
InputParameter::TimeManager,
@@ -81,8 +89,10 @@ namespace MoReFEM
>;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = InputParameterList<InputParameterTuple>;
+ //! \copydoc doxygen_hide_morefem_data_type
using morefem_data_type = MoReFEMData<InputParameterList>;
diff --git a/Sources/Test/Core/VariableTimeStep/Model.hpp b/Sources/Test/Core/VariableTimeStep/Model.hpp
index 36cd950f971d1c08d9a3ad81954cf9dc6116d7c4..3ef5d02d2d574a39e923f4a19cd0fe9962406288 100644
--- a/Sources/Test/Core/VariableTimeStep/Model.hpp
+++ b/Sources/Test/Core/VariableTimeStep/Model.hpp
@@ -23,6 +23,7 @@ namespace MoReFEM
{
+ //! \copydoc doxygen_hide_model_4_test
class Model : public MoReFEM::Model<Model, DoConsiderProcessorWiseLocal2Global::yes>
{
@@ -50,8 +51,7 @@ namespace MoReFEM
/*!
* \brief Constructor.
*
- * \copydetails doxygen_hide_mpi_param
- * \copydoc doxygen_hide_input_parameter_data_arg
+ * \copydoc doxygen_hide_morefem_data_param
*/
Model(const morefem_data_type& morefem_data);
@@ -81,7 +81,7 @@ namespace MoReFEM
* \brief Initialise the problem.
*
* This initialisation includes the resolution of the static problem.
- * \copydoc doxygen_hide_input_parameter_data_arg
+ * \copydoc doxygen_hide_morefem_data_param
*/
void SupplInitialize(const morefem_data_type& morefem_data);
@@ -108,12 +108,7 @@ namespace MoReFEM
private:
- /*!
- * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of
- * maximum time).
- *
- * Returns always true (no such additional condition in this Model).
- */
+ //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true
bool SupplHasFinishedConditions() const;
diff --git a/Sources/Test/Core/VariableTimeStep/main.cpp b/Sources/Test/Core/VariableTimeStep/main.cpp
index bd9e6245f1028fcb544f04fa14b5b00e08ca0908..62502784e9e6219f4a9817c66261fe84f7b9fed8 100644
--- a/Sources/Test/Core/VariableTimeStep/main.cpp
+++ b/Sources/Test/Core/VariableTimeStep/main.cpp
@@ -21,7 +21,8 @@ using namespace MoReFEM;
int main(int argc, char** argv)
{
- using InputParameterList = TestVariableTimeStepNS::InputParameterList;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = TestVariableTimeStepNS::InputParameterList;
try
{
diff --git a/Sources/Test/Geometry/Coloring/InputParameterList.hpp b/Sources/Test/Geometry/Coloring/InputParameterList.hpp
index 466ddea67288f741c9f66ed857e8792526aa4fc3..c174c3fb29bc9bf03a4dfb5ee45727d8352a93c4 100644
--- a/Sources/Test/Geometry/Coloring/InputParameterList.hpp
+++ b/Sources/Test/Geometry/Coloring/InputParameterList.hpp
@@ -22,71 +22,75 @@
namespace MoReFEM
{
-
-
+
+
namespace TestNS
{
-
-
+
+
namespace ColoringNS
{
-
-
+
+
+ //! Default value for some input parameter that are required by a MoReFEM model but are actually unused for current test.
enum class Unused
{
value = 1
};
-
-
+
+
+ //! \copydoc doxygen_hide_mesh_enum
enum class MeshIndex
{
mesh = 1
};
-
-
+
+
+ //! Enum used to index numbering subsets, domains and finite element spaces.
enum class DimensionIndex
{
Dim1 = 1,
Dim2 = 2
};
+
-
-
-
+ //! \copydoc doxygen_hide_input_parameter_tuple
using InputParameterTuple = std::tuple
<
InputParameter::TimeManager,
-
+
InputParameter::NumberingSubset<EnumUnderlyingType(DimensionIndex::Dim1)>,
InputParameter::NumberingSubset<EnumUnderlyingType(DimensionIndex::Dim2)>,
-
+
InputParameter::Unknown<EnumUnderlyingType(Unused::value)>,
-
+
InputParameter::Domain<EnumUnderlyingType(DimensionIndex::Dim1)>,
InputParameter::Domain<EnumUnderlyingType(DimensionIndex::Dim2)>,
-
+
InputParameter::FEltSpace<EnumUnderlyingType(DimensionIndex::Dim1)>,
InputParameter::FEltSpace<EnumUnderlyingType(DimensionIndex::Dim2)>,
-
+
InputParameter::Petsc<EnumUnderlyingType(Unused::value)>,
-
+
InputParameter::Mesh<EnumUnderlyingType(MeshIndex::mesh)>,
-
+
InputParameter::Result
>;
-
-
+
+
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = InputParameterList<InputParameterTuple>;
-
- using morefem_data_type = MoReFEMData<InputParameterList>;
-
-
+
+ //! \copydoc doxygen_hide_morefem_data_type
+ using morefem_data_type = MoReFEMData<InputParameterList>;
+
+
} // namespace P1_to_P_HigherOrder_NS
-
-
+
+
} // namespace TestNS
-
-
+
+
} // namespace MoReFEM
diff --git a/Sources/Test/Geometry/Coloring/Model.hpp b/Sources/Test/Geometry/Coloring/Model.hpp
index 196ce60ff7f43601c4f13e5837cb95d07d8905b7..85b63990de55a12ab06057b2592e4f0f884dfe64 100644
--- a/Sources/Test/Geometry/Coloring/Model.hpp
+++ b/Sources/Test/Geometry/Coloring/Model.hpp
@@ -28,6 +28,7 @@ namespace MoReFEM
{
+ //! \copydoc doxygen_hide_model_4_test
class Model : public MoReFEM::Model<Model, DoConsiderProcessorWiseLocal2Global::no>
{
@@ -55,7 +56,7 @@ namespace MoReFEM
/*!
* \brief Constructor.
*
- * \copydetails doxygen_hide_mpi_param
+ * \copydoc doxygen_hide_morefem_data_param
*/
Model(const morefem_data_type& morefem_data);
@@ -85,6 +86,7 @@ namespace MoReFEM
* \brief Initialise the problem.
*
* This initialisation includes the resolution of the static problem.
+ * \copydoc doxygen_hide_morefem_data_param
*/
void SupplInitialize(const morefem_data_type& morefem_data);
@@ -110,12 +112,7 @@ namespace MoReFEM
private:
- /*!
- * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of
- * maximum time).
- *
- * Returns always true (no such additional condition in this Model).
- */
+ //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true
bool SupplHasFinishedConditions() const;
diff --git a/Sources/Test/Geometry/Coloring/main_test_coloring.cpp b/Sources/Test/Geometry/Coloring/main_test_coloring.cpp
index ce1c94c5c6703c4cf2e3ad756a605c7011c1b4e6..c0094332a4b802f61f068d87065e1c2041e57c1e 100644
--- a/Sources/Test/Geometry/Coloring/main_test_coloring.cpp
+++ b/Sources/Test/Geometry/Coloring/main_test_coloring.cpp
@@ -26,7 +26,8 @@ int main(int argc, char** argv)
using namespace MoReFEM;
- using InputParameterList = TestNS::ColoringNS::InputParameterList;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = TestNS::ColoringNS::InputParameterList;
try
{
diff --git a/Sources/Test/Geometry/CoordsInParallel/InputParameterList.hpp b/Sources/Test/Geometry/CoordsInParallel/InputParameterList.hpp
index a52ab0c4bf2503a406dc2996f216b2844f4a8e67..dc0cf22f6449c14f002d6cb76a577b31044fdd36 100644
--- a/Sources/Test/Geometry/CoordsInParallel/InputParameterList.hpp
+++ b/Sources/Test/Geometry/CoordsInParallel/InputParameterList.hpp
@@ -29,6 +29,7 @@ namespace MoReFEM
{
+ //! \copydoc doxygen_hide_mesh_enum
enum class MeshIndex
{
mesh1 = 1,
@@ -36,6 +37,7 @@ namespace MoReFEM
};
+ //! \copydoc doxygen_hide_domain_enum
enum class DomainIndex
{
mesh1 = 1,
@@ -43,6 +45,7 @@ namespace MoReFEM
};
+ //! \copydoc doxygen_hide_felt_space_enum
enum class FEltSpaceIndex
{
mesh1 = 1,
@@ -50,18 +53,22 @@ namespace MoReFEM
};
+ //! \copydoc doxygen_hide_unknown_enum
enum class UnknownIndex
{
unknown = 1
};
+ //! \copydoc doxygen_hide_solver_enum
enum class SolverIndex
+
{
solver = 1
};
+ //! \copydoc doxygen_hide_numbering_subset_enum
enum class NumberingSubsetIndex
{
mesh1 = 1,
@@ -70,7 +77,8 @@ namespace MoReFEM
- using InputParameterTuple = std::tuple
+ //! \copydoc doxygen_hide_input_parameter_tuple
+ using InputParameterTuple = std::tuple
<
InputParameter::TimeManager,
@@ -95,8 +103,10 @@ namespace MoReFEM
>;
- using InputParameterList = InputParameterList<InputParameterTuple>;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = InputParameterList<InputParameterTuple>;
+ //! \copydoc doxygen_hide_morefem_data_type
using morefem_data_type = MoReFEMData<InputParameterList>;
diff --git a/Sources/Test/Geometry/CoordsInParallel/Model.hpp b/Sources/Test/Geometry/CoordsInParallel/Model.hpp
index 5a67e426918c3cfc49ee87911d967db932d1b2b0..5c0a094d9f5833f4b489ddbd06cd10ecc2254ad6 100644
--- a/Sources/Test/Geometry/CoordsInParallel/Model.hpp
+++ b/Sources/Test/Geometry/CoordsInParallel/Model.hpp
@@ -29,7 +29,8 @@ namespace MoReFEM
//! Model for the test of the behaviour of \a Coords after parallel reduction.
- class Model final : public MoReFEM::Model<Model, DoConsiderProcessorWiseLocal2Global::no>
+ //! \copydoc doxygen_hide_model_4_test
+ class Model final : public MoReFEM::Model<Model, DoConsiderProcessorWiseLocal2Global::no>
{
@@ -57,7 +58,7 @@ namespace MoReFEM
/*!
* \brief Constructor.
*
- * \copydetails doxygen_hide_mpi_param
+ * \copydoc doxygen_hide_morefem_data_param
*/
explicit Model(const morefem_data_type& morefem_data);
@@ -87,6 +88,7 @@ namespace MoReFEM
* \brief Initialise the problem.
*
* This initialisation includes the resolution of the static problem.
+ * \copydoc doxygen_hide_morefem_data_param
*/
void SupplInitialize(const morefem_data_type& morefem_data);
@@ -112,12 +114,7 @@ namespace MoReFEM
private:
- /*!
- * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of
- * maximum time).
- *
- * Returns always true (no such additional condition in this Model).
- */
+ //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true
bool SupplHasFinishedConditions() const;
diff --git a/Sources/Test/Geometry/CoordsInParallel/main.cpp b/Sources/Test/Geometry/CoordsInParallel/main.cpp
index d02f90ab06136d5e05a3ad0e90f23b9f8a6defa1..bf86df241dfcb4bb14a114e27f40f71c4b8912e0 100644
--- a/Sources/Test/Geometry/CoordsInParallel/main.cpp
+++ b/Sources/Test/Geometry/CoordsInParallel/main.cpp
@@ -20,7 +20,8 @@ using namespace MoReFEM;
int main(int argc, char** argv)
{
- using InputParameterList = TestNS::CoordsInParallelNS::InputParameterList;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = TestNS::CoordsInParallelNS::InputParameterList;
try
{
diff --git a/Sources/Test/Geometry/DomainListInCoords/InputParameterList.hpp b/Sources/Test/Geometry/DomainListInCoords/InputParameterList.hpp
index 2e40dd04c27aecce05d84b5f63483229e4509fa6..37b106221782f598bcaf7b21320c288a3987bf87 100644
--- a/Sources/Test/Geometry/DomainListInCoords/InputParameterList.hpp
+++ b/Sources/Test/Geometry/DomainListInCoords/InputParameterList.hpp
@@ -33,12 +33,14 @@ namespace MoReFEM
{
+ //! \copydoc doxygen_hide_mesh_enum
enum class MeshIndex
{
mesh = 1
};
+ //! \copydoc doxygen_hide_domain_enum
enum class DomainIndex
{
volume = 1,
@@ -48,9 +50,11 @@ namespace MoReFEM
};
+ //! Default value for some input parameter that are required by a MoReFEM model but are actually unused for current test.
constexpr auto whatever = 0;
+ //! \copydoc doxygen_hide_input_parameter_tuple
using InputParameterTuple = std::tuple
<
InputParameter::TimeManager,
@@ -73,9 +77,11 @@ namespace MoReFEM
>;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = InputParameterList<InputParameterTuple>;
- using morefem_data_type = MoReFEMData<InputParameterList>;
+ //! \copydoc doxygen_hide_morefem_data_type
+ using morefem_data_type = MoReFEMData<InputParameterList>;
} // namespace DomainListInCoordsNS
diff --git a/Sources/Test/Geometry/DomainListInCoords/Model.hpp b/Sources/Test/Geometry/DomainListInCoords/Model.hpp
index eb5e1897582205c625620dbcf0a500347efce9ea..d6055c96251fb64ceaa9a0b0be7afef9d0deb2fd 100644
--- a/Sources/Test/Geometry/DomainListInCoords/Model.hpp
+++ b/Sources/Test/Geometry/DomainListInCoords/Model.hpp
@@ -35,7 +35,8 @@ namespace MoReFEM
* \brief Toy model used to perform tests about variable domain.
*
*/
- class Model : public MoReFEM::Model<Model, DoConsiderProcessorWiseLocal2Global::no>
+ //! \copydoc doxygen_hide_model_4_test
+ class Model : public MoReFEM::Model<Model, DoConsiderProcessorWiseLocal2Global::no>
{
private:
@@ -63,7 +64,7 @@ namespace MoReFEM
/*!
* \brief Constructor.
*
- * \copydetails doxygen_hide_mpi_param
+ * \copydoc doxygen_hide_morefem_data_param
*/
Model(const morefem_data_type& morefem_data);
@@ -93,6 +94,7 @@ namespace MoReFEM
* \brief Initialise the problem.
*
* This initialisation includes the resolution of the static problem.
+ * \copydoc doxygen_hide_morefem_data_param
*/
void SupplInitialize(const morefem_data_type& morefem_data);
@@ -122,12 +124,7 @@ namespace MoReFEM
private:
- /*!
- * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of
- * maximum time).
- *
- * Returns always true (no such additional condition in this Model).
- */
+ //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true
bool SupplHasFinishedConditions() const;
diff --git a/Sources/Test/Geometry/DomainListInCoords/main.cpp b/Sources/Test/Geometry/DomainListInCoords/main.cpp
index fd251665f445f51d6575ba760e87da72f68307fa..ecad0178d0bc6322814b5bc5d7514f6f1de4733c 100644
--- a/Sources/Test/Geometry/DomainListInCoords/main.cpp
+++ b/Sources/Test/Geometry/DomainListInCoords/main.cpp
@@ -22,7 +22,8 @@ using namespace MoReFEM::TestNS;
int main(int argc, char** argv)
{
- using InputParameterList = DomainListInCoordsNS::InputParameterList;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = DomainListInCoordsNS::InputParameterList;
try
diff --git a/Sources/Test/Geometry/LightweightDomainList/InputParameterList.hpp b/Sources/Test/Geometry/LightweightDomainList/InputParameterList.hpp
index 21470d99bf259ffc8d16754a74b336e3572ccd67..a9842c9a70a4d134abd6c712b493a1d02d2f946a 100644
--- a/Sources/Test/Geometry/LightweightDomainList/InputParameterList.hpp
+++ b/Sources/Test/Geometry/LightweightDomainList/InputParameterList.hpp
@@ -33,42 +33,48 @@ namespace MoReFEM
{
+ //! \copydoc doxygen_hide_mesh_enum
enum class MeshIndex
{
mesh = 1
};
+ //! \copydoc doxygen_hide_domain_enum
enum class DomainIndex
{
domain = 1,
};
+ //! Default value for some input parameter that are required by a MoReFEM model but are actually unused for current test.
constexpr auto whatever = 0;
+ //! \copydoc doxygen_hide_input_parameter_tuple
using InputParameterTuple = std::tuple
<
InputParameter::TimeManager,
-
+
InputParameter::Mesh<EnumUnderlyingType(MeshIndex::mesh)>,
-
+
InputParameter::Domain<EnumUnderlyingType(DomainIndex::domain)>,
InputParameter::LightweightDomainList<1>,
-
+
InputParameter::Unknown<whatever>,
InputParameter::NumberingSubset<whatever>,
InputParameter::FEltSpace<whatever>,
InputParameter::Petsc<whatever>,
-
+
InputParameter::Result
>;
-
-
+
+
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = InputParameterList<InputParameterTuple>;
-
- using morefem_data_type = MoReFEMData<InputParameterList>;
+
+ //! \copydoc doxygen_hide_morefem_data_type
+ using morefem_data_type = MoReFEMData<InputParameterList>;
} // namespace P1_to_P_HigherOrder_NS
diff --git a/Sources/Test/Geometry/LightweightDomainList/Model.hpp b/Sources/Test/Geometry/LightweightDomainList/Model.hpp
index 94076b9a63a536b74fc61129861030e5d26dfd36..464eaff19f4b8f61de3586553695ea8e491846a0 100644
--- a/Sources/Test/Geometry/LightweightDomainList/Model.hpp
+++ b/Sources/Test/Geometry/LightweightDomainList/Model.hpp
@@ -35,7 +35,8 @@ namespace MoReFEM
* \brief Toy model used to perform tests about variable domain.
*
*/
- class Model : public MoReFEM::Model<Model, DoConsiderProcessorWiseLocal2Global::no>
+ //! \copydoc doxygen_hide_model_4_test
+ class Model : public MoReFEM::Model<Model, DoConsiderProcessorWiseLocal2Global::no>
{
private:
@@ -63,7 +64,7 @@ namespace MoReFEM
/*!
* \brief Constructor.
*
- * \copydetails doxygen_hide_mpi_param
+ * \copydoc doxygen_hide_morefem_data_param
*/
Model(const morefem_data_type& morefem_data);
@@ -93,6 +94,7 @@ namespace MoReFEM
* \brief Initialise the problem.
*
* This initialisation includes the resolution of the static problem.
+ * \copydoc doxygen_hide_morefem_data_param
*/
void SupplInitialize(const morefem_data_type& morefem_data);
@@ -122,12 +124,7 @@ namespace MoReFEM
private:
- /*!
- * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of
- * maximum time).
- *
- * Returns always true (no such additional condition in this Model).
- */
+ //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true
bool SupplHasFinishedConditions() const;
diff --git a/Sources/Test/Geometry/LightweightDomainList/main_test_lightweight_domain_list.cpp b/Sources/Test/Geometry/LightweightDomainList/main_test_lightweight_domain_list.cpp
index 5523868674dcb97d4c5dfafb001b64581a99a317..02f60d082bee48128590e0258cf318eb7ca906c0 100644
--- a/Sources/Test/Geometry/LightweightDomainList/main_test_lightweight_domain_list.cpp
+++ b/Sources/Test/Geometry/LightweightDomainList/main_test_lightweight_domain_list.cpp
@@ -22,7 +22,8 @@ using namespace MoReFEM::TestNS;
int main(int argc, char** argv)
{
- using InputParameterList = LightweightDomainListNS::InputParameterList;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = LightweightDomainListNS::InputParameterList;
try
diff --git a/Sources/Test/Geometry/Movemesh/InputParameterList.hpp b/Sources/Test/Geometry/Movemesh/InputParameterList.hpp
index 759fcacc834bc07973a105e04fcae01273ce8764..e93cd76c6c11ca2f03c8c55d1665ebd344cd67e0 100644
--- a/Sources/Test/Geometry/Movemesh/InputParameterList.hpp
+++ b/Sources/Test/Geometry/Movemesh/InputParameterList.hpp
@@ -26,43 +26,51 @@ namespace MoReFEM
{
- enum class MeshIndex
+ //! \copydoc doxygen_hide_mesh_enum
+ enum class MeshIndex
{
mesh = 1
};
- enum class DomainIndex
+ //! \copydoc doxygen_hide_domain_enum
+ enum class DomainIndex
{
domain = 1
};
- enum class FEltSpaceIndex
+ //! \copydoc doxygen_hide_felt_space_enum
+ enum class FEltSpaceIndex
{
felt_space = 1
};
- enum class UnknownIndex
+ //! \copydoc doxygen_hide_unknown_enum
+ enum class UnknownIndex
{
displacement = 1
};
- enum class SolverIndex
+ //! \copydoc doxygen_hide_solver_enum
+ enum class SolverIndex
+
{
solver = 1
};
- enum class NumberingSubsetIndex
+ //! \copydoc doxygen_hide_numbering_subset_enum
+ enum class NumberingSubsetIndex
{
subset = 1
};
+ //! \copydoc doxygen_hide_input_parameter_tuple
using InputParameterTuple = std::tuple
<
InputParameter::TimeManager,
@@ -83,8 +91,10 @@ namespace MoReFEM
>;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = InputParameterList<InputParameterTuple>;
+ //! \copydoc doxygen_hide_morefem_data_type
using morefem_data_type = MoReFEMData<InputParameterList>;
diff --git a/Sources/Test/Geometry/Movemesh/Model.hpp b/Sources/Test/Geometry/Movemesh/Model.hpp
index bff6d939fc7e2175fa370012159b25f9f12f91d8..a0bf237b69d009691af0f1ecc2442fe94b93aa79 100644
--- a/Sources/Test/Geometry/Movemesh/Model.hpp
+++ b/Sources/Test/Geometry/Movemesh/Model.hpp
@@ -24,6 +24,7 @@ namespace MoReFEM
{
+ //! \copydoc doxygen_hide_model_4_test
class Model : public MoReFEM::Model<Model, DoConsiderProcessorWiseLocal2Global::no>
{
@@ -51,7 +52,7 @@ namespace MoReFEM
/*!
* \brief Constructor.
*
- * \copydetails doxygen_hide_mpi_param
+ * \copydoc doxygen_hide_morefem_data_param
*/
Model(const morefem_data_type& morefem_data);
@@ -81,6 +82,7 @@ namespace MoReFEM
* \brief Initialise the problem.
*
* This initialisation includes the resolution of the static problem.
+ * \copydoc doxygen_hide_morefem_data_param
*/
void SupplInitialize(const morefem_data_type& morefem_data);
@@ -106,12 +108,7 @@ namespace MoReFEM
private:
- /*!
- * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of
- * maximum time).
- *
- * Returns always true (no such additional condition in this Model).
- */
+ //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true
bool SupplHasFinishedConditions() const;
diff --git a/Sources/Test/Geometry/Movemesh/main.cpp b/Sources/Test/Geometry/Movemesh/main.cpp
index 01d62bbfedb5b024f9085a0b021bc6f1d89bea1d..f04df64cc8c2216784bc3d070daabeae594ae4a5 100644
--- a/Sources/Test/Geometry/Movemesh/main.cpp
+++ b/Sources/Test/Geometry/Movemesh/main.cpp
@@ -19,7 +19,8 @@ using namespace MoReFEM;
int main(int argc, char** argv)
{
- using InputParameterList = TestNS::MovemeshNS::InputParameterList;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = TestNS::MovemeshNS::InputParameterList;
try
{
diff --git a/Sources/Test/Geometry/NcoordInDomain/InputParameterList.hpp b/Sources/Test/Geometry/NcoordInDomain/InputParameterList.hpp
index 0b57964ab3c4c9f527158dbf0f386ed97e8dcbb2..2b2b72e6eae3fe6b9246d5c85bb5c5bf050df4d9 100644
--- a/Sources/Test/Geometry/NcoordInDomain/InputParameterList.hpp
+++ b/Sources/Test/Geometry/NcoordInDomain/InputParameterList.hpp
@@ -25,51 +25,60 @@ namespace MoReFEM
{
- enum class MeshIndex
+ //! \copydoc doxygen_hide_mesh_enum
+ enum class MeshIndex
{
mesh = 1
};
- enum class DomainIndex
+ //! \copydoc doxygen_hide_domain_enum
+ enum class DomainIndex
{
full_mesh = 1
};
- enum class FEltSpaceIndex
+ //! \copydoc doxygen_hide_felt_space_enum
+ enum class FEltSpaceIndex
{
volume_potential_1_potential_2 = 1,
volume_displacement_potential_1 = 5,
};
- enum class UnknownIndex
+ //! \copydoc doxygen_hide_unknown_enum
+ enum class UnknownIndex
{
potential_1 = 1,
displacement = 5
};
- enum class NumberingSubsetIndex
+ //! \copydoc doxygen_hide_numbering_subset_enum
+ enum class NumberingSubsetIndex
{
potential_1 = 1,
displacement_potential_1 = 5,
};
- enum class SolverIndex
+ //! \copydoc doxygen_hide_solver_enum
+ enum class SolverIndex
+
{
solver = 1
};
+ //! \copydoc doxygen_hide_source_enum
enum class ForceIndexList : unsigned int
{
source = 1
};
+ //! \copydoc doxygen_hide_input_parameter_tuple
using InputParameterTuple = std::tuple
<
InputParameter::TimeManager,
@@ -93,8 +102,10 @@ namespace MoReFEM
>;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = InputParameterList<InputParameterTuple>;
+ //! \copydoc doxygen_hide_morefem_data_type
using morefem_data_type = MoReFEMData<InputParameterList>;
diff --git a/Sources/Test/Geometry/NcoordInDomain/Model.hpp b/Sources/Test/Geometry/NcoordInDomain/Model.hpp
index a4a35cd8224aca93c1696f267032073648af1201..379b7becd2c10fb45af5bbdfeecf9559bea16fbf 100644
--- a/Sources/Test/Geometry/NcoordInDomain/Model.hpp
+++ b/Sources/Test/Geometry/NcoordInDomain/Model.hpp
@@ -26,6 +26,7 @@ namespace MoReFEM
{
+ //! \copydoc doxygen_hide_model_4_test
class Model : public MoReFEM::Model<Model, DoConsiderProcessorWiseLocal2Global::yes>
{
@@ -53,7 +54,7 @@ namespace MoReFEM
/*!
* \brief Constructor.
*
- * \copydetails doxygen_hide_mpi_param
+ * \copydoc doxygen_hide_morefem_data_param
*/
Model(const morefem_data_type& morefem_data);
@@ -83,6 +84,7 @@ namespace MoReFEM
* \brief Initialise the problem.
*
* This initialisation includes the resolution of the static problem.
+ * \copydoc doxygen_hide_morefem_data_param
*/
void SupplInitialize(const morefem_data_type& morefem_data);
@@ -108,12 +110,7 @@ namespace MoReFEM
private:
- /*!
- * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of
- * maximum time).
- *
- * Returns always true (no such additional condition in this Model).
- */
+ //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true
bool SupplHasFinishedConditions() const;
diff --git a/Sources/Test/Geometry/NcoordInDomain/main.cpp b/Sources/Test/Geometry/NcoordInDomain/main.cpp
index fb7d68d9a632494cfd8951d29f1301b7acee5912..168df22b55f942707350733d233d862382fb2ea8 100644
--- a/Sources/Test/Geometry/NcoordInDomain/main.cpp
+++ b/Sources/Test/Geometry/NcoordInDomain/main.cpp
@@ -21,7 +21,8 @@ using namespace MoReFEM;
int main(int argc, char** argv)
{
- using InputParameterList = TestNcoordInDomainNS::InputParameterList;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = TestNcoordInDomainNS::InputParameterList;
try
{
diff --git a/Sources/Test/Ondomatic/InputParameterList.hpp b/Sources/Test/Ondomatic/InputParameterList.hpp
index 2a3efec162972c9d14295f14d24e1ba3fec02a97..d68712ca7f410d4d162c0cddce184d34f791bed8 100644
--- a/Sources/Test/Ondomatic/InputParameterList.hpp
+++ b/Sources/Test/Ondomatic/InputParameterList.hpp
@@ -27,13 +27,15 @@ namespace MoReFEM
namespace OndomaticNS
{
-
+
+ //! \copydoc doxygen_hide_mesh_enum
enum class MeshIndex
{
mesh = 1
};
-
-
+
+
+ //! \copydoc doxygen_hide_domain_enum
enum class DomainIndex
{
highest_dimension = 1,
@@ -46,14 +48,16 @@ namespace MoReFEM
face123 = 8,
full_mesh = 9
};
-
-
+
+
+ //! \copydoc doxygen_hide_boundary_condition_enum
enum class BoundaryConditionIndex
{
face123 = 1
};
-
-
+
+
+ //! \copydoc doxygen_hide_felt_space_enum
enum class FEltSpaceIndex
{
highest_dimension = 1,
@@ -61,48 +65,56 @@ namespace MoReFEM
surface_pressure_5 = 3,
surface_pressure_6 = 4
};
-
-
+
+
+ //! \copydoc doxygen_hide_unknown_enum
enum class UnknownIndex
{
pressure = 1
};
-
-
+
+
+ //! \copydoc doxygen_hide_numbering_subset_enum
enum class NumberingSubsetIndex
{
monolithic = 1
};
-
-
+
+
+ //! \copydoc doxygen_hide_solver_enum
enum class SolverIndex
+
{
solver = 1
};
-
+
+
+ //! \copydoc doxygen_hide_initial_condition_enum
enum class InitialConditionIndex
{
pressure_initial_condition = 1
};
-
+
+ //! \copydoc doxygen_hide_source_enum
enum class ForceIndexList : unsigned int
{
surface_pressure_4 = 1,
surface_pressure_5 = 2,
surface_pressure_6 = 3
};
-
-
+
+
+ //! \copydoc doxygen_hide_input_parameter_tuple
using InputParameterTuple = std::tuple
<
InputParameter::TimeManager,
-
+
InputParameter::NumberingSubset<EnumUnderlyingType(NumberingSubsetIndex::monolithic)>,
-
+
InputParameter::Unknown<EnumUnderlyingType(UnknownIndex::pressure)>,
-
+
InputParameter::Mesh<EnumUnderlyingType(MeshIndex::mesh)>,
-
+
InputParameter::Domain<EnumUnderlyingType(DomainIndex::highest_dimension)>,
InputParameter::Domain<EnumUnderlyingType(DomainIndex::face1)>,
InputParameter::Domain<EnumUnderlyingType(DomainIndex::face2)>,
@@ -112,35 +124,37 @@ namespace MoReFEM
InputParameter::Domain<EnumUnderlyingType(DomainIndex::face6)>,
InputParameter::Domain<EnumUnderlyingType(DomainIndex::face123)>,
InputParameter::Domain<EnumUnderlyingType(DomainIndex::full_mesh)>,
-
+
InputParameter::DirichletBoundaryCondition<EnumUnderlyingType(BoundaryConditionIndex::face123)>,
-
+
InputParameter::FEltSpace<EnumUnderlyingType(FEltSpaceIndex::highest_dimension)>,
InputParameter::FEltSpace<EnumUnderlyingType(FEltSpaceIndex::surface_pressure_4)>,
InputParameter::FEltSpace<EnumUnderlyingType(FEltSpaceIndex::surface_pressure_5)>,
InputParameter::FEltSpace<EnumUnderlyingType(FEltSpaceIndex::surface_pressure_6)>,
-
+
InputParameter::Petsc<EnumUnderlyingType(SolverIndex::solver)>,
-
+
InputParameter::InitialCondition<EnumUnderlyingType(InitialConditionIndex::pressure_initial_condition)>,
-
+
InputParameter::ScalarTransientSource<EnumUnderlyingType(ForceIndexList::surface_pressure_4)>,
InputParameter::ScalarTransientSource<EnumUnderlyingType(ForceIndexList::surface_pressure_5)>,
InputParameter::ScalarTransientSource<EnumUnderlyingType(ForceIndexList::surface_pressure_6)>,
-
+
InputParameter::Result
>;
-
-
+
+
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = InputParameterList<InputParameterTuple>;
-
+
+ //! \copydoc doxygen_hide_morefem_data_type
using morefem_data_type = MoReFEMData<InputParameterList>;
-
-
+
+
} // namespace OndomaticNS
-
-
+
+
} // namespace MoReFEM
-
-
+
+
#endif // MOREFEM_x_TEST_x_ONDOMATIC_x_INPUT_PARAMETER_LIST_HPP_
diff --git a/Sources/Test/Ondomatic/Model.hpp b/Sources/Test/Ondomatic/Model.hpp
index 005073732f80d0dde99500b6bc9980b3397d4dfb..5e4dd774e526014e3bebabfb016382cc1c93ac55 100644
--- a/Sources/Test/Ondomatic/Model.hpp
+++ b/Sources/Test/Ondomatic/Model.hpp
@@ -27,6 +27,7 @@ namespace MoReFEM
{
+ //! \copydoc doxygen_hide_model_4_test
class Model : public MoReFEM::Model<Model, DoConsiderProcessorWiseLocal2Global::yes>
{
@@ -54,7 +55,7 @@ namespace MoReFEM
/*!
* \brief Constructor.
*
- * \copydetails doxygen_hide_mpi_param
+ * \copydoc doxygen_hide_morefem_data_param
*/
Model(const morefem_data_type& morefem_data);
@@ -84,6 +85,7 @@ namespace MoReFEM
* \brief Initialise the problem.
*
* This initialisation includes the resolution of the static problem.
+ * \copydoc doxygen_hide_morefem_data_param
*/
void SupplInitialize(const morefem_data_type& morefem_data);
@@ -118,12 +120,7 @@ namespace MoReFEM
private:
- /*!
- * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of
- * maximum time).
- *
- * Returns always true (no such additional condition in this Model).
- */
+ //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true
bool SupplHasFinishedConditions() const;
diff --git a/Sources/Test/Ondomatic/VariationalFormulation.hpp b/Sources/Test/Ondomatic/VariationalFormulation.hpp
index ca76e031022abb02360f13b43105b2080783580d..bc655575388bf5e671757219f268e675e63de2c3 100644
--- a/Sources/Test/Ondomatic/VariationalFormulation.hpp
+++ b/Sources/Test/Ondomatic/VariationalFormulation.hpp
@@ -31,7 +31,8 @@ namespace MoReFEM
{
- class VariationalFormulation
+ //! \copydoc doxygen_hide_varf_4_test
+ class VariationalFormulation final
: public MoReFEM::VariationalFormulation
<
VariationalFormulation,
@@ -70,9 +71,10 @@ namespace MoReFEM
///@{
/*!
- * \brief Constructor.
- *
- * \copydetails doxygen_hide_mpi_param
+ * \copydoc doxygen_hide_varf_constructor
+ * \param[in] numbering_subset Only \a NumberingSubset relevant for this formulation. It is a remnant of
+ * a former interface of \a MoReFEM::VariationalFormulation; now in most cases (but obviously not in
+ * test...) \a NumberingSubset is reached through the \a GodOfDof dedicated method.
*/
explicit VariationalFormulation(const morefem_data_type& morefem_data,
const NumberingSubset& numbering_subset,
@@ -97,11 +99,7 @@ namespace MoReFEM
///@}
- /*!
- * \brief Get the only numbering subset relevant for this VariationalFormulation.
- *
- * There is a more generic accessor in the base class but is use is more unwieldy.
- */
+ //! Get the only numbering subset relevant for this VariationalFormulation.
const NumberingSubset& GetNumberingSubset() const;
private:
@@ -109,11 +107,7 @@ namespace MoReFEM
/// \name CRTP-required methods.
///@{
- /*!
- * \brief Specific initialisation for derived class attributes.
- *
- * \internal <b><tt>[internal]</tt></b> This method is called by base class method VariationalFormulation::Init().
- */
+ //! \copydoc doxygen_hide_varf_suppl_init
void SupplInit(const InputParameterList& input_parameter_data);
/*!
@@ -239,7 +233,7 @@ namespace MoReFEM
private:
- /// \name NUmbering subsets used in the formulation.
+ /// \name Numbering subsets used in the formulation.
///@{
const NumberingSubset& numbering_subset_;
diff --git a/Sources/Test/Ondomatic/main.cpp b/Sources/Test/Ondomatic/main.cpp
index 0f4f5007e99bd1eb80dba0b2f6a7b88ab8155b8f..4f002fbc48dd0b6cf8848f9802c1643496bb099d 100644
--- a/Sources/Test/Ondomatic/main.cpp
+++ b/Sources/Test/Ondomatic/main.cpp
@@ -21,7 +21,8 @@ using namespace MoReFEM;
int main(int argc, char** argv)
{
- using InputParameterList = OndomaticNS::InputParameterList;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = OndomaticNS::InputParameterList;
try
{
diff --git a/Sources/Test/OndomaticNumbering/InputParameterList.hpp b/Sources/Test/OndomaticNumbering/InputParameterList.hpp
index e58d8201fb59c29f73a0050e48ae351cbf770653..6abfa27135162e47645ce2bb1bf6a2654dd2c6f3 100644
--- a/Sources/Test/OndomaticNumbering/InputParameterList.hpp
+++ b/Sources/Test/OndomaticNumbering/InputParameterList.hpp
@@ -22,6 +22,7 @@ namespace MoReFEM
{
+ //! \copydoc doxygen_hide_input_parameter_tuple
using InputParameterTuple = std::tuple
<
InputParameter::Unknown::Name<1>,
@@ -48,8 +49,10 @@ namespace MoReFEM
>;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = InputParameterList<InputParameterTuple>;
+ //! \copydoc doxygen_hide_morefem_data_type
using morefem_data_type = MoReFEMData<InputParameterList>;
diff --git a/Sources/Test/OndomaticNumbering/main_test_ondomatic_numbering.cpp b/Sources/Test/OndomaticNumbering/main_test_ondomatic_numbering.cpp
index 6570f5f54aa52b22cccd4ba41f7181f1686c18fc..405862b545997f2697ddcad5c8e633330719e68e 100644
--- a/Sources/Test/OndomaticNumbering/main_test_ondomatic_numbering.cpp
+++ b/Sources/Test/OndomaticNumbering/main_test_ondomatic_numbering.cpp
@@ -24,7 +24,8 @@ using namespace MoReFEM;
int main(int argc, char * argv[])
{
- using InputParameterList = OndomaticNumberingNS::InputParameterList ;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = OndomaticNumberingNS::InputParameterList ;
std::cerr << "#523 This program needs a complete overhaul!" << std::endl;
diff --git a/Sources/Test/Operators/ConformProjector/InputParameterList.hpp b/Sources/Test/Operators/ConformProjector/InputParameterList.hpp
index 9be705a0ccea89aa6ac03f5b402466249f6021d1..91699eda49e4f3e0d8a66f438cfcd102647c1cf2 100644
--- a/Sources/Test/Operators/ConformProjector/InputParameterList.hpp
+++ b/Sources/Test/Operators/ConformProjector/InputParameterList.hpp
@@ -26,19 +26,22 @@ namespace MoReFEM
{
- enum class MeshIndex
+ //! \copydoc doxygen_hide_mesh_enum
+ enum class MeshIndex
{
mesh = 1
};
- enum class DomainIndex
+ //! \copydoc doxygen_hide_domain_enum
+ enum class DomainIndex
{
domain = 1
};
- enum class FEltSpaceIndex
+ //! \copydoc doxygen_hide_felt_space_enum
+ enum class FEltSpaceIndex
{
velocity_pressure = 1,
velocity = 2,
@@ -46,20 +49,24 @@ namespace MoReFEM
};
- enum class UnknownIndex
+ //! \copydoc doxygen_hide_unknown_enum
+ enum class UnknownIndex
{
velocity = 1,
pressure = 2
};
- enum class SolverIndex
+ //! \copydoc doxygen_hide_solver_enum
+ enum class SolverIndex
+
{
solver = 1
};
- enum class NumberingSubsetIndex
+ //! \copydoc doxygen_hide_numbering_subset_enum
+ enum class NumberingSubsetIndex
{
velocity_pressure = 1,
velocity = 2,
@@ -67,7 +74,7 @@ namespace MoReFEM
};
-
+ //! \copydoc doxygen_hide_input_parameter_tuple
using InputParameterTuple = std::tuple
<
InputParameter::TimeManager,
@@ -93,8 +100,10 @@ namespace MoReFEM
>;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = InputParameterList<InputParameterTuple>;
+ //! \copydoc doxygen_hide_morefem_data_type
using morefem_data_type = MoReFEMData<InputParameterList>;
diff --git a/Sources/Test/Operators/ConformProjector/Model.cpp b/Sources/Test/Operators/ConformProjector/Model.cpp
index 4b18e237da3a05bb20326eca147515f98b58fe7f..bd6d8e4d60038cafce1c6d35e6002bbe87a32aaf 100644
--- a/Sources/Test/Operators/ConformProjector/Model.cpp
+++ b/Sources/Test/Operators/ConformProjector/Model.cpp
@@ -215,13 +215,13 @@ namespace MoReFEM
// felt_space3,
// output_directory,
// mpi);
-
-
+//
+//
// interpolator_2_3_ = std::make_unique<interpolator>(felt_space2,
-// felt_space3,
// numbering_subset2,
+// felt_space3,
// numbering_subset3);
-//
+//
// interpolator_2_3_->Init();
diff --git a/Sources/Test/Operators/ConformProjector/Model.hpp b/Sources/Test/Operators/ConformProjector/Model.hpp
index 7f6bbbf5cbcbfb567cbb65da44066b1413f8519e..123dcb717bc80107cbc83cecc61937d961348153 100644
--- a/Sources/Test/Operators/ConformProjector/Model.hpp
+++ b/Sources/Test/Operators/ConformProjector/Model.hpp
@@ -28,6 +28,7 @@ namespace MoReFEM
{
+ //! \copydoc doxygen_hide_model_4_test
class Model : public MoReFEM::Model<Model, DoConsiderProcessorWiseLocal2Global::yes>
{
@@ -55,7 +56,7 @@ namespace MoReFEM
/*!
* \brief Constructor.
*
- * \copydetails doxygen_hide_mpi_param
+ * \copydoc doxygen_hide_morefem_data_param
*/
Model(const morefem_data_type& morefem_data);
@@ -85,6 +86,7 @@ namespace MoReFEM
* \brief Initialise the problem.
*
* This initialisation includes the resolution of the static problem.
+ * \copydoc doxygen_hide_morefem_data_param
*/
void SupplInitialize(const morefem_data_type& morefem_data);
@@ -114,12 +116,7 @@ namespace MoReFEM
private:
- /*!
- * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of
- * maximum time).
- *
- * Returns always true (no such additional condition in this Model).
- */
+ //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true
bool SupplHasFinishedConditions() const;
@@ -138,14 +135,19 @@ namespace MoReFEM
//! Output directory.
const std::string output_directory_;
+ //! Interpolator from \a FEltSpace 1 to \a FEltSpace 2.
ConformInterpolatorNS::SubsetOrSuperset::unique_ptr interpolator_1_2_ = nullptr;
+ //! Interpolator from \a FEltSpace 1 to \a FEltSpace 3.
ConformInterpolatorNS::SubsetOrSuperset::unique_ptr interpolator_1_3_ = nullptr;
+ //! Interpolator from \a FEltSpace 2 to \a FEltSpace 1.
ConformInterpolatorNS::SubsetOrSuperset::unique_ptr interpolator_2_1_ = nullptr;
+ //! Interpolator from \a FEltSpace 3 to \a FEltSpace 1.
ConformInterpolatorNS::SubsetOrSuperset::unique_ptr interpolator_3_1_ = nullptr;
+ //! Interpolator from \a FEltSpace 2 to \a FEltSpace 3.
ConformInterpolatorNS::SubsetOrSuperset::unique_ptr interpolator_2_3_ = nullptr;
};
diff --git a/Sources/Test/Operators/ConformProjector/main.cpp b/Sources/Test/Operators/ConformProjector/main.cpp
index 5e1328b690577b454841711a1a985d4d157c7790..9407e6379ed037e3dd98c3150e9e040ddedd5cc6 100644
--- a/Sources/Test/Operators/ConformProjector/main.cpp
+++ b/Sources/Test/Operators/ConformProjector/main.cpp
@@ -21,7 +21,8 @@ using namespace MoReFEM;
int main(int argc, char** argv)
{
- using InputParameterList = ConformProjectorNS::InputParameterList;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = ConformProjectorNS::InputParameterList;
try
{
diff --git a/Sources/Test/Operators/NonConformInterpolator/FromVertexMatching/InputParameterList.hpp b/Sources/Test/Operators/NonConformInterpolator/FromVertexMatching/InputParameterList.hpp
index 004dcbe4f912b45141002b40d0cd0b3fae012b33..bc42dee86f41fad9adb14681a325951c1583bda1 100644
--- a/Sources/Test/Operators/NonConformInterpolator/FromVertexMatching/InputParameterList.hpp
+++ b/Sources/Test/Operators/NonConformInterpolator/FromVertexMatching/InputParameterList.hpp
@@ -26,21 +26,24 @@ namespace MoReFEM
{
- enum class MeshIndex
+ //! \copydoc doxygen_hide_mesh_enum
+ enum class MeshIndex
{
fluid = 1,
solid = 2
};
- enum class DomainIndex
+ //! \copydoc doxygen_hide_domain_enum
+ enum class DomainIndex
{
fluid = 10,
solid = 20
};
- enum class FEltSpaceIndex
+ //! \copydoc doxygen_hide_felt_space_enum
+ enum class FEltSpaceIndex
{
fluid = 10,
@@ -48,7 +51,8 @@ namespace MoReFEM
};
- enum class UnknownIndex
+ //! \copydoc doxygen_hide_unknown_enum
+ enum class UnknownIndex
{
unknown = 1,
@@ -56,13 +60,16 @@ namespace MoReFEM
};
- enum class SolverIndex
+ //! \copydoc doxygen_hide_solver_enum
+ enum class SolverIndex
+
{
solver = 1
};
- enum class NumberingSubsetIndex : unsigned int
+ //! \copydoc doxygen_hide_numbering_subset_enum
+ enum class NumberingSubsetIndex : unsigned int
{
unknown_on_fluid = 10,
@@ -71,7 +78,7 @@ namespace MoReFEM
};
-
+ //! Indexes for the vertex matching interpolator.
enum class InitVertexMatchingInterpolator
{
unknown_on_fluid = 10,
@@ -81,6 +88,7 @@ namespace MoReFEM
+ //! \copydoc doxygen_hide_input_parameter_tuple
using InputParameterTuple = std::tuple
<
InputParameter::TimeManager,
@@ -112,8 +120,10 @@ namespace MoReFEM
>;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = InputParameterList<InputParameterTuple>;
+ //! \copydoc doxygen_hide_morefem_data_type
using morefem_data_type = MoReFEMData<InputParameterList>;
diff --git a/Sources/Test/Operators/NonConformInterpolator/FromVertexMatching/Model.hpp b/Sources/Test/Operators/NonConformInterpolator/FromVertexMatching/Model.hpp
index 12ecfc06915b04dc583170d1247b7de08a446bc5..a24365b7fc4f4d7211fec7bd39f095072e58b29d 100644
--- a/Sources/Test/Operators/NonConformInterpolator/FromVertexMatching/Model.hpp
+++ b/Sources/Test/Operators/NonConformInterpolator/FromVertexMatching/Model.hpp
@@ -28,6 +28,7 @@ namespace MoReFEM
{
+ //! \copydoc doxygen_hide_model_4_test
class Model : public MoReFEM::Model<Model, DoConsiderProcessorWiseLocal2Global::yes>
{
@@ -55,7 +56,7 @@ namespace MoReFEM
/*!
* \brief Constructor.
*
- * \copydetails doxygen_hide_mpi_param
+ * \copydoc doxygen_hide_morefem_data_param
*/
Model(const morefem_data_type& morefem_data);
@@ -85,6 +86,7 @@ namespace MoReFEM
* \brief Initialise the problem.
*
* This initialisation includes the resolution of the static problem.
+ * \copydoc doxygen_hide_morefem_data_param
*/
void SupplInitialize(const morefem_data_type& morefem_data);
@@ -117,12 +119,7 @@ namespace MoReFEM
private:
- /*!
- * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of
- * maximum time).
- *
- * Returns always true (no such additional condition in this Model).
- */
+ //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true
bool SupplHasFinishedConditions() const;
diff --git a/Sources/Test/Operators/NonConformInterpolator/FromVertexMatching/main.cpp b/Sources/Test/Operators/NonConformInterpolator/FromVertexMatching/main.cpp
index df41bf3fd9d4b593197d74a2fff870a465e23f01..5320f2457229db4140fc2ca7f1987089f910029f 100644
--- a/Sources/Test/Operators/NonConformInterpolator/FromVertexMatching/main.cpp
+++ b/Sources/Test/Operators/NonConformInterpolator/FromVertexMatching/main.cpp
@@ -22,7 +22,8 @@ using namespace MoReFEM;
int main(int argc, char** argv)
{
- using InputParameterList = TestVertexMatchingNS::InputParameterList;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = TestVertexMatchingNS::InputParameterList;
try
{
diff --git a/Sources/Test/Operators/P1_to_HigherOrder/InputParameterList.hpp b/Sources/Test/Operators/P1_to_HigherOrder/InputParameterList.hpp
index 1bf9910c34b8a1e2b3c9a8c2bd155d23c0ccae5f..cb7bc2831a19a06727274a13b9bf16ab6f8fa260 100644
--- a/Sources/Test/Operators/P1_to_HigherOrder/InputParameterList.hpp
+++ b/Sources/Test/Operators/P1_to_HigherOrder/InputParameterList.hpp
@@ -30,18 +30,21 @@ namespace MoReFEM
{
+ //! \copydoc doxygen_hide_mesh_enum
enum class MeshIndex
{
mesh = 1
};
+ //! \copydoc doxygen_hide_domain_enum
enum class DomainIndex
{
domain = 1
};
+ //! \copydoc doxygen_hide_felt_space_enum
enum class FEltSpaceIndex
{
fluid_velocity = 1,
@@ -49,6 +52,7 @@ namespace MoReFEM
};
+ //! \copydoc doxygen_hide_unknown_enum
enum class UnknownIndex
{
velocity = 1,
@@ -57,12 +61,15 @@ namespace MoReFEM
};
+ //! \copydoc doxygen_hide_solver_enum
enum class SolverIndex
+
{
solver = 1
};
+ //! \copydoc doxygen_hide_numbering_subset_enum
enum class NumberingSubsetIndex
{
fluid_velocity = 1,
@@ -71,7 +78,8 @@ namespace MoReFEM
- using InputParameterTuple = std::tuple
+ //! \copydoc doxygen_hide_input_parameter_tuple
+ using InputParameterTuple = std::tuple
<
InputParameter::TimeManager,
@@ -95,8 +103,10 @@ namespace MoReFEM
>;
- using InputParameterList = InputParameterList<InputParameterTuple>;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = InputParameterList<InputParameterTuple>;
+ //! \copydoc doxygen_hide_morefem_data_type
using morefem_data_type = MoReFEMData<InputParameterList>;
diff --git a/Sources/Test/Operators/P1_to_HigherOrder/Model.hpp b/Sources/Test/Operators/P1_to_HigherOrder/Model.hpp
index d9e9ec4bd7c49daf3681b88cfbd94ff2f6dec8c8..e86ba8c649d658d659c27272db7ed1622cfbd9c7 100644
--- a/Sources/Test/Operators/P1_to_HigherOrder/Model.hpp
+++ b/Sources/Test/Operators/P1_to_HigherOrder/Model.hpp
@@ -75,7 +75,8 @@ namespace MoReFEM
* \tparam HigherOrderT Which is the target order of the interpolation. For instance, P2 to consider P1 -> P2.
*/
template<HigherOrder HigherOrderT>
- class Model : public MoReFEM::Model<Model<HigherOrderT>, DoConsiderProcessorWiseLocal2Global::yes>
+ //! \copydoc doxygen_hide_model_4_test
+ class Model : public MoReFEM::Model<Model<HigherOrderT>, DoConsiderProcessorWiseLocal2Global::yes>
{
private:
@@ -106,7 +107,7 @@ namespace MoReFEM
/*!
* \brief Constructor.
*
- * \copydetails doxygen_hide_mpi_param
+ * \copydoc doxygen_hide_morefem_data_param
*/
Model(const morefem_data_type& morefem_data);
@@ -136,6 +137,7 @@ namespace MoReFEM
* \brief Initialise the problem.
*
* This initialisation includes the resolution of the static problem.
+ * \copydoc doxygen_hide_morefem_data_param
*/
void SupplInitialize(const morefem_data_type& morefem_data);
@@ -165,12 +167,7 @@ namespace MoReFEM
private:
- /*!
- * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of
- * maximum time).
- *
- * Returns always true (no such additional condition in this Model).
- */
+ //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true
bool SupplHasFinishedConditions() const;
diff --git a/Sources/Test/Operators/P1_to_HigherOrder/main_interpolator_P1_P1b.cpp b/Sources/Test/Operators/P1_to_HigherOrder/main_interpolator_P1_P1b.cpp
index 65836fcb3137dbebcdb99b83647a770e0e7c9bba..97fd6d97932b67d612cb124d2fe87edac0af105e 100644
--- a/Sources/Test/Operators/P1_to_HigherOrder/main_interpolator_P1_P1b.cpp
+++ b/Sources/Test/Operators/P1_to_HigherOrder/main_interpolator_P1_P1b.cpp
@@ -22,7 +22,8 @@ using namespace MoReFEM::TestNS;
int main(int argc, char** argv)
{
- using InputParameterList = P1_to_P_HigherOrder_NS::InputParameterList;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = P1_to_P_HigherOrder_NS::InputParameterList;
try
diff --git a/Sources/Test/Operators/P1_to_HigherOrder/main_interpolator_P1_P2.cpp b/Sources/Test/Operators/P1_to_HigherOrder/main_interpolator_P1_P2.cpp
index 90e644787ea819ba9efac02382f31974537a0cf9..ec4f9bda76383dd61c724d7d1f5a243fd67cb943 100644
--- a/Sources/Test/Operators/P1_to_HigherOrder/main_interpolator_P1_P2.cpp
+++ b/Sources/Test/Operators/P1_to_HigherOrder/main_interpolator_P1_P2.cpp
@@ -22,7 +22,8 @@ using namespace MoReFEM::TestNS;
int main(int argc, char** argv)
{
- using InputParameterList = P1_to_P_HigherOrder_NS::InputParameterList;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = P1_to_P_HigherOrder_NS::InputParameterList;
try
{
diff --git a/Sources/Test/Operators/TestFunctions/ExpectedResults.hpp b/Sources/Test/Operators/TestFunctions/ExpectedResults.hpp
index 731101d963a5ef5681a7a92e84b02212a01d2f06..e3eb131e7d1703bb07c0069bd925289e65aaec73 100644
--- a/Sources/Test/Operators/TestFunctions/ExpectedResults.hpp
+++ b/Sources/Test/Operators/TestFunctions/ExpectedResults.hpp
@@ -41,6 +41,12 @@ namespace MoReFEM
{
+ /*!
+ * \brief Convenient alias to choose the underlying storage for the expected result, depending on the
+ * \a IsMatrixOrVectorT template parameter.
+ *
+ * \tparam IsMatrixOrVectorT Whether matrix or vector is considered.
+ */
template<IsMatrixOrVector IsMatrixOrVectorT>
using content_type = std::conditional_t
<
@@ -50,6 +56,12 @@ namespace MoReFEM
>;
+ /*!
+ * \brief Convenient alias to define the associative container which stores all expected results (key is a
+ * unique keyword to identify which is which).
+ *
+ * \tparam LinAlgT Whether matrix or vector is considered.
+ */
template<IsMatrixOrVector LinAlgT>
using expected_results_type = std::unordered_map
<
@@ -57,27 +69,100 @@ namespace MoReFEM
content_type<LinAlgT>
>;
-
+ /*!
+ * \class doxygen_hide_GetExpectedVectorialResults_common
+ *
+ * \param[in] is_parallel Whether the vectorial expected results were obtained in sequential or in
+ * parallel. Due to parallel renumbering, positioning of values might not be the same.
+ *
+ * \return The expected results for all vectorial quantities to check (key is a unique string identifier,
+ * value the expected result stored in a std::vector).
+ */
+
+
+ /*!
+ * \class doxygen_hide_GetExpectedMatricialResults_common
+ *
+ * \param[in] is_parallel Whether the matricial expected results were obtained in sequential or in
+ * parallel. Due to parallel renumbering, positioning of values might not be the same.
+ *
+ * \return The expected results for all matricial quantities to check (key is a unique string identifier,
+ * value the expected result stored in a std::vector of std::vector: first for indexing the row, and inner
+ * one to store the actual values to check).
+ */
+
+ /*!
+ * \brief Get the expected results for the vectorial quantities to check.
+ *
+ * \param[in] dimension Whether we're considering dimension 1, 2 or 3.
+ * \copydoc doxygen_hide_GetExpectedVectorialResults_common
+ */
expected_results_type<IsMatrixOrVector::vector> GetExpectedVectorialResults(unsigned int dimension,
bool is_parallel);
-
+ /*!
+ * \brief Get the expected results for the matricial quantities to check.
+ *
+ * \param[in] dimension Whether we're considering dimension 1, 2 or 3.
+ * \copydoc doxygen_hide_GetExpectedMatricialResults_common
+ */
expected_results_type<IsMatrixOrVector::matrix> GetExpectedMatricialResults(unsigned int dimension,
bool is_parallel);
+ /*!
+ * \brief The underlying function called by \a GetExpectedVectorialResults() for 1D case.
+ *
+ * \copydoc doxygen_hide_GetExpectedVectorialResults_common
+ */
expected_results_type<IsMatrixOrVector::vector> GetExpectedVectorialResults1D(bool is_parallel);
+ /*!
+ * \brief The underlying function called by \a GetExpectedMatricialResults() for 1D case.
+ *
+ * \copydoc doxygen_hide_GetExpectedMatricialResults_common
+ */
expected_results_type<IsMatrixOrVector::matrix> GetExpectedMatricialResults1D(bool is_parallel);
+ /*!
+ * \brief The underlying function called by \a GetExpectedVectorialResults() for 2D case.
+ *
+ * \copydoc doxygen_hide_GetExpectedVectorialResults_common
+ */
expected_results_type<IsMatrixOrVector::vector> GetExpectedVectorialResults2D(bool is_parallel);
+ /*!
+ * \brief The underlying function called by \a GetExpectedMatricialResults() for 2D case.
+ *
+ * \copydoc doxygen_hide_GetExpectedMatricialResults_common
+ */
expected_results_type<IsMatrixOrVector::matrix> GetExpectedMatricialResults2D(bool is_parallel);
+ /*!
+ * \brief The underlying function called by \a GetExpectedVectorialResults() for 3D case.
+ *
+ * \copydoc doxygen_hide_GetExpectedVectorialResults_common
+ */
expected_results_type<IsMatrixOrVector::vector> GetExpectedVectorialResults3D(bool is_parallel);
+ /*!
+ * \brief The underlying function called by \a GetExpectedMatricialResults() for 3D case.
+ *
+ * \copydoc doxygen_hide_GetExpectedMatricialResults_common
+ */
expected_results_type<IsMatrixOrVector::matrix> GetExpectedMatricialResults3D(bool is_parallel);
+ /*!
+ * \brief Insert a new entry in the expected results storage.
+ *
+ * \tparam IsMatrixOrVectorT Whether the new entry is matricial or vectorial.
+ *
+ * \param[in] name Identifier of the new entry; must be unique in the storage.
+ * \param[in] content The associated numerical values of the new entry.
+ * \param[in,out] expected_results The storage in which all entries are stored. New one is added in output
+ * of this function.
+ * \copydoc doxygen_hide_invoking_file_and_line
+ */
template<IsMatrixOrVector IsMatrixOrVectorT>
void InsertNewEntry(const std::string& name,
content_type<IsMatrixOrVectorT>&& content,
@@ -85,6 +170,17 @@ namespace MoReFEM
const char* invoking_file, int invoking_line);
+ /*!
+ * \brief Check whether the matrix obtained is the same as the one stored in expected result storage.
+ *
+ * \param[in] god_of_dof \a GodOfDof upon which the matrix is defined. It is requested to retrieve
+ * informations related to numbering.
+ * \param[in] name Identifier of the entry to check.
+ * \param[in] obtained Value obtained by the computation; the content must match the expected one.
+ * \param[in] expected_results The storage in which all matricial entries are stored.
+ * \copydoc doxygen_hide_invoking_file_and_line
+ * \param[in] epsilon Value under which two floating point quantities are consider equal.
+ */
void CheckMatrix(const GodOfDof& god_of_dof,
const GlobalMatrix& obtained,
const expected_results_type<IsMatrixOrVector::matrix>& expected_results,
@@ -93,6 +189,17 @@ namespace MoReFEM
const double epsilon = 1.e-12);
+ /*!
+ * \brief Check whether the vector obtained is the same as the one stored in expected result storage.
+ *
+ * \param[in] god_of_dof \a GodOfDof upon which the vector is defined. It is requested to retrieve
+ * informations related to numbering.
+ * \param[in] name Identifier of the entry to check.
+ * \param[in] obtained Value obtained by the computation; the content must match the expected one.
+ * \param[in] expected_results The storage in which all vectorial entries are stored.
+ * \copydoc doxygen_hide_invoking_file_and_line
+ * \param[in] epsilon Value under which two floating point quantities are consider equal.
+ */
void CheckVector(const GodOfDof& god_of_dof,
const GlobalVector& obtained,
const expected_results_type<IsMatrixOrVector::vector>& expected_results,
diff --git a/Sources/Test/Operators/TestFunctions/InputParameterList.hpp b/Sources/Test/Operators/TestFunctions/InputParameterList.hpp
index 6fa1fb305bac427903737825734466e38dc959b9..27a58061ca9acd45453d8e0a2338d77ae159387d 100644
--- a/Sources/Test/Operators/TestFunctions/InputParameterList.hpp
+++ b/Sources/Test/Operators/TestFunctions/InputParameterList.hpp
@@ -30,13 +30,15 @@ namespace MoReFEM
{
- enum class MeshIndex
+ //! \copydoc doxygen_hide_mesh_enum
+ enum class MeshIndex
{
mesh = 1
};
- enum class DomainIndex
+ //! \copydoc doxygen_hide_domain_enum
+ enum class DomainIndex
{
volume = 1,
surface = 2,
@@ -44,7 +46,8 @@ namespace MoReFEM
};
- enum class FEltSpaceIndex
+ //! \copydoc doxygen_hide_felt_space_enum
+ enum class FEltSpaceIndex
{
volume_potential_1_potential_2 = 1,
volume_potential_1 = 2,
@@ -59,7 +62,8 @@ namespace MoReFEM
};
- enum class UnknownIndex
+ //! \copydoc doxygen_hide_unknown_enum
+ enum class UnknownIndex
{
potential_1 = 1,
potential_2 = 2,
@@ -69,7 +73,8 @@ namespace MoReFEM
};
- enum class NumberingSubsetIndex
+ //! \copydoc doxygen_hide_numbering_subset_enum
+ enum class NumberingSubsetIndex
{
potential_1_potential_2 = 1,
potential_1 = 2,
@@ -82,12 +87,15 @@ namespace MoReFEM
};
- enum class SolverIndex
+ //! \copydoc doxygen_hide_solver_enum
+ enum class SolverIndex
+
{
solver = 1
};
+ //! \copydoc doxygen_hide_fiber_enum
enum class FiberIndex
{
fibers_in_volume = 1,
@@ -95,11 +103,15 @@ namespace MoReFEM
angles = 3
};
+
+ //! \copydoc doxygen_hide_source_enum
enum class ForceIndexList : unsigned int
{
source = 1
};
+
+ //! \copydoc doxygen_hide_input_parameter_tuple
using InputParameterTuple = std::tuple
<
InputParameter::TimeManager,
@@ -164,8 +176,10 @@ namespace MoReFEM
>;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = InputParameterList<InputParameterTuple>;
+ //! \copydoc doxygen_hide_morefem_data_type
using morefem_data_type = MoReFEMData<InputParameterList>;
diff --git a/Sources/Test/Operators/TestFunctions/Model.hpp b/Sources/Test/Operators/TestFunctions/Model.hpp
index ee7dacad16e7795a44b359c465e4702c4adf2e02..e29381df96a5b0d2335338f57d9d0d59d366a7ee 100644
--- a/Sources/Test/Operators/TestFunctions/Model.hpp
+++ b/Sources/Test/Operators/TestFunctions/Model.hpp
@@ -27,6 +27,7 @@ namespace MoReFEM
{
+ //! \copydoc doxygen_hide_model_4_test
class Model : public MoReFEM::Model<Model, DoConsiderProcessorWiseLocal2Global::yes>
{
@@ -54,7 +55,7 @@ namespace MoReFEM
/*!
* \brief Constructor.
*
- * \copydetails doxygen_hide_mpi_param
+ * \copydoc doxygen_hide_morefem_data_param
*/
Model(const morefem_data_type& morefem_data);
@@ -84,6 +85,7 @@ namespace MoReFEM
* \brief Initialise the problem.
*
* This initialisation includes the resolution of the static problem.
+ * \copydoc doxygen_hide_morefem_data_param
*/
void SupplInitialize(const morefem_data_type& morefem_data);
@@ -118,12 +120,7 @@ namespace MoReFEM
private:
- /*!
- * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of
- * maximum time).
- *
- * Returns always true (no such additional condition in this Model).
- */
+ //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true
bool SupplHasFinishedConditions() const;
diff --git a/Sources/Test/Operators/TestFunctions/VariationalFormulation.hpp b/Sources/Test/Operators/TestFunctions/VariationalFormulation.hpp
index a76ddeb4a77405831b9cb2cb60fefcf3e104269d..33233338abe861583c418f8b29d7cdf813c62810 100644
--- a/Sources/Test/Operators/TestFunctions/VariationalFormulation.hpp
+++ b/Sources/Test/Operators/TestFunctions/VariationalFormulation.hpp
@@ -52,6 +52,7 @@ namespace MoReFEM
{
+ //! \copydoc doxygen_hide_varf_4_test
class VariationalFormulation
: public MoReFEM::VariationalFormulation
<
@@ -100,6 +101,7 @@ namespace MoReFEM
using ActiveStressPolicy =
GlobalVariationalOperatorNS::SecondPiolaKirchhoffStressTensorNS::ActiveStressPolicyNS::None;
+ //! Alias to the hyperelasticity policy used.
using hyperelasticity_policy =
GlobalVariationalOperatorNS::SecondPiolaKirchhoffStressTensorNS::HyperelasticityPolicyNS
::Hyperelasticity<typename hyperelastic_law_parent::hyperelastic_law_type>;
@@ -136,11 +138,7 @@ namespace MoReFEM
/// \name Special members.
///@{
- /*!
- * \brief Constructor.
- *
- * \copydetails doxygen_hide_mpi_param
- */
+ //! copydoc doxygen_hide_varf_constructor
explicit VariationalFormulation(const morefem_data_type& morefem_data,
TimeManager& time_manager,
const GodOfDof& god_of_dof,
@@ -168,11 +166,7 @@ namespace MoReFEM
/// \name CRTP-required methods.
///@{
- /*!
- * \brief Specific initialisation for derived class attributes.
- *
- * \internal <b><tt>[internal]</tt></b> This method is called by base class method VariationalFormulation::Init().
- */
+ //! \copydoc doxygen_hide_varf_suppl_init
void SupplInit(const InputParameterList& input_parameter_data);
/*!
diff --git a/Sources/Test/Operators/TestFunctions/main.cpp b/Sources/Test/Operators/TestFunctions/main.cpp
index 78197ce735f3cd29990bac244e5eb63f024a7c8c..6b9e7e630ca12cfa8747293733537ab93f8a6ddb 100644
--- a/Sources/Test/Operators/TestFunctions/main.cpp
+++ b/Sources/Test/Operators/TestFunctions/main.cpp
@@ -21,7 +21,8 @@ using namespace MoReFEM;
int main(int argc, char** argv)
{
- using InputParameterList = TestFunctionsNS::InputParameterList;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = TestFunctionsNS::InputParameterList;
try
{
diff --git a/Sources/Test/Parameter/AtDof/InputParameterList.hpp b/Sources/Test/Parameter/AtDof/InputParameterList.hpp
index afeaaed72aac33530b269a00ac6de4756691b2eb..810213d675eb5056e26d783e3c270995f499bbf4 100644
--- a/Sources/Test/Parameter/AtDof/InputParameterList.hpp
+++ b/Sources/Test/Parameter/AtDof/InputParameterList.hpp
@@ -26,12 +26,14 @@ namespace MoReFEM
{
+ //! \copydoc doxygen_hide_mesh_enum
enum class MeshIndex
{
mesh = 1
};
+ //! \copydoc doxygen_hide_domain_enum
enum class DomainIndex
{
domain = 1,
@@ -39,12 +41,14 @@ namespace MoReFEM
};
+ //! \copydoc doxygen_hide_felt_space_enum
enum class FEltSpaceIndex
{
index = 1
};
+ //! \copydoc doxygen_hide_unknown_enum
enum class UnknownIndex
{
scalar = 1,
@@ -52,12 +56,15 @@ namespace MoReFEM
};
+ //! \copydoc doxygen_hide_solver_enum
enum class SolverIndex
+
{
solver = 1
};
+ //! \copydoc doxygen_hide_numbering_subset_enum
enum class NumberingSubsetIndex
{
scalar = 1,
@@ -65,6 +72,7 @@ namespace MoReFEM
};
+ //! \copydoc doxygen_hide_fiber_enum
enum class FiberIndex
{
fiber = 1,
@@ -73,6 +81,7 @@ namespace MoReFEM
+ //! \copydoc doxygen_hide_input_parameter_tuple
using InputParameterTuple = std::tuple
<
InputParameter::TimeManager,
@@ -99,8 +108,10 @@ namespace MoReFEM
>;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = InputParameterList<InputParameterTuple>;
+ //! \copydoc doxygen_hide_morefem_data_type
using morefem_data_type = MoReFEMData<InputParameterList>;
diff --git a/Sources/Test/Parameter/AtDof/Model.cpp b/Sources/Test/Parameter/AtDof/Model.cpp
index 1448b9a1f37f7375b05f757249460e0f8b533b0e..76dcfe88afb7908b487bd29d012001bf7703f0f7 100644
--- a/Sources/Test/Parameter/AtDof/Model.cpp
+++ b/Sources/Test/Parameter/AtDof/Model.cpp
@@ -37,11 +37,13 @@ namespace MoReFEM
{
static_cast<void>(morefem_data);
- Internal::FiberNS::FiberListManager<ParameterNS::Type::scalar>::GetInstance().GetNonCstFiberList(2).Initialize();
+ decltype(auto) scalar_fiber_manager =
+ Internal::FiberNS::FiberListManager<ParameterNS::Type::scalar>::GetInstance();
+ scalar_fiber_manager.GetNonCstFiberList(EnumUnderlyingType(FiberIndex::distance)).Initialize();
- // decltype(auto) fiber_list =
- //Internal::FiberNS::FiberListManager<ParameterNS::Type::scalar>::GetInstance().GetNonCstFiberList(2).Initialize();
-
+ decltype(auto) vectorial_fiber_manager =
+ Internal::FiberNS::FiberListManager<ParameterNS::Type::vector>::GetInstance();
+ vectorial_fiber_manager.GetNonCstFiberList(EnumUnderlyingType(FiberIndex::fiber)).Initialize();
}
@@ -54,10 +56,7 @@ namespace MoReFEM
void Model::SupplFinalize()
- {
-// Internal::FiberNS::FiberListManager<ParameterNS::Type::scalar>::Destroy();
-// Internal::FiberNS::FiberListManager<ParameterNS::Type::vector>::Destroy();
- }
+ { }
} // namespace TestAtDofNS
diff --git a/Sources/Test/Parameter/AtDof/Model.hpp b/Sources/Test/Parameter/AtDof/Model.hpp
index 00cd15b59ea25167e095ec85368ffb019ee7a002..7847fe3b72b77eb5ef19b03d9203b3293870e119 100644
--- a/Sources/Test/Parameter/AtDof/Model.hpp
+++ b/Sources/Test/Parameter/AtDof/Model.hpp
@@ -28,6 +28,7 @@ namespace MoReFEM
{
+ //! \copydoc doxygen_hide_model_4_test
class Model : public MoReFEM::Model<Model, DoConsiderProcessorWiseLocal2Global::yes>
{
@@ -55,9 +56,8 @@ namespace MoReFEM
/*!
* \brief Constructor.
*
- * \copydetails doxygen_hide_mpi_param
+ * \copydoc doxygen_hide_morefem_data_param
*/
-
Model(const morefem_data_type& morefem_data);
//! Destructor.
@@ -86,6 +86,7 @@ namespace MoReFEM
* \brief Initialise the problem.
*
* This initialisation includes the resolution of the static problem.
+ * \copydoc doxygen_hide_morefem_data_param
*/
void SupplInitialize(const morefem_data_type& morefem_data);
@@ -115,12 +116,7 @@ namespace MoReFEM
private:
- /*!
- * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of
- * maximum time).
- *
- * Returns always true (no such additional condition in this Model).
- */
+ //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true
bool SupplHasFinishedConditions() const;
@@ -139,10 +135,6 @@ namespace MoReFEM
//! Output directory.
const std::string output_directory_;
- GlobalVector::unique_ptr scalar_parameter_vector_ = nullptr;
-
- GlobalVector::unique_ptr vectorial_parameter_vector_ = nullptr;
-
};
diff --git a/Sources/Test/Parameter/AtDof/main.cpp b/Sources/Test/Parameter/AtDof/main.cpp
index e0144d4da3fc6a86abc3ea8eecb7226f474c6a70..94a5c3a1efac4892c97449c51c799b3060cf64f3 100644
--- a/Sources/Test/Parameter/AtDof/main.cpp
+++ b/Sources/Test/Parameter/AtDof/main.cpp
@@ -21,6 +21,7 @@ using namespace MoReFEM;
int main(int argc, char** argv)
{
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = TestAtDofNS::InputParameterList;
try
diff --git a/Sources/Test/Parameter/TimeDependency/InputParameterList.hpp b/Sources/Test/Parameter/TimeDependency/InputParameterList.hpp
index 439a9285c12d083078292e2330148763de1400c5..2c6a3d9ebe64bee5da29667b4b5485ba694fd55d 100644
--- a/Sources/Test/Parameter/TimeDependency/InputParameterList.hpp
+++ b/Sources/Test/Parameter/TimeDependency/InputParameterList.hpp
@@ -28,50 +28,60 @@ namespace MoReFEM
{
- enum class MeshIndex
+ //! \copydoc doxygen_hide_mesh_enum
+ enum class MeshIndex
{
mesh = 1
};
- enum class DomainIndex
+ //! \copydoc doxygen_hide_domain_enum
+ enum class DomainIndex
{
domain = 1,
full_mesh = 2
};
- enum class FEltSpaceIndex
+ //! \copydoc doxygen_hide_felt_space_enum
+ enum class FEltSpaceIndex
{
index = 1
};
- enum class UnknownIndex
+ //! \copydoc doxygen_hide_unknown_enum
+ enum class UnknownIndex
{
scalar = 1,
vectorial = 2
};
- enum class SolverIndex
+ //! \copydoc doxygen_hide_solver_enum
+ enum class SolverIndex
+
{
solver = 1
};
- enum class NumberingSubsetIndex
+ //! \copydoc doxygen_hide_numbering_subset_enum
+ enum class NumberingSubsetIndex
{
scalar = 1,
vectorial = 2
};
+ //! \copydoc doxygen_hide_source_enum
enum class SourceIndex
{
source = 1,
};
+
+ //! Index for the rpessure read from a file.
enum class PressureIndex
{
pressure = 1
@@ -79,6 +89,7 @@ namespace MoReFEM
+ //! \copydoc doxygen_hide_input_parameter_tuple
using InputParameterTuple = std::tuple
<
InputParameter::TimeManager,
@@ -109,8 +120,10 @@ namespace MoReFEM
>;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = InputParameterList<InputParameterTuple>;
+ //! \copydoc doxygen_hide_morefem_data_type
using morefem_data_type = MoReFEMData<InputParameterList>;
diff --git a/Sources/Test/Parameter/TimeDependency/Model.hpp b/Sources/Test/Parameter/TimeDependency/Model.hpp
index 93129f6534cff41e5f43cbdfa8f42d06457aa50a..08e4002dcde8b20eb627f877a0a6fabf604ae9fa 100644
--- a/Sources/Test/Parameter/TimeDependency/Model.hpp
+++ b/Sources/Test/Parameter/TimeDependency/Model.hpp
@@ -30,6 +30,7 @@ namespace MoReFEM
{
+ //! \copydoc doxygen_hide_model_4_test
class Model : public MoReFEM::Model<Model, DoConsiderProcessorWiseLocal2Global::yes>
{
@@ -49,6 +50,7 @@ namespace MoReFEM
//! Friendship granted to the base class so this one can manipulates private methods.
friend parent;
+ //! Convenient alias.
using scalar_varying_type_functor = Parameter
<
ParameterNS::Type::scalar,
@@ -56,6 +58,7 @@ namespace MoReFEM
ParameterNS::TimeDependencyFunctor
>;
+ //! Convenient alias.
using scalar_varying_type_from_file = Parameter
<
ParameterNS::Type::scalar,
@@ -63,7 +66,7 @@ namespace MoReFEM
ParameterNS::TimeDependencyFromFile
>;
-
+ //! Convenient alias.
using scalar_immutable_type = Parameter
<
ParameterNS::Type::scalar,
@@ -79,7 +82,7 @@ namespace MoReFEM
/*!
* \brief Constructor.
*
- * \copydetails doxygen_hide_mpi_param
+ * \copydoc doxygen_hide_morefem_data_param
*/
Model(const morefem_data_type& morefem_data);
@@ -109,6 +112,7 @@ namespace MoReFEM
* \brief Initialise the problem.
*
* This initialisation includes the resolution of the static problem.
+ * \copydoc doxygen_hide_morefem_data_param
*/
void SupplInitialize(const morefem_data_type& morefem_data);
@@ -135,12 +139,7 @@ namespace MoReFEM
private:
- /*!
- * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of
- * maximum time).
- *
- * Returns always true (no such additional condition in this Model).
- */
+ //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true
bool SupplHasFinishedConditions() const;
diff --git a/Sources/Test/Parameter/TimeDependency/main.cpp b/Sources/Test/Parameter/TimeDependency/main.cpp
index 79dbc4881a848dd7c1bfc52e0428c73a8c4e7ad5..23865d3e35d5b9408a94f2a6a9cff84a7173648e 100644
--- a/Sources/Test/Parameter/TimeDependency/main.cpp
+++ b/Sources/Test/Parameter/TimeDependency/main.cpp
@@ -21,7 +21,8 @@ using namespace MoReFEM;
int main(int argc, char** argv)
{
- using InputParameterList = TestParameterTimeDependencyNS::InputParameterList;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = TestParameterTimeDependencyNS::InputParameterList;
try
{
diff --git a/Sources/Test/Test.doxygen b/Sources/Test/Test.doxygen
new file mode 100644
index 0000000000000000000000000000000000000000..e687bcfc4c9ca76aa3489bef341e13ce79f81c56
--- /dev/null
+++ b/Sources/Test/Test.doxygen
@@ -0,0 +1,18 @@
+/*!
+ * \class doxygen_hide_model_4_test
+ *
+ * \brief Model tailored for the test usage.
+ */
+
+
+/*!
+ * \class doxygen_hide_varf_4_test
+ *
+ * \brief Variational formulation tailored for the test usage.
+ */
+
+
+
+
+
+
diff --git a/Sources/Test/ThirdParty/Mpi/ErrorHandling/InputParameterList.hpp b/Sources/Test/ThirdParty/Mpi/ErrorHandling/InputParameterList.hpp
index 250e440d4ac3c079f1ff0eaf6480d715abbe6d27..369cbd85ed380324f64d33bc4d70e5ee4ba12240 100644
--- a/Sources/Test/ThirdParty/Mpi/ErrorHandling/InputParameterList.hpp
+++ b/Sources/Test/ThirdParty/Mpi/ErrorHandling/InputParameterList.hpp
@@ -28,15 +28,18 @@ namespace MoReFEM
- using InputParameterTuple = std::tuple
+ //! \copydoc doxygen_hide_input_parameter_tuple
+ using InputParameterTuple = std::tuple
<
InputParameter::TimeManager,
InputParameter::Result
>;
- using InputParameterList = InputParameterList<InputParameterTuple>;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = InputParameterList<InputParameterTuple>;
+ //! \copydoc doxygen_hide_morefem_data_type
using morefem_data_type = MoReFEMData<InputParameterList>;
diff --git a/Sources/Test/ThirdParty/Mpi/ErrorHandling/main.cpp b/Sources/Test/ThirdParty/Mpi/ErrorHandling/main.cpp
index f3c23fbb2f7860d83c45376161cf6522f429180c..7b7674b5d083ffec1d27d0c1ed277bcbb657788a 100644
--- a/Sources/Test/ThirdParty/Mpi/ErrorHandling/main.cpp
+++ b/Sources/Test/ThirdParty/Mpi/ErrorHandling/main.cpp
@@ -21,7 +21,8 @@ using namespace MoReFEM;
int main(int argc, char** argv)
{
- using InputParameterList = TestNS::InputParameterListNS::InputParameterList;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = TestNS::InputParameterListNS::InputParameterList;
try
{
diff --git a/Sources/Test/ThirdParty/Mpi/Functions/InputParameterList.hpp b/Sources/Test/ThirdParty/Mpi/Functions/InputParameterList.hpp
index 96e40f7dd18cdda9dbf27c4075567b1ebb457e71..739ff55559a8d471d99137930282cf40a2c02a5d 100644
--- a/Sources/Test/ThirdParty/Mpi/Functions/InputParameterList.hpp
+++ b/Sources/Test/ThirdParty/Mpi/Functions/InputParameterList.hpp
@@ -26,15 +26,18 @@ namespace MoReFEM
{
- using InputParameterTuple = std::tuple
+ //! \copydoc doxygen_hide_input_parameter_tuple
+ using InputParameterTuple = std::tuple
<
InputParameter::TimeManager,
InputParameter::Result
>;
- using InputParameterList = InputParameterList<InputParameterTuple>;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = InputParameterList<InputParameterTuple>;
+ //! \copydoc doxygen_hide_morefem_data_type
using morefem_data_type = MoReFEMData<InputParameterList>;
diff --git a/Sources/Test/ThirdParty/Mpi/Functions/main.cpp b/Sources/Test/ThirdParty/Mpi/Functions/main.cpp
index 4576a5ad903bb233a617b37a558d506e81da95ba..1e8d58b0c4fd7d8b644b12623cf4163fa838395e 100644
--- a/Sources/Test/ThirdParty/Mpi/Functions/main.cpp
+++ b/Sources/Test/ThirdParty/Mpi/Functions/main.cpp
@@ -38,7 +38,8 @@ namespace // anonymous
int main(int argc, char** argv)
{
- using InputParameterList = TestNS::InputParameterListNS::InputParameterList;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = TestNS::InputParameterListNS::InputParameterList;
try
{
diff --git a/Sources/Test/ThirdParty/Mpi/SendReceive/InputParameterList.hpp b/Sources/Test/ThirdParty/Mpi/SendReceive/InputParameterList.hpp
index d64db4248de5535f11d0a40196a1693a73fa8d49..82213a7117a70c87663b667d6289301cfbd37b21 100644
--- a/Sources/Test/ThirdParty/Mpi/SendReceive/InputParameterList.hpp
+++ b/Sources/Test/ThirdParty/Mpi/SendReceive/InputParameterList.hpp
@@ -28,15 +28,18 @@ namespace MoReFEM
- using InputParameterTuple = std::tuple
+ //! \copydoc doxygen_hide_input_parameter_tuple
+ using InputParameterTuple = std::tuple
<
InputParameter::TimeManager,
InputParameter::Result
>;
- using InputParameterList = InputParameterList<InputParameterTuple>;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = InputParameterList<InputParameterTuple>;
+ //! \copydoc doxygen_hide_morefem_data_type
using morefem_data_type = MoReFEMData<InputParameterList>;
diff --git a/Sources/Test/ThirdParty/Mpi/SendReceive/main_array.cpp b/Sources/Test/ThirdParty/Mpi/SendReceive/main_array.cpp
index 524d3675af77ca22c7ffae3baa970281b03c2337..9c7c8ba1312c14a9e24e60a7bd21053261654b45 100644
--- a/Sources/Test/ThirdParty/Mpi/SendReceive/main_array.cpp
+++ b/Sources/Test/ThirdParty/Mpi/SendReceive/main_array.cpp
@@ -23,7 +23,8 @@ using namespace MoReFEM;
int main(int argc, char** argv)
{
- using InputParameterList = TestNS::MpiSendReceiveNS::InputParameterList;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = TestNS::MpiSendReceiveNS::InputParameterList;
try
{
diff --git a/Sources/Test/ThirdParty/Mpi/SendReceive/main_single_value.cpp b/Sources/Test/ThirdParty/Mpi/SendReceive/main_single_value.cpp
index eacd0c2d15eb1eaf630c93cf3441a2643fe223d6..96baa8dbdf0ef0939a15b1d3512c6df18126dbf3 100644
--- a/Sources/Test/ThirdParty/Mpi/SendReceive/main_single_value.cpp
+++ b/Sources/Test/ThirdParty/Mpi/SendReceive/main_single_value.cpp
@@ -23,7 +23,8 @@ using namespace MoReFEM;
int main(int argc, char** argv)
{
- using InputParameterList = TestNS::MpiSendReceiveNS::InputParameterList;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = TestNS::MpiSendReceiveNS::InputParameterList;
try
{
diff --git a/Sources/Test/Utilities/InputParameterList/InputParameterList.hpp b/Sources/Test/Utilities/InputParameterList/InputParameterList.hpp
index f237aeb3df7c659644932e0d06782e1d0498019f..1fd780f528b4d3173423ce181a4e42844b522cae 100644
--- a/Sources/Test/Utilities/InputParameterList/InputParameterList.hpp
+++ b/Sources/Test/Utilities/InputParameterList/InputParameterList.hpp
@@ -20,6 +20,7 @@
# include "Core/InputParameter/Solver/Petsc.hpp"
# include "Core/InputParameter/Geometry/InterpolationFile.hpp"
+
namespace MoReFEM
{
@@ -32,55 +33,51 @@ namespace MoReFEM
{
+ //! \copydoc doxygen_hide_mesh_enum
enum class MeshIndex
{
mesh = 1
};
+ //! \copydoc doxygen_hide_domain_enum
enum class DomainIndex
{
domain = 1
};
+ //! \copydoc doxygen_hide_felt_space_enum
enum class FEltSpaceIndex
{
felt_space = 1
};
+ //! \copydoc doxygen_hide_unknown_enum
enum class UnknownIndex
{
unknown = 1
};
+ //! \copydoc doxygen_hide_solver_enum
enum class SolverIndex
+
{
solver = 1
};
+ //! \copydoc doxygen_hide_numbering_subset_enum
enum class NumberingSubsetIndex : unsigned int
{
numbering_subset = 1
};
- struct HardcodedNumberingSubset
- {
-
- static const std::string& Value()
- {
- static const std::string ret("Hardcoded numbering subset");
- return ret;
- }
-
-
- };
-
+ //! \copydoc doxygen_hide_input_parameter_tuple
using InputParameterTuple = std::tuple
<
InputParameter::TimeManager,
@@ -104,9 +101,11 @@ namespace MoReFEM
>;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = InputParameterList<InputParameterTuple>;
- using morefem_data_type = MoReFEMData<InputParameterList>;
+ //! \copydoc doxygen_hide_morefem_data_type
+ using morefem_data_type = MoReFEMData<InputParameterList>;
} // namespace TestNS
diff --git a/Sources/Test/Utilities/InputParameterList/main.cpp b/Sources/Test/Utilities/InputParameterList/main.cpp
index 9531004dbabab01c3b3dcc031f8d558c1af604ec..fd3474450b2cd34c64cc99d9262e9ec8855b03ef 100644
--- a/Sources/Test/Utilities/InputParameterList/main.cpp
+++ b/Sources/Test/Utilities/InputParameterList/main.cpp
@@ -23,7 +23,8 @@ using namespace MoReFEM;
int main(int argc, char** argv)
{
- using InputParameterList = TestNS::InputParameterListNS::InputParameterList;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = TestNS::InputParameterListNS::InputParameterList;
try
{
diff --git a/Sources/ThirdParty/Wrappers/Petsc/Matrix/MatrixOperations.hpp b/Sources/ThirdParty/Wrappers/Petsc/Matrix/MatrixOperations.hpp
index a4f9c4ffe03772c091f134db3a993a1fa6e3ac9d..3419ada43424ab76a50ae5b35d84b6c9fbd51718 100644
--- a/Sources/ThirdParty/Wrappers/Petsc/Matrix/MatrixOperations.hpp
+++ b/Sources/ThirdParty/Wrappers/Petsc/Matrix/MatrixOperations.hpp
@@ -345,7 +345,7 @@ namespace MoReFEM
*
* Formula is:
* \verbatim
- * m3 = m1^T * m2.
+ m3 = m1^T * m2.
* \endverbatim
*
* \copydetails doxygen_hide_matmatmult_warning
@@ -421,9 +421,9 @@ namespace MoReFEM
*
* \warning Unfortunately a simple test with P = I leads to error
* \verbatim
- * [0;39m[0;49m[0]PETSC ERROR: Nonconforming object sizes
- * [0]PETSC ERROR: Expected fill=-2 must be >= 1.0
- * \endverbatim
+ [0;39m[0;49m[0]PETSC ERROR: Nonconforming object sizes
+ [0]PETSC ERROR: Expected fill=-2 must be >= 1.0
+ \endverbatim
* The reason is that PETSC_DEFAULT may not be supported (I've asked Petsc developers); but even with
* hand-tailored fill it doesn't seem to work...
* So unfortunately I have to advise instead MatMatMult followed by MatTransposeMatMult instead...
diff --git a/Sources/ThirdParty/Wrappers/Petsc/Solver/Snes.cpp b/Sources/ThirdParty/Wrappers/Petsc/Solver/Snes.cpp
index cc840704c05a0a5b2f4ff57ccd102313d0a9b0c3..516edadf1af151dd528656dc2805498a24846818 100644
--- a/Sources/ThirdParty/Wrappers/Petsc/Solver/Snes.cpp
+++ b/Sources/ThirdParty/Wrappers/Petsc/Solver/Snes.cpp
@@ -9,7 +9,6 @@
/// \addtogroup ThirdPartyGroup
/// \{
-
#include <cassert>
#include "ThirdParty/Wrappers/Petsc/Solver/Snes.hpp"
diff --git a/Sources/ThirdParty/Wrappers/Petsc/Vector/Vector.hpp b/Sources/ThirdParty/Wrappers/Petsc/Vector/Vector.hpp
index b46d003e57d4cf4fa1aafbbbbf72bfdd95e6898f..0ffad3dbb18f25c6bb808f0c746382f93e7d981e 100644
--- a/Sources/ThirdParty/Wrappers/Petsc/Vector/Vector.hpp
+++ b/Sources/ThirdParty/Wrappers/Petsc/Vector/Vector.hpp
@@ -745,10 +745,10 @@ namespace MoReFEM
*
* \attention Petsc man page mentions performance issues with this one.
* \verbatim
- * per-processor memory bandwidth
- * interprocessor latency
- * work load inbalance that causes certain processes to arrive much earlier than others
- * \endverbatim
+ per-processor memory bandwidth
+ interprocessor latency
+ work load inbalance that causes certain processes to arrive much earlier than others
+ \endverbatim
*
* \note This function may work for parallel vectors; no need to reduce the result obtained on each process
* (on the contrary you would compute number of proc * dot_product...).
diff --git a/Sources/ThirdParty/Wrappers/Petsc/Viewer.hpp b/Sources/ThirdParty/Wrappers/Petsc/Viewer.hpp
index e10a52a9817a87d257ae4a2fef73acbb36877c83..30e74c6215270f8c78cc609845b5593e56ffb3aa 100644
--- a/Sources/ThirdParty/Wrappers/Petsc/Viewer.hpp
+++ b/Sources/ThirdParty/Wrappers/Petsc/Viewer.hpp
@@ -25,8 +25,20 @@ namespace MoReFEM
namespace Wrappers
{
- // Forward declaration.
+
+ // ============================
+ //! \cond IGNORE_BLOCK_IN_DOXYGEN
+ // Forward declarations.
+ // ============================
+
+
class Mpi;
+
+
+ // ============================
+ // End of forward declarations.
+ //! \endcond IGNORE_BLOCK_IN_DOXYGEN
+ // ============================
namespace Petsc
@@ -61,7 +73,7 @@ namespace MoReFEM
/*!
* \class doxygen_hide_petsc_file_mode
*
- * \param[in] file_mode From http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Viewer/PetscViewerBinaryOpen.html#PetscViewerBinaryOpen :
+ * \param[in] file_mode Same modes as in Petsc documentation, i.e.:
* - FILE_MODE_WRITE - create new file for binary output.
* - FILE_MODE_READ - open existing file for binary input.
* - FILE_MODE_APPEND - open existing file for binary output.
@@ -112,8 +124,6 @@ namespace MoReFEM
};
-
-
} // namespace Petsc
@@ -126,5 +136,4 @@ namespace MoReFEM
/// @} // addtogroup ThirdPartyGroup
-
#endif // MOREFEM_x_THIRD_PARTY_x_WRAPPERS_x_PETSC_x_VIEWER_HPP_
diff --git a/Sources/Utilities/Containers/BoolArray.hpp b/Sources/Utilities/Containers/BoolArray.hpp
index ffc49cd4d1146e1bdbbfe5fa25a97f7567d7c373..60ac02881e0eec27496852b07e9aea5020443e7e 100644
--- a/Sources/Utilities/Containers/BoolArray.hpp
+++ b/Sources/Utilities/Containers/BoolArray.hpp
@@ -187,7 +187,7 @@ namespace MoReFEM
//! Underlying dynamic bool array.
bool* array_;
- //! NUmber of elements in the array.
+ //! Number of elements in the array.
unsigned int Nelt_;
};
diff --git a/Sources/Utilities/Containers/Internal/Sort.hpp b/Sources/Utilities/Containers/Internal/Sort.hpp
new file mode 100644
index 0000000000000000000000000000000000000000..451c6f9e787cbe699a2280e1a2f2141dd7884380
--- /dev/null
+++ b/Sources/Utilities/Containers/Internal/Sort.hpp
@@ -0,0 +1,133 @@
+///
+////// \file
+///
+///
+/// Created by Sebastien Gilles <sebastien@orque.saclay.inria.fr> on the Thu, 17 Jan 2013 10:43:51 +0100
+/// Copyright (c) Inria. All rights reserved.
+///
+/// \ingroup UtilitiesGroup
+/// \addtogroup UtilitiesGroup
+/// \{
+
+#ifndef MOREFEM_x_UTILITIES_x_CONTAINERS_x_INTERNAL_x_SORT_HPP_
+# define MOREFEM_x_UTILITIES_x_CONTAINERS_x_INTERNAL_x_SORT_HPP_
+
+
+# include <cassert>
+# include <tuple>
+
+
+namespace MoReFEM
+{
+
+
+ namespace Internal
+ {
+
+
+ namespace SortNS
+ {
+
+// * static int Value(const T& element)
+// * {
+// * return T.GetDimension();
+// * }
+
+ /*!
+ * \brief Compare whether two objects of same type are equal regarding one unary function.
+ *
+ * \tparam T Type of the objects involved.
+ * \tparam UnaryT Structure which is expected to define a static unary function named
+ * Value which sole parameter is a \a T object.
+ * Typically UnaryT will be a trick to get the results of a method of T object.
+ *
+ * For instance:
+ * \code{.cpp}
+ struct Dimension
+ {
+ static int Value(const T& element)
+ {
+ return T.GetDimension();
+ }
+ };
+
+ T foo, bar;
+
+ bool are_equal = IsEqual<T, Dimension>(foo, bar);
+ //< actually performs foo.GetDimension() == bar.GetDimension();
+ \endcode
+ *
+ * In the above example it may seem pointlessly complicated, but the highlight
+ * is that it can be used in metaprogramming context (see for instance Sort
+ * implementation).
+ *
+ *
+ * \copydoc doxygen_hide_lhs_rhs_arg
+ * \return True of both lhs and rhs are equal considering \a UnaryT function.
+ */
+ template<class T, class UnaryT>
+ bool IsEqual(const T& lhs, const T& rhs);
+
+
+
+ /*!
+ * \brief Helper function for SortingCriterion.
+ *
+ * See SortingCriterion documentation to understand what is the goal.
+ *
+ * \tparam T Type of the objects to sort. Operators < and == must be defined for this type.
+ * \tparam IndexT This index is going downward from the size of the tuple minus 1 to 0 (reason
+ * for this awful trick is that to end the recursion I can use 0 but not std::tuple_size<TupleT>::value).
+ * So SortHelper is first called with IndexT = Size - 1, which means in fact very first element
+ * of the tuple. Then with Size - 2, which means second element of tuple... and so forth!
+ */
+ template <class T, int IndexT, class TupleT>
+ struct SortHelper
+ {
+
+ //! Actual function (wrapped into a class for template specialization).
+ static bool Compare(const T& lhs, const T& rhs);
+
+
+ };
+
+
+ // ============================
+ //! \cond IGNORE_BLOCK_IN_DOXYGEN
+ // ============================
+
+
+ //! Same as above, used to end the recursion.
+ template <class T, class TupleT>
+ struct SortHelper<T, 0, TupleT>
+ {
+
+ //! Actual function (wrapped into a class for template specialization).
+ static bool Compare(const T& lhs, const T& rhs);
+
+
+ };
+
+
+ // ============================
+ //! \endcond IGNORE_BLOCK_IN_DOXYGEN
+ // ============================
+
+
+
+ } // namespace SortNS
+
+
+ } // namespace Internal
+
+
+} // namespace MoReFEM
+
+
+/// @} // addtogroup UtilitiesGroup
+
+
+# include "Utilities/Containers/Internal/Sort.hxx"
+
+
+#endif // MOREFEM_x_UTILITIES_x_CONTAINERS_x_INTERNAL_x_SORT_HPP_
diff --git a/Sources/Utilities/Containers/Internal/Sort.hxx b/Sources/Utilities/Containers/Internal/Sort.hxx
new file mode 100644
index 0000000000000000000000000000000000000000..b49300bd97f5ed25d06daed75ce88681c51b358c
--- /dev/null
+++ b/Sources/Utilities/Containers/Internal/Sort.hxx
@@ -0,0 +1,87 @@
+///
+////// \file
+///
+///
+/// Created by Sebastien Gilles <sebastien@orque.saclay.inria.fr> on the Thu, 17 Jan 2013 10:43:51 +0100
+/// Copyright (c) Inria. All rights reserved.
+///
+/// \ingroup UtilitiesGroup
+/// \addtogroup UtilitiesGroup
+/// \{
+
+#ifndef MOREFEM_x_UTILITIES_x_CONTAINERS_x_INTERNAL_x_SORT_HXX_
+# define MOREFEM_x_UTILITIES_x_CONTAINERS_x_INTERNAL_x_SORT_HXX_
+
+
+# include <cassert>
+# include <tuple>
+
+
+namespace MoReFEM
+{
+
+
+ namespace Internal
+ {
+
+
+ namespace SortNS
+ {
+
+
+ template<class T, class UnaryT>
+ bool IsEqual(const T& lhs, const T& rhs)
+ {
+ return UnaryT::Value(lhs) == UnaryT::Value(rhs);
+ }
+
+
+ template <class T, int IndexT, class TupleT>
+ bool SortHelper<T, IndexT, TupleT>::Compare(const T& lhs, const T& rhs)
+ {
+ enum { size = std::tuple_size<TupleT>::value } ;
+
+ using Criterion = typename std::tuple_element<size - 1 - IndexT, TupleT>::type;
+
+ if (!IsEqual<T, Criterion>(lhs, rhs))
+ {
+ return typename Criterion::StrictOrderingOperator()(Criterion::Value(lhs), Criterion::Value(rhs));
+ }
+
+ return SortHelper<T, IndexT - 1, TupleT>::Compare(lhs, rhs);
+ }
+
+
+ template <class T, class TupleT>
+ bool SortHelper<T, 0, TupleT>::Compare(const T& lhs, const T& rhs)
+ {
+ enum { size = std::tuple_size<TupleT>::value } ;
+
+ using Criterion = typename std::tuple_element<size - 1, TupleT>::type;
+
+ if (!IsEqual<T, Criterion>(lhs, rhs))
+ return typename Criterion::StrictOrderingOperator()(Criterion::Value(lhs), Criterion::Value(rhs));
+
+ // False is returned here as we consider the sorting criterion
+ // expects a strict ordering criterion: typically STL functions
+ // expect < and not <=.
+ // So when \a lhs and \a rhs are completely equal for all criteria,
+ // we do not want to return true (which would mean there is
+ // actually a difference in one of the sorting criterion).
+ return false;
+ }
+
+
+ } // namespace SortNS
+
+
+ } // namespace Internal
+
+
+} // namespace MoReFEM
+
+
+/// @} // addtogroup UtilitiesGroup
+
+
+#endif // MOREFEM_x_UTILITIES_x_CONTAINERS_x_INTERNAL_x_SORT_HXX_
diff --git a/Sources/Utilities/Containers/Sort.hpp b/Sources/Utilities/Containers/Sort.hpp
index 6e2ba799ed955b47eedf1e2c6d0f1849756b09d9..d9149ed4242a40d899e96dbe84d3df96a45f26e6 100644
--- a/Sources/Utilities/Containers/Sort.hpp
+++ b/Sources/Utilities/Containers/Sort.hpp
@@ -12,10 +12,11 @@
#ifndef MOREFEM_x_UTILITIES_x_CONTAINERS_x_SORT_HPP_
# define MOREFEM_x_UTILITIES_x_CONTAINERS_x_SORT_HPP_
-
# include <cassert>
# include <tuple>
+# include "Utilities/Containers/Internal/Sort.hpp"
+
namespace MoReFEM
{
@@ -25,126 +26,6 @@ namespace MoReFEM
{
- namespace SortNS
- {
-
-
- namespace Impl
- {
-
-
- /*!
- * \brief Compare whether two objects of same type are equal regarding one unary function.
- *
- * \tparam T Type of the objects involved.
- * \tparam UnaryT Structure which is expected to define a static unary function named
- * Value which sole parameter is a \a T object.
- * Typically UnaryT will be a trick to get the results of a method of T object.
- * For instance:
- * \code
- * struct Dimension
- * {
- *
- * static int Value(const T& element)
- * {
- * return T.GetDimension();
- * }
- *
- * };
- *
- * T foo, bar;
- *
- * bool are_equal = IsEqual<T, Dimension>(foo, bar);
- * //< actually performs foo.GetDimension() == bar.GetDimension();
- *
- * \endcode
- *
- * In the above example it may seem pointlessly complicated, but the highlight
- * is that it can be used in metaprogramming context (see for instance Sort
- * implementation).
- *
- *
- * \copydoc doxygen_hide_lhs_rhs_arg
- * \return True of both lhs and rhs are equal considering \a UnaryT function.
- */
- template<class T, class UnaryT>
- bool IsEqual(const T& lhs, const T& rhs)
- {
- return UnaryT::Value(lhs) == UnaryT::Value(rhs);
- }
-
-
-
- /*!
- * \brief Helper function for SortingCriterion.
- *
- * See SortingCriterion documentation to understand what is the goal.
- *
- * \tparam T Type of the objects to sort. Operators < and == must be defined for this type.
- * \tparam IndexT This index is going downward from the size of the tuple minus 1 to 0 (reason
- * for this awful trick is that to end the recursion I can use 0 but not std::tuple_size<TupleT>::value).
- * So SortHelper is first called with IndexT = Size - 1, which means in fact very first element
- * of the tuple. Then with Size - 2, which means second element of tuple... and so forth!
-
- */
- template <class T, int IndexT, class TupleT>
- struct SortHelper
- {
-
- //! Actual function (wrapped into a class for template specialization).
- static bool Compare(const T& lhs, const T& rhs)
- {
- enum { size = std::tuple_size<TupleT>::value } ;
-
- using Criterion = typename std::tuple_element<size - 1 - IndexT, TupleT>::type;
-
- if (!IsEqual<T, Criterion>(lhs, rhs))
- {
- return typename Criterion::StrictOrderingOperator()(Criterion::Value(lhs), Criterion::Value(rhs));
- }
-
- return SortHelper<T, IndexT - 1, TupleT>::Compare(lhs, rhs);
- }
-
-
- };
-
-
- //! Same as above, used to end the recursion.
- template <class T, class TupleT>
- struct SortHelper<T, 0, TupleT>
- {
-
- //! Actual function (wrapped into a class for template specialization).
- static bool Compare(const T& lhs, const T& rhs)
- {
- enum { size = std::tuple_size<TupleT>::value } ;
-
- using Criterion = typename std::tuple_element<size - 1, TupleT>::type;
-
- if (!IsEqual<T, Criterion>(lhs, rhs))
- return typename Criterion::StrictOrderingOperator()(Criterion::Value(lhs), Criterion::Value(rhs));
-
- // False is returned here as we consider the sorting criterion
- // expects a strict ordering criterion: typically STL functions
- // expect < and not <=.
- // So when \a lhs and \a rhs are completely equal for all criteria,
- // we do not want to return true (which would mean there is
- // actually a difference in one of the sorting criterion).
- return false;
- }
-
-
- };
-
-
- } // namespace Impl
-
-
- } // namespace SortNS
-
-
-
/*!
* \brief Defines the ordering of two differents objects.
*
@@ -225,7 +106,7 @@ namespace MoReFEM
enum { size = std::tuple_size<Criteria>::value } ;
- return SortNS::Impl::SortHelper<T, size - 1, Criteria>::Compare(lhs, rhs);
+ return ::MoReFEM::Internal::SortNS::SortHelper<T, size - 1, Criteria>::Compare(lhs, rhs);
}
@@ -238,5 +119,4 @@ namespace MoReFEM
/// @} // addtogroup UtilitiesGroup
-
#endif // MOREFEM_x_UTILITIES_x_CONTAINERS_x_SORT_HPP_
diff --git a/Sources/Utilities/LinearAlgebra/Storage/Local/LocalVectorStorage.hpp b/Sources/Utilities/LinearAlgebra/Storage/Local/LocalVectorStorage.hpp
index b9aafe613a255635169c3af737766cc91b02c0cb..eed8472998571bb2473f5b7f363a2a76ebe61c0f 100644
--- a/Sources/Utilities/LinearAlgebra/Storage/Local/LocalVectorStorage.hpp
+++ b/Sources/Utilities/LinearAlgebra/Storage/Local/LocalVectorStorage.hpp
@@ -30,7 +30,7 @@ namespace MoReFEM
* \brief CRTP to give access to \a NlocalVectorT local vectors.
*
* \tparam DerivedT Name of the base class for which the CRTP is deployed.
- * \tparam NlocalVectorT NUmber of local vectors to add.
+ * \tparam NlocalVectorT Number of local vectors to add.
*
* It is advised to declare in \a DerivedT an enum class to tag the local vectors, e.g.:
* \code
diff --git a/Sources/Utilities/Singleton/Singleton.hpp b/Sources/Utilities/Singleton/Singleton.hpp
index f083cac5e8364204f3984edcc832e7a07dd4066d..a366003279fbca39e5ea2f6acc165b428c9cd3f7 100644
--- a/Sources/Utilities/Singleton/Singleton.hpp
+++ b/Sources/Utilities/Singleton/Singleton.hpp
@@ -15,6 +15,7 @@
# include <mutex>
# include <memory>
# include <cstdlib>
+# include <cassert>
# include "Utilities/Singleton/Exceptions/Singleton.hpp"
diff --git a/XCodeTemplates/InputParameterList.xctemplate/___FILEBASENAME___.hpp b/XCodeTemplates/InputParameterList.xctemplate/___FILEBASENAME___.hpp
index 1037a9840a783cd27512f60d15ff6505b3f5bd12..c6391a27cec3cf99b86f0c52eecc0c5418f756d8 100644
--- a/XCodeTemplates/InputParameterList.xctemplate/___FILEBASENAME___.hpp
+++ b/XCodeTemplates/InputParameterList.xctemplate/___FILEBASENAME___.hpp
@@ -31,13 +31,15 @@ namespace MoReFEM
{
- enum class MeshIndex
+ //! \copydoc doxygen_hide_mesh_enum
+ enum class MeshIndex
{
mesh = 1
};
- enum class DomainIndex
+ //! \copydoc doxygen_hide_domain_enum
+ enum class DomainIndex
{
/* TODO Complete with something like:
highest_dimension = 1,
@@ -46,7 +48,8 @@ namespace MoReFEM
};
- enum class FEltSpaceIndex
+ //! \copydoc doxygen_hide_felt_space_enum
+ enum class FEltSpaceIndex
{
/* TODO Complete with something like:
highest_dimension = 1,
@@ -56,7 +59,8 @@ namespace MoReFEM
};
- enum class UnknownIndex
+ //! \copydoc doxygen_hide_unknown_enum
+ enum class UnknownIndex
{
/* TODO Complete with something like:
velocity = 1,
@@ -65,6 +69,7 @@ namespace MoReFEM
};
+ //! \copydoc doxygen_hide_boundary_condition_enum
enum class BoundaryConditionIndex
{
/* TODO Complete with something like:
@@ -75,13 +80,16 @@ namespace MoReFEM
- enum class SolverIndex
+ //! \copydoc doxygen_hide_solver_enum
+ enum class SolverIndex
+
{
solver = 1
};
- enum class NumberingSubsetIndex
+ //! \copydoc doxygen_hide_numbering_subset_enum
+ enum class NumberingSubsetIndex
{
/* TODO Complete with something like:
monolithic =
@@ -90,6 +98,7 @@ namespace MoReFEM
+ //! \copydoc doxygen_hide_input_parameter_tuple
using InputParameterTuple = std::tuple
<
InputParameter::TimeManager,
@@ -114,8 +123,10 @@ namespace MoReFEM
>;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = InputParameterList<InputParameterTuple>;
+ //! \copydoc doxygen_hide_morefem_data_type
using morefem_data_type = MoReFEMData<InputParameterList>;
diff --git a/XCodeTemplates/Main.xctemplate/___FILEBASENAME___.cpp b/XCodeTemplates/Main.xctemplate/___FILEBASENAME___.cpp
index 1b372b87cd112d1d3d05fbd04cf91c43bf657944..2a5e77d34f35d8403694200ca9643949b21adf64 100644
--- a/XCodeTemplates/Main.xctemplate/___FILEBASENAME___.cpp
+++ b/XCodeTemplates/Main.xctemplate/___FILEBASENAME___.cpp
@@ -22,7 +22,8 @@ using namespace MoReFEM;
int main(int argc, char** argv)
{
- using InputParameterList = ___VARIABLE_problemName:identifier___NS::InputParameterList;
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
+ using InputParameterList = ___VARIABLE_problemName:identifier___NS::InputParameterList;
try
{
diff --git a/XCodeTemplates/MainEnsightOutput.xctemplate/___FILEBASENAME___.cpp b/XCodeTemplates/MainEnsightOutput.xctemplate/___FILEBASENAME___.cpp
index 873aa3c7452f6dda0f79daf5722a11d7be0e1248..3ce336ed65a86399429596cca2e39c263d7c08c2 100644
--- a/XCodeTemplates/MainEnsightOutput.xctemplate/___FILEBASENAME___.cpp
+++ b/XCodeTemplates/MainEnsightOutput.xctemplate/___FILEBASENAME___.cpp
@@ -32,6 +32,7 @@ int main(int argc, char** argv)
try
{
+ //! \copydoc doxygen_hide_model_specific_input_parameter_list
using InputParameterList = ___VARIABLE_problemName:identifier___NS::InputParameterList;
MoReFEMData<InputParameterList, Utilities::InputParameterListNS::DoTrackUnusedFields::no> morefem_data(argc, argv);
diff --git a/XCodeTemplates/Model.xctemplate/___FILEBASENAME___.hpp b/XCodeTemplates/Model.xctemplate/___FILEBASENAME___.hpp
index c75ec6579b818ddfaa1efc064f1a8f4feaf97a63..f0e5f5ea2ec6da5fc3b8b433d17495aa0745935b 100644
--- a/XCodeTemplates/Model.xctemplate/___FILEBASENAME___.hpp
+++ b/XCodeTemplates/Model.xctemplate/___FILEBASENAME___.hpp
@@ -55,7 +55,7 @@ namespace MoReFEM
/*!
* \brief Constructor.
*
- * \copydetails doxygen_hide_mpi_param
+ * \copydoc doxygen_hide_morefem_data_param
*/
Model(const morefem_data_type& morefem_data);
@@ -84,7 +84,7 @@ namespace MoReFEM
/*!
* \brief Initialise the problem.
*
- * This initialisation includes the resolution of the static problem.
+ * \copydoc doxygen_hide_morefem_data_param
*/
void SupplInitialize(const morefem_data_type& morefem_data);
@@ -109,13 +109,7 @@ namespace MoReFEM
private:
-
- /*!
- * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of
- * maximum time).
- *
- * Returns always true (no such additional condition in this Model).
- */
+ //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true
bool SupplHasFinishedConditions() const;
diff --git a/XCodeTemplates/VariationalFormulation.xctemplate/___FILEBASENAME___.hpp b/XCodeTemplates/VariationalFormulation.xctemplate/___FILEBASENAME___.hpp
index 20a9832ba2539b8524eb5d920b57e054dec6a56d..3112c7ce60a0e6d3fbeec0929d54e2b9e31e83a3 100644
--- a/XCodeTemplates/VariationalFormulation.xctemplate/___FILEBASENAME___.hpp
+++ b/XCodeTemplates/VariationalFormulation.xctemplate/___FILEBASENAME___.hpp
@@ -31,6 +31,7 @@ namespace MoReFEM
{
+ //! \copydoc doxygen_hide_simple_varf
class VariationalFormulation
: public MoReFEM::VariationalFormulation
<
@@ -67,15 +68,11 @@ namespace MoReFEM
/// \name Special members.
///@{
- /*!
- * \brief Constructor.
- *
- * \copydetails doxygen_hide_mpi_param
- */
+ //! copydoc doxygen_hide_varf_constructor
explicit VariationalFormulation(const morefem_data_type& morefem_data,
const NumberingSubset& numbering_subset1,
const NumberingSubset& numbering_subset2, // TODO and more if needed...
- const TimeManager& time_manager,
+ TimeManager& time_manager,
const GodOfDof& god_of_dof,
DirichletBoundaryCondition::vector_shared_ptr&& boundary_condition_list);
@@ -102,13 +99,7 @@ namespace MoReFEM
/// \name CRTP-required methods.
///@{
- /*!
- * \brief Specific initialisation for derived class attributes.
- *
- * \internal <b><tt>[internal]</tt></b> This method is called by base class method VariationalFormulation::Init().
- *
- * \copydoc doxygen_hide_input_parameter_data_arg
- */
+ //! \copydoc doxygen_hide_varf_suppl_init
// TODO: InputParameterDataT might probably be replaced by the actual InputParameterList used in the Model.
template<class InputParameterDataT>
void SupplInit(const InputParameterDataT& input_parameter_data);