bandedmatrix.h File Reference

Data structure and some function declarations for banded block matrices. More...

Go to the source code of this file.

Data Structures
struct	BandedMatrix
	Structure for defining a banded block matrix. More...

Functions
int	BandedMatrixDestroy (void *)
int	BandedMatrixInitialize (void *)
int	BandedMatrixPreallocate (void *, int, int, int)

Detailed Description

Data structure and some function declarations for banded block matrices.

Author

Debojyoti Ghosh

Definition in file bandedmatrix.h.

---

Data Structure Documentation

BandedMatrix

struct BandedMatrix

Structure for defining a banded block matrix.

This structure contains all the variables for defining a banded block matrix.

Definition at line 18 of file bandedmatrix.h.

Data Fields
int	nbands	number of block bands
int	nrows_local	number of block rows (local)
int	BlockSize	block size
int *	ncol	global column numbers for each block
int *	nrow	global row numbers for each block
double *	data	array containing the matrix elements

Function Documentation

BandedMatrixDestroy()

int BandedMatrixDestroy

(

void *

A

)

Destroy a banded block matrix object

Free up allocations inside a banded matrix object

Parameters

A	Banded matrix object of type BandedMatrix

Definition at line 10 of file BandedMatrixDestroy.c.

{
  BandedMatrix *B = (BandedMatrix*) A;

  if (B->ncol) free(B->ncol);
  if (B->nrow) free(B->nrow);
  if (B->data) free(B->data);

  return(0);
}

BandedMatrixInitialize()

int BandedMatrixInitialize

(

void *

A

)

Initialize a banded block matrix object

Initialize a newly-created banded matrix object.

Parameters

A	Banded matrix object of type BandedMatrix

Definition at line 10 of file BandedMatrixInitialize.c.

{
  BandedMatrix *B = (BandedMatrix*) A;

  B->nbands       = 0;
  B->nrows_local  = 0;
  B->BlockSize    = 0;

  B->ncol = NULL;
  B->nrow = NULL;
  B->data = NULL;

  return(0);
}

BandedMatrixPreallocate()

int BandedMatrixPreallocate	(	void *	A,
		int	nbands,
		int	nrows_local,
		int	BlockSize
	)

Preallocate memory for a banded block matrix

Preallocate memory for a banded matrix object.

Parameters

A	Banded matrix object of the type BandedMatrix
nbands	Number of bands
nrows_local	Local number of rows
BlockSize	Block size

Definition at line 10 of file BandedMatrixPreallocate.c.

{
  BandedMatrix *B = (BandedMatrix*) A;

  B->nbands       = nbands;
  B->nrows_local  = nrows_local;
  B->BlockSize    = BlockSize;

  B->ncol = (int*) calloc (nrows_local*nbands, sizeof(int));
  B->nrow = (int*) calloc (nrows_local, sizeof(int));
  B->data = (double*) calloc (nrows_local*nbands*BlockSize*BlockSize, sizeof(double));

  return(0);
}