FEI Version of the Day
fei_VectorTraits_Epetra.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_Epetra_h_
00045 #define _fei_VectorTraits_Epetra_h_
00046 
00047 #ifdef HAVE_FEI_EPETRA
00048 
00049 //
00050 //IMPORTANT NOTE: Make sure that wherever this file is included from, it
00051 //appears BEFORE any include of fei_base.hpp or fei_Vector.hpp !!!
00052 //
00053 #include <fei_VectorTraits.hpp>
00054 #include <fei_Include_Trilinos.hpp>
00055 
00056 namespace fei {
00063   template<>
00064   struct VectorTraits<Epetra_MultiVector> {
00065     static const char* typeName()
00066       { return("Epetra_MultiVector"); }
00067 
00068     static int setValues(Epetra_MultiVector* vec, int firstLocalOffset,
00069                          double scalar, bool isSolnVector=false)
00070       {
00071         return( vec->PutScalar(scalar) );
00072       }
00073 
00074     //note that incoming indices are point-entry indices, not block-indices.
00075     static int putValuesIn(Epetra_MultiVector* vec,
00076                            int firstLocalOffset,
00077                            int numValues,
00078                            const int* indices,
00079                            const double* values,
00080                            bool sum_into,
00081                            bool isSolnVector=false,
00082                            int vectorIndex=0)
00083       {
00084         double* localVecValues = (*vec)[vectorIndex];
00085         if (sum_into) {
00086           for(int i=0; i<numValues; ++i) {
00087             localVecValues[indices[i]-firstLocalOffset] += values[i];
00088           }
00089         }
00090         else {
00091           for(int i=0; i<numValues; ++i) {
00092             localVecValues[indices[i]-firstLocalOffset] = values[i];
00093           }
00094         }
00095         return(0);
00096       }
00097 
00098     //note that incoming indices are point-entry indices, not block-indices.
00099     static int copyOut(Epetra_MultiVector* vec,
00100                        int firstLocalOffset,
00101                        int numValues, const int* indices, double* values,
00102                        bool isSolnVector=false,
00103                        int vectorIndex=0)
00104       {
00105         double* localVecValues = (*vec)[vectorIndex];
00106         for(int i=0; i<numValues; ++i) {
00107           values[i] = localVecValues[indices[i]-firstLocalOffset];
00108         }
00109 
00110         return(0);
00111       }
00112 
00113     static double* getLocalCoefsPtr(Epetra_MultiVector* vec,
00114                                     bool isSolnVector=false,
00115                                     int vectorIndex=0)
00116       {
00117         return((*vec)[vectorIndex]);
00118       }
00119 
00120     static int update(Epetra_MultiVector* vec,
00121                       double a,
00122                       const Epetra_MultiVector* x,
00123                       double b)
00124     {
00125       return( vec->Update(a, *x, b) );
00126     }
00127 
00128   };//struct VectorTraits<Epetra_MultiVector>
00129 }//namespace fei
00130 
00131 #endif //HAVE_FEI_EPETRA
00132 
00133 #endif // _fei_VectorTraits_Epetra_hpp_
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends