OpenCMISS-Iron Internal API Documentation
distributed_matrix_vector::distributedmatrix_matrixbyvectoradd Interface Reference

Private Member Functions

subroutine distributed_matrix_by_vector_add (ROW_SELECTION_TYPE, ALPHA, DISTRIBUTED_MATRIX, DISTRIBUTED_VECTOR, DISTRIBUTED_PRODUCT, ERR, ERROR,)
 Calculates the matrix vector product of a distrubted matrix times a distributed vector and adds it to the distributed product vector. NOTE: This will only work for specific CMISS distributed matrices i.e., ones in which the columns of the matrix are distributed in the same way as the rows of the multiplied vector are distributed, and the rows of the matrix are distributed in the same way as the rows of the product vector. More...
 

Detailed Description

Definition at line 342 of file distributed_matrix_vector.f90.

Member Function/Subroutine Documentation

subroutine distributed_matrix_vector::distributedmatrix_matrixbyvectoradd::distributed_matrix_by_vector_add ( integer(intg), intent(in)  ROW_SELECTION_TYPE,
real(dp), intent(in)  ALPHA,
type(distributed_matrix_type), pointer  DISTRIBUTED_MATRIX,
type(distributed_vector_type), pointer  DISTRIBUTED_VECTOR,
type(distributed_vector_type), pointer  DISTRIBUTED_PRODUCT,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Calculates the matrix vector product of a distrubted matrix times a distributed vector and adds it to the distributed product vector. NOTE: This will only work for specific CMISS distributed matrices i.e., ones in which the columns of the matrix are distributed in the same way as the rows of the multiplied vector are distributed, and the rows of the matrix are distributed in the same way as the rows of the product vector.

Parameters
[in]row_selection_typeThe row selection for the matrix-vector product
See also
DISTRIBUTED_MATRIX_VECTOR::GhostingTypes,DISTRIBUTED_MATRIX_VECTOR
Parameters
[in]alphaThe multiplicative factor for the distributed matrix
distributed_matrixA pointer to the distributed matrix
distributed_vectorA pointer to the distributed vector
distributed_productOn exit, the value of the matrix vector product added to the distributed product vector.
[out]errThe error code
[out]errorThe error string

Definition at line 5387 of file distributed_matrix_vector.f90.