Xpetra Version of the Day
Loading...
Searching...
No Matches
Xpetra_Export.hpp
Go to the documentation of this file.
1// @HEADER
2// *****************************************************************************
3// Xpetra: A linear algebra interface package
4//
5// Copyright 2012 NTESS and the Xpetra contributors.
6// SPDX-License-Identifier: BSD-3-Clause
7// *****************************************************************************
8// @HEADER
9
10#ifndef XPETRA_EXPORT_HPP
11#define XPETRA_EXPORT_HPP
12
13/* this file is automatically generated - do not edit (see script/interfaces.py) */
14
15#include <Tpetra_KokkosCompat_DefaultNode.hpp>
16#include <Teuchos_Describable.hpp>
17#include <Teuchos_as.hpp>
18#include "Xpetra_Map.hpp"
19#include <iterator>
20
21namespace Xpetra {
22
23template <class LocalOrdinal,
24 class GlobalOrdinal,
25 class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
26class Export
27 : public Teuchos::Describable {
28 public:
29 typedef LocalOrdinal local_ordinal_type;
30 typedef GlobalOrdinal global_ordinal_type;
31 typedef Node node_type;
32
34
35
37 virtual ~Export() {}
38
40
42
43
45 virtual size_t getNumSameIDs() const = 0;
46
48 virtual size_t getNumPermuteIDs() const = 0;
49
52
55
57 virtual size_t getNumRemoteIDs() const = 0;
58
61
63 virtual size_t getNumExportIDs() const = 0;
64
67
70
73
76
79
81
83
84
86 virtual void print(std::ostream &os) const = 0;
87
89
90}; // Export class
91
92} // namespace Xpetra
93
94#define XPETRA_EXPORT_SHORT
95#endif // XPETRA_EXPORT_HPP
virtual size_t getNumSameIDs() const =0
Number of initial identical IDs.
virtual Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getSourceMap() const =0
The source Map used to construct this Export.
virtual ArrayView< const LocalOrdinal > getPermuteToLIDs() const =0
List of local IDs in the target Map that are permuted.
GlobalOrdinal global_ordinal_type
virtual size_t getNumPermuteIDs() const =0
Number of IDs to permute but not to communicate.
virtual Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getTargetMap() const =0
The target Map used to construct this Export.
virtual ArrayView< const LocalOrdinal > getPermuteFromLIDs() const =0
List of local IDs in the source Map that are permuted.
virtual size_t getNumExportIDs() const =0
Number of entries that must be sent by the calling process to other processes.
virtual ArrayView< const LocalOrdinal > getExportLIDs() const =0
List of entries in the source Map that will be sent to other processes.
virtual ~Export()
Destructor.
virtual ArrayView< const LocalOrdinal > getRemoteLIDs() const =0
List of entries in the target Map to receive from other processes.
virtual void setDistributorParameters(const Teuchos::RCP< Teuchos::ParameterList > params) const =0
Set parameters on the underlying object.
LocalOrdinal local_ordinal_type
virtual ArrayView< const int > getExportPIDs() const =0
List of processes to which entries will be sent.
virtual size_t getNumRemoteIDs() const =0
Number of entries not on the calling process.
virtual void print(std::ostream &os) const =0
Print the Export's data to the given output stream.