lapack_support.h

Go to the documentation of this file.

// -----------------------------------------------------------------------------
//
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR LGPL-2.1-or-later
// Copyright (C) 2005 - 2025 by the deal.II authors
//
// This file is part of the deal.II library.
//
// Detailed license information governing the source code and contributions
// can be found in LICENSE.md and CONTRIBUTING.md at the top level directory.
//
// -----------------------------------------------------------------------------
 
#ifndef dealii_lapack_support_h
#define dealii_lapack_support_h
 
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/exceptions.h>
#include <deal.II/base/types.h>
 
DEAL_II_NAMESPACE_OPEN
 
namespace types
{
#ifdef LAPACK_WITH_64BIT_BLAS_INDICES
  using blas_int = long long;
#else
  using blas_int = int;
#endif
} // namespace types
 
namespace LAPACKSupport
{
  enum State
  {
    matrix,
    inverse_matrix,
    lu,
    cholesky,
    eigenvalues,
    svd,
    inverse_svd,
    unusable = 0x8000
  };
 
  inline const char *
  state_name(State s)
  {
    switch (s)
      {
        case matrix:
          return "matrix";
        case inverse_matrix:
          return "inverse matrix";
        case lu:
          return "lu decomposition";
        case cholesky:
          return "cholesky decomposition";
        case eigenvalues:
          return "eigenvalues";
        case svd:
          return "svd";
        case inverse_svd:
          return "inverse_svd";
        case unusable:
          return "unusable";
        default:
          return "unknown";
      }
  }
 
  enum Property
  {
    general = 0,
    symmetric = 1,
    upper_triangular = 2,
    lower_triangular = 4,
    diagonal = 6,
    hessenberg = 8
  };
 
  inline const char *
  property_name(const Property s)
  {
    switch (s)
      {
        case general:
          return "general";
        case symmetric:
          return "symmetric";
        case upper_triangular:
          return "upper triangular";
        case lower_triangular:
          return "lower triangular";
        case diagonal:
          return "diagonal";
        case hessenberg:
          return "Hessenberg";
      }
 
    DEAL_II_NOT_IMPLEMENTED();
    return "invalid";
  }
 
  constexpr char A = 'A';
  constexpr char N = 'N';
  constexpr char O = 'O';
  constexpr char T = 'T';
  constexpr char U = 'U';
  constexpr char L = 'L';
  constexpr char V = 'V';
  constexpr types::blas_int zero = 0;
  constexpr types::blas_int one = 1;
 
  DeclException2(ExcErrorCode,
                 std::string,
                 types::blas_int,
                 << "The function " << arg1 << " returned with an error code "
                 << arg2);
 
  DeclException1(
    ExcState,
    State,
    << "The function cannot be called while the matrix is in state "
    << state_name(arg1));
 
  DeclException1(ExcProperty,
                 Property,
                 << "The function cannot be called with a "
                 << property_name(arg1) << " matrix.");
 
  DeclException1(
    ExcMissing,
    std::string,
    << "When you ran 'cmake' during installation of deal.II, no suitable "
    << "installation of the BLAS or LAPACK library could be found. "
    << "Consequently, the function <" << arg1 << "> can not be called. "
    << "Refer to the readme at https://dealii.org/current/readme.html for "
    << "information on how to ensure that deal.II picks up an existing "
    << "BLAS and LAPACK installation at configuration time.");
} // namespace LAPACKSupport
 
 
DEAL_II_NAMESPACE_CLOSE
 
#endif