Epetra Package Browser (Single Doxygen Collection) Development
Epetra_Vector.h
Go to the documentation of this file.
00001 /*
00002 //@HEADER
00003 // ************************************************************************
00004 // 
00005 //               Epetra: Linear Algebra Services Package 
00006 //                 Copyright 2001 Sandia Corporation
00007 // 
00008 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00009 // the U.S. Government retains certain rights in this software.
00010 //
00011 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are
00013 // met:
00014 //
00015 // 1. Redistributions of source code must retain the above copyright
00016 // notice, this list of conditions and the following disclaimer.
00017 //
00018 // 2. Redistributions in binary form must reproduce the above copyright
00019 // notice, this list of conditions and the following disclaimer in the
00020 // documentation and/or other materials provided with the distribution.
00021 //
00022 // 3. Neither the name of the Corporation nor the names of the
00023 // contributors may be used to endorse or promote products derived from
00024 // this software without specific prior written permission.
00025 //
00026 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00027 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00029 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00030 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00031 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00032 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00033 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00034 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00035 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00036 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 //
00038 // Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
00039 // 
00040 // ************************************************************************
00041 //@HEADER
00042 */
00043 
00044 #ifndef EPETRA_VECTOR_H
00045 #define EPETRA_VECTOR_H
00046 
00047 #include "Epetra_ConfigDefs.h"
00048 #include "Epetra_MultiVector.h"
00049 class Epetra_Map;
00050 
00052 
00141 //=========================================================================
00142 class EPETRA_LIB_DLL_EXPORT Epetra_Vector : public Epetra_MultiVector {
00143 
00144   public:
00145 
00147 
00148 
00149 
00165   Epetra_Vector(const Epetra_BlockMap& Map, bool zeroOut = true);
00166 
00168   
00169   Epetra_Vector(const Epetra_Vector& Source);
00170   
00172 
00184   Epetra_Vector(Epetra_DataAccess CV, const Epetra_BlockMap& Map, double *V);
00185 
00187 
00201   Epetra_Vector(Epetra_DataAccess CV, const Epetra_MultiVector& Source, int Index);
00202 
00204     virtual ~Epetra_Vector ();
00206   
00208 
00209 
00211 
00224   int ReplaceGlobalValues(int NumEntries, const double * Values, const int * Indices);
00225 
00227 
00240   int ReplaceMyValues(int NumEntries, const double * Values, const int * Indices);
00241 
00243 
00256   int SumIntoGlobalValues(int NumEntries, const double * Values, const int * Indices);
00257 
00259 
00272   int SumIntoMyValues(int NumEntries, const double * Values, const int * Indices);
00273 
00274   // Blockmap Versions
00275 
00277 
00295   int ReplaceGlobalValues(int NumEntries, int BlockOffset, const double * Values, const int * Indices);
00296 
00298 
00316   int ReplaceMyValues(int NumEntries, int BlockOffset, const double * Values, const int * Indices);
00317 
00319 
00337   int SumIntoGlobalValues(int NumEntries, int BlockOffset, const double * Values, const int * Indices);
00338 
00340 
00358   int SumIntoMyValues(int NumEntries, int BlockOffset, const double * Values, const int * Indices);
00360 
00362 
00363 
00364   //Let the compiler know we intend to overload the base-class ExtractCopy
00365   //function, rather than hide it.
00366   using Epetra_MultiVector::ExtractCopy;
00367 
00369 
00375   int ExtractCopy(double *V) const;
00376   
00377   //Let the compiler know we intend to overload the base-class ExtractView
00378   //function, rather than hide it.
00379   using Epetra_MultiVector::ExtractView;
00380 
00382 
00388   int ExtractView(double **V) const;
00390 
00392 
00393 
00395 
00398     double& operator [] (int index)
00399     {
00400 #ifdef HAVE_EPETRA_ARRAY_BOUNDS_CHECK
00401       EPETRA_TEST_FOR_EXCEPTION(
00402         !( 0 <= index && index < this->MyLength() ), -99,
00403         "Epetra_Vector::operator[](int): "
00404         "The index = " << index << " does not fall in the range"
00405         "[0,"<<this->MyLength()<<")"
00406         );
00407 #endif
00408       return Values_[index];
00409     }
00411 
00414     const double& operator [] (int index) const
00415     {
00416 #ifdef HAVE_EPETRA_ARRAY_BOUNDS_CHECK
00417       EPETRA_TEST_FOR_EXCEPTION(
00418         !( 0 <= index && index < this->MyLength() ), -99,
00419         "Epetra_Vector::operator[](int) const: "
00420         "The index = " << index << " does not fall in the range"
00421         "[0,"<<this->MyLength()<<")"
00422         );
00423 #endif
00424       return Values_[index];
00425     }
00427     
00429 
00430 
00431   //Let the compiler know we intend to overload the base-class ResetView
00432   //function, rather than hide it.
00433   using Epetra_MultiVector::ResetView;
00434 
00436 
00455   int ResetView(double * Values_in) {EPETRA_CHK_ERR(Epetra_MultiVector::ResetView(&Values_in)); return(0);};
00457  private:
00458 
00459     int ChangeValues(int NumEntries, int BlockOffset, const double * Values, const int * Indices, bool IndicesGlobal, bool SumInto);
00460 
00461 };
00462 
00463 #endif /* EPETRA_VECTOR_H */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines