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 corresponds to a NULL object in C and is indicated in Fortran by PETSC_NULL_XXXX
91: A Fortran object with a value of (void*) -2 is an object that was never created or was destroyed (see checkFortranTypeInitialize()).
92: A Fortran object with a value of (void*) -3 happens when a PETSc routine returns in one of its arguments a NULL object
93: (it cannot return a value of (void*) 0 because if later the returned variable is passed to a creation routine,
94: it would think one has passed in a PETSC_NULL_XXX and error).
96: This is needed because Fortran always uses pass by reference so one cannot pass a NULL address, only an address with special
97: values at the location.
98: */
100: #define CHKFORTRANNULL(a) \
101: do { \
102: if (FORTRANNULLINTEGER(a) || FORTRANNULLENUM(a) || FORTRANNULLDOUBLE(a) || FORTRANNULLSCALAR(a) || FORTRANNULLREAL(a) || FORTRANNULLBOOL(a) || FORTRANNULLFUNCTION(a) || FORTRANNULLCHARACTER(a) || FORTRANNULLMPICOMM(a)) { a = PETSC_NULLPTR; } \
103: } while (0)
105: #define CHKFORTRANNULLENUM(a) \
106: do { \
107: if (FORTRANNULLENUM(a)) { a = PETSC_NULLPTR; } \
108: } while (0)
110: #define CHKFORTRANNULLINTEGER(a) \
111: do { \
112: if (FORTRANNULLINTEGER(a) || FORTRANNULLENUM(a)) { \
113: a = PETSC_NULLPTR; \
114: } else if (FORTRANNULLDOUBLE(a) || FORTRANNULLSCALAR(a) || FORTRANNULLREAL(a) || FORTRANNULLBOOL(a) || FORTRANNULLFUNCTION(a) || FORTRANNULLCHARACTER(a) || FORTRANNULLMPICOMM(a)) { \
115: *ierr = PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, PETSC_ERR_ARG_WRONG, PETSC_ERROR_INITIAL, "Use PETSC_NULL_INTEGER"); \
116: *ierr = PETSC_ERR_ARG_BADPTR; \
117: return; \
118: } \
119: } while (0)
121: #define CHKFORTRANNULLSCALAR(a) \
122: do { \
123: if (FORTRANNULLSCALAR(a)) { \
124: a = PETSC_NULLPTR; \
125: } else if (FORTRANNULLINTEGER(a) || FORTRANNULLDOUBLE(a) || FORTRANNULLREAL(a) || FORTRANNULLBOOL(a) || FORTRANNULLFUNCTION(a) || FORTRANNULLCHARACTER(a) || FORTRANNULLMPICOMM(a)) { \
126: *ierr = PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, PETSC_ERR_ARG_WRONG, PETSC_ERROR_INITIAL, "Use PETSC_NULL_SCALAR"); \
127: *ierr = PETSC_ERR_ARG_BADPTR; \
128: return; \
129: } \
130: } while (0)
132: #define CHKFORTRANNULLDOUBLE(a) \
133: do { \
134: if (FORTRANNULLDOUBLE(a)) { \
135: a = PETSC_NULLPTR; \
136: } else if (FORTRANNULLINTEGER(a) || FORTRANNULLSCALAR(a) || FORTRANNULLREAL(a) || FORTRANNULLBOOL(a) || FORTRANNULLFUNCTION(a) || FORTRANNULLCHARACTER(a) || FORTRANNULLMPICOMM(a)) { \
137: *ierr = PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, PETSC_ERR_ARG_WRONG, PETSC_ERROR_INITIAL, "Use PETSC_NULL_DOUBLE"); \
138: *ierr = PETSC_ERR_ARG_BADPTR; \
139: return; \
140: } \
141: } while (0)
143: #define CHKFORTRANNULLREAL(a) \
144: do { \
145: if (FORTRANNULLREAL(a)) { \
146: a = PETSC_NULLPTR; \
147: } else if (FORTRANNULLINTEGER(a) || FORTRANNULLDOUBLE(a) || FORTRANNULLSCALAR(a) || FORTRANNULLBOOL(a) || FORTRANNULLFUNCTION(a) || FORTRANNULLCHARACTER(a) || FORTRANNULLMPICOMM(a)) { \
148: *ierr = PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, PETSC_ERR_ARG_WRONG, PETSC_ERROR_INITIAL, "Use PETSC_NULL_REAL"); \
149: *ierr = PETSC_ERR_ARG_BADPTR; \
150: return; \
151: } \
152: } while (0)
154: #define CHKFORTRANNULLOBJECT(a) \
155: do { \
156: if (!(*(void **)a)) { \
157: a = PETSC_NULLPTR; \
158: } else if (FORTRANNULLINTEGER(a) || FORTRANNULLDOUBLE(a) || FORTRANNULLSCALAR(a) || FORTRANNULLREAL(a) || FORTRANNULLBOOL(a) || FORTRANNULLFUNCTION(a) || FORTRANNULLCHARACTER(a) || FORTRANNULLMPICOMM(a)) { \
159: *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"); \
160: *ierr = PETSC_ERR_ARG_BADPTR; \
161: return; \
162: } \
163: } while (0)
165: #define CHKFORTRANNULLBOOL(a) \
166: do { \
167: if (FORTRANNULLBOOL(a)) { \
168: a = PETSC_NULLPTR; \
169: } else if (FORTRANNULLSCALAR(a) || FORTRANNULLINTEGER(a) || FORTRANNULLDOUBLE(a) || FORTRANNULLSCALAR(a) || FORTRANNULLREAL(a) || FORTRANNULLFUNCTION(a) || FORTRANNULLCHARACTER(a) || FORTRANNULLMPICOMM(a)) { \
170: *ierr = PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, PETSC_ERR_ARG_WRONG, PETSC_ERROR_INITIAL, "Use PETSC_NULL_BOOL"); \
171: *ierr = PETSC_ERR_ARG_BADPTR; \
172: return; \
173: } \
174: } while (0)
176: #define CHKFORTRANNULLFUNCTION(a) \
177: do { \
178: if (FORTRANNULLFUNCTION(a)) { \
179: a = PETSC_NULLPTR; \
180: } else if (FORTRANNULLOBJECT(a) || FORTRANNULLSCALAR(a) || FORTRANNULLDOUBLE(a) || FORTRANNULLREAL(a) || FORTRANNULLINTEGER(a) || FORTRANNULLBOOL(a) || FORTRANNULLCHARACTER(a) || FORTRANNULLMPICOMM(a)) { \
181: *ierr = PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, PETSC_ERR_ARG_WRONG, PETSC_ERROR_INITIAL, "Use PETSC_NULL_FUNCTION"); \
182: *ierr = PETSC_ERR_ARG_BADPTR; \
183: return; \
184: } \
185: } while (0)
187: #define CHKFORTRANNULLMPICOMM(a) \
188: do { \
189: if (FORTRANNULLMPICOMM(a)) { \
190: a = PETSC_NULLPTR; \
191: } else if (FORTRANNULLINTEGER(a) || FORTRANNULLDOUBLE(a) || FORTRANNULLSCALAR(a) || FORTRANNULLREAL(a) || FORTRANNULLBOOL(a) || FORTRANNULLFUNCTION(a) || FORTRANNULLCHARACTER(a)) { \
192: *ierr = PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, PETSC_ERR_ARG_WRONG, PETSC_ERROR_INITIAL, "Use PETSC_NULL_MPI_COMM"); \
193: *ierr = PETSC_ERR_ARG_BADPTR; \
194: return; \
195: } \
196: } while (0)
198: /* In the beginning of Fortran XxxCreate() ensure object is not NULL or already created */
199: #define PETSC_FORTRAN_OBJECT_CREATE(a) \
200: do { \
201: if (!(*(void **)a)) { \
202: *ierr = PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, PETSC_ERR_ARG_WRONG, PETSC_ERROR_INITIAL, "Cannot create PETSC_NULL_XXX object"); \
203: *ierr = PETSC_ERR_ARG_WRONG; \
204: return; \
205: } else if (*((void **)(a)) != (void *)-2 && *((void **)(a)) != (void *)-3) { \
206: *ierr = PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, PETSC_ERR_ARG_WRONG, PETSC_ERROR_INITIAL, "Cannot create already existing object"); \
207: *ierr = PETSC_ERR_ARG_WRONG; \
208: return; \
209: } \
210: } while (0)
212: /*
213: 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()
214: If it is PETSC_NULL_XXX just return since these objects cannot be destroyed
215: */
216: #define PETSC_FORTRAN_OBJECT_F_DESTROYED_TO_C_NULL(a) \
217: do { \
218: if (!*(void **)a || *((void **)(a)) == (void *)-2 || *((void **)(a)) == (void *)-3) { \
219: *ierr = PETSC_SUCCESS; \
220: return; \
221: } \
222: } while (0)
224: /* After C XxxDestroy(a) is called, change a's state from NULL to destroyed, so that it can be used/destroyed again by Fortran.
225: E.g., in VecScatterCreateToAll(x,vscat,seq,ierr), if seq = PETSC_NULL_VEC, petsc won't create seq. But if seq is a
226: destroyed object (e.g., as a result of a previous Fortran VecDestroy), petsc will create seq.
227: */
228: #define PETSC_FORTRAN_OBJECT_C_NULL_TO_F_DESTROYED(a) \
229: do { \
230: *((void **)(a)) = (void *)-2; \
231: } while (0)
233: /*
234: Variable type where we stash PETSc object pointers in Fortran.
235: */
236: typedef PETSC_UINTPTR_T PetscFortranAddr;
238: /*
239: These are used to support the default viewers that are
240: created at run time, in C using the , trick.
242: The numbers here must match the numbers in include/petsc/finclude/petscsys.h
243: */
244: #define PETSC_VIEWER_DRAW_WORLD_FORTRAN 4
245: #define PETSC_VIEWER_DRAW_SELF_FORTRAN 5
246: #define PETSC_VIEWER_SOCKET_WORLD_FORTRAN 6
247: #define PETSC_VIEWER_SOCKET_SELF_FORTRAN 7
248: #define PETSC_VIEWER_STDOUT_WORLD_FORTRAN 8
249: #define PETSC_VIEWER_STDOUT_SELF_FORTRAN 9
250: #define PETSC_VIEWER_STDERR_WORLD_FORTRAN 10
251: #define PETSC_VIEWER_STDERR_SELF_FORTRAN 11
252: #define PETSC_VIEWER_BINARY_WORLD_FORTRAN 12
253: #define PETSC_VIEWER_BINARY_SELF_FORTRAN 13
254: #define PETSC_VIEWER_MATLAB_WORLD_FORTRAN 14
255: #define PETSC_VIEWER_MATLAB_SELF_FORTRAN 15
257: #include <petscviewer.h>
259: static inline PetscViewer PetscPatchDefaultViewers(PetscViewer *v)
260: {
261: if (!v) return PETSC_NULLPTR;
262: if (!(*(void **)v)) return PETSC_NULLPTR;
263: switch (*(PetscFortranAddr *)v) {
264: case PETSC_VIEWER_DRAW_WORLD_FORTRAN:
265: return PETSC_VIEWER_DRAW_WORLD;
266: case PETSC_VIEWER_DRAW_SELF_FORTRAN:
267: return PETSC_VIEWER_DRAW_SELF;
269: case PETSC_VIEWER_STDOUT_WORLD_FORTRAN:
270: return PETSC_VIEWER_STDOUT_WORLD;
271: case PETSC_VIEWER_STDOUT_SELF_FORTRAN:
272: return PETSC_VIEWER_STDOUT_SELF;
274: case PETSC_VIEWER_STDERR_WORLD_FORTRAN:
275: return PETSC_VIEWER_STDERR_WORLD;
276: case PETSC_VIEWER_STDERR_SELF_FORTRAN:
277: return PETSC_VIEWER_STDERR_SELF;
279: case PETSC_VIEWER_BINARY_WORLD_FORTRAN:
280: return PETSC_VIEWER_BINARY_WORLD;
281: case PETSC_VIEWER_BINARY_SELF_FORTRAN:
282: return PETSC_VIEWER_BINARY_SELF;
284: #if defined(PETSC_HAVE_MATLAB)
285: case PETSC_VIEWER_MATLAB_SELF_FORTRAN:
286: return PETSC_VIEWER_MATLAB_SELF;
287: case PETSC_VIEWER_MATLAB_WORLD_FORTRAN:
288: return PETSC_VIEWER_MATLAB_WORLD;
289: #endif
291: #if defined(PETSC_USE_SOCKET_VIEWER)
292: case PETSC_VIEWER_SOCKET_WORLD_FORTRAN:
293: return PETSC_VIEWER_SOCKET_WORLD;
294: case PETSC_VIEWER_SOCKET_SELF_FORTRAN:
295: return PETSC_VIEWER_SOCKET_SELF;
296: #endif
298: default:
299: return *v;
300: }
301: }
303: #if defined(PETSC_USE_SOCKET_VIEWER)
304: #define PetscPatchDefaultViewers_Fortran_Socket(vin, v) \
305: } \
306: else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_SOCKET_WORLD_FORTRAN) \
307: { \
308: v = PETSC_VIEWER_SOCKET_WORLD; \
309: } \
310: else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_SOCKET_SELF_FORTRAN) \
311: { \
312: v = PETSC_VIEWER_SOCKET_SELF
313: #else
314: #define PetscPatchDefaultViewers_Fortran_Socket(vin, v)
315: #endif
317: #define PetscPatchDefaultViewers_Fortran(vin, v) \
318: do { \
319: if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_DRAW_WORLD_FORTRAN) { \
320: v = PETSC_VIEWER_DRAW_WORLD; \
321: } else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_DRAW_SELF_FORTRAN) { \
322: v = PETSC_VIEWER_DRAW_SELF; \
323: } else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_STDOUT_WORLD_FORTRAN) { \
324: v = PETSC_VIEWER_STDOUT_WORLD; \
325: } else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_STDOUT_SELF_FORTRAN) { \
326: v = PETSC_VIEWER_STDOUT_SELF; \
327: } else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_STDERR_WORLD_FORTRAN) { \
328: v = PETSC_VIEWER_STDERR_WORLD; \
329: } else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_STDERR_SELF_FORTRAN) { \
330: v = PETSC_VIEWER_STDERR_SELF; \
331: } else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_BINARY_WORLD_FORTRAN) { \
332: v = PETSC_VIEWER_BINARY_WORLD; \
333: } else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_BINARY_SELF_FORTRAN) { \
334: v = PETSC_VIEWER_BINARY_SELF; \
335: } else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_MATLAB_WORLD_FORTRAN) { \
336: v = PETSC_VIEWER_BINARY_WORLD; \
337: } else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_MATLAB_SELF_FORTRAN) { \
338: v = PETSC_VIEWER_BINARY_SELF; \
339: PetscPatchDefaultViewers_Fortran_Socket(vin, v); \
340: } else { \
341: v = *vin; \
342: } \
343: } while (0)
345: /*
346: Allocates enough space to store Fortran function pointers in PETSc object
347: that are needed by the Fortran interface.
348: */
349: #define PetscObjectAllocateFortranPointers(obj, N) \
350: do { \
351: if (!((PetscObject)(obj))->fortran_func_pointers) { \
352: *ierr = PetscCalloc((N) * sizeof(void (*)(void)), &((PetscObject)(obj))->fortran_func_pointers); \
353: if (*ierr) return; \
354: ((PetscObject)obj)->num_fortran_func_pointers = (N); \
355: } \
356: } while (0)
358: #define PetscCallFortranVoidFunction(...) \
359: do { \
360: PetscErrorCode ierr = PETSC_SUCCESS; \
361: /* the function may or may not access ierr */ \
362: __VA_ARGS__; \
363: PetscCall(ierr); \
364: } while (0)
366: /* Entire function body, _ctx is a "special" variable that can be passed along */
367: #define PetscObjectUseFortranCallback_Private(obj, cid, types, args, cbclass) \
368: do { \
369: void(*func) types, *_ctx; \
370: PetscFunctionBegin; \
371: PetscCall(PetscObjectGetFortranCallback((PetscObject)(obj), (cbclass), (cid), (PetscVoidFn **)&func, &_ctx)); \
372: if (func) PetscCallFortranVoidFunction((*func)args); \
373: PetscFunctionReturn(PETSC_SUCCESS); \
374: } while (0)
375: #define PetscObjectUseFortranCallback(obj, cid, types, args) PetscObjectUseFortranCallback_Private(obj, cid, types, args, PETSC_FORTRAN_CALLBACK_CLASS)
376: #define PetscObjectUseFortranCallbackSubType(obj, cid, types, args) PetscObjectUseFortranCallback_Private(obj, cid, types, args, PETSC_FORTRAN_CALLBACK_SUBTYPE)
378: /* Disable deprecation warnings while building Fortran wrappers */
379: #undef PETSC_DEPRECATED_OBJECT
380: #define PETSC_DEPRECATED_OBJECT(...)
381: #undef PETSC_DEPRECATED_FUNCTION
382: #define PETSC_DEPRECATED_FUNCTION(...)
383: #undef PETSC_DEPRECATED_ENUM
384: #define PETSC_DEPRECATED_ENUM(...)
385: #undef PETSC_DEPRECATED_TYPEDEF
386: #define PETSC_DEPRECATED_TYPEDEF(...)
387: #undef PETSC_DEPRECATED_MACRO
388: #define PETSC_DEPRECATED_MACRO(...)
390: /* PGI compilers pass in f90 pointers as 2 arguments */
391: #if defined(PETSC_HAVE_F90_2PTR_ARG)
392: #define PETSC_F90_2PTR_PROTO_NOVAR , void *
393: #define PETSC_F90_2PTR_PROTO(ptr) , void *ptr
394: #define PETSC_F90_2PTR_PARAM(ptr) , ptr
395: #else
396: #define PETSC_F90_2PTR_PROTO_NOVAR
397: #define PETSC_F90_2PTR_PROTO(ptr)
398: #define PETSC_F90_2PTR_PARAM(ptr)
399: #endif
401: typedef struct {
402: char dummy;
403: } F90Array1d;
404: typedef struct {
405: char dummy;
406: } F90Array2d;
407: typedef struct {
408: char dummy;
409: } F90Array3d;
410: typedef struct {
411: char dummy;
412: } F90Array4d;
414: PETSC_EXTERN PetscErrorCode F90Array1dCreate(void *, MPI_Datatype, PetscInt, PetscInt, F90Array1d *PETSC_F90_2PTR_PROTO_NOVAR);
415: PETSC_EXTERN PetscErrorCode F90Array1dAccess(F90Array1d *, MPI_Datatype, void **PETSC_F90_2PTR_PROTO_NOVAR);
416: PETSC_EXTERN PetscErrorCode F90Array1dDestroy(F90Array1d *, MPI_Datatype PETSC_F90_2PTR_PROTO_NOVAR);
418: PETSC_EXTERN PetscErrorCode F90Array2dCreate(void *, MPI_Datatype, PetscInt, PetscInt, PetscInt, PetscInt, F90Array2d *PETSC_F90_2PTR_PROTO_NOVAR);
419: PETSC_EXTERN PetscErrorCode F90Array2dAccess(F90Array2d *, MPI_Datatype, void **PETSC_F90_2PTR_PROTO_NOVAR);
420: PETSC_EXTERN PetscErrorCode F90Array2dDestroy(F90Array2d *, MPI_Datatype PETSC_F90_2PTR_PROTO_NOVAR);
422: PETSC_EXTERN PetscErrorCode F90Array3dCreate(void *, MPI_Datatype, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, F90Array3d *PETSC_F90_2PTR_PROTO_NOVAR);
423: PETSC_EXTERN PetscErrorCode F90Array3dAccess(F90Array3d *, MPI_Datatype, void **PETSC_F90_2PTR_PROTO_NOVAR);
424: PETSC_EXTERN PetscErrorCode F90Array3dDestroy(F90Array3d *, MPI_Datatype PETSC_F90_2PTR_PROTO_NOVAR);
426: PETSC_EXTERN PetscErrorCode F90Array4dCreate(void *, MPI_Datatype, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, F90Array4d *PETSC_F90_2PTR_PROTO_NOVAR);
427: PETSC_EXTERN PetscErrorCode F90Array4dAccess(F90Array4d *, MPI_Datatype, void **PETSC_F90_2PTR_PROTO_NOVAR);
428: PETSC_EXTERN PetscErrorCode F90Array4dDestroy(F90Array4d *, MPI_Datatype PETSC_F90_2PTR_PROTO_NOVAR);
430: /*
431: F90Array1dCreate - Given a C pointer to a one dimensional
432: array and its length; this fills in the appropriate Fortran 90
433: pointer data structure.
435: Input Parameters:
436: + array - regular C pointer (address)
437: . type - DataType of the array
438: . start - starting index of the array
439: - len - length of array (in items)
441: Output Parameter:
442: . ptr - Fortran 90 pointer
443: */