Ice Sheet System Model  4.18
Code documentation
Public Member Functions | Data Fields
Matrix< doubletype > Class Template Reference

#include <Matrix.h>

Public Member Functions

 Matrix ()
 
 Matrix (int M, int N)
 
 Matrix (int m, int n, int M, int N, int *d_nnz, int *o_nnz)
 
 Matrix (int M, int N, double sparsity)
 
 Matrix (IssmPDouble *serial_mat, int M, int N, IssmPDouble sparsity)
 
 Matrix (int M, int N, int connectivity, int numberofdofspernode)
 
 ~Matrix ()
 
void InitCheckAndSetType (void)
 
void Echo (void)
 
void AllocationInfo (void)
 
void Assemble (void)
 
IssmDouble Norm (NormMode norm_type)
 
void GetSize (int *pM, int *pN)
 
void GetLocalSize (int *pM, int *pN)
 
void MatMult (Vector< doubletype > *X, Vector< doubletype > *AX)
 
Matrix< doubletype > * Duplicate (void)
 
doubletype * ToSerial (void)
 
void SetValues (int m, int *idxm, int n, int *idxn, IssmDouble *values, InsMode mode)
 
void Convert (MatrixType newtype)
 
void SetZero (void)
 

Data Fields

int type
 
IssmMat< doubletype > * imatrix
 

Detailed Description

template<class doubletype>
class Matrix< doubletype >

Definition at line 27 of file Matrix.h.

Constructor & Destructor Documentation

◆ Matrix() [1/6]

template<class doubletype >
Matrix< doubletype >::Matrix ( )
inline

Definition at line 38 of file Matrix.h.

38  {/*{{{*/
39  InitCheckAndSetType();
40  }

◆ Matrix() [2/6]

template<class doubletype >
Matrix< doubletype >::Matrix ( int  M,
int  N 
)
inline

Definition at line 42 of file Matrix.h.

42  {/*{{{*/
43 
44  InitCheckAndSetType();
45 
46  if(type==PetscMatType){
47  #ifdef _HAVE_PETSC_
48  this->pmatrix=new PetscMat(M,N);
49  #endif
50  }
51  else{
52  this->imatrix=new IssmMat<doubletype>(M,N);
53  }
54 
55  }

◆ Matrix() [3/6]

template<class doubletype >
Matrix< doubletype >::Matrix ( int  m,
int  n,
int  M,
int  N,
int *  d_nnz,
int *  o_nnz 
)
inline

Definition at line 57 of file Matrix.h.

57  {/*{{{*/
58 
59  InitCheckAndSetType();
60 
61  if(type==PetscMatType){
62  #ifdef _HAVE_PETSC_
63  this->pmatrix=new PetscMat(m,n,M,N,d_nnz,o_nnz);
64  #endif
65  }
66  else{
67  this->imatrix=new IssmMat<doubletype>(m,n,M,N,d_nnz,o_nnz);
68  }
69 
70  }

◆ Matrix() [4/6]

template<class doubletype >
Matrix< doubletype >::Matrix ( int  M,
int  N,
double  sparsity 
)
inline

Definition at line 72 of file Matrix.h.

72  {/*{{{*/
73 
74  InitCheckAndSetType();
75 
76  if(type==PetscMatType){
77  #ifdef _HAVE_PETSC_
78  this->pmatrix=new PetscMat(M,N,sparsity);
79  #endif
80  }
81  else{
82  this->imatrix=new IssmMat<doubletype>(M,N,sparsity);
83  }
84  }

◆ Matrix() [5/6]

template<class doubletype >
Matrix< doubletype >::Matrix ( IssmPDouble *  serial_mat,
int  M,
int  N,
IssmPDouble  sparsity 
)
inline

Definition at line 86 of file Matrix.h.

86  {/*{{{*/
87 
88  InitCheckAndSetType();
89 
90  if(type==PetscMatType){
91  #ifdef _HAVE_PETSC_
92  this->pmatrix=new PetscMat(serial_mat,M,N,sparsity);
93  #endif
94  }
95  else{
96  this->imatrix=new IssmMat<doubletype>(serial_mat,M,N,sparsity);
97  }
98 
99  }

◆ Matrix() [6/6]

template<class doubletype >
Matrix< doubletype >::Matrix ( int  M,
int  N,
int  connectivity,
int  numberofdofspernode 
)
inline

Definition at line 101 of file Matrix.h.

101  {/*{{{*/
102 
103  InitCheckAndSetType();
104 
105  if(type==PetscMatType){
106  #ifdef _HAVE_PETSC_
107  this->pmatrix=new PetscMat(M,N,connectivity,numberofdofspernode);
108  #endif
109  }
110  else{
111  this->imatrix=new IssmMat<doubletype>(M,N,connectivity,numberofdofspernode);
112  }
113 
114  }

◆ ~Matrix()

template<class doubletype >
Matrix< doubletype >::~Matrix ( )
inline

Definition at line 116 of file Matrix.h.

116  {/*{{{*/
117 
118  if(type==PetscMatType){
119  #ifdef _HAVE_PETSC_
120  delete this->pmatrix;
121  #endif
122  }
123  else delete this->imatrix;
124 
125  }

Member Function Documentation

◆ InitCheckAndSetType()

template<class doubletype >
void Matrix< doubletype >::InitCheckAndSetType ( void  )
inline

Definition at line 127 of file Matrix.h.

127  {/*{{{*/
128 
129  #ifdef _HAVE_PETSC_
130  pmatrix=NULL;
131  #endif
132  imatrix=NULL;
133 
134  /*retrieve toolkittype: */
135  char* toolkittype=ToolkitOptions::GetToolkitType();
136 
137  /*set matrix type: */
138  if (strcmp(toolkittype,"petsc")==0){
139  #ifdef _HAVE_PETSC_
140  type=PetscMatType;
141  #else
142  _error_("cannot create petsc matrix without PETSC compiled!");
143  #endif
144  }
145  else if(strcmp(toolkittype,"issm")==0){
146  /*let this choice stand:*/
147  type=IssmMatType;
148  }
149  else{
150  _error_("unknow toolkit type ");
151  }
152 
153  /*Free ressources: */
154  xDelete<char>(toolkittype);
155  }

◆ Echo()

template<class doubletype >
void Matrix< doubletype >::Echo ( void  )
inline

Definition at line 159 of file Matrix.h.

159  {/*{{{*/
160  _assert_(this);
161 
162  if(type==PetscMatType){
163  #ifdef _HAVE_PETSC_
164  this->pmatrix->Echo();
165  #endif
166  }
167  else{
168  this->imatrix->Echo();
169  }
170 
171  }

◆ AllocationInfo()

template<class doubletype >
void Matrix< doubletype >::AllocationInfo ( void  )
inline

Definition at line 173 of file Matrix.h.

173  {/*{{{*/
174  _assert_(this);
175  if(type==PetscMatType){
176  #ifdef _HAVE_PETSC_
177  this->pmatrix->AllocationInfo();
178  #endif
179  }
180  else{
181  //this->imatrix->AllocationInfo();
182  _error_("not supported yet");
183  }
184  }/*}}}*/

◆ Assemble()

template<class doubletype >
void Matrix< doubletype >::Assemble ( void  )
inline

Definition at line 185 of file Matrix.h.

185  {/*{{{*/
186 
187  if(type==PetscMatType){
188  #ifdef _HAVE_PETSC_
189  this->pmatrix->Assemble();
190  #endif
191  }
192  else{
193  this->imatrix->Assemble();
194  }
195  }

◆ Norm()

template<class doubletype >
IssmDouble Matrix< doubletype >::Norm ( NormMode  norm_type)
inline

Definition at line 197 of file Matrix.h.

197  {/*{{{*/
198 
199  IssmDouble norm=0;
200 
201  if(type==PetscMatType){
202  #ifdef _HAVE_PETSC_
203  norm=this->pmatrix->Norm(norm_type);
204  #endif
205  }
206  else{
207  norm=this->imatrix->Norm(norm_type);
208  }
209 
210  return norm;
211  }

◆ GetSize()

template<class doubletype >
void Matrix< doubletype >::GetSize ( int *  pM,
int *  pN 
)
inline

Definition at line 213 of file Matrix.h.

213  {/*{{{*/
214 
215  if(type==PetscMatType){
216  #ifdef _HAVE_PETSC_
217  this->pmatrix->GetSize(pM,pN);
218  #endif
219  }
220  else{
221  this->imatrix->GetSize(pM,pN);
222  }
223 
224  }

◆ GetLocalSize()

template<class doubletype >
void Matrix< doubletype >::GetLocalSize ( int *  pM,
int *  pN 
)
inline

Definition at line 226 of file Matrix.h.

226  {/*{{{*/
227 
228  if(type==PetscMatType){
229  #ifdef _HAVE_PETSC_
230  this->pmatrix->GetLocalSize(pM,pN);
231  #endif
232  }
233  else{
234  this->imatrix->GetLocalSize(pM,pN);
235  }
236 
237  }

◆ MatMult()

