FEI Version of the Day
fei_Matrix.hpp
00001 /*
00002 // @HEADER
00003 // ************************************************************************
00004 //             FEI: Finite Element Interface to Linear Solvers
00005 //                  Copyright (2005) Sandia Corporation.
00006 //
00007 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation, the
00008 // U.S. Government retains certain rights in this software.
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 Alan Williams (william@sandia.gov) 
00038 //
00039 // ************************************************************************
00040 // @HEADER
00041 */
00042 
00043 
00044 #ifndef _fei_Matrix_hpp_
00045 #define _fei_Matrix_hpp_
00046 
00047 #include "fei_iosfwd.hpp"
00048 #include "fei_SharedPtr.hpp"
00049 #include "fei_MatrixGraph.hpp"
00050 #include "fei_defs.h"
00051 
00052 namespace fei {
00065   class Matrix {
00066   public:
00068     class Factory {
00069     public:
00071       virtual ~Factory(){}
00072 
00074       virtual fei::SharedPtr<fei::Matrix>
00075         createMatrix(fei::SharedPtr<fei::MatrixGraph> matrixGraph) = 0;
00076     };
00077 
00079     virtual ~Matrix(){}
00080 
00084     virtual const char* typeName() = 0;
00085 
00088     virtual int parameters(const fei::ParameterSet& paramset) = 0;
00089 
00091     virtual fei::SharedPtr<fei::MatrixGraph> getMatrixGraph() const = 0;
00092 
00094     virtual void setMatrixGraph(fei::SharedPtr<fei::MatrixGraph> matrixGraph) = 0;
00095 
00098     virtual int getGlobalNumRows() const = 0;
00099 
00102     virtual int getLocalNumRows() const = 0;
00103 
00109     virtual int getRowLength(int row, int& length) const = 0;
00110 
00112     virtual int putScalar(double scalar) = 0;
00113 
00123     virtual int copyOutRow(int row, int len, double* coefs, int* indices) const = 0;
00124 
00137     virtual int sumIn(int numRows, const int* rows,
00138                       int numCols, const int* cols,
00139                       const double* const* values,
00140                       int format=0) = 0;
00141 
00154     virtual int copyIn(int numRows, const int* rows,
00155                        int numCols, const int* cols,
00156                        const double* const* values,
00157                       int format=0) = 0;
00158 
00174     virtual int sumInFieldData(int fieldID,
00175                                int idType,
00176                                int rowID,
00177                                int colID,
00178                                const double* const* data,
00179                                int format=0) = 0;
00180 
00198     virtual int sumInFieldData(int fieldID,
00199                                int idType,
00200                                int rowID,
00201                                int colID,
00202                                const double* data,
00203                                int format=0) = 0;
00204 
00214     virtual int sumIn(int blockID, int connectivityID,
00215                       const double* const* values,
00216                       int format=0) = 0;
00217 
00222     virtual int globalAssemble() = 0;
00223 
00226     virtual int multiply(fei::Vector* x,
00227                          fei::Vector* y) = 0;
00228 
00234     virtual int gatherFromOverlap(bool accumulate = true) = 0;
00235 
00251     virtual int writeToFile(const char* filename,
00252                             bool matrixMarketFormat=true) = 0;
00253 
00266     virtual int writeToStream(FEI_OSTREAM& ostrm,
00267                               bool matrixMarketFormat=true) = 0;
00268 
00271     virtual bool usingBlockEntryStorage() = 0;
00272 
00277     virtual void markState() = 0;
00278 
00283     virtual bool changedSinceMark() = 0;
00284 
00285     virtual double* getBeginPointer() { return NULL; }
00286     virtual int getOffset(int row, int col) { return -1; }
00287 
00288   };//class Matrix
00289 }//namespace fei
00290 
00291 #ifndef _fei_ostream_ops_hpp_
00292 #include <fei_ostream_ops.hpp>
00293 #endif
00294 
00295 #endif // _fei_Matrix_hpp_
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends