parpacktools.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 PARPACKTOOLS_HPP
#define PARPACKTOOLS_HPP
 
#include "typedefs.hpp"
 
// the two drivers share the info layout and therefore the decoders. USE_PARPACK
// hard-errors without USE_ARPACK ( config/linalg/config_parpack.cmake ), so
// arpacktools is always available here
#include "arpacktools.hpp"
 
namespace belfem
{
    namespace parpack
    {
        // the info array layout is identical to the serial driver's -- use
        // arpack::gInfoNaupd, arpack::gInfoNumConverged, ... to index it, and
        // arpack::check_naupd() / arpack::check_neupd() to decode it
 
#ifdef __cplusplus
        extern"C" {
#endif

            void
            parpack_standard_eigen(
                const int_t * nloc,      // rows owned by this rank
                const int_t * nglobal,   // rows of the whole matrix
                const int_t * nnz,       // nonzeros in the local block
                const real  * values,    // local values
                const int_t * indices,   // GLOBAL column indices
                const int_t * pointers,  // LOCAL row pointers
                const int_t * job,
                const int_t * nev,
                const int_t * ncvmin,   // floor for the Krylov subspace
                const real  * tol,
                const int_t * maxit,
                const real  * sigma,    // 0 for OP = A, else OP = sigma*I - A
                real * lambdareal,
                real * lambdaimag,
                int_t * info ) ;

            void
            parpack_symmetric_eigen(
                const int_t * nloc,      // rows owned by this rank
                const int_t * nglobal,   // rows of the whole matrix
                const int_t * nnz,       // nonzeros in the local block
                const real  * values,    // local values
                const int_t * indices,   // GLOBAL column indices
                const int_t * pointers,  // LOCAL row pointers
                const int_t * job,
                const int_t * nev,
                const int_t * ncvmin,   // floor for the Krylov subspace
                const real  * tol,
                const int_t * maxit,
                const real  * sigma,    // 0 for OP = A, else OP = sigma*I - A
                real * lambdareal,
                real * lambdaimag,
                int_t * info ) ;
 
#ifdef __cplusplus
        }
#endif
 
    }
 
}
#endif //PARPACKTOOLS_HPP