Rodin/Configure.h.in file

Build configuration and feature-selection macros for Rodin.

CMake generates Rodin/Configure.h from this template. Include the generated header to inspect the library version and enabled backends; optional feature macros are defined only when their feature is enabled.

Representative use

#include <Rodin/Configure.h>
#if defined(RODIN_USE_MPI)
// Code requiring the MPI backend.
#endif

Module-specific controls

Controls declared by individual modules remain documented on their own header pages: RODIN_GEOMETRY_REQUIRE_INCIDENCE for mesh connectivity, RODIN_QF_GRUNDMANNMOLLER_MAX_ORDER for quadrature capacity, and RODIN_VARIATIONAL_H1ELEMENT_MAX_VECTOR_DIMENSION for H1 vector capacity.

Defines

#define RODIN_VERSION
Rodin version string.
#define RODIN_VERSION_MAJOR
Rodin major version number.
#define RODIN_VERSION_MINOR
Rodin minor version number.
#define RODIN_VERSION_PATCH
Rodin patch version number.
#define RODIN_VERSION_CODE
Encoded Rodin version number.
#define RODIN_WITH_PY
Indicates if Rodin is built with Python support.
#define RODIN_WITH_PLOT
Legacy plotting feature macro; no plotting module is currently shipped.
#define RODIN_USE_MPI
Indicates if Rodin is built with MPI support.
#define RODIN_USE_OPENMP
Indicates if Rodin is built with OpenMP support.
#define RODIN_USE_UMFPACK
Indicates if Rodin is built with SuiteSparse support.
#define RODIN_USE_PARU
Indicates if Rodin is built with SuiteSparse:ParU support.
#define RODIN_USE_MUMPS
Indicates if Rodin is built with MUMPS support.
#define RODIN_USE_SPQR
Indicates if Rodin is built with SuiteSparse support.
#define RODIN_USE_CHOLMOD
Indicates if Rodin is built with SuiteSparse support.
#define RODIN_SILENCE_WARNINGS
Indicates if Rodin warnings are silenced.
#define RODIN_SILENCE_EXCEPTIONS
Indicates if Rodin exceptions are silenced.
#define RODIN_RESOURCES_DIR
Indicates the Rodin resources directory.
#define RODIN_THIRD_PARTY_DIR
Indicates the Rodin third-party source directory.
#define RODIN_THREAD_SAFE
Indicates if Rodin is built with thread safety enabled.
#define RODIN_MULTITHREADED
Indicates if Rodin supports multithreading.
#define RODIN_USE_APPLE_ACCELERATE
Indicates if Rodin is built with Apple Accelerate support.
#define RODIN_USE_SCOTCH
Indicates if Rodin is built with Scotch support.
#define RODIN_MAXIMAL_SPACE_DIMENSION
Indicates the maximal space dimension.
#define RODIN_MAXIMUM_POLYTOPE_VERTICES
Maximum number of vertices supported by a polytope.
#define RODIN_FUZZY_CONSTANT
Legacy default tolerance intended for fuzzy scalar comparisons.

Define documentation

#define RODIN_WITH_PY

Indicates if Rodin is built with Python support.

Utilization

#ifndef RODIN_WITH_PY
// Code depending on Python support
#endif

#define RODIN_WITH_PLOT

Legacy plotting feature macro; no plotting module is currently shipped.

#ifndef RODIN_WITH_PLOT
// Legacy plotting integration
#endif

#define RODIN_USE_MPI

Indicates if Rodin is built with MPI support.

Utilization

#ifndef RODIN_USE_MPI
// Code depending on MPI support
#endif

#define RODIN_USE_OPENMP

Indicates if Rodin is built with OpenMP support.

Utilization

#ifndef RODIN_USE_OPENMP
// Code depending on OpenMP support
#endif

#define RODIN_USE_UMFPACK

Indicates if Rodin is built with SuiteSparse support.

Utilization

#ifndef RODIN_USE_UMFPACK
// Code depending on UMFPACK
#endif

#define RODIN_USE_PARU

Indicates if Rodin is built with SuiteSparse:ParU support.

Utilization

#ifndef RODIN_USE_PARU
// Code depending on ParU
#endif

#define RODIN_USE_MUMPS

Indicates if Rodin is built with MUMPS support.

Utilization

#ifndef RODIN_USE_MUMPS
// Code depending on MUMPS
#endif

#define RODIN_USE_SPQR

Indicates if Rodin is built with SuiteSparse support.

Utilization

#ifndef RODIN_USE_SPQR
// Code depending on SPQR
#endif

#define RODIN_USE_CHOLMOD

Indicates if Rodin is built with SuiteSparse support.

Utilization

#ifndef RODIN_USE_CHOLMOD
// Code depending on CHOLMOD
#endif

#define RODIN_SILENCE_EXCEPTIONS

Indicates if Rodin exceptions are silenced.

If defined, this directive will prevent Rodin from outputting the error messages. It does not prevent the exception from being thrown.

#define RODIN_RESOURCES_DIR

Indicates the Rodin resources directory.

Utilization

std::cout << RODIN_RESOURCES_DIR << std::endl;

#define RODIN_THIRD_PARTY_DIR

Indicates the Rodin third-party source directory.

Utilization

std::cout << RODIN_THIRD_PARTY_DIR << std::endl;

#define RODIN_THREAD_SAFE

Indicates if Rodin is built with thread safety enabled.

Utilization

#ifdef RODIN_THREAD_SAFE
  // Code that requires thread safety features.
#endif

#define RODIN_MULTITHREADED

Indicates if Rodin supports multithreading.

Utilization

#ifdef RODIN_MULTITHREADED
  // Code that leverages multithreading capabilities.
#endif

#define RODIN_USE_APPLE_ACCELERATE

Indicates if Rodin is built with Apple Accelerate support.

Utilization

#ifdef RODIN_USE_APPLE_ACCELERATE
  // Code that uses the Apple Accelerate framework for optimized computations.
#endif

#define RODIN_USE_SCOTCH

Indicates if Rodin is built with Scotch support.

Utilization

#ifdef RODIN_USE_SCOTCH
  // Code that uses the Scotch library for partioning.
#endif

#define RODIN_FUZZY_CONSTANT

Legacy default tolerance intended for fuzzy scalar comparisons.

Absolute threshold in the compared values' units; the value is a numerical policy, not a scale-independent error bound. Currently unused in Rodin's implementation; retained as a configuration macro for downstream users.