Tpetra parallel linear algebra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Tpetra_BlockVector_decl.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Tpetra: Templated Linear Algebra Services Package
5 // Copyright (2008) 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 TPETRA_BLOCKVECTOR_DECL_HPP
43 #define TPETRA_BLOCKVECTOR_DECL_HPP
44 
46 #include "Tpetra_BlockMultiVector.hpp"
47 #include "Tpetra_Vector.hpp"
48 
49 namespace Tpetra {
50 
76 template<class Scalar,
77  class LO,
78  class GO,
79  class Node>
80 class BlockVector : public BlockMultiVector<Scalar, LO, GO, Node> {
81 private:
83  typedef Teuchos::ScalarTraits<Scalar> STS;
84 
85 public:
87 
88 
98  typedef typename base_type::node_type node_type;
100  typedef typename Node::device_type device_type;
101 
108 
123  typedef Kokkos::View<impl_scalar_type*,
124  Kokkos::LayoutRight,
125  device_type,
126  Kokkos::MemoryTraits<Kokkos::Unmanaged> >
128 
133  typedef Kokkos::View<const impl_scalar_type*,
134  Kokkos::LayoutRight,
135  device_type,
136  Kokkos::MemoryTraits<Kokkos::Unmanaged> >
138 
140 
142 
147  BlockVector ();
148 
151 
154 
158 
162 
165  const Teuchos::DataAccess copyOrView);
166 
196  BlockVector (const map_type& meshMap, const LO blockSize);
197 
202  BlockVector (const map_type& meshMap,
203  const map_type& pointMap,
204  const LO blockSize);
205 
219  BlockVector (const mv_type& X_mv,
220  const map_type& meshMap,
221  const LO blockSize);
222 
235  BlockVector (const vec_type& X_vec,
236  const map_type& meshMap,
237  const LO blockSize);
238 
244  const map_type& newMeshMap,
245  const map_type& newPointMap,
246  const size_t offset = 0);
247 
253  const map_type& newMeshMap,
254  const size_t offset = 0);
255 
257 
259 
265 
267 
269 
285  bool replaceLocalValues (const LO localRowIndex, const Scalar vals[]) const;
286 
296  bool replaceGlobalValues (const GO globalRowIndex, const Scalar vals[]) const;
297 
307  bool sumIntoLocalValues (const LO localRowIndex, const Scalar vals[]) const;
308 
318  bool sumIntoGlobalValues (const GO globalRowIndex, const Scalar vals[]) const;
319 
330  bool getLocalRowView (const LO localRowIndex, Scalar*& vals) const;
331 
342  bool getGlobalRowView (const GO globalRowIndex, Scalar*& vals) const;
343 
356  little_vec_type getLocalBlock (const LO localRowIndex) const;
358 };
359 
360 } // namespace Tpetra
361 
362 #endif // TPETRA_BLOCKMULTIVECTOR_DECL_HPP
Node node_type
The Kokkos Node type; a legacy thing that will go away at some point.
BlockVector< Scalar, LO, GO, Node > & operator=(const BlockVector< Scalar, LO, GO, Node > &)=default
Copy assigment (shallow copy).
base_type::node_type node_type
The Kokkos Node type.
bool replaceGlobalValues(const GO globalRowIndex, const Scalar vals[]) const
Replace all values at the given mesh point, using a global index.
Kokkos::View< const impl_scalar_type *, Kokkos::LayoutRight, device_type, Kokkos::MemoryTraits< Kokkos::Unmanaged > > const_little_vec_type
&quot;Const block view&quot; of all degrees of freedom at a mesh point.
LO local_ordinal_type
The type of local indices.
base_type::scalar_type scalar_type
The type of entries in the vector.
GO global_ordinal_type
The type of global indices.
base_type::impl_scalar_type impl_scalar_type
The implementation type of entries in the vector.
MultiVector for multiple degrees of freedom per mesh point.
bool getLocalRowView(const LO localRowIndex, Scalar *&vals) const
Get a writeable view of the entries at the given mesh point, using a local index. ...
little_vec_type getLocalBlock(const LO localRowIndex) const
Get a view of the degrees of freedom at the given mesh point, using a local index.
vec_type getVectorView()
Get a Tpetra::Vector that views this BlockVector&#39;s data.
bool getGlobalRowView(const GO globalRowIndex, Scalar *&vals) const
Get a writeable view of the entries at the given mesh point, using a global index.
Tpetra::Vector< Scalar, LO, GO, Node > vec_type
The specialization of Tpetra::Vector that this class uses.
bool replaceLocalValues(const LO localRowIndex, const Scalar vals[]) const
Replace all values at the given mesh point, using a local index.
bool sumIntoLocalValues(const LO localRowIndex, const Scalar vals[]) const
Sum into all values at the given mesh point, using a local index.
Tpetra::MultiVector< Scalar, LO, GO, Node > mv_type
The specialization of Tpetra::MultiVector that this class uses.
Scalar scalar_type
The type of entries in the object.
A distributed dense vector.
base_type::local_ordinal_type local_ordinal_type
The type of local indices.
Forward declaration of Tpetra::BlockVector.
typename mv_type::impl_scalar_type impl_scalar_type
The implementation type of entries in the object.
BlockVector()
Default constructor.
Vector for multiple degrees of freedom per mesh point.
Kokkos::View< impl_scalar_type *, Kokkos::LayoutRight, device_type, Kokkos::MemoryTraits< Kokkos::Unmanaged > > little_vec_type
&quot;Block view&quot; of all degrees of freedom at a mesh point, for a single column of the MultiVector...
Tpetra::Map< LO, GO, Node > map_type
The specialization of Tpetra::Map that this class uses.
bool sumIntoGlobalValues(const GO globalRowIndex, const Scalar vals[]) const
Sum into all values at the given mesh point, using a global index.
base_type::global_ordinal_type global_ordinal_type
The type of global indices.
Kokkos::View< impl_scalar_type *, Kokkos::LayoutRight, device_type, Kokkos::MemoryTraits< Kokkos::Unmanaged > > little_vec_type
&quot;Block view&quot; of all degrees of freedom at a mesh point.
Node::device_type device_type
The Kokkos Device type.