Actual source code: ftnimpl.h
1: #pragma once
3: #include <petsc/private/petscimpl.h>
4: PETSC_INTERN PetscErrorCode PETScParseFortranArgs_Private(int *, char ***);
5: PETSC_EXTERN PetscErrorCode PetscMPIFortranDatatypeToC(MPI_Fint, MPI_Datatype *);
7: PETSC_EXTERN PetscErrorCode PetscScalarAddressToFortran(PetscObject, PetscInt, PetscScalar *, PetscScalar *, PetscInt, size_t *);
8: PETSC_EXTERN PetscErrorCode PetscScalarAddressFromFortran(PetscObject, PetscScalar *, size_t, PetscInt, PetscScalar **);
9: PETSC_EXTERN size_t PetscIntAddressToFortran(const PetscInt *, const PetscInt *);
10: PETSC_EXTERN PetscInt *PetscIntAddressFromFortran(const PetscInt *, size_t);
11: PETSC_EXTERN char *PETSC_NULL_CHARACTER_Fortran;
12: PETSC_EXTERN void *PETSC_NULL_INTEGER_Fortran;
13: PETSC_EXTERN void *PETSC_NULL_SCALAR_Fortran;
14: PETSC_EXTERN void *PETSC_NULL_DOUBLE_Fortran;
15: PETSC_EXTERN void *PETSC_NULL_REAL_Fortran;
16: PETSC_EXTERN void *PETSC_NULL_BOOL_Fortran;
17: PETSC_EXTERN void *PETSC_NULL_ENUM_Fortran;
18: PETSC_EXTERN void *PETSC_NULL_INTEGER_ARRAY_Fortran;
19: PETSC_EXTERN void *PETSC_NULL_SCALAR_ARRAY_Fortran;
20: PETSC_EXTERN void *PETSC_NULL_REAL_ARRAY_Fortran;
21: PETSC_EXTERN void *PETSC_NULL_MPI_COMM_Fortran;
22: PETSC_EXTERN void *PETSC_NULL_INTEGER_POINTER_Fortran;
23: PETSC_EXTERN void *PETSC_NULL_SCALAR_POINTER_Fortran;
24: PETSC_EXTERN void *PETSC_NULL_REAL_POINTER_Fortran;
25: PETSC_EXTERN void (*PETSC_NULL_FUNCTION_Fortran)(void);
27: PETSC_INTERN PetscErrorCode PetscInitFortran_Private(const char *, PetscInt);
29: /* ----------------------------------------------------------------------*/
30: /*
31: PETSc object C pointers are stored directly as
32: Fortran integer*4 or *8 depending on the size of pointers.
33: */
35: /* --------------------------------------------------------------------*/
36: /*
37: Since Fortran does not null terminate strings we need to insure the string is null terminated before passing it
38: to C. This may require a memory allocation which is then freed with FREECHAR().
39: */
40: #define FIXCHAR(a, n, b) \
41: do { \
42: if ((a) == PETSC_NULL_CHARACTER_Fortran) { \
43: (b) = PETSC_NULLPTR; \
44: (a) = PETSC_NULLPTR; \
45: } else { \
46: while (((n) > 0) && ((a)[(n) - 1] == ' ')) (n)--; \
47: *ierr = PetscMalloc1((n) + 1, &(b)); \
48: if (*ierr) return; \
49: *ierr = PetscMemcpy((b), (a), (n)); \
50: (b)[n] = '\0'; \
51: if (*ierr) return; \
52: } \
53: } while (0)
54: #define FREECHAR(a, b) \
55: do { \
56: if (a != b) *ierr = PetscFree(b); \
57: } while (0)
59: /*
60: Fortran expects any unneeded characters at the end of its strings to be filled with the blank character.
61: */
62: #define FIXRETURNCHAR(flg, a, n) \
63: do { \
64: if (flg) { \
65: PETSC_FORTRAN_CHARLEN_T __i; \
66: for (__i = 0; __i < n && a[__i] != 0; __i++) { }; \
67: for (; __i < n; __i++) a[__i] = ' '; \
68: } \
69: } while (0)
71: /*
72: The cast through PETSC_UINTPTR_T is so that compilers that warn about casting to/from void * to void(*)(void)
73: will not complain about these comparisons. It is not know if this works for all compilers
74: */
75: #define FORTRANNULLINTEGERPOINTER(a) (((void *)(PETSC_UINTPTR_T)a) == PETSC_NULL_INTEGER_POINTER_Fortran)
76: #define FORTRANNULLSCALARPOINTER(a) (((void *)(PETSC_UINTPTR_T)a) == PETSC_NULL_SCALAR_POINTER_Fortran)
77: #define FORTRANNULLREALPOINTER(a) (((void *)(PETSC_UINTPTR_T)a) == PETSC_NULL_REAL_POINTER_Fortran)
78: #define FORTRANNULLINTEGER(a) (((void *)(PETSC_UINTPTR_T)a) == PETSC_NULL_INTEGER_Fortran || ((void *)(PETSC_UINTPTR_T)a) == PETSC_NULL_INTEGER_ARRAY_Fortran)
79: #define FORTRANNULLSCALAR(a) (((void *)(PETSC_UINTPTR_T)a) == PETSC_NULL_SCALAR_Fortran || ((void *)(PETSC_UINTPTR_T)a) == PETSC_NULL_SCALAR_ARRAY_Fortran)
80: #define FORTRANNULLREAL(a) (((void *)(PETSC_UINTPTR_T)a) == PETSC_NULL_REAL_Fortran || ((void *)(PETSC_UINTPTR_T)a) == PETSC_NULL_REAL_ARRAY_Fortran)
81: #define FORTRANNULLDOUBLE(a) (((void *)(PETSC_UINTPTR_T)a) == PETSC_NULL_DOUBLE_Fortran)
82: #define FORTRANNULLBOOL(a) (((void *)(PETSC_UINTPTR_T)a) == PETSC_NULL_BOOL_Fortran)
83: #define FORTRANNULLENUM(a) ((((void *)(PETSC_UINTPTR_T)a) == PETSC_NULL_ENUM_Fortran) || (((void *)(PETSC_UINTPTR_T)a) == (void *)-50))
84: #define FORTRANNULLCHARACTER(a) (((void *)(PETSC_UINTPTR_T)a) == PETSC_NULL_CHARACTER_Fortran)
85: #define FORTRANNULLFUNCTION(a) (((void (*)(void))(PETSC_UINTPTR_T)a) == PETSC_NULL_FUNCTION_Fortran)
86: #define FORTRANNULLOBJECT(a) (*(void **)(PETSC_UINTPTR_T)a == (void *)0)
87: #define FORTRANNULLMPICOMM(a) (((void *)(PETSC_UINTPTR_T)a) == PETSC_NULL_MPI_COMM_Fortran)
89: /*
90: A Fortran object with a value of (void*) 0 is indicated in Fortran by PETSC_NULL_XXXX, it is passed to routines to indicate the argument value is not requested or provided
91: similar to how NULL is used with PETSc objects in C
93: A Fortran object with a value of (void*) PETSC_FORTRAN_TYPE_INITIALIZE (-2) is an object that was never created or was destroyed (see checkFortranTypeInitialize()).
95: A Fortran object with a value of (void*) -3 happens when a PETSc routine returns in one of its arguments a NULL object
96: (it cannot return a value of (void*) 0 because if later the returned variable is passed to a creation routine, it would think one has passed in a PETSC_NULL_XXX and error).
98: These three values are used because Fortran always uses pass by reference so one cannot pass a NULL address, only an address with special
99: values at the location.
100: */
102: #define CHKFORTRANNULL(a) \
103: do { \
104: if (FORTRANNULLINTEGER(a) || FORTRANNULLENUM(a) || FORTRANNULLDOUBLE(a) || FORTRANNULLSCALAR(a) || FORTRANNULLREAL(a) || FORTRANNULLBOOL(a) || FORTRANNULLFUNCTION(a) || FORTRANNULLCHARACTER(a) || FORTRANNULLMPICOMM(a)) a = PETSC_NULLPTR; \
105: } while (0)
107: #define CHKFORTRANNULLENUM(a) \
108: do { \
109: if (FORTRANNULLENUM(a)) a = PETSC_NULLPTR; \
110: } while (0)
112: #define CHKFORTRANNULLINTEGER(a) \
113: do { \
114: if (FORTRANNULLINTEGER(a) || FORTRANNULLENUM(a)) a = PETSC_NULLPTR; \
115: else if (FORTRANNULLDOUBLE(a) || FORTRANNULLSCALAR(a) || FORTRANNULLREAL(a) || FORTRANNULLBOOL(a) || FORTRANNULLFUNCTION(a) || FORTRANNULLCHARACTER(a) || FORTRANNULLMPICOMM(a)) { \
116: *ierr = PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, PETSC_ERR_ARG_WRONG, PETSC_ERROR_INITIAL, "Use PETSC_NULL_INTEGER"); \
117: *ierr = PETSC_ERR_ARG_BADPTR; \
118: return; \
119: } \
120: } while (0)
122: #define CHKFORTRANNULLSCALAR(a) \
123: do { \
124: if (FORTRANNULLSCALAR(a)) { \
125: a = PETSC_NULLPTR; \
126: } else if (FORTRANNULLINTEGER(a) || FORTRANNULLDOUBLE(a) || FORTRANNULLREAL(a) || FORTRANNULLBOOL(a) || FORTRANNULLFUNCTION(a) || FORTRANNULLCHARACTER(a) || FORTRANNULLMPICOMM(a)) { \
127: *ierr = PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, PETSC_ERR_ARG_WRONG, PETSC_ERROR_INITIAL, "Use PETSC_NULL_SCALAR"); \
128: *ierr = PETSC_ERR_ARG_BADPTR; \
129: return; \
130: } \
131: } while (0)
133: #define CHKFORTRANNULLDOUBLE(a) \
134: do { \
135: if (FORTRANNULLDOUBLE(a)) { \
136: a = PETSC_NULLPTR; \
137: } else if (FORTRANNULLINTEGER(a) || FORTRANNULLSCALAR(a) || FORTRANNULLREAL(a) || FORTRANNULLBOOL(a) || FORTRANNULLFUNCTION(a) || FORTRANNULLCHARACTER(a) || FORTRANNULLMPICOMM(a)) { \
138: *ierr = PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, PETSC_ERR_ARG_WRONG, PETSC_ERROR_INITIAL, "Use PETSC_NULL_DOUBLE"); \
139: *ierr = PETSC_ERR_ARG_BADPTR; \
140: return; \
141: } \
142: } while (0)
144: #define CHKFORTRANNULLREAL(a) \
145: do { \
146: if (FORTRANNULLREAL(a)) { \
147: a = PETSC_NULLPTR; \
148: } else if (FORTRANNULLINTEGER(a) || FORTRANNULLDOUBLE(a) || FORTRANNULLSCALAR(a) || FORTRANNULLBOOL(a) || FORTRANNULLFUNCTION(a) || FORTRANNULLCHARACTER(a) || FORTRANNULLMPICOMM(a)) { \
149: *ierr = PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, PETSC_ERR_ARG_WRONG, PETSC_ERROR_INITIAL, "Use PETSC_NULL_REAL"); \
150: *ierr = PETSC_ERR_ARG_BADPTR; \
151: return; \
152: } \
153: } while (0)
155: #define CHKFORTRANNULLOBJECT(a) \
156: do { \
157: if (!(*(void **)a)) { \
158: a = PETSC_NULLPTR; \
159: } else if (FORTRANNULLINTEGER(a) || FORTRANNULLDOUBLE(a) || FORTRANNULLSCALAR(a) || FORTRANNULLREAL(a) || FORTRANNULLBOOL(a) || FORTRANNULLFUNCTION(a) || FORTRANNULLCHARACTER(a) || FORTRANNULLMPICOMM(a)) { \
160: *ierr = PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, PETSC_ERR_ARG_WRONG, PETSC_ERROR_INITIAL, "Use PETSC_NULL_XXX where XXX is the name of a particular object class"); \
161: *ierr = PETSC_ERR_ARG_BADPTR; \
162: return; \
163: } \
164: } while (0)
166: #define CHKFORTRANNULLBOOL(a) \
167: do { \
168: if (FORTRANNULLBOOL(a)) { \
169: a = PETSC_NULLPTR; \
170: } else if (FORTRANNULLSCALAR(a) || FORTRANNULLINTEGER(a) || FORTRANNULLDOUBLE(a) || FORTRANNULLSCALAR(a) || FORTRANNULLREAL(a) || FORTRANNULLFUNCTION(a) || FORTRANNULLCHARACTER(a) || FORTRANNULLMPICOMM(a)) { \
171: *ierr = PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, PETSC_ERR_ARG_WRONG, PETSC_ERROR_INITIAL, "Use PETSC_NULL_BOOL"); \
172: *ierr = PETSC_ERR_ARG_BADPTR; \
173: return; \
174: } \
175: } while (0)
177: #define CHKFORTRANNULLFUNCTION(a) \
178: do { \
179: if (FORTRANNULLFUNCTION(a)) { \
180: a = PETSC_NULLPTR; \
181: } else if (FORTRANNULLOBJECT(a) || FORTRANNULLSCALAR(a) || FORTRANNULLDOUBLE(a) || FORTRANNULLREAL(a) || FORTRANNULLINTEGER(a) || FORTRANNULLBOOL(a) || FORTRANNULLCHARACTER(a) || FORTRANNULLMPICOMM(a)) { \
182: *ierr = PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, PETSC_ERR_ARG_WRONG, PETSC_ERROR_INITIAL, "Use PETSC_NULL_FUNCTION"); \
183: *ierr = PETSC_ERR_ARG_BADPTR; \
184: return; \
185: } \
186: } while (0)
188: #define CHKFORTRANNULLMPICOMM(a) \
189: do { \
190: if (FORTRANNULLMPICOMM(a)) { \
191: a = PETSC_NULLPTR; \
192: } else if (FORTRANNULLINTEGER(a) || FORTRANNULLDOUBLE(a) || FORTRANNULLSCALAR(a) || FORTRANNULLREAL(a) || FORTRANNULLBOOL(a) || FORTRANNULLFUNCTION(a) || FORTRANNULLCHARACTER(a)) { \
193: *ierr = PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, PETSC_ERR_ARG_WRONG, PETSC_ERROR_INITIAL, "Use PETSC_NULL_MPI_COMM"); \
194: *ierr = PETSC_ERR_ARG_BADPTR; \
195: return; \
196: } \
197: } while (0)
199: /* In the beginning of Fortran XxxCreate() ensure object is not NULL or already created */
200: #define PETSC_FORTRAN_OBJECT_CREATE(a) \
201: do { \
202: if (!(*(void **)a)) { \
203: *ierr = PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, PETSC_ERR_ARG_WRONG, PETSC_ERROR_INITIAL, "Cannot create PETSC_NULL_XXX object"); \
204: *ierr = PETSC_ERR_ARG_WRONG; \
205: return; \
206: } else if (*((void **)(a)) != (void *)-2 && *((void **)(a)) != (void *)-3) { \
207: *ierr = PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, PETSC_ERR_ARG_WRONG, PETSC_ERROR_INITIAL, "Cannot create already existing object"); \
208: *ierr = PETSC_ERR_ARG_WRONG; \
209: return; \
210: } \
211: } while (0)
213: /*
214: In the beginning of Fortran XxxDestroy(a), if the input object was destroyed, change it to a PETSc C NULL object so that it won't crash C XxxDestory()
215: If it is PETSC_NULL_XXX just return since these objects cannot be destroyed
216: */
217: #define PETSC_FORTRAN_OBJECT_F_DESTROYED_TO_C_NULL(a) \
218: do { \
219: if (!*(void **)a || *((void **)(a)) == (void *)-2 || *((void **)(a)) == (void *)-3) { \
220: *ierr = PETSC_SUCCESS; \
221: return; \
222: } \
223: } while (0)
225: /* After C XxxDestroy(a) is called, change a's state from NULL to destroyed, so that it can be used/destroyed again by Fortran.
226: E.g., in VecScatterCreateToAll(x,vscat,seq,ierr), if seq = PETSC_NULL_VEC, PETSc won't create seq. But if seq is a
227: destroyed object (e.g., as a result of a previous Fortran VecDestroy), PETSc will create seq.
228: */
229: #define PETSC_FORTRAN_OBJECT_C_NULL_TO_F_DESTROYED(a) \
230: do { \
231: *((void **)(a)) = (void *)-2; \
232: } while (0)
234: /*
235: Variable type where we stash PETSc object pointers in Fortran.
236: */
237: typedef PETSC_UINTPTR_T PetscFortranAddr;
239: /*
240: These are used to support the default viewers that are
241: created at run time, in C using the , trick.
243: The numbers here must match the numbers in include/petsc/finclude/petscsys.h
244: */
245: #define PETSC_VIEWER_DRAW_WORLD_FORTRAN 4
246: #define PETSC_VIEWER_DRAW_SELF_FORTRAN 5
247: #define PETSC_VIEWER_SOCKET_WORLD_FORTRAN 6
248: #define PETSC_VIEWER_SOCKET_SELF_FORTRAN 7
249: #define PETSC_VIEWER_STDOUT_WORLD_FORTRAN 8
250: #define PETSC_VIEWER_STDOUT_SELF_FORTRAN 9
251: #define PETSC_VIEWER_STDERR_WORLD_FORTRAN 10
252: #define PETSC_VIEWER_STDERR_SELF_FORTRAN 11
253: #define PETSC_VIEWER_BINARY_WORLD_FORTRAN 12
254: #define PETSC_VIEWER_BINARY_SELF_FORTRAN 13
255: #define PETSC_VIEWER_MATLAB_WORLD_FORTRAN 14
256: #define PETSC_VIEWER_MATLAB_SELF_FORTRAN 15
258: #include <petscviewer.h>
260: static inline PetscViewer PetscPatchDefaultViewers(PetscViewer *v)
261: {
262: if (!v) return PETSC_NULLPTR;
263: if (!(*(void **)v)) return PETSC_NULLPTR;
264: switch (*(PetscFortranAddr *)v) {
265: case PETSC_VIEWER_DRAW_WORLD_FORTRAN:
266: return PETSC_VIEWER_DRAW_WORLD;
267: case PETSC_VIEWER_DRAW_SELF_FORTRAN:
268: return PETSC_VIEWER_DRAW_SELF;
270: case PETSC_VIEWER_STDOUT_WORLD_FORTRAN:
271: return PETSC_VIEWER_STDOUT_WORLD;
272: case PETSC_VIEWER_STDOUT_SELF_FORTRAN:
273: return PETSC_VIEWER_STDOUT_SELF;
275: case PETSC_VIEWER_STDERR_WORLD_FORTRAN:
276: return PETSC_VIEWER_STDERR_WORLD;
277: case PETSC_VIEWER_STDERR_SELF_FORTRAN:
278: return PETSC_VIEWER_STDERR_SELF;
280: case PETSC_VIEWER_BINARY_WORLD_FORTRAN:
281: return PETSC_VIEWER_BINARY_WORLD;
282: case PETSC_VIEWER_BINARY_SELF_FORTRAN:
283: return PETSC_VIEWER_BINARY_SELF;
285: #if defined(PETSC_HAVE_MATLAB)
286: case PETSC_VIEWER_MATLAB_SELF_FORTRAN:
287: return PETSC_VIEWER_MATLAB_SELF;
288: case PETSC_VIEWER_MATLAB_WORLD_FORTRAN:
289: return PETSC_VIEWER_MATLAB_WORLD;
290: #endif
292: #if defined(PETSC_USE_SOCKET_VIEWER)
293: case PETSC_VIEWER_SOCKET_WORLD_FORTRAN:
294: return PETSC_VIEWER_SOCKET_WORLD;
295: case PETSC_VIEWER_SOCKET_SELF_FORTRAN:
296: return PETSC_VIEWER_SOCKET_SELF;
297: #endif
299: default:
300: return *v;
301: }
302: }
304: #if defined(PETSC_USE_SOCKET_VIEWER)
305: #define PetscPatchDefaultViewers_Fortran_Socket(vin, v) \
306: } \
307: else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_SOCKET_WORLD_FORTRAN) \
308: { \
309: v = PETSC_VIEWER_SOCKET_WORLD; \
310: } \
311: else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_SOCKET_SELF_FORTRAN) \
312: { \
313: v = PETSC_VIEWER_SOCKET_SELF
314: #else
315: #define PetscPatchDefaultViewers_Fortran_Socket(vin, v)
316: #endif
318: #define PetscPatchDefaultViewers_Fortran(vin, v) \
319: do { \
320: if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_DRAW_WORLD_FORTRAN) { \
321: v = PETSC_VIEWER_DRAW_WORLD; \
322: } else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_DRAW_SELF_FORTRAN) { \
323: v = PETSC_VIEWER_DRAW_SELF; \
324: } else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_STDOUT_WORLD_FORTRAN) { \
325: v = PETSC_VIEWER_STDOUT_WORLD; \
326: } else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_STDOUT_SELF_FORTRAN) { \
327: v = PETSC_VIEWER_STDOUT_SELF; \
328: } else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_STDERR_WORLD_FORTRAN) { \
329: v = PETSC_VIEWER_STDERR_WORLD; \
330: } else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_STDERR_SELF_FORTRAN) { \
331: v = PETSC_VIEWER_STDERR_SELF; \
332: } else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_BINARY_WORLD_FORTRAN) { \
333: v = PETSC_VIEWER_BINARY_WORLD; \
334: } else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_BINARY_SELF_FORTRAN) { \
335: v = PETSC_VIEWER_BINARY_SELF; \
336: } else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_MATLAB_WORLD_FORTRAN) { \
337: v = PETSC_VIEWER_BINARY_WORLD; \
338: } else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_MATLAB_SELF_FORTRAN) { \
339: v = PETSC_VIEWER_BINARY_SELF; \
340: PetscPatchDefaultViewers_Fortran_Socket(vin, v); \
341: } else { \
342: v = *vin; \
343: } \
344: } while (0)
346: /*
347: Allocates enough space to store Fortran function pointers in PETSc object
348: that are needed by the Fortran interface.
349: */
350: #define PetscObjectAllocateFortranPointers(obj, N) \
351: do { \
352: if (!((PetscObject)(obj))->fortran_func_pointers) { \
353: *ierr = PetscCalloc((N) * sizeof(void (*)(void)), &((PetscObject)(obj))->fortran_func_pointers); \
354: if (*ierr) return; \
355: ((PetscObject)obj)->num_fortran_func_pointers = (N); \
356: } \
357: } while (0)
359: #define PetscCallFortranVoidFunction(...) \
360: do { \
361: PetscErrorCode ierr = PETSC_SUCCESS; \
362: /* the function may or may not access ierr */ \
363: __VA_ARGS__; \
364: PetscCall(ierr); \
365: } while (0)
367: /* Entire function body, _ctx is a "special" variable that can be passed along */
368: #define PetscObjectUseFortranCallback_Private(obj, cid, types, args, cbclass) \
369: do { \
370: void(*func) types, *_ctx; \
371: PetscFunctionBegin; \
372: PetscCall(PetscObjectGetFortranCallback((PetscObject)(obj), (cbclass), (cid), (PetscVoidFn **)&func, &_ctx)); \
373: if (func) PetscCallFortranVoidFunction((*func)args); \
374: PetscFunctionReturn(PETSC_SUCCESS); \
375: } while (0)
376: #define PetscObjectUseFortranCallback(obj, cid, types, args) PetscObjectUseFortranCallback_Private(obj, cid, types, args, PETSC_FORTRAN_CALLBACK_CLASS)
377: #define PetscObjectUseFortranCallbackSubType(obj, cid, types, args) PetscObjectUseFortranCallback_Private(obj, cid, types, args, PETSC_FORTRAN_CALLBACK_SUBTYPE)
379: /* Disable deprecation warnings while building Fortran wrappers */
380: #undef PETSC_DEPRECATED_OBJECT
381: #define PETSC_DEPRECATED_OBJECT(...)
382: #undef PETSC_DEPRECATED_FUNCTION
383: #define PETSC_DEPRECATED_FUNCTION(...)
384: #undef PETSC_DEPRECATED_ENUM
385: #define PETSC_DEPRECATED_ENUM(...)
386: #undef PETSC_DEPRECATED_TYPEDEF
387: #define PETSC_DEPRECATED_TYPEDEF(...)
388: #undef PETSC_DEPRECATED_MACRO
389: #define PETSC_DEPRECATED_MACRO(...)
391: /* PGI compilers pass in f90 pointers as 2 arguments */
392: #if defined(PETSC_HAVE_F90_2PTR_ARG)
393: #define PETSC_F90_2PTR_PROTO_NOVAR , void *
394: #define PETSC_F90_2PTR_PROTO(ptr) , void *ptr
395: #define PETSC_F90_2PTR_PARAM(ptr) , ptr
396: #else
397: #define PETSC_F90_2PTR_PROTO_NOVAR
398: #define PETSC_F90_2PTR_PROTO(ptr)
399: #define PETSC_F90_2PTR_PARAM(ptr)
400: #endif
402: typedef struct {
403: char dummy;
404: } F90Array1d;
405: typedef struct {
406: char dummy;
407: } F90Array2d;
408: typedef struct {
409: char dummy;
410: } F90Array3d;
411: typedef struct {
412: char dummy;
413: } F90Array4d;
415: PETSC_EXTERN PetscErrorCode F90Array1dCreate(void *, MPI_Datatype, PetscInt, PetscInt, F90Array1d *PETSC_F90_2PTR_PROTO_NOVAR);
416: PETSC_EXTERN PetscErrorCode F90Array1dAccess(F90Array1d *, MPI_Datatype, void **PETSC_F90_2PTR_PROTO_NOVAR);
417: PETSC_EXTERN PetscErrorCode F90Array1dDestroy(F90Array1d *, MPI_Datatype PETSC_F90_2PTR_PROTO_NOVAR);
419: PETSC_EXTERN PetscErrorCode F90Array2dCreate(void *, MPI_Datatype, PetscInt, PetscInt, PetscInt, PetscInt, F90Array2d *PETSC_F90_2PTR_PROTO_NOVAR);
420: PETSC_EXTERN PetscErrorCode F90Array2dAccess(F90Array2d *, MPI_Datatype, void **PETSC_F90_2PTR_PROTO_NOVAR);
421: PETSC_EXTERN PetscErrorCode F90Array2dDestroy(F90Array2d *, MPI_Datatype PETSC_F90_2PTR_PROTO_NOVAR);
423: PETSC_EXTERN PetscErrorCode F90Array3dCreate(void *, MPI_Datatype, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, F90Array3d *PETSC_F90_2PTR_PROTO_NOVAR);
424: PETSC_EXTERN PetscErrorCode F90Array3dAccess(F90Array3d *, MPI_Datatype, void **PETSC_F90_2PTR_PROTO_NOVAR);
425: PETSC_EXTERN PetscErrorCode F90Array3dDestroy(F90Array3d *, MPI_Datatype PETSC_F90_2PTR_PROTO_NOVAR);
427: PETSC_EXTERN PetscErrorCode F90Array4dCreate(void *, MPI_Datatype, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, F90Array4d *PETSC_F90_2PTR_PROTO_NOVAR);
428: PETSC_EXTERN PetscErrorCode F90Array4dAccess(F90Array4d *, MPI_Datatype, void **PETSC_F90_2PTR_PROTO_NOVAR);
429: PETSC_EXTERN PetscErrorCode F90Array4dDestroy(F90Array4d *, MPI_Datatype PETSC_F90_2PTR_PROTO_NOVAR);
431: /*
432: F90Array1dCreate - Given a C pointer to a one dimensional
433: array and its length; this fills in the appropriate Fortran 90
434: pointer data structure.
436: Input Parameters:
437: + array - regular C pointer (address)
438: . type - DataType of the array
439: . start - starting index of the array
440: - len - length of array (in items)
442: Output Parameter:
443: . ptr - Fortran 90 pointer
444: */