[ { "path": ".clang-format", "content": "BasedOnStyle: \"LLVM\"\n\nBreakBeforeBraces: Linux\nStandard: Cpp11\nColumnLimit: 80\n\nMaxEmptyLinesToKeep: 2\n\nNamespaceIndentation: All\n\nAlignAfterOpenBracket: true\nAlwaysBreakTemplateDeclarations: true\nBinPackArguments: false\nBinPackParameters: false\nPointerAlignment: Right\nAllowShortFunctionsOnASingleLine: Empty\n\nBreakConstructorInitializersBeforeComma: true\n" }, { "path": ".clang-tidy", "content": "Checks: >\n -*,\n cppcoreguidelines-pro-type-static-cast-downcast,\n google-readability-casting,\n modernize-*,\n -modernize-concat-nested-namespaces,\n -modernize-pass-by-value,\n -modernize-use-nodiscard,\n -modernize-use-trailing-return-type,\n mpi-*,\n performance-*,\n -performance-inefficient-string-concatenation,\n -performance-no-automatic-move,\n -performance-avoid-endl\n" }, { "path": ".clangd", "content": "# Work around our crazy compilation setup:\nCompileFlags:\n Add: [\n -I../source/euler,\n -DRYUJIN_VERSION=\"\",\n -DRYUJIN_GIT_REVISION=\"\"\n -DRYUJIN_GIT_SHORTREV=\"\"\n ]\n" }, { "path": ".gitattributes", "content": ".gitattributes export-ignore\n.gitignore export-ignore\n.gitmodules export-ignore\n" }, { "path": ".github/dependabot.yml", "content": "# Set update schedule for GitHub Actions\n\nversion: 2\nupdates:\n\n - package-ecosystem: \"github-actions\"\n directory: \"/\"\n schedule:\n # Check for updates to GitHub Actions every week\n interval: \"weekly\"\n" }, { "path": ".github/workflows/indent.yml", "content": "name: indentation\n\non: [push, pull_request]\n\nconcurrency:\n group: ${ {github.event_name }}-${{ github.workflow }}-${{ github.ref }}\n cancel-in-progress: ${{github.event_name == 'pull_request'}}\n\npermissions:\n contents: read\n\njobs:\n\n ################\n # clang-format #\n ################\n\n clang-format:\n name: clang-format\n runs-on: ubuntu-latest\n\n steps:\n - uses: actions/checkout@v3\n with:\n submodules: 'true'\n - name: clang-format\n uses: DoozyX/clang-format-lint-action@v0.16.2\n with:\n source: 'source tests'\n clangFormatVersion: 16.0.3\n" }, { "path": ".github/workflows/test.yml", "content": "name: verification\n\non:\n push:\n pull_request:\n types:\n - opened\n - reopened\n - synchronize\n - ready_for_review\n\nconcurrency:\n group: ${ {github.event_name }}-${{ github.workflow }}-${{ github.ref }}\n cancel-in-progress: ${{github.event_name == 'pull_request'}}\n\npermissions:\n contents: read\n\njobs:\n\n #############################################\n # ubuntu-lts-24.04 with gcc, deal.II master #\n #############################################\n\n ubuntu-lts-2404-dealii-master-release:\n name: tests-release-deal.II-master\n runs-on: [ubuntu-24.04]\n\n container:\n options: --user root\n image: dealii/dealii:master-noble\n\n steps:\n - uses: actions/checkout@v3\n with:\n submodules: 'true'\n - name: info\n run: |\n g++ -v\n cmake --version\n - name: configure release\n run: |\n mkdir build-release\n cd build-release\n cmake -DWITH_OPENMP=on ..\n - name: build release\n run: |\n cd build-release\n make VERBOSE=1 -j2\n - name: test release\n run: |\n export OMPI_ALLOW_RUN_AS_ROOT=1\n export OMPI_ALLOW_RUN_AS_ROOT_CONFIRM=1\n cd build-release\n # skip a number of expensive verification tests:\n ctest --output-on-failure -j2 -VV -E \\\n \"(verification-isentropic_vortex.*l7|verification-becker_solution.*l7)\"\n\n #############################################\n # ubuntu-lts-24.04 with gcc, deal.II master #\n #############################################\n\n ubuntu-lts-2404-dealii-master-debug:\n name: tests-debug-deal.II-master\n runs-on: [ubuntu-24.04]\n\n container:\n options: --user root\n image: dealii/dealii:master-noble\n\n steps:\n - uses: actions/checkout@v3\n with:\n submodules: 'true'\n - name: info\n run: |\n g++ -v\n cmake --version\n - name: configure debug\n run: |\n mkdir build-debug\n cd build-debug\n cmake -DWITH_OPENMP=on -DCMAKE_BUILD_TYPE=Debug -DCMAKE_CXX_FLAGS_DEBUG=\"-O2\" ..\n - name: build debug\n run: |\n cd build-debug\n make VERBOSE=1 -j2\n - name: test debug\n run: |\n export OMPI_ALLOW_RUN_AS_ROOT=1\n export OMPI_ALLOW_RUN_AS_ROOT_CONFIRM=1\n cd build-debug\n # skip a number of expensive verification tests:\n ctest --output-on-failure -j2 -VV -E \\\n \"(verification-isentropic_vortex.*l7|verification-becker_solution.*l7)\"\n" }, { "path": ".gitignore", "content": "build*\n.cache\n" }, { "path": ".gitmodules", "content": "[submodule \"simd-math\"]\n\tpath = simd-math\n\turl = https://github.com/vectorclass/version2\n" }, { "path": ".mailmap", "content": "Martin Kronbichler \nMartin Kronbichler \nMatthias Maier \nIgnacio Tomas \nIgnacio Tomas \nIgnacio Tomas <47006763+nachosaurus@users.noreply.github.com>\nEric Tovar \nEric Tovar \nEric Tovar <36754207+ejtovar@users.noreply.github.com>\n" }, { "path": "CMakeLists.txt", "content": "##\n## SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception\n## Copyright (C) 2020 - 2024 by the ryujin authors\n##\n\n#\n# Sanity check:\n#\n\nget_filename_component(_source \"${CMAKE_SOURCE_DIR}\" REALPATH)\nget_filename_component(_build \"${CMAKE_BINARY_DIR}\" REALPATH)\nif(\"${_source}\" STREQUAL \"${_build}\")\n message(FATAL_ERROR\n \"\\nRefusing to configure the project in the source directory. This \"\n \"operation would globber important files. You need to configure in a \"\n \"separate build directory. It is easiest to simply invoke $ make, which \"\n \"will configure ryujin in the directory ./build.\\n\"\n \"You will need to clean up ./CMakeCache.txt and ./CMakeFiles by hand, \"\n \"or by running $ make cleanup_insource which will delete these files \"\n \"and directories for you\"\n )\nendif()\n\n#\n# Set up deal.II\n#\n\nset(RYUJIN_VERSION 2.1.1)\n\ncmake_minimum_required(VERSION 3.15)\nset(CMAKE_EXPORT_COMPILE_COMMANDS 1)\nlist(APPEND CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake)\n\nfind_package(deal.II 9.5 REQUIRED HINTS ${DEAL_II_DIR} $ENV{DEAL_II_DIR})\n\nset(CMAKE_BUILD_TYPE \"Release\" CACHE STRING\n \"Choose the type of build, options are: Debug, Release\"\n )\ndeal_ii_initialize_cached_variables()\ndeal_ii_query_git_information()\n\n# Work around a typo in the deal.II CMake configuration:\nif(EXISTS ${DEAL_II_GIT_CONFIG})\n include(${DEAL_II_GIT_CONFIG})\nelse()\n string(REPLACE\n \"Git.cmake\" \"ConfigGit.cmake\" DEAL_II_GIT_CONFIG \"${DEAL_II_GIT_CONFIG}\"\n )\n if(EXISTS ${DEAL_II_GIT_CONFIG})\n include(${DEAL_II_GIT_CONFIG})\n endif()\nendif()\n\nmessage(STATUS \" dealii: ${DEAL_II_GIT_REVISION}\")\nmessage(STATUS \" ryujin: ${GIT_REVISION}\")\n\nif(NOT DEAL_II_WITH_MPI OR NOT DEAL_II_WITH_P4EST)\n message(FATAL_ERROR\n \"Need a deal.II library with mpi and p4est support enabled.\"\n )\nendif()\n\nproject(ryujin CXX)\n\n#\n# Compile-time options:\n#\n\nset(NUMBER \"double\" CACHE STRING \"The principal floating point type\")\n\noption(DEBUG_EXPENSIVE_BOUNDS_CHECK \"Debug: enable debug code paths for additional limiter bounds checks\" OFF)\noption(DEBUG_OUTPUT \"Debug: enable detailed time-step output\" OFF)\noption(DEBUG_SANITIZER \"Debug: enable address and UBSAN sanitizers for DEBUG build\" OFF)\noption(DEBUG_SYMMETRY_CHECK \"Debug: enable debug code paths that verify d_ij, c_ij, m_ij for (anti)symmetry\" OFF)\noption(DEFAULT_ENABLE_EQUATIONS \"Default enable all available equations. This parameter only sets the default value of all EQUATION_* configuration options\" ON)\noption(DENORMALS_ARE_ZERO \"Set the \\\"denormals are zero\\\" and \\\"flush to zero\\\" bits in the MXCSR register\" ON)\n\noption(WITH_DEAL_II_THREADS \"Enable deal.II threading support\" OFF)\n\n#\n# External packages:\n#\n\noption(WITH_DOXYGEN \"Build documentation with doxygen\" OFF)\noption(WITH_LIKWID \"Compile and link against the likwid instrumentation library\" OFF)\n\nif(\"${WITH_OPENMP}\" STREQUAL \"\")\n find_package(OpenMP QUIET)\nendif()\noption(WITH_OPENMP \"Enable threading support via OpenMP\" ${OpenMP_FOUND})\n\nif(\"${WITH_EOSPAC}\" STREQUAL \"\")\n find_package(EOSPAC QUIET)\nendif()\noption(WITH_EOSPAC \"Add support for the EOSPAC suite\" ${EOSPAC_FOUND})\n\nif(\"${WITH_GDAL}\" STREQUAL \"\")\n find_package(GDAL QUIET)\nendif()\noption(WITH_GDAL \"Compile and link against the gdal library\" ${GDAL_FOUND})\n\n#\n# Set up compiler flags:\n#\n\n# We require at least C++20:\nset(CMAKE_CXX_STANDARD 20)\nset(CMAKE_CXX_STANDARD_REQUIRED ON)\nset(CMAKE_CXX_EXTENSIONS OFF)\n\nif(CMAKE_CXX_COMPILER_ID MATCHES \"GNU\")\n string(APPEND DEAL_II_CXX_FLAGS \" -fdiagnostics-color=always\")\n string(REPLACE \"-Qunused-arguments\" \"\" DEAL_II_CXX_FLAGS \"${DEAL_II_CXX_FLAGS}\")\n string(REPLACE \"-Qunused-arguments\" \"\" DEAL_II_WARNING_FLAGS \"${DEAL_II_WARNING_FLAGS}\")\n string(REPLACE \"-ffp-exception-behavior=strict\" \"\" DEAL_II_CXX_FLAGS_DEBUG \"${DEAL_II_CXX_FLAGS_DEBUG}\")\n string(APPEND DEAL_II_CXX_FLAGS \" -Wno-missing-braces -Wno-unknown-pragmas\")\n\n if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS 12.0)\n string(APPEND DEAL_II_CXX_FLAGS \" -Wno-overloaded-virtual\")\n endif()\n\n if(\"${NUMBER}\" STREQUAL \"float\")\n string(APPEND DEAL_II_CXX_FLAGS \" -Wno-float-conversion\")\n endif()\nendif()\n\nif(CMAKE_CXX_COMPILER_ID MATCHES \"Clang\")\n string(APPEND DEAL_II_CXX_FLAGS \" -Xclang -fcolor-diagnostics\")\n\n #\n # This is finally fixed in clang-16 (by updating the C++20 support to the\n # latest defect correction). For earlier versions, silence the warning.\n #\n if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS \"16.0.0\")\n string(APPEND DEAL_II_CXX_FLAGS \" -Wno-ambiguous-reversed-operator\")\n endif()\nendif()\n\nif(DEBUG_SANITIZER)\n string(APPEND DEAL_II_CXX_FLAGS_DEBUG\n \" -fsanitize=address,undefined,leak -fsanitize-address-use-after-return=always -fsanitize-address-use-after-scope\"\n )\n string(APPEND DEAL_II_LINKER_FLAGS_DEBUG\n \" -fsanitize=address,undefined,leak -fsanitize-address-use-after-return=always -fsanitize-address-use-after-scope\"\n )\nendif()\n\n# Respect user overrides performed via CMAKE_CXX_FLAGS/CMAKE_EXE_LINKER_FLAGS\nstring(APPEND DEAL_II_CXX_FLAGS \" $ENV{CXXFLAGS} ${CMAKE_CXX_FLAGS}\")\n\n#\n# Workaround: Remove any unwanted -std=c++17 flags that might be set in\n# DEAL_II_CXX_FLAGS. This is unfortunately the case for some deal.II\n# versions packaged in Debian and Ubuntu.\n#\nstring(REPLACE \"-std=c++17\" \"\" DEAL_II_CXX_FLAGS \"${DEAL_II_CXX_FLAGS}\")\n\nstring(APPEND DEAL_II_CXX_FLAGS_DEBUG \" ${CMAKE_CXX_FLAGS_DEBUG}\")\nstring(APPEND DEAL_II_CXX_FLAGS_RELEASE \" ${CMAKE_CXX_FLAGS_RELEASE}\")\nstring(APPEND DEAL_II_LINKER_FLAGS \" $ENV{LDFLAGS} ${CMAKE_EXE_LINKER_FLAGS}\")\nset(CMAKE_CXX_FLAGS \"\")\nset(CMAKE_CXX_FLAGS_RELEASE \"\")\nset(CMAKE_CXX_FLAGS_DEBUG \"\")\nset(CMAKE_EXE_LINKER_FLAGS \"\")\n\n#\n# Feature configuration:\n#\n\nset(EXTERNAL_TARGETS)\n\nif(WITH_EOSPAC)\n find_package(EOSPAC REQUIRED)\n list(APPEND EXTERNAL_TARGETS \"Eospac::Eospac6\")\nendif()\n\nif(WITH_GDAL)\n find_package(GDAL REQUIRED)\n list(APPEND EXTERNAL_TARGETS \"GDAL::GDAL\")\nendif()\n\nif(WITH_LIKWID)\n find_package(LIKWID REQUIRED)\n list(APPEND EXTERNAL_TARGETS \"Likwid::Likwid\")\nendif()\n\nif(WITH_OPENMP)\n find_package(OpenMP REQUIRED)\n list(APPEND EXTERNAL_TARGETS \"OpenMP::OpenMP_CXX\")\nendif()\n\n#\n# Set up the rest:\n#\n\ninclude(GNUInstallDirs)\n\nadd_subdirectory(source)\n\ninstall(FILES COPYING.md README.md\n DESTINATION ${CMAKE_INSTALL_DOCDIR}\n )\n\nfile(MAKE_DIRECTORY \"${CMAKE_BINARY_DIR}/run/\")\nfile(CREATE_LINK \"${CMAKE_SOURCE_DIR}/prm\" \"${CMAKE_BINARY_DIR}/run/prm\" SYMBOLIC)\ninstall(DIRECTORY prm DESTINATION ${CMAKE_INSTALL_DOCDIR})\n\nenable_testing()\nadd_subdirectory(tests)\n\nIF(WITH_DOXYGEN)\n add_subdirectory(doc)\nENDIF()\n" }, { "path": "CONTRIBUTING.md", "content": "Contributing to ryujin\n======================\n\nAs a contributor to this project, you agree that all of your contributions\nbe governed by the\n[Developer Certificate of Origin version 1.1](https://developercertificate.org/),\nsee [COPYING.md](COPYING.md) for details.\n" }, { "path": "COPYING.md", "content": "ryujin copyright and license\n============================\n\nThis project is licensed under the the terms of the\n[Apache License 2.0](https://spdx.org/licenses/Apache-2.0.html) with\n[LLVM Exception](https://spdx.org/licenses/LLVM-exception.html).\n\nAs a contributor to this project, you agree that all of your contributions\nbe governed by the\n[Developer Certificate of Origin version 1.1](https://developercertificate.org/).\n\n\nThird party software\n--------------------\n\nThis program depends on and interfaces with the [deal.II finite element\nlibrary](https://dealii.org) which is dual licensed under the terms of the\nApache License 2.0 with LLVM Exception and the\n[GNU Lesser General Public License version 2.1 or later](https://spdx.org/licenses/LGPL-2.1-or-later.html).\n\nThe git submodule `simd-math/` contains the\n[vector class SIMD library](https://github.com/vectorclass/version2), which\nis third party software licensed under the terms of the Apache License 2.0\nand copyrighted by Agner Fog and collaborators.\n\n\nLogo\n----\n\nThe logo `doc/logo.png` shows a cropped portion of the painting \"The\nDragon\" by [Kunisada II Utagawa](https://en.wikipedia.org/wiki/Utagawa_Kunisada_II)\nwhich is in the public domain. The Wikimedia entry can be found\n[here](https://commons.wikimedia.org/wiki/File:Kunisada_II_The_Dragon.jpg).\n\n\nContact\n-------\n\nFor questions regarding licensing and commercial use please contact\nMatthias Maier .\n\n\nFull license texts\n==================\n\nThe open source license that applies to a source file is annotated in the\nheader with an [SPDX identifier](https://spdx.dev/ids/). In addition, part\nof the source code (identified in the copyright header) is subject to a\nLANL Copyright Statement outlined below.\n\n\n[Developer Certificate of Origin version 1.1](https://developercertificate.org/)\n--------------------------------------------------------------------------------\n\n```\nDeveloper Certificate of Origin\nVersion 1.1\n\nCopyright (C) 2004, 2006 The Linux Foundation and its contributors.\n1 Letterman Drive\nSuite D4700\nSan Francisco, CA, 94129\n\nEveryone is permitted to copy and distribute verbatim copies of this\nlicense document, but changing it is not allowed.\n\n\nDeveloper's Certificate of Origin 1.1\n\nBy making a contribution to this project, I certify that:\n\n(a) The contribution was created in whole or in part by me and I\n have the right to submit it under the open source license\n indicated in the file; or\n\n(b) The contribution is based upon previous work that, to the best\n of my knowledge, is covered under an appropriate open source\n license and I have the right under that license to submit that\n work with modifications, whether created in whole or in part\n by me, under the same open source license (unless I am\n permitted to submit under a different license), as indicated\n in the file; or\n\n(c) The contribution was provided directly to me by some other\n person who certified (a), (b) or (c) and I have not modified\n it.\n\n(d) I understand and agree that this project and the contribution\n are public and that a record of the contribution (including all\n personal information I submit with it, including my sign-off) is\n maintained indefinitely and may be redistributed consistent with\n this project or the open source license(s) involved.\n```\n\n\n[Apache License 2.0](https://spdx.org/licenses/Apache-2.0.html)\n---------------------------------------------------------------\n\n```\n Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\nTERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\nEND OF TERMS AND CONDITIONS\n\nAPPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\nCopyright [yyyy] [name of copyright owner]\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n```\n\n\n[LLVM Exception](https://spdx.org/licenses/LLVM-exception.html)\n---------------------------------------------------------------\n\n```\nAs an exception, if, as a result of your compiling your source code, portions\nof this Software are embedded into an Object form of such source code, you\nmay redistribute such embedded portions in such Object form without complying\nwith the conditions of Sections 4(a), 4(b) and 4(d) of the License.\n\nIn addition, if you combine or link compiled forms of this Software with\nsoftware that is licensed under the GPLv2 (\"Combined Software\") and if a\ncourt of competent jurisdiction determines that the patent provision (Section\n3), the indemnity provision (Section 9) or other Section of the License\nconflicts with the conditions of the GPLv2, you may retroactively and\nprospectively choose to deem waived or otherwise exclude such Section(s) of\nthe License, but only in their entirety and only with respect to the Combined\nSoftware.\n```\n\n\nLANL Copyright Statement\n------------------------\n\nThe following statement applies to a number of contributed source code\nfiles under `./source` which are identified by the string\n`[LANL Copyright Statement]` in the copyright header:\n```\nCopyright (c) 2023 - 2024 by Triad National Security, LLC\n\nAll rights reserved.\n\nThis program was produced under U.S. Government contract 89233218CNA000001\nfor Los Alamos National Laboratory (LANL), which is operated by Triad\nNational Security, LLC for the U.S. Department of Energy/National Nuclear\nSecurity Administration. All rights in the program are reserved by Triad\nNational Security, LLC, and the U.S. Department of Energy/National Nuclear\nSecurity Administration. The Government is granted for itself and others\nacting on its behalf a nonexclusive, paid-up, irrevocable worldwide license\nin this material to reproduce, prepare derivative works, distribute copies\nto the public, perform publicly and display publicly, and to permit others\nto do so.\n\nThis program is Open-Source under the Apache 2.0 License.\n```\n" }, { "path": "INSTALLATION.md", "content": "Installation instructions\n=========================\n\nNecessary tools and library dependencies\n----------------------------------------\n\nryujin requires [deal.II](https://dealii.org) version 9.4.0 or newer\ncompiled with support enabled for MPI and P4est.\n\nOn Debian and Ubuntu you can conveniently install all necessary libraries\nand tools with `apt`.\n - On Debian you can run the following command (as root user) to\n install deal.II, all development libraries and necessary tools:\n ```\n apt install libdeal.ii-dev cmake cmake-curses-gui numdiff make g++ ninja-build git\n ```\n - On Ubuntu LTS 24.04 you can run the following command to install\n deal.II, all development libraries and necessary tools:\n ```\n sudo apt install libdeal.ii-dev cmake cmake-curses-gui numdiff make g++ ninja-build git\n ```\n - On Ubuntu LTS 22.04 you can install the current deal.II version\n from a PPA\n ```\n sudo add-apt-repository ppa:ginggs/deal.ii-9.5.1-backports\n sudo apt update\n sudo apt install libdeal.ii-dev cmake cmake-curses-gui numdiff make g++ ninja-build git\n ```\n\nIf you are on a MAC it might be easiest to simply install our precompiled\nMAC bundle for deal.II which you can find on the [Github download\npage](https://github.com/dealii/dealii/releases/tag/v9.5.2).\n\nIf you are on Windows we strongly recommend to set up the [Windows\nSubsystem for Linux v2\n(WSL)](https://learn.microsoft.com/en-us/windows/wsl/about) and install\nUbuntu LTS 24.04 from the Microsoft store. Then, simply launch the\nUbuntu App which starts a Bash shell. You can then proceed with the\ninstallation instructions for Ubuntu LTS 24.04 summarized above. You can\nfind a helpful tutorial on how to use the linux command line\n[here](https://ubuntu.com/tutorials/command-line-for-beginners#1-overview).\n\nGeneric installation instructions how to download, install, or manually\ncompile deal.II can be found on the\n[deal.II homepage](https://dealii.org/download.html) and on the\n[deal.II wiki](https://github.com/dealii/dealii/wiki).\nMake sure that deal.II is configured with MPI and P4est support and that\nthe following additional tools are in your `PATH`: git, numdiff, cmake,\nmake.\n\n\nRetrieving and compiling ryujin\n-------------------------------\n\nAt this point you should have deal.II and all necessary command line tools\ninstalled. You then simply check out the ryujin repository and run `make`\nto compile ryujin:\n```\ngit clone https://github.com/conservation-laws/ryujin\ncd ryujin\ngit submodule init\ngit submodule update\nmake release\n```\n\nNote that ryujin uses the [CMake](https://cmake.org/) build system. The\n`Makefile` found in the repository only contains a number of convenience\ntargets and its use is entirely optional. If invoked it will create a\nsubdirectory `build`, run cmake to configure the project, and make to build\nit. The executable will be located in build/run. The\nconvenience Makefile contains the following additional targets:\n - `make debug`: switch to debug build and compile program\n - `make release`: switch to release build and compile program\n - `make edit_cache`: runs ccmake in the build directory\n" }, { "path": "Makefile", "content": "##\n## SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception\n## Copyright (C) 2020 - 2023 by the ryujin authors\n##\n\nSHELL:=bash\ndefault: all\n\n.PHONY: default\n\nSOURCEDIR:=$(shell dirname $(abspath $(lastword $(MAKEFILE_LIST))))\nBUILDDIR:=build\n\nifeq (, $(shell which ninja))\n GENERATOR:=\"Unix Makefiles\"\n MAKE_COMMAND:=make\n MAKE_FILE:=Makefile\nelse\n GENERATOR:=Ninja\n MAKE_COMMAND:=ninja\n MAKE_FILE:=build.ninja\nendif\n\n##########################################################################\n\ncleanup_insource:\n\t@rm -f $(SOURCEDIR)/CMakeCache.txt\n\t@rm -rf $(SOURCEDIR)/CMakeFiles\n\nrebuild_cache:\n\t@mkdir -p $(BUILDDIR)\n\t@cd $(BUILDDIR) && cmake -G$(GENERATOR) $(SOURCEDIR)\n\nedit_cache:\n\t@mkdir -p $(BUILDDIR)\n\t@cd $(BUILDDIR) && ccmake -G$(GENERATOR) $(SOURCEDIR)\n\n$(BUILDDIR)/$(MAKE_FILE):\n\t@mkdir -p $(BUILDDIR)\n\t@cd $(BUILDDIR) && cmake -G$(GENERATOR) $(SOURCEDIR)\n\ndebug:\n\t@mkdir -p $(BUILDDIR)\n\t@cd $(BUILDDIR) && cmake -DCMAKE_BUILD_TYPE=Debug -G$(GENERATOR) $(SOURCEDIR)\n\t@cd $(BUILDDIR) && $(MAKE_COMMAND)\n\nrelease:\n\t@mkdir -p $(BUILDDIR)\n\t@cd $(BUILDDIR) && cmake -DCMAKE_BUILD_TYPE=Release -G$(GENERATOR) $(SOURCEDIR)\n\t@cd $(BUILDDIR) && $(MAKE_COMMAND)\n\nMakefile:\n\t\n\n%: cleanup_insource $(BUILDDIR)/$(MAKE_FILE)\n\t@cd $(BUILDDIR) && $(MAKE_COMMAND) $@\n\n.PHONY: cleanup_insource rebuild_cache edit_cache debug release\n\n##########################################################################\n\nindent:\n\t@clang-format -i source/*.h source/*.cc source/**/*.h source/**/*.cc tests/**/*.cc\n\n.PHONY: indent\n\n##########################################################################\n" }, { "path": "README.md", "content": "\n\nryujin\n======\n\nRyujin is a high-performance high-order collocation-type finite-element\nsolver for conservation equations such as the compressible Navier-Stokes\nand Euler equations of gas dynamics. The solver is based on the [convex\nlimiting technique](https://doi.org/10.1137/17M1149961) to ensure\n[invariant domain preservation](https://doi.org/10.1137/16M1074291) and\nuses the finite element library [deal.II](https://github.com/dealii/dealii)\n([website](https://www.dealii.org)) and the [vector class SIMD\nlibrary](https://github.com/vectorclass/version2). As such the solver\nmaintains important physical invariants and is guaranteed to be stable\nwithout the use of ad-hoc tuning parameters.\n\nRyujin is freely available under the terms of the\n[Apache License 2.0](https://spdx.org/licenses/Apache-2.0.html)\nwith [LLVM Exception](https://spdx.org/licenses/LLVM-exception.html).\nPart of the contributed source code, third-party dependencies and header\nlibraries are covered by different open source licenses. For details\nconsult [COPYING.md](COPYING.md). Contributions to the ryujin source code\nare governed by the [Developer Certificate of Origin version\n1.1](https://developercertificate.org/); see\n[CONTRIBUTING.md](CONTRIBUTING.md) for details.\n\n\nModules\n-------\n\nRyujin features the following equation modules selectable by the following\nparameter flags:\n - `equation = euler`, an optimized solver module for the\n [compressible Euler\n equations](https://en.wikipedia.org/wiki/Euler_equations_(fluid_dynamics))\n with polytropic equation of state.\n - `equation = euler barotropic`, an optimized solver module for the\n [compressible Euler\n equations](https://en.wikipedia.org/wiki/Euler_equations_(fluid_dynamics))\n with a barotropic equation of state, such as the isentropic or\n isothermal equation of state.\n - `equation = euler aeos`, a generalized solver module for the\n compressible Euler equation with an [arbitrary or tabulated equation of\n state](https://en.wikipedia.org/wiki/Equation_of_state).\n - `equation = navier stokes`, an optimized solver module for the\n [compressible Navier-Stokes\n equations](https://en.wikipedia.org/wiki/Navier%E2%80%93Stokes_equations)\n with polytropic equation of state,\n Newtonian fluid model, and Fourier's law for the heat flux.\n - `equation = euler poisson`, an optimized solver module for a charged\n (single species) fluid goverened by the compressible Euler with\n polytropic gas equation of state, and subject to an electrostatic force\n model with background magnetic field.\n - `equation = euler poisson barotropic`, an optimized solver module for a charged\n (single species) fluid goverened by the compressible Euler\n equations](https://en.wikipedia.org/wiki/Euler_equations_(fluid_dynamics))\n with a barotropic equation of state, and subject to an electrostatic\n force model with background magnetic field.\n - `equation = euler poisson aeos`, an generalized solver module for a charged\n (single species) fluid goverened by the compressible Euler equation with\n an arbitrary or tabulated equation of state, and subject to an\n electrostatic force model with background magnetic field.\n - `equation = shallow water`, a module for the [shallow water\n equations](https://en.wikipedia.org/wiki/Shallow_water_equations).\n - `equation = scalar conservation`, a module for scalar conservation\n equations with user-supplied flux. The module features a greedy\n wave-speed estimate to maintain an invariant domain, a generic indicator\n based on the entropy-viscosity commutator technique with a general,\n entropy-like function, and a customizable convex limiter.\n\nResources\n---------\n\n - [Website](https://conservation-laws.org/)\n - [Installation instructions](./INSTALLATION.md)\n - [Usage instructions](./USAGE.md)\n - [Doxygen documentation](https://conservation-laws.org/ryujin/doxygen)\n\nVideos\n------\n\nA number of simulation results can be found on [this youtube\nchannel](https://www.youtube.com/@matthiasmaier8956).\n\n[](https://www.youtube.com/watch?v=ig7R3yA7CtE)\n[](https://www.youtube.com/watch?v=yM2rT3teakE)\n[](https://www.youtube.com/watch?v=xIwJZlsXpZ4)\n[](https://www.youtube.com/watch?v=pPP26zelb0M)\n[](https://www.youtube.com/watch?v=vBCRAF_c8m8)\n[](https://www.youtube.com/watch?v=xecIZylotSE)\n\nThere original videos are available\n[here](https://tamiko.43-1.org/developer/) ([license\ndetails](https://tamiko.43-1.org/developer/COPYING.txt)).\n\nReferences\n----------\n\nIf you use this software for an academic publication please consider citing\nsome of the following references:\n\n```\n@article{ryujin-2021-1,\n author = {Matthias Maier and Martin Kronbichler},\n title = {Efficient parallel 3D computation of the compressible Euler equations with an invariant-domain preserving second-order finite-element scheme},\n doi = {10.1145/3470637},\n url = {https://arxiv.org/abs/2007.00094},\n journal = {ACM Transactions on Parallel Computing},\n year = {2021},\n volume = {8},\n number = {3},\n pages = {16:1-30}\n}\n\n@article{ryujin-2021-2,\n author = {Jean-Luc Guermond and Matthias Maier and Bojan Popov and Ignacio Tomas},\n title = {Second-order invariant domain preserving approximation of the compressible Navier--Stokes equations},\n doi = {10.1016/j.cma.2020.113608},\n url = {https://arxiv.org/abs/2009.06022},\n journal = {Computer Methods in Applied Mechanics and Engineering},\n year = {2021},\n volume = {375},\n number = {1},\n pages = {113608}\n}\n\n@article{ryujin-2021-3,\n author = {Jean-Luc~Guermond and Martin Kronbichler and Matthias Maier and Bojan Popov and Ignacio Tomas},\n title = {On the implementation of a robust and efficient finite element-based parallel solver for the compressible Navier-stokes equations},\n url = {https://arxiv.org/abs/2106.02159},\n journal = {Computer Methods in Applied Mechanics and Engineering},\n year = {2022},\n volume = {389},\n pages = {114250}\n}\n\n@article{ryujin-2023-4,\n author = {Bennett Clayton and Jean-Luc Guermond and Matthias Maier and Bojan Popov and Tovar, Eric J.},\n title = {Robust second-order approximation of the compressible Euler equations with an arbitrary equation of state},\n url = {http://arxiv.org/abs/2207.12832},\n journal = {Journal of Computational Physics},\n pages = {111926},\n year = {2023}\n}\n\n@article{ryujin-2024-5,\n author = {Jean-Luc Guermond and Matthias Maier and Bojan Popov and Laura Saavedra and Ignacio Tomas},\n title = {First-Order Greedy Invariant-Domain Preserving Approximation for Hyperbolic Problems: Scalar Conservation Laws, and p-System},\n url = {https://arxiv.org/abs/2310.01713},\n journal = {Journal of Scientific Computing},\n year = {2024},\n volume = {100},\n number = {46},\n pages = {},\n}\n\n@article{ryujin-2025-6,\n author = {Jean-Luc Guermond and Matthias Maier and Tovar, Eric J.},\n title = {A high-order explicit Runge-Kutta approximation technique for the shallow water equations},\n url = {https://arxiv.org/abs/2403.17123},\n journal = {Computers \\& Fluids},\n year = {2025},\n volume = {288},\n pages = {106493},\n}\n\n@article{ryujin-2025-7,\n author = {Martin Kronbichler and Matthias Maier and Ignacio Tomas},\n title = {Graph-based methods for hyperbolic systems of conservation laws using discontinuous space discretizations},\n url = {https://arxiv.org/abs/2402.04514},\n journal = {Communications in Computational Physics},\n year = {2025},\n volume = {38},\n pages = {74--108}\n}\n\n@article{ryujin-2025-8,\n author = {Jake Harmon and Martin Kronbichler and Matthias Maier and Eric Tovar},\n title = {A conservative invariant-domain preserving projection technique for hyperbolic systems under adaptive mesh refinement},\n url = {https://arxiv.org/abs/2507.18717},\n year = {2025},\n journal = {submitted}\n}\n\n@article{ryujin-2025-9,\n author = {Jordan Hoffart and Matthias Maier and John Shadid and Ignacio Tomas},\n title = {Structure-preserving finite-element approximations of the magnetic Euler-Poisson equations},\n url = {https://arxiv.org/abs/2510.11808},\n year = {2025},\n journal = {submitted}\n}\n```\n\nContact\n-------\n\nFor questions either open an\n[issue](https://github.com/conservation-laws/ryujin/issues), or contact\nMatthias Maier (maier@tamu.edu).\n\nDevelopers\n----------\n\n - Martin Kronbichler ([@kronbichler](https://github.com/kronbichler)), Ruhr University Bochum, Germany\n - Matthias Maier ([@tamiko](https://github.com/tamiko)), Texas A&M University, TX, USA\n - Ignacio Tomas ([@nachosaurus](https://github.com/nachosaurus)), Texas Tech University, TX, USA\n - Eric Tovar ([@ejtovar](https://github.com/ejtovar)), Xcimer Energy Corporation, USA\n\nContributors\n------------\n\n - Wolfgang Bangerth [@bangerth](https://github.com/bangerth), Colorado State University\n - Taylor Boylan ([@tmboylan](https://github.com/tmboylan)),\n - Jerett Cherry ([@jerret-cc](https://github.com/jerett-cc)), Colorado State University\n - Gregory Christian ([@gregorychristian](https://github.com/gregorychristian), Imperial College London, UK\n - Bennett Clayton ([@bgclayto](https://github.com/bgclayto))\n - Seth Gerberding ([@Gerbeset](https://github.com/Gerbeset)), Texas A&M University, TX, USA\n - Jake Harmon ([@harmonj](https://github.com/harmonj)), Los Alamos National Laboratory, USA\n - Jordan Hoffart ([@jordanhoffart](https://github.com/jordanhoffart)), Texas A&M University, TX, USA\n - David Pecoraro ([@ChrisPec27](https://github.com/ChrisPec27)), Texas A&M University, TX, USA\n - Madison Sheridan ([@Helblindi](https://github.com/Helblindi)), Texas A&M University, TX, USA\n" }, { "path": "USAGE.md", "content": "Usage Usage instructions\n========================\n\nConvenience Makefile\n--------------------\n\nThe `Makefile` found in the repository only contains a number of\nconvenience targets and its use is entirely optional. It will create a\nsubdirectory `build` and run cmake to configure the project. The executable\nwill be located in `build/run`. The convenience Makefile contains the\nfollowing additional targets:\n - `make debug`: switch to debug build and compile program\n - `make release`: switch to release build and compile program\n - `make edit_cache`: runs ccmake in the build directory\n\nExecutable and runtime parameter files\n--------------------------------------\n\nAfter compiling ryujin you should end up with an executable located in the\nbuild directory at `build/run/ryujin`. The executable takes a parameter\nfile location as single (optional) argument. If run without an argument it\nwill try to open a parameter file `ryujin.prm` in the working directory of\nthe executable (that is `build/run`):\n```\ncd build/run\n./ryujin # uses ryujin.prm\n./ryujin my_parameter_file.prm\n```\nYou can find a number of example parameter files in the `prm` subdirectory.\n\nSpecifically, the `prm/verification` subdirectory contains parameter files\nand baseline output vectors that document expected error and\nconvergence rates for various analytical solutions. All configurations\ncompare the simulation result at final time to a known analytic solution\nand record the normalized L1, L2, and L\\infty error norms (summed up over\nall components). All test configurations should be run with double floating\npoint precision.\n\nThe `prm/benchmarks` directory contains parameter files for well known and\npopular benchmark configurations. These configurations typically do\nnot have an analytical solution, but the expected solution structure is\nwell known. They are thus usually compared in the eyeball norm.\nFor example, to run the Mach 3 cylinder with 2.36M gridpoints on a machine\nwith 16 cores and two threads per core you could use:\n```\ncd build/run\nDEAL_II_NUM_THREADS=2 mpirun -np 16 ryujin prm/benchmarks/euler-mach3-cylinder-2d.prm\n```\nWarning: This is a rather large computation. For quick tests you might want\nto decrease the resolution by lowering the number set by `set mesh\nrefinement` in the prm file.\n\nYou can obtain a full list of supported runtime parameters and their\ndefault values by invoking the `./ryujin` executable without creating a\n`ryujin.prm` in the path:\n```\n% ./ryujin\n[INFO] initiating flux capacitor\n[INFO] Default parameter file »ryujin.prm« not found.\n[INFO] Creating template parameter files...\n% ls\n[...]\ndefault_parameters-euler-2d-description.prm\ndefault_parameters-navier_stokes-2d-description.prm\ndefault_parameters-shallow_water-2d-description.prm\ndefault_parameters-euler_aeos-2d-description.prm\ndefault_parameters-scalar_conservation-2d-description.prm\n```\nConsult the above parameter files with detailed annotated configuration\noptions (and their 1d and 3d counterparts) for details.\n\nOutput file format\n------------------\n\nryujin supports outputting temporal snapshots in `.vtu` format. (In\nprinciple you can modify ryujin to output any file format supported by\ndeal.II, have a look at `source/vtu_output.template.h`) You can use\nParaview to open and inspect `.vtu` files, which you can install via your\npackage manager or obtain [here](https://www.paraview.org/).\n\nryujin has some rudimentary support for outputting instantaneous, time\naveraged, or space integrated primitive values (and their second moments)\non user defined level sets.\n\nControlling parallelism and screen output\n-----------------------------------------\n\nryujin uses MPI and thread parallelization. You typically control the\ndegree of MPI parallelism by invoking ryujin with an MPI launcher program.\nThe number of threads created by each rank is controlled with the\n`DEAL_II_NUM_THREADS` environment variable. For example, you can run ryujin\non 8 ranks with 4 threads each as follows:\n```\nDEAL_II_NUM_THREADS=4 mpirun -np 8 ./ryujin\n```\n\n\nCompile time options\n--------------------\n\nryujin has a number of compile time options to fine tune certain behavior.\nYou can set and change compile time options by specifying them on the\ncommand line during configuration with `cmake`, or `ccmake`. You can invoke\n`ccmake` as follows:\n```\ncd build\nccmake .\n```\nYou can also invoke `ccmake` conveniently with the convenience `Makefile`\nfrom anywhere in the source directory by running\n```\nmake edit_cache\n```\n\nThe most important compile-time option is `CMAKE_BUILD_TYPE` that is used\nto switch between a debug build configuration (`Debug`) and a release build\nconfiguration (`Release`). This option can also be set quickly with the\nconvenience `Makefile` and typing `make debug`, or `make release` from the\ntop level directory of ryujin.\n\nChanging other compile-time options is rarely needed. And if in doubt they\nare best kept at their default values. For completeness we list all\nconfiguration options here:\n - `CMAKE_BUILD_TYPE`: build ryujin in \"Release\" or \"Debug\" mode\n - `NUMBER`: select \"double\" for double precision or \"float\" for single precision (defaults to double)\n - `ASYNC_MPI_EXCHANGE`: enable asynchronous \"communication hiding\" MPI exchange (defaults to OFF)\n - `DEBUG_EXPENSIVE_BOUNDS_CHECK`: enable debug code paths for additional limiter bounds checks (defaults to OFF)\n - `DEBUG_OUTPUT`: enable debug output (defaults to OFF)\n - `DEBUG_SANITIZER`: enable address and UBSAN sanitizers for DEBUG build (defaults to OFF)\n - `DEBUG_SYMMETRY_CHECK`: Debug: enable debug code paths that verify d_ij, c_ij, m_ij for (anti)symmetry (defaults to OFF)\n - `DENORMALS_ARE_ZERO`: disable floating point denormals (defaults to ON)\n - `WITH_DOXYGEN`: enable support for doxygen and build documentation\n - `WITH_EOSPAC`: enable support for the EOSPAC6/Sesame tabulated equation of state database (autodetection)\n - `WITH_LIKWID`: enable support for Likwid stetoscope mode (library for Intel performance counters, defaults to OFF)\n - `WITH_OPENMP`: enable support for multithreading via OpenMP (autodetection)\n" }, { "path": "cmake/FindEOSPAC.cmake", "content": "##\n## SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception\n## Copyright (C) 2023 by the ryujin authors\n##\n\n\n# FIXME: this should be made much more robust. But *meh*\n\nset(EOSPAC_LIBRARY \"\")\nforeach(_prefix ${CMAKE_PREFIX_PATH})\n file(GLOB_RECURSE _candidates ${_prefix}/*/libeospac6.a)\n if(NOT \"${_candidates}\" STREQUAL \"\")\n list(GET _candidates 0 EOSPAC_LIBRARY)\n break()\n endif()\nendforeach()\nif(\"${EOSPAC_LIBRARY}\" STREQUAL \"\")\n set(EOSPAC_LIBRARY \"EOSPAC_LIBRARY-NOTFOUND\")\nendif()\n\nset(EOSPAC_INCLUDE_DIR \"\")\nforeach(_prefix ${CMAKE_PREFIX_PATH})\n file(GLOB_RECURSE _candidates ${_prefix}/*/eos_Interface.h)\n if(NOT \"${_candidates}\" STREQUAL \"\")\n list(GET _candidates 0 EOSPAC_INCLUDE_DIR)\n get_filename_component(EOSPAC_INCLUDE_DIR \"${EOSPAC_INCLUDE_DIR}\" DIRECTORY)\n break()\n endif()\nendforeach()\nif(\"${EOSPAC_INCLUDE_DIR}\" STREQUAL \"\")\n set(EOSPAC_INCLUDE_DIR \"EOSPAC_INCLUDE_DIR-NOTFOUND\")\nendif()\n\nfind_package_handle_standard_args(EOSPAC DEFAULT_MSG\n EOSPAC_LIBRARY EOSPAC_INCLUDE_DIR\n )\n\nif(EOSPAC_FOUND AND NOT TARGET Eospac::Eospac6)\n add_library(Eospac::Eospac6 INTERFACE IMPORTED)\n target_link_libraries(Eospac::Eospac6 INTERFACE ${EOSPAC_LIBRARY})\n target_include_directories(Eospac::Eospac6 SYSTEM INTERFACE ${EOSPAC_INCLUDE_DIR})\nendif()\n" }, { "path": "cmake/FindLIKWID.cmake", "content": "##\n## SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception\n## Copyright (C) 2023 by the ryujin authors\n##\n\nfind_path(LIKWID_INCLUDE_DIR likwid.h\n PATH_SUFFIXES include\n )\n\nfind_library(LIKWID_LIBRARY\n NAMES likwid\n PATH_SUFFIXES lib${LIB_SUFFIX} lib64 lib\n )\n\nfind_library(LIKWID_HWLOC_LIBRARY\n NAMES likwid-hwloc\n PATH_SUFFIXES lib${LIB_SUFFIX} lib64 lib\n )\n\nfind_library(LIKWID_LUA_LIBRARY\n NAMES likwid-lua\n PATH_SUFFIXES lib${LIB_SUFFIX} lib64 lib\n )\n\nfind_package_handle_standard_args(LIKWID DEFAULT_MSG\n LIKWID_LIBRARY LIKWID_INCLUDE_DIR\n )\n\nif(LIKWID_FOUND AND NOT TARGET Likdwid::Likwid)\n add_library(Likwid::Likwid INTERFACE IMPORTED)\n target_link_libraries(Likwid::Likwid INTERFACE ${LIKWID_LIBRARY})\n\n foreach(_lib LIKWID_HWLOC_LIBRARY LIKWID_LUA_LIBRARY)\n if(NOT \"${${_lib}}\" MATCHES \"-NOTFOUND\")\n target_link_libraries(Likwid::Likwid INTERFACE ${${_lib}})\n endif()\n endforeach()\n\n target_include_directories(Likwid::Likwid SYSTEM INTERFACE ${LIKWID_INCLUDE_DIR})\n target_compile_definitions(Likwid::Likwid INTERFACE \"LIKWID_PERFMON\")\nendif()\n" }, { "path": "doc/CMakeLists.txt", "content": "##\n## SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception\n## Copyright (C) 2020 - 2023 by the ryujin authors\n##\n\nfind_package(Doxygen REQUIRED)\n\nfind_path(MATHJAX_PATH MathJax.js PATHS\n ${MATHJAX_PATH} $ENV{MATHJAX_PATH}\n /usr/share/mathjax /usr/share/javascript/mathjax\n )\n\nif(MATHJAX_PATH MATCHES \"MATHJAX_PATH-NOTFOUND\")\n set(MATHJAX_PATH \"https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/\")\nendif()\n\nmessage(STATUS \"Using MathJax path: »${MATHJAX_PATH}«\")\n\nfile(GLOB_RECURSE DOXYGEN_INPUT\n ${CMAKE_SOURCE_DIR}/source/*.h\n ${CMAKE_SOURCE_DIR}/doc/headers/*.h\n )\nstring(REPLACE \";\" \" \" DOXYGEN_INPUT \"${DOXYGEN_INPUT}\")\n\nfile(GLOB_RECURSE DOXYGEN_DEPEND\n ${CMAKE_CURRENT_SOURCE_DIR}/options.dox.in\n ${CMAKE_SOURCE_DIR}/source/*.h\n ${CMAKE_SOURCE_DIR}/doc/headers/*.h\n )\n\nconfigure_file(\n ${CMAKE_CURRENT_SOURCE_DIR}/options.dox.in\n ${CMAKE_CURRENT_BINARY_DIR}/options.dox\n @ONLY\n )\n\nadd_custom_command(\n OUTPUT ${CMAKE_BINARY_DIR}/doxygen.log\n COMMAND ${DOXYGEN_EXECUTABLE}\n ${CMAKE_CURRENT_BINARY_DIR}/options.dox\n > ${CMAKE_BINARY_DIR}/doxygen.log 2>&1\n WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}\n DEPENDS\n ${DOXYGEN_DEPEND}\n COMMENT \"Generating documentation via doxygen.\"\n VERBATIM\n )\n\nadd_custom_target(doxygen ALL\n DEPENDS ${CMAKE_BINARY_DIR}/doxygen.log\n )\n\ninstall(DIRECTORY\n ${CMAKE_CURRENT_BINARY_DIR}/html\n DESTINATION ${CMAKE_INSTALL_DOCDIR}/html\n )\n" }, { "path": "doc/headers/main.h", "content": "/**\n * @mainpage\n *\n * This is the main starting page for the technical ryujin class and\n * function documentation. A full usage guide can be found at\n * https://conservation-laws.org\n *\n * The program is organized into the following modules:\n *\n * @dot\n digraph G\n{\n graph[rankdir=\"TB\",bgcolor=\"transparent\"];\n\n node [fontname=\"FreeSans\",fontsize=15,\n shape=record,height=0.2,width=0.4,\n color=\"black\", fillcolor=\"white\", style=\"filled\"];\n edge [color=\"black\", weight=10];\n\n simd [label=\"SIMD\", URL=\"\\ref SIMD\"];\n fe [label=\"Finite element formulation\", URL=\"\\ref FiniteElement\"];\n misc [label=\"Miscellaneous\", URL=\"\\ref Miscellaneous\"];\n mesh [label=\"Discretization\", URL=\"\\ref Mesh\"];\n hyperbolic [label=\"Hyperbolic Module\", URL=\"\\ref HyperbolicModule\"];\n parabolic [label=\"Parabolic Module\", URL=\"\\ref ParabolicModule\"];\n loop [label=\"Time Integration and Postprocessing\", URL=\"\\ref TimeLoop\"];\n\n formulation [label=\"PDE formulation\", URL=\"\\ref Description\"];\n\n euler [label=\"Euler Equations\", URL=\"\\ref EulerEquations\"];\n shallow [label=\"Shallow Water Equations\", URL=\"\\ref ShallowWaterEquations\"];\n navier [label=\"Navier Stokes Equations\", URL=\"\\ref NavierStokesEquations\"];\n\n fe -> mesh [color=\"black\",style=\"solid\"];\n simd -> hyperbolic [color=\"black\",style=\"solid\"];\n fe -> hyperbolic [color=\"black\",style=\"solid\"];\n misc -> hyperbolic [color=\"black\",style=\"solid\"];\n mesh -> hyperbolic [color=\"black\",style=\"solid\"];\n simd -> parabolic [color=\"black\",style=\"solid\"];\n fe -> parabolic [color=\"black\",style=\"solid\"];\n misc -> parabolic [color=\"black\",style=\"solid\"];\n mesh -> parabolic [color=\"black\",style=\"solid\"];\n misc -> loop [color=\"black\",style=\"solid\"];\n hyperbolic -> loop [color=\"black\",style=\"solid\"];\n parabolic -> loop [color=\"black\",style=\"solid\"];\n euler -> formulation [color=\"blak\",style=\"solid\"];\n shallow -> formulation [color=\"black\",style=\"solid\"];\n navier -> formulation [color=\"black\",style=\"solid\"];\n formulation -> hyperbolic [color=\"black\",style=\"solid\"];\n formulation -> parabolic [color=\"black\",style=\"solid\"];\n}\n * @enddot\n *\n * ryujin is based on discretization approaches and algorithms that have\n * been developed in a number of publications\n * \\cite GuermondPopov2016\n * \\cite GuermondPopov2016b\n * \\cite GuermondEtAl2018\n * \\cite GuermondEtAl2018SW\n * \\cite ryujin-2021-1\n * \\cite ryujin-2021-2\n * \\cite ryujin-2021-3\n * \\cite ClaytonGuermondPopov-2022\n * \\cite ryujin-2023-4.\n * A complete list of references can be found in the \\ref citelist.\n */\n" }, { "path": "doc/headers/modules.h", "content": "/**\n * @defgroup Mesh Mesh generation and discretization\n *\n * Several classes and helper functions for creating meshes for a number of\n * benchmark configurations and controlling the finite element\n * discretization.\n */\n\n\n/**\n * @defgroup FiniteElement Finite element formulation\n *\n * Some helper functions for local index handling, dof renumbering,\n * sparsity pattern creation and matrix assembly.\n */\n\n\n/**\n * @defgroup Miscellaneous Miscellaneous\n *\n * Miscellaneous helper functions, macros and classes.\n */\n\n\n/**\n * @defgroup SIMD SIMD\n *\n * SIMD related functions and classes.\n */\n\n\n/**\n * @defgroup HyperbolicModule Hyperbolic Module\n *\n * This module contains classes and functions used during different stages\n * of the explicit hyperbolic update performed in HyperbolicModule::step().\n */\n\n\n/**\n * @defgroup ParabolicModule Parabolic Module\n *\n * This module contains classes and functions used during different stages\n * of the implicit parabolic update performed in ParabolicModule::step().\n */\n\n\n/**\n * @defgroup TimeLoop Time Integration and Postprocessing\n *\n * This module contains classes and functions used for timestepping and\n * running the program.\n */\n\n\n/**\n * @defgroup EulerEquations The Compressible Euler Equations\n *\n * This module contains classes and functions related to solving the\n * compressible Euler equations of gas dynamics.\n */\n\n\n/**\n * @defgroup NavierStokesEquations The Compressible Navier Stokes Equations\n *\n * This module contains classes and functions related to solving the\n * compressible Navier Stokes equations.\n */\n\n\n/**\n * @defgroup ScalarConservationEquations The Scalar Conservation Equations\n *\n * This module contains classes and functions related to solving various\n * scalar conservation equations.\n */\n\n\n/**\n * @defgroup ShallowWaterEquations The Shallow Water Equations\n *\n * This module contains classes and functions related to solving the\n * shallow water equations.\n */\n\n\n/**\n * @defgroup SkeletonEquations Minimal equation interface\n *\n * This module contains the minimal necessary interface for defining a\n * hyperbolic system.\n */\n" }, { "path": "doc/options.dox.in", "content": "# Doxyfile 1.9.7\n\n# This file describes the settings to be used by the documentation system\n# doxygen (www.doxygen.org) for a project.\n#\n# All text after a double hash (##) is considered a comment and is placed in\n# front of the TAG it is preceding.\n#\n# All text after a single hash (#) is considered a comment and will be ignored.\n# The format is:\n# TAG = value [value, ...]\n# For lists, items can also be appended using:\n# TAG += value [value, ...]\n# Values that contain spaces should be placed between quotes (\\\" \\\").\n#\n# Note:\n#\n# Use doxygen to compare the used configuration file with the template\n# configuration file:\n# doxygen -x [configFile]\n# Use doxygen to compare the used configuration file with the template\n# configuration file without replacing the environment variables or CMake type\n# replacement variables:\n# doxygen -x_noenv [configFile]\n\n#---------------------------------------------------------------------------\n# Project related configuration options\n#---------------------------------------------------------------------------\n\n# This tag specifies the encoding used for all characters in the configuration\n# file that follow. The default is UTF-8 which is also the encoding used for all\n# text before the first occurrence of this tag. Doxygen uses libiconv (or the\n# iconv built into libc) for the transcoding. See\n# https://www.gnu.org/software/libiconv/ for the list of possible encodings.\n# The default value is: UTF-8.\n\nDOXYFILE_ENCODING = UTF-8\n\n# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by\n# double-quotes, unless you are using Doxywizard) that should identify the\n# project for which the documentation is generated. This name is used in the\n# title of most generated pages and in a few other places.\n# The default value is: My Project.\n\nPROJECT_NAME = ryujin\n\n# The PROJECT_NUMBER tag can be used to enter a project or revision number. This\n# could be handy for archiving the generated documentation or if some version\n# control system is used.\n\nPROJECT_NUMBER = \"@RYUJIN_VERSION@ revision @GIT_REVISION@\"\n\n# Using the PROJECT_BRIEF tag one can provide an optional one line description\n# for a project that appears at the top of each page and should give viewer a\n# quick idea about the purpose of the project. Keep the description short.\n\nPROJECT_BRIEF =\n\n# With the PROJECT_LOGO tag one can specify a logo or an icon that is included\n# in the documentation. The maximum height of the logo should not exceed 55\n# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy\n# the logo to the output directory.\n\nPROJECT_LOGO = @CMAKE_CURRENT_SOURCE_DIR@/logo.png\n\n# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path\n# into which the generated documentation will be written. If a relative path is\n# entered, it will be relative to the location where doxygen was started. If\n# left blank the current directory will be used.\n\nOUTPUT_DIRECTORY =\n\n# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096\n# sub-directories (in 2 levels) under the output directory of each output format\n# and will distribute the generated files over these directories. Enabling this\n# option can be useful when feeding doxygen a huge amount of source files, where\n# putting all generated files in the same directory would otherwise causes\n# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to\n# control the number of sub-directories.\n# The default value is: NO.\n\nCREATE_SUBDIRS = NO\n\n# Controls the number of sub-directories that will be created when\n# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every\n# level increment doubles the number of directories, resulting in 4096\n# directories at level 8 which is the default and also the maximum value. The\n# sub-directories are organized in 2 levels, the first level always has a fixed\n# number of 16 directories.\n# Minimum value: 0, maximum value: 8, default value: 8.\n# This tag requires that the tag CREATE_SUBDIRS is set to YES.\n\nCREATE_SUBDIRS_LEVEL = 8\n\n# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII\n# characters to appear in the names of generated files. If set to NO, non-ASCII\n# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode\n# U+3044.\n# The default value is: NO.\n\nALLOW_UNICODE_NAMES = NO\n\n# The OUTPUT_LANGUAGE tag is used to specify the language in which all\n# documentation generated by doxygen is written. Doxygen will use this\n# information to generate all constant output in the proper language.\n# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian,\n# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English\n# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek,\n# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with\n# English messages), Korean, Korean-en (Korean with English messages), Latvian,\n# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese,\n# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish,\n# Swedish, Turkish, Ukrainian and Vietnamese.\n# The default value is: English.\n\nOUTPUT_LANGUAGE = English\n\n# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member\n# descriptions after the members that are listed in the file and class\n# documentation (similar to Javadoc). Set to NO to disable this.\n# The default value is: YES.\n\nBRIEF_MEMBER_DESC = YES\n\n# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief\n# description of a member or function before the detailed description\n#\n# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the\n# brief descriptions will be completely suppressed.\n# The default value is: YES.\n\nREPEAT_BRIEF = YES\n\n# This tag implements a quasi-intelligent brief description abbreviator that is\n# used to form the text in various listings. Each string in this list, if found\n# as the leading text of the brief description, will be stripped from the text\n# and the result, after processing the whole list, is used as the annotated\n# text. Otherwise, the brief description is used as-is. If left blank, the\n# following values are used ($name is automatically replaced with the name of\n# the entity):The $name class, The $name widget, The $name file, is, provides,\n# specifies, contains, represents, a, an and the.\n\nABBREVIATE_BRIEF = \"The $name class\" \\\n \"The $name widget\" \\\n \"The $name file\" \\\n is \\\n provides \\\n specifies \\\n contains \\\n represents \\\n a \\\n an \\\n the\n\n# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then\n# doxygen will generate a detailed section even if there is only a brief\n# description.\n# The default value is: NO.\n\nALWAYS_DETAILED_SEC = NO\n\n# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all\n# inherited members of a class in the documentation of that class as if those\n# members were ordinary class members. Constructors, destructors and assignment\n# operators of the base classes will not be shown.\n# The default value is: NO.\n\nINLINE_INHERITED_MEMB = NO\n\n# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path\n# before files name in the file list and in the header files. If set to NO the\n# shortest path that makes the file name unique will be used\n# The default value is: YES.\n\nFULL_PATH_NAMES = YES\n\n# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.\n# Stripping is only done if one of the specified strings matches the left-hand\n# part of the path. The tag can be used to show relative paths in the file list.\n# If left blank the directory from which doxygen is run is used as the path to\n# strip.\n#\n# Note that you can specify absolute paths here, but also relative paths, which\n# will be relative from the directory where doxygen is started.\n# This tag requires that the tag FULL_PATH_NAMES is set to YES.\n\nSTRIP_FROM_PATH = @CMAKE_SOURCE_DIR@ \\\n @CMAKE_BINARY_DIR@\n\n# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the\n# path mentioned in the documentation of a class, which tells the reader which\n# header file to include in order to use a class. If left blank only the name of\n# the header file containing the class definition is used. Otherwise one should\n# specify the list of include paths that are normally passed to the compiler\n# using the -I flag.\n\nSTRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@ \\\n @CMAKE_BINARY_DIR@\n\n# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but\n# less readable) file names. This can be useful is your file systems doesn't\n# support long names like on DOS, Mac, or CD-ROM.\n# The default value is: NO.\n\nSHORT_NAMES = NO\n\n# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the\n# first line (until the first dot) of a Javadoc-style comment as the brief\n# description. If set to NO, the Javadoc-style will behave just like regular Qt-\n# style comments (thus requiring an explicit @brief command for a brief\n# description.)\n# The default value is: NO.\n\nJAVADOC_AUTOBRIEF = NO\n\n# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line\n# such as\n# /***************\n# as being the beginning of a Javadoc-style comment \"banner\". If set to NO, the\n# Javadoc-style will behave just like regular comments and it will not be\n# interpreted by doxygen.\n# The default value is: NO.\n\nJAVADOC_BANNER = NO\n\n# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first\n# line (until the first dot) of a Qt-style comment as the brief description. If\n# set to NO, the Qt-style will behave just like regular Qt-style comments (thus\n# requiring an explicit \\brief command for a brief description.)\n# The default value is: NO.\n\nQT_AUTOBRIEF = NO\n\n# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a\n# multi-line C++ special comment block (i.e. a block of //! or /// comments) as\n# a brief description. This used to be the default behavior. The new default is\n# to treat a multi-line C++ comment block as a detailed description. Set this\n# tag to YES if you prefer the old behavior instead.\n#\n# Note that setting this tag to YES also means that rational rose comments are\n# not recognized any more.\n# The default value is: NO.\n\nMULTILINE_CPP_IS_BRIEF = NO\n\n# By default Python docstrings are displayed as preformatted text and doxygen's\n# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the\n# doxygen's special commands can be used and the contents of the docstring\n# documentation blocks is shown as doxygen documentation.\n# The default value is: YES.\n\nPYTHON_DOCSTRING = YES\n\n# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the\n# documentation from any documented member that it re-implements.\n# The default value is: YES.\n\nINHERIT_DOCS = YES\n\n# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new\n# page for each member. If set to NO, the documentation of a member will be part\n# of the file/class/namespace that contains it.\n# The default value is: NO.\n\nSEPARATE_MEMBER_PAGES = NO\n\n# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen\n# uses this value to replace tabs by spaces in code fragments.\n# Minimum value: 1, maximum value: 16, default value: 4.\n\nTAB_SIZE = 4\n\n# This tag can be used to specify a number of aliases that act as commands in\n# the documentation. An alias has the form:\n# name=value\n# For example adding\n# \"sideeffect=@par Side Effects:^^\"\n# will allow you to put the command \\sideeffect (or @sideeffect) in the\n# documentation, which will result in a user-defined paragraph with heading\n# \"Side Effects:\". Note that you cannot put \\n's in the value part of an alias\n# to insert newlines (in the resulting output). You can put ^^ in the value part\n# of an alias to insert a newline as if a physical newline was in the original\n# file. When you need a literal { or } or , in the value part of an alias you\n# have to escape them by means of a backslash (\\), this can lead to conflicts\n# with the commands \\{ and \\} for these it is advised to use the version @{ and\n# @} or use a double escape (\\\\{ and \\\\})\n\nALIASES =\n\n# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources\n# only. Doxygen will then generate output that is more tailored for C. For\n# instance, some of the names that are used will be different. The list of all\n# members will be omitted, etc.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_FOR_C = NO\n\n# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or\n# Python sources only. Doxygen will then generate output that is more tailored\n# for that language. For instance, namespaces will be presented as packages,\n# qualified scopes will look different, etc.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_JAVA = NO\n\n# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran\n# sources. Doxygen will then generate output that is tailored for Fortran.\n# The default value is: NO.\n\nOPTIMIZE_FOR_FORTRAN = NO\n\n# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL\n# sources. Doxygen will then generate output that is tailored for VHDL.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_VHDL = NO\n\n# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice\n# sources only. Doxygen will then generate output that is more tailored for that\n# language. For instance, namespaces will be presented as modules, types will be\n# separated into more groups, etc.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_SLICE = NO\n\n# Doxygen selects the parser to use depending on the extension of the files it\n# parses. With this tag you can assign which parser to use for a given\n# extension. Doxygen has a built-in mapping, but you can override or extend it\n# using this tag. The format is ext=language, where ext is a file extension, and\n# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,\n# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,\n# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:\n# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser\n# tries to guess whether the code is fixed or free formatted code, this is the\n# default for Fortran type files). For instance to make doxygen treat .inc files\n# as Fortran files (default is PHP), and .f files as C (default is Fortran),\n# use: inc=Fortran f=C.\n#\n# Note: For files without extension you can use no_extension as a placeholder.\n#\n# Note that for custom extensions you also need to set FILE_PATTERNS otherwise\n# the files are not read by doxygen. When specifying no_extension you should add\n# * to the FILE_PATTERNS.\n#\n# Note see also the list of default file extension mappings.\n\nEXTENSION_MAPPING =\n\n# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments\n# according to the Markdown format, which allows for more readable\n# documentation. See https://daringfireball.net/projects/markdown/ for details.\n# The output of markdown processing is further processed by doxygen, so you can\n# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in\n# case of backward compatibilities issues.\n# The default value is: YES.\n\nMARKDOWN_SUPPORT = YES\n\n# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up\n# to that level are automatically included in the table of contents, even if\n# they do not have an id attribute.\n# Note: This feature currently applies only to Markdown headings.\n# Minimum value: 0, maximum value: 99, default value: 5.\n# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.\n\nTOC_INCLUDE_HEADINGS = 5\n\n# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to\n# generate identifiers for the Markdown headings. Note: Every identifier is\n# unique.\n# Possible values are: DOXYGEN Use a fixed 'autotoc_md' string followed by a\n# sequence number starting at 0. and GITHUB Use the lower case version of title\n# with any whitespace replaced by '-' and punctations characters removed..\n# The default value is: DOXYGEN.\n# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.\n\nMARKDOWN_ID_STYLE = DOXYGEN\n\n# When enabled doxygen tries to link words that correspond to documented\n# classes, or namespaces to their corresponding documentation. Such a link can\n# be prevented in individual cases by putting a % sign in front of the word or\n# globally by setting AUTOLINK_SUPPORT to NO.\n# The default value is: YES.\n\nAUTOLINK_SUPPORT = YES\n\n# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want\n# to include (a tag file for) the STL sources as input, then you should set this\n# tag to YES in order to let doxygen match functions declarations and\n# definitions whose arguments contain STL classes (e.g. func(std::string);\n# versus func(std::string) {}). This also make the inheritance and collaboration\n# diagrams that involve STL classes more complete and accurate.\n# The default value is: NO.\n\nBUILTIN_STL_SUPPORT = YES\n\n# If you use Microsoft's C++/CLI language, you should set this option to YES to\n# enable parsing support.\n# The default value is: NO.\n\nCPP_CLI_SUPPORT = NO\n\n# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:\n# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen\n# will parse them like normal C++ but will assume all classes use public instead\n# of private inheritance when no explicit protection keyword is present.\n# The default value is: NO.\n\nSIP_SUPPORT = NO\n\n# For Microsoft's IDL there are propget and propput attributes to indicate\n# getter and setter methods for a property. Setting this option to YES will make\n# doxygen to replace the get and set methods by a property in the documentation.\n# This will only work if the methods are indeed getting or setting a simple\n# type. If this is not the case, or you want to show the methods anyway, you\n# should set this option to NO.\n# The default value is: YES.\n\nIDL_PROPERTY_SUPPORT = YES\n\n# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC\n# tag is set to YES then doxygen will reuse the documentation of the first\n# member in the group (if any) for the other members of the group. By default\n# all members of a group must be documented explicitly.\n# The default value is: NO.\n\nDISTRIBUTE_GROUP_DOC = NO\n\n# If one adds a struct or class to a group and this option is enabled, then also\n# any nested class or struct is added to the same group. By default this option\n# is disabled and one has to add nested compounds explicitly via \\ingroup.\n# The default value is: NO.\n\nGROUP_NESTED_COMPOUNDS = NO\n\n# Set the SUBGROUPING tag to YES to allow class member groups of the same type\n# (for instance a group of public functions) to be put as a subgroup of that\n# type (e.g. under the Public Functions section). Set it to NO to prevent\n# subgrouping. Alternatively, this can be done per class using the\n# \\nosubgrouping command.\n# The default value is: YES.\n\nSUBGROUPING = YES\n\n# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions\n# are shown inside the group in which they are included (e.g. using \\ingroup)\n# instead of on a separate page (for HTML and Man pages) or section (for LaTeX\n# and RTF).\n#\n# Note that this feature does not work in combination with\n# SEPARATE_MEMBER_PAGES.\n# The default value is: NO.\n\nINLINE_GROUPED_CLASSES = NO\n\n# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions\n# with only public data fields or simple typedef fields will be shown inline in\n# the documentation of the scope in which they are defined (i.e. file,\n# namespace, or group documentation), provided this scope is documented. If set\n# to NO, structs, classes, and unions are shown on a separate page (for HTML and\n# Man pages) or section (for LaTeX and RTF).\n# The default value is: NO.\n\nINLINE_SIMPLE_STRUCTS = NO\n\n# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or\n# enum is documented as struct, union, or enum with the name of the typedef. So\n# typedef struct TypeS {} TypeT, will appear in the documentation as a struct\n# with name TypeT. When disabled the typedef will appear as a member of a file,\n# namespace, or class. And the struct will be named TypeS. This can typically be\n# useful for C code in case the coding convention dictates that all compound\n# types are typedef'ed and only the typedef is referenced, never the tag name.\n# The default value is: NO.\n\nTYPEDEF_HIDES_STRUCT = NO\n\n# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This\n# cache is used to resolve symbols given their name and scope. Since this can be\n# an expensive process and often the same symbol appears multiple times in the\n# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small\n# doxygen will become slower. If the cache is too large, memory is wasted. The\n# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range\n# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536\n# symbols. At the end of a run doxygen will report the cache usage and suggest\n# the optimal cache size from a speed point of view.\n# Minimum value: 0, maximum value: 9, default value: 0.\n\nLOOKUP_CACHE_SIZE = 0\n\n# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use\n# during processing. When set to 0 doxygen will based this on the number of\n# cores available in the system. You can set it explicitly to a value larger\n# than 0 to get more control over the balance between CPU load and processing\n# speed. At this moment only the input processing can be done using multiple\n# threads. Since this is still an experimental feature the default is set to 1,\n# which effectively disables parallel processing. Please report any issues you\n# encounter. Generating dot graphs in parallel is controlled by the\n# DOT_NUM_THREADS setting.\n# Minimum value: 0, maximum value: 32, default value: 1.\n\nNUM_PROC_THREADS = 1\n\n# If the TIMESTAMP tag is set different from NO then each generated page will\n# contain the date or date and time when the page was generated. Setting this to\n# NO can help when comparing the output of multiple runs.\n# Possible values are: YES, NO, DATETIME and DATE.\n# The default value is: NO.\n\nTIMESTAMP = NO\n\n#---------------------------------------------------------------------------\n# Build related configuration options\n#---------------------------------------------------------------------------\n\n# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in\n# documentation are documented, even if no documentation was available. Private\n# class members and static file members will be hidden unless the\n# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.\n# Note: This will also disable the warnings about undocumented members that are\n# normally produced when WARNINGS is set to YES.\n# The default value is: NO.\n\nEXTRACT_ALL = YES\n\n# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will\n# be included in the documentation.\n# The default value is: NO.\n\nEXTRACT_PRIVATE = NO\n\n# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual\n# methods of a class will be included in the documentation.\n# The default value is: NO.\n\nEXTRACT_PRIV_VIRTUAL = NO\n\n# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal\n# scope will be included in the documentation.\n# The default value is: NO.\n\nEXTRACT_PACKAGE = NO\n\n# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be\n# included in the documentation.\n# The default value is: NO.\n\nEXTRACT_STATIC = YES\n\n# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined\n# locally in source files will be included in the documentation. If set to NO,\n# only classes defined in header files are included. Does not have any effect\n# for Java sources.\n# The default value is: YES.\n\nEXTRACT_LOCAL_CLASSES = YES\n\n# This flag is only useful for Objective-C code. If set to YES, local methods,\n# which are defined in the implementation section but not in the interface are\n# included in the documentation. If set to NO, only methods in the interface are\n# included.\n# The default value is: NO.\n\nEXTRACT_LOCAL_METHODS = NO\n\n# If this flag is set to YES, the members of anonymous namespaces will be\n# extracted and appear in the documentation as a namespace called\n# 'anonymous_namespace{file}', where file will be replaced with the base name of\n# the file that contains the anonymous namespace. By default anonymous namespace\n# are hidden.\n# The default value is: NO.\n\nEXTRACT_ANON_NSPACES = NO\n\n# If this flag is set to YES, the name of an unnamed parameter in a declaration\n# will be determined by the corresponding definition. By default unnamed\n# parameters remain unnamed in the output.\n# The default value is: YES.\n\nRESOLVE_UNNAMED_PARAMS = YES\n\n# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all\n# undocumented members inside documented classes or files. If set to NO these\n# members will be included in the various overviews, but no documentation\n# section is generated. This option has no effect if EXTRACT_ALL is enabled.\n# The default value is: NO.\n\nHIDE_UNDOC_MEMBERS = NO\n\n# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all\n# undocumented classes that are normally visible in the class hierarchy. If set\n# to NO, these classes will be included in the various overviews. This option\n# will also hide undocumented C++ concepts if enabled. This option has no effect\n# if EXTRACT_ALL is enabled.\n# The default value is: NO.\n\nHIDE_UNDOC_CLASSES = NO\n\n# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend\n# declarations. If set to NO, these declarations will be included in the\n# documentation.\n# The default value is: NO.\n\nHIDE_FRIEND_COMPOUNDS = NO\n\n# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any\n# documentation blocks found inside the body of a function. If set to NO, these\n# blocks will be appended to the function's detailed documentation block.\n# The default value is: NO.\n\nHIDE_IN_BODY_DOCS = NO\n\n# The INTERNAL_DOCS tag determines if documentation that is typed after a\n# \\internal command is included. If the tag is set to NO then the documentation\n# will be excluded. Set it to YES to include the internal documentation.\n# The default value is: NO.\n\nINTERNAL_DOCS = NO\n\n# With the correct setting of option CASE_SENSE_NAMES doxygen will better be\n# able to match the capabilities of the underlying filesystem. In case the\n# filesystem is case sensitive (i.e. it supports files in the same directory\n# whose names only differ in casing), the option must be set to YES to properly\n# deal with such files in case they appear in the input. For filesystems that\n# are not case sensitive the option should be set to NO to properly deal with\n# output files written for symbols that only differ in casing, such as for two\n# classes, one named CLASS and the other named Class, and to also support\n# references to files without having to specify the exact matching casing. On\n# Windows (including Cygwin) and MacOS, users should typically set this option\n# to NO, whereas on Linux or other Unix flavors it should typically be set to\n# YES.\n# Possible values are: SYSTEM, NO and YES.\n# The default value is: SYSTEM.\n\nCASE_SENSE_NAMES = YES\n\n# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with\n# their full class and namespace scopes in the documentation. If set to YES, the\n# scope will be hidden.\n# The default value is: NO.\n\nHIDE_SCOPE_NAMES = NO\n\n# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will\n# append additional text to a page's title, such as Class Reference. If set to\n# YES the compound reference will be hidden.\n# The default value is: NO.\n\nHIDE_COMPOUND_REFERENCE= NO\n\n# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class\n# will show which file needs to be included to use the class.\n# The default value is: YES.\n\nSHOW_HEADERFILE = YES\n\n# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of\n# the files that are included by a file in the documentation of that file.\n# The default value is: YES.\n\nSHOW_INCLUDE_FILES = YES\n\n# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each\n# grouped member an include statement to the documentation, telling the reader\n# which file to include in order to use the member.\n# The default value is: NO.\n\nSHOW_GROUPED_MEMB_INC = NO\n\n# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include\n# files with double quotes in the documentation rather than with sharp brackets.\n# The default value is: NO.\n\nFORCE_LOCAL_INCLUDES = NO\n\n# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the\n# documentation for inline members.\n# The default value is: YES.\n\nINLINE_INFO = YES\n\n# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the\n# (detailed) documentation of file and class members alphabetically by member\n# name. If set to NO, the members will appear in declaration order.\n# The default value is: YES.\n\nSORT_MEMBER_DOCS = NO\n\n# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief\n# descriptions of file, namespace and class members alphabetically by member\n# name. If set to NO, the members will appear in declaration order. Note that\n# this will also influence the order of the classes in the class list.\n# The default value is: NO.\n\nSORT_BRIEF_DOCS = NO\n\n# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the\n# (brief and detailed) documentation of class members so that constructors and\n# destructors are listed first. If set to NO the constructors will appear in the\n# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.\n# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief\n# member documentation.\n# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting\n# detailed member documentation.\n# The default value is: NO.\n\nSORT_MEMBERS_CTORS_1ST = NO\n\n# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy\n# of group names into alphabetical order. If set to NO the group names will\n# appear in their defined order.\n# The default value is: NO.\n\nSORT_GROUP_NAMES = NO\n\n# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by\n# fully-qualified names, including namespaces. If set to NO, the class list will\n# be sorted only by class name, not including the namespace part.\n# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.\n# Note: This option applies only to the class list, not to the alphabetical\n# list.\n# The default value is: NO.\n\nSORT_BY_SCOPE_NAME = NO\n\n# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper\n# type resolution of all parameters of a function it will reject a match between\n# the prototype and the implementation of a member function even if there is\n# only one candidate or it is obvious which candidate to choose by doing a\n# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still\n# accept a match between prototype and implementation in such cases.\n# The default value is: NO.\n\nSTRICT_PROTO_MATCHING = NO\n\n# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo\n# list. This list is created by putting \\todo commands in the documentation.\n# The default value is: YES.\n\nGENERATE_TODOLIST = YES\n\n# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test\n# list. This list is created by putting \\test commands in the documentation.\n# The default value is: YES.\n\nGENERATE_TESTLIST = YES\n\n# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug\n# list. This list is created by putting \\bug commands in the documentation.\n# The default value is: YES.\n\nGENERATE_BUGLIST = YES\n\n# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)\n# the deprecated list. This list is created by putting \\deprecated commands in\n# the documentation.\n# The default value is: YES.\n\nGENERATE_DEPRECATEDLIST= YES\n\n# The ENABLED_SECTIONS tag can be used to enable conditional documentation\n# sections, marked by \\if ... \\endif and \\cond \n# ... \\endcond blocks.\n\nENABLED_SECTIONS =\n\n# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the\n# initial value of a variable or macro / define can have for it to appear in the\n# documentation. If the initializer consists of more lines than specified here\n# it will be hidden. Use a value of 0 to hide initializers completely. The\n# appearance of the value of individual variables and macros / defines can be\n# controlled using \\showinitializer or \\hideinitializer command in the\n# documentation regardless of this setting.\n# Minimum value: 0, maximum value: 10000, default value: 30.\n\nMAX_INITIALIZER_LINES = 30\n\n# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at\n# the bottom of the documentation of classes and structs. If set to YES, the\n# list will mention the files that were used to generate the documentation.\n# The default value is: YES.\n\nSHOW_USED_FILES = YES\n\n# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This\n# will remove the Files entry from the Quick Index and from the Folder Tree View\n# (if specified).\n# The default value is: YES.\n\nSHOW_FILES = YES\n\n# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces\n# page. This will remove the Namespaces entry from the Quick Index and from the\n# Folder Tree View (if specified).\n# The default value is: YES.\n\nSHOW_NAMESPACES = YES\n\n# The FILE_VERSION_FILTER tag can be used to specify a program or script that\n# doxygen should invoke to get the current version for each file (typically from\n# the version control system). Doxygen will invoke the program by executing (via\n# popen()) the command command input-file, where command is the value of the\n# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided\n# by doxygen. Whatever the program writes to standard output is used as the file\n# version. For an example see the documentation.\n\nFILE_VERSION_FILTER =\n\n# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed\n# by doxygen. The layout file controls the global structure of the generated\n# output files in an output format independent way. To create the layout file\n# that represents doxygen's defaults, run doxygen with the -l option. You can\n# optionally specify a file name after the option, if omitted DoxygenLayout.xml\n# will be used as the name of the layout file. See also section \"Changing the\n# layout of pages\" for information.\n#\n# Note that if you run doxygen from a directory containing a file called\n# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE\n# tag is left empty.\n\nLAYOUT_FILE =\n\n# The CITE_BIB_FILES tag can be used to specify one or more bib files containing\n# the reference definitions. This must be a list of .bib files. The .bib\n# extension is automatically appended if omitted. This requires the bibtex tool\n# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.\n# For LaTeX the style of the bibliography can be controlled using\n# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the\n# search path. See also \\cite for info how to create references.\n\nCITE_BIB_FILES = @CMAKE_CURRENT_SOURCE_DIR@/references.bib\n\n#---------------------------------------------------------------------------\n# Configuration options related to warning and progress messages\n#---------------------------------------------------------------------------\n\n# The QUIET tag can be used to turn on/off the messages that are generated to\n# standard output by doxygen. If QUIET is set to YES this implies that the\n# messages are off.\n# The default value is: NO.\n\nQUIET = YES\n\n# The WARNINGS tag can be used to turn on/off the warning messages that are\n# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES\n# this implies that the warnings are on.\n#\n# Tip: Turn warnings on while writing the documentation.\n# The default value is: YES.\n\nWARNINGS = YES\n\n# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate\n# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag\n# will automatically be disabled.\n# The default value is: YES.\n\nWARN_IF_UNDOCUMENTED = YES\n\n# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for\n# potential errors in the documentation, such as documenting some parameters in\n# a documented function twice, or documenting parameters that don't exist or\n# using markup commands wrongly.\n# The default value is: YES.\n\nWARN_IF_DOC_ERROR = YES\n\n# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete\n# function parameter documentation. If set to NO, doxygen will accept that some\n# parameters have no documentation without warning.\n# The default value is: YES.\n\nWARN_IF_INCOMPLETE_DOC = YES\n\n# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that\n# are documented, but have no documentation for their parameters or return\n# value. If set to NO, doxygen will only warn about wrong parameter\n# documentation, but not about the absence of documentation. If EXTRACT_ALL is\n# set to YES then this flag will automatically be disabled. See also\n# WARN_IF_INCOMPLETE_DOC\n# The default value is: NO.\n\nWARN_NO_PARAMDOC = NO\n\n# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about\n# undocumented enumeration values. If set to NO, doxygen will accept\n# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag\n# will automatically be disabled.\n# The default value is: NO.\n\nWARN_IF_UNDOC_ENUM_VAL = NO\n\n# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when\n# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS\n# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but\n# at the end of the doxygen process doxygen will return with a non-zero status.\n# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then doxygen behaves\n# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not\n# write the warning messages in between other messages but write them at the end\n# of a run, in case a WARN_LOGFILE is defined the warning messages will be\n# besides being in the defined file also be shown at the end of a run, unless\n# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case\n# the behavior will remain as with the setting FAIL_ON_WARNINGS.\n# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT.\n# The default value is: NO.\n\nWARN_AS_ERROR = NO\n\n# The WARN_FORMAT tag determines the format of the warning messages that doxygen\n# can produce. The string should contain the $file, $line, and $text tags, which\n# will be replaced by the file and line number from which the warning originated\n# and the warning text. Optionally the format may contain $version, which will\n# be replaced by the version of the file (if it could be obtained via\n# FILE_VERSION_FILTER)\n# See also: WARN_LINE_FORMAT\n# The default value is: $file:$line: $text.\n\nWARN_FORMAT = \"$file:$line: $text\"\n\n# In the $text part of the WARN_FORMAT command it is possible that a reference\n# to a more specific place is given. To make it easier to jump to this place\n# (outside of doxygen) the user can define a custom \"cut\" / \"paste\" string.\n# Example:\n# WARN_LINE_FORMAT = \"'vi $file +$line'\"\n# See also: WARN_FORMAT\n# The default value is: at line $line of file $file.\n\nWARN_LINE_FORMAT = \"at line $line of file $file\"\n\n# The WARN_LOGFILE tag can be used to specify a file to which warning and error\n# messages should be written. If left blank the output is written to standard\n# error (stderr). In case the file specified cannot be opened for writing the\n# warning and error messages are written to standard error. When as file - is\n# specified the warning and error messages are written to standard output\n# (stdout).\n\nWARN_LOGFILE =\n\n#---------------------------------------------------------------------------\n# Configuration options related to the input files\n#---------------------------------------------------------------------------\n\n# The INPUT tag is used to specify the files and/or directories that contain\n# documented source files. You may enter file names like myfile.cpp or\n# directories like /usr/src/myproject. Separate the files or directories with\n# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING\n# Note: If this tag is empty the current directory is searched.\n\nINPUT = @DOXYGEN_INPUT@\n\n# This tag can be used to specify the character encoding of the source files\n# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses\n# libiconv (or the iconv built into libc) for the transcoding. See the libiconv\n# documentation (see:\n# https://www.gnu.org/software/libiconv/) for the list of possible encodings.\n# See also: INPUT_FILE_ENCODING\n# The default value is: UTF-8.\n\nINPUT_ENCODING = UTF-8\n\n# This tag can be used to specify the character encoding of the source files\n# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify\n# character encoding on a per file pattern basis. Doxygen will compare the file\n# name with each pattern and apply the encoding instead of the default\n# INPUT_ENCODING) if there is a match. The character encodings are a list of the\n# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding\n# \"INPUT_ENCODING\" for further information on supported encodings.\n\nINPUT_FILE_ENCODING =\n\n# If the value of the INPUT tag contains directories, you can use the\n# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and\n# *.h) to filter out the source-files in the directories.\n#\n# Note that for custom extensions or not directly supported extensions you also\n# need to set EXTENSION_MAPPING for the extension otherwise the files are not\n# read by doxygen.\n#\n# Note the list of default checked file patterns might differ from the list of\n# default file extension mappings.\n#\n# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,\n# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,\n# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml,\n# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C\n# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd,\n# *.vhdl, *.ucf, *.qsf and *.ice.\n\nFILE_PATTERNS =\n\n# The RECURSIVE tag can be used to specify whether or not subdirectories should\n# be searched for input files as well.\n# The default value is: NO.\n\nRECURSIVE = NO\n\n# The EXCLUDE tag can be used to specify files and/or directories that should be\n# excluded from the INPUT source files. This way you can easily exclude a\n# subdirectory from a directory tree whose root is specified with the INPUT tag.\n#\n# Note that relative paths are relative to the directory from which doxygen is\n# run.\n\nEXCLUDE =\n\n# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or\n# directories that are symbolic links (a Unix file system feature) are excluded\n# from the input.\n# The default value is: NO.\n\nEXCLUDE_SYMLINKS = NO\n\n# If the value of the INPUT tag contains directories, you can use the\n# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude\n# certain files from those directories.\n#\n# Note that the wildcards are matched against the file with absolute path, so to\n# exclude all test directories for example use the pattern */test/*\n\nEXCLUDE_PATTERNS =\n\n# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names\n# (namespaces, classes, functions, etc.) that should be excluded from the\n# output. The symbol name can be a fully qualified name, a word, or if the\n# wildcard * is used, a substring. Examples: ANamespace, AClass,\n# ANamespace::AClass, ANamespace::*Test\n\nEXCLUDE_SYMBOLS =\n\n# The EXAMPLE_PATH tag can be used to specify one or more files or directories\n# that contain example code fragments that are included (see the \\include\n# command).\n\nEXAMPLE_PATH =\n\n# If the value of the EXAMPLE_PATH tag contains directories, you can use the\n# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and\n# *.h) to filter out the source-files in the directories. If left blank all\n# files are included.\n\nEXAMPLE_PATTERNS =\n\n# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be\n# searched for input files to be used with the \\include or \\dontinclude commands\n# irrespective of the value of the RECURSIVE tag.\n# The default value is: NO.\n\nEXAMPLE_RECURSIVE = NO\n\n# The IMAGE_PATH tag can be used to specify one or more files or directories\n# that contain images that are to be included in the documentation (see the\n# \\image command).\n\nIMAGE_PATH =\n\n# The INPUT_FILTER tag can be used to specify a program that doxygen should\n# invoke to filter for each input file. Doxygen will invoke the filter program\n# by executing (via popen()) the command:\n#\n# \n#\n# where is the value of the INPUT_FILTER tag, and is the\n# name of an input file. Doxygen will then use the output that the filter\n# program writes to standard output. If FILTER_PATTERNS is specified, this tag\n# will be ignored.\n#\n# Note that the filter must not add or remove lines; it is applied before the\n# code is scanned, but not when the output code is generated. If lines are added\n# or removed, the anchors will not be placed correctly.\n#\n# Note that doxygen will use the data processed and written to standard output\n# for further processing, therefore nothing else, like debug statements or used\n# commands (so in case of a Windows batch file always use @echo OFF), should be\n# written to standard output.\n#\n# Note that for custom extensions or not directly supported extensions you also\n# need to set EXTENSION_MAPPING for the extension otherwise the files are not\n# properly processed by doxygen.\n\nINPUT_FILTER =\n\n# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern\n# basis. Doxygen will compare the file name with each pattern and apply the\n# filter if there is a match. The filters are a list of the form: pattern=filter\n# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how\n# filters are used. If the FILTER_PATTERNS tag is empty or if none of the\n# patterns match the file name, INPUT_FILTER is applied.\n#\n# Note that for custom extensions or not directly supported extensions you also\n# need to set EXTENSION_MAPPING for the extension otherwise the files are not\n# properly processed by doxygen.\n\nFILTER_PATTERNS =\n\n# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using\n# INPUT_FILTER) will also be used to filter the input files that are used for\n# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).\n# The default value is: NO.\n\nFILTER_SOURCE_FILES = YES\n\n# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file\n# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and\n# it is also possible to disable source filtering for a specific pattern using\n# *.ext= (so without naming a filter).\n# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.\n\nFILTER_SOURCE_PATTERNS =\n\n# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that\n# is part of the input, its contents will be placed on the main page\n# (index.html). This can be useful if you have a project on for instance GitHub\n# and want to reuse the introduction page also for the doxygen output.\n\nUSE_MDFILE_AS_MAINPAGE =\n\n# The Fortran standard specifies that for fixed formatted Fortran code all\n# characters from position 72 are to be considered as comment. A common\n# extension is to allow longer lines before the automatic comment starts. The\n# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can\n# be processed before the automatic comment starts.\n# Minimum value: 7, maximum value: 10000, default value: 72.\n\nFORTRAN_COMMENT_AFTER = 72\n\n#---------------------------------------------------------------------------\n# Configuration options related to source browsing\n#---------------------------------------------------------------------------\n\n# If the SOURCE_BROWSER tag is set to YES then a list of source files will be\n# generated. Documented entities will be cross-referenced with these sources.\n#\n# Note: To get rid of all source code in the generated output, make sure that\n# also VERBATIM_HEADERS is set to NO.\n# The default value is: NO.\n\nSOURCE_BROWSER = YES\n\n# Setting the INLINE_SOURCES tag to YES will include the body of functions,\n# classes and enums directly into the documentation.\n# The default value is: NO.\n\nINLINE_SOURCES = NO\n\n# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any\n# special comment blocks from generated source code fragments. Normal C, C++ and\n# Fortran comments will always remain visible.\n# The default value is: YES.\n\nSTRIP_CODE_COMMENTS = YES\n\n# If the REFERENCED_BY_RELATION tag is set to YES then for each documented\n# entity all documented functions referencing it will be listed.\n# The default value is: NO.\n\nREFERENCED_BY_RELATION = YES\n\n# If the REFERENCES_RELATION tag is set to YES then for each documented function\n# all documented entities called/used by that function will be listed.\n# The default value is: NO.\n\nREFERENCES_RELATION = YES\n\n# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set\n# to YES then the hyperlinks from functions in REFERENCES_RELATION and\n# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will\n# link to the documentation.\n# The default value is: YES.\n\nREFERENCES_LINK_SOURCE = YES\n\n# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the\n# source code will show a tooltip with additional information such as prototype,\n# brief description and links to the definition and documentation. Since this\n# will make the HTML file larger and loading of large files a bit slower, you\n# can opt to disable this feature.\n# The default value is: YES.\n# This tag requires that the tag SOURCE_BROWSER is set to YES.\n\nSOURCE_TOOLTIPS = YES\n\n# If the USE_HTAGS tag is set to YES then the references to source code will\n# point to the HTML generated by the htags(1) tool instead of doxygen built-in\n# source browser. The htags tool is part of GNU's global source tagging system\n# (see https://www.gnu.org/software/global/global.html). You will need version\n# 4.8.6 or higher.\n#\n# To use it do the following:\n# - Install the latest version of global\n# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file\n# - Make sure the INPUT points to the root of the source tree\n# - Run doxygen as normal\n#\n# Doxygen will invoke htags (and that will in turn invoke gtags), so these\n# tools must be available from the command line (i.e. in the search path).\n#\n# The result: instead of the source browser generated by doxygen, the links to\n# source code will now point to the output of htags.\n# The default value is: NO.\n# This tag requires that the tag SOURCE_BROWSER is set to YES.\n\nUSE_HTAGS = NO\n\n# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a\n# verbatim copy of the header file for each class for which an include is\n# specified. Set to NO to disable this.\n# See also: Section \\class.\n# The default value is: YES.\n\nVERBATIM_HEADERS = YES\n\n# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the\n# clang parser (see:\n# http://clang.llvm.org/) for more accurate parsing at the cost of reduced\n# performance. This can be particularly helpful with template rich C++ code for\n# which doxygen's built-in parser lacks the necessary type information.\n# Note: The availability of this option depends on whether or not doxygen was\n# generated with the -Duse_libclang=ON option for CMake.\n# The default value is: NO.\n\nCLANG_ASSISTED_PARSING = NO\n\n# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS\n# tag is set to YES then doxygen will add the directory of each input to the\n# include path.\n# The default value is: YES.\n# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.\n\nCLANG_ADD_INC_PATHS = YES\n\n# If clang assisted parsing is enabled you can provide the compiler with command\n# line options that you would normally use when invoking the compiler. Note that\n# the include paths will already be set by doxygen for the files and directories\n# specified with INPUT and INCLUDE_PATH.\n# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.\n\nCLANG_OPTIONS =\n\n# If clang assisted parsing is enabled you can provide the clang parser with the\n# path to the directory containing a file called compile_commands.json. This\n# file is the compilation database (see:\n# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the\n# options used when the source files were built. This is equivalent to\n# specifying the -p option to a clang tool, such as clang-check. These options\n# will then be passed to the parser. Any options specified with CLANG_OPTIONS\n# will be added as well.\n# Note: The availability of this option depends on whether or not doxygen was\n# generated with the -Duse_libclang=ON option for CMake.\n\nCLANG_DATABASE_PATH =\n\n#---------------------------------------------------------------------------\n# Configuration options related to the alphabetical class index\n#---------------------------------------------------------------------------\n\n# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all\n# compounds will be generated. Enable this if the project contains a lot of\n# classes, structs, unions or interfaces.\n# The default value is: YES.\n\nALPHABETICAL_INDEX = YES\n\n# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes)\n# that should be ignored while generating the index headers. The IGNORE_PREFIX\n# tag works for classes, function and member names. The entity will be placed in\n# the alphabetical list under the first letter of the entity name that remains\n# after removing the prefix.\n# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.\n\nIGNORE_PREFIX =\n\n#---------------------------------------------------------------------------\n# Configuration options related to the HTML output\n#---------------------------------------------------------------------------\n\n# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output\n# The default value is: YES.\n\nGENERATE_HTML = YES\n\n# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a\n# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of\n# it.\n# The default directory is: html.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_OUTPUT = html\n\n# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each\n# generated HTML page (for example: .htm, .php, .asp).\n# The default value is: .html.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_FILE_EXTENSION = .html\n\n# The HTML_HEADER tag can be used to specify a user-defined HTML header file for\n# each generated HTML page. If the tag is left blank doxygen will generate a\n# standard header.\n#\n# To get valid HTML the header file that includes any scripts and style sheets\n# that doxygen needs, which is dependent on the configuration options used (e.g.\n# the setting GENERATE_TREEVIEW). It is highly recommended to start with a\n# default header using\n# doxygen -w html new_header.html new_footer.html new_stylesheet.css\n# YourConfigFile\n# and then modify the file new_header.html. See also section \"Doxygen usage\"\n# for information on how to generate the default header that doxygen normally\n# uses.\n# Note: The header is subject to change so you typically have to regenerate the\n# default header when upgrading to a newer version of doxygen. For a description\n# of the possible markers and block names see the documentation.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_HEADER =\n\n# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each\n# generated HTML page. If the tag is left blank doxygen will generate a standard\n# footer. See HTML_HEADER for more information on how to generate a default\n# footer and what special commands can be used inside the footer. See also\n# section \"Doxygen usage\" for information on how to generate the default footer\n# that doxygen normally uses.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_FOOTER =\n\n# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style\n# sheet that is used by each HTML page. It can be used to fine-tune the look of\n# the HTML output. If left blank doxygen will generate a default style sheet.\n# See also section \"Doxygen usage\" for information on how to generate the style\n# sheet that doxygen normally uses.\n# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as\n# it is more robust and this tag (HTML_STYLESHEET) will in the future become\n# obsolete.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_STYLESHEET =\n\n# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined\n# cascading style sheets that are included after the standard style sheets\n# created by doxygen. Using this option one can overrule certain style aspects.\n# This is preferred over using HTML_STYLESHEET since it does not replace the\n# standard style sheet and is therefore more robust against future updates.\n# Doxygen will copy the style sheet files to the output directory.\n# Note: The order of the extra style sheet files is of importance (e.g. the last\n# style sheet in the list overrules the setting of the previous ones in the\n# list).\n# Note: Since the styling of scrollbars can currently not be overruled in\n# Webkit/Chromium, the styling will be left out of the default doxygen.css if\n# one or more extra stylesheets have been specified. So if scrollbar\n# customization is desired it has to be added explicitly. For an example see the\n# documentation.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_EXTRA_STYLESHEET =\n\n# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or\n# other source files which should be copied to the HTML output directory. Note\n# that these files will be copied to the base HTML output directory. Use the\n# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these\n# files. In the HTML_STYLESHEET file, use the file name only. Also note that the\n# files will be copied as-is; there are no commands or markers available.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_EXTRA_FILES =\n\n# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output\n# should be rendered with a dark or light theme.\n# Possible values are: LIGHT always generate light mode output, DARK always\n# generate dark mode output, AUTO_LIGHT automatically set the mode according to\n# the user preference, use light mode if no preference is set (the default),\n# AUTO_DARK automatically set the mode according to the user preference, use\n# dark mode if no preference is set and TOGGLE allow to user to switch between\n# light and dark mode via a button.\n# The default value is: AUTO_LIGHT.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_COLORSTYLE = AUTO_LIGHT\n\n# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen\n# will adjust the colors in the style sheet and background images according to\n# this color. Hue is specified as an angle on a color-wheel, see\n# https://en.wikipedia.org/wiki/Hue for more information. For instance the value\n# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300\n# purple, and 360 is red again.\n# Minimum value: 0, maximum value: 359, default value: 220.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_COLORSTYLE_HUE = 220\n\n# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors\n# in the HTML output. For a value of 0 the output will use gray-scales only. A\n# value of 255 will produce the most vivid colors.\n# Minimum value: 0, maximum value: 255, default value: 100.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_COLORSTYLE_SAT = 100\n\n# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the\n# luminance component of the colors in the HTML output. Values below 100\n# gradually make the output lighter, whereas values above 100 make the output\n# darker. The value divided by 100 is the actual gamma applied, so 80 represents\n# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not\n# change the gamma.\n# Minimum value: 40, maximum value: 240, default value: 80.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_COLORSTYLE_GAMMA = 80\n\n# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML\n# documentation will contain a main index with vertical navigation menus that\n# are dynamically created via JavaScript. If disabled, the navigation index will\n# consists of multiple levels of tabs that are statically embedded in every HTML\n# page. Disable this option to support browsers that do not have JavaScript,\n# like the Qt help browser.\n# The default value is: YES.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_DYNAMIC_MENUS = YES\n\n# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML\n# documentation will contain sections that can be hidden and shown after the\n# page has loaded.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_DYNAMIC_SECTIONS = NO\n\n# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries\n# shown in the various tree structured indices initially; the user can expand\n# and collapse entries dynamically later on. Doxygen will expand the tree to\n# such a level that at most the specified number of entries are visible (unless\n# a fully collapsed tree already exceeds this amount). So setting the number of\n# entries 1 will produce a full collapsed tree by default. 0 is a special value\n# representing an infinite number of entries and will result in a full expanded\n# tree by default.\n# Minimum value: 0, maximum value: 9999, default value: 100.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_INDEX_NUM_ENTRIES = 100\n\n# If the GENERATE_DOCSET tag is set to YES, additional index files will be\n# generated that can be used as input for Apple's Xcode 3 integrated development\n# environment (see:\n# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To\n# create a documentation set, doxygen will generate a Makefile in the HTML\n# output directory. Running make will produce the docset in that directory and\n# running make install will install the docset in\n# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at\n# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy\n# genXcode/_index.html for more information.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_DOCSET = NO\n\n# This tag determines the name of the docset feed. A documentation feed provides\n# an umbrella under which multiple documentation sets from a single provider\n# (such as a company or product suite) can be grouped.\n# The default value is: Doxygen generated docs.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_FEEDNAME = \"Doxygen generated docs\"\n\n# This tag determines the URL of the docset feed. A documentation feed provides\n# an umbrella under which multiple documentation sets from a single provider\n# (such as a company or product suite) can be grouped.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_FEEDURL =\n\n# This tag specifies a string that should uniquely identify the documentation\n# set bundle. This should be a reverse domain-name style string, e.g.\n# com.mycompany.MyDocSet. Doxygen will append .docset to the name.\n# The default value is: org.doxygen.Project.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_BUNDLE_ID = org.doxygen.Project\n\n# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify\n# the documentation publisher. This should be a reverse domain-name style\n# string, e.g. com.mycompany.MyDocSet.documentation.\n# The default value is: org.doxygen.Publisher.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_PUBLISHER_ID = org.doxygen.Publisher\n\n# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.\n# The default value is: Publisher.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_PUBLISHER_NAME = Publisher\n\n# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three\n# additional HTML index files: index.hhp, index.hhc, and index.hhk. The\n# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop\n# on Windows. In the beginning of 2021 Microsoft took the original page, with\n# a.o. the download links, offline the HTML help workshop was already many years\n# in maintenance mode). You can download the HTML help workshop from the web\n# archives at Installation executable (see:\n# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo\n# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).\n#\n# The HTML Help Workshop contains a compiler that can convert all HTML output\n# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML\n# files are now used as the Windows 98 help format, and will replace the old\n# Windows help format (.hlp) on all Windows platforms in the future. Compressed\n# HTML files also contain an index, a table of contents, and you can search for\n# words in the documentation. The HTML workshop also contains a viewer for\n# compressed HTML files.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_HTMLHELP = NO\n\n# The CHM_FILE tag can be used to specify the file name of the resulting .chm\n# file. You can add a path in front of the file if the result should not be\n# written to the html output directory.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nCHM_FILE =\n\n# The HHC_LOCATION tag can be used to specify the location (absolute path\n# including file name) of the HTML help compiler (hhc.exe). If non-empty,\n# doxygen will try to run the HTML help compiler on the generated index.hhp.\n# The file has to be specified with full path.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nHHC_LOCATION =\n\n# The GENERATE_CHI flag controls if a separate .chi index file is generated\n# (YES) or that it should be included in the main .chm file (NO).\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nGENERATE_CHI = NO\n\n# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)\n# and project file content.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nCHM_INDEX_ENCODING =\n\n# The BINARY_TOC flag controls whether a binary table of contents is generated\n# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it\n# enables the Previous and Next buttons.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nBINARY_TOC = NO\n\n# The TOC_EXPAND flag can be set to YES to add extra items for group members to\n# the table of contents of the HTML help documentation and to the tree view.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nTOC_EXPAND = NO\n\n# The SITEMAP_URL tag is used to specify the full URL of the place where the\n# generated documentation will be placed on the server by the user during the\n# deployment of the documentation. The generated sitemap is called sitemap.xml\n# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL\n# is specified no sitemap is generated. For information about the sitemap\n# protocol see https://www.sitemaps.org\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nSITEMAP_URL =\n\n# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and\n# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that\n# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help\n# (.qch) of the generated HTML documentation.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_QHP = NO\n\n# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify\n# the file name of the resulting .qch file. The path specified is relative to\n# the HTML output folder.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQCH_FILE =\n\n# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help\n# Project output. For more information please see Qt Help Project / Namespace\n# (see:\n# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).\n# The default value is: org.doxygen.Project.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_NAMESPACE = org.doxygen.Project\n\n# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt\n# Help Project output. For more information please see Qt Help Project / Virtual\n# Folders (see:\n# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).\n# The default value is: doc.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_VIRTUAL_FOLDER = doc\n\n# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom\n# filter to add. For more information please see Qt Help Project / Custom\n# Filters (see:\n# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_CUST_FILTER_NAME =\n\n# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the\n# custom filter to add. For more information please see Qt Help Project / Custom\n# Filters (see:\n# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_CUST_FILTER_ATTRS =\n\n# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this\n# project's filter section matches. Qt Help Project / Filter Attributes (see:\n# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_SECT_FILTER_ATTRS =\n\n# The QHG_LOCATION tag can be used to specify the location (absolute path\n# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to\n# run qhelpgenerator on the generated .qhp file.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHG_LOCATION =\n\n# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be\n# generated, together with the HTML files, they form an Eclipse help plugin. To\n# install this plugin and make it available under the help contents menu in\n# Eclipse, the contents of the directory containing the HTML and XML files needs\n# to be copied into the plugins directory of eclipse. The name of the directory\n# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.\n# After copying Eclipse needs to be restarted before the help appears.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_ECLIPSEHELP = NO\n\n# A unique identifier for the Eclipse help plugin. When installing the plugin\n# the directory name containing the HTML and XML files should also have this\n# name. Each documentation set should have its own identifier.\n# The default value is: org.doxygen.Project.\n# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.\n\nECLIPSE_DOC_ID = org.doxygen.Project\n\n# If you want full control over the layout of the generated HTML pages it might\n# be necessary to disable the index and replace it with your own. The\n# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top\n# of each HTML page. A value of NO enables the index and the value YES disables\n# it. Since the tabs in the index contain the same information as the navigation\n# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nDISABLE_INDEX = NO\n\n# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index\n# structure should be generated to display hierarchical information. If the tag\n# value is set to YES, a side panel will be generated containing a tree-like\n# index structure (just like the one that is generated for HTML Help). For this\n# to work a browser that supports JavaScript, DHTML, CSS and frames is required\n# (i.e. any modern browser). Windows users are probably better off using the\n# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can\n# further fine tune the look of the index (see \"Fine-tuning the output\"). As an\n# example, the default style sheet generated by doxygen has an example that\n# shows how to put an image at the root of the tree instead of the PROJECT_NAME.\n# Since the tree basically has the same information as the tab index, you could\n# consider setting DISABLE_INDEX to YES when enabling this option.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_TREEVIEW = NO\n\n# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the\n# FULL_SIDEBAR option determines if the side bar is limited to only the treeview\n# area (value NO) or if it should extend to the full height of the window (value\n# YES). Setting this to YES gives a layout similar to\n# https://docs.readthedocs.io with more room for contents, but less room for the\n# project logo, title, and description. If either GENERATE_TREEVIEW or\n# DISABLE_INDEX is set to NO, this option has no effect.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nFULL_SIDEBAR = NO\n\n# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that\n# doxygen will group on one line in the generated HTML documentation.\n#\n# Note that a value of 0 will completely suppress the enum values from appearing\n# in the overview section.\n# Minimum value: 0, maximum value: 20, default value: 4.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nENUM_VALUES_PER_LINE = 4\n\n# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used\n# to set the initial width (in pixels) of the frame in which the tree is shown.\n# Minimum value: 0, maximum value: 1500, default value: 250.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nTREEVIEW_WIDTH = 250\n\n# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to\n# external symbols imported via tag files in a separate window.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nEXT_LINKS_IN_WINDOW = NO\n\n# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email\n# addresses.\n# The default value is: YES.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nOBFUSCATE_EMAILS = YES\n\n# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg\n# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see\n# https://inkscape.org) to generate formulas as SVG images instead of PNGs for\n# the HTML output. These images will generally look nicer at scaled resolutions.\n# Possible values are: png (the default) and svg (looks nicer but requires the\n# pdf2svg or inkscape tool).\n# The default value is: png.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_FORMULA_FORMAT = png\n\n# Use this tag to change the font size of LaTeX formulas included as images in\n# the HTML documentation. When you change the font size after a successful\n# doxygen run you need to manually remove any form_*.png images from the HTML\n# output directory to force them to be regenerated.\n# Minimum value: 8, maximum value: 50, default value: 10.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nFORMULA_FONTSIZE = 10\n\n# The FORMULA_MACROFILE can contain LaTeX \\newcommand and \\renewcommand commands\n# to create new LaTeX commands to be used in formulas as building blocks. See\n# the section \"Including formulas\" for details.\n\nFORMULA_MACROFILE =\n\n# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see\n# https://www.mathjax.org) which uses client side JavaScript for the rendering\n# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX\n# installed or if you want to formulas look prettier in the HTML output. When\n# enabled you may also need to install MathJax separately and configure the path\n# to it using the MATHJAX_RELPATH option.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nUSE_MATHJAX = YES\n\n# With MATHJAX_VERSION it is possible to specify the MathJax version to be used.\n# Note that the different versions of MathJax have different requirements with\n# regards to the different settings, so it is possible that also other MathJax\n# settings have to be changed when switching between the different MathJax\n# versions.\n# Possible values are: MathJax_2 and MathJax_3.\n# The default value is: MathJax_2.\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_VERSION = MathJax_2\n\n# When MathJax is enabled you can set the default output format to be used for\n# the MathJax output. For more details about the output format see MathJax\n# version 2 (see:\n# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3\n# (see:\n# http://docs.mathjax.org/en/latest/web/components/output.html).\n# Possible values are: HTML-CSS (which is slower, but has the best\n# compatibility. This is the name for Mathjax version 2, for MathJax version 3\n# this will be translated into chtml), NativeMML (i.e. MathML. Only supported\n# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This\n# is the name for Mathjax version 3, for MathJax version 2 this will be\n# translated into HTML-CSS) and SVG.\n# The default value is: HTML-CSS.\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_FORMAT = HTML-CSS\n\n# When MathJax is enabled you need to specify the location relative to the HTML\n# output directory using the MATHJAX_RELPATH option. The destination directory\n# should contain the MathJax.js script. For instance, if the mathjax directory\n# is located at the same level as the HTML output directory, then\n# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax\n# Content Delivery Network so you can quickly see the result without installing\n# MathJax. However, it is strongly recommended to install a local copy of\n# MathJax from https://www.mathjax.org before deployment. The default value is:\n# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2\n# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_RELPATH = @MATHJAX_PATH@\n\n# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax\n# extension names that should be enabled during MathJax rendering. For example\n# for MathJax version 2 (see\n# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):\n# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols\n# For example for MathJax version 3 (see\n# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html):\n# MATHJAX_EXTENSIONS = ams\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_EXTENSIONS =\n\n# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces\n# of code that will be used on startup of the MathJax code. See the MathJax site\n# (see:\n# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an\n# example see the documentation.\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_CODEFILE =\n\n# When the SEARCHENGINE tag is enabled doxygen will generate a search box for\n# the HTML output. The underlying search engine uses javascript and DHTML and\n# should work on any modern browser. Note that when using HTML help\n# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)\n# there is already a search function so this one should typically be disabled.\n# For large projects the javascript based search engine can be slow, then\n# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to\n# search using the keyboard; to jump to the search box use + S\n# (what the is depends on the OS and browser, but it is typically\n# , /