PetscMat Class Reference

#include <PetscMat.h>

Public Member Functions
	PetscMat ()
	PetscMat (int M, int N)
	PetscMat (int M, int N, IssmDouble sparsity)
	PetscMat (int m, int n, int M, int N, int *d_nnz, int *o_nnz)
	PetscMat (IssmDouble *serial_mat, int M, int N, IssmDouble sparsity)
	PetscMat (int M, int N, int connectivity, int numberofdofspernode)
	~PetscMat ()
void	AllocationInfo (void)
void	Echo (void)
void	Assemble (void)
IssmDouble	Norm (NormMode norm_type)
void	GetSize (int *pM, int *pN)
void	GetLocalSize (int *pM, int *pN)
void	MatMult (PetscVec *X, PetscVec *AX)
PetscMat *	Duplicate (void)
IssmDouble *	ToSerial (void)
void	SetValues (int m, int *idxm, int n, int *idxn, IssmDouble *values, InsMode mode)
void	Convert (MatrixType type)
void	SetZero (void)

Data Fields
Mat	matrix

Detailed Description

Definition at line 24 of file PetscMat.h.

Constructor & Destructor Documentation

PetscMat() [1/6]

PetscMat::PetscMat

(

)

Definition at line 21 of file PetscMat.cpp.

                  {/*{{{*/
   this->matrix=NULL;
   #ifdef _HAVE_AD_
   this->amatrix=NULL;
   #endif
 
}

PetscMat() [2/6]

PetscMat::PetscMat	(	int	M,
		int	N
	)

Definition at line 29 of file PetscMat.cpp.

                             {/*{{{*/
 
   this->matrix=NewMat(M,N,IssmComm::GetComm());
}

PetscMat() [3/6]

PetscMat::PetscMat	(	int	M,
		int	N,
		IssmDouble	sparsity
	)

Definition at line 34 of file PetscMat.cpp.

                                                  {/*{{{*/
 
   this->matrix=NewMat(M,N,sparsity,IssmComm::GetComm());
}

PetscMat() [4/6]

PetscMat::PetscMat	(	int	m,
		int	n,
		int	M,
		int	N,
		int *	d_nnz,
		int *	o_nnz
	)

Definition at line 39 of file PetscMat.cpp.

                                                               {/*{{{*/
 
   MatCreate(IssmComm::GetComm(),&this->matrix);
   MatSetSizes(this->matrix,m,n,M,N);
   MatSetFromOptions(this->matrix);
 
   /* 
    * Versions of Petsc beyond 3.3 have changed the use of preallocation 
    * routines to distinguish between parallel builds and sequential. Since
    * our Windows builds are currently only sequential, we need to change
    * the way we use these functions.
    *
    * The following code computes the total number of non-zeroes per row of the
    * matrix in question. In parallel builds it is nescessary to kep track of 
    * diagonal non zeros and off-diagonal (d_nnz and o_nnz). Sequential does
    * not make that distinction.
   */
   #ifdef _HAVE_PETSC_MPI_
      int* nnz = new int[M];
      for(int i = 0; i < M; i++)
         nnz[i] = o_nnz[i] + d_nnz[i];
 
      PetscErrorCode ierr = MatSeqAIJSetPreallocation(this->matrix,0,nnz);
      delete[] nnz;
   #else
      PetscErrorCode ierr = MatMPIAIJSetPreallocation(this->matrix,0,d_nnz,0,o_nnz);
   #endif
   if(ierr) _error_("PETSc could not allocate matrix (probably not enough memory)");
// MatSetOption(this->matrix,MAT_NEW_NONZERO_ALLOCATION_ERR,PETSC_FALSE);
 
}

PetscMat() [5/6]

PetscMat::PetscMat	(	IssmDouble *	serial_mat,
		int	M,
		int	N,
		IssmDouble	sparsity
	)

Definition at line 71 of file PetscMat.cpp.

                                                                        {/*{{{*/
 
   int     i;
   int* idxm=NULL;
   int* idxn=NULL;
 
   if(M)idxm=xNew<int>(M);
   if(N)idxn=xNew<int>(N);
 
   for(i=0;i<M;i++)idxm[i]=i;
   for(i=0;i<N;i++)idxn[i]=i;
 
   this->matrix=NewMat(M,N,sparsity,IssmComm::GetComm());
   MatSetValues(this->matrix,M,idxm,N,idxn,serial_mat,INSERT_VALUES);
   MatAssemblyBegin(this->matrix,MAT_FINAL_ASSEMBLY);
   MatAssemblyEnd(this->matrix,MAT_FINAL_ASSEMBLY);
 
   xDelete<int>(idxm);
   xDelete<int>(idxn);
 
}

PetscMat() [6/6]

PetscMat::PetscMat	(	int	M,
		int	N,
		int	connectivity,
		int	numberofdofspernode
	)

Definition at line 93 of file PetscMat.cpp.

                                                                       {/*{{{*/
 
   this->matrix=NewMat(M,N,connectivity,numberofdofspernode,IssmComm::GetComm());
 
}

