TpetraExt_BlockExtraction_decl.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
// 
//          Tpetra: Templated Linear Algebra Services Package
//                 Copyright (2008) Sandia Corporation
// 
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ************************************************************************
// @HEADER

#ifndef TPETRAEXT_BLOCKEXTRACTION_DECL_HPP
#define TPETRAEXT_BLOCKEXTRACTION_DECL_HPP

#include "Tpetra_ConfigDefs.hpp"
#include "Tpetra_RowMatrix.hpp"
#include "Tpetra_BlockMap.hpp"

namespace Tpetra {
  namespace Ext {

    template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
    void
    extractBlockDiagonals(const Tpetra::RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> &matrix, 
                          const Teuchos::ArrayView<const LocalOrdinal> &first_points,
                          Teuchos::ArrayRCP<Scalar>       &out_diags,
                          Teuchos::ArrayRCP<LocalOrdinal> &out_offsets);

    template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
    void
    extractBlockDiagonals(const Tpetra::RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> &matrix, 
                          const Tpetra::BlockMap<LocalOrdinal,GlobalOrdinal,Node>         &block_map,
                          Teuchos::ArrayRCP<Scalar>       &out_diags,
                          Teuchos::ArrayRCP<LocalOrdinal> &out_offsets);

    template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
    void
    extractBlockRow(LocalOrdinal localBlockRow,
                    const RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> &matrix, 
                    const BlockMap<LocalOrdinal,GlobalOrdinal,Node> &block_row_map,
                    const BlockMap<LocalOrdinal,GlobalOrdinal,Node> &block_col_map,
                    ArrayRCP<ArrayRCP<Scalar> >      &out_block_entries,
                    ArrayRCP<LocalOrdinal>           &out_block_indices);

  }
}

#endif // TPETRAEXT_BLOCKEXTRACTION_DECL_HPP