Thyra Version of the Day
Loading...
Searching...
No Matches
Thyra_SpmdVectorSpaceDefaultBase_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_DECL_HPP
43#define THYRA_SPMD_VECTOR_SPACE_BASE_DECL_HPP
44
45#include "Thyra_SpmdVectorSpaceBase.hpp"
46#include "Thyra_ScalarProdVectorSpaceBase_decl.hpp"
47
48namespace Thyra {
49
92template<class Scalar>
94 : virtual public SpmdVectorSpaceBase<Scalar>
95 , virtual public ScalarProdVectorSpaceBase<Scalar>
96{
97public:
98
101
104
115 Ordinal localOffset() const;
116
141 Ordinal mapCode() const;
142
144 bool isLocallyReplicated() const;
145
147
151 std::string description() const;
153
156
159 Ordinal dim() const;
160
164
189 bool isCompatible(const VectorSpaceBase<Scalar>& vecSpc) const;
190
192
193protected:
194
222 virtual void updateState(const Ordinal globalDim,
223 const bool isLocallyReplicated = false);
224
225private:
226
227 // //////////////////////////////////////
228 // Private data members
229
230 Ordinal mapCode_; // < 0 is a flag that everything needs initialized
231 Ordinal defaultLocalOffset_;
232 Ordinal defaultGlobalDim_;
233 Ordinal localSubDim_;
234 bool isLocallyReplicated_;
235
237
238}; // end class SpmdVectorSpaceDefaultBase
239
240} // end namespace Thyra
241
242#endif // THYRA_SPMD_VECTOR_SPACE_BASE_DECL_HPP
Base abstract VectorSpaceBase class for all SPMD-based vector spaces.
Base VectorSpaceBase class for all SPMD vector spaces with contiguous local-to-global indexing.
virtual void updateState(const Ordinal globalDim, const bool isLocallyReplicated=false)
This function must be called whenever the state of this changes and some internal state must be updat...
Teuchos::RCP< const VectorSpaceFactoryBase< Scalar > > smallVecSpcFcty() const
Returns a DefaultSpmdVectorSpaceFactory object that has been given getComm().
bool isLocallyReplicated() const
Returns true if vector space is locally replicated space.
Ordinal dim() const
Returns the sum of the local number of elements on every process.
bool isCompatible(const VectorSpaceBase< Scalar > &vecSpc) const
Checks the general compatibility of parallel (or serial on one process) Spmd-based vector spaces.
Abstract interface for objects that represent a space for vectors.
Teuchos::Ordinal Ordinal
Type for the dimension of a vector space. `*.