PARALUTION  1.0.0
PARALUTION
Public Member Functions | Protected Attributes | Friends
paralution::BaseStencil< ValueType > Class Template Referenceabstract

Base class for all host/accelerator stencils. More...

#include <base_stencil.hpp>

Inheritance diagram for paralution::BaseStencil< ValueType >:
paralution::AcceleratorStencil< ValueType > paralution::HostStencil< ValueType > paralution::GPUAcceleratorStencil< ValueType > paralution::MICAcceleratorStencil< ValueType > paralution::OCLAcceleratorStencil< ValueType > paralution::HostStencilLaplace2D< ValueType >

Public Member Functions

 BaseStencil ()
 
virtual ~BaseStencil ()
 
int get_nrow (void) const
 Return the number of rows in the stencil. More...
 
int get_ncol (void) const
 Return the number of columns in the stencil. More...
 
int get_ndim (void) const
 Return the dimension of the stencil. More...
 
virtual int get_nnz (void) const =0
 Return the nnz per row. More...
 
virtual void info (void) const =0
 Shows simple info about the object. More...
 
virtual unsigned int get_stencil_id (void) const =0
 Return the stencil format id (see stencil_formats.hpp) More...
 
virtual void set_backend (const Paralution_Backend_Descriptor local_backend)
 Copy the backend descriptor information. More...
 
virtual void SetGrid (const int size)
 
virtual void Apply (const BaseVector< ValueType > &in, BaseVector< ValueType > *out) const =0
 Apply the stencil to vector, out = this*in;. More...
 
virtual void ApplyAdd (const BaseVector< ValueType > &in, const ValueType scalar, BaseVector< ValueType > *out) const =0
 Apply and add the stencil to vector, out = out + scalar*this*in;. More...
 

Protected Attributes

int ndim_
 Number of rows. More...
 
int size_
 Number of columns. More...
 
Paralution_Backend_Descriptor local_backend_
 Backend descriptor (local copy) More...
 

Friends

class BaseVector< ValueType >
 
class HostVector< ValueType >
 
class AcceleratorVector< ValueType >
 
class GPUAcceleratorVector< ValueType >
 
class OCLAcceleratorVector< ValueType >
 
class MICAcceleratorVector< ValueType >
 

Detailed Description

template<typename ValueType>
class paralution::BaseStencil< ValueType >

Base class for all host/accelerator stencils.

Constructor & Destructor Documentation

template<typename ValueType >
paralution::BaseStencil< ValueType >::BaseStencil ( )
template<typename ValueType >
paralution::BaseStencil< ValueType >::~BaseStencil ( )
virtual

Member Function Documentation

template<typename ValueType>
virtual void paralution::BaseStencil< ValueType >::Apply ( const BaseVector< ValueType > &  in,
BaseVector< ValueType > *  out 
) const
pure virtual

Apply the stencil to vector, out = this*in;.

Implemented in paralution::HostStencilLaplace2D< ValueType >.

template<typename ValueType>
virtual void paralution::BaseStencil< ValueType >::ApplyAdd ( const BaseVector< ValueType > &  in,
const ValueType  scalar,
BaseVector< ValueType > *  out 
) const
pure virtual

Apply and add the stencil to vector, out = out + scalar*this*in;.

Implemented in paralution::HostStencilLaplace2D< ValueType >.

template<typename ValueType >
int paralution::BaseStencil< ValueType >::get_ncol ( void  ) const

Return the number of columns in the stencil.

template<typename ValueType >
int paralution::BaseStencil< ValueType >::get_ndim ( void  ) const

Return the dimension of the stencil.

template<typename ValueType>
virtual int paralution::BaseStencil< ValueType >::get_nnz ( void  ) const
pure virtual

Return the nnz per row.

Implemented in paralution::HostStencilLaplace2D< ValueType >.

template<typename ValueType >
int paralution::BaseStencil< ValueType >::get_nrow ( void  ) const

Return the number of rows in the stencil.

template<typename ValueType>
virtual unsigned int paralution::BaseStencil< ValueType >::get_stencil_id ( void  ) const
pure virtual

Return the stencil format id (see stencil_formats.hpp)

Implemented in paralution::HostStencilLaplace2D< ValueType >.

template<typename ValueType>
virtual void paralution::BaseStencil< ValueType >::info ( void  ) const
pure virtual

Shows simple info about the object.

Implemented in paralution::HostStencilLaplace2D< ValueType >.

template<typename ValueType >
void paralution::BaseStencil< ValueType >::set_backend ( const Paralution_Backend_Descriptor  local_backend)
virtual

Copy the backend descriptor information.

template<typename ValueType >
void paralution::BaseStencil< ValueType >::SetGrid ( const int  size)
virtual

Friends And Related Function Documentation

template<typename ValueType>
friend class AcceleratorVector< ValueType >
friend
template<typename ValueType>
friend class BaseVector< ValueType >
friend
template<typename ValueType>
friend class GPUAcceleratorVector< ValueType >
friend
template<typename ValueType>
friend class HostVector< ValueType >
friend
template<typename ValueType>
friend class MICAcceleratorVector< ValueType >
friend
template<typename ValueType>
friend class OCLAcceleratorVector< ValueType >
friend

Field Documentation

template<typename ValueType>
Paralution_Backend_Descriptor paralution::BaseStencil< ValueType >::local_backend_
protected

Backend descriptor (local copy)

template<typename ValueType>
int paralution::BaseStencil< ValueType >::ndim_
protected

Number of rows.

template<typename ValueType>
int paralution::BaseStencil< ValueType >::size_
protected

Number of columns.

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