EpetraExt_MatrixMatrix.h

Go to the documentation of this file.

//@HEADER
// ***********************************************************************
//
//     EpetraExt: Epetra Extended - Linear Algebra Services Package
//                 Copyright (2011) 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 EPETRAEXT_MATRIXMATRIX_H
#define EPETRAEXT_MATRIXMATRIX_H

#if defined(EpetraExt_SHOW_DEPRECATED_WARNINGS)
#ifdef __GNUC__
#warning "The EpetraExt package is deprecated"
#endif
#endif

#include <EpetraExt_ConfigDefs.h>

class Epetra_CrsMatrix;
class Epetra_Map;
class Epetra_Vector;

#ifdef HAVE_VECTOR
#include <vector>
#endif

namespace EpetraExt {
  class CrsMatrixStruct;


class MatrixMatrix {

  public:
    virtual ~MatrixMatrix(){}

    static int Multiply(const Epetra_CrsMatrix& A,
      bool transposeA,
      const Epetra_CrsMatrix& B,
      bool transposeB,
      Epetra_CrsMatrix& C,
                        bool call_FillComplete_on_result=true,
      bool keep_all_hard_zeros=false);

    static int Add(const Epetra_CrsMatrix& A,
                   bool transposeA,
                   double scalarA,
                   Epetra_CrsMatrix& B,
                   double scalarB);

    static int Add(const Epetra_CrsMatrix& A,
                   bool transposeA,
                   double scalarA,
                   const Epetra_CrsMatrix & B,
                   bool transposeB,
                   double scalarB,
                   Epetra_CrsMatrix * & C);


    static int Jacobi(double omega,
          const Epetra_Vector & Dinv,
          const Epetra_CrsMatrix& A,
          const Epetra_CrsMatrix& B,
          Epetra_CrsMatrix& C,
          bool call_FillComplete_on_result=true);

 private:
    template<typename int_type>
    static int Tmult_A_B(const Epetra_CrsMatrix & A,
     CrsMatrixStruct & Aview,
     const Epetra_CrsMatrix & B,
     CrsMatrixStruct& Bview,
     Epetra_CrsMatrix& C,
     bool call_FillComplete_on_result,
     bool keep_all_hard_zeros);

    static int mult_A_B(const Epetra_CrsMatrix & A,
     CrsMatrixStruct & Aview,
     const Epetra_CrsMatrix & B,
     CrsMatrixStruct& Bview,
     Epetra_CrsMatrix& C,
     bool call_FillComplete_on_result,
     bool keep_all_hard_zeros);

    template<typename int_type>
    static int Tmult_AT_B_newmatrix(const CrsMatrixStruct & Atransview, 
            const CrsMatrixStruct & Bview, 
            Epetra_CrsMatrix & C,
            bool keep_all_hard_zeros);

    static int mult_AT_B_newmatrix(const CrsMatrixStruct & Atransview, 
           const CrsMatrixStruct & Bview, 
           Epetra_CrsMatrix & C,
           bool keep_all_hard_zeros);

    template<typename int_type>
    static int TMultiply(const Epetra_CrsMatrix& A,
      bool transposeA,
      const Epetra_CrsMatrix& B,
      bool transposeB,
      Epetra_CrsMatrix& C,
      bool call_FillComplete_on_result,
      bool keep_all_hard_zeros);

    template<typename int_type>
    static int TAdd(const Epetra_CrsMatrix& A,
                   bool transposeA,
                   double scalarA,
                   Epetra_CrsMatrix& B,
                   double scalarB);

    template<typename int_type>
    static int TAdd(const Epetra_CrsMatrix& A,
                      bool transposeA,
                      double scalarA,
                      const Epetra_CrsMatrix & B,
                      bool transposeB,
                      double scalarB,
                      Epetra_CrsMatrix * & C);

    template<typename int_type>
    static int Tjacobi_A_B(double omega,
         const Epetra_Vector & Dinv,
         const Epetra_CrsMatrix & A,
         CrsMatrixStruct & Aview,
         const Epetra_CrsMatrix & B,
         CrsMatrixStruct& Bview,
         Epetra_CrsMatrix& C,
         bool call_FillComplete_on_result);
    
    static int jacobi_A_B(double omega,
        const Epetra_Vector & Dinv,
        const Epetra_CrsMatrix & A,
        CrsMatrixStruct & Aview,
        const Epetra_CrsMatrix & B,
        CrsMatrixStruct& Bview,
        Epetra_CrsMatrix& C,
        bool call_FillComplete_on_result);

    template<typename int_type>
    static int TJacobi(double omega,
           const Epetra_Vector & Dinv,
           const Epetra_CrsMatrix& A,
           const Epetra_CrsMatrix& B,
           Epetra_CrsMatrix& C,
           bool call_FillComplete_on_result);
    

};//class MatrixMatrix


 template<typename int_type>
 double sparsedot(double* u, int_type* u_ind, int u_len,
      double* v, int_type* v_ind, int v_len);
}//namespace EpetraExt

#endif