FEI Version of the Day
fei_MatrixTraits_LinSysCore.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_MatrixTraits_LinSysCore_hpp_
00045 #define _fei_MatrixTraits_LinSysCore_hpp_
00046 
00047 //This file defines matrix traits for LinearSystemCore matrices
00048 //(well, "matrix-views" to be more precise).
00049 //
00050 
00051 #include <fei_LinearSystemCore.hpp>
00052 
00053 namespace fei {
00054 
00056   template<>
00057   struct MatrixTraits<LinearSystemCore> {
00058 
00060     static const char* typeName()
00061       { return("LinearSystemCore"); }
00062 
00063     static double* getBeginPointer(LinearSystemCore* lsc)
00064       {
00065          return lsc->getMatrixBeginPointer();
00066       }
00067 
00068     static int getOffset(LinearSystemCore* lsc, int row, int col)
00069       {
00070          return lsc->getMatrixOffset(row,col);
00071       }
00072 
00075     static int setValues(LinearSystemCore* lsc, double scalar)
00076       {
00077   return( lsc->resetMatrix(scalar) );
00078       }
00079 
00083     static int getNumLocalRows(LinearSystemCore* lsc, int& numRows)
00084     {
00085       numRows = -1;
00086       return(-1);
00087     }
00088 
00091     static int getRowLength(LinearSystemCore* lsc, int row, int& length)
00092       {
00093   return( lsc->getMatrixRowLength(row, length) );
00094       }
00095 
00108     static int copyOutRow(LinearSystemCore* lsc,
00109           int row, int len, double* coefs, int* indices)
00110       {
00111         int dummy;
00112   return( lsc->getMatrixRow(row, coefs, indices, len, dummy) );
00113       }
00114 
00117     static int putValuesIn(LinearSystemCore* lsc,
00118                            int numRows, const int* rows,
00119                            int numCols, const int* cols,
00120                            const double* const* values,
00121                            bool sum_into)
00122       {
00123         if (sum_into) {
00124           return( lsc->sumIntoSystemMatrix(numRows, rows,
00125                                            numCols, cols, values) );
00126         }
00127         else {
00128     return( lsc->putIntoSystemMatrix(numRows, rows,
00129                                            numCols, cols, values) );
00130         }
00131       }
00132 
00137     static int globalAssemble(LinearSystemCore* lsc)
00138     {
00139       return( lsc->matrixLoadComplete() );
00140     }
00141 
00143     static int matvec(LinearSystemCore* lsc,
00144           fei::Vector* x,
00145           fei::Vector* y)
00146     {
00147       return( -1 );
00148     }
00149   };//struct MatrixTraits
00150 }//namespace fei
00151 
00152 #endif // _fei_MatrixTraits_LinSysCore_hpp_
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends