Zoltan2
|
MeshAdapter defines the interface for mesh input. More...
#include <Zoltan2_MeshAdapter.hpp>
Public Member Functions | |
enum BaseAdapterType | adapterType () const override |
Returns the type of adapter. More... | |
MeshAdapter () | |
virtual bool | areEntityIDsUnique (MeshEntityType etype) const |
Provide a pointer to the entity topology types. More... | |
virtual size_t | getLocalNumOf (MeshEntityType etype) const =0 |
Returns the global number of mesh entities of MeshEntityType. More... | |
virtual void | getIDsViewOf (MeshEntityType etype, gno_t const *&Ids) const =0 |
Provide a pointer to this process' identifiers. More... | |
virtual void | getTopologyViewOf (MeshEntityType etype, enum EntityTopologyType const *&Types) const |
Provide a pointer to the entity topology types. More... | |
virtual int | getNumWeightsPerOf (MeshEntityType etype) const |
Return the number of weights per entity. More... | |
virtual void | getWeightsViewOf (MeshEntityType etype, const scalar_t *&weights, int &stride, int idx=0) const |
Provide a pointer to one of the number of this process' optional entity weights. More... | |
virtual int | getDimension () const |
Return dimension of the entity coordinates, if any. More... | |
virtual void | getCoordinatesViewOf (MeshEntityType etype, const scalar_t *&coords, int &stride, int coordDim) const |
Provide a pointer to one dimension of entity coordinates. More... | |
virtual bool | availAdjs (MeshEntityType source, MeshEntityType target) const |
Returns whether a first adjacency combination is available. More... | |
virtual size_t | getLocalNumAdjs (MeshEntityType source, MeshEntityType target) const |
Returns the number of first adjacencies on this process. More... | |
virtual void | getAdjsView (MeshEntityType source, MeshEntityType target, const offset_t *&offsets, const gno_t *&adjacencyIds) const |
Sets pointers to this process' mesh first adjacencies. More... | |
virtual bool | avail2ndAdjs (MeshEntityType sourcetarget, MeshEntityType through) const |
Returns whether a second adjacency combination is available. If combination is not available in the MeshAdapter, Zoltan2 will compute them, using A^T A, where A is matrix of first adjacencies. More... | |
virtual size_t | getLocalNum2ndAdjs (MeshEntityType sourcetarget, MeshEntityType through) const |
if avail2ndAdjs(), returns the number of second adjacencies on this process. More... | |
virtual void | get2ndAdjsView (MeshEntityType sourcetarget, MeshEntityType through, const offset_t *&offsets, const gno_t *&adjacencyIds) const |
if avail2ndAdjs(), set pointers to this process' second adjacencies More... | |
virtual int | getNumWeightsPer2ndAdj (MeshEntityType sourcetarget, MeshEntityType through) const |
Returns the number (0 or greater) of weights per second adjacency. Note: second-adjacency weights may be used only if avail2ndAdjs(). More... | |
virtual void | get2ndAdjWeightsView (MeshEntityType sourcetarget, MeshEntityType through, const scalar_t *&weights, int &stride, int idx) const |
Provide a pointer to the second adjacency weights, if any. Note: second-adjacency weights may be used only if avail2ndAdjs(). More... | |
enum MeshEntityType | getPrimaryEntityType () const |
Returns the entity to be partitioned, ordered, colored, etc. More... | |
enum MeshEntityType | getAdjacencyEntityType () const |
Returns the entity that describes adjacencies between the entities to be partitioned, ordered, colored, etc. That is, a primaryEntityType that contains an adjacencyEntityType are adjacent. More... | |
enum MeshEntityType | getSecondAdjacencyEntityType () const |
Returns the entity that describes second adjacencies between the entities to be partitioned, ordered, colored, etc. That is, two primaryEntityType that share a secondAdjacencyEntityType are adjacent. More... | |
void | setEntityTypes (std::string ptypestr, std::string atypestr, std::string satypestr) |
Sets the primary, adjacency, and second adjacency entity types. Called by algorithm based on parameter values in parameter list from application. Also sets primaryEntityType, adjacencyEntityType, and secondAdjacencyEntityType to something reasonable: primaryEntityType not adjacencyEntityType or secondAdjacencyEntityType. More... | |
virtual bool | useDegreeAsWeightOf (MeshEntityType etype, int idx) const |
Optional method allowing the idx-th weight of entity type etype to be set as the number of neighbors (the degree) of the entity Default is false; user can change in his MeshAdapter implementation. More... | |
size_t | getLocalNumIDs () const override |
Returns the number of objects on this process. More... | |
void | getIDsView (const gno_t *&Ids) const override |
Provide a pointer to this process' identifiers. More... | |
void | getIDsKokkosView (Kokkos::View< const gno_t *, typename node_t::device_type > &ids) const override |
int | getNumWeightsPerID () const override |
Returns the number of weights per object. Number of weights per object should be zero or greater. If zero, then it is assumed that all objects are equally weighted. Default is zero weights per ID. More... | |
void | getWeightsView (const scalar_t *&wgt, int &stride, int idx=0) const override |
Provide pointer to a weight array with stride. More... | |
void | getCoordinatesView (const scalar_t *&coords, int &stride, int coordDim) const override |
void | getCoordinatesKokkosView (Kokkos::View< scalar_t **, Kokkos::LayoutLeft, typename node_t::device_type > &elements) const override |
bool | useDegreeAsWeight (int idx) const |
Public Member Functions inherited from Zoltan2::AdapterWithCoords< User > | |
virtual void | getCoordinatesKokkosView (CoordsDeviceView &elements) const =0 |
virtual void | getCoordinatesHostView (CoordsHostView &) const |
virtual void | getCoordinatesDeviceView (CoordsDeviceView &elements) const |
Public Member Functions inherited from Zoltan2::BaseAdapter< User > | |
virtual void | getIDsKokkosView (ConstIdsDeviceView &ids) const |
Provide a Kokkos view to this process' identifiers. More... | |
virtual void | getIDsHostView (ConstIdsHostView &hostIds) const |
Provide a Kokkos view (Host side) to this process' identifiers. More... | |
virtual void | getIDsDeviceView (ConstIdsDeviceView &deviceIds) const |
Provide a Kokkos view (Device side) to this process' identifiers. More... | |
virtual void | getWeightsKokkosView (Kokkos::View< scalar_t **, device_t > &wgt) const |
Provide kokkos view of weights. More... | |
virtual void | getWeightsHostView (WeightsHostView1D &hostWgts, int idx=0) const |
Provide a Kokkos view (Host side) of the weights. More... | |
virtual void | getWeightsHostView (WeightsHostView &hostWgts) const |
Provide a Kokkos view (Host side) of the weights. More... | |
virtual void | getWeightsDeviceView (WeightsDeviceView1D &deviceWgts, int idx=0) const |
Provide a Kokkos view (Device side) of the weights. More... | |
virtual void | getWeightsDeviceView (WeightsDeviceView &deviceWgts) const |
Provide a Kokkos view (Device side) of the weights. More... | |
virtual void | getPartsView (const part_t *&inputPart) const |
Provide pointer to an array containing the input part assignment for each ID. The input part information may be used for re-partitioning to reduce data movement, or for mapping parts to processes. Adapters may return NULL for this pointer (the default behavior); if NULL is returned, algorithms will assume the rank. More... | |
virtual void | getPartsHostView (Kokkos::View< part_t *, host_t > &inputPart) const |
virtual void | getPartsDeviceView (Kokkos::View< part_t *, device_t > &inputPart) const |
template<typename Adapter > | |
void | applyPartitioningSolution (const User &in, User *&out, const PartitioningSolution< Adapter > &solution) const |
Apply a PartitioningSolution to an input. More... | |
Public Member Functions inherited from Zoltan2::BaseAdapterRoot | |
virtual | ~BaseAdapterRoot ()=default |
Additional Inherited Members | |
Public Types inherited from Zoltan2::AdapterWithCoords< User > | |
using | scalar_t = typename BaseAdapter< User >::scalar_t |
using | device_t = typename BaseAdapter< User >::node_t::device_type |
using | host_t = typename Kokkos::HostSpace::memory_space |
using | CoordsDeviceView = Kokkos::View< scalar_t **, Kokkos::LayoutLeft, device_t > |
using | CoordsHostView = typename CoordsDeviceView::HostMirror |
Public Types inherited from Zoltan2::BaseAdapter< User > | |
using | lno_t = typename InputTraits< User >::lno_t |
using | gno_t = typename InputTraits< User >::gno_t |
using | scalar_t = typename InputTraits< User >::scalar_t |
using | node_t = typename InputTraits< User >::node_t |
using | part_t = typename InputTraits< User >::part_t |
using | offset_t = typename InputTraits< User >::offset_t |
using | host_t = typename Kokkos::HostSpace::memory_space |
using | device_t = typename node_t::device_type |
using | ConstIdsDeviceView = Kokkos::View< const gno_t *, device_t > |
using | ConstIdsHostView = typename ConstIdsDeviceView::HostMirror |
using | IdsDeviceView = Kokkos::View< gno_t *, device_t > |
using | IdsHostView = typename IdsDeviceView::HostMirror |
using | ConstOffsetsDeviceView = Kokkos::View< const offset_t *, device_t > |
using | ConstOffsetsHostView = typename ConstOffsetsDeviceView::HostMirror |
using | OffsetsDeviceView = Kokkos::View< offset_t *, device_t > |
using | OffsetsHostView = typename OffsetsDeviceView::HostMirror |
using | ConstScalarsDeviceView = Kokkos::View< const scalar_t *, device_t > |
using | ConstScalarsHostView = typename ConstScalarsDeviceView::HostMirror |
using | ScalarsDeviceView = Kokkos::View< scalar_t *, device_t > |
using | ScalarsHostView = typename ScalarsDeviceView::HostMirror |
using | ConstWeightsDeviceView1D = Kokkos::View< const scalar_t *, device_t > |
using | ConstWeightsHostView1D = typename ConstWeightsDeviceView1D::HostMirror |
using | WeightsDeviceView1D = Kokkos::View< scalar_t *, device_t > |
using | WeightsHostView1D = typename WeightsDeviceView1D::HostMirror |
using | ConstWeightsDeviceView = Kokkos::View< const scalar_t **, device_t > |
using | ConstWeightsHostView = typename ConstWeightsDeviceView::HostMirror |
using | WeightsDeviceView = Kokkos::View< scalar_t **, device_t > |
using | WeightsHostView = typename WeightsDeviceView::HostMirror |
Protected Member Functions inherited from Zoltan2::BaseAdapter< User > | |
void | generateWeightFileOnly (const char *fileprefix, const Teuchos::Comm< int > &comm) const |
MeshAdapter defines the interface for mesh input.
Adapter objects provide access for Zoltan2 to the user's data. Many built-in adapters are already defined for common data structures, such as Tpetra and Epetra objects and C-language pointers to arrays.
Data types:
scalar_t
entity and adjacency weights lno_t
local indices and local counts gno_t
global indices and global counts node_t
is a Kokkos CPU nodeThe Kokkos node type can be safely ignored.
The template parameter User
is a user-defined data type which, through a traits mechanism, provides the actual data types with which the Zoltan2 library will be compiled. User
may be the actual class or structure used by application to represent a vector, or it may be the helper class BasicUserTypes. See InputTraits for more information.
The scalar_t
type, representing use data such as matrix values, is used by Zoltan2 for weights, coordinates, part sizes and quality metrics. Some User types (like Tpetra::CrsMatrix) have an inherent scalar type, and some (like Tpetra::CrsGraph) do not. For such objects, the scalar type is set by Zoltan2 to float
. If you wish to change it to double, set the second template parameter to double
.
Definition at line 88 of file Zoltan2_MeshAdapter.hpp.
|
inline |
Definition at line 107 of file Zoltan2_MeshAdapter.hpp.
|
inlineoverridevirtual |
Returns the type of adapter.
Implements Zoltan2::BaseAdapter< User >.
Definition at line 103 of file Zoltan2_MeshAdapter.hpp.
|
inlinevirtual |
Provide a pointer to the entity topology types.
Types | will on return point to the list of entity topology types for this process. |
Reimplemented in Zoltan2::PamgenMeshAdapter< User >.
Definition at line 118 of file Zoltan2_MeshAdapter.hpp.
|
pure virtual |
Returns the global number of mesh entities of MeshEntityType.
Returns the number of mesh entities on this process.
Implemented in Zoltan2::PamgenMeshAdapter< User >.
|
pure virtual |
Provide a pointer to this process' identifiers.
Ids | will on return point to the list of the global Ids for this process. |
|
inlinevirtual |
Provide a pointer to the entity topology types.
Types | will on return point to the list of entity topology types for this process. |
Reimplemented in Zoltan2::PamgenMeshAdapter< User >.
Definition at line 144 of file Zoltan2_MeshAdapter.hpp.
|
inlinevirtual |
Return the number of weights per entity.
Definition at line 156 of file Zoltan2_MeshAdapter.hpp.
|
inlinevirtual |
Provide a pointer to one of the number of this process' optional entity weights.
weights | on return will contain a list of the weights for the number specified. |
stride | on return will indicate the stride of the weights list. |
The k'th weight is located at weights[stride*k].
idx | is a value ranging from zero to one less than getNumWeightsPerEntityID() |
Definition at line 171 of file Zoltan2_MeshAdapter.hpp.
|
inlinevirtual |
Return dimension of the entity coordinates, if any.
Some algorithms can partition mesh entities using geometric coordinate information
Some algorithms can use geometric entity coordinate information if it is present.
Reimplemented in Zoltan2::PamgenMeshAdapter< User >.
Definition at line 188 of file Zoltan2_MeshAdapter.hpp.
|
inlinevirtual |
Provide a pointer to one dimension of entity coordinates.
coords | points to a list of coordinate values for the dimension. |
stride | describes the layout of the coordinate values in the coords list. If stride is one, then the ith coordinate value is coords[i], but if stride is two, then the ith coordinate value is coords[2*i]. |
coordDim | is a value from 0 to one less than getEntityCoordinateDimension() specifying which dimension is being provided in the coords list. |
Definition at line 200 of file Zoltan2_MeshAdapter.hpp.
|
inlinevirtual |
Returns whether a first adjacency combination is available.
Reimplemented in Zoltan2::PamgenMeshAdapter< User >.
Definition at line 211 of file Zoltan2_MeshAdapter.hpp.
|
inlinevirtual |
Returns the number of first adjacencies on this process.
Reimplemented in Zoltan2::PamgenMeshAdapter< User >.
Definition at line 218 of file Zoltan2_MeshAdapter.hpp.
|
inlinevirtual |
Sets pointers to this process' mesh first adjacencies.
source | |
offsets | is an array of size getLocalNumOf() + 1. The first adjacency Ids for Ids[i] (returned in getIDsViewOf()) begin at adjacencyIds[offsets[i]]. The last element of offsets is the size of the adjacencyIds array. |
adjacencyIds | on return will point to the global first adjacency Ids for each entity. |
Definition at line 232 of file Zoltan2_MeshAdapter.hpp.
|
inlinevirtual |
Returns whether a second adjacency combination is available. If combination is not available in the MeshAdapter, Zoltan2 will compute them, using A^T A, where A is matrix of first adjacencies.
Reimplemented in Zoltan2::PamgenMeshAdapter< User >.
Definition at line 245 of file Zoltan2_MeshAdapter.hpp.
|
inlinevirtual |
if avail2ndAdjs(), returns the number of second adjacencies on this process.
Reimplemented in Zoltan2::PamgenMeshAdapter< User >.
Definition at line 254 of file Zoltan2_MeshAdapter.hpp.
|
inlinevirtual |
if avail2ndAdjs(), set pointers to this process' second adjacencies
sourcetarget | |
offsets | is an array of size getLocalNumOf() + 1. The second adjacency Ids for Ids[i] (returned in getIDsViewOf()) begin at adjacencyIds[offsets[i]]. The last element of offsets is the size of the adjacencyIds array. |
adjacencyIds | on return will point to the global second adjacency Ids for each entity. |
Definition at line 270 of file Zoltan2_MeshAdapter.hpp.
|
inlinevirtual |
Returns the number (0 or greater) of weights per second adjacency. Note: second-adjacency weights may be used only if avail2ndAdjs().
Definition at line 283 of file Zoltan2_MeshAdapter.hpp.
|
inlinevirtual |
Provide a pointer to the second adjacency weights, if any. Note: second-adjacency weights may be used only if avail2ndAdjs().
weights | is the list of weights of the given number for the second adjacencies returned in get2ndAdjsView(). |
stride | The k'th weight is located at weights[stride*k] |
idx | ranges from zero to one less than getNumWeightsPer2ndAdj(). |
Definition at line 296 of file Zoltan2_MeshAdapter.hpp.
|
inline |
Returns the entity to be partitioned, ordered, colored, etc.
Definition at line 312 of file Zoltan2_MeshAdapter.hpp.
|
inline |
Returns the entity that describes adjacencies between the entities to be partitioned, ordered, colored, etc. That is, a primaryEntityType that contains an adjacencyEntityType are adjacent.
Definition at line 321 of file Zoltan2_MeshAdapter.hpp.
|
inline |
Returns the entity that describes second adjacencies between the entities to be partitioned, ordered, colored, etc. That is, two primaryEntityType that share a secondAdjacencyEntityType are adjacent.
Definition at line 330 of file Zoltan2_MeshAdapter.hpp.
|
inline |
Sets the primary, adjacency, and second adjacency entity types. Called by algorithm based on parameter values in parameter list from application. Also sets primaryEntityType, adjacencyEntityType, and secondAdjacencyEntityType to something reasonable: primaryEntityType not adjacencyEntityType or secondAdjacencyEntityType.
Definition at line 340 of file Zoltan2_MeshAdapter.hpp.
|
inlinevirtual |
Optional method allowing the idx-th weight of entity type etype to be set as the number of neighbors (the degree) of the entity Default is false; user can change in his MeshAdapter implementation.
Reimplemented in Zoltan2::PamgenMeshAdapter< User >.
Definition at line 406 of file Zoltan2_MeshAdapter.hpp.
|
inlineoverridevirtual |
Returns the number of objects on this process.
Objects may be coordinates, graph vertices, matrix rows, etc. They are the objects to be partitioned, ordered, or colored.
Implements Zoltan2::BaseAdapterRoot.
Definition at line 413 of file Zoltan2_MeshAdapter.hpp.
|
inlineoverridevirtual |
Provide a pointer to this process' identifiers.
ids | will on return point to the list of the global Ids for this process. |
Reimplemented from Zoltan2::BaseAdapter< User >.
Definition at line 417 of file Zoltan2_MeshAdapter.hpp.
|
inlineoverride |
Definition at line 421 of file Zoltan2_MeshAdapter.hpp.
|
inlineoverridevirtual |
Returns the number of weights per object. Number of weights per object should be zero or greater. If zero, then it is assumed that all objects are equally weighted. Default is zero weights per ID.
Reimplemented from Zoltan2::BaseAdapterRoot.
Definition at line 437 of file Zoltan2_MeshAdapter.hpp.
|
inlineoverridevirtual |
Provide pointer to a weight array with stride.
wgt | on return a pointer to the weights for this idx |
stride | on return, the value such that the nth weight should be found at wgt[n*stride] . |
idx | the weight index, zero or greater This function or getWeightsKokkosView must be implemented in derived adapter if getNumWeightsPerID > 0. This function should not be called if getNumWeightsPerID is zero. |
Reimplemented from Zoltan2::BaseAdapter< User >.
Definition at line 441 of file Zoltan2_MeshAdapter.hpp.
|
inlineoverridevirtual |
Implements Zoltan2::AdapterWithCoords< User >.
Definition at line 445 of file Zoltan2_MeshAdapter.hpp.
|
inlineoverride |
Definition at line 451 of file Zoltan2_MeshAdapter.hpp.
|
inline |
Definition at line 471 of file Zoltan2_MeshAdapter.hpp.