FEI Version of the Day
fei_VectorTraits_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_VectorTraits_LinSysCore_hpp_
00045 #define _fei_VectorTraits_LinSysCore_hpp_
00046 
00047 
00048 #include <fei_VectorTraits.hpp>
00049 #include <fei_LinearSystemCore.hpp>
00050 
00051 namespace fei {
00052 
00056   template<>
00057   struct VectorTraits<LinearSystemCore>  {
00058 
00060     static const char* typeName()
00061       { return("LinearSystemCore"); }
00062 
00065     static int setValues(LinearSystemCore* vec, int firstLocalOffset,
00066        double scalar, bool isSolnVector=false)
00067       {
00068   if (isSolnVector) {
00069     //LinearSystemCore doesn't have a 'resetSolnVector()'.
00070     return(-1);
00071   }
00072   int err = vec->resetRHSVector(scalar);
00073   return(err);
00074       }
00075 
00079     static int putValuesIn(LinearSystemCore* vec,
00080          int firstLocalOffset,
00081          int numValues, const int* indices, const double* values,
00082                      bool sum_into,
00083          bool isSolnVector=false,
00084          int vectorIndex=0)
00085       {
00086   int err = 0;
00087   if (isSolnVector) {
00088           if (sum_into) {
00089             return(-1);//LinearSystemCore allows 'put' (overwrite) operations on
00090                //the soln-vector, but not 'sumInto'.
00091           }
00092           else {
00093       err = vec->putInitialGuess(indices, values, numValues);
00094           }
00095   }
00096   else {
00097           if (sum_into) {
00098             err = vec->sumIntoRHSVector(numValues, values, indices);
00099           }
00100           else {
00101       err = vec->putIntoRHSVector(numValues, values, indices);
00102           }
00103   }
00104   return(err);
00105       }
00106 
00110     static int copyOut(LinearSystemCore* vec,
00111            int firstLocalOffset,
00112            int numValues, const int* indices, double* values,
00113            bool isSolnVector=false,
00114            int vectorIndex=0)
00115       {
00116   int err = 0;
00117   if (isSolnVector) {
00118     for(int i=0; i<numValues; ++i) {
00119       if (vec->getSolnEntry(indices[i], values[i]) != 0) return(-1);
00120     }
00121   }
00122   else {
00123     err = vec->getFromRHSVector(numValues, values, indices);
00124   }
00125 
00126   return(err);
00127       }
00128 
00131     static int update(LinearSystemCore* vec,
00132           double a,
00133           const LinearSystemCore* x,
00134           double b)
00135     { return(-1); }
00136 
00137   };//struct VectorTraits
00138 }//namespace fei
00139 
00140 #endif // _fei_VectorTraits_LinSysCore_hpp_
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends