Commit ecb421e8 authored by Jakub Klinkovský's avatar Jakub Klinkovský Committed by Jakub Klinkovský
Browse files

Added a Doxygen group for documenting Hypre wrappers

parent 76389ead

Documentation/Doxyfile

+1 −0
Original line number Diff line number Diff line
@@ -2123,6 +2123,7 @@ INCLUDE_FILE_PATTERNS = 
PREDEFINED = DOXYGEN_ONLY

PREDEFINED += HAVE_MPI

PREDEFINED += HAVE_CUDA

PREDEFINED += HAVE_HYPRE



# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this

# tag can be used to specify a list of macro names that should be expanded. The

Documentation/Pages/main-page.md

+5 −0
Original line number Diff line number Diff line
@@ -178,6 +178,11 @@ computing platform, and (optionally) some libraries. 
      <td> </td>

      <td> Only used for the compilation of the `tnl-decompose-mesh` tool. </td>

  </tr>

  <tr><td> [Hypre](https://github.com/hypre-space/hypre) </td>

      <td> \ref Hypre "Wrappers for Hypre solvers" </td>

      <td> `-DHAVE_HYPRE -lHYPRE` </td>

      <td> Attention should be paid to Hypre build options, e.g. `--enable-bigint`. </td>

  </tr>

  <tr><td> [libpng](http://www.libpng.org/pub/png/libpng.html) </td>

      <td> \ref TNL::Images "Image processing" classes </td>

      <td> `-DHAVE_PNG_H -lpng` </td>

src/TNL/Containers/HypreParVector.h

+2 −0
Original line number Diff line number Diff line
@@ -23,6 +23,8 @@ namespace Containers { 
 * - https://github.com/hypre-space/hypre/blob/master/src/parcsr_mv/par_vector.h

 * - https://github.com/hypre-space/hypre/blob/master/src/parcsr_mv/par_vector.c

 * - https://github.com/hypre-space/hypre/blob/master/src/parcsr_mv/_hypre_parcsr_mv.h (catch-all interface)

 *

 * \ingroup Hypre

 */

class HypreParVector

{

src/TNL/Containers/HypreVector.h

+2 −0
Original line number Diff line number Diff line
@@ -24,6 +24,8 @@ namespace Containers { 
 * - https://github.com/hypre-space/hypre/blob/master/src/seq_mv/vector.h

 * - https://github.com/hypre-space/hypre/blob/master/src/seq_mv/vector.c

 * - https://github.com/hypre-space/hypre/blob/master/src/seq_mv/seq_mv.h (catch-all interface)

 *

 * \ingroup Hypre

 */

class HypreVector

{

src/TNL/Hypre.h

+16 −0
Original line number Diff line number Diff line
@@ -36,6 +36,19 @@ 


namespace TNL {



/**

 * \defgroup Hypre  Wrappers for the Hypre library

 *

 * This group includes various wrapper classes for data structures and

 * algorithms implemented in the [Hypre library][hypre]. See the

 * [example][example] for how these wrappers can be used.

 *

 * [hypre]: https://github.com/hypre-space/hypre

 * [example]: https://mmg-gitlab.fjfi.cvut.cz/gitlab/tnl/tnl-dev/-/blob/develop/src/Examples/Hypre/tnl-hypre-ex5.cpp

 *

 * @{

 */



/**

 * \brief A simple RAII wrapper for Hypre's initialization and finalization.

 *
@@ -111,4 +124,7 @@ struct Hypre 
   #endif

// clang-format on



// this is a Doxygen end-group marker

//! @}



#endif  // HAVE_HYPRE