FEI Version of the Day
fei_Aztec_LSVector.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 #ifndef _fei_Aztec_LSVector_hpp_
00044 #define _fei_Aztec_LSVector_hpp_
00045 
00046 
00047 #include <fei_SharedPtr.hpp>
00048 
00049 //
00050 // This class provides a vector that can be used with the AztecDMSR_matrix
00051 // and the AztecDVBR_Matrix.
00052 //
00053 // An important restriction to note:
00054 //
00055 // * An Aztec_LSVector can not be constructed until AFTER the AztecDMSR_Matrix
00056 //   (or AztecDVBR_Matrix) that it is to be used with has been completely
00057 //   initialized and filled (e.g., A.loadComplete() has been called (which
00058 //   means, most importantly, that AZ_transform has been called)). This is
00059 //   because the local data array for an aztec vector must be allocated
00060 //   with enough extra space to hold 'boundary elements' that are exchanged
00061 //   with other processors during the calculation of a parallel matrix-vector
00062 //   product, and we don't know how much memory that requires until after
00063 //   AZ_transform has been called.
00064 //
00065 // * Also, the calling code is responsible for keeping track of any 
00066 //   re-ordering that AZ_transform has done. i.e., Aztec_LSVector is just
00067 //   like a raw array with respect to indexing of entries. If v is an
00068 //   instantiation of an Aztec_LSVector, then v[9] literally returns the
00069 //   entry at position 9 (the 10th entry, since indexing is 0-based).
00070 //
00071 namespace fei_trilinos {
00072 
00073 class Aztec_Map;
00074 
00076 class Aztec_LSVector {
00077   public:
00078     // Constructor.
00079     Aztec_LSVector(fei::SharedPtr<Aztec_Map> map, int* data_org);
00080 
00081     Aztec_LSVector(const Aztec_LSVector& source);  // copy constructor
00082 
00083     virtual ~Aztec_LSVector ();
00084 
00085     Aztec_LSVector* newVector() const;
00086 
00087     // Mathematical functions.
00088     double dotProd (const Aztec_LSVector& y) const;
00089     void scale (double s);
00090     void addVec (double s, const Aztec_LSVector& c);
00091     double norm () const;
00092     double norm1 () const;
00093  
00094     // operator=
00095     Aztec_LSVector& operator = (const Aztec_LSVector& rhs);
00096     
00097     // Access functions.
00098     double& operator [] (int index);
00099     const double& operator [] (int index) const;
00100     
00101     void put (double scalar);
00102 
00103     const double* startPointer() const {return localCoeffs_;};
00104 
00105     //Special function
00106     bool readFromFile(const char *fileName);
00107     bool writeToFile(const char *fileName) const;
00108     
00109   protected:
00110     virtual void assign(const Aztec_LSVector& rhs);
00111     
00112   private:
00113     void checkInput();
00114     int inUpdate(int globalIndex, int& localIndex) const;
00115 
00116     fei::SharedPtr<Aztec_Map> amap_;
00117     double *localCoeffs_;        // local vector coefficients
00118     int length_;
00119 };
00120 
00121 }//namespace fei_trilinos
00122 
00123 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends