Epetra Package Browser (Single Doxygen Collection) Development
Epetra_FastCrsMatrix.h
Go to the documentation of this file.
00001 /*
00002 //@HEADER
00003 // ************************************************************************
00004 // 
00005 //               Epetra: Linear Algebra Services Package 
00006 //                 Copyright 2001 Sandia Corporation
00007 // 
00008 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00009 // the U.S. Government retains certain rights in this software.
00010 //
00011 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are
00013 // met:
00014 //
00015 // 1. Redistributions of source code must retain the above copyright
00016 // notice, this list of conditions and the following disclaimer.
00017 //
00018 // 2. Redistributions in binary form must reproduce the above copyright
00019 // notice, this list of conditions and the following disclaimer in the
00020 // documentation and/or other materials provided with the distribution.
00021 //
00022 // 3. Neither the name of the Corporation nor the names of the
00023 // contributors may be used to endorse or promote products derived from
00024 // this software without specific prior written permission.
00025 //
00026 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00027 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00029 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00030 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00031 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00032 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00033 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00034 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00035 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00036 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 //
00038 // Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
00039 // 
00040 // ************************************************************************
00041 //@HEADER
00042 */
00043 
00044 #ifndef EPETRA_FASTCRSMATRIX_H
00045 #define EPETRA_FASTCRSMATRIX_H
00046 
00047 #include "Epetra_Operator.h"
00048 #include "Epetra_CrsMatrix.h"
00049 class Epetra_Vector;
00050 class Epetra_MultiVector;
00051 
00053 
00059 class Epetra_FastCrsOperator: public Epetra_CompObject, public virtual Epetra_Operator  {
00060       
00061  public:
00062 
00064 
00065 
00066   Epetra_FastCrsOperator(const Epetra_CrsMatrix & Matrix, bool UseFloats = false);
00067 
00069   virtual ~Epetra_FastCrsOperator();
00071   
00073 
00074 
00075   /* Updates the values only using a matrix that has exactly the same structure as
00076      the matrix used to construct this Epetra_FastCrsOperator object.
00077   */ 
00078   int UpdateValues(const Epetra_CrsMatrix & Matrix);
00080   
00082 
00083 
00085     char * Label() const {return(CrsMatrix_.Label());};
00086     
00088 
00097   int SetUseTranspose(bool UseTranspose) {return(CrsMatrix_.SetUseTranspose());};
00098 
00100   /* Returns the quantity \f$ \| A \|_\infty\f$ such that
00101      \f[\| A \|_\infty = \max_{1\lei\lem} \sum_{j=1}^n |a_{ij}| \f].
00102   */ 
00103   double NormInf() const {return(CrsMatrix_.NormInf());};
00104   
00106   const Epetra_Comm & Comm() const {return(CrsMatrix_.Comm());};
00107   
00109 
00115   int Apply(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const;
00116 
00118 
00125   int ApplyInverse(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const;
00126 
00128   bool HasNormInf() const {return(CrsMatrix_.HasNormInf());};
00129   
00131   bool UseTranspose() const {return(CrsMatrix_.UseTranspose());};
00132   
00134   const Epetra_Map & OperatorDomainMap() const {return(CrsMatrix_.OperatorDomainMap());};
00135   
00137   const Epetra_Map & OperatorRangeMap() const {return(CrsMatrix_.OperatorRangeMap());};
00138 
00140 
00141 
00142  protected:
00143   int Allocate(bool UseFloats);
00144   const Epetra_CrsMatrix & CrsMatrix_;
00145   int NumMyRows_;
00146   int NumMyNonzeros_;
00147   double *Values_;
00148   float * FloatValues_;
00149   int * Indices_;
00150   unsigned short * ShortIndices_;
00151 
00152   bool UsingFloats_;
00153   bool UsingShorts_;
00154   bool ValuesAllocated_;
00155     
00156 
00157   mutable Epetra_MultiVector * ImportVector_;
00158   mutable Epetra_MultiVector * ExportVector_;
00159 
00160 };
00161 #endif /* EPETRA_FASTCRSMATRIX_H */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines