FEI Version of the Day
fei_MatrixTraits_LinProbMgr.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_LinProbMgr_hpp_
00045 #define _fei_MatrixTraits_LinProbMgr_hpp_
00046 
00047 //This file defines matrix traits for LinearProblemManager matrix
00048 //representations.
00049 //
00050 
00051 #include <fei_LinearProblemManager.hpp>
00052 
00053 namespace fei {
00054 
00056   template<>
00057   struct MatrixTraits<fei::LinearProblemManager> {
00058 
00060     static const char* typeName()
00061       { return("fei::LinearProblemManager"); }
00062 
00063     static double* getBeginPointer(fei::LinearProblemManager* /*mat*/)
00064       {
00065         return NULL;
00066       }
00067 
00068     static int getOffset(fei::LinearProblemManager* /*mat*/, int /*row*/, int /*col*/)
00069       {
00070         return -1;
00071       }
00072 
00075     static int setValues(fei::LinearProblemManager* mat, double scalar)
00076       {
00077   mat->setMatrixValues(scalar);
00078         return(0);
00079       }
00080 
00084     static int getNumLocalRows(fei::LinearProblemManager* mat, int& numRows)
00085     {
00086       numRows = mat->getLocalNumRows();
00087       return(0);
00088     }
00089 
00092     static int getRowLength(fei::LinearProblemManager* mat, int row, int& length)
00093       {
00094   length = mat->getRowLength(row);
00095         if (length < 0) return(length);
00096         return(0);
00097       }
00098 
00111     static int copyOutRow(fei::LinearProblemManager* mat,
00112           int row, int len, double* coefs, int* indices)
00113       {
00114   return( mat->copyOutMatrixRow(row, len, coefs, indices) );
00115       }
00116 
00119     static int putValuesIn(fei::LinearProblemManager* mat,
00120                            int numRows, const int* rows,
00121                            int numCols, const int* cols,
00122                            const double* const* values,
00123                            bool sum_into)
00124       {
00125         return( mat->insertMatrixValues(numRows, rows,
00126                                         numCols, cols,
00127                                         values, sum_into) );
00128       }
00129 
00133     static int globalAssemble(fei::LinearProblemManager* mat)
00134     {
00135       return( mat->globalAssemble() );
00136     }
00137 
00139     static int matvec(fei::LinearProblemManager* mat,
00140           fei::Vector* x,
00141           fei::Vector* y)
00142     {
00143       return( -1 );
00144     }
00145   };//struct MatrixTraits
00146 }//namespace fei
00147 
00148 #endif // _fei_MatrixTraits_LinProbMgr_hpp_
00149 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends