Epetra_Operator.h

Go to the documentation of this file.
00001 
00002 //@HEADER
00003 /*
00004 ************************************************************************
00005 
00006               Epetra: Linear Algebra Services Package 
00007                 Copyright (2001) Sandia Corporation
00008 
00009 Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00010 license for use of this work by or on behalf of the U.S. Government.
00011 
00012 This library is free software; you can redistribute it and/or modify
00013 it under the terms of the GNU Lesser General Public License as
00014 published by the Free Software Foundation; either version 2.1 of the
00015 License, or (at your option) any later version.
00016  
00017 This library is distributed in the hope that it will be useful, but
00018 WITHOUT ANY WARRANTY; without even the implied warranty of
00019 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00020 Lesser General Public License for more details.
00021  
00022 You should have received a copy of the GNU Lesser General Public
00023 License along with this library; if not, write to the Free Software
00024 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00025 USA
00026 Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
00027 
00028 ************************************************************************
00029 */
00030 //@HEADER
00031 
00032 #ifndef EPETRA_OPERATOR_H
00033 #define EPETRA_OPERATOR_H
00034 
00035 class Epetra_MultiVector;
00036 class Epetra_Map;
00037 class Epetra_Comm;
00038 
00040 
00047 class Epetra_Operator {
00048       
00049  public:
00050 
00052 
00053 
00054     virtual ~Epetra_Operator() {};
00056   
00058 
00059 
00061 
00070     virtual int SetUseTranspose(bool UseTranspose) = 0;
00072   
00074 
00075 
00077 
00085     virtual int Apply(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const = 0;
00086 
00088 
00099     virtual int ApplyInverse(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const = 0;
00100 
00102     /* Returns the quantity \f$ \| A \|_\infty\f$ such that
00103        \f[\| A \|_\infty = \max_{1\lei\lem} \sum_{j=1}^n |a_{ij}| \f].
00104 
00105        \warning This method must not be called unless HasNormInf() returns true.
00106     */ 
00107     virtual double NormInf() const = 0;
00109   
00111 
00112 
00114     virtual const char * Label() const = 0;
00115 
00117     virtual bool UseTranspose() const = 0;
00118 
00120     virtual bool HasNormInf() const = 0;
00121 
00123     virtual const Epetra_Comm & Comm() const = 0;
00124 
00126     virtual const Epetra_Map & OperatorDomainMap() const = 0;
00127 
00129     virtual const Epetra_Map & OperatorRangeMap() const = 0;
00131 
00132 };
00133 
00134 #endif /* EPETRA_OPERATOR_H */

Generated on Wed May 12 21:41:05 2010 for Epetra Package Browser (Single Doxygen Collection) by  doxygen 1.4.7