hypre_parcsr.hpp

Go to the documentation of this file.

// Copyright (c) 2010, Lawrence Livermore National Security, LLC. Produced at
// the Lawrence Livermore National Laboratory. LLNL-CODE-443211. All Rights
// reserved. See file COPYRIGHT for details.
//
// This file is part of the MFEM library. For more information and source code
// availability see http://mfem.org.
//
// MFEM is free software; you can redistribute it and/or modify it under the
// terms of the GNU Lesser General Public License (as published by the Free
// Software Foundation) version 2.1 dated February 1999.

#ifndef MOAB_HYPRE_PARCSR
#define MOAB_HYPRE_PARCSR

#include "moab/MOABConfig.h"

#ifdef MOAB_HAVE_MPI

#include "_hypre_parcsr_mv.h"

namespace moab
{

namespace internal
{

    // This module contains functions that are logically part of HYPRE, and might
    // become part of HYPRE at some point. In the meantime the module can be
    // thought of as an extension of HYPRE.

    /** Parallel essential BC elimination from the system A*X = B.
        (Adapted from hypre_ParCSRMatrixEliminateRowsCols.) */
    void hypre_ParCSRMatrixEliminateAXB( hypre_ParCSRMatrix* A,
                                         HYPRE_Int num_rowscols_to_elim,
                                         HYPRE_Int* rowscols_to_elim,
                                         hypre_ParVector* X,
                                         hypre_ParVector* B );

    /** Parallel essential BC elimination from matrix A only. The eliminated
        elements are stored in a new matrix Ae, so that (A + Ae) equals the original
        matrix A. */
    void hypre_ParCSRMatrixEliminateAAe( hypre_ParCSRMatrix* A,
                                         hypre_ParCSRMatrix** Ae,
                                         HYPRE_Int num_rowscols_to_elim,
                                         HYPRE_Int* rowscols_to_elim );

    /** Split matrix 'A' into nr x nc blocks, return nr x nc pointers to
        new parallel matrices. The array 'blocks' needs to be preallocated to hold
        nr x nc pointers. If 'interleaved' == 0 the matrix is split into contiguous
        blocks (AAABBBCCC) otherwise the blocks are interleaved (ABCABCABC).
        The local number of rows of A must be divisible by nr. The local number of
        columns of A must be divisible by nc. */
    void hypre_ParCSRMatrixSplit( hypre_ParCSRMatrix* A,
                                  HYPRE_Int nr,
                                  HYPRE_Int nc,
                                  hypre_ParCSRMatrix** blocks,
                                  int interleaved_rows,
                                  int interleaved_cols );

    typedef int HYPRE_Bool;
#define HYPRE_MPI_BOOL MPI_INT

    /** The "Boolean" analog of y = alpha * A * x + beta * y, where elements in the
        sparsity pattern of the CSR matrix A are treated as "true". */
    void hypre_CSRMatrixBooleanMatvec( hypre_CSRMatrix* A,
                                       HYPRE_Bool alpha,
                                       HYPRE_Bool* x,
                                       HYPRE_Bool beta,
                                       HYPRE_Bool* y );

    hypre_ParCSRCommHandle* hypre_ParCSRCommHandleCreate_bool( HYPRE_Int job,
                                                               hypre_ParCSRCommPkg* comm_pkg,
                                                               HYPRE_Bool* send_data,
                                                               HYPRE_Bool* recv_data );

    /** The "Boolean" analog of y = alpha * A * x + beta * y, where elements in the
        sparsity pattern of the ParCSR matrix A are treated as "true". */
    void hypre_ParCSRMatrixBooleanMatvec( hypre_ParCSRMatrix* A,
                                          HYPRE_Bool alpha,
                                          HYPRE_Bool* x,
                                          HYPRE_Bool beta,
                                          HYPRE_Bool* y );

}  // namespace internal

}  // namespace moab

#endif  // MOAB_HAVE_MPI

#endif