Thyra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Thyra_SpmdVectorSpaceBase_decl.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Thyra: Interfaces and Support for Abstract Numerical Algorithms
5 // Copyright (2004) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
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 Roscoe A. Bartlett (bartlettra@ornl.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef THYRA_SPMD_VECTOR_SPACE_BASE_BASE_DECL_HPP
43 #define THYRA_SPMD_VECTOR_SPACE_BASE_BASE_DECL_HPP
44 
45 #include "Thyra_VectorSpaceBase_decl.hpp"
46 #include "Teuchos_Comm.hpp"
47 
48 
49 namespace Thyra {
50 
51 
131 template<class Scalar>
132 class SpmdVectorSpaceBase : virtual public VectorSpaceBase<Scalar> {
133 public:
134 
137 
141 
147  virtual Ordinal localSubDim() const = 0;
148 
152  virtual Ordinal localOffset() const = 0;
153 
161  virtual Ordinal mapCode() const = 0;
162 
164  virtual bool isLocallyReplicated() const = 0;
165 
167 
168 private:
169 
170  // Not defined and not to be called
171  SpmdVectorSpaceBase<Scalar>&
172  operator=(const SpmdVectorSpaceBase<Scalar>&);
173 
174 };
175 
176 
177 } // end namespace Thyra
178 
179 
180 #endif // THYRA_SPMD_VECTOR_SPACE_BASE_BASE_DECL_HPP
Teuchos::Ordinal Ordinal
Type for the dimension of a vector space. `*.
virtual Teuchos::RCP< const Teuchos::Comm< Ordinal > > getComm() const =0
Returns the SPMD communicator.
virtual Ordinal localOffset() const =0
Returns the offset for the local sub-vector stored on this process.
virtual bool isLocallyReplicated() const =0
Returns true if vector space is locally replicated space.
virtual Ordinal localSubDim() const =0
Returns the number of local elements stored on this process.
virtual Ordinal mapCode() const =0
Returns the code for the mapping of elements to processes.