Module Documentation

Hand-written documentation for each module: usage guides, algorithm descriptions and theory notes.

The class, file and namespace indices in the navigation bar cover the generated API reference separately.

Infrastructure

• Core — Logging, timing, types, constants and string tools
• Containers — Cell, Map, Bitset and the other BELFEM container classes
• Linear Algebra — Backend-agnostic linear algebra API and LAPACK wrappers
• Sparse — Sparse storage and the solver interfaces (UMFPACK, MUMPS, STRUMPACK, PARDISO, PETSc)
• I/O — HDF5, ASCII, CSV, configuration files and XML
• Communication — MPI communication abstraction layer
• Mesh — Mesh data structures, I/O (Gmsh, HDF5, Exodus, VTK) and parallel partitioning
• Visualizer — Optional VTK rendering of meshes and curves (USE_VTK, off by default)

Mathematics

• Graph — Graph algorithms and partitioning (BFS, DFS, RCM, METIS, SCOTCH)
• Tensor — Fourth-order tensor helper
• Quaternion — Quaternion value type for 3D rotations
• Spline — Spline interpolation
• Optimizer — NLOPT-backed bound-constrained minimisation
• Homology — Cohomology algorithms, cut generation and theory

Finite Elements

• FEM Overview — How the finite-element modules fit together
• FEM Kernel — DOF management, hanging nodes, assembly, time stepping and the nonlinear controller
• Interpolation — Shape functions, integration points and Nedelec elements
• IWG — Integral weak forms (Poisson, heat conduction, elasticity, time stepping)
• Maxwell — Electromagnetics: h-phi formulation, thin shells, HTS, cohomology cuts
• Thermal — Transient heat conduction and the magneto-thermal coupling belfem selects for a thermal deck
• Postprocessing — Mesh-level postprocessing: volumes, surfaces, normals, gradients, mesh checks

Physics and Circuits

• Materials — Material property framework (pure metals, HTS, alloys, user-defined)
• Database — Precomputed lookup tables on tensor grids
• Gas Models — Equation-of-state and transport models
• Gas Tables — Tabulated thermophysical property data
• Circuit — Lumped-element circuit simulator coupled to the FEM problem
• Executables — belfem and the material, gas and db2exo tools, with their command-line interface