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//
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_FECRSGRAPH_DECL_HPP
43#define TPETRA_FECRSGRAPH_DECL_HPP
44
47
48#include "Tpetra_FECrsGraph_fwd.hpp"
49#include "Tpetra_CrsGraph_decl.hpp"
50
51namespace Tpetra {
119
120 template <class LocalOrdinal,
121 class GlobalOrdinal,
122 class Node>
123 class FECrsGraph :
124 public CrsGraph<LocalOrdinal, GlobalOrdinal, Node>
125 {
127 typedef DistObject<GlobalOrdinal, LocalOrdinal, GlobalOrdinal, Node> dist_object_type;
128
129 template <class S, class LO, class GO, class N>
130 friend class FECrsMatrix;
131 public:
133 typedef CrsGraph<LocalOrdinal, GlobalOrdinal, Node> crs_graph_type;
134
136 typedef LocalOrdinal local_ordinal_type;
138 typedef GlobalOrdinal global_ordinal_type;
140 typedef Node node_type;
141
143 typedef typename CrsGraph<LocalOrdinal, GlobalOrdinal, Node>::device_type device_type;
145 typedef typename CrsGraph<LocalOrdinal, GlobalOrdinal, Node>::execution_space execution_space;
146
148 typedef typename CrsGraph<LocalOrdinal, GlobalOrdinal, Node>::local_graph_device_type local_graph_device_type;
149
151 using map_type = ::Tpetra::Map<LocalOrdinal, GlobalOrdinal, Node>;
153 using import_type = ::Tpetra::Import<LocalOrdinal, GlobalOrdinal, Node>;
155 using export_type = ::Tpetra::Export<LocalOrdinal, GlobalOrdinal, Node>;
156
158
159
183 FECrsGraph(const Teuchos::RCP<const map_type> & ownedRowMap,
184 const Teuchos::RCP<const map_type> & ownedPlusSharedRowMap,
185 const size_t maxNumEntriesPerRow,
186 const Teuchos::RCP<const import_type> & ownedPlusSharedToOwnedimporter = Teuchos::null,
187 const Teuchos::RCP<const map_type> & domainMap = Teuchos::null,
188 const Teuchos::RCP<const map_type> & ownedRangeMap = Teuchos::null,
189 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
190
217 FECrsGraph (const Teuchos::RCP<const map_type> & ownedRowMap,
218 const Teuchos::RCP<const map_type> & ownedPlusSharedRowMap,
219 const size_t maxNumEntriesPerRow,
220 const Teuchos::RCP<const map_type> & ownedPlusSharedDomainMap,
221 const Teuchos::RCP<const import_type> & ownedPlusSharedToOwnedimporter = Teuchos::null,
222 const Teuchos::RCP<const map_type> & ownedDomainMap = Teuchos::null,
223 const Teuchos::RCP<const map_type> & ownedRangeMap = Teuchos::null,
224 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
225
249 FECrsGraph (const Teuchos::RCP<const map_type> & ownedRowMap,
250 const Teuchos::RCP<const map_type> & ownedPlusSharedRowMap,
251 const Kokkos::DualView<const size_t*, device_type>& numEntPerRow,
252 const Teuchos::RCP<const import_type> & ownedPlusSharedToOwnedimporter = Teuchos::null,
253 const Teuchos::RCP<const map_type> & domainMap = Teuchos::null,
254 const Teuchos::RCP<const map_type> & ownedRangeMap = Teuchos::null,
255 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
256
283 FECrsGraph (const Teuchos::RCP<const map_type> & ownedRowMap,
284 const Teuchos::RCP<const map_type> & ownedPlusSharedRowMap,
285 const Kokkos::DualView<const size_t*, device_type>& numEntPerRow,
286 const Teuchos::RCP<const map_type> & ownedPlusSharedDomainMap,
287 const Teuchos::RCP<const import_type> & ownedPlusSharedToOwnedimporter = Teuchos::null,
288 const Teuchos::RCP<const map_type> & ownedDomainMap = Teuchos::null,
289 const Teuchos::RCP<const map_type> & ownedRangeMap = Teuchos::null,
290 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
291
292
318 FECrsGraph(const Teuchos::RCP<const map_type> & ownedRowMap,
319 const Teuchos::RCP<const map_type> & ownedPlusSharedRowMap,
320 const Teuchos::RCP<const map_type> & ownedPlusSharedColMap,
321 const size_t maxNumEntriesPerRow,
322 const Teuchos::RCP<const import_type> & ownedPlusSharedToOwnedimporter = Teuchos::null,
323 const Teuchos::RCP<const map_type> & domainMap = Teuchos::null,
324 const Teuchos::RCP<const map_type> & ownedRangeMap = Teuchos::null,
325 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
326
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 size_t maxNumEntriesPerRow,
358 const Teuchos::RCP<const map_type> & ownedPlusSharedDomainMap,
359 const Teuchos::RCP<const import_type> & ownedPlusSharedToOwnedimporter = Teuchos::null,
360 const Teuchos::RCP<const map_type> & ownedDomainMap = Teuchos::null,
361 const Teuchos::RCP<const map_type> & ownedRangeMap = Teuchos::null,
362 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
363
364
388 FECrsGraph (const Teuchos::RCP<const map_type> & ownedRowMap,
389 const Teuchos::RCP<const map_type> & ownedPlusSharedRowMap,
390 const Teuchos::RCP<const map_type> & ownedPlusSharedColMap,
391 const Kokkos::DualView<const size_t*, device_type>& numEntPerRow,
392 const Teuchos::RCP<const import_type> & ownedPlusSharedToOwnedimporter = Teuchos::null,
393 const Teuchos::RCP<const map_type> & domainMap = Teuchos::null,
394 const Teuchos::RCP<const map_type> & ownedRangeMap = Teuchos::null,
395 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
396
421 FECrsGraph (const Teuchos::RCP<const map_type> & ownedRowMap,
422 const Teuchos::RCP<const map_type> & ownedPlusSharedRowMap,
423 const Teuchos::RCP<const map_type> & ownedPlusSharedColMap,
424 const Kokkos::DualView<const size_t*, device_type>& numEntPerRow,
425 const Teuchos::RCP<const map_type> & ownedPlusSharedDomainMap,
426 const Teuchos::RCP<const import_type> & ownedPlusSharedToOwnedimporter = Teuchos::null,
427 const Teuchos::RCP<const map_type> & ownedDomainMap = Teuchos::null,
428 const Teuchos::RCP<const map_type> & ownedRangeMap = Teuchos::null,
429 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
430
432 FECrsGraph (const FECrsGraph<LocalOrdinal, GlobalOrdinal, Node>&) = delete;
433
435 FECrsGraph (FECrsGraph<LocalOrdinal, GlobalOrdinal, Node>&&) = delete;
436
438 FECrsGraph&
439 operator= (const FECrsGraph<LocalOrdinal, GlobalOrdinal, Node>&) = delete;
440
442 FECrsGraph&
443 operator= (FECrsGraph<LocalOrdinal, GlobalOrdinal, Node>&&) = delete;
444
454 virtual ~FECrsGraph () = default;
455
457
459
460 Teuchos::RCP<const Teuchos::ParameterList>
461 getValidParameters () const override;
462
464
466
468 void endAssembly();
469 void endAssembly(const Teuchos::RCP<const map_type>& domainMap, const Teuchos::RCP<const map_type>& rangeMap);
470
472 void beginAssembly();
473
511 void
512 fillComplete (const Teuchos::RCP<const map_type>& ownedDomainMap,
513 const Teuchos::RCP<const map_type>& ownedRangeMap,
514 const Teuchos::RCP<Teuchos::ParameterList>& /* params */ = Teuchos::null) {
515 ownedDomainMap_ = ownedDomainMap;
516 ownedRangeMap_ = ownedRangeMap;
517 endFill();
518 }
519
547 void
548 fillComplete (const Teuchos::RCP<Teuchos::ParameterList>& /* params */ = Teuchos::null) {endFill();}
549
550
551 private:
552
554 void endFill();
555 void endFill(const Teuchos::RCP<const map_type>& domainMap, const Teuchos::RCP<const map_type>& rangeMap);
556
558 void beginFill();
559
563 void doOwnedPlusSharedToOwned(const CombineMode CM=Tpetra::ADD);
564
567 void doOwnedToOwnedPlusShared(const CombineMode CM=Tpetra::ADD);
568
569 public:
571 void switchActiveCrsGraph();
573
574 private:
575
576 // Common core guts of the constructor (the colMap argument is Teuchos::null if we're globally-indexed)
577 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);
578
579 // Template to avoid long type names...lazy.
580 // template<typename ViewType>
581 // Teuchos::RCP<const map_type> makeOwnedColMap (ViewType ownedGraphIndices);
582
583 // Enum for activity
584 enum FEWhichActive
585 {
586 FE_ACTIVE_OWNED,
587 FE_ACTIVE_OWNED_PLUS_SHARED
588 };
589
590 enum class FillState
591 {
592 open, // matrix is "open". Values can freely inserted
593 closed
594 };
595 Teuchos::RCP<FillState> fillState_;
596
597 // This is whichever graph isn't currently active
598 Teuchos::RCP<CrsGraph<LocalOrdinal, GlobalOrdinal, Node> > inactiveCrsGraph_;
599
600 // This is in RCP to make shallow copies of the FECrsGraph work correctly
601 Teuchos::RCP<FEWhichActive> activeCrsGraph_;
602
603 // The importer between the rowmaps of the two graphs
604 Teuchos::RCP<const import_type> ownedRowsImporter_;
605
606 // The domainMap to use in endFill() for the owned graph
607 Teuchos::RCP<const map_type> ownedDomainMap_;
608
609 // The rangeMap to use in endFill() for the owned graph
610 Teuchos::RCP<const map_type> ownedRangeMap_;
611
612 protected:
622 size_t
623 insertGlobalIndicesImpl (const local_ordinal_type lclRow,
624 const global_ordinal_type inputGblColInds[],
625 const size_t numInputInds);
626
636 size_t
637 insertGlobalIndicesImpl (const RowInfo& rowInfo,
638 const global_ordinal_type inputGblColInds[],
639 const size_t numInputInds,
640 std::function<void(const size_t, const size_t, const size_t)> fun =
641 std::function<void(const size_t, const size_t, const size_t)>());
642
643 void
644 insertLocalIndicesImpl (const local_ordinal_type lclRow,
645 const Teuchos::ArrayView<const local_ordinal_type>& gblColInds,
646 std::function<void(const size_t, const size_t, const size_t)> fun =
647 std::function<void(const size_t, const size_t, const size_t)>());
648
649 }; // class FECrsGraph
650
651
652} // namespace Tpetra
653
654#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::device_type
typename Node::device_type device_type
This class' Kokkos device type.
Definition Tpetra_CrsGraph_decl.hpp:243
Tpetra::CrsGraph::execution_space
typename device_type::execution_space execution_space
This class' Kokkos execution space.
Definition Tpetra_CrsGraph_decl.hpp:245
Tpetra::CrsGraph::local_graph_device_type
Kokkos::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:254
Tpetra::DistObject
Base class for distributed Tpetra objects that support data redistribution.
Definition Tpetra_DistObject_decl.hpp:325
Tpetra::Export
Communication plan for data redistribution from a (possibly) multiply-owned to a uniquely-owned distr...
Definition Tpetra_Export_decl.hpp:119
Tpetra::FECrsGraph::device_type
CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::device_type device_type
The Kokkos device type.
Definition Tpetra_FECrsGraph_decl.hpp:143
Tpetra::FECrsGraph::endAssembly
void endAssembly()
Migrates data to the owned mode.
Definition Tpetra_FECrsGraph_def.hpp:417
Tpetra::FECrsGraph::crs_graph_type
CrsGraph< LocalOrdinal, GlobalOrdinal, Node > crs_graph_type
Parent class.
Definition Tpetra_FECrsGraph_decl.hpp:133
Tpetra::FECrsGraph::getValidParameters
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters() const override
Default parameter list suitable for validation.
Definition Tpetra_FECrsGraph_def.hpp:445
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:405
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:330
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:548
Tpetra::FECrsGraph::local_ordinal_type
LocalOrdinal local_ordinal_type
This class' first template parameter; the type of local indices.
Definition Tpetra_FECrsGraph_decl.hpp:136
Tpetra::FECrsGraph::map_type
::Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > map_type
The Map specialization used by this class.
Definition Tpetra_FECrsGraph_decl.hpp:151
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:456
Tpetra::FECrsGraph::FECrsGraph
FECrsGraph(const Teuchos::RCP< const map_type > &ownedRowMap, const Teuchos::RCP< const map_type > &ownedPlusSharedRowMap, const size_t maxNumEntriesPerRow, const Teuchos::RCP< const import_type > &ownedPlusSharedToOwnedimporter=Teuchos::null, const Teuchos::RCP< const map_type > &domainMap=Teuchos::null, const Teuchos::RCP< const map_type > &ownedRangeMap=Teuchos::null, const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null)
Constructorfor globally-indexed assembly specifying a single upper bound for the number of entries in...
Definition Tpetra_FECrsGraph_def.hpp:56
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:148
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:512
Tpetra::FECrsGraph::~FECrsGraph
virtual ~FECrsGraph()=default
Destructor (virtual for memory safety of derived classes).
Tpetra::FECrsGraph::import_type
::Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > import_type
The Import specialization used by this class.
Definition Tpetra_FECrsGraph_decl.hpp:153
Tpetra::FECrsGraph::node_type
Node node_type
This class' Kokkos Node type.
Definition Tpetra_FECrsGraph_decl.hpp:140
Tpetra::FECrsGraph::export_type
::Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node > export_type
The Export specialization used by this class.
Definition Tpetra_FECrsGraph_decl.hpp:155
Tpetra::FECrsGraph::execution_space
CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::execution_space execution_space
The Kokkos execution space.
Definition Tpetra_FECrsGraph_decl.hpp:145
Tpetra::FECrsGraph::global_ordinal_type
GlobalOrdinal global_ordinal_type
This class' second template parameter; the type of global indices.
Definition Tpetra_FECrsGraph_decl.hpp:138
Tpetra::Import
Communication plan for data redistribution from a uniquely-owned to a (possibly) multiply-owned distr...
Definition Tpetra_Import_decl.hpp:111
Tpetra::Map
A parallel distribution of indices over processes.
Definition Tpetra_Map_decl.hpp:228
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:97
Tpetra::ADD
@ ADD
Sum new values.
Definition Tpetra_CombineMode.hpp:98
Generated by doxygen 1.17.0