diff --git a/.clang-format b/.clang-format
new file mode 100644
index 0000000000000000000000000000000000000000..e5fd772d57f2f7a95cbc0f1a273717c05f6f65b6
--- /dev/null
+++ b/.clang-format
@@ -0,0 +1,8 @@
+# https://clang.llvm.org/docs/ClangFormatStyleOptions.html
+BasedOnStyle: LLVM
+UseTab: Never
+IndentWidth: 4
+BreakBeforeBraces: Allman
+SortIncludes: false
+ColumnLimit: 0
+AccessModifierOffset: -4
diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 0000000000000000000000000000000000000000..de6044b96d078e062de7f658aef508ff77461564
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,8 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 4
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000000000000000000000000000000000000..7a8268629bad758193154609de0a876b5b1f29d4
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,45 @@
+# Compiled Object files
+*.slo
+*.lo
+*.o
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+
+# Misc
+core
+*.pyc
+*.*~
+
+# OS
+.DS_Store
+*.swp
+*.bak
+
+# Workspace
+workspace
+workspace.tar.gz
+*.tar.gz
+*.tgz
+
+# build dir
+build
+
+# Gmsh
+*.pos
+*.msh # do not commit the mesh...
+!*_lfs.msh # ... except in the lfs
+#*.opt
+
+# IDE
+.project
+.pydevproject
+.settings
+.vscode
+.vscode/*
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
new file mode 100644
index 0000000000000000000000000000000000000000..eaec99953ba5d4c8a84ed45811373b238a3472ad
--- /dev/null
+++ b/.gitlab-ci.yml
@@ -0,0 +1,90 @@
+# gitlab-ci file for fpm
+
+default:
+ image: rboman/waves-py3:2020.3
+ before_script:
+ - source /opt/intel/mkl/bin/mklvars.sh intel64
+ - source /opt/intel/tbb/bin/tbbvars.sh intel64
+
+.global_tag: &global_tag_def
+ tags:
+ - mn2l
+
+variables:
+ GIT_CLONE_PATH: /builds/$CI_PROJECT_PATH/FPM_BUILD/fpm # cannot work in /builds/$CI_PROJECT_PATH
+
+stages:
+ - build
+# - fmt_dox
+
+build:
+ <<: *global_tag_def
+ stage: build
+ script:
+ - printenv | sort
+ - cd ..
+ # get and build waves
+ - rm -rf waves
+ - wget -q https://gitlab.uliege.be/am-dept/waves/-/archive/master/waves-master.tar.bz2
+ - tar xf waves-master.tar.bz2
+ - rm waves-master.tar.bz2
+ - mv waves-master waves
+ - cd waves
+ - mkdir build
+ - cd build
+ - cmake -Wno-dev -C ../CMake/disable-trilinos.cmake ..
+ - make -j $(nproc)
+ # check code format
+ - clang-format --version # we use clang-format-10 exclusively
+ - cd ../../fpm
+ - ${CI_PROJECT_DIR}/../waves/scripts/format_code.py
+ - mkdir -p patches
+ - if git diff --patch --exit-code > patches/clang-format.patch; then echo "Clang format changed nothing"; else echo "Clang format found changes to make!"; false; fi
+ # build fpm
+ - mkdir build
+ - cd build
+ - cmake -Wno-dev .. # -DCMAKE_PREFIX_PATH=${CI_PROJECT_DIR}/../waves (handled by default)
+ - make -j $(nproc)
+ # build documentation
+ - make dox
+ # test
+ - ctest -j $(nproc) --output-on-failure #--verbose
+ - mv ${CI_PROJECT_DIR}/../waves/scripts/format_code.py . # ulgy way to keep a script we need later...
+ #timeout: 10 hours # will be available in 12.3
+ artifacts:
+ paths:
+ - build/
+ - patches/
+ expire_in: 1 day
+
+#format:
+# <<: *global_tag_def
+# stage: fmt_dox
+# script:
+# - clang-format --version # we use clang-format-10 exclusively
+# - ./build/format_code.py
+# - mkdir -p patches
+# - if git diff --patch --exit-code > patches/clang-format.patch; then echo "Clang format changed nothing"; else echo "Clang format found changes to make!"; false; fi
+# artifacts:
+# paths:
+# - patches/
+# expire_in: 1 day
+# when: on_failure
+# dependencies:
+# - build_test
+# allow_failure: true
+#
+#
+#doxygen:
+# <<: *global_tag_def
+# stage: fmt_dox
+# script:
+# - cd build
+# - make dox
+# artifacts:
+# paths:
+# - build/doxygen/
+# expire_in: 1 day
+# dependencies:
+# - build_test
+
diff --git a/CMake/FindEIGEN.cmake b/CMake/FindEIGEN.cmake
new file mode 100644
index 0000000000000000000000000000000000000000..6ac879eebceacf6c99b58fc2d43d8fd9a8f863f3
--- /dev/null
+++ b/CMake/FindEIGEN.cmake
@@ -0,0 +1,78 @@
+# Copyright 2020 University of Liège
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# FindEIGEN.cmake - try to find Eigen 3 headers
+# The logic that checks the version comes from FindEigen3.cmake (source dir)
+# ----------------------------------------------------------------------------
+# output:
+# EIGEN_FOUND : TRUE/FALSE
+# EIGEN_INCLUDE_DIRS : where the Eigen/*.h are [cached]
+# EIGEN_VERSION : version number of Eigen
+# ----------------------------------------------------------------------------
+# autodetection:
+# utiliser "CMAKE_PREFIX_PATH=c:\local"
+# ou "CMAKE_INCLUDE_PATH=c:\local\include"
+# ou "INCLUDE=c:\local\include"
+# ----------------------------------------------------------------------------
+
+# Check version (only for Eigen 3)
+macro(_eigen3_check_version)
+ file(READ "${EIGEN_INCLUDE_DIRS}/Eigen/src/Core/util/Macros.h" _eigen3_version_header)
+
+ string(REGEX MATCH "define[ \t]+EIGEN_WORLD_VERSION[ \t]+([0-9]+)" _eigen3_world_version_match "${_eigen3_version_header}")
+ set(EIGEN_WORLD_VERSION "${CMAKE_MATCH_1}")
+ string(REGEX MATCH "define[ \t]+EIGEN_MAJOR_VERSION[ \t]+([0-9]+)" _eigen3_major_version_match "${_eigen3_version_header}")
+ set(EIGEN_MAJOR_VERSION "${CMAKE_MATCH_1}")
+ string(REGEX MATCH "define[ \t]+EIGEN_MINOR_VERSION[ \t]+([0-9]+)" _eigen3_minor_version_match "${_eigen3_version_header}")
+ set(EIGEN_MINOR_VERSION "${CMAKE_MATCH_1}")
+
+ set(EIGEN_VERSION ${EIGEN_WORLD_VERSION}.${EIGEN_MAJOR_VERSION}.${EIGEN_MINOR_VERSION})
+
+ if(${EIGEN_VERSION} VERSION_LESS ${EIGEN_FIND_VERSION})
+ message(FATAL_ERROR "Eigen version ${EIGEN_VERSION} found in ${EIGEN_INCLUDE_DIRS}, but at least version ${EIGEN_FIND_VERSION} is required!")
+ endif()
+endmacro()
+
+# Set a dummy version if not provided
+if(NOT EIGEN_FIND_VERSION)
+ if(NOT EIGEN_FIND_VERSION_MAJOR)
+ set(EIGEN_FIND_VERSION_MAJOR 3)
+ endif()
+ if(NOT EIGEN_FIND_VERSION_MINOR)
+ set(EIGEN_FIND_VERSION_MINOR 3)
+ endif()
+ if(NOT EIGEN_FIND_VERSION_PATCH)
+ set(EIGEN_FIND_VERSION_PATCH 4)
+ endif()
+
+ set(EIGEN_FIND_VERSION "${EIGEN_FIND_VERSION_MAJOR}.${EIGEN_FIND_VERSION_MINOR}.${EIGEN_FIND_VERSION_PATCH}")
+endif()
+
+# Find the header and check the version
+find_path(EIGEN_INCLUDE_DIRS "Eigen/Dense" PATHS "/usr/include/eigen3")
+if (EIGEN_INCLUDE_DIRS)
+ _eigen3_check_version()
+else()
+ message(FATAL_ERROR "Eigen3 headers not found! Define the path in the INCLUDE environment variable.")
+endif()
+
+# handle the QUIETLY and REQUIRED arguments and set EIGEN_FOUND to TRUE
+# if all listed variables are TRUE
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(EIGEN
+ FOUND_VAR EIGEN_FOUND
+ REQUIRED_VARS EIGEN_INCLUDE_DIRS
+ VERSION_VAR EIGEN_VERSION)
+
+#MESSAGE(STATUS "EIGEN_FOUND = ${EIGEN_FOUND}")
diff --git a/CMake/fpmMacros.cmake b/CMake/fpmMacros.cmake
new file mode 100644
index 0000000000000000000000000000000000000000..53075b9f3c84359834ead63082e4c771f3859d24
--- /dev/null
+++ b/CMake/fpmMacros.cmake
@@ -0,0 +1,41 @@
+# Copyright 2020 University of Liège
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# useful macros/fcts
+
+MACRO(MACRO_AddTest srcDir)
+ FILE(GLOB tfiles RELATIVE ${srcDir} ${srcDir}/*)
+ FOREACH(tfile ${tfiles})
+ SET(spath ${srcDir}/${tfile})
+ IF(NOT IS_DIRECTORY ${spath} AND
+ ${spath} MATCHES ".+\\.py$" AND
+ NOT ${tfile} STREQUAL "__init__.py")
+ STRING(REPLACE "${PROJECT_SOURCE_DIR}/" "" strip ${spath})
+ MESSAGE(STATUS "Adding test ${strip}")
+ ADD_TEST(NAME ${strip}
+ WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
+ COMMAND ${PYTHON_EXECUTABLE} run_fpm.py --nogui --clean ${strip})
+ ELSE()
+ MACRO_AddTest(${srcDir}/${tfile})
+ ENDIF()
+ ENDFOREACH()
+ENDMACRO()
+
+
+MACRO(MACRO_DebugPostfix libname)
+ IF(MSVC)
+ SET_TARGET_PROPERTIES(${libname} PROPERTIES DEBUG_POSTFIX "_d")
+ ENDIF(MSVC)
+ENDMACRO()
+
diff --git a/CMake/msys2.cmake b/CMake/msys2.cmake
new file mode 100644
index 0000000000000000000000000000000000000000..42089822a1664552e4a3480c795af53877e4a1dc
--- /dev/null
+++ b/CMake/msys2.cmake
@@ -0,0 +1,17 @@
+# Copyright 2020 University of Liège
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# MSYS2 with MinGW (AC)
+
+SET(CMAKE_GENERATOR "MSYS Makefiles" CACHE INTERNAL "" FORCE)
diff --git a/CMakeLists.txt b/CMakeLists.txt
new file mode 100644
index 0000000000000000000000000000000000000000..9df63d97551759d93dd78048f03de57116c0bce5
--- /dev/null
+++ b/CMakeLists.txt
@@ -0,0 +1,124 @@
+# Copyright 2020 University of Liège
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# ----------------------------------------------------------------------------
+PROJECT(fpm)
+# ----------------------------------------------------------------------------
+CMAKE_MINIMUM_REQUIRED(VERSION 3.1)
+IF(${CMAKE_VERSION} VERSION_GREATER "3.14.0") # we might want to update the project and use the NEW behavior here
+ cmake_policy(SET CMP0078 OLD)
+ cmake_policy(SET CMP0086 OLD)
+ENDIF()
+
+SET(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin CACHE PATH
+ "Single output directory for building all libraries.")
+SET(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin CACHE PATH
+ "Single output directory for building all executables.")
+MARK_AS_ADVANCED(LIBRARY_OUTPUT_PATH EXECUTABLE_OUTPUT_PATH)
+
+IF(NOT CMAKE_BUILD_TYPE)
+ SET( CMAKE_BUILD_TYPE "Release" CACHE STRING
+ "Choose the type of build, options are: None Debug Release RelWithDebInfo MinSizeRel."
+ FORCE)
+ENDIF(NOT CMAKE_BUILD_TYPE)
+MESSAGE(STATUS "Build type: ${CMAKE_BUILD_TYPE}")
+
+LIST(APPEND CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/CMake")
+
+# -- GENERAL OPTIONS
+
+# print OS
+MESSAGE(STATUS "CMAKE_SYSTEM_NAME=\"${CMAKE_SYSTEM_NAME}\"")
+MESSAGE(STATUS "CMAKE_CXX_COMPILER_ID=${CMAKE_CXX_COMPILER_ID}")
+
+# -- macros/fcts
+INCLUDE(fpmMacros)
+
+# -- C++11
+SET(CMAKE_CXX_STANDARD 11) # newer way to set C++11 (requires cmake>=3.1)
+SET(CMAKE_CXX_STANDARD_REQUIRED ON)
+
+# Set specific compiler flags
+IF((CMAKE_CXX_COMPILER_ID MATCHES "GNU") OR (CMAKE_CXX_COMPILER_ID MATCHES "Intel"))
+ IF(NOT APPLE)
+ SET(CMAKE_SHARED_LINKER_FLAGS "-Wl,--no-as-needed")
+ ENDIF()
+ SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall") # add verbosity
+ SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fopenmp -Wno-unknown-pragmas -Wno-sign-compare") # merge trilinos
+ELSEIF(CMAKE_CXX_COMPILER_ID MATCHES "MSVC")
+ ADD_DEFINITIONS(-D_CRT_SECURE_NO_WARNINGS -D_SCL_SECURE_NO_DEPRECATE)
+ ADD_DEFINITIONS(-D_USE_MATH_DEFINES) # otherwise M_PI is undefined
+ SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /MP") # parallel build with MSVC
+ #SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /W4") # add verbosity
+ELSEIF(CMAKE_CXX_COMPILER_ID MATCHES "Clang")
+ SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-deprecated-register")
+ #SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Weverything") # add verbosity
+ENDIF()
+
+# -- Search for Python
+IF (CMAKE_VERSION VERSION_LESS 3.12.0)
+ FIND_PACKAGE(PythonInterp 3.6 REQUIRED)
+ FIND_PACKAGE(PythonLibs 3.6 REQUIRED)
+ELSE()
+ find_package (Python3 COMPONENTS Interpreter Development)
+ # use Python3_ROOT_DIR if wrong python found (e.g. anaconda)
+ SET(PYTHON_EXECUTABLE ${Python3_EXECUTABLE})
+ SET(PYTHON_LIBRARIES ${Python3_LIBRARIES})
+ SET(PYTHON_INCLUDE_PATH ${Python3_INCLUDE_DIRS})
+ SET(PYTHONLIBS_VERSION_STRING ${Python3_VERSION})
+ENDIF()
+MESSAGE(STATUS "PYTHON_EXECUTABLE:FILEPATH=${PYTHON_EXECUTABLE}")
+MESSAGE(STATUS "PYTHON_LIBRARY:FILEPATH=${PYTHON_LIBRARY}")
+MESSAGE(STATUS "PYTHON_INCLUDE_DIR:FILEPATH=${PYTHON_INCLUDE_DIR}")
+MESSAGE(STATUS "PYTHON_FRAMEWORK_INCLUDES=${PYTHON_FRAMEWORK_INCLUDES}")
+MESSAGE(STATUS "PYTHONLIBS_VERSION_STRING=${PYTHONLIBS_VERSION_STRING}")
+MESSAGE(STATUS "Python_FRAMEWORKS=${Python_FRAMEWORKS}")
+
+# -- Search for SWIG
+FIND_PACKAGE(SWIG REQUIRED)
+IF(CMAKE_GENERATOR MATCHES "Visual Studio") # not MSVC because of nmake & jom
+ SET(CMAKE_SWIG_OUTDIR "${EXECUTABLE_OUTPUT_PATH}/$(Configuration)/")
+ELSE()
+ SET(CMAKE_SWIG_OUTDIR "${EXECUTABLE_OUTPUT_PATH}")
+ENDIF()
+
+# -- Doxygen (https://vicrucann.github.io/tutorials/quick-cmake-doxygen/)
+# check if Doxygen is installed
+FIND_PACKAGE(Doxygen)
+IF(DOXYGEN_FOUND)
+ # set input and output files
+ SET(DOXYGEN_IN ${PROJECT_SOURCE_DIR}/Doxyfile.in)
+ SET(DOXYGEN_OUT ${PROJECT_BINARY_DIR}/Doxyfile)
+
+ # request to configure the file
+ CONFIGURE_FILE(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
+ #message("Doxygen build started")
+
+ # note the option ALL which allows to build the docs together with the application
+ # "make dox" rebuilds the doc
+ ADD_CUSTOM_TARGET( dox #ALL
+ COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
+ WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+ COMMENT "Generating API documentation with Doxygen"
+ VERBATIM )
+ELSE()
+ MESSAGE("Doxygen need to be installed to generate the doxygen documentation")
+ENDIF()
+
+# -- CTest
+ENABLE_TESTING()
+
+# -- Modules
+ADD_SUBDIRECTORY( fpm )
+
diff --git a/Doxyfile.in b/Doxyfile.in
new file mode 100644
index 0000000000000000000000000000000000000000..ac19f6e21e7f51dd96e4654e1f240c718c950739
--- /dev/null
+++ b/Doxyfile.in
@@ -0,0 +1,2487 @@
+# 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 = fpm
+
+# 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 = "Field panel method"
+
+# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
+# in the documentation. The maximum height of the logo should not exceed 55
+# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
+# the logo to the output directory.
+
+PROJECT_LOGO = @PROJECT_SOURCE_DIR@/dox/logo.jpg
+
+# 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 = @PROJECT_BINARY_DIR@/doxygen
+
+# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
+# directories (in 2 levels) under the output directory of each output format and
+# will distribute the generated files over these directories. Enabling this
+# option can be useful when feeding doxygen a huge amount of source files, where
+# putting all generated files in the same directory would otherwise causes
+# performance problems for the file system.
+# The default value is: NO.
+
+CREATE_SUBDIRS = NO
+
+# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
+# characters to appear in the names of generated files. If set to NO, non-ASCII
+# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
+# U+3044.
+# The default value is: NO.
+
+ALLOW_UNICODE_NAMES = NO
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all constant output in the proper language.
+# 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 = "The $name class" \
+ "The $name widget" \
+ "The $name file" \
+ is \
+ provides \
+ specifies \
+ contains \
+ represents \
+ a \
+ an \
+ the
+
+# 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 = NO
+
+# 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 =
+
+# This tag can be used to specify a number of word-keyword mappings (TCL only).
+# A mapping has the form "name=value". For example adding "class=itcl::class"
+# will allow you to use the command class in the itcl::class meaning.
+
+TCL_SUBST =
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
+# only. Doxygen will then generate output that is more tailored for C. For
+# instance, some of the names that are used will be different. The list of all
+# members will be omitted, etc.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_FOR_C = NO
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 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 = NO
+
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+# The default value is: NO.
+
+CPP_CLI_SUPPORT = NO
+
+# Set the SIP_SUPPORT tag to YES if your project consists of sip (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 = YES
+
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
+# tag is set to YES then doxygen will reuse the documentation of the first
+# member in the group (if any) for the other members of the group. By default
+# all members of a group must be documented explicitly.
+# 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 = NO
+
+# Set the SUBGROUPING tag to YES to allow class member groups of the same type
+# (for instance a group of public functions) to be put as a subgroup of that
+# type (e.g. under the Public Functions section). Set it to NO to prevent
+# subgrouping. Alternatively, this can be done per class using the
+# \nosubgrouping command.
+# The default value is: YES.
+
+SUBGROUPING = YES
+
+# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
+# are shown inside the group in which they are included (e.g. using \ingroup)
+# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
+# and RTF).
+#
+# 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 = NO
+
+# 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 = YES
+
+# 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 = NO
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
+# locally in source files will be included in the documentation. If set to NO,
+# only classes defined in header files are included. Does not have any effect
+# for Java sources.
+# The default value is: YES.
+
+EXTRACT_LOCAL_CLASSES = YES
+
+# This flag is only useful for Objective-C code. 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 = NO
+
+# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
+# files with double quotes in the documentation rather than with sharp brackets.
+# The default value is: NO.
+
+FORCE_LOCAL_INCLUDES = NO
+
+# If the INLINE_INFO tag is set to YES 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 = YES
+
+# 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 = NO
+
+# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
+# a warning is encountered.
+# The default value is: NO.
+
+WARN_AS_ERROR = NO
+
+# The WARN_FORMAT tag determines the format of the warning messages that doxygen
+# can produce. The string should contain the $file, $line, and $text tags, which
+# will be replaced by the file and line number from which the warning originated
+# and the warning text. Optionally the format may contain $version, which will
+# be replaced by the version of the file (if it could be obtained via
+# FILE_VERSION_FILTER)
+# The default value is: $file:$line: $text.
+
+WARN_FORMAT = "$file:$line: $text"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning and error
+# messages should be written. If left blank the output is written to standard
+# error (stderr).
+
+WARN_LOGFILE =
+
+#---------------------------------------------------------------------------
+# 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 = @PROJECT_SOURCE_DIR@/README.md \
+ @PROJECT_SOURCE_DIR@/src
+
+
+# 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, *.pyw, *.f90, *.f, *.for, *.tcl,
+# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js.
+
+FILE_PATTERNS = *.c \
+ *.cpp \
+ *.h \
+ *.hpp \
+ *.md
+
+#FILE_PATTERNS = *.c \
+# *.cc \
+# *.cxx \
+# *.cpp \
+# *.c++ \
+# *.java \
+# *.ii \
+# *.ixx \
+# *.ipp \
+# *.i++ \
+# *.inl \
+# *.idl \
+# *.ddl \
+# *.odl \
+# *.h \
+# *.hh \
+# *.hxx \
+# *.hpp \
+# *.h++ \
+# *.cs \
+# *.d \
+# *.php \
+# *.php4 \
+# *.php5 \
+# *.phtml \
+# *.inc \
+# *.m \
+# *.markdown \
+# *.md \
+# *.mm \
+# *.dox \
+# *.py \
+# *.pyw \
+# *.f90 \
+# *.f \
+# *.for \
+# *.tcl \
+# *.vhd \
+# *.vhdl \
+# *.ucf \
+# *.qsf \
+# *.as \
+# *.js
+
+# 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 = NO
+
+# 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 =
+
+# 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 =
+
+# 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 = @PROJECT_SOURCE_DIR@/dox/
+
+# 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
+
+# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
+# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
+# cost of reduced performance. This can be particularly helpful with template
+# rich C++ code for which doxygen's built-in parser lacks the necessary type
+# information.
+# Note: The availability of this option depends on whether or not doxygen was
+# generated with the -Duse-libclang=ON option for CMake.
+# The default value is: NO.
+
+CLANG_ASSISTED_PARSING = NO
+
+# If clang assisted parsing is enabled you can provide the compiler with command
+# line options that you would normally use when invoking the compiler. Note that
+# the include paths will already be set by doxygen for the files and directories
+# specified with INPUT and INCLUDE_PATH.
+# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
+
+CLANG_OPTIONS =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+
+# 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 = NO
+
+# 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 = NO
+
+# 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 = org.doxygen.Project
+
+# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
+# the documentation publisher. This should be a reverse domain-name style
+# string, e.g. com.mycompany.MyDocSet.documentation.
+# The default value is: org.doxygen.Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_PUBLISHER_ID = org.doxygen.Publisher
+
+# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
+# The default value is: Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_PUBLISHER_NAME = Publisher
+
+# If the GENERATE_HTMLHELP tag is set to YES 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 = YES
+
+# 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 = YES
+
+# 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 =
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
+# search data is written to a file for indexing by an external tool. With the
+# SEARCHDATA_FILE tag the name of this file can be specified.
+# The default file is: searchdata.xml.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SEARCHDATA_FILE = searchdata.xml
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
+# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
+# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
+# projects and redirect the results back to the right project.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTERNAL_SEARCH_ID =
+
+# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
+# projects other than the one defined by this configuration file, but that are
+# all added to the same external search index. Each project needs to have a
+# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
+# to a relative location where the documentation can be found. The format is:
+# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTRA_SEARCH_MAPPINGS =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
+# The default value is: YES.
+
+GENERATE_LATEX = NO
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# 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 = amsmath
+
+# 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: YES.
+
+HAVE_DOT = YES
+
+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
+# to run in parallel. When set to 0 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 = NO
+
+# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
+# class node. If there are many fields or methods and many nodes the graph may
+# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
+# number of items for each type to make the size more manageable. Set this to 0
+# for no limit. Note that the threshold may be exceeded by 50% before the limit
+# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
+# but if the number exceeds 15, the total amount of fields shown is limited to
+# 10.
+# Minimum value: 0, maximum value: 100, default value: 10.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+UML_LIMIT_NUM_FIELDS = 10
+
+# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
+# collaboration graphs will show the relations between templates and their
+# instances.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+TEMPLATE_RELATIONS = NO
+
+# If the 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, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
+# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
+# gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
+# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
+# png:gdiplus:gdiplus.
+# The default value is: png.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_IMAGE_FORMAT = png
+
+# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
+# enable generation of interactive SVG images that allow zooming and panning.
+#
+# Note that this requires a modern browser other than Internet Explorer. Tested
+# and working are Firefox, Chrome, Safari, and Opera.
+# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
+# the SVG files visible. Older versions of IE do not have SVG support.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+INTERACTIVE_SVG = NO
+
+# The DOT_PATH tag can be used to specify the path where the dot tool can be
+# found. If left blank, it is assumed the dot tool can be found in the path.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_PATH =
+
+# The DOTFILE_DIRS tag can be used to specify one or more directories that
+# contain dot files that are included in the documentation (see the \dotfile
+# command).
+# 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 = NO
+
+# 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/LICENSE b/LICENSE
new file mode 100644
index 0000000000000000000000000000000000000000..86cd459cd2b367ce13ac57d1e58d2f590fc0cb39
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,504 @@
+GNU LESSER GENERAL PUBLIC LICENSE
+ Version 2.1, February 1999
+
+ Copyright (C) 1991, 1999 Free Software Foundation, Inc.
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+(This is the first released version of the Lesser GPL. It also counts
+ as the successor of the GNU Library Public License, version 2, hence
+ the version number 2.1.)
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+Licenses are intended to guarantee your freedom to share and change
+free software--to make sure the software is free for all its users.
+
+ This license, the Lesser General Public License, applies to some
+specially designated software packages--typically libraries--of the
+Free Software Foundation and other authors who decide to use it. You
+can use it too, but we suggest you first think carefully about whether
+this license or the ordinary General Public License is the better
+strategy to use in any particular case, based on the explanations below.
+
+ When we speak of free software, we are referring to freedom of use,
+not price. Our General Public Licenses are designed to make sure that
+you have the freedom to distribute copies of free software (and charge
+for this service if you wish); that you receive source code or can get
+it if you want it; that you can change the software and use pieces of
+it in new free programs; and that you are informed that you can do
+these things.
+
+ To protect your rights, we need to make restrictions that forbid
+distributors to deny you these rights or to ask you to surrender these
+rights. These restrictions translate to certain responsibilities for
+you if you distribute copies of the library or if you modify it.
+
+ For example, if you distribute copies of the library, whether gratis
+or for a fee, you must give the recipients all the rights that we gave
+you. You must make sure that they, too, receive or can get the source
+code. If you link other code with the library, you must provide
+complete object files to the recipients, so that they can relink them
+with the library after making changes to the library and recompiling
+it. And you must show them these terms so they know their rights.
+
+ We protect your rights with a two-step method: (1) we copyright the
+library, and (2) we offer you this license, which gives you legal
+permission to copy, distribute and/or modify the library.
+
+ To protect each distributor, we want to make it very clear that
+there is no warranty for the free library. Also, if the library is
+modified by someone else and passed on, the recipients should know
+that what they have is not the original version, so that the original
+author's reputation will not be affected by problems that might be
+introduced by others.
+
+ Finally, software patents pose a constant threat to the existence of
+any free program. We wish to make sure that a company cannot
+effectively restrict the users of a free program by obtaining a
+restrictive license from a patent holder. Therefore, we insist that
+any patent license obtained for a version of the library must be
+consistent with the full freedom of use specified in this license.
+
+ Most GNU software, including some libraries, is covered by the
+ordinary GNU General Public License. This license, the GNU Lesser
+General Public License, applies to certain designated libraries, and
+is quite different from the ordinary General Public License. We use
+this license for certain libraries in order to permit linking those
+libraries into non-free programs.
+
+ When a program is linked with a library, whether statically or using
+a shared library, the combination of the two is legally speaking a
+combined work, a derivative of the original library. The ordinary
+General Public License therefore permits such linking only if the
+entire combination fits its criteria of freedom. The Lesser General
+Public License permits more lax criteria for linking other code with
+the library.
+
+ We call this license the "Lesser" General Public License because it
+does Less to protect the user's freedom than the ordinary General
+Public License. It also provides other free software developers Less
+of an advantage over competing non-free programs. These disadvantages
+are the reason we use the ordinary General Public License for many
+libraries. However, the Lesser license provides advantages in certain
+special circumstances.
+
+ For example, on rare occasions, there may be a special need to
+encourage the widest possible use of a certain library, so that it becomes
+a de-facto standard. To achieve this, non-free programs must be
+allowed to use the library. A more frequent case is that a free
+library does the same job as widely used non-free libraries. In this
+case, there is little to gain by limiting the free library to free
+software only, so we use the Lesser General Public License.
+
+ In other cases, permission to use a particular library in non-free
+programs enables a greater number of people to use a large body of
+free software. For example, permission to use the GNU C Library in
+non-free programs enables many more people to use the whole GNU
+operating system, as well as its variant, the GNU/Linux operating
+system.
+
+ Although the Lesser General Public License is Less protective of the
+users' freedom, it does ensure that the user of a program that is
+linked with the Library has the freedom and the wherewithal to run
+that program using a modified version of the Library.
+
+ The precise terms and conditions for copying, distribution and
+modification follow. Pay close attention to the difference between a
+"work based on the library" and a "work that uses the library". The
+former contains code derived from the library, whereas the latter must
+be combined with the library in order to run.
+
+ GNU LESSER GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License Agreement applies to any software library or other
+program which contains a notice placed by the copyright holder or
+other authorized party saying it may be distributed under the terms of
+this Lesser General Public License (also called "this License").
+Each licensee is addressed as "you".
+
+ A "library" means a collection of software functions and/or data
+prepared so as to be conveniently linked with application programs
+(which use some of those functions and data) to form executables.
+
+ The "Library", below, refers to any such software library or work
+which has been distributed under these terms. A "work based on the
+Library" means either the Library or any derivative work under
+copyright law: that is to say, a work containing the Library or a
+portion of it, either verbatim or with modifications and/or translated
+straightforwardly into another language. (Hereinafter, translation is
+included without limitation in the term "modification".)
+
+ "Source code" for a work means the preferred form of the work for
+making modifications to it. For a library, complete source code means
+all the source code for all modules it contains, plus any associated
+interface definition files, plus the scripts used to control compilation
+and installation of the library.
+
+ Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running a program using the Library is not restricted, and output from
+such a program is covered only if its contents constitute a work based
+on the Library (independent of the use of the Library in a tool for
+writing it). Whether that is true depends on what the Library does
+and what the program that uses the Library does.
+
+ 1. You may copy and distribute verbatim copies of the Library's
+complete source code as you receive it, in any medium, provided that
+you conspicuously and appropriately publish on each copy an
+appropriate copyright notice and disclaimer of warranty; keep intact
+all the notices that refer to this License and to the absence of any
+warranty; and distribute a copy of this License along with the
+Library.
+
+ You may charge a fee for the physical act of transferring a copy,
+and you may at your option offer warranty protection in exchange for a
+fee.
+
+ 2. You may modify your copy or copies of the Library or any portion
+of it, thus forming a work based on the Library, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) The modified work must itself be a software library.
+
+ b) You must cause the files modified to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ c) You must cause the whole of the work to be licensed at no
+ charge to all third parties under the terms of this License.
+
+ d) If a facility in the modified Library refers to a function or a
+ table of data to be supplied by an application program that uses
+ the facility, other than as an argument passed when the facility
+ is invoked, then you must make a good faith effort to ensure that,
+ in the event an application does not supply such function or
+ table, the facility still operates, and performs whatever part of
+ its purpose remains meaningful.
+
+ (For example, a function in a library to compute square roots has
+ a purpose that is entirely well-defined independent of the
+ application. Therefore, Subsection 2d requires that any
+ application-supplied function or table used by this function must
+ be optional: if the application does not supply it, the square
+ root function must still compute square roots.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Library,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Library, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote
+it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Library.
+
+In addition, mere aggregation of another work not based on the Library
+with the Library (or with a work based on the Library) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may opt to apply the terms of the ordinary GNU General Public
+License instead of this License to a given copy of the Library. To do
+this, you must alter all the notices that refer to this License, so
+that they refer to the ordinary GNU General Public License, version 2,
+instead of to this License. (If a newer version than version 2 of the
+ordinary GNU General Public License has appeared, then you can specify
+that version instead if you wish.) Do not make any other change in
+these notices.
+
+ Once this change is made in a given copy, it is irreversible for
+that copy, so the ordinary GNU General Public License applies to all
+subsequent copies and derivative works made from that copy.
+
+ This option is useful when you wish to copy part of the code of
+the Library into a program that is not a library.
+
+ 4. You may copy and distribute the Library (or a portion or
+derivative of it, under Section 2) in object code or executable form
+under the terms of Sections 1 and 2 above provided that you accompany
+it with the complete corresponding machine-readable source code, which
+must be distributed under the terms of Sections 1 and 2 above on a
+medium customarily used for software interchange.
+
+ If distribution of object code is made by offering access to copy
+from a designated place, then offering equivalent access to copy the
+source code from the same place satisfies the requirement to
+distribute the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 5. A program that contains no derivative of any portion of the
+Library, but is designed to work with the Library by being compiled or
+linked with it, is called a "work that uses the Library". Such a
+work, in isolation, is not a derivative work of the Library, and
+therefore falls outside the scope of this License.
+
+ However, linking a "work that uses the Library" with the Library
+creates an executable that is a derivative of the Library (because it
+contains portions of the Library), rather than a "work that uses the
+library". The executable is therefore covered by this License.
+Section 6 states terms for distribution of such executables.
+
+ When a "work that uses the Library" uses material from a header file
+that is part of the Library, the object code for the work may be a
+derivative work of the Library even though the source code is not.
+Whether this is true is especially significant if the work can be
+linked without the Library, or if the work is itself a library. The
+threshold for this to be true is not precisely defined by law.
+
+ If such an object file uses only numerical parameters, data
+structure layouts and accessors, and small macros and small inline
+functions (ten lines or less in length), then the use of the object
+file is unrestricted, regardless of whether it is legally a derivative
+work. (Executables containing this object code plus portions of the
+Library will still fall under Section 6.)
+
+ Otherwise, if the work is a derivative of the Library, you may
+distribute the object code for the work under the terms of Section 6.
+Any executables containing that work also fall under Section 6,
+whether or not they are linked directly with the Library itself.
+
+ 6. As an exception to the Sections above, you may also combine or
+link a "work that uses the Library" with the Library to produce a
+work containing portions of the Library, and distribute that work
+under terms of your choice, provided that the terms permit
+modification of the work for the customer's own use and reverse
+engineering for debugging such modifications.
+
+ You must give prominent notice with each copy of the work that the
+Library is used in it and that the Library and its use are covered by
+this License. You must supply a copy of this License. If the work
+during execution displays copyright notices, you must include the
+copyright notice for the Library among them, as well as a reference
+directing the user to the copy of this License. Also, you must do one
+of these things:
+
+ a) Accompany the work with the complete corresponding
+ machine-readable source code for the Library including whatever
+ changes were used in the work (which must be distributed under
+ Sections 1 and 2 above); and, if the work is an executable linked
+ with the Library, with the complete machine-readable "work that
+ uses the Library", as object code and/or source code, so that the
+ user can modify the Library and then relink to produce a modified
+ executable containing the modified Library. (It is understood
+ that the user who changes the contents of definitions files in the
+ Library will not necessarily be able to recompile the application
+ to use the modified definitions.)
+
+ b) Use a suitable shared library mechanism for linking with the
+ Library. A suitable mechanism is one that (1) uses at run time a
+ copy of the library already present on the user's computer system,
+ rather than copying library functions into the executable, and (2)
+ will operate properly with a modified version of the library, if
+ the user installs one, as long as the modified version is
+ interface-compatible with the version that the work was made with.
+
+ c) Accompany the work with a written offer, valid for at
+ least three years, to give the same user the materials
+ specified in Subsection 6a, above, for a charge no more
+ than the cost of performing this distribution.
+
+ d) If distribution of the work is made by offering access to copy
+ from a designated place, offer equivalent access to copy the above
+ specified materials from the same place.
+
+ e) Verify that the user has already received a copy of these
+ materials or that you have already sent this user a copy.
+
+ For an executable, the required form of the "work that uses the
+Library" must include any data and utility programs needed for
+reproducing the executable from it. However, as a special exception,
+the materials to be distributed need not include anything that is
+normally distributed (in either source or binary form) with the major
+components (compiler, kernel, and so on) of the operating system on
+which the executable runs, unless that component itself accompanies
+the executable.
+
+ It may happen that this requirement contradicts the license
+restrictions of other proprietary libraries that do not normally
+accompany the operating system. Such a contradiction means you cannot
+use both them and the Library together in an executable that you
+distribute.
+
+ 7. You may place library facilities that are a work based on the
+Library side-by-side in a single library together with other library
+facilities not covered by this License, and distribute such a combined
+library, provided that the separate distribution of the work based on
+the Library and of the other library facilities is otherwise
+permitted, and provided that you do these two things:
+
+ a) Accompany the combined library with a copy of the same work
+ based on the Library, uncombined with any other library
+ facilities. This must be distributed under the terms of the
+ Sections above.
+
+ b) Give prominent notice with the combined library of the fact
+ that part of it is a work based on the Library, and explaining
+ where to find the accompanying uncombined form of the same work.
+
+ 8. You may not copy, modify, sublicense, link with, or distribute
+the Library except as expressly provided under this License. Any
+attempt otherwise to copy, modify, sublicense, link with, or
+distribute the Library is void, and will automatically terminate your
+rights under this License. However, parties who have received copies,
+or rights, from you under this License will not have their licenses
+terminated so long as such parties remain in full compliance.
+
+ 9. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Library or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Library (or any work based on the
+Library), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Library or works based on it.
+
+ 10. Each time you redistribute the Library (or any work based on the
+Library), the recipient automatically receives a license from the
+original licensor to copy, distribute, link with or modify the Library
+subject to these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties with
+this License.
+
+ 11. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Library at all. For example, if a patent
+license would not permit royalty-free redistribution of the Library by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Library.
+
+If any portion of this section is held invalid or unenforceable under any
+particular circumstance, the balance of the section is intended to apply,
+and the section as a whole is intended to apply in other circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 12. If the distribution and/or use of the Library is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Library under this License may add
+an explicit geographical distribution limitation excluding those countries,
+so that distribution is permitted only in or among countries not thus
+excluded. In such case, this License incorporates the limitation as if
+written in the body of this License.
+
+ 13. The Free Software Foundation may publish revised and/or new
+versions of the Lesser General Public License from time to time.
+Such new versions will be similar in spirit to the present version,
+but may differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Library
+specifies a version number of this License which applies to it and
+"any later version", you have the option of following the terms and
+conditions either of that version or of any later version published by
+the Free Software Foundation. If the Library does not specify a
+license version number, you may choose any version ever published by
+the Free Software Foundation.
+
+ 14. If you wish to incorporate parts of the Library into other free
+programs whose distribution conditions are incompatible with these,
+write to the author to ask for permission. For software which is
+copyrighted by the Free Software Foundation, write to the Free
+Software Foundation; we sometimes make exceptions for this. Our
+decision will be guided by the two goals of preserving the free status
+of all derivatives of our free software and of promoting the sharing
+and reuse of software generally.
+
+ NO WARRANTY
+
+ 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
+WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
+EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
+OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
+KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
+LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
+THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
+AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
+FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
+CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
+LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
+RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
+FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Libraries
+
+ If you develop a new library, and you want it to be of the greatest
+possible use to the public, we recommend making it free software that
+everyone can redistribute and change. You can do so by permitting
+redistribution under these terms (or, alternatively, under the terms of the
+ordinary General Public License).
+
+ To apply these terms, attach the following notices to the library. It is
+safest to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least the
+"copyright" line and a pointer to where the full notice is found.
+
+ {description}
+ Copyright (C) {year} {fullname}
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Lesser General Public
+ License as published by the Free Software Foundation; either
+ version 2.1 of the License, or (at your option) any later version.
+
+ This library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public
+ License along with this library; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
+ USA
+
+Also add information on how to contact you by electronic and paper mail.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the library, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the
+ library `Frob' (a library for tweaking knobs) written by James Random
+ Hacker.
+
+ {signature of Ty Coon}, 1 April 1990
+ Ty Coon, President of Vice
+
+That's all there is to it!
\ No newline at end of file
diff --git a/README.md b/README.md
index f4cb02f4cbd2347d6e6d977397520b4f00cdc9a2..2212ff5aedf5dbafa1f92f4efea1cfac81893ea6 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,23 @@
# fpm
+Field panel method for solving transonic flows using the full potential equation
+
+
+## Features
+Set of python/C++ modules solving the linear potential equation and correcting it with source terms computed using third-party nonlinear solvers.
+
+- [x] [gmsh](http://geuz.org/gmsh) support for meshing and post-processing
+- [x] [eigen3](http://eigen.tuxfamily.org/) support for linear algebra
+
+## Build
+fpm is linked against [waves](https://gitlab.uliege.be/am-dept/waves). Once all the required packages and waves are installed:
+
+```bash
+git clone git@gitlab.uliege.be:am-dept/fpm.git # get the code
+mkdir build && cd build
+cmake -DCMAKE_PREFIX_PATH=/path/to/waves .. # configure and reference waves package
+make # compile
+ctest # test
+```
+
+## References
diff --git a/dox/img.png b/dox/img.png
new file mode 100644
index 0000000000000000000000000000000000000000..0fd3ab84749e1471a68c7d2eef825d1d9b9ed67d
Binary files /dev/null and b/dox/img.png differ
diff --git a/dox/logo.jpg b/dox/logo.jpg
new file mode 100644
index 0000000000000000000000000000000000000000..17aeb3377b96b8ec85fed719dd8b3fdc25bd6913
Binary files /dev/null and b/dox/logo.jpg differ
diff --git a/fpm/CMakeLists.txt b/fpm/CMakeLists.txt
new file mode 100644
index 0000000000000000000000000000000000000000..25a1abe94eb4fe61b7416ae9f2720beb8652871d
--- /dev/null
+++ b/fpm/CMakeLists.txt
@@ -0,0 +1,23 @@
+# Copyright 2020 University of Liège
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# CMake input file of fwk.so
+
+# Add source dir
+ADD_SUBDIRECTORY( src )
+ADD_SUBDIRECTORY( _src )
+
+# Add test dir
+MACRO_AddTest(${CMAKE_CURRENT_SOURCE_DIR}/tests)
+
diff --git a/fpm/__init__.py b/fpm/__init__.py
new file mode 100644
index 0000000000000000000000000000000000000000..2e7e73fe7ee4d3162d864c944c3114c93957825d
--- /dev/null
+++ b/fpm/__init__.py
@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+# fpm module initialization file
+
+import fwk
+import tbox # on windows, preloads tbox.dll so that it is found later by fpmw.dll
+fwk.wutils.findbins('fpm', verb=False)
+
+from fpmw import *
+
diff --git a/fpm/_src/CMakeLists.txt b/fpm/_src/CMakeLists.txt
new file mode 100644
index 0000000000000000000000000000000000000000..a137601db122112709848b228ee3a3d3e3c36695
--- /dev/null
+++ b/fpm/_src/CMakeLists.txt
@@ -0,0 +1,53 @@
+# Copyright 2020 University of Liège
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# CMake file for the SWIG interface of fpm.so
+
+INCLUDE(${SWIG_USE_FILE})
+
+FILE(GLOB SRCS *.h *.cpp *.inl *.swg)
+FILE(GLOB ISRCS *.i)
+
+SET(CMAKE_SWIG_FLAGS "")
+SET_SOURCE_FILES_PROPERTIES(${ISRCS} PROPERTIES CPLUSPLUS ON)
+
+FOREACH(dir ${WAVES_INCLUDE_DIRS})
+ LIST(APPEND WAVES_SINCLUDE_DIRS "-I${dir}")
+ENDFOREACH()
+FOREACH(dir ${WAVES_SWIG_DIRS})
+ LIST(APPEND WAVES_SINCLUDE_DIRS "-I${dir}")
+ENDFOREACH()
+
+SET(SWINCFLAGS
+-I${PROJECT_SOURCE_DIR}/fpm/src
+${WAVES_SINCLUDE_DIRS}
+)
+SET_SOURCE_FILES_PROPERTIES(${ISRCS} PROPERTIES SWIG_FLAGS "${SWINCFLAGS}")
+
+if (${CMAKE_VERSION} VERSION_LESS "3.8.0")
+ SWIG_ADD_MODULE(fpmw python ${ISRCS} ${SRCS})
+else()
+ SWIG_ADD_LIBRARY(fpmw LANGUAGE python SOURCES ${ISRCS} ${SRCS})
+endif()
+MACRO_DebugPostfix(_fpmw)
+
+TARGET_INCLUDE_DIRECTORIES(_fpmw PRIVATE ${PROJECT_SOURCE_DIR}/fpm/_src
+ ${WAVES_SWIG_DIRS}
+ ${PYTHON_INCLUDE_PATH}
+)
+
+SWIG_LINK_LIBRARIES(fpmw
+ fpm ${WAVES_LIBRARIES} ${PYTHON_LIBRARIES}
+)
+
diff --git a/fpm/_src/fpmw.h b/fpm/_src/fpmw.h
new file mode 100644
index 0000000000000000000000000000000000000000..c0c92e736bb3756365a9a78d57f4a597db0f379f
--- /dev/null
+++ b/fpm/_src/fpmw.h
@@ -0,0 +1,23 @@
+/*
+ * Copyright 2020 University of Liège
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "fBody.h"
+#include "fBuilder.h"
+#include "fField.h"
+#include "fProblem.h"
+#include "fSolver.h"
+#include "fTimers.h"
+#include "fWake.h"
diff --git a/fpm/_src/fpmw.i b/fpm/_src/fpmw.i
new file mode 100644
index 0000000000000000000000000000000000000000..92054b34c7470cdf523c91fc273e958867deda6c
--- /dev/null
+++ b/fpm/_src/fpmw.i
@@ -0,0 +1,89 @@
+/*
+ * Copyright 2020 University of Liège
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// fpm.i: SWIG input file of the fpm python interface
+
+%feature("autodoc","1");
+
+%module(docstring=
+"'fpmw' module: field panel method
+(c) ULg - A&M",
+directors="1",
+threads="1"
+) fpmw
+%{
+
+//#if defined(_WIN32) && defined(__GNUC__)
+#undef _hypot
+#include <cmath>
+//#endif
+
+#include <memory>
+#include <string>
+#include <sstream>
+#include <typeinfo>
+
+#include "fwkw.h"
+#include "tboxw.h"
+#include "fpmw.h"
+
+#include "fpm.h"
+
+%}
+
+%include "fwkw.swg"
+%import "tboxw.i"
+
+%include "fpm.h"
+
+%include "fTimers.h"
+
+namespace fpm {
+%extend Timers {
+ Timer &getitem(std::string const &name)
+ {
+ return (*self)[name];
+ }
+
+ %pythoncode {
+def __getitem__(self, name):
+ return self.getitem(name)
+ }
+}
+};
+
+%include <std_shared_ptr.i>
+
+%shared_ptr(fpm::Field);
+%include "fField.h"
+
+%shared_ptr(fpm::Body);
+%immutable fpm::Body::wake; // avoids the creation of the setter method
+%include "fBody.h"
+%shared_ptr(fpm::Wake);
+%include "fWake.h"
+
+%shared_ptr(fpm::Problem);
+%immutable fpm::Problem::msh;
+%include "fProblem.h"
+
+%shared_ptr(fpm::Builder);
+%immutable fpm::Builder::pbl;
+%include "fBuilder.h"
+
+%shared_ptr(fpm::Solver);
+%immutable fpm::Solver::aic;
+%include "fSolver.h"
diff --git a/fpm/models/n0012.geo b/fpm/models/n0012.geo
new file mode 100644
index 0000000000000000000000000000000000000000..c1c0f8047b81e01508d9250f421eaec6a6abcafd
--- /dev/null
+++ b/fpm/models/n0012.geo
@@ -0,0 +1,576 @@
+/* Rectangular NACA0012 wing */
+
+// Parameters
+// domain and mesh
+DefineConstant[ wSpn = { 2.0, Name "Wing span" } ];
+DefineConstant[ wNc = { 80, Name "Number of cells along wing chord" } ];
+DefineConstant[ wNs = { 10, Name "Number of cells along wing span" } ];
+DefineConstant[ tSpn = { 0.0, Name "Tail span" } ];
+DefineConstant[ tNc = { 40, Name "Number of cells along tail chord" } ];
+DefineConstant[ tNs = { 6, Name "Number of cells along tail span" } ];
+DefineConstant[ fWdt = { 0.0, Name "Field width" } ];
+DefineConstant[ nX = { 10, Name "Number of field cells along X" } ];
+DefineConstant[ nY = { 10, Name "Number of field cells along Y" } ];
+DefineConstant[ nZ = { 10, Name "Number of field cells along Z" } ];
+
+//// GEOMETRY
+
+/// Points
+
+// Wing
+Point(1) = {1.000000,-wSpn/2,0.000000};
+Point(2) = {0.999013,-wSpn/2,0.000143};
+Point(3) = {0.996057,-wSpn/2,0.000572};
+Point(4) = {0.991144,-wSpn/2,0.001280};
+Point(5) = {0.984292,-wSpn/2,0.002260};
+Point(6) = {0.975528,-wSpn/2,0.003501};
+Point(7) = {0.964888,-wSpn/2,0.004990};
+Point(8) = {0.952414,-wSpn/2,0.006710};
+Point(9) = {0.938153,-wSpn/2,0.008643};
+Point(10) = {0.922164,-wSpn/2,0.010770};
+Point(11) = {0.904508,-wSpn/2,0.013071};
+Point(12) = {0.885257,-wSpn/2,0.015523};
+Point(13) = {0.864484,-wSpn/2,0.018106};
+Point(14) = {0.842274,-wSpn/2,0.020795};
+Point(15) = {0.818712,-wSpn/2,0.023569};
+Point(16) = {0.793893,-wSpn/2,0.026405};
+Point(17) = {0.767913,-wSpn/2,0.029279};
+Point(18) = {0.740877,-wSpn/2,0.032168};
+Point(19) = {0.712890,-wSpn/2,0.035048};
+Point(20) = {0.684062,-wSpn/2,0.037896};
+Point(21) = {0.654508,-wSpn/2,0.040686};
+Point(22) = {0.624345,-wSpn/2,0.043394};
+Point(23) = {0.593691,-wSpn/2,0.045992};
+Point(24) = {0.562667,-wSpn/2,0.048455};
+Point(25) = {0.531395,-wSpn/2,0.050754};
+Point(26) = {0.500000,-wSpn/2,0.052862};
+Point(27) = {0.468605,-wSpn/2,0.054749};
+Point(28) = {0.437333,-wSpn/2,0.056390};
+Point(29) = {0.406309,-wSpn/2,0.057755};
+Point(30) = {0.375655,-wSpn/2,0.058819};
+Point(31) = {0.345492,-wSpn/2,0.059557};
+Point(32) = {0.315938,-wSpn/2,0.059947};
+Point(33) = {0.287110,-wSpn/2,0.059971};
+Point(34) = {0.259123,-wSpn/2,0.059614};
+Point(35) = {0.232087,-wSpn/2,0.058863};
+Point(36) = {0.206107,-wSpn/2,0.057712};
+Point(37) = {0.181288,-wSpn/2,0.056159};
+Point(38) = {0.157726,-wSpn/2,0.054206};
+Point(39) = {0.135516,-wSpn/2,0.051862};
+Point(40) = {0.114743,-wSpn/2,0.049138};
+Point(41) = {0.095492,-wSpn/2,0.046049};
+Point(42) = {0.077836,-wSpn/2,0.042615};
+Point(43) = {0.061847,-wSpn/2,0.038859};
+Point(44) = {0.047586,-wSpn/2,0.034803};
+Point(45) = {0.035112,-wSpn/2,0.030473};
+Point(46) = {0.024472,-wSpn/2,0.025893};
+Point(47) = {0.015708,-wSpn/2,0.021088};
+Point(48) = {0.008856,-wSpn/2,0.016078};
+Point(49) = {0.003943,-wSpn/2,0.010884};
+Point(50) = {0.000987,-wSpn/2,0.005521};
+Point(51) = {0.000000,-wSpn/2,0.000000};
+Point(52) = {0.000987,-wSpn/2,-0.005521};
+Point(53) = {0.003943,-wSpn/2,-0.010884};
+Point(54) = {0.008856,-wSpn/2,-0.016078};
+Point(55) = {0.015708,-wSpn/2,-0.021088};
+Point(56) = {0.024472,-wSpn/2,-0.025893};
+Point(57) = {0.035112,-wSpn/2,-0.030473};
+Point(58) = {0.047586,-wSpn/2,-0.034803};
+Point(59) = {0.061847,-wSpn/2,-0.038859};
+Point(60) = {0.077836,-wSpn/2,-0.042615};
+Point(61) = {0.095492,-wSpn/2,-0.046049};
+Point(62) = {0.114743,-wSpn/2,-0.049138};
+Point(63) = {0.135516,-wSpn/2,-0.051862};
+Point(64) = {0.157726,-wSpn/2,-0.054206};
+Point(65) = {0.181288,-wSpn/2,-0.056159};
+Point(66) = {0.206107,-wSpn/2,-0.057712};
+Point(67) = {0.232087,-wSpn/2,-0.058863};
+Point(68) = {0.259123,-wSpn/2,-0.059614};
+Point(69) = {0.287110,-wSpn/2,-0.059971};
+Point(70) = {0.315938,-wSpn/2,-0.059947};
+Point(71) = {0.345492,-wSpn/2,-0.059557};
+Point(72) = {0.375655,-wSpn/2,-0.058819};
+Point(73) = {0.406309,-wSpn/2,-0.057755};
+Point(74) = {0.437333,-wSpn/2,-0.056390};
+Point(75) = {0.468605,-wSpn/2,-0.054749};
+Point(76) = {0.500000,-wSpn/2,-0.052862};
+Point(77) = {0.531395,-wSpn/2,-0.050754};
+Point(78) = {0.562667,-wSpn/2,-0.048455};
+Point(79) = {0.593691,-wSpn/2,-0.045992};
+Point(80) = {0.624345,-wSpn/2,-0.043394};
+Point(81) = {0.654508,-wSpn/2,-0.040686};
+Point(82) = {0.684062,-wSpn/2,-0.037896};
+Point(83) = {0.712890,-wSpn/2,-0.035048};
+Point(84) = {0.740877,-wSpn/2,-0.032168};
+Point(85) = {0.767913,-wSpn/2,-0.029279};
+Point(86) = {0.793893,-wSpn/2,-0.026405};
+Point(87) = {0.818712,-wSpn/2,-0.023569};
+Point(88) = {0.842274,-wSpn/2,-0.020795};
+Point(89) = {0.864484,-wSpn/2,-0.018106};
+Point(90) = {0.885257,-wSpn/2,-0.015523};
+Point(91) = {0.904508,-wSpn/2,-0.013071};
+Point(92) = {0.922164,-wSpn/2,-0.010770};
+Point(93) = {0.938153,-wSpn/2,-0.008643};
+Point(94) = {0.952414,-wSpn/2,-0.006710};
+Point(95) = {0.964888,-wSpn/2,-0.004990};
+Point(96) = {0.975528,-wSpn/2,-0.003501};
+Point(97) = {0.984292,-wSpn/2,-0.002260};
+Point(98) = {0.991144,-wSpn/2,-0.001280};
+Point(99) = {0.996057,-wSpn/2,-0.000572};
+Point(100) = {0.999013,-wSpn/2,-0.000143};
+
+Point(102) = {1.000000,wSpn/2,0.000000};
+Point(103) = {0.999013,wSpn/2,0.000143};
+Point(104) = {0.996057,wSpn/2,0.000572};
+Point(105) = {0.991144,wSpn/2,0.001280};
+Point(106) = {0.984292,wSpn/2,0.002260};
+Point(107) = {0.975528,wSpn/2,0.003501};
+Point(108) = {0.964888,wSpn/2,0.004990};
+Point(109) = {0.952414,wSpn/2,0.006710};
+Point(110) = {0.938153,wSpn/2,0.008643};
+Point(111) = {0.922164,wSpn/2,0.010770};
+Point(112) = {0.904508,wSpn/2,0.013071};
+Point(113) = {0.885257,wSpn/2,0.015523};
+Point(114) = {0.864484,wSpn/2,0.018106};
+Point(115) = {0.842274,wSpn/2,0.020795};
+Point(116) = {0.818712,wSpn/2,0.023569};
+Point(117) = {0.793893,wSpn/2,0.026405};
+Point(118) = {0.767913,wSpn/2,0.029279};
+Point(119) = {0.740877,wSpn/2,0.032168};
+Point(120) = {0.712890,wSpn/2,0.035048};
+Point(121) = {0.684062,wSpn/2,0.037896};
+Point(122) = {0.654508,wSpn/2,0.040686};
+Point(123) = {0.624345,wSpn/2,0.043394};
+Point(124) = {0.593691,wSpn/2,0.045992};
+Point(125) = {0.562667,wSpn/2,0.048455};
+Point(126) = {0.531395,wSpn/2,0.050754};
+Point(127) = {0.500000,wSpn/2,0.052862};
+Point(128) = {0.468605,wSpn/2,0.054749};
+Point(129) = {0.437333,wSpn/2,0.056390};
+Point(130) = {0.406309,wSpn/2,0.057755};
+Point(131) = {0.375655,wSpn/2,0.058819};
+Point(132) = {0.345492,wSpn/2,0.059557};
+Point(133) = {0.315938,wSpn/2,0.059947};
+Point(134) = {0.287110,wSpn/2,0.059971};
+Point(135) = {0.259123,wSpn/2,0.059614};
+Point(136) = {0.232087,wSpn/2,0.058863};
+Point(137) = {0.206107,wSpn/2,0.057712};
+Point(138) = {0.181288,wSpn/2,0.056159};
+Point(139) = {0.157726,wSpn/2,0.054206};
+Point(140) = {0.135516,wSpn/2,0.051862};
+Point(141) = {0.114743,wSpn/2,0.049138};
+Point(142) = {0.095492,wSpn/2,0.046049};
+Point(143) = {0.077836,wSpn/2,0.042615};
+Point(144) = {0.061847,wSpn/2,0.038859};
+Point(145) = {0.047586,wSpn/2,0.034803};
+Point(146) = {0.035112,wSpn/2,0.030473};
+Point(147) = {0.024472,wSpn/2,0.025893};
+Point(148) = {0.015708,wSpn/2,0.021088};
+Point(149) = {0.008856,wSpn/2,0.016078};
+Point(150) = {0.003943,wSpn/2,0.010884};
+Point(151) = {0.000987,wSpn/2,0.005521};
+Point(152) = {0.000000,wSpn/2,0.000000};
+Point(153) = {0.000987,wSpn/2,-0.005521};
+Point(154) = {0.003943,wSpn/2,-0.010884};
+Point(155) = {0.008856,wSpn/2,-0.016078};
+Point(156) = {0.015708,wSpn/2,-0.021088};
+Point(157) = {0.024472,wSpn/2,-0.025893};
+Point(158) = {0.035112,wSpn/2,-0.030473};
+Point(159) = {0.047586,wSpn/2,-0.034803};
+Point(160) = {0.061847,wSpn/2,-0.038859};
+Point(161) = {0.077836,wSpn/2,-0.042615};
+Point(162) = {0.095492,wSpn/2,-0.046049};
+Point(163) = {0.114743,wSpn/2,-0.049138};
+Point(164) = {0.135516,wSpn/2,-0.051862};
+Point(165) = {0.157726,wSpn/2,-0.054206};
+Point(166) = {0.181288,wSpn/2,-0.056159};
+Point(167) = {0.206107,wSpn/2,-0.057712};
+Point(168) = {0.232087,wSpn/2,-0.058863};
+Point(169) = {0.259123,wSpn/2,-0.059614};
+Point(170) = {0.287110,wSpn/2,-0.059971};
+Point(171) = {0.315938,wSpn/2,-0.059947};
+Point(172) = {0.345492,wSpn/2,-0.059557};
+Point(173) = {0.375655,wSpn/2,-0.058819};
+Point(174) = {0.406309,wSpn/2,-0.057755};
+Point(175) = {0.437333,wSpn/2,-0.056390};
+Point(176) = {0.468605,wSpn/2,-0.054749};
+Point(177) = {0.500000,wSpn/2,-0.052862};
+Point(178) = {0.531395,wSpn/2,-0.050754};
+Point(179) = {0.562667,wSpn/2,-0.048455};
+Point(180) = {0.593691,wSpn/2,-0.045992};
+Point(181) = {0.624345,wSpn/2,-0.043394};
+Point(182) = {0.654508,wSpn/2,-0.040686};
+Point(183) = {0.684062,wSpn/2,-0.037896};
+Point(184) = {0.712890,wSpn/2,-0.035048};
+Point(185) = {0.740877,wSpn/2,-0.032168};
+Point(186) = {0.767913,wSpn/2,-0.029279};
+Point(187) = {0.793893,wSpn/2,-0.026405};
+Point(188) = {0.818712,wSpn/2,-0.023569};
+Point(189) = {0.842274,wSpn/2,-0.020795};
+Point(190) = {0.864484,wSpn/2,-0.018106};
+Point(191) = {0.885257,wSpn/2,-0.015523};
+Point(192) = {0.904508,wSpn/2,-0.013071};
+Point(193) = {0.922164,wSpn/2,-0.010770};
+Point(194) = {0.938153,wSpn/2,-0.008643};
+Point(195) = {0.952414,wSpn/2,-0.006710};
+Point(196) = {0.964888,wSpn/2,-0.004990};
+Point(197) = {0.975528,wSpn/2,-0.003501};
+Point(198) = {0.984292,wSpn/2,-0.002260};
+Point(199) = {0.991144,wSpn/2,-0.001280};
+Point(200) = {0.996057,wSpn/2,-0.000572};
+Point(201) = {0.999013,wSpn/2,-0.000143};
+
+// Tail
+If(tSpn != 0)
+ Point(301) = {5+1.000000/2,-tSpn/2,0.5+0.000000/2};
+ Point(302) = {5+0.999013/2,-tSpn/2,0.5+0.000143/2};
+ Point(303) = {5+0.996057/2,-tSpn/2,0.5+0.000572/2};
+ Point(304) = {5+0.991144/2,-tSpn/2,0.5+0.001280/2};
+ Point(305) = {5+0.984292/2,-tSpn/2,0.5+0.002260/2};
+ Point(306) = {5+0.975528/2,-tSpn/2,0.5+0.003501/2};
+ Point(307) = {5+0.964888/2,-tSpn/2,0.5+0.004990/2};
+ Point(308) = {5+0.952414/2,-tSpn/2,0.5+0.006710/2};
+ Point(309) = {5+0.938153/2,-tSpn/2,0.5+0.008643/2};
+ Point(310) = {5+0.922164/2,-tSpn/2,0.5+0.010770/2};
+ Point(311) = {5+0.904508/2,-tSpn/2,0.5+0.013071/2};
+ Point(312) = {5+0.885257/2,-tSpn/2,0.5+0.015523/2};
+ Point(313) = {5+0.864484/2,-tSpn/2,0.5+0.018106/2};
+ Point(314) = {5+0.842274/2,-tSpn/2,0.5+0.020795/2};
+ Point(315) = {5+0.818712/2,-tSpn/2,0.5+0.023569/2};
+ Point(316) = {5+0.793893/2,-tSpn/2,0.5+0.026405/2};
+ Point(317) = {5+0.767913/2,-tSpn/2,0.5+0.029279/2};
+ Point(318) = {5+0.740877/2,-tSpn/2,0.5+0.032168/2};
+ Point(319) = {5+0.712890/2,-tSpn/2,0.5+0.035048/2};
+ Point(320) = {5+0.684062/2,-tSpn/2,0.5+0.037896/2};
+ Point(321) = {5+0.654508/2,-tSpn/2,0.5+0.040686/2};
+ Point(322) = {5+0.624345/2,-tSpn/2,0.5+0.043394/2};
+ Point(323) = {5+0.593691/2,-tSpn/2,0.5+0.045992/2};
+ Point(324) = {5+0.562667/2,-tSpn/2,0.5+0.048455/2};
+ Point(325) = {5+0.531395/2,-tSpn/2,0.5+0.050754/2};
+ Point(326) = {5+0.500000/2,-tSpn/2,0.5+0.052862/2};
+ Point(327) = {5+0.468605/2,-tSpn/2,0.5+0.054749/2};
+ Point(328) = {5+0.437333/2,-tSpn/2,0.5+0.056390/2};
+ Point(329) = {5+0.406309/2,-tSpn/2,0.5+0.057755/2};
+ Point(330) = {5+0.375655/2,-tSpn/2,0.5+0.058819/2};
+ Point(331) = {5+0.345492/2,-tSpn/2,0.5+0.059557/2};
+ Point(332) = {5+0.315938/2,-tSpn/2,0.5+0.059947/2};
+ Point(333) = {5+0.287110/2,-tSpn/2,0.5+0.059971/2};
+ Point(334) = {5+0.259123/2,-tSpn/2,0.5+0.059614/2};
+ Point(335) = {5+0.232087/2,-tSpn/2,0.5+0.058863/2};
+ Point(336) = {5+0.206107/2,-tSpn/2,0.5+0.057712/2};
+ Point(337) = {5+0.181288/2,-tSpn/2,0.5+0.056159/2};
+ Point(338) = {5+0.157726/2,-tSpn/2,0.5+0.054206/2};
+ Point(339) = {5+0.135516/2,-tSpn/2,0.5+0.051862/2};
+ Point(340) = {5+0.114743/2,-tSpn/2,0.5+0.049138/2};
+ Point(341) = {5+0.095492/2,-tSpn/2,0.5+0.046049/2};
+ Point(342) = {5+0.077836/2,-tSpn/2,0.5+0.042615/2};
+ Point(343) = {5+0.061847/2,-tSpn/2,0.5+0.038859/2};
+ Point(344) = {5+0.047586/2,-tSpn/2,0.5+0.034803/2};
+ Point(345) = {5+0.035112/2,-tSpn/2,0.5+0.030473/2};
+ Point(346) = {5+0.024472/2,-tSpn/2,0.5+0.025893/2};
+ Point(347) = {5+0.015708/2,-tSpn/2,0.5+0.021088/2};
+ Point(348) = {5+0.008856/2,-tSpn/2,0.5+0.016078/2};
+ Point(349) = {5+0.003943/2,-tSpn/2,0.5+0.010884/2};
+ Point(350) = {5+0.000987/2,-tSpn/2,0.5+0.005521/2};
+ Point(351) = {5+0.000000/2,-tSpn/2,0.5+0.000000/2};
+ Point(352) = {5+0.000987/2,-tSpn/2,0.5-0.005521/2};
+ Point(353) = {5+0.003943/2,-tSpn/2,0.5-0.010884/2};
+ Point(354) = {5+0.008856/2,-tSpn/2,0.5-0.016078/2};
+ Point(355) = {5+0.015708/2,-tSpn/2,0.5-0.021088/2};
+ Point(356) = {5+0.024472/2,-tSpn/2,0.5-0.025893/2};
+ Point(357) = {5+0.035112/2,-tSpn/2,0.5-0.030473/2};
+ Point(358) = {5+0.047586/2,-tSpn/2,0.5-0.034803/2};
+ Point(359) = {5+0.061847/2,-tSpn/2,0.5-0.038859/2};
+ Point(360) = {5+0.077836/2,-tSpn/2,0.5-0.042615/2};
+ Point(361) = {5+0.095492/2,-tSpn/2,0.5-0.046049/2};
+ Point(362) = {5+0.114743/2,-tSpn/2,0.5-0.049138/2};
+ Point(363) = {5+0.135516/2,-tSpn/2,0.5-0.051862/2};
+ Point(364) = {5+0.157726/2,-tSpn/2,0.5-0.054206/2};
+ Point(365) = {5+0.181288/2,-tSpn/2,0.5-0.056159/2};
+ Point(366) = {5+0.206107/2,-tSpn/2,0.5-0.057712/2};
+ Point(367) = {5+0.232087/2,-tSpn/2,0.5-0.058863/2};
+ Point(368) = {5+0.259123/2,-tSpn/2,0.5-0.059614/2};
+ Point(369) = {5+0.287110/2,-tSpn/2,0.5-0.059971/2};
+ Point(370) = {5+0.315938/2,-tSpn/2,0.5-0.059947/2};
+ Point(371) = {5+0.345492/2,-tSpn/2,0.5-0.059557/2};
+ Point(372) = {5+0.375655/2,-tSpn/2,0.5-0.058819/2};
+ Point(373) = {5+0.406309/2,-tSpn/2,0.5-0.057755/2};
+ Point(374) = {5+0.437333/2,-tSpn/2,0.5-0.056390/2};
+ Point(375) = {5+0.468605/2,-tSpn/2,0.5-0.054749/2};
+ Point(376) = {5+0.500000/2,-tSpn/2,0.5-0.052862/2};
+ Point(377) = {5+0.531395/2,-tSpn/2,0.5-0.050754/2};
+ Point(378) = {5+0.562667/2,-tSpn/2,0.5-0.048455/2};
+ Point(379) = {5+0.593691/2,-tSpn/2,0.5-0.045992/2};
+ Point(380) = {5+0.624345/2,-tSpn/2,0.5-0.043394/2};
+ Point(381) = {5+0.654508/2,-tSpn/2,0.5-0.040686/2};
+ Point(382) = {5+0.684062/2,-tSpn/2,0.5-0.037896/2};
+ Point(383) = {5+0.712890/2,-tSpn/2,0.5-0.035048/2};
+ Point(384) = {5+0.740877/2,-tSpn/2,0.5-0.032168/2};
+ Point(385) = {5+0.767913/2,-tSpn/2,0.5-0.029279/2};
+ Point(386) = {5+0.793893/2,-tSpn/2,0.5-0.026405/2};
+ Point(387) = {5+0.818712/2,-tSpn/2,0.5-0.023569/2};
+ Point(388) = {5+0.842274/2,-tSpn/2,0.5-0.020795/2};
+ Point(389) = {5+0.864484/2,-tSpn/2,0.5-0.018106/2};
+ Point(390) = {5+0.885257/2,-tSpn/2,0.5-0.015523/2};
+ Point(391) = {5+0.904508/2,-tSpn/2,0.5-0.013071/2};
+ Point(392) = {5+0.922164/2,-tSpn/2,0.5-0.010770/2};
+ Point(393) = {5+0.938153/2,-tSpn/2,0.5-0.008643/2};
+ Point(394) = {5+0.952414/2,-tSpn/2,0.5-0.006710/2};
+ Point(395) = {5+0.964888/2,-tSpn/2,0.5-0.004990/2};
+ Point(396) = {5+0.975528/2,-tSpn/2,0.5-0.003501/2};
+ Point(397) = {5+0.984292/2,-tSpn/2,0.5-0.002260/2};
+ Point(398) = {5+0.991144/2,-tSpn/2,0.5-0.001280/2};
+ Point(399) = {5+0.996057/2,-tSpn/2,0.5-0.000572/2};
+ Point(400) = {5+0.999013/2,-tSpn/2,0.5-0.000143/2};
+
+ Point(402) = {5+1.000000/2,tSpn/2,0.5+0.000000/2};
+ Point(403) = {5+0.999013/2,tSpn/2,0.5+0.000143/2};
+ Point(404) = {5+0.996057/2,tSpn/2,0.5+0.000572/2};
+ Point(405) = {5+0.991144/2,tSpn/2,0.5+0.001280/2};
+ Point(406) = {5+0.984292/2,tSpn/2,0.5+0.002260/2};
+ Point(407) = {5+0.975528/2,tSpn/2,0.5+0.003501/2};
+ Point(408) = {5+0.964888/2,tSpn/2,0.5+0.004990/2};
+ Point(409) = {5+0.952414/2,tSpn/2,0.5+0.006710/2};
+ Point(410) = {5+0.938153/2,tSpn/2,0.5+0.008643/2};
+ Point(411) = {5+0.922164/2,tSpn/2,0.5+0.010770/2};
+ Point(412) = {5+0.904508/2,tSpn/2,0.5+0.013071/2};
+ Point(413) = {5+0.885257/2,tSpn/2,0.5+0.015523/2};
+ Point(414) = {5+0.864484/2,tSpn/2,0.5+0.018106/2};
+ Point(415) = {5+0.842274/2,tSpn/2,0.5+0.020795/2};
+ Point(416) = {5+0.818712/2,tSpn/2,0.5+0.023569/2};
+ Point(417) = {5+0.793893/2,tSpn/2,0.5+0.026405/2};
+ Point(418) = {5+0.767913/2,tSpn/2,0.5+0.029279/2};
+ Point(419) = {5+0.740877/2,tSpn/2,0.5+0.032168/2};
+ Point(420) = {5+0.712890/2,tSpn/2,0.5+0.035048/2};
+ Point(421) = {5+0.684062/2,tSpn/2,0.5+0.037896/2};
+ Point(422) = {5+0.654508/2,tSpn/2,0.5+0.040686/2};
+ Point(423) = {5+0.624345/2,tSpn/2,0.5+0.043394/2};
+ Point(424) = {5+0.593691/2,tSpn/2,0.5+0.045992/2};
+ Point(425) = {5+0.562667/2,tSpn/2,0.5+0.048455/2};
+ Point(426) = {5+0.531395/2,tSpn/2,0.5+0.050754/2};
+ Point(427) = {5+0.500000/2,tSpn/2,0.5+0.052862/2};
+ Point(428) = {5+0.468605/2,tSpn/2,0.5+0.054749/2};
+ Point(429) = {5+0.437333/2,tSpn/2,0.5+0.056390/2};
+ Point(430) = {5+0.406309/2,tSpn/2,0.5+0.057755/2};
+ Point(431) = {5+0.375655/2,tSpn/2,0.5+0.058819/2};
+ Point(432) = {5+0.345492/2,tSpn/2,0.5+0.059557/2};
+ Point(433) = {5+0.315938/2,tSpn/2,0.5+0.059947/2};
+ Point(434) = {5+0.287110/2,tSpn/2,0.5+0.059971/2};
+ Point(435) = {5+0.259123/2,tSpn/2,0.5+0.059614/2};
+ Point(436) = {5+0.232087/2,tSpn/2,0.5+0.058863/2};
+ Point(437) = {5+0.206107/2,tSpn/2,0.5+0.057712/2};
+ Point(438) = {5+0.181288/2,tSpn/2,0.5+0.056159/2};
+ Point(439) = {5+0.157726/2,tSpn/2,0.5+0.054206/2};
+ Point(440) = {5+0.135516/2,tSpn/2,0.5+0.051862/2};
+ Point(441) = {5+0.114743/2,tSpn/2,0.5+0.049138/2};
+ Point(442) = {5+0.095492/2,tSpn/2,0.5+0.046049/2};
+ Point(443) = {5+0.077836/2,tSpn/2,0.5+0.042615/2};
+ Point(444) = {5+0.061847/2,tSpn/2,0.5+0.038859/2};
+ Point(445) = {5+0.047586/2,tSpn/2,0.5+0.034803/2};
+ Point(446) = {5+0.035112/2,tSpn/2,0.5+0.030473/2};
+ Point(447) = {5+0.024472/2,tSpn/2,0.5+0.025893/2};
+ Point(448) = {5+0.015708/2,tSpn/2,0.5+0.021088/2};
+ Point(449) = {5+0.008856/2,tSpn/2,0.5+0.016078/2};
+ Point(450) = {5+0.003943/2,tSpn/2,0.5+0.010884/2};
+ Point(451) = {5+0.000987/2,tSpn/2,0.5+0.005521/2};
+ Point(452) = {5+0.000000/2,tSpn/2,0.5+0.000000/2};
+ Point(453) = {5+0.000987/2,tSpn/2,0.5-0.005521/2};
+ Point(454) = {5+0.003943/2,tSpn/2,0.5-0.010884/2};
+ Point(455) = {5+0.008856/2,tSpn/2,0.5-0.016078/2};
+ Point(456) = {5+0.015708/2,tSpn/2,0.5-0.021088/2};
+ Point(457) = {5+0.024472/2,tSpn/2,0.5-0.025893/2};
+ Point(458) = {5+0.035112/2,tSpn/2,0.5-0.030473/2};
+ Point(459) = {5+0.047586/2,tSpn/2,0.5-0.034803/2};
+ Point(460) = {5+0.061847/2,tSpn/2,0.5-0.038859/2};
+ Point(461) = {5+0.077836/2,tSpn/2,0.5-0.042615/2};
+ Point(462) = {5+0.095492/2,tSpn/2,0.5-0.046049/2};
+ Point(463) = {5+0.114743/2,tSpn/2,0.5-0.049138/2};
+ Point(464) = {5+0.135516/2,tSpn/2,0.5-0.051862/2};
+ Point(465) = {5+0.157726/2,tSpn/2,0.5-0.054206/2};
+ Point(466) = {5+0.181288/2,tSpn/2,0.5-0.056159/2};
+ Point(467) = {5+0.206107/2,tSpn/2,0.5-0.057712/2};
+ Point(468) = {5+0.232087/2,tSpn/2,0.5-0.058863/2};
+ Point(469) = {5+0.259123/2,tSpn/2,0.5-0.059614/2};
+ Point(470) = {5+0.287110/2,tSpn/2,0.5-0.059971/2};
+ Point(471) = {5+0.315938/2,tSpn/2,0.5-0.059947/2};
+ Point(472) = {5+0.345492/2,tSpn/2,0.5-0.059557/2};
+ Point(473) = {5+0.375655/2,tSpn/2,0.5-0.058819/2};
+ Point(474) = {5+0.406309/2,tSpn/2,0.5-0.057755/2};
+ Point(475) = {5+0.437333/2,tSpn/2,0.5-0.056390/2};
+ Point(476) = {5+0.468605/2,tSpn/2,0.5-0.054749/2};
+ Point(477) = {5+0.500000/2,tSpn/2,0.5-0.052862/2};
+ Point(478) = {5+0.531395/2,tSpn/2,0.5-0.050754/2};
+ Point(479) = {5+0.562667/2,tSpn/2,0.5-0.048455/2};
+ Point(480) = {5+0.593691/2,tSpn/2,0.5-0.045992/2};
+ Point(481) = {5+0.624345/2,tSpn/2,0.5-0.043394/2};
+ Point(482) = {5+0.654508/2,tSpn/2,0.5-0.040686/2};
+ Point(483) = {5+0.684062/2,tSpn/2,0.5-0.037896/2};
+ Point(484) = {5+0.712890/2,tSpn/2,0.5-0.035048/2};
+ Point(485) = {5+0.740877/2,tSpn/2,0.5-0.032168/2};
+ Point(486) = {5+0.767913/2,tSpn/2,0.5-0.029279/2};
+ Point(487) = {5+0.793893/2,tSpn/2,0.5-0.026405/2};
+ Point(488) = {5+0.818712/2,tSpn/2,0.5-0.023569/2};
+ Point(489) = {5+0.842274/2,tSpn/2,0.5-0.020795/2};
+ Point(490) = {5+0.864484/2,tSpn/2,0.5-0.018106/2};
+ Point(491) = {5+0.885257/2,tSpn/2,0.5-0.015523/2};
+ Point(492) = {5+0.904508/2,tSpn/2,0.5-0.013071/2};
+ Point(493) = {5+0.922164/2,tSpn/2,0.5-0.010770/2};
+ Point(494) = {5+0.938153/2,tSpn/2,0.5-0.008643/2};
+ Point(495) = {5+0.952414/2,tSpn/2,0.5-0.006710/2};
+ Point(496) = {5+0.964888/2,tSpn/2,0.5-0.004990/2};
+ Point(497) = {5+0.975528/2,tSpn/2,0.5-0.003501/2};
+ Point(498) = {5+0.984292/2,tSpn/2,0.5-0.002260/2};
+ Point(499) = {5+0.991144/2,tSpn/2,0.5-0.001280/2};
+ Point(500) = {5+0.996057/2,tSpn/2,0.5-0.000572/2};
+ Point(501) = {5+0.999013/2,tSpn/2,0.5-0.000143/2};
+EndIf
+
+// Field
+If(fWdt != 0)
+ Point(1000001) = {-2, -fWdt/2, -2};
+ Point(1000002) = {8, -fWdt/2, -2};
+ Point(1000003) = {8, -fWdt/2, 2};
+ Point(1000004) = {-2, -fWdt/2, 2};
+ Point(1000005) = {-2, fWdt/2, -2};
+ Point(1000006) = {8, fWdt/2, -2};
+ Point(1000007) = {8, fWdt/2, 2};
+ Point(1000008) = {-2, fWdt/2, 2};
+EndIf
+
+/// Lines
+
+//Wing
+Spline(1) = {1:51};
+Spline(2) = {51:100,1};
+Spline(5) = {102:152};
+Spline(6) = {152:201,102};
+Line(11) = {1,102};
+Line(12) = {51,152};
+
+// Tail
+If(tSpn != 0)
+ Spline(21) = {301:351};
+ Spline(22) = {351:400,301};
+ Spline(25) = {402:452};
+ Spline(26) = {452:501,402};
+ Line(31) = {301,402};
+ Line(32) = {351,452};
+EndIf
+
+// Field
+If(fWdt != 0)
+ Line(1000001) = {1000001, 1000002};
+ Line(1000002) = {1000002, 1000003};
+ Line(1000003) = {1000003, 1000004};
+ Line(1000004) = {1000004, 1000001};
+ Line(1000005) = {1000005, 1000006};
+ Line(1000006) = {1000006, 1000007};
+ Line(1000007) = {1000007, 1000008};
+ Line(1000008) = {1000008, 1000005};
+ Line(1000009) = {1000001, 1000005};
+ Line(1000010) = {1000002, 1000006};
+ Line(1000011) = {1000003, 1000007};
+ Line(1000012) = {1000004, 1000008};
+EndIf
+
+/// Line loops & Surfaces
+
+// Wing
+Line Loop(1) = {1,12,-5,-11};
+Line Loop(2) = {2,11,-6,-12};
+Surface(1) = {-1};
+Surface(2) = {-2};
+
+// Tail
+If(tSpn != 0)
+ Line Loop(11) = {21,32,-25,-31};
+ Line Loop(12) = {22,31,-26,-32};
+ Surface(11) = {-11};
+ Surface(12) = {-12};
+EndIf
+
+// Field
+If(fWdt != 0)
+ Line Loop(101) = {1000001, 1000002, 1000003, 1000004};
+ Line Loop(102) = {1000002, 1000011, -1000006, -1000010};
+ Line Loop(103) = {1000005, 1000006, 1000007, 1000008};
+ Line Loop(104) = {1000004, 1000009, -1000008, -1000012};
+ Line Loop(105) = {1000003, 1000012, -1000007, -1000011};
+ Line Loop(106) = {1000001, 1000010, -1000005, -1000009};
+ Surface(101) = {-101};
+ Surface(102) = {102};
+ Surface(103) = {103};
+ Surface(104) = {104};
+ Surface(105) = {105};
+ Surface(106) = {106};
+EndIf
+
+/// Volume
+If(fWdt != 0)
+ Surface Loop(1) = {101:106};
+ Volume(1) = {1};
+EndIf
+
+//// MESHING
+
+/// Lines
+
+// Wing
+Transfinite Line{1, 2, 5, 6} = wNc + 1 Using Bump 0.05;
+Transfinite Line{11, 12} = wNs + 1;
+
+// Tail
+If(tSpn != 0)
+ Transfinite Line{21, 22, 25, 26} = tNc + 1 Using Bump 0.05;
+ Transfinite Line{31, 32} = tNs + 1;
+EndIf
+
+// Field
+If(fWdt != 0)
+ Transfinite Line{1000001, 1000003, 1000005, 1000007} = nX + 1;
+ Transfinite Line{1000009, 1000010, 1000011, 1000012} = nY + 1;
+ Transfinite Line{1000002, 1000004, 1000006, 1000008} = nZ + 1;
+EndIf
+
+/// Surfaces
+
+// Wing
+Transfinite Surface{1, 2};
+Recombine Surface{1, 2};
+
+// Tail
+If(tSpn != 0)
+ Transfinite Surface{11, 12};
+ Recombine Surface{11, 12};
+EndIf
+
+// Field
+If(fWdt != 0)
+ Transfinite Surface{101:106};
+ Recombine Surface{101:106};
+EndIf
+
+/// Volume
+
+// Field
+If(fWdt != 0)
+ Transfinite Volume{1};
+ Recombine Volume{1};
+EndIf
+
+//// PHYSICAL GROUPS
+
+// Wing
+Physical Line("wTe") = {11};
+Physical Surface("wing") = {1,2};
+
+// Tail
+If(tSpn != 0)
+ Physical Line("tTe") = {31};
+ Physical Surface("tail") = {11,12};
+EndIf
+
+// Field
+If(fWdt != 0)
+ Physical Volume("field") = {1};
+EndIf
diff --git a/fpm/models/n0012.py b/fpm/models/n0012.py
new file mode 100644
index 0000000000000000000000000000000000000000..aecc9643019973c1bd99ca46931031d028adc151
--- /dev/null
+++ b/fpm/models/n0012.py
@@ -0,0 +1,58 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+# Copyright 2020 University of Liège
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Naca 0012 model
+# Adrien Crovato
+
+import fpm
+import tbox
+import tbox.gmsh as gmsh
+from fwk.coloring import ccolors
+
+def main(p, tail=False, field=False):
+ # timer
+ tms = fpm.Timers()
+ tms['total'].start()
+ # mesh
+ print(ccolors.ANSI_BLUE + 'PyMeshing...' + ccolors.ANSI_RESET)
+ msh = gmsh.MeshLoader('n0012.geo', __file__).execute(**p['pars'])
+ # problem
+ pbl = fpm.Problem(msh, p['aoa'], p['aos'], p['mach'], p['spn'], 1, 0, 0, 0)
+ wing = fpm.Body(msh, 'wing', ['wTe'], 10)
+ pbl.add(wing)
+ if tail:
+ tail = fpm.Body(msh, 'tail', ['tTe'], 10)
+ pbl.add(tail)
+ if field:
+ field = fpm.Field(msh, 'field')
+ pbl.set(field)
+ # AIC builder
+ aic = fpm.Builder(pbl)
+ aic.run()
+ # solver
+ slv = fpm.Solver(aic)
+ slv.run()
+ slv.save(tbox.GmshExport(msh))
+ print('\n', slv)
+ # end timer
+ tms['total'].stop()
+ print(ccolors.ANSI_BLUE + 'PyTiming...' + ccolors.ANSI_RESET)
+ print(tms)
+
+if __name__ == '__main__':
+ main()
+
diff --git a/fpm/src/CMakeLists.txt b/fpm/src/CMakeLists.txt
new file mode 100644
index 0000000000000000000000000000000000000000..15f283e16e513b3fbea89479fd032b522be76ef2
--- /dev/null
+++ b/fpm/src/CMakeLists.txt
@@ -0,0 +1,37 @@
+# Copyright 2020 University of Liège
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# CMake input file of fpm.so
+
+FILE(GLOB SRCS *.h *.cpp *.inl *.hpp)
+
+ADD_LIBRARY(fpm SHARED ${SRCS})
+MACRO_DebugPostfix(fpm)
+
+TARGET_INCLUDE_DIRECTORIES(fpm PUBLIC ${PROJECT_SOURCE_DIR}/fpm/src)
+
+# -- Eigen
+FIND_PACKAGE(EIGEN 3.3.4 REQUIRED)
+TARGET_INCLUDE_DIRECTORIES(fpm PUBLIC ${EIGEN_INCLUDE_DIRS})
+TARGET_COMPILE_DEFINITIONS(fpm PUBLIC EIGEN_DONT_PARALLELIZE)
+
+# -- WAVES (if no path is provided, assume that it is located next to fpm)
+IF(NOT DEFINED CMAKE_PREFIX_PATH)
+ SET(CMAKE_PREFIX_PATH "${PROJECT_SOURCE_DIR}/../waves/build")
+ENDIF()
+FIND_PACKAGE(WAVES REQUIRED)
+TARGET_INCLUDE_DIRECTORIES(fpm PUBLIC ${WAVES_INCLUDE_DIRS})
+TARGET_LINK_LIBRARIES(fpm ${WAVES_LIBRARIES})
+
+SOURCE_GROUP(base REGULAR_EXPRESSION ".*\\.(cpp|inl|hpp|h)")
diff --git a/fpm/src/fBody.cpp b/fpm/src/fBody.cpp
new file mode 100644
index 0000000000000000000000000000000000000000..571fb5804c2c95b8c990a0611d1e87fcaf6791aa
--- /dev/null
+++ b/fpm/src/fBody.cpp
@@ -0,0 +1,155 @@
+/*
+ * Copyright 2020 University of Liège
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "fBody.h"
+#include "fWake.h"
+#include "wMshData.h"
+#include "wNode.h"
+#include "wElement.h"
+#include "wTag.h"
+#include "wQuad4.h"
+#include "wGmshExport.h"
+#include <iomanip>
+#include <fstream>
+using namespace tbox;
+using namespace fpm;
+
+Body::Body(std::shared_ptr<MshData> _msh, std::string const &id,
+ std::vector<std::string> const &teIds, double xF) : Group(_msh, id), Cl(0), Cd(0), Cs(0), Cm(0)
+{
+ // Get nodes
+ for (auto e : tag->elems)
+ for (auto n : e->nodes)
+ nodes.push_back(n);
+ std::sort(nodes.begin(), nodes.end());
+ nodes.erase(std::unique(nodes.begin(), nodes.end()), nodes.end());
+ // Associate each node to its adjacent elements
+ for (auto e : tag->elems)
+ for (auto n : e->nodes)
+ neMap[n].push_back(e);
+
+ // If wakes are requested, check if they are already available, otherwise create them
+ bool hasChanged = false;
+ size_t j = 0;
+ for (auto teId : teIds)
+ {
+ std::cout << "Creating wake... " << std::flush;
+ try
+ {
+ wakes.push_back(new Wake(_msh, tag->name + "Wake" + std::to_string(j), tag));
+ std::cout << *wakes.back() << " already existing, nothing done." << std::endl;
+ }
+ catch (const std::out_of_range &)
+ {
+ // Notify that mesh needs to be saved
+ hasChanged = true;
+ // Create tags
+ Tag *tagp = new Tag(static_cast<int>(msh->ptags.rbegin()->first + 1), tag->name + "Wake" + std::to_string(j), 2);
+ Tag *tage = new Tag(static_cast<int>(msh->etags.rbegin()->first + 1), tag->name + "Wake" + std::to_string(j), 2);
+ msh->ntags[tag->name + "Wake" + std::to_string(j)] = tagp;
+ msh->ptags[static_cast<int>(msh->ptags.rbegin()->first + 1)] = tagp;
+ msh->etags[static_cast<int>(msh->etags.rbegin()->first + 1)] = tage;
+ // Sort TE nodes (ascending along y-coordinate)
+ Group te(_msh, teId);
+ std::vector<Node *> teNodes;
+ for (auto e : te.tag->elems)
+ for (auto n : e->nodes)
+ teNodes.push_back(n);
+ std::sort(teNodes.begin(), teNodes.end(), [](Node *a, Node *b) -> bool { return a->pos(1) < b->pos(1); });
+ teNodes.erase(std::unique(teNodes.begin(), teNodes.end()), teNodes.end());
+ // Translate TE nodes (along x-coordinate)
+ std::vector<Node *> wkNodes;
+ for (auto n : teNodes)
+ {
+ // Sanity check
+ if (xF <= n->pos(0))
+ {
+ std::stringstream err;
+ err << "fpm::Body: zero or negative length wake requested for " << *tag << "!\n";
+ throw std::runtime_error(err.str());
+ }
+ Node *nN = new Node(msh->nodes.back()->no + 1, Eigen::Vector3d(xF, n->pos(1), n->pos(2)));
+ wkNodes.push_back(nN);
+ msh->nodes.push_back(nN);
+ }
+ // Create wake elements
+ for (size_t i = 0; i < wkNodes.size() - 1; ++i)
+ {
+ std::vector<Node *> qnodes = {teNodes[i], wkNodes[i], wkNodes[i + 1], teNodes[i + 1]};
+ msh->elems.push_back(new Quad4(msh->elems.back()->no + 1, tagp, tage, tag->elems[0]->parts, qnodes));
+ }
+ // Create wake
+ wakes.push_back(new Wake(_msh, tag->name + "Wake" + std::to_string(j), tag));
+ std::cout << *wakes.back() << " created. " << std::flush;
+ }
+ ++j;
+ }
+ // Save the mesh if modified
+ if (hasChanged)
+ {
+ GmshExport writer(_msh);
+ writer.save(_msh->name);
+ }
+
+ // Size load vectors
+ cLoadX.resize(nodes.size());
+ cLoadY.resize(nodes.size());
+ cLoadZ.resize(nodes.size());
+}
+
+/**
+ * @brief Save global quantities to file
+ */
+void Body::save(std::string const &name)
+{
+ // Write to file
+ std::cout << "writing file: " << name + ".dat"
+ << "... " << std::flush;
+ std::ofstream outfile;
+ outfile.open(name + ".dat");
+ // Header
+ outfile << "$Body - " << tag->name << std::endl;
+ // Element count
+ outfile << "$Elements" << std::endl;
+ outfile << tag->elems.size();
+ // Aerodynamic coefficients
+ outfile << "$Aerodynamic coefficients" << std::endl;
+ outfile << "#" << std::fixed
+ << std::setw(14) << "Cl"
+ << std::setw(15) << "Cd"
+ << std::setw(15) << "Cs"
+ << std::setw(15) << "Cm"
+ << std::endl;
+ outfile << std::fixed
+ << std::setw(15) << Cl
+ << std::setw(15) << Cd
+ << std::setw(15) << Cs
+ << std::setw(15) << Cm
+ << std::endl;
+ // Footer
+ outfile << std::endl;
+ // Close file
+ outfile.close();
+ std::cout << "done!" << std::endl;
+}
+
+void Body::write(std::ostream &out) const
+{
+ out << "fpm::Body " << *tag << std::endl;
+ out << "with";
+ for (auto w : wakes)
+ out << "\t" << *w;
+}
diff --git a/fpm/src/fBody.h b/fpm/src/fBody.h
new file mode 100644
index 0000000000000000000000000000000000000000..181af38f670c9699a95aca280a52f37cec84b47c
--- /dev/null
+++ b/fpm/src/fBody.h
@@ -0,0 +1,58 @@
+/*
+ * Copyright 2020 University of Liège
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef FBODY_H
+#define FBODY_H
+
+#include "fpm.h"
+#include "wGroup.h"
+#include <vector>
+#include <map>
+
+namespace fpm
+{
+
+/**
+ * @brief Manage a body immersed in the fluid (lifting surface)
+ * @authors Adrien Crovato
+ */
+class FPM_API Body : public tbox::Group
+{
+public:
+ double Cl; ///< lift coefficient
+ double Cd; ///< drag coefficient
+ double Cs; ///< sideforce coefficient
+ double Cm; ///< pitch moment coefficient (positive nose-up)
+ std::vector<double> cLoadX; ///< x-component of aerodynamic load normalized by dynamic pressure
+ std::vector<double> cLoadY; ///< y-component of aerodynamic load normalized by dynamic pressure
+ std::vector<double> cLoadZ; ///< z-component of aerodynamic load normalized by dynamic pressure
+ std::vector<tbox::Node *> nodes; ///< nodes of the surface
+ std::map<tbox::Node *, std::vector<tbox::Element *>> neMap; ///< map between nodes and adjacent elements
+ std::vector<Wake *> wakes; ///< wake(s) attached to the lifting surface
+
+ Body(std::shared_ptr<tbox::MshData> _msh, std::string const &name, std::vector<std::string> const &teNames, double xF);
+ ~Body() { std::cout << "~Body()\n"; }
+
+ virtual void save(std::string const &name);
+
+#ifndef SWIG
+ virtual void write(std::ostream &out) const override;
+#endif
+};
+
+} // namespace fpm
+
+#endif //FBODY_H
diff --git a/fpm/src/fBuilder.cpp b/fpm/src/fBuilder.cpp
new file mode 100644
index 0000000000000000000000000000000000000000..720b3b879a74ecf2e7d028357a4f5bef5bd4325d
--- /dev/null
+++ b/fpm/src/fBuilder.cpp
@@ -0,0 +1,163 @@
+/*
+ * Copyright 2020 University of Liège
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "fBuilder.h"
+#include "fProblem.h"
+#include "fField.h"
+#include "fBody.h"
+#include "fWake.h"
+
+#include "wTag.h"
+#include "wElement.h"
+#include "wMem.h"
+
+#define PI 3.14159
+
+using namespace tbox;
+using namespace fpm;
+
+/**
+ * @brief Initialize the solver and perform sanity checks
+ * @authors Adrien Crovato
+ */
+Builder::Builder(std::shared_ptr<Problem> _pbl) : pbl(_pbl), valid(false)
+{
+ // Check the problem and update element memory
+ pbl->check();
+ pbl->updateMem();
+
+ // Setup AIC matrices
+ pbl->field ? nF = pbl->field->tag->elems.size() : nF = 0;
+ nP = 0;
+ for (auto body : pbl->bodies)
+ nP += body->tag->elems.size();
+ A = Eigen::MatrixXd::Zero(nP, nP);
+ B = Eigen::MatrixXd::Zero(nP, nP);
+ C = Eigen::MatrixXd::Zero(nP, nF);
+ Cx = Eigen::MatrixXd::Zero(nP, nF);
+ Cy = Eigen::MatrixXd::Zero(nP, nF);
+ Cz = Eigen::MatrixXd::Zero(nP, nF);
+}
+
+/**
+ * @brief Fill AIC matrices
+ */
+void Builder::run()
+{
+ // global->local id
+ std::map<Element *, int> rows;
+ int i = 0;
+ for (auto body : pbl->bodies)
+ for (auto e : body->tag->elems)
+ {
+ rows[e] = i;
+ i++;
+ }
+
+ // body to body
+ for (auto ibody : pbl->bodies)
+ for (auto ei : ibody->tag->elems)
+ {
+ // body panels
+ for (auto jbody : pbl->bodies)
+ for (auto ej : jbody->tag->elems)
+ {
+ A(rows.at(ei), rows.at(ej)) = mu(ei, ej);
+ B(rows.at(ei), rows.at(ej)) = tau(ei, ej);
+ }
+ // wake panels
+ for (auto jbody : pbl->bodies)
+ for (auto wake : jbody->wakes)
+ for (auto ew : wake->tag->elems)
+ {
+ double wmu = mu(ei, ew);
+ A(rows.at(ei), rows.at(wake->wkMap.at(ew).first)) += wmu;
+ A(rows.at(ei), rows.at(wake->wkMap.at(ew).second)) -= wmu;
+ }
+ }
+
+ // field to body
+ if (pbl->field)
+ for (auto body : pbl->bodies)
+ for (auto e : body->tag->elems)
+ for (size_t j = 0; j < pbl->field->tag->elems.size(); ++j)
+ {
+ C(rows.at(e), j) = sigma(e, pbl->field->tag->elems[j]);
+ Cx(rows.at(e), j) = sigmaX(e, pbl->field->tag->elems[j]);
+ Cy(rows.at(e), j) = sigmaY(e, pbl->field->tag->elems[j]);
+ Cz(rows.at(e), j) = sigmaY(e, pbl->field->tag->elems[j]);
+ }
+
+ valid = true;
+}
+
+/**
+ * @brief Compute doublet AIC from body panel ej to body panel ei
+ */
+double Builder::mu(Element *ei, Element *ej)
+{
+ if (ei == ej)
+ return 0.5;
+ else
+ return 0;
+}
+/**
+ * @brief Compute source AIC from body panel ej to body panel ei
+ */
+double Builder::tau(Element *ei, Element *ej)
+{
+ if (ei == ej)
+ return 0;
+ else
+ return 0;
+}
+/**
+ * @brief Compute source AIC from field panel ej to body panel ei
+ */
+double Builder::sigma(Element *ei, Element *ej)
+{
+ return 0;
+}
+/**
+ * @brief Compute source x-velocity AIC from field panel ej to body panel ei
+ */
+double Builder::sigmaX(Element *ei, Element *ej)
+{
+ return 0;
+}
+/**
+ * @brief Compute source y-velocity AIC from field panel ej to body panel ei
+ */
+double Builder::sigmaY(Element *ei, Element *ej)
+{
+ return 0;
+}
+/**
+ * @brief Compute source z-velocity AIC from field panel ej to body panel ei
+ */
+double Builder::sigmaZ(Element *ei, Element *ej)
+{
+ return 0;
+}
+
+void Builder::write(std::ostream &out) const
+{
+ out << "fpm::Builder with AIC matrices:"
+ << "\n\tA(" << A.rows() << "," << A.cols() << "), B(" << B.rows() << "," << B.cols() << ")"
+ << "\n\tC(" << C.rows() << "," << C.cols() << ")"
+ << "\n\tCx(" << Cx.rows() << "," << Cx.cols() << "), Cy(" << Cy.rows() << "," << Cy.cols() << "), Cz(" << Cz.rows() << "," << Cz.cols() << ")"
+ << "\nwith\t" << *pbl;
+}
diff --git a/fpm/src/fBuilder.h b/fpm/src/fBuilder.h
new file mode 100644
index 0000000000000000000000000000000000000000..bb290cc1eda4eb4ec983a34fea48bb60edd7b556
--- /dev/null
+++ b/fpm/src/fBuilder.h
@@ -0,0 +1,71 @@
+/*
+ * Copyright 2020 University of Liège
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef FBUILDER_H
+#define FBUILDER_H
+
+#include "fpm.h"
+#include "wObject.h"
+
+#include <iostream>
+#include <vector>
+#include <memory>
+#include <Eigen/Dense>
+
+namespace fpm
+{
+
+/**
+ * @brief Aerodynamic Influence Coefficients builder
+ * @authors Adrien Crovato
+ * @todo add symmetry support
+ * @todo implement AIC computation
+ */
+class FPM_API Builder : public fwk::wSharedObject
+{
+public:
+ std::shared_ptr<Problem> pbl; ///< problem definition
+
+ bool valid; ///< matrices are up-to-date
+ int nP; ///< number of body panels
+ int nF; ///< number of field panels
+ Eigen::MatrixXd A; ///< body-body doublet matrix
+ Eigen::MatrixXd B; ///< body-body source matrix
+ Eigen::MatrixXd C; ///< field-body source matrix
+ Eigen::MatrixXd Cx; ///< field-body x-velocity source matrix
+ Eigen::MatrixXd Cy; ///< field-body y-velocity source matrix
+ Eigen::MatrixXd Cz; ///< field-body z-velocity source matrix
+
+ Builder(std::shared_ptr<Problem> _pbl);
+ ~Builder() { std::cout << "~Builder()\n"; }
+
+ void run();
+
+#ifndef SWIG
+ virtual void write(std::ostream &out) const override;
+#endif
+
+private:
+ double mu(tbox::Element *ei, tbox::Element *ej);
+ double tau(tbox::Element *ei, tbox::Element *ej);
+ double sigma(tbox::Element *ei, tbox::Element *ej);
+ double sigmaX(tbox::Element *ei, tbox::Element *ej);
+ double sigmaY(tbox::Element *ei, tbox::Element *ej);
+ double sigmaZ(tbox::Element *ei, tbox::Element *ej);
+};
+
+} // namespace fpm
+#endif //FBUILDER_H
diff --git a/fpm/src/fEdge.h b/fpm/src/fEdge.h
new file mode 100644
index 0000000000000000000000000000000000000000..959675c9f0ac289117855b9917db7ce3d206b909
--- /dev/null
+++ b/fpm/src/fEdge.h
@@ -0,0 +1,93 @@
+/*
+ * Copyright 2020 University of Liège
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef FEDGE_H
+#define FEDGE_H
+
+#include "fpm.h"
+#include "wNode.h"
+
+#ifndef SWIG
+namespace fpm
+{
+
+/**
+ * @brief Common edge of three elements
+ * @authors Adrien Crovato
+ * @todo copy-pasted from waves/flow/wFace.h
+ */
+class FPM_API Edge
+{
+public:
+ std::vector<tbox::Node *> nods;
+ tbox::Element *el0;
+ tbox::Element *el1;
+ tbox::Element *el2;
+
+ Edge(std::vector<tbox::Node *> const &_nods) : nods(_nods), el0(NULL), el1(NULL), el2(NULL) {}
+};
+
+/**
+ * @brief Edge comparator
+ * @authors Adrien Crovato, Romain Boman
+ * @todo copy-pasted from waves/flow/wFace.h
+ */
+class FPM_API EquEdge
+{
+public:
+ // Default parameters
+ static const size_t bucket_size = 4;
+ static const size_t min_buckets = 8;
+ // Function returning a unique size_t per Edge
+ size_t operator()(Edge *const f) const
+ {
+ size_t sum = 0;
+ for (auto n : f->nods)
+ sum += static_cast<size_t>(n->no);
+
+ return sum; // sum of nodes id
+ }
+ // Function allowing to univoquely identify a Edge
+ bool operator()(Edge *const f0, Edge *const f1) const
+ {
+ bool flag = false;
+ size_t cnt = 0;
+ // compare nodes of f0 to nodes of f1
+ for (auto n0 : f0->nods)
+ {
+ for (auto n1 : f1->nods)
+ {
+ if (n0 == n1)
+ {
+ cnt++;
+ break;
+ }
+ }
+ if (cnt == 0)
+ break;
+ }
+ // check the number of shared nodes
+ if (cnt == f0->nods.size())
+ flag = true;
+
+ return flag; // true if f0 = f1 (ie, f0 and f1 share the same nodes)
+ }
+};
+
+} // namespace fpm
+#endif
+
+#endif //FEDGE_H
diff --git a/fpm/src/fField.cpp b/fpm/src/fField.cpp
new file mode 100644
index 0000000000000000000000000000000000000000..37f76c14f7c00553bb30e9df1bfbb06482f5ce37
--- /dev/null
+++ b/fpm/src/fField.cpp
@@ -0,0 +1,26 @@
+/*
+ * Copyright 2020 University of Liège
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "fField.h"
+#include "wTag.h"
+
+using namespace tbox;
+using namespace fpm;
+
+void Field::write(std::ostream &out) const
+{
+ out << "fpm::Field " << *tag << std::endl;
+}
diff --git a/fpm/src/fField.h b/fpm/src/fField.h
new file mode 100644
index 0000000000000000000000000000000000000000..6ef5bb8d99a16907ecf09a473d848a04d23348d1
--- /dev/null
+++ b/fpm/src/fField.h
@@ -0,0 +1,43 @@
+/*
+ * Copyright 2020 University of Liège
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef FFIELD_H
+#define FFIELD_H
+
+#include "fpm.h"
+#include "wGroup.h"
+
+namespace fpm
+{
+
+/**
+ * @brief Manage the fluid field
+ * @authors Adrien Crovato
+ */
+class FPM_API Field : public tbox::Group
+{
+public:
+ Field(std::shared_ptr<tbox::MshData> _msh, std::string const &name) : Group(_msh, name) {}
+ ~Field() { std::cout << "~Field()\n"; }
+
+#ifndef SWIG
+ virtual void write(std::ostream &out) const override;
+#endif
+};
+
+} // namespace fpm
+
+#endif //FFIELD_H
diff --git a/fpm/src/fProblem.cpp b/fpm/src/fProblem.cpp
new file mode 100644
index 0000000000000000000000000000000000000000..ef7843fcf82507b88da160f5a1342998b93a611f
--- /dev/null
+++ b/fpm/src/fProblem.cpp
@@ -0,0 +1,173 @@
+/*
+ * Copyright 2020 University of Liège
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "fProblem.h"
+#include "fField.h"
+#include "fBody.h"
+#include "wTag.h"
+#include "wElement.h"
+#include "wMem.h"
+#include "wCache.h"
+using namespace tbox;
+using namespace fpm;
+
+Problem::Problem(std::shared_ptr<MshData> _msh, double aoa, double aos, double mch,
+ double sref, double cref, double xref, double yref, double zref) : msh(_msh), alpha(aoa), beta(aos), mach(mch), sR(sref), cR(cref)
+{
+ xR(0) = xref;
+ xR(1) = yref;
+ xR(2) = zref;
+}
+
+/**
+ * @brief Set the fluid field
+ */
+void Problem::set(std::shared_ptr<Field> f)
+{
+ field = f;
+}
+/**
+ * @brief Add a non-lifting body
+ */
+void Problem::add(std::shared_ptr<Body> b)
+{
+ bodies.push_back(b);
+}
+
+/**
+ * @brief Compute velocity at element
+ */
+Eigen::Vector3d Problem::U(tbox::Element &e, std::vector<double> const &phi)
+{
+ Eigen::Vector3d v(0, 0, 0);
+ // @todo to be implemented if usefull
+ return v;
+ std::cout << std::endl;
+}
+
+/**
+ * @brief Compute density at element
+ */
+double Problem::Rho(tbox::Element &e, std::vector<double> const &phi)
+{
+ // particularized: pow(1 + 0.5 * (gamma - 1) * mInf * mInf * (1 - gradU2), 1 / (gamma - 1));
+ Eigen::Vector3d u = U(e, phi);
+ double a = 1 + 0.2 * mach * mach * (1 - u.dot(u));
+ return sqrt(a * a * a * a * a);
+}
+
+/**
+ * @brief Compute Mach number at element
+ */
+double Problem::Mach(tbox::Element &e, std::vector<double> const &phi)
+{
+ if (mach == 0)
+ return 0;
+ else
+ {
+ // particularized: pow(1 + 0.5 * (gamma - 1) * mInf * mInf * (1 - gradU2), 1 / (gamma - 1));
+ Eigen::Vector3d u = U(e, phi);
+ double a2 = 1 / (mach * mach) + 0.2 * (1 - u.dot(u)); // speed of sound squared
+ return u.norm() / sqrt(a2);
+ }
+}
+
+/**
+ * @brief Compute pressure coefficient at element
+ */
+double Problem::Cp(tbox::Element &e, std::vector<double> const &phi)
+{
+ Eigen::Vector3d u = U(e, phi);
+ if (mach == 0)
+ return 1 - u.dot(u);
+ else
+ {
+ //particularized: 2 / (gamma * mInf * mInf) * (pow(1 + 0.5 * (gamma - 1) * mInf * mInf * (1 - gradU2), gamma / (gamma - 1)) - 1);
+ double a = 1 + 0.2 * mach * mach * (1 - u.dot(u));
+ return 2 / (1.4 * mach * mach) * (sqrt(a * a * a * a * a * a * a) - 1);
+ }
+}
+
+/**
+ * @brief Update the elements memory (Jacobian)
+ */
+void Problem::updateMem()
+{
+ // Update volume Jacobian
+ if (field)
+ for (auto e : field->tag->elems)
+ e->getVMem().update(true);
+ // Update surface Jacobian
+ for (auto s : bodies)
+ for (auto e : s->tag->elems)
+ e->getVMem().update(false);
+}
+
+/**
+ * @brief Check that Problem is not empty and that elements are supported
+ */
+void Problem::check() const
+{
+ // Sanity checks
+ if (bodies.empty())
+ throw std::runtime_error("No lifting bodies provided!\n");
+ if (mach != 0 && !field)
+ {
+ std::stringstream err;
+ err << "Compressible computation requested for Mach "
+ << mach << ", but no field provided!\n";
+ throw std::runtime_error(err.str());
+ }
+ if (mach == 0 && field)
+ std::cout << "Incompressible computation requested, but a field was provided. This will result in unnecessary computations!\n"
+ << std::endl;
+
+ // Three-dimension problem
+ // Volume elements
+ if (field)
+ for (auto e : field->tag->elems)
+ if (e->type() != ELTYPE::HEX8)
+ {
+ std::stringstream err;
+ err << "FPM solver is only implemented for surface elements of type "
+ << ELTYPE::HEX8 << " (" << e->type() << " was given)!\n";
+ throw std::runtime_error(err.str());
+ }
+ // Surface elements
+ for (auto b : bodies)
+ for (auto e : b->tag->elems)
+ if (e->type() != ELTYPE::QUAD4)
+ {
+ std::stringstream err;
+ err << "FPM solver is only implemented for surface elements of type "
+ << ELTYPE::QUAD4 << " (" << e->type() << " was given)!\n";
+ throw std::runtime_error(err.str());
+ }
+}
+
+void Problem::write(std::ostream &out) const
+{
+ out << "fpm::Problem definition"
+ << "\n\tAngle of attack: " << alpha
+ << "\n\tAngle of sideslip: " << beta
+ << "\n\tReference area: " << sR
+ << "\n\tReference length: " << cR
+ << "\n\tReference point: [" << xR.transpose() << "]"
+ << std::endl;
+ out << "with";
+ for (auto b : bodies)
+ out << "\t" << *b;
+}
diff --git a/fpm/src/fProblem.h b/fpm/src/fProblem.h
new file mode 100644
index 0000000000000000000000000000000000000000..4bf8c33f16ec4457509bac8e2282d77d7684b16e
--- /dev/null
+++ b/fpm/src/fProblem.h
@@ -0,0 +1,74 @@
+/*
+ * Copyright 2020 University of Liège
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#ifndef FPROBLEM_H
+#define FPROBLEM_H
+
+#include "fpm.h"
+#include "wObject.h"
+#include <memory>
+#include <vector>
+#include <Eigen/Dense>
+
+namespace fpm
+{
+
+/**
+ * @brief Manage the problem
+ * @authors Adrien Crovato
+ * @todo check and implement velocity computation
+ */
+class FPM_API Problem : public fwk::wSharedObject
+{
+public:
+ std::shared_ptr<tbox::MshData> msh; ///< mesh data structure
+#ifndef SWIG
+ std::shared_ptr<Field> field; ///< fluid field
+ std::vector<std::shared_ptr<Body>> bodies; ///< bodies in fluid
+#endif
+ // Reference values
+ double alpha; ///< Angle of attack
+ double beta; ///< Angle of sideslip
+ double mach; ///< Mach number
+ double sR; ///< Reference surface
+ double cR; ///< Reference chord
+ Eigen::Vector3d xR; ///< Reference center point (for moment computation)
+
+ Problem(std::shared_ptr<tbox::MshData> _msh, double aoa, double aos, double mch, double sref, double cref, double xref, double yref, double zref);
+ ~Problem() { std::cout << "~Problem()\n"; }
+
+ void set(std::shared_ptr<Field> f);
+ void add(std::shared_ptr<Body> b);
+
+ // Functions
+ inline double PhiI(Eigen::Vector3d const &pos);
+ inline Eigen::Vector3d Ui();
+ Eigen::Vector3d U(tbox::Element &e, std::vector<double> const &phi);
+ double Rho(tbox::Element &e, std::vector<double> const &phi);
+ double Mach(tbox::Element &e, std::vector<double> const &phi);
+ double Cp(tbox::Element &e, std::vector<double> const &phi);
+
+#ifndef SWIG
+ void check() const;
+ void updateMem();
+ virtual void write(std::ostream &out) const override;
+#endif
+};
+
+#include "fProblem.inl"
+
+} // namespace fpm
+
+#endif //FPROBLEM_H
diff --git a/fpm/src/fProblem.inl b/fpm/src/fProblem.inl
new file mode 100644
index 0000000000000000000000000000000000000000..175e1a3d89ec95a0def6b9fba88769ec0cbe2f2c
--- /dev/null
+++ b/fpm/src/fProblem.inl
@@ -0,0 +1,31 @@
+/*
+ * Copyright 2020 University of Liège
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * @brief Compute freestream potential
+ */
+inline double Problem::PhiI(Eigen::Vector3d const &pos)
+{
+ return cos(alpha) * cos(beta) * pos(0) + sin(beta) * pos(1) + sin(alpha) * cos(beta) * pos(2);
+}
+
+/**
+ * @brief Compute freestream velocity
+ */
+inline Eigen::Vector3d Problem::Ui()
+{
+ return Eigen::Vector3d(cos(alpha) * cos(beta), sin(beta), sin(alpha) * cos(beta));
+}
diff --git a/fpm/src/fSolver.cpp b/fpm/src/fSolver.cpp
new file mode 100644
index 0000000000000000000000000000000000000000..51066d4588b354404c8e49094898f8e39a947b68
--- /dev/null
+++ b/fpm/src/fSolver.cpp
@@ -0,0 +1,231 @@
+/*
+ * Copyright 2020 University of Liège
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "fSolver.h"
+#include "fBuilder.h"
+#include "fProblem.h"
+#include "fBody.h"
+
+#include "wMshData.h"
+#include "wNode.h"
+#include "wElement.h"
+#include "wMem.h"
+#include "wTag.h"
+#include "wResults.h"
+#include "wMshExport.h"
+#include "wCache.h"
+
+using namespace tbox;
+using namespace fpm;
+
+#define ANSI_COLOR_YELLOW "\x1b[1;33m"
+#define ANSI_COLOR_RESET "\x1b[0m"
+
+/**
+ * @brief Initialize the solver and perform sanity checks
+ * @authors Adrien Crovato
+ */
+Solver::Solver(std::shared_ptr<Builder> _aic) : aic(_aic), Cl(0), Cd(0), Cs(0), Cm(0)
+{
+ // Say hi
+ std::cout << std::endl;
+ std::cout << "*******************************************************************************" << std::endl;
+ std::cout << "** \\_/ **" << std::endl;
+ std::cout << "** \\_______O(_)O_______/ **" << std::endl;
+ std::cout << "** **" << std::endl;
+ std::cout << "*******************************************************************************" << std::endl;
+ std::cout << "** Hi! My name is FPM v0.1-2007 **" << std::endl;
+ std::cout << "** Adrien Crovato & Romain Boman **" << std::endl;
+ std::cout << "** ULiege 2020-2021 **" << std::endl;
+ std::cout << "*******************************************************************************" << std::endl
+ << std::endl;
+
+ // Setup variables
+ phi.resize(aic->pbl->msh->nodes.size(), 0.);
+ vPhi.resize(aic->pbl->msh->nodes.size(), 0.);
+ U.resize(aic->pbl->msh->elems.size(), Eigen::Vector3d::Zero());
+ rho.resize(aic->pbl->msh->elems.size(), 0.);
+ M.resize(aic->pbl->msh->elems.size(), 0.);
+ Cp.resize(aic->pbl->msh->elems.size(), 0.);
+}
+
+/**
+ * @brief Solve the (full) potential equation
+ */
+void Solver::run()
+{
+ if (!aic->valid)
+ throw std::runtime_error("fpm::Solver:run() AIC matrices are not up-to-date!\n");
+
+ // @todo compute sigma from an interpolator and compute volume flow (interpolation should be performed only once BEFORE run)
+ std::cout << "Computing field sources... " << std::flush;
+ Eigen::VectorXd sigma(aic->nF);
+ if (aic->pbl->field)
+ sigma = Eigen::VectorXd::Zero(aic->nF);
+ Eigen::VectorXd uX = aic->Cx * sigma;
+ Eigen::VectorXd uY = aic->Cy * sigma;
+ Eigen::VectorXd uZ = aic->Cz * sigma;
+ std::cout << "done!" << std::endl;
+
+ std::cout << "Computing body sources... " << std::flush;
+ Eigen::VectorXd mu(aic->nP), tau(aic->nP);
+ int ig = 0;
+ for (auto body : aic->pbl->bodies)
+ for (int i = 0; i < body->tag->elems.size(); ++i, ++ig)
+ tau(ig) = (aic->pbl->Ui() + Eigen::Vector3d(uX(ig), uY(ig), uZ(ig))).dot(body->tag->elems[i]->normal());
+ std::cout << "done!" << std::endl;
+
+ std::cout << "Solving for body doublets... " << std::flush;
+ Eigen::PartialPivLU<Eigen::MatrixXd>(aic->A).solve(aic->B * tau);
+ std::cout << "done!" << std::endl;
+
+ std::cout << "Computing flow and loads on bodies... " << std::flush;
+ computeFlow(mu, tau, sigma);
+ computeLoad();
+ std::cout << "done!" << std::endl
+ << std::endl;
+}
+
+/**
+ * @brief Write the results
+ */
+void Solver::save(std::shared_ptr<MshExport> mshWriter, int n)
+{
+ // Write files
+ std::cout << "Saving files... " << std::endl;
+ // setup results
+ Results results;
+ results.scalars_at_nodes["phi"] = φ
+ results.scalars_at_nodes["varPhi"] = &vPhi;
+ results.vectors_at_elems["U"] = &U;
+ results.scalars_at_elems["rho"] = ρ
+ results.scalars_at_elems["Mach"] = &M;
+ results.scalars_at_elems["Cp"] = &Cp;
+ // save (mesh and boundary surface)
+ if (n > 0)
+ {
+ mshWriter->save(aic->pbl->msh->name + "_" + std::to_string(n), results);
+ for (auto body : aic->pbl->bodies)
+ body->save(body->tag->name + "_" + std::to_string(n));
+ }
+ else
+ {
+ mshWriter->save(aic->pbl->msh->name, results);
+ for (auto body : aic->pbl->bodies)
+ body->save(body->tag->name);
+ }
+}
+
+/**
+ * @brief Compute flow solution on bodies
+ */
+void Solver::computeFlow(const Eigen::VectorXd &mu, const Eigen::VectorXd &tau, const Eigen::VectorXd &sigma)
+{
+ // @todo should we
+ // - compute velocity from phi at nodes or mu at nodes? if mu, then store phi at elements only
+
+ // Compute phi at elements and transfer at nodes
+ Eigen::VectorXd phie = aic->A * mu + aic->B * tau + aic->C * sigma;
+ auto pbl = aic->pbl;
+ // reset all values
+ for (auto n : pbl->msh->nodes)
+ vPhi[n->no - 1] = 0;
+ int ig = 0;
+ for (auto body : pbl->bodies)
+ {
+ // associate the potential value to its element
+ std::map<Element *, double> mapPhi;
+ for (auto e : body->tag->elems)
+ {
+ mapPhi[e] = phie[ig];
+ ig++;
+ }
+ // average at nodes
+ for (auto n : body->nodes)
+ for (auto e : body->neMap.at(n))
+ vPhi[n->no - 1] += mapPhi.at(e) / body->neMap.at(n).size(); // maybe use area average?
+ }
+
+ // Compute surface flow
+ for (auto body : pbl->bodies)
+ {
+ for (auto n : body->nodes)
+ phi[n->no - 1] = pbl->PhiI(n->pos) + vPhi[n->row]; // total potential
+
+ for (auto e : body->tag->elems)
+ {
+ U[e->no - 1] = pbl->U(*e, phi); // velocity
+ rho[e->no - 1] = pbl->Rho(*e, phi); // density
+ M[e->no - 1] = pbl->Mach(*e, phi); // Mach number
+ Cp[e->no - 1] = pbl->Cp(*e, phi); // pressure coefficient
+ }
+ }
+}
+
+/**
+ * @brief Compute aerodynamic load coefficients on bodies
+ */
+void Solver::computeLoad()
+{
+ Cl = 0;
+ Cd = 0;
+ Cs = 0;
+ Cm = 0;
+ auto pbl = aic->pbl;
+ for (auto body : pbl->bodies)
+ {
+ // Compute normalized load (i.e. load / pressure)
+ for (size_t i = 0; i < body->nodes.size(); ++i)
+ {
+ body->cLoadX[i] = 0;
+ body->cLoadY[i] = 0;
+ body->cLoadZ[i] = 0;
+ for (auto e : body->neMap.at(body->nodes[i]))
+ {
+ Eigen::Vector3d cLoad = Cp[e->no - 1] * e->getVMem().getVol() * e->normal() / e->nodes.size();
+ body->cLoadX[i] += cLoad(0);
+ body->cLoadY[i] += cLoad(1);
+ body->cLoadZ[i] += cLoad(2);
+ }
+ }
+
+ // Compute aerodynamic load coefficients (i.e. Load / pressure / surface)
+ // compute coefficients along x and vertical (y in 2D, z in 3D) directions and pitching moment (along -z in 2D, y in 3D)
+ body->Cm = 0;
+ Eigen::Vector3d Cf(0, 0, 0);
+ for (auto e : body->tag->elems)
+ {
+ Eigen::Vector3d l = e->getVMem().getCg() - pbl->xR; // lever arm
+ Eigen::Vector3d cf = Cp[e->no - 1] * e->getVMem().getVol() * e->normal(); // force coefficient
+ Cf -= cf;
+ body->Cm -= (l(2) * cf(0) - l(0) * cf(2)) / (pbl->sR * pbl->cR); // moment is positive along y (3D) and negative along z (2D) => positive nose-up
+ }
+ // rotate to flow direction
+ body->Cd = (Cf(0) * cos(pbl->alpha) * cos(pbl->beta) + Cf(1) * sin(pbl->beta) + Cf(2) * sin(pbl->alpha) * cos(pbl->beta)) / pbl->sR;
+ body->Cs = (-Cf(0) * cos(pbl->alpha) * sin(pbl->beta) + Cf(1) * cos(pbl->beta) - Cf(2) * sin(pbl->alpha) * sin(pbl->beta)) / pbl->sR;
+ body->Cl = (-Cf(0) * sin(pbl->alpha) + Cf(2) * cos(pbl->alpha)) / pbl->sR;
+ // compute total
+ Cl += body->Cl;
+ Cd += body->Cd;
+ Cs += body->Cs;
+ Cm += body->Cm;
+ }
+}
+
+void Solver::write(std::ostream &out) const
+{
+ out << "fpm::Solver\nwith\t" << *aic;
+}
diff --git a/fpm/src/fSolver.h b/fpm/src/fSolver.h
new file mode 100644
index 0000000000000000000000000000000000000000..a7c90841450d68adcddef23a7e8b6d15267fbe0e
--- /dev/null
+++ b/fpm/src/fSolver.h
@@ -0,0 +1,69 @@
+/*
+ * Copyright 2020 University of Liège
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef FSOLVER_H
+#define FSOLVER_H
+
+#include "fpm.h"
+#include "wObject.h"
+
+#include <iostream>
+#include <vector>
+#include <memory>
+#include <Eigen/Dense>
+
+namespace fpm
+{
+
+/**
+ * @brief Field panel solver
+ * @authors Adrien Crovato
+ * @todo check and implement velocity computation
+ */
+class FPM_API Solver : public fwk::wSharedObject
+{
+public:
+ std::shared_ptr<Builder> aic; ///< AIC builder
+
+ std::vector<double> phi; ///< full potential
+ std::vector<double> vPhi; ///< perturbation potential
+ std::vector<Eigen::Vector3d> U; ///< velocity
+ std::vector<double> rho; ///< density
+ std::vector<double> M; ///< mach number
+ std::vector<double> Cp; ///< pressure coefficient
+ double Cl; ///< lift coefficient
+ double Cd; ///< drag coefficient
+ double Cs; ///< sideforce coefficient
+ double Cm; ///< pitch moment coefficient (positive nose-up)
+
+public:
+ Solver(std::shared_ptr<Builder> _aic);
+ ~Solver() { std::cout << "~Solver()\n"; }
+
+ void run();
+ void save(std::shared_ptr<tbox::MshExport> mshWriter, int n = 0);
+
+#ifndef SWIG
+ virtual void write(std::ostream &out) const override;
+#endif
+
+private:
+ void computeFlow(const Eigen::VectorXd &mu, const Eigen::VectorXd &tau, const Eigen::VectorXd &sigma);
+ void computeLoad();
+};
+
+} // namespace fpm
+#endif //FSOLVER_H
diff --git a/fpm/src/fTimers.cpp b/fpm/src/fTimers.cpp
new file mode 100644
index 0000000000000000000000000000000000000000..9a8f5f8ab6fd070f56c1650b8918d5db41eb8322
--- /dev/null
+++ b/fpm/src/fTimers.cpp
@@ -0,0 +1,97 @@
+/*
+ * Copyright 2020 University of Liège
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "fTimers.h"
+#include <iomanip>
+
+using namespace fpm;
+
+Timer::Timer() : isOn(false)
+{
+ reset();
+}
+
+/**
+ * @brief Reset the timer
+ */
+void Timer::reset()
+{
+ if (!isOn)
+ {
+ start();
+ stop();
+ }
+ else
+ throw std::runtime_error("Cannot reset a running timer!\n");
+}
+
+/**
+ * @brief Start the timer
+ */
+void Timer::start()
+{
+ if (!isOn)
+ {
+ tS = std::chrono::high_resolution_clock::now();
+ cS = std::clock();
+ isOn = true;
+ }
+ else
+ throw std::runtime_error("Cannot start a running timer!\n");
+}
+
+/**
+ * @brief Stop the timer
+ */
+void Timer::stop()
+{
+ if (isOn)
+ {
+ tE = std::chrono::high_resolution_clock::now();
+ cE = std::clock();
+ isOn = false;
+ }
+ else
+ throw std::runtime_error("Cannot stop a non-running timer!\n");
+}
+
+/**
+ * @brief Access/create a given timer
+ */
+Timer &Timers::operator[](std::string const &name)
+{
+ return timers[name];
+}
+
+/**
+ * @brief Print the times of all timers
+ */
+void Timers::write(std::ostream &out) const
+{
+ out << std::fixed << std::setprecision(1);
+ out << std::setw(20) << std::left << "Timer"
+ << std::setw(15) << std::right << "Wall-clock (s)"
+ << std::setw(15) << std::right << "CPU (s)"
+ << std::endl;
+
+ for (auto const &tm : timers)
+ {
+ out << std::setw(20) << std::left << tm.first
+ << std::setw(15) << std::right << tm.second.getWall()
+ << std::setw(15) << std::right << tm.second.getCpu()
+ << std::endl;
+ }
+}
diff --git a/fpm/src/fTimers.h b/fpm/src/fTimers.h
new file mode 100644
index 0000000000000000000000000000000000000000..e08840b545098430c1267a96b62bb6138474da09
--- /dev/null
+++ b/fpm/src/fTimers.h
@@ -0,0 +1,78 @@
+/*
+ * Copyright 2020 University of Liège
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef FTIMERS_H
+#define FTIMERS_H
+
+#include "fpm.h"
+#include "wObject.h"
+#include <map>
+#include <chrono>
+#include <ctime>
+#include <string>
+
+namespace fpm
+{
+
+/**
+ * @brief Basic and portable timer
+ * @author Adrien Crovato
+ * @todo use clock_gettime for POSIX (https://en.cppreference.com/w/cpp/chrono/c/clock)?
+ */
+class FPM_API Timer
+{
+private:
+ bool isOn; ///< status
+ std::chrono::high_resolution_clock::time_point tS; ///< start time (wall-clock)
+ std::chrono::high_resolution_clock::time_point tE; ///< stop time (wall-clock)
+ std::clock_t cS; ///< start time (cpu)
+ std::clock_t cE; ///< stop time (cpu)
+
+public:
+ Timer();
+ virtual ~Timer() {}
+
+ void reset();
+ void start();
+ void stop();
+ inline double getWall() const;
+ inline double getCpu() const;
+};
+
+#include "fTimers.inl"
+
+/**
+ * @brief Collection of timers
+ * @author Romain Boman, Adrien Crovato
+ */
+class FPM_API Timers : public fwk::wObject
+{
+private:
+ std::map<std::string, Timer> timers; ///< set of timers
+
+public:
+ Timers() : fwk::wObject() {}
+ virtual ~Timers() {}
+
+#ifndef SWIG
+ Timer &operator[](std::string const &name);
+ virtual void write(std::ostream &out) const override;
+#endif //SWIG
+};
+
+} // namespace fpm
+
+#endif //FTIMERS_H
diff --git a/fpm/src/fTimers.inl b/fpm/src/fTimers.inl
new file mode 100644
index 0000000000000000000000000000000000000000..1fae11257570f0b14a8b3c19f98949e1db67c36b
--- /dev/null
+++ b/fpm/src/fTimers.inl
@@ -0,0 +1,31 @@
+/*
+ * Copyright 2020 University of Liège
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * @brief Compute the wall-clock (ellasped) time from "start" to "stop"
+ */
+inline double Timer::getWall() const
+{
+ return std::chrono::duration<double>(tE - tS).count();
+}
+
+/**
+ * @brief Compute the cpu (user) time from "start" to "stop"
+ */
+inline double Timer::getCpu() const
+{
+ return (cE - cS) / (double)CLOCKS_PER_SEC;
+}
\ No newline at end of file
diff --git a/fpm/src/fWake.cpp b/fpm/src/fWake.cpp
new file mode 100644
index 0000000000000000000000000000000000000000..2b95ce7b29d5bdd313dadf01740813f522077b34
--- /dev/null
+++ b/fpm/src/fWake.cpp
@@ -0,0 +1,79 @@
+/*
+ * Copyright 2020 University of Liège
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "fWake.h"
+#include "fEdge.h"
+#include "wNode.h"
+#include "wElement.h"
+#include <vector>
+#include <unordered_set>
+using namespace tbox;
+using namespace fpm;
+
+Wake::Wake(std::shared_ptr<MshData> _msh, std::string const &name, Tag *const &wTag) : Group(_msh, name)
+{
+ // Create set of TE edges
+ std::unordered_set<Edge *, EquEdge, EquEdge> teEdges;
+ for (auto e : tag->elems)
+ {
+ Edge *ed = new Edge({e->nodes[0], e->nodes[3]});
+ ed->el0 = e;
+ teEdges.insert(ed);
+ }
+
+ // Find wing elements having an edge on the TE
+ for (auto e : wTag->elems)
+ {
+ size_t idx = 0;
+ for (size_t i = 0; i < e->nodes.size(); ++i)
+ {
+ // build wing edge
+ std::vector<Node *> eN(2);
+ for (size_t j = 0; j < 2; ++j)
+ eN[j] = e->nodes[(idx + j) % e->nodes.size()];
+ Edge ed(eN);
+ // check if wing edge is a TE edge
+ auto it = teEdges.find(&ed);
+ if (it != teEdges.end())
+ {
+ // check normal direction
+ if (e->normal().dot((*it)->el0->normal()) > 0)
+ (*it)->el1 = e;
+ else
+ (*it)->el2 = e;
+ }
+ idx++;
+ }
+ }
+
+ // Create a map between the wing and wake elements
+ for (auto ed : teEdges)
+ {
+ if (ed->el1 == NULL || ed->el2 == NULL)
+ {
+ std::stringstream err;
+ err << "fpm::Lifting: no wing element from tag " << *wTag << "could be associated to wake element " << *(ed->el0) << "!\n";
+ throw std::runtime_error(err.str());
+ }
+ wkMap[ed->el0] = std::pair<Element *, Element *>(ed->el1, ed->el2);
+ delete ed;
+ }
+}
+
+void Wake::write(std::ostream &out) const
+{
+ out << "fpm::Wake " << *tag << std::endl;
+}
diff --git a/fpm/src/fWake.h b/fpm/src/fWake.h
new file mode 100644
index 0000000000000000000000000000000000000000..6d725aca260793b44ef9449e450125f391072b62
--- /dev/null
+++ b/fpm/src/fWake.h
@@ -0,0 +1,47 @@
+/*
+ * Copyright 2020 University of Liège
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef FWAKE_H
+#define FWAKE_H
+
+#include "fpm.h"
+#include "wGroup.h"
+#include "wTag.h"
+#include <map>
+
+namespace fpm
+{
+
+/**
+ * @brief Manage the wake attached to a lifting body
+ * @authors Adrien Crovato
+ */
+class FPM_API Wake : public tbox::Group
+{
+public:
+ std::map<tbox::Element *, std::pair<tbox::Element *, tbox::Element *>> wkMap; ///< wing-wake map
+
+ Wake(std::shared_ptr<tbox::MshData> _msh, std::string const &name, tbox::Tag *const &wTag);
+ ~Wake() {}
+
+#ifndef SWIG
+ virtual void write(std::ostream &out) const override;
+#endif
+};
+
+} // namespace fpm
+
+#endif //FWAKE_H
diff --git a/fpm/src/fpm.h b/fpm/src/fpm.h
new file mode 100644
index 0000000000000000000000000000000000000000..676bbd8ed209d11f4c9c44c34d6a32571e924f10
--- /dev/null
+++ b/fpm/src/fpm.h
@@ -0,0 +1,57 @@
+/*
+ * Copyright 2020 University of Liège
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// fpm global header
+
+#ifndef FPM_H
+#define FPM_H
+
+#if defined(WIN32)
+#ifdef fpm_EXPORTS
+#define FPM_API __declspec(dllexport)
+#else
+#define FPM_API __declspec(dllimport)
+#endif
+#else
+#define FPM_API
+#endif
+
+#include "tbox.h"
+
+namespace fpm
+{
+
+// utilities
+class Timer;
+class Timers;
+
+// problem definition
+class Problem;
+class Field;
+class Body;
+class Wake;
+
+// solver
+class Builder;
+class Solver;
+
+// misc
+class Edge;
+class EquEdge;
+
+} // namespace fpm
+
+#endif //FPM_H
diff --git a/fpm/tests/n12.py b/fpm/tests/n12.py
new file mode 100644
index 0000000000000000000000000000000000000000..663229ff5856bd0559a2b0ec899987939c67f465
--- /dev/null
+++ b/fpm/tests/n12.py
@@ -0,0 +1,45 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+# Copyright 2020 University of Liège
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Naca 0012 wing
+# Adrien Crovato
+
+from fwk.testing import *
+
+def main():
+ p = {}
+ # geometry parameters
+ p['pars'] = {'wSpn' : 5, 'wNc' : 80, 'wNs' : 10}
+ p['spn'] = 5
+ # flow parameters
+ p['aoa'] = 0
+ p['aos'] = 0
+ p['mach'] = 0
+ # run
+ import fpm.models.n0012 as n12
+ n12.main(p)
+ # test
+ print(ccolors.ANSI_BLUE + 'PyTesting...' + ccolors.ANSI_RESET)
+ tests = CTests()
+ tests.run()
+
+ # eof
+ print('')
+
+if __name__ == '__main__':
+ main()
+
diff --git a/fpm/tests/n12f.py b/fpm/tests/n12f.py
new file mode 100644
index 0000000000000000000000000000000000000000..edd633a49a2c1cb2d0cb92eb8544df45e4a99ff4
--- /dev/null
+++ b/fpm/tests/n12f.py
@@ -0,0 +1,45 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+# Copyright 2020 University of Liège
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Naca 0012 wing
+# Adrien Crovato
+
+from fwk.testing import *
+
+def main():
+ p = {}
+ # geometry parameters
+ p['pars'] = {'wSpn' : 5, 'wNc' : 80, 'wNs' : 10, 'fWdt' : 10, 'nX' : 10, 'nY' : 10, 'nZ' : 4}
+ p['spn'] = 5
+ # flow parameters
+ p['aoa'] = 0
+ p['aos'] = 0
+ p['mach'] = 0.8
+ # run
+ import fpm.models.n0012 as n12
+ n12.main(p, field=True)
+ # test
+ print(ccolors.ANSI_BLUE + 'PyTesting...' + ccolors.ANSI_RESET)
+ tests = CTests()
+ tests.run()
+
+ # eof
+ print('')
+
+if __name__ == '__main__':
+ main()
+
diff --git a/fpm/tests/n12t.py b/fpm/tests/n12t.py
new file mode 100644
index 0000000000000000000000000000000000000000..783473542549519c8f9f35a778528b94e3128cdb
--- /dev/null
+++ b/fpm/tests/n12t.py
@@ -0,0 +1,45 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+# Copyright 2020 University of Liège
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Naca 0012 wing
+# Adrien Crovato
+
+from fwk.testing import *
+
+def main():
+ p = {}
+ # geometry parameters
+ p['pars'] = {'wSpn' : 5, 'wNc' : 80, 'wNs' : 10, 'tSpn' : 3, 'tNc' : 40, 'tNs' : 5}
+ p['spn'] = 5
+ # flow parameters
+ p['aoa'] = 0
+ p['aos'] = 0
+ p['mach'] = 0
+ # run
+ import fpm.models.n0012 as n12
+ n12.main(p, tail=True)
+ # test
+ print(ccolors.ANSI_BLUE + 'PyTesting...' + ccolors.ANSI_RESET)
+ tests = CTests()
+ tests.run()
+
+ # eof
+ print('')
+
+if __name__ == '__main__':
+ main()
+
diff --git a/run_fpm.py b/run_fpm.py
new file mode 100755
index 0000000000000000000000000000000000000000..a63a0ecceddc9604c6a5e03e53a03a1ec11a1082
--- /dev/null
+++ b/run_fpm.py
@@ -0,0 +1,26 @@
+#!/usr/bin/env python
+# -*- coding: utf8 -*-
+# test encoding: à -é-è-ô-ï-€
+#
+# runs a test as if it was installed
+# - fixes the python path in a dev environment
+# - creates a workspace folder
+
+if __name__ == "__main__":
+ import sys
+ import os
+
+ thisdir = os.path.split(os.path.abspath(__file__))[0]
+
+ # look for fwk
+ fwkdir = os.path.abspath(os.path.join(thisdir, '..', 'waves'))
+ if not os.path.isdir(fwkdir):
+ raise Exception(
+ "'waves' not found - clone it next to fpm (from https://gitlab.uliege.be/am-dept/waves)")
+ sys.path.append(fwkdir)
+
+ # adds "." to the pythonpath (after waves so that waves is found first)
+ sys.path.append(thisdir)
+
+ import run # maybe we should put the code of run in fwk....
+ run.main(thisdir)