Tpetra parallel linear algebra Version of the Day
Loading...
Searching...
No Matches
Tpetra_FECrsGraph_decl.hpp
Go to the documentation of this file.
1// @HEADER
2// *****************************************************************************
3// Tpetra: Templated Linear Algebra Services Package
4//
5// Copyright 2008 NTESS and the Tpetra contributors.
6// SPDX-License-Identifier: BSD-3-Clause
7// *****************************************************************************
8// @HEADER
9
10#ifndef TPETRA_FECRSGRAPH_DECL_HPP
11#define TPETRA_FECRSGRAPH_DECL_HPP
12
15
16#include "Tpetra_ConfigDefs.hpp"
17#include "Tpetra_FECrsGraph_fwd.hpp"
18#include "Tpetra_CrsGraph_decl.hpp"
19
20namespace Tpetra {
88
89template <class LocalOrdinal,
90 class GlobalOrdinal,
91 class Node>
92class FECrsGraph : public CrsGraph<LocalOrdinal, GlobalOrdinal, Node> {
94 typedef DistObject<GlobalOrdinal, LocalOrdinal, GlobalOrdinal, Node> dist_object_type;
95
96 template <class S, class LO, class GO, class N>
97 friend class FECrsMatrix;
98
99 public:
101 typedef CrsGraph<LocalOrdinal, GlobalOrdinal, Node> crs_graph_type;
102
104 typedef LocalOrdinal local_ordinal_type;
106 typedef GlobalOrdinal global_ordinal_type;
108 typedef Node node_type;
109
111 typedef typename CrsGraph<LocalOrdinal, GlobalOrdinal, Node>::device_type device_type;
113 typedef typename CrsGraph<LocalOrdinal, GlobalOrdinal, Node>::execution_space execution_space;
114
116 typedef typename CrsGraph<LocalOrdinal, GlobalOrdinal, Node>::local_graph_device_type local_graph_device_type;
117
119 using map_type = ::Tpetra::Map<LocalOrdinal, GlobalOrdinal, Node>;
121 using import_type = ::Tpetra::Import<LocalOrdinal, GlobalOrdinal, Node>;
123 using export_type = ::Tpetra::Export<LocalOrdinal, GlobalOrdinal, Node>;
124
126
127
151 FECrsGraph(const Teuchos::RCP<const map_type>& ownedRowMap,
152 const Teuchos::RCP<const map_type>& ownedPlusSharedRowMap,
153 const size_t maxNumEntriesPerRow,
154 const Teuchos::RCP<const import_type>& ownedPlusSharedToOwnedimporter = Teuchos::null,
155 const Teuchos::RCP<const map_type>& domainMap = Teuchos::null,
156 const Teuchos::RCP<const map_type>& ownedRangeMap = Teuchos::null,
157 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
158
185 FECrsGraph(const Teuchos::RCP<const map_type>& ownedRowMap,
186 const Teuchos::RCP<const map_type>& ownedPlusSharedRowMap,
187 const size_t maxNumEntriesPerRow,
188 const Teuchos::RCP<const map_type>& ownedPlusSharedDomainMap,
189 const Teuchos::RCP<const import_type>& ownedPlusSharedToOwnedimporter = Teuchos::null,
190 const Teuchos::RCP<const map_type>& ownedDomainMap = Teuchos::null,
191 const Teuchos::RCP<const map_type>& ownedRangeMap = Teuchos::null,
192 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
193
217 FECrsGraph(const Teuchos::RCP<const map_type>& ownedRowMap,
218 const Teuchos::RCP<const map_type>& ownedPlusSharedRowMap,
219 const Kokkos::DualView<const size_t*, device_type>& numEntPerRow,
220 const Teuchos::RCP<const import_type>& ownedPlusSharedToOwnedimporter = Teuchos::null,
221 const Teuchos::RCP<const map_type>& domainMap = Teuchos::null,
222 const Teuchos::RCP<const map_type>& ownedRangeMap = Teuchos::null,
223 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
224
251 FECrsGraph(const Teuchos::RCP<const map_type>& ownedRowMap,
252 const Teuchos::RCP<const map_type>& ownedPlusSharedRowMap,
253 const Kokkos::DualView<const size_t*, device_type>& numEntPerRow,
254 const Teuchos::RCP<const map_type>& ownedPlusSharedDomainMap,
255 const Teuchos::RCP<const import_type>& ownedPlusSharedToOwnedimporter = Teuchos::null,
256 const Teuchos::RCP<const map_type>& ownedDomainMap = Teuchos::null,
257 const Teuchos::RCP<const map_type>& ownedRangeMap = Teuchos::null,
258 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
259
285 FECrsGraph(const Teuchos::RCP<const map_type>& ownedRowMap,
286 const Teuchos::RCP<const map_type>& ownedPlusSharedRowMap,
287 const Teuchos::RCP<const map_type>& ownedPlusSharedColMap,
288 const size_t maxNumEntriesPerRow,
289 const Teuchos::RCP<const import_type>& ownedPlusSharedToOwnedimporter = Teuchos::null,
290 const Teuchos::RCP<const map_type>& domainMap = Teuchos::null,
291 const Teuchos::RCP<const map_type>& ownedRangeMap = Teuchos::null,
292 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
293
321 FECrsGraph(const Teuchos::RCP<const map_type>& ownedRowMap,
322 const Teuchos::RCP<const map_type>& ownedPlusSharedRowMap,
323 const Teuchos::RCP<const map_type>& ownedPlusSharedColMap,
324 const size_t maxNumEntriesPerRow,
325 const Teuchos::RCP<const map_type>& ownedPlusSharedDomainMap,
326 const Teuchos::RCP<const import_type>& ownedPlusSharedToOwnedimporter = Teuchos::null,
327 const Teuchos::RCP<const map_type>& ownedDomainMap = Teuchos::null,
328 const Teuchos::RCP<const map_type>& ownedRangeMap = Teuchos::null,
329 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
330
354 FECrsGraph(const Teuchos::RCP<const map_type>& ownedRowMap,
355 const Teuchos::RCP<const map_type>& ownedPlusSharedRowMap,
356 const Teuchos::RCP<const map_type>& ownedPlusSharedColMap,
357 const Kokkos::DualView<const size_t*, device_type>& numEntPerRow,
358 const Teuchos::RCP<const import_type>& ownedPlusSharedToOwnedimporter = Teuchos::null,
359 const Teuchos::RCP<const map_type>& domainMap = Teuchos::null,
360 const Teuchos::RCP<const map_type>& ownedRangeMap = Teuchos::null,
361 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
362
387 FECrsGraph(const Teuchos::RCP<const map_type>& ownedRowMap,
388 const Teuchos::RCP<const map_type>& ownedPlusSharedRowMap,
389 const Teuchos::RCP<const map_type>& ownedPlusSharedColMap,
390 const Kokkos::DualView<const size_t*, device_type>& numEntPerRow,
391 const Teuchos::RCP<const map_type>& ownedPlusSharedDomainMap,
392 const Teuchos::RCP<const import_type>& ownedPlusSharedToOwnedimporter = Teuchos::null,
393 const Teuchos::RCP<const map_type>& ownedDomainMap = Teuchos::null,
394 const Teuchos::RCP<const map_type>& ownedRangeMap = Teuchos::null,
395 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
396
398 FECrsGraph(const FECrsGraph<LocalOrdinal, GlobalOrdinal, Node>&) = delete;
399
401 FECrsGraph(FECrsGraph<LocalOrdinal, GlobalOrdinal, Node>&&) = delete;
402
404 FECrsGraph&
405 operator=(const FECrsGraph<LocalOrdinal, GlobalOrdinal, Node>&) = delete;
406
408 FECrsGraph&
409 operator=(FECrsGraph<LocalOrdinal, GlobalOrdinal, Node>&&) = delete;
410
420 virtual ~FECrsGraph() = default;
421
423
425
426 Teuchos::RCP<const Teuchos::ParameterList>
427 getValidParameters() const override;
428
430
432
434 void endAssembly();
435 void endAssembly(const Teuchos::RCP<const map_type>& domainMap, const Teuchos::RCP<const map_type>& rangeMap);
436
438 void beginAssembly();
439
477 void
478 fillComplete(const Teuchos::RCP<const map_type>& ownedDomainMap,
479 const Teuchos::RCP<const map_type>& ownedRangeMap,
480 const Teuchos::RCP<Teuchos::ParameterList>& /* params */ = Teuchos::null) {
481 ownedDomainMap_ = ownedDomainMap;
482 ownedRangeMap_ = ownedRangeMap;
483 endFill();
484 }
485
513 void
514 fillComplete(const Teuchos::RCP<Teuchos::ParameterList>& /* params */ = Teuchos::null) { endFill(); }
515
516 private:
518 void endFill();
519 void endFill(const Teuchos::RCP<const map_type>& domainMap, const Teuchos::RCP<const map_type>& rangeMap);
520
522 void beginFill();
523
527 void doOwnedPlusSharedToOwned(const CombineMode CM = Tpetra::ADD);
528
531 void doOwnedToOwnedPlusShared(const CombineMode CM = Tpetra::ADD);
532
533 public:
535 void switchActiveCrsGraph();
537
538 private:
539 // Common core guts of the constructor (the colMap argument is Teuchos::null if we're globally-indexed)
540 void setup(const Teuchos::RCP<const map_type>& ownedRowMap, const Teuchos::RCP<const map_type>& ownedPlusSharedRowMap, const Teuchos::RCP<const map_type>& ownedPlusSharedColMap, const Teuchos::RCP<Teuchos::ParameterList>& params);
541
542 // Template to avoid long type names...lazy.
543 // template<typename ViewType>
544 // Teuchos::RCP<const map_type> makeOwnedColMap (ViewType ownedGraphIndices);
545
546 Teuchos::RCP<FE::FillState> fillState_;
547
548 // This is whichever graph isn't currently active
549 Teuchos::RCP<CrsGraph<LocalOrdinal, GlobalOrdinal, Node> > inactiveCrsGraph_;
550
551 // This is in RCP to make shallow copies of the FECrsGraph work correctly
552 Teuchos::RCP<FE::WhichActive> activeCrsGraph_;
553
554 // The importer between the rowmaps of the two graphs
555 Teuchos::RCP<const import_type> ownedRowsImporter_;
556
557 // The domainMap to use in endFill() for the owned graph
558 Teuchos::RCP<const map_type> ownedDomainMap_;
559
560 // The rangeMap to use in endFill() for the owned graph
561 Teuchos::RCP<const map_type> ownedRangeMap_;
562
563 protected:
573 size_t
574 insertGlobalIndicesImpl(const local_ordinal_type lclRow,
575 const global_ordinal_type inputGblColInds[],
576 const size_t numInputInds);
577
587 size_t
588 insertGlobalIndicesImpl(const RowInfo& rowInfo,
589 const global_ordinal_type inputGblColInds[],
590 const size_t numInputInds,
591 std::function<void(const size_t, const size_t, const size_t)> fun =
592 std::function<void(const size_t, const size_t, const size_t)>());
593
594 void
595 insertLocalIndicesImpl(const local_ordinal_type lclRow,
596 const Teuchos::ArrayView<const local_ordinal_type>& gblColInds,
597 std::function<void(const size_t, const size_t, const size_t)> fun =
598 std::function<void(const size_t, const size_t, const size_t)>());
599
600}; // class FECrsGraph
601
602} // namespace Tpetra
603
604#endif // TPETRA_FECRSGRAPH_DECL_HPP
Tpetra_CrsGraph_decl.hpp
Declaration of the Tpetra::CrsGraph class.
Tpetra_FECrsGraph_fwd.hpp
Forward declaration of Tpetra::FECrsGraph.
Tpetra::CrsGraph
A distributed graph accessed by rows (adjacency lists) and stored sparsely.
Definition Tpetra_CrsGraph_decl.hpp:195
Tpetra::CrsGraph::device_type
typename Node::device_type device_type
This class' Kokkos device type.
Definition Tpetra_CrsGraph_decl.hpp:212
Tpetra::CrsGraph::local_graph_device_type
KokkosSparse::StaticCrsGraph< local_ordinal_type, Kokkos::LayoutLeft, device_type, void, size_t > local_graph_device_type
The type of the part of the sparse graph on each MPI process.
Definition Tpetra_CrsGraph_decl.hpp:225
Tpetra::CrsGraph::execution_space
typename device_type::execution_space execution_space
This class' Kokkos execution space.
Definition Tpetra_CrsGraph_decl.hpp:214
Tpetra::CrsMatrixStruct
Struct that holds views of the contents of a CrsMatrix.
Definition TpetraExt_MMHelpers_decl.hpp:36
Tpetra::Export
Communication plan for data redistribution from a (possibly) multiply-owned to a uniquely-owned distr...
Definition Tpetra_Export_decl.hpp:86
Tpetra::FECrsGraph
A distributed graph accessed by rows (adjacency lists) and stored sparsely.
Definition Tpetra_FECrsGraph_decl.hpp:92
Tpetra::FECrsGraph::device_type
CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::device_type device_type
The Kokkos device type.
Definition Tpetra_FECrsGraph_decl.hpp:111
Tpetra::FECrsGraph::endAssembly
void endAssembly()
Migrates data to the owned mode.
Definition Tpetra_FECrsGraph_def.hpp:369
Tpetra::FECrsGraph::crs_graph_type
CrsGraph< LocalOrdinal, GlobalOrdinal, Node > crs_graph_type
Parent class.
Definition Tpetra_FECrsGraph_decl.hpp:101
Tpetra::FECrsGraph::getValidParameters
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters() const override
Default parameter list suitable for validation.
Definition Tpetra_FECrsGraph_def.hpp:394
Tpetra::FECrsGraph::FECrsGraph
FECrsGraph(const FECrsGraph< LocalOrdinal, GlobalOrdinal, Node > &)=delete
Copy constructor (forbidden).
Tpetra::FECrsGraph::beginAssembly
void beginAssembly()
Activates the owned+shared mode for assembly.
Definition Tpetra_FECrsGraph_def.hpp:358
Tpetra::FECrsGraph::operator=
FECrsGraph & operator=(const FECrsGraph< LocalOrdinal, GlobalOrdinal, Node > &)=delete
Copy assignment (forbidden).
Tpetra::FECrsGraph::switchActiveCrsGraph
void switchActiveCrsGraph()
Switches which CrsGraph is active (without migrating data)
Definition Tpetra_FECrsGraph_def.hpp:290
Tpetra::FECrsGraph::fillComplete
void fillComplete(const Teuchos::RCP< Teuchos::ParameterList > &=Teuchos::null)
Tell the graph that you are done changing its structure; set default domain and range Maps.
Definition Tpetra_FECrsGraph_decl.hpp:514
Tpetra::FECrsGraph::local_ordinal_type
LocalOrdinal local_ordinal_type
This class' first template parameter; the type of local indices.
Definition Tpetra_FECrsGraph_decl.hpp:104
Tpetra::FECrsGraph::insertGlobalIndicesImpl
size_t insertGlobalIndicesImpl(const local_ordinal_type lclRow, const global_ordinal_type inputGblColInds[], const size_t numInputInds)
Insert global indices, using an input local row index.
Definition Tpetra_FECrsGraph_def.hpp:404
Tpetra::FECrsGraph::local_graph_device_type
CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::local_graph_device_type local_graph_device_type
The type of the part of the sparse graph on each MPI process.
Definition Tpetra_FECrsGraph_decl.hpp:116
Tpetra::FECrsGraph::FECrsGraph
FECrsGraph(FECrsGraph< LocalOrdinal, GlobalOrdinal, Node > &&)=delete
Move constructor (forbidden).
Tpetra::FECrsGraph::fillComplete
void fillComplete(const Teuchos::RCP< const map_type > &ownedDomainMap, const Teuchos::RCP< const map_type > &ownedRangeMap, const Teuchos::RCP< Teuchos::ParameterList > &=Teuchos::null)
Tell the graph that you are done changing its structure.
Definition Tpetra_FECrsGraph_decl.hpp:478
Tpetra::FECrsGraph::~FECrsGraph
virtual ~FECrsGraph()=default
Destructor (virtual for memory safety of derived classes).
Tpetra::FECrsGraph::node_type
Node node_type
This class' Kokkos Node type.
Definition Tpetra_FECrsGraph_decl.hpp:108
Tpetra::FECrsGraph::operator=
FECrsGraph & operator=(FECrsGraph< LocalOrdinal, GlobalOrdinal, Node > &&)=delete
Move assignment (forbidden).
Tpetra::FECrsGraph::execution_space
CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::execution_space execution_space
The Kokkos execution space.
Definition Tpetra_FECrsGraph_decl.hpp:113
Tpetra::FECrsGraph::global_ordinal_type
GlobalOrdinal global_ordinal_type
This class' second template parameter; the type of global indices.
Definition Tpetra_FECrsGraph_decl.hpp:106
Tpetra::FECrsMatrix
Sparse matrix that presents a row-oriented interface that lets users read or modify entries.
Definition Tpetra_FECrsMatrix_decl.hpp:29
Tpetra::Import
Communication plan for data redistribution from a uniquely-owned to a (possibly) multiply-owned distr...
Definition Tpetra_Import_decl.hpp:77
Tpetra::Map
A parallel distribution of indices over processes.
Definition Tpetra_Map_decl.hpp:197
Tpetra
Namespace Tpetra contains the class and methods constituting the Tpetra library.
Tpetra::CombineMode
CombineMode
Rule for combining data in an Import or Export.
Definition Tpetra_CombineMode.hpp:65
Tpetra::ADD
@ ADD
Sum new values.
Definition Tpetra_CombineMode.hpp:66
Tpetra::RowInfo
Allocation information for a locally owned row in a CrsGraph or CrsMatrix.
Definition Tpetra_CrsGraph_decl.hpp:78
Generated by doxygen 1.9.8