xref: /petsc/src/mat/impls/shell/ftn-custom/zshellf.c (revision d18b9058a302a5932c30eaa4e142cc3ba0992349)
1 #include <petsc/private/fortranimpl.h>
2 #include <petscmat.h>
3 
4 #if defined(PETSC_HAVE_FORTRAN_CAPS)
5 #define matshellsetoperation_            MATSHELLSETOPERATION
6 #define matcreateshell_                  MATCREATESHELL
7 #elif !defined(PETSC_HAVE_FORTRAN_UNDERSCORE)
8 #define matcreateshell_                  matcreateshell
9 #define matshellsetoperation_            matshellsetoperation
10 #endif
11 
12 /**
13  * Subset of MatOperation that is supported by the Fortran wrappers.
14  */
15 enum FortranMatOperation {
16   FORTRAN_MATOP_MULT = 0,
17   FORTRAN_MATOP_MULT_ADD = 1,
18   FORTRAN_MATOP_MULT_TRANSPOSE = 2,
19   FORTRAN_MATOP_MULT_TRANSPOSE_ADD = 3,
20   FORTRAN_MATOP_SOR = 4,
21   FORTRAN_MATOP_TRANSPOSE = 5,
22   FORTRAN_MATOP_GET_DIAGONAL = 6,
23   FORTRAN_MATOP_DIAGONAL_SCALE = 7,
24   FORTRAN_MATOP_ZERO_ENTRIES = 8,
25   FORTRAN_MATOP_AXPY = 9,
26   FORTRAN_MATOP_SHIFT = 10,
27   FORTRAN_MATOP_DIAGONAL_SET = 11,
28   FORTRAN_MATOP_DESTROY = 12,
29   FORTRAN_MATOP_VIEW = 13,
30   FORTRAN_MATOP_GET_VECS = 14,
31   FORTRAN_MATOP_GET_DIAGONAL_BLOCK = 15,
32   FORTRAN_MATOP_COPY = 16,
33   FORTRAN_MATOP_SCALE = 17,
34   FORTRAN_MATOP_SIZE = 18,
35   FORTRAN_MATOP_SET_RANDOM = 19
36 };
37 
38 /*
39   The MatShell Matrix Vector product requires a C routine.
40   This C routine then calls the corresponding Fortran routine that was
41   set by the user.
42 */
43 PETSC_EXTERN void PETSC_STDCALL matcreateshell_(MPI_Comm *comm,PetscInt *m,PetscInt *n,PetscInt *M,PetscInt *N,void *ctx,Mat *mat,PetscErrorCode *ierr)
44 {
45   *ierr = MatCreateShell(MPI_Comm_f2c(*(MPI_Fint*)&*comm),*m,*n,*M,*N,ctx,mat);
46 }
47 
48 static PetscErrorCode ourmult(Mat mat,Vec x,Vec y)
49 {
50   PetscErrorCode ierr = 0;
51 
52   (*(PetscErrorCode (PETSC_STDCALL *)(Mat*,Vec*,Vec*,PetscErrorCode*))(((PetscObject) mat)->fortran_func_pointers[FORTRAN_MATOP_MULT]))(&mat,&x,&y,&ierr);
53   return ierr;
54 }
55 
56 static PetscErrorCode ourmultadd(Mat mat,Vec x,Vec y,Vec z)
57 {
58   PetscErrorCode ierr = 0;
59 
60   (*(PetscErrorCode (PETSC_STDCALL *)(Mat*,Vec*,Vec*,Vec*,PetscErrorCode*))(((PetscObject) mat)->fortran_func_pointers[FORTRAN_MATOP_MULT_ADD]))(&mat,&x,&y,&z,&ierr);
61   return ierr;
62 }
63 
64 static PetscErrorCode ourmulttranspose(Mat mat,Vec x,Vec y)
65 {
66   PetscErrorCode ierr = 0;
67 
68   (*(PetscErrorCode (PETSC_STDCALL *)(Mat*,Vec*,Vec*,PetscErrorCode*))(((PetscObject) mat)->fortran_func_pointers[FORTRAN_MATOP_MULT_TRANSPOSE]))(&mat,&x,&y,&ierr);
69   return ierr;
70 }
71 
72 static PetscErrorCode ourmulttransposeadd(Mat mat,Vec x,Vec y,Vec z)
73 {
74   PetscErrorCode ierr = 0;
75 
76   (*(PetscErrorCode (PETSC_STDCALL *)(Mat*,Vec*,Vec*,Vec*,PetscErrorCode*))(((PetscObject) mat)->fortran_func_pointers[FORTRAN_MATOP_MULT_TRANSPOSE_ADD]))(&mat,&x,&y,&z,&ierr);
77   return ierr;
78 }
79 
80 static PetscErrorCode oursor(Mat mat,Vec b,PetscReal omega,MatSORType flg,PetscReal shift,PetscInt its,PetscInt lits,Vec x)
81 {
82   PetscErrorCode ierr = 0;
83 
84   (*(PetscErrorCode (PETSC_STDCALL *)(Mat*,Vec*,PetscReal*,MatSORType*,PetscReal*,PetscInt*,PetscInt*,Vec*,PetscErrorCode*))(((PetscObject) mat)->fortran_func_pointers[FORTRAN_MATOP_SOR]))(&mat,&b,&omega,&flg,&shift,&its,&lits,&x,&ierr);
85   return ierr;
86 }
87 
88 static PetscErrorCode ourtranspose(Mat mat,MatReuse reuse,Mat *B)
89 {
90   PetscErrorCode ierr = 0;
91   Mat *b = (!B ? (Mat *) PETSC_NULL_OBJECT_Fortran : B);
92 
93   (*(PetscErrorCode (PETSC_STDCALL *)(Mat*,MatReuse*,Mat*,PetscErrorCode*))(((PetscObject) mat)->fortran_func_pointers[FORTRAN_MATOP_TRANSPOSE]))(&mat,&reuse,b,&ierr);
94   return ierr;
95 }
96 
97 static PetscErrorCode ourgetdiagonal(Mat mat,Vec x)
98 {
99   PetscErrorCode ierr = 0;
100 
101   (*(PetscErrorCode (PETSC_STDCALL *)(Mat*,Vec*,PetscErrorCode*))(((PetscObject) mat)->fortran_func_pointers[FORTRAN_MATOP_GET_DIAGONAL]))(&mat,&x,&ierr);
102   return ierr;
103 }
104 
105 static PetscErrorCode ourdiagonalscale(Mat mat,Vec l,Vec r)
106 {
107   PetscErrorCode ierr = 0;
108   Vec *a = (!l ? (Vec*) PETSC_NULL_OBJECT_Fortran : &l);
109   Vec *b = (!r ? (Vec*) PETSC_NULL_OBJECT_Fortran : &r);
110 
111   (*(PetscErrorCode (PETSC_STDCALL *)(Mat*,Vec*,Vec*,PetscErrorCode*))(((PetscObject) mat)->fortran_func_pointers[FORTRAN_MATOP_DIAGONAL_SCALE]))(&mat,a,b,&ierr);
112   return ierr;
113 }
114 
115 static PetscErrorCode ourzeroentries(Mat mat)
116 {
117   PetscErrorCode ierr = 0;
118 
119   (*(PetscErrorCode (PETSC_STDCALL *)(Mat*,PetscErrorCode*))(((PetscObject) mat)->fortran_func_pointers[FORTRAN_MATOP_ZERO_ENTRIES]))(&mat,&ierr);
120   return ierr;
121 }
122 
123 static PetscErrorCode ouraxpy(Mat mat,PetscScalar a,Mat X,MatStructure str)
124 {
125   PetscErrorCode ierr = 0;
126 
127   (*(PetscErrorCode (PETSC_STDCALL *)(Mat*,PetscScalar*,Mat*,MatStructure*,PetscErrorCode*))(((PetscObject) mat)->fortran_func_pointers[FORTRAN_MATOP_AXPY]))(&mat,&a,&X,&str,&ierr);
128   return ierr;
129 }
130 
131 static PetscErrorCode ourshift(Mat mat,PetscScalar a)
132 {
133   PetscErrorCode ierr = 0;
134 
135   (*(PetscErrorCode (PETSC_STDCALL *)(Mat*,PetscScalar*,PetscErrorCode*))(((PetscObject) mat)->fortran_func_pointers[FORTRAN_MATOP_SHIFT]))(&mat,&a,&ierr);
136   return ierr;
137 }
138 
139 static PetscErrorCode ourdiagonalset(Mat mat,Vec x,InsertMode ins)
140 {
141   PetscErrorCode ierr = 0;
142 
143   (*(PetscErrorCode (PETSC_STDCALL *)(Mat*,Vec*,InsertMode*,PetscErrorCode*))(((PetscObject) mat)->fortran_func_pointers[FORTRAN_MATOP_DIAGONAL_SET]))(&mat,&x,&ins,&ierr);
144   return ierr;
145 }
146 
147 static PetscErrorCode ourdestroy(Mat mat)
148 {
149   PetscErrorCode ierr = 0;
150 
151   (*(PetscErrorCode (PETSC_STDCALL *)(Mat*,PetscErrorCode*))(((PetscObject) mat)->fortran_func_pointers[FORTRAN_MATOP_DESTROY]))(&mat,&ierr);
152   return ierr;
153 }
154 
155 static PetscErrorCode ourview(Mat mat,PetscViewer v)
156 {
157   PetscErrorCode ierr = 0;
158 
159   (*(PetscErrorCode (PETSC_STDCALL *)(Mat*,PetscViewer*,PetscErrorCode*))(((PetscObject) mat)->fortran_func_pointers[FORTRAN_MATOP_VIEW]))(&mat,&v,&ierr);
160   return ierr;
161 }
162 
163 static PetscErrorCode ourgetvecs(Mat mat,Vec *l,Vec *r)
164 {
165   PetscErrorCode ierr = 0;
166   Vec *a = (!l ? (Vec *) PETSC_NULL_OBJECT_Fortran : l);
167   Vec *b = (!r ? (Vec *) PETSC_NULL_OBJECT_Fortran : r);
168 
169   (*(PetscErrorCode (PETSC_STDCALL *)(Mat*,Vec*,Vec*,PetscErrorCode*))(((PetscObject) mat)->fortran_func_pointers[FORTRAN_MATOP_GET_VECS]))(&mat,a,b,&ierr);
170   return ierr;
171 }
172 
173 static PetscErrorCode ourgetdiagonalblock(Mat mat,Mat *l)
174 {
175   PetscErrorCode ierr = 0;
176   (*(PetscErrorCode (PETSC_STDCALL *)(Mat*,Mat*,PetscErrorCode*))(((PetscObject) mat)->fortran_func_pointers[FORTRAN_MATOP_GET_DIAGONAL_BLOCK]))(&mat,l,&ierr);
177   return ierr;
178 }
179 
180 static PetscErrorCode ourcopy(Mat mat,Mat B,MatStructure str)
181 {
182   PetscErrorCode ierr = 0;
183   (*(PetscErrorCode (PETSC_STDCALL *)(Mat*,Mat*,MatStructure*,PetscErrorCode*))(((PetscObject) mat)->fortran_func_pointers[FORTRAN_MATOP_COPY]))(&mat,&B,&str,&ierr);
184   return ierr;
185 }
186 
187 static PetscErrorCode ourscale(Mat mat,PetscScalar a)
188 {
189   PetscErrorCode ierr = 0;
190   (*(PetscErrorCode (PETSC_STDCALL *)(Mat*,PetscScalar*,PetscErrorCode*))(((PetscObject) mat)->fortran_func_pointers[FORTRAN_MATOP_SCALE]))(&mat,&a,&ierr);
191   return ierr;
192 }
193 
194 static PetscErrorCode oursetrandom(Mat mat,PetscRandom ctx)
195 {
196   PetscErrorCode ierr = 0;
197   (*(PetscErrorCode (PETSC_STDCALL *)(Mat*,PetscRandom*,PetscErrorCode*))(((PetscObject) mat)->fortran_func_pointers[FORTRAN_MATOP_SET_RANDOM]))(&mat,&ctx,&ierr);
198   return ierr;
199 }
200 
201 PETSC_EXTERN void PETSC_STDCALL matshellsetoperation_(Mat *mat,MatOperation *op,PetscErrorCode (PETSC_STDCALL *f)(Mat*,Vec*,Vec*,PetscErrorCode*),PetscErrorCode *ierr)
202 {
203   MPI_Comm comm;
204 
205   *ierr = PetscObjectGetComm((PetscObject) *mat,&comm);if (*ierr) return;
206   PetscObjectAllocateFortranPointers(*mat,FORTRAN_MATOP_SIZE);
207 
208   switch (*op) {
209   case MATOP_MULT:
210     *ierr = MatShellSetOperation(*mat,*op,(PetscVoidFunction) ourmult);
211     ((PetscObject)*mat)->fortran_func_pointers[FORTRAN_MATOP_MULT] = (PetscVoidFunction) f;
212     break;
213   case MATOP_MULT_ADD:
214     *ierr = MatShellSetOperation(*mat,*op,(PetscVoidFunction) ourmultadd);
215     ((PetscObject)*mat)->fortran_func_pointers[FORTRAN_MATOP_MULT_ADD] = (PetscVoidFunction) f;
216     break;
217   case MATOP_MULT_TRANSPOSE:
218     *ierr = MatShellSetOperation(*mat,*op,(PetscVoidFunction) ourmulttranspose);
219     ((PetscObject)*mat)->fortran_func_pointers[FORTRAN_MATOP_MULT_TRANSPOSE] = (PetscVoidFunction) f;
220     break;
221   case MATOP_MULT_TRANSPOSE_ADD:
222     *ierr = MatShellSetOperation(*mat,*op,(PetscVoidFunction) ourmulttransposeadd);
223     ((PetscObject)*mat)->fortran_func_pointers[FORTRAN_MATOP_MULT_TRANSPOSE_ADD] = (PetscVoidFunction) f;
224     break;
225   case MATOP_SOR:
226     *ierr = MatShellSetOperation(*mat,*op,(PetscVoidFunction) oursor);
227     ((PetscObject)*mat)->fortran_func_pointers[FORTRAN_MATOP_SOR] = (PetscVoidFunction) f;
228     break;
229   case MATOP_TRANSPOSE:
230     *ierr = MatShellSetOperation(*mat,*op,(PetscVoidFunction) ourtranspose);
231     ((PetscObject)*mat)->fortran_func_pointers[FORTRAN_MATOP_TRANSPOSE] = (PetscVoidFunction) f;
232     break;
233   case MATOP_GET_DIAGONAL:
234     *ierr = MatShellSetOperation(*mat,*op,(PetscVoidFunction) ourgetdiagonal);
235     ((PetscObject)*mat)->fortran_func_pointers[FORTRAN_MATOP_GET_DIAGONAL] = (PetscVoidFunction) f;
236     break;
237   case MATOP_DIAGONAL_SCALE:
238     *ierr = MatShellSetOperation(*mat,*op,(PetscVoidFunction) ourdiagonalscale);
239     ((PetscObject)*mat)->fortran_func_pointers[FORTRAN_MATOP_DIAGONAL_SCALE] = (PetscVoidFunction) f;
240     break;
241   case MATOP_ZERO_ENTRIES:
242     *ierr = MatShellSetOperation(*mat,*op,(PetscVoidFunction) ourzeroentries);
243     ((PetscObject)*mat)->fortran_func_pointers[FORTRAN_MATOP_ZERO_ENTRIES] = (PetscVoidFunction) f;
244     break;
245   case MATOP_AXPY:
246     *ierr = MatShellSetOperation(*mat,*op,(PetscVoidFunction) ouraxpy);
247     ((PetscObject)*mat)->fortran_func_pointers[FORTRAN_MATOP_AXPY] = (PetscVoidFunction) f;
248     break;
249   case MATOP_SHIFT:
250     *ierr = MatShellSetOperation(*mat,*op,(PetscVoidFunction) ourshift);
251     ((PetscObject)*mat)->fortran_func_pointers[FORTRAN_MATOP_SHIFT] = (PetscVoidFunction) f;
252     break;
253   case MATOP_DIAGONAL_SET:
254     *ierr = MatShellSetOperation(*mat,*op,(PetscVoidFunction) ourdiagonalset);
255     ((PetscObject)*mat)->fortran_func_pointers[FORTRAN_MATOP_DIAGONAL_SET] = (PetscVoidFunction) f;
256     break;
257   case MATOP_DESTROY:
258     *ierr = MatShellSetOperation(*mat,*op,(PetscVoidFunction) ourdestroy);
259     ((PetscObject)*mat)->fortran_func_pointers[FORTRAN_MATOP_DESTROY] = (PetscVoidFunction) f;
260     break;
261   case MATOP_VIEW:
262     *ierr = MatShellSetOperation(*mat,*op,(PetscVoidFunction) ourview);
263     ((PetscObject)*mat)->fortran_func_pointers[FORTRAN_MATOP_VIEW] = (PetscVoidFunction) f;
264     break;
265   case MATOP_GET_VECS:
266     *ierr = MatShellSetOperation(*mat,*op,(PetscVoidFunction) ourgetvecs);
267     ((PetscObject)*mat)->fortran_func_pointers[FORTRAN_MATOP_GET_VECS] = (PetscVoidFunction) f;
268     break;
269   case MATOP_GET_DIAGONAL_BLOCK:
270     *ierr = MatShellSetOperation(*mat,*op,(PetscVoidFunction) ourgetdiagonalblock);
271     ((PetscObject)*mat)->fortran_func_pointers[FORTRAN_MATOP_GET_DIAGONAL_BLOCK] = (PetscVoidFunction) f;
272     break;
273   case MATOP_COPY:
274     *ierr = MatShellSetOperation(*mat,*op,(PetscVoidFunction) ourcopy);
275     ((PetscObject)*mat)->fortran_func_pointers[FORTRAN_MATOP_COPY] = (PetscVoidFunction) f;
276     break;
277   case MATOP_SCALE:
278     *ierr = MatShellSetOperation(*mat,*op,(PetscVoidFunction) ourscale);
279     ((PetscObject)*mat)->fortran_func_pointers[FORTRAN_MATOP_SCALE] = (PetscVoidFunction) f;
280     break;
281   case MATOP_SET_RANDOM:
282     *ierr = MatShellSetOperation(*mat,*op,(PetscVoidFunction) oursetrandom);
283     ((PetscObject)*mat)->fortran_func_pointers[FORTRAN_MATOP_SET_RANDOM] = (PetscVoidFunction) f;
284     break;
285   default:
286     PetscError(comm,__LINE__,"MatShellSetOperation_Fortran",__FILE__,PETSC_ERR_ARG_WRONG,PETSC_ERROR_INITIAL,"Cannot set that matrix operation");
287     *ierr = 1;
288   }
289 }
290