Tpetra parallel linear algebra  Version of the Day
Tpetra_Details_Transfer_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_DETAILS_TRANSFER_DECL_HPP
43 #define TPETRA_DETAILS_TRANSFER_DECL_HPP
44 
45 #include "Tpetra_ConfigDefs.hpp"
46 #include "Tpetra_Map_decl.hpp"
47 #include "Teuchos_Describable.hpp"
48 
49 namespace Tpetra {
50  //
51  // Forward declaration. The "doxygen" bit simply tells Doxygen (our
52  // automatic documentation generation system) to skip forward
53  // declarations.
54  //
55 #ifndef DOXYGEN_SHOULD_SKIP_THIS
56 class Distributor;
57 #endif // DOXYGEN_SHOULD_SKIP_THIS
58 
59 namespace Details {
60 
66  class GO = ::Tpetra::Details::DefaultTypes::global_ordinal_type,
68 class Transfer : public Teuchos::Describable {
69 public:
71  virtual ~Transfer () {}
72 
77  typedef ::Tpetra::Map<LO, GO, NT> map_type;
78 
83  virtual size_t getNumSameIDs() const = 0;
84 
91  virtual size_t getNumPermuteIDs () const = 0;
92 
94  virtual Teuchos::ArrayView<const LO> getPermuteFromLIDs () const = 0;
95 
97  virtual Teuchos::ArrayView<const LO> getPermuteToLIDs () const = 0;
98 
100  virtual size_t getNumRemoteIDs () const = 0;
101 
103  virtual Teuchos::ArrayView<const LO> getRemoteLIDs () const = 0;
104 
106  virtual size_t getNumExportIDs () const = 0;
107 
109  virtual Teuchos::ArrayView<const LO> getExportLIDs () const = 0;
110 
115  virtual Teuchos::ArrayView<const int> getExportPIDs () const = 0;
116 
118  virtual Teuchos::RCP<const map_type> getSourceMap () const = 0;
119 
121  virtual Teuchos::RCP<const map_type> getTargetMap () const = 0;
122 
124  virtual ::Tpetra::Distributor& getDistributor () const = 0;
125 
142  virtual bool isLocallyComplete () const = 0;
143 
164  virtual void
165  describe (Teuchos::FancyOStream& out,
166  const Teuchos::EVerbosityLevel verbLevel =
167  Teuchos::Describable::verbLevel_default) const;
168 
169 protected:
183  void
184  describeImpl (Teuchos::FancyOStream& out,
185  const std::string& className,
186  const Teuchos::EVerbosityLevel verbLevel =
187  Teuchos::Describable::verbLevel_default) const;
188 
189 private:
196  void
197  globalDescribe (Teuchos::FancyOStream& out,
198  const Teuchos::EVerbosityLevel vl) const;
199 
204  std::string
205  localDescribeToString (const Teuchos::EVerbosityLevel vl) const;
206 };
207 
208 } // namespace Details
209 } // namespace Tpetra
210 
211 // Explicit instantiation macro.
212 // Only invoke this when in the Tpetra::Details namespace.
213 // Most users do not need to use this.
214 //
215 // LO: The local ordinal type.
216 // GO: The global ordinal type.
217 // NODE: The Kokkos Node type.
218 #define TPETRA_DETAILS_TRANSFER_INSTANT(LO, GO, NODE) \
219  \
220  template class Transfer< LO , GO , NODE >;
221 
222 #endif // TPETRA_DETAILS_TRANSFER_DECL_HPP
virtual Teuchos::ArrayView< const LO > getPermuteToLIDs() const =0
List of local IDs in the target Map that are permuted.
void describeImpl(Teuchos::FancyOStream &out, const std::string &className, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
Implementation of describe() for subclasses (Tpetra::Import and Tpetra::Export).
Namespace Tpetra contains the class and methods constituting the Tpetra library.
Common base class of Import and Export.
virtual Teuchos::ArrayView< const int > getExportPIDs() const =0
List of processes to which entries will be sent.
KokkosClassic::DefaultNode::DefaultNodeType node_type
Default value of Node template parameter.
virtual size_t getNumSameIDs() const =0
Number of initial identical IDs.
virtual Teuchos::ArrayView< const LO > getPermuteFromLIDs() const =0
List of local IDs in the source Map that are permuted.
virtual bool isLocallyComplete() const =0
Is this Export or Import locally complete?
virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
Describe this object in a human-readable way to the given output stream.
::Tpetra::Map< LO, GO, NT > map_type
The specialization of Map used by this class and subclasses.
int local_ordinal_type
Default value of LocalOrdinal template parameter.
Implementation details of Tpetra.
Declarations for the Tpetra::Map class and related nonmember constructors.
virtual ::Tpetra::Distributor & getDistributor() const =0
The Distributor that this Export or Import object uses to move data.
virtual size_t getNumPermuteIDs() const =0
Number of IDs to permute but not to communicate.
virtual Teuchos::ArrayView< const LO > getRemoteLIDs() const =0
List of entries in the target Map to receive from other processes.
virtual Teuchos::RCP< const map_type > getTargetMap() const =0
The target Map used to construct this Export or Import.
virtual Teuchos::ArrayView< const LO > getExportLIDs() const =0
List of entries in the source Map that will be sent to other processes.
virtual ~Transfer()
Destructor (declared virtual for memory safety of derived classes).
virtual size_t getNumRemoteIDs() const =0
Number of entries not on the calling process.
virtual size_t getNumExportIDs() const =0
Number of entries that must be sent by the calling process to other processes.
virtual Teuchos::RCP< const map_type > getSourceMap() const =0
The source Map used to construct this Export or Import.