~PetscMat()

PetscMat::~PetscMat

(

)

Definition at line 99 of file PetscMat.cpp.

                   {/*{{{*/
   MatFree(&this->matrix);
}

Member Function Documentation

AllocationInfo()

void PetscMat::AllocationInfo

(

void

)

Definition at line 105 of file PetscMat.cpp.

                                 {/*{{{*/
 
   MatInfo info;
   MatGetInfo(this->matrix,MAT_GLOBAL_SUM,&info);
   _printf0_("=========================== Stiffness matrix allocation info ===========================\n");
   _printf0_("\n");
   _printf0_(" Block size  : "<<info.block_size << "\n");
   _printf0_(" nz_allocated: "<<info.nz_allocated << "\n");
   _printf0_(" nz_used     : "<<info.nz_used << "\n");
   _printf0_(" nz_unneeded : "<<info.nz_unneeded<<" ("<<double(info.nz_unneeded)/double(info.nz_allocated)*100.<<"%)\n");
   _printf0_("\n");
   _printf0_("========================================================================================\n");
}

Echo()

void PetscMat::Echo

(

void

)

Definition at line 119 of file PetscMat.cpp.

                       {/*{{{*/
 
   MatView(this->matrix,PETSC_VIEWER_STDOUT_WORLD);
}

Assemble()

void PetscMat::Assemble

(

void

)

Definition at line 124 of file PetscMat.cpp.

                           {/*{{{*/
 
   _assert_(this->matrix);
   MatAssemblyBegin(this->matrix,MAT_FINAL_ASSEMBLY);
   MatAssemblyEnd(this->matrix,MAT_FINAL_ASSEMBLY);
 
}

Norm()

IssmDouble PetscMat::Norm

(

NormMode

norm_type

)

Definition at line 132 of file PetscMat.cpp.

                                      {/*{{{*/
 
   IssmDouble norm=0;
   _assert_(this->matrix);
   MatNorm(this->matrix,ISSMToPetscNormMode(mode),&norm);
 
   return norm;
 
}

GetSize()

void PetscMat::GetSize	(	int *	pM,
		int *	pN
	)

Definition at line 142 of file PetscMat.cpp.

                                     {/*{{{*/
 
   _assert_(this->matrix);
   MatGetSize(this->matrix,pM,pN);
}

GetLocalSize()

void PetscMat::GetLocalSize	(	int *	pM,
		int *	pN
	)

Definition at line 148 of file PetscMat.cpp.

                                          {/*{{{*/
 
   _assert_(this->matrix);
   MatGetLocalSize(this->matrix,pM,pN);
 
}

MatMult()

void PetscMat::MatMult	(	PetscVec *	X,
		PetscVec *	AX
	)

Definition at line 155 of file PetscMat.cpp.

                                              {/*{{{*/
 
   _assert_(this->matrix);
   _assert_(X->vector);
   MatMultPatch(this->matrix,X->vector,AX->vector,IssmComm::GetComm());
 
}

Duplicate()

PetscMat * PetscMat::Duplicate

(

void

)

Definition at line 163 of file PetscMat.cpp.

                                 {/*{{{*/
 
   PetscMat* output=new PetscMat();
   _assert_(this->matrix);
   MatDuplicate(this->matrix,MAT_COPY_VALUES,&output->matrix);
 
   return output;
 
}

ToSerial()

IssmDouble * PetscMat::ToSerial

(

void

)

Definition at line 173 of file PetscMat.cpp.

                                  {/*{{{*/
 
    IssmDouble* output=NULL;
 
    MatToSerial(&output,this->matrix,IssmComm::GetComm());
    return output;
 
}

SetValues()

void PetscMat::SetValues	(	int	m,
		int *	idxm,
		int	n,
		int *	idxn,
		IssmDouble *	values,
		InsMode	mode
	)

Definition at line 182 of file PetscMat.cpp.

                                                                                       {/*{{{*/
 
   PetscErrorCode ierr = MatSetValues(this->matrix,m,idxm,n,idxn,values,ISSMToPetscInsertMode(mode));
   if(ierr) _error_("PETSc's MatSetValues reported an error");
 
}

Convert()

void PetscMat::Convert

(

MatrixType

type

)

Definition at line 189 of file PetscMat.cpp.

                                     {/*{{{*/
 
   MatConvert(this->matrix,ISSMToPetscMatrixType(type),MAT_REUSE_MATRIX,&this->matrix);
 
}

SetZero()

void PetscMat::SetZero

(

void

)

Definition at line 195 of file PetscMat.cpp.

                          {/*{{{*/
   MatZeroEntries(this->matrix);
}

Field Documentation

matrix

Mat PetscMat::matrix

Definition at line 27 of file PetscMat.h.

---

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

• src/c/toolkits/petsc/objects/PetscMat.h
• src/c/toolkits/petsc/objects/PetscMat.cpp