IFPACK Development
Ifpack_Container.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 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 //@HEADER
00041 */
00042 
00043 #ifndef IFPACK_CONTAINER_H
00044 #define IFPACK_CONTAINER_H
00045 
00046 class Epetra_RowMatrix;
00047 class Ifpack_Partitioner;
00048 namespace Teuchos {
00049   class ParameterList;
00050 }
00051 
00053 
00098 class Ifpack_Container {
00099 
00100 public:
00101 
00103   virtual ~Ifpack_Container() {};
00104 
00106   virtual int NumRows() const = 0;
00107 
00109   virtual int NumVectors() const = 0;
00110 
00112   virtual int SetNumVectors(const int i) = 0;
00113 
00115   virtual double& LHS(const int i, const int Vector = 0) = 0;
00116   
00118   virtual double& RHS(const int i, const int Vector = 0) = 0;
00119 
00121 
00130   virtual int& ID(const int i) = 0;
00131 
00133   virtual int SetMatrixElement(const int row, const int col,
00134                    const double value) = 0;
00135 
00137   virtual int Initialize() = 0;
00138 
00140   virtual int Compute(const Epetra_RowMatrix& A) = 0;
00141 
00143   virtual int SetParameters(Teuchos::ParameterList& List) = 0;
00144 
00146   virtual bool IsInitialized() const = 0;
00147 
00149   virtual bool IsComputed() const = 0;
00150 
00152   virtual int Apply() = 0;
00153 
00155   virtual int ApplyInverse() = 0;
00156 
00158   virtual const char* Label() const = 0;
00159 
00161   virtual double InitializeFlops() const = 0;
00162 
00164   virtual double ComputeFlops() const = 0;
00165 
00167   virtual double ApplyFlops() const = 0;
00168 
00170   virtual double ApplyInverseFlops() const = 0;
00171 
00173   virtual ostream& Print(std::ostream& os) const = 0;
00174 };
00175 
00176 inline ostream& operator<<(ostream& os, const Ifpack_Container& obj)
00177 {
00178   return(obj.Print(os));
00179 }
00180 
00181 #endif // IFPACK_CONTAINER_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends