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 2011 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 #ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
00225   int ReplaceGlobalValues(int NumEntries, const double * Values, const int * Indices);
00226 #endif
00227 #ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
00228   int ReplaceGlobalValues(int NumEntries, const double * Values, const long long * Indices);
00229 #endif
00230 
00232 
00245   int ReplaceMyValues(int NumEntries, const double * Values, const int * Indices);
00246 
00248 
00261   int SumIntoGlobalValues(int NumEntries, const double * Values, const int * Indices);
00262 
00264 
00277   int SumIntoMyValues(int NumEntries, const double * Values, const int * Indices);
00278 
00279   // Blockmap Versions
00280 
00282 
00300   int ReplaceGlobalValues(int NumEntries, int BlockOffset, const double * Values, const int * Indices);
00301 
00303 
00321   int ReplaceMyValues(int NumEntries, int BlockOffset, const double * Values, const int * Indices);
00322 
00324 
00342   int SumIntoGlobalValues(int NumEntries, int BlockOffset, const double * Values, const int * Indices);
00343 
00345 
00363   int SumIntoMyValues(int NumEntries, int BlockOffset, const double * Values, const int * Indices);
00365 
00367 
00368 
00369   //Let the compiler know we intend to overload the base-class ExtractCopy
00370   //function, rather than hide it.
00371   using Epetra_MultiVector::ExtractCopy;
00372 
00374 
00380   int ExtractCopy(double *V) const;
00381   
00382   //Let the compiler know we intend to overload the base-class ExtractView
00383   //function, rather than hide it.
00384   using Epetra_MultiVector::ExtractView;
00385 
00387 
00393   int ExtractView(double **V) const;
00395 
00397 
00398 
00400 
00403     double& operator [] (int index)
00404     {
00405 #ifdef HAVE_EPETRA_ARRAY_BOUNDS_CHECK
00406       EPETRA_TEST_FOR_EXCEPTION(
00407         !( 0 <= index && index < this->MyLength() ), -99,
00408         "Epetra_Vector::operator[](int): "
00409         "The index = " << index << " does not fall in the range"
00410         "[0,"<<this->MyLength()<<")"
00411         );
00412 #endif
00413       return Values_[index];
00414     }
00416 
00419     const double& operator [] (int index) const
00420     {
00421 #ifdef HAVE_EPETRA_ARRAY_BOUNDS_CHECK
00422       EPETRA_TEST_FOR_EXCEPTION(
00423         !( 0 <= index && index < this->MyLength() ), -99,
00424         "Epetra_Vector::operator[](int) const: "
00425         "The index = " << index << " does not fall in the range"
00426         "[0,"<<this->MyLength()<<")"
00427         );
00428 #endif
00429       return Values_[index];
00430     }
00432     
00434 
00435 
00436   //Let the compiler know we intend to overload the base-class ResetView
00437   //function, rather than hide it.
00438   using Epetra_MultiVector::ResetView;
00439 
00441 
00460   int ResetView(double * Values_in) {EPETRA_CHK_ERR(Epetra_MultiVector::ResetView(&Values_in)); return(0);};
00462  private:
00463 
00464     int ChangeValues(int NumEntries, int BlockOffset, const double * Values, const int * Indices, bool IndicesGlobal, bool SumInto);
00465 #ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
00466     int ChangeValues(int NumEntries, int BlockOffset, const double * Values, const long long * Indices, bool IndicesGlobal, bool SumInto);
00467 #endif
00468 
00469   template<typename int_type>
00470     int TChangeValues(int NumEntries, int BlockOffset, const double * Values, const int_type * Indices, bool IndicesGlobal, bool SumInto);
00471 };
00472 
00473 #endif /* EPETRA_VECTOR_H */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines