FEI Version of the Day
fei_Matrix_Local.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_Local_hpp_
00045 #define _fei_Matrix_Local_hpp_
00046 
00047 #include <fei_SharedPtr.hpp>
00048 #include <fei_MatrixGraph.hpp>
00049 #include <fei_Matrix.hpp>
00050 #include <fei_SparseRowGraph.hpp>
00051 
00052 #include <vector>
00053 
00054 namespace fei {
00055 class Matrix_Local : public fei::Matrix {
00056  public:
00057   Matrix_Local(fei::SharedPtr<fei::MatrixGraph> matrixGraph,
00058                fei::SharedPtr<fei::SparseRowGraph> sparseRowGraph);
00059 
00060   virtual ~Matrix_Local();
00061 
00062   static fei::SharedPtr<fei::Matrix>
00063     create_Matrix_Local(fei::SharedPtr<fei::MatrixGraph> matrixGraph,
00064                         bool blockEntry);
00065 
00066   const char* typeName();
00067 
00070   int parameters(const fei::ParameterSet& paramset);
00071 
00074   int parameters(int numParams, const char* const* paramStrings);
00075 
00077     fei::SharedPtr<fei::MatrixGraph> getMatrixGraph() const;
00078 
00080     void setMatrixGraph(fei::SharedPtr<fei::MatrixGraph> matrixGraph);
00081 
00084     int getGlobalNumRows() const;
00085 
00088     int getLocalNumRows() const;
00089 
00095     int getRowLength(int row, int& length) const;
00096 
00098     int putScalar(double scalar);
00099 
00109     int copyOutRow(int row, int len, double* coefs, int* indices) const;
00110 
00123     int sumIn(int numRows, const int* rows,
00124                       int numCols, const int* cols,
00125                       const double* const* values,
00126                       int format=0);
00127 
00140     int copyIn(int numRows, const int* rows,
00141                        int numCols, const int* cols,
00142                        const double* const* values,
00143                       int format=0);
00144 
00160     int sumInFieldData(int fieldID,
00161                                int idType,
00162                                int rowID,
00163                                int colID,
00164                                const double* const* data,
00165                                int format=0);
00166 
00184     int sumInFieldData(int fieldID,
00185                                int idType,
00186                                int rowID,
00187                                int colID,
00188                                const double* data,
00189                                int format=0);
00190 
00200     int sumIn(int blockID, int connectivityID,
00201                       const double* const* values,
00202                       int format=0);
00203 
00208     int globalAssemble();
00209 
00212     int multiply(fei::Vector* x,
00213                          fei::Vector* y);
00214 
00220     int gatherFromOverlap(bool accumulate = true);
00221 
00237     int writeToFile(const char* filename,
00238                             bool matrixMarketFormat=true);
00239 
00252     int writeToStream(FEI_OSTREAM& ostrm,
00253                               bool matrixMarketFormat=true);
00254 
00257     bool usingBlockEntryStorage();
00258 
00263     void markState();
00264 
00269     bool changedSinceMark();
00270 
00271     const std::vector<int>& getRowNumbers() const;
00272 
00273     const std::vector<int>& getRowOffsets() const;
00274 
00275     const std::vector<int>& getColumnIndices() const;
00276 
00277     const std::vector<double>& getCoefs() const;
00278 
00279  private:
00280   int getRowIndex(int rowNumber) const;
00281 
00282   int giveToMatrix(int numRows, const int* rows,
00283                       int numCols, const int* cols,
00284                       const double* const* values,
00285                       bool sumInto, int format);
00286 
00287   fei::SharedPtr<fei::MatrixGraph> matrixGraph_;
00288   fei::SharedPtr<fei::SparseRowGraph> sparseRowGraph_;
00289   std::vector<double> coefs_;
00290   bool stateChanged_;
00291   std::vector<double> work_data1D_;
00292   std::vector<const double*> work_data2D_;
00293 };//class Matrix_Local
00294 }//namespace fei
00295 
00296 #endif
00297 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends