ifp_LocalMat.h

00001 /*@HEADER
00002 // ***********************************************************************
00003 // 
00004 //       Ifpack: Object-Oriented Algebraic Preconditioner Package
00005 //                 Copyright (2002) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 //@HEADER
00028 */
00029 
00030 #ifndef _IFP_LOCALMAT_H_
00031 #define _IFP_LOCALMAT_H_
00032 
00033 #include <iostream>
00034 #include "ifp_BlockVec.h"
00035 class ifp_LocalPrecon;
00036 
00037 class ifp_LocalMat
00038 {
00039 protected:
00040     inline void solve_is_mult(const ifp_BlockVec& B, ifp_BlockVec& X) const;
00041 
00042 public:
00043     virtual ~ifp_LocalMat() {} // virtual, to make sure we call derived destructor
00044     virtual double *& Data() = 0; // ref to ptr to double
00045     virtual const double *Data() const = 0;
00046 
00047     virtual ifp_LocalMat *CreateEmpty() const = 0;
00048     virtual ifp_LocalMat *CreateInv(ifp_LocalPrecon&) const = 0;
00049     virtual void SetToZero(int, int) = 0;
00050     virtual void MatCopy(const ifp_LocalMat& A) = 0;
00051     virtual void Print(std::ostream&) const = 0;
00052 
00053     virtual void Mat_Trans(ifp_LocalMat *B) const = 0;
00054     virtual void Mat_Mat_Add(const ifp_LocalMat *B, ifp_LocalMat *C, 
00055         double alpha = 1.0) const = 0;
00056     virtual void Mat_Mat_Mult(const ifp_LocalMat *B, ifp_LocalMat *C, 
00057         double alpha = 1.0, double beta = 0.0) const = 0;
00058     virtual void Mat_Vec_Mult(const ifp_BlockVec& B, ifp_BlockVec& C,
00059         double alpha = 1.0, double beta = 0.0) const = 0;
00060     virtual void Mat_Trans_Vec_Mult(const ifp_BlockVec& B, ifp_BlockVec&C,
00061         double alpha = 1.0, double beta = 0.0) const = 0;
00062     virtual void Mat_Vec_Solve(const ifp_BlockVec& b, 
00063         ifp_BlockVec& x) const = 0;
00064     virtual void Mat_Trans_Vec_Solve(const ifp_BlockVec& b, 
00065         ifp_BlockVec& x) const = 0;
00066 };
00067 
00068 inline void ifp_LocalMat::solve_is_mult(const ifp_BlockVec& B, ifp_BlockVec& X) const
00069 {
00070     if (&B != &X)
00071     {
00072         Mat_Vec_Mult(B, X);
00073     }
00074     else
00075     {
00076         // solves must allow solves in place
00077         ifp_BlockVec T(B, -1);
00078         Mat_Vec_Mult(T, X);
00079     }
00080 }
00081 
00082 typedef ifp_LocalMat *ifp_LocalMatp;
00083 
00084 #endif // _IFP_LOCALMAT_H_

Generated on Thu Sep 18 12:37:07 2008 for IFPACK by doxygen 1.3.9.1