template<class doubletype >
void Matrix< doubletype >::MatMult ( Vector< doubletype > *  X,
Vector< doubletype > *  AX 
)
inline

Definition at line 239 of file Matrix.h.

239  {/*{{{*/
240 
241  if(type==PetscMatType){
242  #ifdef _HAVE_PETSC_
243  this->pmatrix->MatMult(X->pvector,AX->pvector);
244  #endif
245  }
246  else{
247  this->imatrix->MatMult(X->ivector,AX->ivector);
248  }
249 
250  }

◆ Duplicate()

template<class doubletype >
Matrix<doubletype>* Matrix< doubletype >::Duplicate ( void  )
inline

Definition at line 252 of file Matrix.h.

252  {/*{{{*/
253 
254  Matrix<doubletype>* output=new Matrix<doubletype>();
255 
256  if(type==PetscMatType){
257  #ifdef _HAVE_PETSC_
258  output->pmatrix=this->pmatrix->Duplicate();
259  #endif
260  }
261  else{
262  output->imatrix=this->imatrix->Duplicate();
263  }
264 
265  return output;
266  }

◆ ToSerial()

template<class doubletype >
doubletype* Matrix< doubletype >::ToSerial ( void  )
inline

Definition at line 268 of file Matrix.h.

268  {/*{{{*/
269 
270  doubletype* output=NULL;
271 
272  if(type==PetscMatType){
273  #ifdef _HAVE_PETSC_
274  output=this->pmatrix->ToSerial();
275  #endif
276  }
277  else{
278  output=this->imatrix->ToSerial();
279  }
280 
281  return output;
282  }

◆ SetValues()

template<class doubletype >
void Matrix< doubletype >::SetValues ( int  m,
int *  idxm,
int  n,
int *  idxn,
IssmDouble *  values,
InsMode  mode 
)
inline

Definition at line 284 of file Matrix.h.

284  {/*{{{*/
285 
286  if(type==PetscMatType){
287  #ifdef _HAVE_PETSC_
288  this->pmatrix->SetValues(m,idxm,n,idxn,values,mode);
289  #endif
290  }
291  else{
292  this->imatrix->SetValues(m,idxm,n,idxn,values,mode);
293  }
294  }

◆ Convert()

template<class doubletype >
void Matrix< doubletype >::Convert ( MatrixType  newtype)
inline

Definition at line 296 of file Matrix.h.

296  {/*{{{*/
297 
298  if(type==PetscMatType){
299  #ifdef _HAVE_PETSC_
300  this->pmatrix->Convert(newtype);
301  #endif
302  }
303  else{
304  this->imatrix->Convert(newtype);
305  }
306 
307  }

◆ SetZero()

template<class doubletype >
void Matrix< doubletype >::SetZero ( void  )
inline

Definition at line 312 of file Matrix.h.

312  {/*{{{*/
313  if(type==PetscMatType){
314  #ifdef _HAVE_PETSC_
315  this->pmatrix->SetZero();
316  #endif
317  }
318  else{
319  this->imatrix->SetZero();
320  }
321  }

Field Documentation

◆ type

template<class doubletype >
int Matrix< doubletype >::type

Definition at line 31 of file Matrix.h.

◆ imatrix

template<class doubletype >
IssmMat<doubletype>* Matrix< doubletype >::imatrix

Definition at line 35 of file Matrix.h.

The documentation for this class was generated from the following files:
Matrix
Definition: Matrix.h:27
_assert_
#define _assert_(ignore)
Definition: exceptions.h:37
IssmDouble
double IssmDouble
Definition: types.h:37
ToolkitOptions::GetToolkitType
static char * GetToolkitType(void)
Definition: ToolkitOptions.cpp:29
IssmMat
Definition: IssmMat.h:35
IssmMatType
@ IssmMatType
Definition: Matrix.h:22
Matrix::type
int type
Definition: Matrix.h:31
Matrix::InitCheckAndSetType
void InitCheckAndSetType(void)
Definition: Matrix.h:127
Matrix::Duplicate
Matrix< doubletype > * Duplicate(void)
Definition: Matrix.h:252
_error_
#define _error_(StreamArgs)
Definition: exceptions.h:49
Vector::ivector
IssmVec< doubletype > * ivector
Definition: Vector.h:33
Matrix::imatrix
IssmMat< doubletype > * imatrix
Definition: Matrix.h:35
PetscMat
Definition: PetscMat.h:24
PetscMatType
@ PetscMatType
Definition: Matrix.h:22
Generated on Thu Jul 2 2020 08:09:29 for Ice Sheet System Model by   doxygen 1.8.19