ifp_LocalMat.h

/*@HEADER
// ***********************************************************************
// 
//       Ifpack: Object-Oriented Algebraic Preconditioner Package
//                 Copyright (2002) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library 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; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
//@HEADER
*/

#ifndef _IFP_LOCALMAT_H_
#define _IFP_LOCALMAT_H_

#include "Ifpack_config.h"

#include <iostream>
#include "ifp_BlockVec.h"
class ifp_LocalPrecon;

class IFPACK_DEPRECATED ifp_LocalMat
{
protected:
    inline void solve_is_mult(const ifp_BlockVec& B, ifp_BlockVec& X) const;

public:
    virtual ~ifp_LocalMat() {} // virtual, to make sure we call derived destructor
    virtual double *& Data() = 0; // ref to ptr to double
    virtual const double *Data() const = 0;

    virtual ifp_LocalMat *CreateEmpty() const = 0;
    virtual ifp_LocalMat *CreateInv(ifp_LocalPrecon&) const = 0;
    virtual void SetToZero(int, int) = 0;
    virtual void MatCopy(const ifp_LocalMat& A) = 0;
    virtual void Print(std::ostream&) const = 0;

    virtual void Mat_Trans(ifp_LocalMat *B) const = 0;
    virtual void Mat_Mat_Add(const ifp_LocalMat *B, ifp_LocalMat *C, 
        double alpha = 1.0) const = 0;
    virtual void Mat_Mat_Mult(const ifp_LocalMat *B, ifp_LocalMat *C, 
        double alpha = 1.0, double beta = 0.0) const = 0;
    virtual void Mat_Vec_Mult(const ifp_BlockVec& B, ifp_BlockVec& C,
        double alpha = 1.0, double beta = 0.0) const = 0;
    virtual void Mat_Trans_Vec_Mult(const ifp_BlockVec& B, ifp_BlockVec&C,
        double alpha = 1.0, double beta = 0.0) const = 0;
    virtual void Mat_Vec_Solve(const ifp_BlockVec& b, 
        ifp_BlockVec& x) const = 0;
    virtual void Mat_Trans_Vec_Solve(const ifp_BlockVec& b, 
        ifp_BlockVec& x) const = 0;
};

inline IFPACK_DEPRECATED void ifp_LocalMat::solve_is_mult(const ifp_BlockVec& B, ifp_BlockVec& X) const
{
    if (&B != &X)
    {
        Mat_Vec_Mult(B, X);
    }
    else
    {
        // solves must allow solves in place
        ifp_BlockVec T(B, -1);
        Mat_Vec_Mult(T, X);
    }
}

typedef ifp_LocalMat *ifp_LocalMatp;

#endif // _IFP_LOCALMAT_H_