Skip to content
Snippets Groups Projects
Commit b62caef0 authored by Simon Praetorius's avatar Simon Praetorius
Browse files

Add file documentation

parent f1cd4a76
No related branches found
No related tags found
1 merge request!1315Provide dedicated include for metis and parmetis headers
......@@ -5,6 +5,13 @@
#ifndef DUNE_METIS_HH
#define DUNE_METIS_HH
/**
* \file This include file is intended to be used instead of the direct include of `metis.h`. It
* provides the right order of necessary pre-includes, e.g. when scotch-metis is found, and introduces
* version-/distribution-independent type definitions for floating-point arguments (`real_t`) and
* integer arguments (`idx_t`) in the namespace `Dune::Metis`.
**/
#if HAVE_METIS
#if HAVE_SCOTCH_METIS
......
......@@ -5,6 +5,13 @@
#ifndef DUNE_PARMETIS_HH
#define DUNE_PARMETIS_HH
/**
* \file This include file is intended to be used instead of the direct include of `parmetis.h`. It
* provides the right order of necessary pre-includes, e.g. when ptscotch-parmetis is found, and introduces
* version-/distribution-independent type definitions for floating-point arguments (`real_t`) and
* integer arguments (`idx_t`) in the namespace `Dune::ParMetis`.
**/
#if HAVE_PARMETIS
#if HAVE_MPI
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment