FEI Version of the Day
fei_MatrixTraits.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_hpp_
00045 #define _fei_MatrixTraits_hpp_
00046 
00047 #include <fei_macros.hpp>
00048 
00049 namespace fei {
00050   class Vector;
00051 
00079   template<typename T>
00080   struct MatrixTraits {
00081 
00086     static const char* typeName()
00087       { return("unsupported"); }
00088 
00089     static double* getBeginPointer(T* /*mat*/)
00090       {
00091         return NULL;
00092       }
00093 
00094     static int getOffset(T* /*mat*/, int /*row*/, int /*col*/)
00095       {
00096         return -1;
00097       }
00098 
00101     static int setValues(T* mat, double scalar)
00102       { return(-1); }
00103 
00107     static int getNumLocalRows(T* mat, int& numRows)
00108       { return(-1); }
00109 
00113     static int getRowLength(T* mat, int row, int& length)
00114       { return(-1); }
00115 
00128     static int copyOutRow(T* mat,
00129           int row, int len, double* coefs, int* indices)
00130       { return(-1); }
00131 
00136     static int putValuesIn(T* mat,
00137                            int numRows, const int* rows,
00138                            int numCols, const int* cols,
00139                            const double* const* values,
00140                            bool sum_into)
00141       { return(-1); }
00142 
00149     static int globalAssemble(T* A)
00150     { return(0); }
00151 
00155     static int matvec(T* A, fei::Vector* x, fei::Vector* y)
00156     { return(-1); }
00157   };//struct MatrixTraits
00158 
00159 }//namespace fei
00160 
00161 #endif // _fei_MatrixTraits_hpp_
00162 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends