mumpstools.hpp

Go to the documentation of this file.

/*
 * BELFEM -- The Berkeley Lab Finite Element Framework
 * Copyright (c) 2026, The Regents of the University of California,
 * through Lawrence Berkeley National Laboratory (subject to receipt of any required
 * approvals from the U.S. Dept. of Energy).  All rights reserved.
 *
 * Developers: Christian Messe, Gregory Giard
 *
 * See the top-level LICENSE file for the complete license and disclaimer.
 */
 
#ifndef BELFEM_MUMPSTOOLS_HPP
#define BELFEM_MUMPSTOOLS_HPP
 
#include "typedefs.hpp"
#ifdef BELFEM_MUMPS
#ifdef __cplusplus
extern"C" {
#endif
 
//------------------------------------------------------------------------------

    void
    mumpstools_create_solver(
            belfem::int_t    & aSolverID,
            belfem::int_t    & aInfo,
            const belfem::int_t & aHostIsWorking,
            const belfem::int_t & aSymmetryMode );
 
//------------------------------------------------------------------------------

    void
    mumpstools_free_solver(
            belfem::int_t    & aSolverID,
            belfem::int_t    * aInfo );
 
//------------------------------------------------------------------------------

    void
    mumpstools_num_solvers( belfem::int_t & aCount );
 
//------------------------------------------------------------------------------

    void
    mumpstools_solve(
        const belfem::int_t  * aIParameters,
        const double * aRParameters,
        const belfem::int_t    & aN,
        const belfem::int_t    & aNNZ,
        const belfem::int_t    & aNHRS,
        const belfem::int_t    * aRowIndices,
        const belfem::int_t    * aColIndices,
        const double * aValues,
        double       * aX,
        const double * aY,
        belfem::int_t * aInfo,
        belfem::int_t * aInfoG,
        double        * aRInfoG ) ;
 
//------------------------------------------------------------------------------
#ifdef __cplusplus
}
#endif
#endif
 
namespace mumps
{
    enum class Parameter
    {
        SolverID,
        Job,
        MasterRank,
        InfoLevel,
        ErrorAnalysis,
        WorkingHost,
        SymmetryMode,
        SerialReordering,
        ParallelReordering,
        CompressionMode,
        NumRefinementSteps,
        MemoryRelaxation,
        ComputeDeterminant,
        MemoryBudget        // ICNTL(23), MB per process; 0 = not set
    };
 
//------------------------------------------------------------------------------

    enum class WorkspaceAction
    {
        Ladder,   // double ICNTL(14) and factorize again
        Cap,      // hand MUMPS the machine budget as ICNTL(23) and factorize again
        GiveUp    // hand the failure to the soft-fail arms
    };
 
//------------------------------------------------------------------------------

    WorkspaceAction
    next_workspace_action(
            const belfem::int_t aInfoG1,
            const belfem::int_t aRelax,
            const belfem::int_t aRelaxCeiling,
            const belfem::int_t aBudgetSlot,
            const belfem::int_t aBudgetMB,
            const belfem::int_t aBoundMB );
 
}
 
#endif //BELFEM_MUMPSTOOLS_HPP