comma::GraphArgs< CoMMAIndexType, CoMMAWeightType, CoMMAIntType > Class Template Reference

Convenient class holding arguments defining the graph. More...

#include <Args.h>

Public Member Functions
	GraphArgs ()=default
	Default constructor. More...
	GraphArgs (const std::vector< CoMMAIndexType > &connectivity_indices, const std::vector< CoMMAIndexType > &connectivity, const std::vector< CoMMAWeightType > &connectivity_weights, const std::vector< CoMMAWeightType > &volumes, const std::vector< std::vector< CoMMAWeightType > > &centers, const std::vector< CoMMAWeightType > &priority_weights, const std::vector< CoMMAIntType > &n_bnd_faces, CoMMAIntType dimension)
	Constructor. More...

Public Attributes
const std::vector< CoMMAIndexType > &	connectivity_indices
	Indices of the CSR representation of the graph. More...
const std::vector< CoMMAIndexType > &	connectivity
	Values of the CSR representation of the graph. More...
const std::vector< CoMMAWeightType > &	connectivity_weights
	Weights of the CSR representation of the graph. More...
const std::vector< CoMMAWeightType > &	volumes
	Volumes of the cells. More...
const std::vector< std::vector< CoMMAWeightType > > &	centers
	Centers of the cells. More...
const std::vector< CoMMAWeightType > &	priority_weights
	Priority weights. More...
const std::vector< CoMMAIntType > &	n_bnd_faces
	Number of boundary faces per cell. More...
CoMMAIntType	dimension
	Dimensionality of the problem, 2- or 3D. More...

Detailed Description

template<typename CoMMAIndexType, typename CoMMAWeightType, typename CoMMAIntType>
class comma::GraphArgs< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >

Convenient class holding arguments defining the graph.

Template Parameters

CoMMAIndexType	the CoMMA index type for the global index of the mesh
CoMMAWeightType	the CoMMA weight type for the weights (volume or area) of the nodes or edges of the Mesh
CoMMAIntType	the CoMMA type for integers

Constructor & Destructor Documentation

GraphArgs() [1/2]

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >

comma::GraphArgs< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::GraphArgs ( )

default

Default constructor.

GraphArgs() [2/2]

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >

comma::GraphArgs< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::GraphArgs ( const std::vector< CoMMAIndexType > &  connectivity_indices, const std::vector< CoMMAIndexType > &  connectivity, const std::vector< CoMMAWeightType > &  connectivity_weights, const std::vector< CoMMAWeightType > &  volumes, const std::vector< std::vector< CoMMAWeightType > > &  centers, const std::vector< CoMMAWeightType > &  priority_weights, const std::vector< CoMMAIntType > &  n_bnd_faces, CoMMAIntType  dimension  )

inline

Constructor.

Parameters

[in]	connectivity_indices	Indices of the CSR representation of the graph.
[in]	connectivity	Values of the CSR representation of the graph.
[in]	connectivity_weights	Weights of the CSR representation of the graph.
[in]	volumes	Volumes of the cells.
[in]	centers	Centers of the cells.
[in]	priority_weights	Priority weights.
[in]	n_bnd_faces	Number of boundary faces per cell.
[in]	dimension	Dimensionality of the problem, 2- or 3D.

Member Data Documentation

centers

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >

const std::vector<std::vector<CoMMAWeightType> >& comma::GraphArgs< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::centers

Centers of the cells.

connectivity

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >

const std::vector<CoMMAIndexType>& comma::GraphArgs< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::connectivity

Values of the CSR representation of the graph.

connectivity_indices

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >

const std::vector<CoMMAIndexType>& comma::GraphArgs< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::connectivity_indices

Indices of the CSR representation of the graph.

connectivity_weights

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >

const std::vector<CoMMAWeightType>& comma::GraphArgs< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::connectivity_weights

Weights of the CSR representation of the graph.

dimension

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >

CoMMAIntType comma::GraphArgs< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::dimension

Dimensionality of the problem, 2- or 3D.

n_bnd_faces

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >

const std::vector<CoMMAIntType>& comma::GraphArgs< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::n_bnd_faces

Number of boundary faces per cell.

priority_weights

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >

const std::vector<CoMMAWeightType>& comma::GraphArgs< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::priority_weights

Priority weights.

volumes

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >

const std::vector<CoMMAWeightType>& comma::GraphArgs< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::volumes

Volumes of the cells.

---

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

• include/CoMMA/Args.h