Xpetra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Static Public Member Functions | Private Member Functions | List of all members
Xpetra::CrsGraphFactory< LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

#include <Xpetra_CrsGraphFactory.hpp>

Static Public Member Functions

static Teuchos::RCP< CrsGraph
< LocalOrdinal, GlobalOrdinal,
Node > > 		Build (const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &rowMap)
 Constructor for empty graph (intended use is an import/export target - can't insert entries directly) More...
 
static Teuchos::RCP< CrsGraph
< LocalOrdinal, GlobalOrdinal,
Node > > 		Build (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &map, size_t maxNumEntriesPerRow)
 Constructor specifying the number of non-zeros for all rows. More...
 
static Teuchos::RCP< CrsGraph
< LocalOrdinal, GlobalOrdinal,
Node > > 		Build (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &rowMap, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &colMap, size_t maxNumEntriesPerRow, const Teuchos::RCP< Teuchos::ParameterList > &plist=Teuchos::null)
 Constructor specifying column Map and number of entries per row. More...
 
static Teuchos::RCP< CrsGraph
< LocalOrdinal, GlobalOrdinal,
Node > > 		Build (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &rowMap, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &colMap, const ArrayRCP< const size_t > &NumEntriesPerRowToAlloc, const Teuchos::RCP< Teuchos::ParameterList > &plist=Teuchos::null)
 Constructor specifying column Map and number of entries in each row. More...
 
static Teuchos::RCP< CrsGraph
< LocalOrdinal, GlobalOrdinal,
Node > > 		Build (const RCP< const CrsGraph< LocalOrdinal, GlobalOrdinal, Node >> &sourceGraph, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &domainMap=Teuchos::null, const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &rangeMap=Teuchos::null, const RCP< Teuchos::ParameterList > &params=Teuchos::null)
 Constructor using fused import. More...
 
static Teuchos::RCP< CrsGraph
< LocalOrdinal, GlobalOrdinal,
Node > > 		Build (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &rowMap, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &colMap, const typename Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::local_graph_type::row_map_type &rowPointers, const typename Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::local_graph_type::entries_type::non_const_type &columnIndices, const Teuchos::RCP< Teuchos::ParameterList > &plist=Teuchos::null)
 Constructor specifying column Map and arrays containing the graph in sorted, local ids. More...
 
static Teuchos::RCP< CrsGraph
< LocalOrdinal, GlobalOrdinal,
Node > > 		Build (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &rowMap, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &colMap, const typename Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::local_graph_type &lclGraph, const Teuchos::RCP< Teuchos::ParameterList > &params)
 Constructor specifying column Map and a local (sorted) graph, which the resulting CrsGraph views. More...
 
static Teuchos::RCP< CrsGraph
< LocalOrdinal, GlobalOrdinal,
Node > > 		Build (const typename Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::local_graph_type &lclGraph, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &rowMap, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &colMap, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &domainMap=Teuchos::null, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &rangeMap=Teuchos::null, const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null)
 Constructor specifying column, domain and range maps, and a local (sorted) graph, which the resulting CrsGraph views. More...
 
static Teuchos::RCP< CrsGraph
< LocalOrdinal, GlobalOrdinal,
Node > > 		Build (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &rowMap, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &colMap, const Teuchos::ArrayRCP< size_t > &rowPointers, const Teuchos::ArrayRCP< LocalOrdinal > &columnIndices, const Teuchos::RCP< Teuchos::ParameterList > &plist=Teuchos::null)
 Constructor specifying column Map and arrays containing the graph in sorted, local ids. More...
 

Private Member Functions

 CrsGraphFactory ()
 Private constructor. This is a static class. More...
 

Detailed Description

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
class Xpetra::CrsGraphFactory< LocalOrdinal, GlobalOrdinal, Node >

Definition at line 32 of file Xpetra_CrsGraphFactory.hpp.

Constructor & Destructor Documentation

template<class LocalOrdinal , class GlobalOrdinal , class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
Xpetra::CrsGraphFactory< LocalOrdinal, GlobalOrdinal, Node >::CrsGraphFactory ( )
inlineprivate

Private constructor. This is a static class.

Definition at line 35 of file Xpetra_CrsGraphFactory.hpp.

Member Function Documentation

template<class LocalOrdinal , class GlobalOrdinal , class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
static Teuchos::RCP<CrsGraph<LocalOrdinal, GlobalOrdinal, Node> > Xpetra::CrsGraphFactory< LocalOrdinal, GlobalOrdinal, Node >::Build ( const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &  rowMap)
inlinestatic

Constructor for empty graph (intended use is an import/export target - can't insert entries directly)

Definition at line 40 of file Xpetra_CrsGraphFactory.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
static Teuchos::RCP<CrsGraph<LocalOrdinal, GlobalOrdinal, Node> > Xpetra::CrsGraphFactory< LocalOrdinal, GlobalOrdinal, Node >::Build ( const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &  map,
size_t  maxNumEntriesPerRow 
)
inlinestatic

Constructor specifying the number of non-zeros for all rows.

Definition at line 53 of file Xpetra_CrsGraphFactory.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
static Teuchos::RCP<CrsGraph<LocalOrdinal, GlobalOrdinal, Node> > Xpetra::CrsGraphFactory< LocalOrdinal, GlobalOrdinal, Node >::Build ( const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &  rowMap,
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &  colMap,
size_t  maxNumEntriesPerRow,
const Teuchos::RCP< Teuchos::ParameterList > &  plist = Teuchos::null 
)
inlinestatic

Constructor specifying column Map and number of entries per row.

Definition at line 68 of file Xpetra_CrsGraphFactory.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
static Teuchos::RCP<CrsGraph<LocalOrdinal, GlobalOrdinal, Node> > Xpetra::CrsGraphFactory< LocalOrdinal, GlobalOrdinal, Node >::Build ( const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &  rowMap,
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &  colMap,
const ArrayRCP< const size_t > &  NumEntriesPerRowToAlloc,
const Teuchos::RCP< Teuchos::ParameterList > &  plist = Teuchos::null 
)
inlinestatic

Constructor specifying column Map and number of entries in each row.

Definition at line 86 of file Xpetra_CrsGraphFactory.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
static Teuchos::RCP<CrsGraph<LocalOrdinal, GlobalOrdinal, Node> > Xpetra::CrsGraphFactory< LocalOrdinal, GlobalOrdinal, Node >::Build ( const RCP< const CrsGraph< LocalOrdinal, GlobalOrdinal, Node >> &  sourceGraph,
const Import< LocalOrdinal, GlobalOrdinal, Node > &  importer,
const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &  domainMap = Teuchos::null,
const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &  rangeMap = Teuchos::null,
const RCP< Teuchos::ParameterList > &  params = Teuchos::null 
)
inlinestatic

Constructor using fused import.

Definition at line 104 of file Xpetra_CrsGraphFactory.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
static Teuchos::RCP<CrsGraph<LocalOrdinal, GlobalOrdinal, Node> > Xpetra::CrsGraphFactory< LocalOrdinal, GlobalOrdinal, Node >::Build ( const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &  rowMap,
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &  colMap,
const typename Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::local_graph_type::row_map_type &  rowPointers,
const typename Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::local_graph_type::entries_type::non_const_type &  columnIndices,
const Teuchos::RCP< Teuchos::ParameterList > &  plist = Teuchos::null 
)
inlinestatic

Constructor specifying column Map and arrays containing the graph in sorted, local ids.

Parameters
rowMap[in] Distribution of rows of the graph.
colMap[in] Distribution of columns of the graph.
rowPointers[in] The beginning of each row in the graph, as in a CSR "rowptr" array. The length of this vector should be equal to the number of rows in the graph, plus one. This last entry should store the nunber of nonzeros in the graph.
columnIndices[in] The local indices of the columns, as in a CSR "colind" array. The length of this vector should be equal to the number of unknowns in the graph.
params[in/out] Optional list of parameters. If not null, any missing parameters will be filled in with their default values.

Definition at line 140 of file Xpetra_CrsGraphFactory.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
static Teuchos::RCP<CrsGraph<LocalOrdinal, GlobalOrdinal, Node> > Xpetra::CrsGraphFactory< LocalOrdinal, GlobalOrdinal, Node >::Build ( const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &  rowMap,
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &  colMap,
const typename Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::local_graph_type &  lclGraph,
const Teuchos::RCP< Teuchos::ParameterList > &  params 
)
inlinestatic

Constructor specifying column Map and a local (sorted) graph, which the resulting CrsGraph views.

Unlike most other CrsGraph constructors, successful completion of this constructor will result in a fill-complete graph.

Parameters
rowMap[in] Distribution of rows of the graph.
colMap[in] Distribution of columns of the graph.
lclGraph[in] A locally indexed Kokkos::StaticCrsGraph whose local row indices come from the specified row Map, and whose local column indices come from the specified column Map.
params[in/out] Optional list of parameters. If not null, any missing parameters will be filled in with their default values.

Definition at line 176 of file Xpetra_CrsGraphFactory.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
static Teuchos::RCP<CrsGraph<LocalOrdinal, GlobalOrdinal, Node> > Xpetra::CrsGraphFactory< LocalOrdinal, GlobalOrdinal, Node >::Build ( const typename Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >::local_graph_type &  lclGraph,
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &  rowMap,
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &  colMap,
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &  domainMap = Teuchos::null,
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &  rangeMap = Teuchos::null,
const Teuchos::RCP< Teuchos::ParameterList > &  params = Teuchos::null 
)
inlinestatic

Constructor specifying column, domain and range maps, and a local (sorted) graph, which the resulting CrsGraph views.

Unlike most other CrsGraph constructors, successful completion of this constructor will result in a fill-complete graph.

Parameters
rowMap[in] Distribution of rows of the graph.
colMap[in] Distribution of columns of the graph.
domainMap[in] The graph's domain Map. MUST be one to one!
rangeMap[in] The graph's range Map. MUST be one to one! May be, but need not be, the same as the domain Map.
lclGraph[in] A locally indexed Kokkos::StaticCrsGraph whose local row indices come from the specified row Map, and whose local column indices come from the specified column Map.
params[in/out] Optional list of parameters. If not null, any missing parameters will be filled in with their default values.

Definition at line 216 of file Xpetra_CrsGraphFactory.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
static Teuchos::RCP<CrsGraph<LocalOrdinal, GlobalOrdinal, Node> > Xpetra::CrsGraphFactory< LocalOrdinal, GlobalOrdinal, Node >::Build ( const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &  rowMap,
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &  colMap,
const Teuchos::ArrayRCP< size_t > &  rowPointers,
const Teuchos::ArrayRCP< LocalOrdinal > &  columnIndices,
const Teuchos::RCP< Teuchos::ParameterList > &  plist = Teuchos::null 
)
inlinestatic

Constructor specifying column Map and arrays containing the graph in sorted, local ids.

Parameters
rowMap[in] Distribution of rows of the graph.
colMap[in] Distribution of columns of the graph.
rowPointers[in] The beginning of each row in the graph, as in a CSR "rowptr" array. The length of this vector should be equal to the number of rows in the graph, plus one. This last entry should store the nunber of nonzeros in the graph.
columnIndices[in] The local indices of the columns, as in a CSR "colind" array. The length of this vector should be equal to the number of unknowns in the graph.
params[in/out] Optional list of parameters. If not null, any missing parameters will be filled in with their default values.

Definition at line 256 of file Xpetra_CrsGraphFactory.hpp.

The documentation for this class was generated from the following file: