Reference documentation for deal.II version 9.0.0
Classes | Public Types | Public Member Functions | Private Attributes | List of all members
CUDAWrappers::MatrixFree< dim, Number > Class Template Reference

#include <deal.II/matrix_free/cuda_matrix_free.h>

Inheritance diagram for CUDAWrappers::MatrixFree< dim, Number >:
[legend]

Classes

struct  Data
 

Public Types

enum  ParallelizationScheme
 

Public Member Functions

 MatrixFree ()
 
void reinit (const Mapping< dim > &mapping, const DoFHandler< dim > &dof_handler, const ConstraintMatrix &constraints, const Quadrature< 1 > &quad, const AdditionalData additional_data=AdditionalData())
 
void reinit (const DoFHandler< dim > &dof_handler, const ConstraintMatrix &constraints, const Quadrature< 1 > &quad, const AdditionalData AdditionalData=AdditionalData())
 
Data get_data (unsigned int color) const
 
template<typename functor >
void cell_loop (const functor &func, const CUDAVector< Number > &src, CUDAVector< Number > &dst) const
 
void free ()
 
std::size_t memory_consumption () const
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
 Subscriptor (Subscriptor &&) noexcept
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
Subscriptoroperator= (Subscriptor &&) noexcept
 
void subscribe (const char *identifier=nullptr) const
 
void unsubscribe (const char *identifier=nullptr) const
 
unsigned int n_subscriptions () const
 
void list_subscribers () const
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Private Attributes

ParallelizationScheme parallelization_scheme
 
unsigned int fe_degree
 
unsigned int dofs_per_cell
 
unsigned int n_constrained_dofs
 
unsigned int q_points_per_cell
 
unsigned int n_colors
 
std::vector< unsigned int > n_cells
 
std::vector< point_type * > q_points
 
std::vector< unsigned int * > local_to_global
 
std::vector< Number * > inv_jacobian
 
std::vector< Number * > JxW
 
std::vector< dim3 > grid_dim
 
std::vector< dim3 > block_dim
 

Additional Inherited Members

- Static Public Member Functions inherited from Subscriptor
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 

Detailed Description

template<int dim, typename Number = double>
class CUDAWrappers::MatrixFree< dim, Number >

This class collects all the data that is stored for the matrix free implementation. The storage scheme is tailored towards several loops performed with the same data, i.e., typically doing many matrix-vector products or residual computations on the same mesh.

This class does not implement any operations involving finite element basis functions, i.e., regarding the operation performed on the cells. For these operations, the class FEEvaluation is designed to use the data collected in this class.

This class implements a loop over all cells (cell_loop()). This loop is scheduled in such a way that cells that cells that share degrees of freedom are not worked on simultaneously, which implies that it is possible to write to vectors in parallel without having to explicitly synchronize access to these vectors and matrices. This class does not implement any shape values, all it does is to cache the respective data. To implement finite element operations, use the class CUDAWrappers::FEEvalutation.

This class traverse the cells in a different order than the usual Triangulation class in deal.II.

Note
Only float and double are supported.

Definition at line 73 of file cuda_matrix_free.h.

Member Enumeration Documentation

◆ ParallelizationScheme

template<int dim, typename Number = double>
enum CUDAWrappers::MatrixFree::ParallelizationScheme

Parallelization scheme used: parallel_in_elem (parallelism at the level of degrees of freedom) or parallel_over_elem (parallelism at the level of cells)

Definition at line 89 of file cuda_matrix_free.h.

Constructor & Destructor Documentation

◆ MatrixFree()

template<int dim, typename Number = double>
CUDAWrappers::MatrixFree< dim, Number >::MatrixFree ( )

Default constructor.

Member Function Documentation

◆ reinit() [1/2]

template<int dim, typename Number = double>
void CUDAWrappers::MatrixFree< dim, Number >::reinit ( const Mapping< dim > &  mapping,
const DoFHandler< dim > &  dof_handler,
const ConstraintMatrix constraints,
const Quadrature< 1 > &  quad,
const AdditionalData  additional_data = AdditionalData() 
)

Extracts the information needed to perform loops over cells. The DoFHandler and ConstraintMatrix describe the layout of degrees of freedom, the DoFHandler and the mapping describe the transformation from unit to real cell, and the finite element underlying the DoFHandler together with the quadrature formula describe the local operations.

◆ reinit() [2/2]

template<int dim, typename Number = double>
void CUDAWrappers::MatrixFree< dim, Number >::reinit ( const DoFHandler< dim > &  dof_handler,
const ConstraintMatrix constraints,
const Quadrature< 1 > &  quad,
const AdditionalData  AdditionalData = AdditionalData() 
)

Initializes the data structures. Same as above but using a Q1 mapping.

◆ get_data()

template<int dim, typename Number = double>
Data CUDAWrappers::MatrixFree< dim, Number >::get_data ( unsigned int  color) const

Return the Data structure associated with color.

◆ cell_loop()

template<int dim, typename Number = double>
template<typename functor >
void CUDAWrappers::MatrixFree< dim, Number >::cell_loop ( const functor &  func,
const CUDAVector< Number > &  src,
CUDAVector< Number > &  dst 
) const

This method runs the loop over all cells and apply the local operation on each element in parallel. func is a functor which is appplied on each color.

◆ free()

template<int dim, typename Number = double>
void CUDAWrappers::MatrixFree< dim, Number >::free ( )

Free all the memory allocated.

◆ memory_consumption()

template<int dim, typename Number = double>
std::size_t CUDAWrappers::MatrixFree< dim, Number >::memory_consumption ( ) const

Return an approximation of the memory consumption of this class in bytes.

Member Data Documentation

◆ parallelization_scheme

template<int dim, typename Number = double>
ParallelizationScheme CUDAWrappers::MatrixFree< dim, Number >::parallelization_scheme
private

Parallelization scheme used, parallelization over degrees of freedom or over cells.

Definition at line 200 of file cuda_matrix_free.h.

◆ fe_degree

template<int dim, typename Number = double>
unsigned int CUDAWrappers::MatrixFree< dim, Number >::fe_degree
private

Degree of the finite element used.

Definition at line 204 of file cuda_matrix_free.h.

◆ dofs_per_cell

template<int dim, typename Number = double>
unsigned int CUDAWrappers::MatrixFree< dim, Number >::dofs_per_cell
private

Number of degrees of freedom per cell.

Definition at line 208 of file cuda_matrix_free.h.

◆ n_constrained_dofs

template<int dim, typename Number = double>
unsigned int CUDAWrappers::MatrixFree< dim, Number >::n_constrained_dofs
private

Number of constrained degrees of freedom.

Definition at line 212 of file cuda_matrix_free.h.

◆ q_points_per_cell

template<int dim, typename Number = double>
unsigned int CUDAWrappers::MatrixFree< dim, Number >::q_points_per_cell
private

Number of quadrature points per cells.

Definition at line 216 of file cuda_matrix_free.h.

◆ n_colors

template<int dim, typename Number = double>
unsigned int CUDAWrappers::MatrixFree< dim, Number >::n_colors
private

Number of colors produced by the graph coloring algorithm.

Definition at line 220 of file cuda_matrix_free.h.

◆ n_cells

template<int dim, typename Number = double>
std::vector<unsigned int> CUDAWrappers::MatrixFree< dim, Number >::n_cells
private

Number of cells in each color.

Definition at line 224 of file cuda_matrix_free.h.

◆ q_points

template<int dim, typename Number = double>
std::vector<point_type *> CUDAWrappers::MatrixFree< dim, Number >::q_points
private

Vector of pointers to the quadrature points associated to the cells of each color.

Definition at line 229 of file cuda_matrix_free.h.

◆ local_to_global

template<int dim, typename Number = double>
std::vector<unsigned int *> CUDAWrappers::MatrixFree< dim, Number >::local_to_global
private

Map the position in the local vector to the position in the global vector.

Definition at line 234 of file cuda_matrix_free.h.

◆ inv_jacobian

template<int dim, typename Number = double>
std::vector<Number *> CUDAWrappers::MatrixFree< dim, Number >::inv_jacobian
private

Vector of pointer to the inverse Jacobian associated to the cells of each color.

Definition at line 239 of file cuda_matrix_free.h.

◆ JxW

template<int dim, typename Number = double>
std::vector<Number *> CUDAWrappers::MatrixFree< dim, Number >::JxW
private

Vector of pointer to the Jacobian time the weights associated to the cells of each color.

Definition at line 244 of file cuda_matrix_free.h.

◆ grid_dim

template<int dim, typename Number = double>
std::vector<dim3> CUDAWrappers::MatrixFree< dim, Number >::grid_dim
private

Grid dimensions associated to the different colors. The grid dimensions are used to launch the CUDA kernels.

Definition at line 253 of file cuda_matrix_free.h.

◆ block_dim

template<int dim, typename Number = double>
std::vector<dim3> CUDAWrappers::MatrixFree< dim, Number >::block_dim
private

Block dimensions associated to the different colors. The block dimensions are used to launch the CUDA kernels.

Definition at line 258 of file cuda_matrix_free.h.


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