EpetraExt Package Browser (Single Doxygen Collection)  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
EpetraExt_BlockVector.h
Go to the documentation of this file.
1 //@HEADER
2 // ***********************************************************************
3 //
4 // EpetraExt: Epetra Extended - Linear Algebra Services Package
5 // Copyright (2011) Sandia Corporation
6 //
7 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
8 // the U.S. Government retains certain rights in this software.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 //@HEADER
41 
42 #ifndef EPETRAEXT_BLOCKVECTOR_H
43 #define EPETRAEXT_BLOCKVECTOR_H
44 
45 #if defined(EpetraExt_SHOW_DEPRECATED_WARNINGS)
46 #ifdef __GNUC__
47 #warning "The EpetraExt package is deprecated"
48 #endif
49 #endif
50 
51 #include "Epetra_ConfigDefs.h"
52 #include "Epetra_Vector.h"
53 #include "Teuchos_RCP.hpp"
54 #include <vector>
55 
57 
64 namespace EpetraExt {
65 
66 class BlockVector: public Epetra_Vector {
67  public:
68 
70 
80  BlockVector( const Epetra_BlockMap & BaseMap, const Epetra_BlockMap & GlobalMap);
81 
91  BlockVector(Epetra_DataAccess CV, const Epetra_BlockMap & BaseMap,
92  const Epetra_Vector & BlockVec);
93 
95  BlockVector( const BlockVector & MV );
96 
98  virtual ~BlockVector();
100 
102  int ExtractBlockValues( Epetra_Vector & BaseVec, long long BlockRow) const;
103 
105  int LoadBlockValues(const Epetra_Vector & BaseVec, long long BlockRow);
106 
107 #ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
108  int BlockSumIntoGlobalValues(int NumIndices, double* Values,
110  int* Indices, int BlockRow);
112  int BlockReplaceGlobalValues(int NumIndices, double* Values,
113  int* Indices, int BlockRow);
114 #endif
115 
116 #ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
117  int BlockSumIntoGlobalValues(int NumIndices, double* Values,
119  long long* Indices, long long BlockRow);
121  int BlockReplaceGlobalValues(int NumIndices, double* Values,
122  long long* Indices, long long BlockRow);
123 #endif
124 
126  Teuchos::RCP<const Epetra_Vector> GetBlock(long long BlockRow) const;
127 
129  Teuchos::RCP<Epetra_Vector> GetBlock(long long BlockRow);
130 
132  const Epetra_BlockMap& GetBaseMap() const;
133 
134  protected:
135 
137 
138  long long Offset_;
139 
140 };
141 
142 } //namespace EpetraExt
143 
144 #endif /* EPETRAEXT_BLOCKVECTOR_H */
int BlockSumIntoGlobalValues(int NumIndices, double *Values, int *Indices, int BlockRow)
Load entries into BlockVector with base vector indices offset by BlockRow.
int BlockReplaceGlobalValues(int NumIndices, double *Values, int *Indices, int BlockRow)
Load entries into BlockVector with base vector indices offset by BlockRow.
virtual ~BlockVector()
Destructor.
int ExtractBlockValues(Epetra_Vector &BaseVec, long long BlockRow) const
Extract a single block from a Block Vector: block row is global, not a stencil value.
int LoadBlockValues(const Epetra_Vector &BaseVec, long long BlockRow)
Load a single block into a Block Vector: block row is global, not a stencil value.
BlockVector(const Epetra_BlockMap &BaseMap, const Epetra_BlockMap &GlobalMap)
BlockVector constuctor with one block row per processor.
Teuchos::RCP< const Epetra_Vector > GetBlock(long long BlockRow) const
Return Epetra_Vector for given block row.
Epetra_DataAccess
const Epetra_BlockMap & GetBaseMap() const
Return base map.