Actual source code: petsc.h
1: /*
2: This is the main PETSc include file (for C and C++). It is included by all
3: other PETSc include files, so it almost never has to be specifically included.
4: */
7: /* ========================================================================== */
8: /*
9: petscconf.h is contained in bmake/${PETSC_ARCH}/petscconf.h it is
10: found automatically by the compiler due to the -I${PETSC_DIR}/bmake/${PETSC_ARCH}
11: in the bmake/common/variables definition of PETSC_INCLUDE
12: */
13: #include "petscconf.h"
15: /* ========================================================================== */
16: /*
17: This facilitates using C version of PETSc from C++ and
18: C++ version from C. Use --with-c-support --with-clanguage=c++ with config/configure.py for the latter)
19: */
21: #error "PETSc configured with --with-clanguage=c++ and NOT --with-c-support - it can be used only with a C++ compiler"
22: #endif
27: #else
30: #endif
31: /* ========================================================================== */
32: /*
33: Current PETSc version number and release date
34: */
35: #include petscversion.h
37: /*
38: Currently cannot check formatting for PETSc print statements because we have our
39: own format %D and %G
40: */
41: #undef PETSC_PRINTF_FORMAT_CHECK
42: #define PETSC_PRINTF_FORMAT_CHECK(a,b)
43: #undef PETSC_FPRINTF_FORMAT_CHECK
44: #define PETSC_FPRINTF_FORMAT_CHECK(a,b)
46: /*
47: Fixes for configure time choices which impact our interface. Currently only
48: calling conventions and extra compiler checking falls under this category.
49: */
50: #if !defined(PETSC_STDCALL)
51: #define PETSC_STDCALL
52: #endif
53: #if !defined(PETSC_TEMPLATE)
54: #define PETSC_TEMPLATE
55: #endif
56: #if !defined(PETSC_HAVE_DLL_EXPORT)
57: #define PETSC_DLL_EXPORT
58: #define PETSC_DLL_IMPORT
59: #endif
60: #if !defined(PETSC_DLLEXPORT)
61: #define PETSC_DLLEXPORT
62: #endif
63: #if !defined(PETSCVEC_DLLEXPORT)
64: #define PETSCVEC_DLLEXPORT
65: #endif
66: #if !defined(PETSCMAT_DLLEXPORT)
67: #define PETSCMAT_DLLEXPORT
68: #endif
69: #if !defined(PETSCDM_DLLEXPORT)
70: #define PETSCDM_DLLEXPORT
71: #endif
72: #if !defined(PETSCKSP_DLLEXPORT)
73: #define PETSCKSP_DLLEXPORT
74: #endif
75: #if !defined(PETSCSNES_DLLEXPORT)
76: #define PETSCSNES_DLLEXPORT
77: #endif
78: #if !defined(PETSCTS_DLLEXPORT)
79: #define PETSCTS_DLLEXPORT
80: #endif
81: #if !defined(PETSCFORTRAN_DLLEXPORT)
82: #define PETSCFORTRAN_DLLEXPORT
83: #endif
84: /* ========================================================================== */
86: /*
87: Defines the interface to MPI allowing the use of all MPI functions.
89: PETSc does not use the C++ binding of MPI at ALL. The following flag
90: makes sure the C++ bindings are not included. The C++ bindings REQUIRE
91: putting mpi.h before ANY C++ include files, we cannot control this
92: with all PETSc users.
93: */
94: #define MPICH_SKIP_MPICXX 1
95: #include "mpi.h"
96: /*
97: Yuck, we need to put stdio.h AFTER mpi.h for MPICH2 with C++ compiler
98: see the top of mpicxx.h
100: The MPI STANDARD HAS TO BE CHANGED to prevent this nonsense.
101: */
102: #include <stdio.h>
104: /*MC
105: PetscErrorCode - datatype used for return error code from all PETSc functions
107: Level: beginner
109: .seealso: CHKERRQ, SETERRQ
110: M*/
111: typedef int PetscErrorCode;
113: /*MC
115: PetscCookie - A unique id used to identify each PETSc object.
116: (internal integer in the data structure used for error
117: checking). These are all defined by an offset from the lowest
118: one, PETSC_SMALLEST_COOKIE.
120: Level: advanced
121: M*/
122: typedef int PetscCookie;
124: /*MC
125: PetscEvent - id used to identify PETSc or user events - primarily for logging
127: Level: intermediate
129: .seealso: PetscLogEventRegister, PetscLogEventBegin PetscLogEventEnd
130: M*/
131: typedef int PetscEvent;
133: /*MC
134: PetscBLASInt - datatype used to represent 'int' parameters to blas functions.
136: Level: intermediate
137: M*/
138: typedef int PetscBLASInt;
140: /*MC
141: PetscMPIInt - datatype used to represent 'int' parameters to MPI functions.
143: Level: intermediate
144: M*/
145: typedef int PetscMPIInt;
147: /*MC
148: PetscEnum - datatype used to pass enum types within PETSc functions.
150: Level: intermediate
152: .seealso: PetscOptionsGetEnum, PetscOptionsEnum, PetscBagRegisterEnum
153: M*/
154: typedef enum { ENUM_DUMMY } PetscEnum;
156: /*MC
157: PetscInt - PETSc type that represents integer - used primarily to
158: represent size of objects. Its size can be configured with the option
159: --with-64-bit-indices - to be either 32bit or 64bit [default 32 bit ints]
161: Level: intermediate
163: .seealso: PetscScalar, VecSetSizes
164: M*/
165: #if defined(PETSC_USE_64BIT_INDICES)
166: typedef long long PetscInt;
167: #define MPIU_INT MPI_LONG_LONG_INT
168: #else
169: typedef int PetscInt;
170: #define MPIU_INT MPI_INT
171: #endif
173: /*
174: You can use PETSC_STDOUT as a replacement of stdout. You can also change
175: the value of PETSC_STDOUT to redirect all standard output elsewhere
176: */
180: /*MC
181: PetscPolymorphicSubroutine - allows defining a C++ polymorphic version of
182: a PETSc function that remove certain optional arguments for a simplier user interface
184: Not collective
186: Synopsis:
187: PetscPolymorphicSubroutine(Functionname,(arguments of C++ function),(arguments of C function))
188:
189: Level: developer
191: Example:
192: PetscPolymorphicSubroutine(VecNorm,(Vec x,PetscReal *r),(x,NORM_2,r)) generates the new routine
193: PetscErrorCode VecNorm(Vec x,PetscReal *r) = VecNorm(x,NORM_2,r)
195: .seealso: PetscPolymorphicFunction()
197: M*/
198: #define PetscPolymorphicSubroutine(A,B,C) PETSC_STATIC_INLINE PetscErrorCode A B {return A C;}
200: /*MC
201: PetscPolymorphicScalar - allows defining a C++ polymorphic version of
202: a PETSc function that replaces a PetscScalar * argument with a PetscScalar argument
204: Not collective
206: Synopsis:
207: PetscPolymorphicScalar(Functionname,(arguments of C++ function),(arguments of C function))
208:
209: Level: developer
211: Example:
212: PetscPolymorphicScalar(VecAXPY,(PetscScalar _t,Vec x,Vec y),(&_T,x,y)) generates the new routine
213: PetscErrorCode VecAXPY(PetscScalar _t,Vec x,Vec y) = {PetscScalar _T = _t; return VecAXPY(&_T,x,y);}
215: .seealso: PetscPolymorphicFunction(),PetscPolymorphicSubroutine()
217: M*/
218: #define PetscPolymorphicScalar(A,B,C) PETSC_STATIC_INLINE PetscErrorCode A B {PetscScalar _T = _t; return A C;}
220: /*MC
221: PetscPolymorphicFunction - allows defining a C++ polymorphic version of
222: a PETSc function that remove certain optional arguments for a simplier user interface
223: and returns the computed value (istead of an error code)
225: Not collective
227: Synopsis:
228: PetscPolymorphicFunction(Functionname,(arguments of C++ function),(arguments of C function),return type,return variable name)
229:
230: Level: developer
232: Example:
233: PetscPolymorphicFunction(VecNorm,(Vec x,NormType t),(x,t,&r),PetscReal,r) generates the new routine
234: PetscReal VecNorm(Vec x,NormType t) = {PetscReal r; VecNorm(x,t,&r); return r;}
236: .seealso: PetscPolymorphicSubroutine()
238: M*/
239: #define PetscPolymorphicFunction(A,B,C,D,E) PETSC_STATIC_INLINE D A B {D E; A C;return E;}
241: #else
242: #define PetscPolymorphicSubroutine(A,B,C)
243: #define PetscPolymorphicScalar(A,B,C)
244: #define PetscPolymorphicFunction(A,B,C,D,E)
245: #endif
247: /*
248: Extern indicates a PETSc function defined elsewhere
249: */
250: #if !defined(EXTERN)
251: #define EXTERN extern
252: #endif
254: /*
255: Defines some elementary mathematics functions and constants.
256: */
257: #include petscmath.h
259: /*
261: */
265: /*
266: Basic PETSc constants
267: */
269: /*E
270: PetscTruth - Logical variable. Actually an integer
272: Level: beginner
274: E*/
275: typedef enum { PETSC_FALSE,PETSC_TRUE } PetscTruth;
278: /*MC
279: PETSC_FALSE - False value of PetscTruth
281: Level: beginner
283: Note: Zero integer
285: .seealso: PetscTruth
286: M*/
288: /*MC
289: PETSC_TRUE - True value of PetscTruth
291: Level: beginner
293: Note: Nonzero integer
295: .seealso: PetscTruth
296: M*/
298: /*MC
299: PETSC_YES - Alias for PETSC_TRUE
301: Level: beginner
303: Note: Zero integer
305: .seealso: PetscTruth
306: M*/
307: #define PETSC_YES PETSC_TRUE
309: /*MC
310: PETSC_NO - Alias for PETSC_FALSE
312: Level: beginner
314: Note: Nonzero integer
316: .seealso: PetscTruth
317: M*/
318: #define PETSC_NO PETSC_FALSE
320: /*MC
321: PETSC_NULL - standard way of passing in a null or array or pointer
323: Level: beginner
325: Notes: accepted by many PETSc functions to not set a parameter and instead use
326: some default
328: This macro does not exist in Fortran; you must use PETSC_NULL_INTEGER,
329: PETSC_NULL_DOUBLE_PRECISION etc
331: .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_IGNORE, PETSC_DETERMINE
333: M*/
334: #define PETSC_NULL 0
336: /*MC
337: PETSC_DECIDE - standard way of passing in integer or floating point parameter
338: where you wish PETSc to use the default.
340: Level: beginner
342: .seealso: PETSC_NULL, PETSC_DEFAULT, PETSC_IGNORE, PETSC_DETERMINE
344: M*/
345: #define PETSC_DECIDE -1
347: /*MC
348: PETSC_DEFAULT - standard way of passing in integer or floating point parameter
349: where you wish PETSc to use the default.
351: Level: beginner
353: .seealso: PETSC_DECIDE, PETSC_NULL, PETSC_IGNORE, PETSC_DETERMINE
355: M*/
356: #define PETSC_DEFAULT -2
359: /*MC
360: PETSC_IGNORE - same as PETSC_NULL, means PETSc will ignore this argument
362: Level: beginner
364: Notes: accepted by many PETSc functions to not set a parameter and instead use
365: some default
367: This macro does not exist in Fortran; you must use PETSC_NULL_INTEGER,
368: PETSC_NULL_DOUBLE_PRECISION etc
370: .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_NULL, PETSC_DETERMINE
372: M*/
373: #define PETSC_IGNORE PETSC_NULL
375: /*MC
376: PETSC_DETERMINE - standard way of passing in integer or floating point parameter
377: where you wish PETSc to compute the required value.
379: Level: beginner
381: .seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_IGNORE, PETSC_NULL, VecSetSizes()
383: M*/
384: #define PETSC_DETERMINE PETSC_DECIDE
386: /*MC
387: PETSC_COMM_WORLD - the equivalent of the MPI_COMM_WORLD communicator which represents
388: all the processs that PETSc knows about.
390: Level: beginner
392: Notes: By default PETSC_COMM_WORLD and MPI_COMM_WORLD are identical unless you wish to
393: run PETSc on ONLY a subset of MPI_COMM_WORLD. In that case create your new (smaller)
394: communicator, call it, say comm, and set PETSC_COMM_WORLD = comm BEFORE calling
395: PetscInitialize()
397: .seealso: PETSC_COMM_SELF
399: M*/
402: /*MC
403: PETSC_COMM_SELF - a duplicate of the MPI_COMM_SELF communicator which represents
404: the current process
406: Level: beginner
408: Notes: PETSC_COMM_SELF and MPI_COMM_SELF are equivalent.
410: .seealso: PETSC_COMM_WORLD
412: M*/
413: #define PETSC_COMM_SELF MPI_COMM_SELF
418: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSetHelpVersionFunctions(PetscErrorCode (*)(MPI_Comm),PetscErrorCode (*)(MPI_Comm));
419: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscCommDuplicate(MPI_Comm,MPI_Comm*,int*);
420: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscCommDestroy(MPI_Comm*);
422: /*MC
423: PetscMalloc - Allocates memory
425: Input Parameter:
426: . m - number of bytes to allocate
428: Output Parameter:
429: . result - memory allocated
431: Synopsis:
432: PetscErrorCode PetscMalloc(size_t m,void **result)
434: Level: beginner
436: Notes: Memory is always allocated at least double aligned
438: If you request memory of zero size it will allocate no space and assign the pointer to 0; PetscFree() will
439: properly handle not freeing the null pointer.
441: .seealso: PetscFree(), PetscNew()
443: Concepts: memory allocation
445: M*/
446: #define PetscMalloc(a,b) ((a != 0) ? (*PetscTrMalloc)((a),__LINE__,__FUNCT__,__FILE__,__SDIR__,(void**)(b)) : (*(b) = 0,0) )
448: /*MC
449: PetscMalloc2 - Allocates 2 chunks of memory
451: Input Parameter:
452: + m1 - number of elements to allocate in 1st chunk (may be zero)
453: . t1 - type of first memory elements
454: . m2 - number of elements to allocate in 2nd chunk (may be zero)
455: - t2 - type of second memory elements
457: Output Parameter:
458: + r1 - memory allocated in first chunk
459: - r2 - memory allocated in second chunk
461: Synopsis:
462: PetscErrorCode PetscMalloc2(size_t m1,type, t1,void **r1,size_t m2,type t2,void **r2)
464: Level: developer
466: Notes: Memory of first chunk is always allocated at least double aligned
468: .seealso: PetscFree(), PetscNew(), PetscMalloc()
470: Concepts: memory allocation
472: M*/
473: #if defined(PETSC_USE_DEBUG)
474: #define PetscMalloc2(m1,t1,r1,m2,t2,r2) (PetscMalloc((m1)*sizeof(t1),r1) || PetscMalloc((m2)*sizeof(t2),r2))
475: #else
476: #define PetscMalloc2(m1,t1,r1,m2,t2,r2) (PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2),r1) || (*(r2) = (t2*)(*(r1)+m1),0))
477: #endif
479: /*MC
480: PetscMalloc3 - Allocates 3 chunks of memory
482: Input Parameter:
483: + m1 - number of elements to allocate in 1st chunk (may be zero)
484: . t1 - type of first memory elements
485: . m2 - number of elements to allocate in 2nd chunk (may be zero)
486: . t2 - type of second memory elements
487: . m3 - number of elements to allocate in 3rd chunk (may be zero)
488: - t3 - type of third memory elements
490: Output Parameter:
491: + r1 - memory allocated in first chunk
492: . r2 - memory allocated in second chunk
493: - r3 - memory allocated in third chunk
495: Synopsis:
496: PetscErrorCode PetscMalloc3(size_t m1,type, t1,void **r1,size_t m2,type t2,void **r2,size_t m3,type t3,void **r3)
498: Level: developer
500: Notes: Memory of first chunk is always allocated at least double aligned
502: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3()
504: Concepts: memory allocation
506: M*/
507: #if defined(PETSC_USE_DEBUG)
508: #define PetscMalloc3(m1,t1,r1,m2,t2,r2,m3,t3,r3) (PetscMalloc((m1)*sizeof(t1),r1) || PetscMalloc((m2)*sizeof(t2),r2) || PetscMalloc((m3)*sizeof(t3),r3))
509: #else
510: #define PetscMalloc3(m1,t1,r1,m2,t2,r2,m3,t3,r3) (PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(m3)*sizeof(t3),r1) || (*(r2) = (t2*)(*(r1)+m1),*(r3) = (t3*)(*(r2)+m2),0))
511: #endif
513: /*MC
514: PetscMalloc4 - Allocates 4 chunks of memory
516: Input Parameter:
517: + m1 - number of elements to allocate in 1st chunk (may be zero)
518: . t1 - type of first memory elements
519: . m2 - number of elements to allocate in 2nd chunk (may be zero)
520: . t2 - type of second memory elements
521: . m3 - number of elements to allocate in 3rd chunk (may be zero)
522: . t3 - type of third memory elements
523: . m4 - number of elements to allocate in 4th chunk (may be zero)
524: - t4 - type of fourth memory elements
526: Output Parameter:
527: + r1 - memory allocated in first chunk
528: . r2 - memory allocated in second chunk
529: . r3 - memory allocated in third chunk
530: - r4 - memory allocated in fourth chunk
532: Synopsis:
533: PetscErrorCode PetscMalloc4(size_t m1,type, t1,void **r1,size_t m2,type t2,void **r2,size_t m3,type t3,void **r3,size_t m4,type t4,void **r4)
535: Level: developer
537: Notes: Memory of first chunk is always allocated at least double aligned
539: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3(), PetscFree4()
541: Concepts: memory allocation
543: M*/
544: #if defined(PETSC_USE_DEBUG)
545: #define PetscMalloc4(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4) (PetscMalloc((m1)*sizeof(t1),r1) || PetscMalloc((m2)*sizeof(t2),r2) || PetscMalloc((m3)*sizeof(t3),r3) || PetscMalloc((m4)*sizeof(t4),r4))
546: #else
547: #define PetscMalloc4(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4) (PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(m3)*sizeof(t3)+(m4)*sizeof(t4),r1) || (*(r2) = (t2*)(*(r1)+m1),*(r3) = (t3*)(*(r2)+m2),*(r4) = (t4*)(*(r3)+m3),0))
548: #endif
550: /*MC
551: PetscMalloc5 - Allocates 5 chunks of memory
553: Input Parameter:
554: + m1 - number of elements to allocate in 1st chunk (may be zero)
555: . t1 - type of first memory elements
556: . m2 - number of elements to allocate in 2nd chunk (may be zero)
557: . t2 - type of second memory elements
558: . m3 - number of elements to allocate in 3rd chunk (may be zero)
559: . t3 - type of third memory elements
560: . m4 - number of elements to allocate in 4th chunk (may be zero)
561: . t4 - type of fourth memory elements
562: . m5 - number of elements to allocate in 5th chunk (may be zero)
563: - t5 - type of fifth memory elements
565: Output Parameter:
566: + r1 - memory allocated in first chunk
567: . r2 - memory allocated in second chunk
568: . r3 - memory allocated in third chunk
569: . r4 - memory allocated in fourth chunk
570: - r5 - memory allocated in fifth chunk
572: Synopsis:
573: PetscErrorCode PetscMalloc5(size_t m1,type, t1,void **r1,size_t m2,type t2,void **r2,size_t m3,type t3,void **r3,size_t m4,type t4,void **r4,size_t m5,type t5,void **r5)
575: Level: developer
577: Notes: Memory of first chunk is always allocated at least double aligned
579: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3(), PetscFree4(), PetscFree5()
581: Concepts: memory allocation
583: M*/
584: #if defined(PETSC_USE_DEBUG)
585: #define PetscMalloc5(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4,m5,t5,r5) (PetscMalloc((m1)*sizeof(t1),r1) || PetscMalloc((m2)*sizeof(t2),r2) || PetscMalloc((m3)*sizeof(t3),r3) || PetscMalloc((m4)*sizeof(t4),r4) || PetscMalloc((m5)*sizeof(t5),r5))
586: #else
587: #define PetscMalloc5(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4,m5,t5,r5) (PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(m3)*sizeof(t3)+(m4)*sizeof(t4)+(m5)*sizeof(t5),r1) || (*(r2) = (t2*)(*(r1)+m1),*(r3) = (t3*)(*(r2)+m2),*(r4) = (t4*)(*(r3)+m3),*(r5) = (t5*)(*(r4)+m4),0))
588: #endif
591: /*MC
592: PetscMalloc6 - Allocates 6 chunks of memory
594: Input Parameter:
595: + m1 - number of elements to allocate in 1st chunk (may be zero)
596: . t1 - type of first memory elements
597: . m2 - number of elements to allocate in 2nd chunk (may be zero)
598: . t2 - type of second memory elements
599: . m3 - number of elements to allocate in 3rd chunk (may be zero)
600: . t3 - type of third memory elements
601: . m4 - number of elements to allocate in 4th chunk (may be zero)
602: . t4 - type of fourth memory elements
603: . m5 - number of elements to allocate in 5th chunk (may be zero)
604: . t5 - type of fifth memory elements
605: . m6 - number of elements to allocate in 6th chunk (may be zero)
606: - t6 - type of sixth memory elements
608: Output Parameter:
609: + r1 - memory allocated in first chunk
610: . r2 - memory allocated in second chunk
611: . r3 - memory allocated in third chunk
612: . r4 - memory allocated in fourth chunk
613: . r5 - memory allocated in fifth chunk
614: - r6 - memory allocated in sixth chunk
616: Synopsis:
617: PetscErrorCode PetscMalloc6(size_t m1,type, t1,void **r1,size_t m2,type t2,void **r2,size_t m3,type t3,void **r3,size_t m4,type t4,void **r4,size_t m5,type t5,void **r5,size_t m6,type t6,void **r6)
619: Level: developer
621: Notes: Memory of first chunk is always allocated at least double aligned
623: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3(), PetscFree4(), PetscFree5(), PetscFree6()
625: Concepts: memory allocation
627: M*/
628: #if defined(PETSC_USE_DEBUG)
629: #define PetscMalloc6(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4,m5,t5,r5,m6,t6,r6) (PetscMalloc((m1)*sizeof(t1),r1) || PetscMalloc((m2)*sizeof(t2),r2) || PetscMalloc((m3)*sizeof(t3),r3) || PetscMalloc((m4)*sizeof(t4),r4) || PetscMalloc((m5)*sizeof(t5),r5) || PetscMalloc((m6)*sizeof(t6),r6))
630: #else
631: #define PetscMalloc6(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4,m5,t5,r5,m6,t6,r6) (PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(m3)*sizeof(t3)+(m4)*sizeof(t4)+(m5)*sizeof(t5)+(m6)*sizeof(t6),r1) || (*(r2) = (t2*)(*(r1)+m1),*(r3) = (t3*)(*(r2)+m2),*(r4) = (t4*)(*(r3)+m3),*(r5) = (t5*)(*(r4)+m4),*(r6) = (t6*)(*(r5)+m5),0))
632: #endif
634: /*MC
635: PetscMalloc7 - Allocates 7 chunks of memory
637: Input Parameter:
638: + m1 - number of elements to allocate in 1st chunk (may be zero)
639: . t1 - type of first memory elements
640: . m2 - number of elements to allocate in 2nd chunk (may be zero)
641: . t2 - type of second memory elements
642: . m3 - number of elements to allocate in 3rd chunk (may be zero)
643: . t3 - type of third memory elements
644: . m4 - number of elements to allocate in 4th chunk (may be zero)
645: . t4 - type of fourth memory elements
646: . m5 - number of elements to allocate in 5th chunk (may be zero)
647: . t5 - type of fifth memory elements
648: . m6 - number of elements to allocate in 6th chunk (may be zero)
649: . t6 - type of sixth memory elements
650: . m7 - number of elements to allocate in 7th chunk (may be zero)
651: - t7 - type of sixth memory elements
653: Output Parameter:
654: + r1 - memory allocated in first chunk
655: . r2 - memory allocated in second chunk
656: . r3 - memory allocated in third chunk
657: . r4 - memory allocated in fourth chunk
658: . r5 - memory allocated in fifth chunk
659: . r6 - memory allocated in sixth chunk
660: - r7 - memory allocated in sixth chunk
662: Synopsis:
663: PetscErrorCode PetscMalloc7(size_t m1,type, t1,void **r1,size_t m2,type t2,void **r2,size_t m3,type t3,void **r3,size_t m4,type t4,void **r4,size_t m5,type t5,void **r5,size_t m6,type t6,void **r6,size_t m7,type t7,void **r7)
665: Level: developer
667: Notes: Memory of first chunk is always allocated at least double aligned
669: .seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3(), PetscFree4(), PetscFree5(), PetscFree6(), PetscFree7()
671: Concepts: memory allocation
673: M*/
674: #if defined(PETSC_USE_DEBUG)
675: #define PetscMalloc7(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4,m5,t5,r5,m6,t6,r6,m7,t7,r7) (PetscMalloc((m1)*sizeof(t1),r1) || PetscMalloc((m2)*sizeof(t2),r2) || PetscMalloc((m3)*sizeof(t3),r3) || PetscMalloc((m4)*sizeof(t4),r4) || PetscMalloc((m5)*sizeof(t5),r5) || PetscMalloc((m6)*sizeof(t6),r6) || PetscMalloc((m7)*sizeof(t7),r7))
676: #else
677: #define PetscMalloc7(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4,m5,t5,r5,m6,t6,r6,m7,t7,r7) (PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(m3)*sizeof(t3)+(m4)*sizeof(t4)+(m5)*sizeof(t5)+(m6)*sizeof(t6)+(m7)*sizeof(t7),r1) || (*(r2) = (t2*)(*(r1)+m1),*(r3) = (t3*)(*(r2)+m2),*(r4) = (t4*)(*(r3)+m3),*(r5) = (t5*)(*(r4)+m4),*(r6) = (t6*)(*(r5)+m5),*(r7) = (t7*)(*(r6)+m6),0))
678: #endif
680: /*MC
681: PetscNew - Allocates memory of a particular type, zeros the memory!
683: Input Parameter:
684: . type - structure name of space to be allocated. Memory of size sizeof(type) is allocated
686: Output Parameter:
687: . result - memory allocated
689: Synopsis:
690: PetscErrorCode PetscNew(struct type,((type *))result)
692: Level: beginner
694: .seealso: PetscFree(), PetscMalloc()
696: Concepts: memory allocation
698: M*/
699: #define PetscNew(A,b) (PetscMalloc(sizeof(A),(b)) || PetscMemzero(*(b),sizeof(A)))
701: /*MC
702: PetscFree - Frees memory
704: Input Parameter:
705: . memory - memory to free
707: Synopsis:
708: PetscErrorCode PetscFree(void *memory)
710: Level: beginner
712: Notes: Memory must have been obtained with PetscNew() or PetscMalloc()
714: .seealso: PetscNew(), PetscMalloc(), PetscFreeVoid()
716: Concepts: memory allocation
718: M*/
719: #define PetscFree(a) ((a) ? ((*PetscTrFree)((a),__LINE__,__FUNCT__,__FILE__,__SDIR__) || ((a = 0),0)) : 0)
721: /*MC
722: PetscFreeVoid - Frees memory
724: Input Parameter:
725: . memory - memory to free
727: Synopsis:
728: void PetscFreeVoid(void *memory)
730: Level: beginner
732: Notes: This is different from PetscFree() in that no error code is returned
734: .seealso: PetscFree(), PetscNew(), PetscMalloc()
736: Concepts: memory allocation
738: M*/
739: #define PetscFreeVoid(a) ((*PetscTrFree)((a),__LINE__,__FUNCT__,__FILE__,__SDIR__),(a) = 0)
742: /*MC
743: PetscFree2 - Frees 2 chunks of memory obtained with PetscMalloc2()
745: Input Parameter:
746: + memory1 - memory to free
747: - memory2 - 2nd memory to free
750: Synopsis:
751: PetscErrorCode PetscFree2(void *memory1,void *memory2)
753: Level: developer
755: Notes: Memory must have been obtained with PetscMalloc2()
757: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree()
759: Concepts: memory allocation
761: M*/
762: #if defined(PETSC_USE_DEBUG)
763: #define PetscFree2(m1,m2) (PetscFree(m2) || PetscFree(m1))
764: #else
765: #define PetscFree2(m1,m2) (PetscFree(m1))
766: #endif
768: /*MC
769: PetscFree3 - Frees 3 chunks of memory obtained with PetscMalloc3()
771: Input Parameter:
772: + memory1 - memory to free
773: . memory2 - 2nd memory to free
774: - memory3 - 3rd memory to free
777: Synopsis:
778: PetscErrorCode PetscFree3(void *memory1,void *memory2,void *memory3)
780: Level: developer
782: Notes: Memory must have been obtained with PetscMalloc3()
784: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3()
786: Concepts: memory allocation
788: M*/
789: #if defined(PETSC_USE_DEBUG)
790: #define PetscFree3(m1,m2,m3) (PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
791: #else
792: #define PetscFree3(m1,m2,m3) (PetscFree(m1))
793: #endif
795: /*MC
796: PetscFree4 - Frees 4 chunks of memory obtained with PetscMalloc4()
798: Input Parameter:
799: + m1 - memory to free
800: . m2 - 2nd memory to free
801: . m3 - 3rd memory to free
802: - m4 - 4th memory to free
805: Synopsis:
806: PetscErrorCode PetscFree4(void *m1,void *m2,void *m3,void *m4)
808: Level: developer
810: Notes: Memory must have been obtained with PetscMalloc4()
812: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4()
814: Concepts: memory allocation
816: M*/
817: #if defined(PETSC_USE_DEBUG)
818: #define PetscFree4(m1,m2,m3,m4) (PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
819: #else
820: #define PetscFree4(m1,m2,m3,m4) (PetscFree(m1))
821: #endif
823: /*MC
824: PetscFree5 - Frees 5 chunks of memory obtained with PetscMalloc5()
826: Input Parameter:
827: + m1 - memory to free
828: . m2 - 2nd memory to free
829: . m3 - 3rd memory to free
830: . m4 - 4th memory to free
831: - m5 - 5th memory to free
834: Synopsis:
835: PetscErrorCode PetscFree5(void *m1,void *m2,void *m3,void *m4,void *m5)
837: Level: developer
839: Notes: Memory must have been obtained with PetscMalloc5()
841: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5()
843: Concepts: memory allocation
845: M*/
846: #if defined(PETSC_USE_DEBUG)
847: #define PetscFree5(m1,m2,m3,m4,m5) (PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
848: #else
849: #define PetscFree5(m1,m2,m3,m4,m5) (PetscFree(m1))
850: #endif
853: /*MC
854: PetscFree6 - Frees 6 chunks of memory obtained with PetscMalloc6()
856: Input Parameter:
857: + m1 - memory to free
858: . m2 - 2nd memory to free
859: . m3 - 3rd memory to free
860: . m4 - 4th memory to free
861: . m5 - 5th memory to free
862: - m6 - 6th memory to free
865: Synopsis:
866: PetscErrorCode PetscFree6(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6)
868: Level: developer
870: Notes: Memory must have been obtained with PetscMalloc6()
872: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6()
874: Concepts: memory allocation
876: M*/
877: #if defined(PETSC_USE_DEBUG)
878: #define PetscFree6(m1,m2,m3,m4,m5,m6) (PetscFree(m6) || PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
879: #else
880: #define PetscFree6(m1,m2,m3,m4,m5,m6) (PetscFree(m1))
881: #endif
883: /*MC
884: PetscFree7 - Frees 7 chunks of memory obtained with PetscMalloc7()
886: Input Parameter:
887: + m1 - memory to free
888: . m2 - 2nd memory to free
889: . m3 - 3rd memory to free
890: . m4 - 4th memory to free
891: . m5 - 5th memory to free
892: . m6 - 6th memory to free
893: - m7 - 7th memory to free
896: Synopsis:
897: PetscErrorCode PetscFree7(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6,void *m7)
899: Level: developer
901: Notes: Memory must have been obtained with PetscMalloc7()
903: .seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6(),
904: PetscMalloc7()
906: Concepts: memory allocation
908: M*/
909: #if defined(PETSC_USE_DEBUG)
910: #define PetscFree7(m1,m2,m3,m4,m5,m6,m7) (PetscFree(m7) || PetscFree(m6) || PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
911: #else
912: #define PetscFree7(m1,m2,m3,m4,m5,m6,m7) (PetscFree(m1))
913: #endif
915: EXTERN PETSC_DLLEXPORT PetscErrorCode (*PetscTrMalloc)(size_t,int,const char[],const char[],const char[],void**);
916: EXTERN PETSC_DLLEXPORT PetscErrorCode (*PetscTrFree)(void*,int,const char[],const char[],const char[]);
917: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSetMalloc(PetscErrorCode (*)(size_t,int,const char[],const char[],const char[],void**),PetscErrorCode (*)(void*,int,const char[],const char[],const char[]));
918: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscClearMalloc(void);
920: /*
921: Routines for tracing memory corruption/bleeding with default PETSc
922: memory allocation
923: */
924: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMallocDump(FILE *);
925: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMallocDumpLog(FILE *);
926: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMallocGetCurrentUsage(PetscLogDouble *);
927: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMallocGetMaximumUsage(PetscLogDouble *);
928: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMallocDebug(PetscTruth);
929: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMallocValidate(int,const char[],const char[],const char[]);
930: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMallocSetDumpLog(void);
933: /*
934: Variable type where we stash PETSc object pointers in Fortran.
935: Assumes that sizeof(long) == sizeof(void*) which is true on
936: all machines that we know. If this is not the case you should change
937: the long below to something appropriate
938: */
939: #define PetscFortranAddr long
941: /*E
942: PetscDataType - Used for handling different basic data types.
944: Level: beginner
946: .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscDataTypeToMPIDataType(),
947: PetscDataTypeGetSize()
949: E*/
950: typedef enum {PETSC_INT = 0,PETSC_DOUBLE = 1,PETSC_COMPLEX = 2, PETSC_LONG = 3 ,PETSC_SHORT = 4,PETSC_FLOAT = 5,
951: PETSC_CHAR = 6,PETSC_LOGICAL = 7,PETSC_ENUM = 8,PETSC_TRUTH=9, PETSC_LONG_DOUBLE = 10} PetscDataType;
954: #if defined(PETSC_USE_COMPLEX)
955: #define PETSC_SCALAR PETSC_COMPLEX
956: #else
957: #if defined(PETSC_USE_SINGLE)
958: #define PETSC_SCALAR PETSC_FLOAT
959: #elif defined(PETSC_USE_LONG_DOUBLE)
960: #define PETSC_SCALAR PETSC_LONG_DOUBLE
961: #elif defined(PETSC_USE_INT)
962: #define PETSC_SCALAR PETSC_INT
963: #else
964: #define PETSC_SCALAR PETSC_DOUBLE
965: #endif
966: #endif
967: #if defined(PETSC_USE_SINGLE)
968: #define PETSC_REAL PETSC_FLOAT
969: #elif defined(PETSC_USE_LONG_DOUBLE)
970: #define PETSC_REAL PETSC_LONG_DOUBLE
971: #elif defined(PETSC_USE_INT)
972: #define PETSC_REAL PETSC_INT
973: #else
974: #define PETSC_REAL PETSC_DOUBLE
975: #endif
976: #define PETSC_FORTRANADDR PETSC_LONG
978: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDataTypeToMPIDataType(PetscDataType,MPI_Datatype*);
979: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDataTypeGetSize(PetscDataType,PetscInt*);
981: /*
982: Basic memory and string operations. These are usually simple wrappers
983: around the basic Unix system calls, but a few of them have additional
984: functionality and/or error checking.
985: */
986: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMemcpy(void*,const void *,size_t);
987: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscBitMemcpy(void*,PetscInt,const void*,PetscInt,PetscInt,PetscDataType);
988: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMemmove(void*,void *,size_t);
989: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMemzero(void*,size_t);
990: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMemcmp(const void*,const void*,size_t,PetscTruth *);
991: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrlen(const char[],size_t*);
992: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrcmp(const char[],const char[],PetscTruth *);
993: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrgrt(const char[],const char[],PetscTruth *);
994: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrcasecmp(const char[],const char[],PetscTruth*);
995: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrncmp(const char[],const char[],size_t,PetscTruth*);
996: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrcpy(char[],const char[]);
997: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrcat(char[],const char[]);
998: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrncat(char[],const char[],size_t);
999: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrncpy(char[],const char[],size_t);
1000: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrchr(const char[],char,char *[]);
1001: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrtolower(char[]);
1002: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrrchr(const char[],char,char *[]);
1003: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrstr(const char[],const char[],char *[]);
1004: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrrstr(const char[],const char[],char *[]);
1005: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrallocpy(const char[],char *[]);
1006: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrreplace(MPI_Comm,const char[],char[],size_t);
1007: #define PetscStrfree(a) ((a) ? PetscFree(a) : 0)
1009: /*S
1010: PetscToken - 'Token' used for managing tokenizing strings
1012: Level: intermediate
1014: .seealso: PetscTokenCreate(), PetscTokenFind(), PetscTokenDestroy()
1015: S*/
1016: typedef struct {char token;char *array;char *current;} PetscToken;
1018: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscTokenCreate(const char[],const char,PetscToken**);
1019: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscTokenFind(PetscToken*,char *[]);
1020: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscTokenDestroy(PetscToken*);
1022: /*
1023: These are MPI operations for MPI_Allreduce() etc
1024: */
1025: EXTERN PETSC_DLLEXPORT MPI_Op PetscMaxSum_Op;
1026: #if defined(PETSC_USE_COMPLEX)
1027: EXTERN PETSC_DLLEXPORT MPI_Op PetscSum_Op;
1028: #else
1029: #define PetscSum_Op MPI_SUM
1030: #endif
1031: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMaxSum(MPI_Comm,const PetscInt[],PetscInt*,PetscInt*);
1033: /*S
1034: PetscObject - any PETSc object, PetscViewer, Mat, Vec, KSP etc
1036: Level: beginner
1038: Note: This is the base class from which all objects appear.
1040: .seealso: PetscObjectDestroy(), PetscObjectView(), PetscObjectGetName(), PetscObjectSetName()
1041: S*/
1042: typedef struct _p_PetscObject* PetscObject;
1044: /*S
1045: PetscFList - Linked list of functions, possibly stored in dynamic libraries, accessed
1046: by string name
1048: Level: advanced
1050: .seealso: PetscFListAdd(), PetscFListDestroy()
1051: S*/
1052: typedef struct _n_PetscFList *PetscFList;
1054: /*E
1055: PetscFileMode - Access mode for a file.
1057: Level: beginner
1059: FILE_MODE_READ - open a file at its beginning for reading
1061: FILE_MODE_WRITE - open a file at its beginning for writing (will create if the file does not exist)
1063: FILE_MODE_APPEND - open a file at end for writing
1065: FILE_MODE_UPDATE - open a file for updating, meaning for reading and writing
1067: FILE_MODE_APPEND_UPDATE - open a file for updating, meaning for reading and writing, at the end
1069: .seealso: PetscViewerFileSetMode()
1070: E*/
1071: typedef enum {FILE_MODE_READ, FILE_MODE_WRITE, FILE_MODE_APPEND, FILE_MODE_UPDATE, FILE_MODE_APPEND_UPDATE} PetscFileMode;
1073: #include petscviewer.h
1074: #include petscoptions.h
1076: #define PETSC_SMALLEST_COOKIE 1211211
1079: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscCookieRegister(PetscCookie *);
1081: /*
1082: Routines that get memory usage information from the OS
1083: */
1084: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMemoryGetCurrentUsage(PetscLogDouble *);
1085: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMemoryGetMaximumUsage(PetscLogDouble *);
1086: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMemorySetGetMaximumUsage(void);
1087: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMemoryShowUsage(PetscViewer,const char[]);
1089: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscInfoAllow(PetscTruth,const char []);
1090: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetTime(PetscLogDouble*);
1091: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetCPUTime(PetscLogDouble*);
1092: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSleep(int);
1094: /*
1095: Initialization of PETSc
1096: */
1097: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscInitialize(int*,char***,const char[],const char[]);
1098: PetscPolymorphicSubroutine(PetscInitialize,(int *argc,char ***args),(argc,args,PETSC_NULL,PETSC_NULL))
1099: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscInitializeNoArguments(void);
1100: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscInitialized(PetscTruth *);
1101: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFinalized(PetscTruth *);
1102: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFinalize(void);
1103: EXTERN PetscErrorCode PetscInitializeFortran(void);
1104: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetArgs(int*,char ***);
1105: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscEnd(void);
1106: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscInitializePackage(char *);
1108: /*
1110: function pointers. Since the regular C++ code expects its function pointers to be
1111: C++.
1112: */
1113: typedef void (**PetscVoidStarFunction)(void);
1114: typedef void (*PetscVoidFunction)(void);
1115: typedef PetscErrorCode (*PetscErrorCodeFunction)(void);
1117: /*
1118: PetscTryMethod - Queries an object for a method, if it exists then calls it.
1119: These are intended to be used only inside PETSc functions.
1120: */
1121: #define PetscTryMethod(obj,A,B,C) \
1122: 0;{ PetscErrorCode (*f)B, __ierr; \
1123: __PetscObjectQueryFunction((PetscObject)obj,#A,(PetscVoidStarFunction)&f);CHKERRQ(__ierr); \
1124: if (f) {__(*f)C;CHKERRQ(__ierr);}\
1125: }
1126: #define PetscUseMethod(obj,A,B,C) \
1127: 0;{ PetscErrorCode (*f)B, __ierr; \
1128: __PetscObjectQueryFunction((PetscObject)obj,A,(PetscVoidStarFunction)&f);CHKERRQ(__ierr); \
1129: if (f) {__(*f)C;CHKERRQ(__ierr);}\
1130: else {SETERRQ1(PETSC_ERR_SUP,"Cannot locate function %s in object",A);} \
1131: }
1132: /*
1133: Functions that can act on any PETSc object.
1134: */
1135: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectCreate(MPI_Comm,PetscObject*);
1136: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectDestroy(PetscObject);
1137: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectExists(PetscObject,PetscTruth*);
1138: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetComm(PetscObject,MPI_Comm *);
1139: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetCookie(PetscObject,int *);
1140: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectSetType(PetscObject,const char []);
1141: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetType(PetscObject,const char *[]);
1142: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectSetName(PetscObject,const char[]);
1143: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetName(PetscObject,const char*[]);
1144: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectReference(PetscObject);
1145: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetReference(PetscObject,PetscInt*);
1146: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectDereference(PetscObject);
1147: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetNewTag(PetscObject,PetscMPIInt *);
1148: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectView(PetscObject,PetscViewer);
1149: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectCompose(PetscObject,const char[],PetscObject);
1150: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectQuery(PetscObject,const char[],PetscObject *);
1151: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectComposeFunction(PetscObject,const char[],const char[],void (*)(void));
1152: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectSetFromOptions(PetscObject);
1153: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectSetUp(PetscObject);
1154: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscCommGetNewTag(MPI_Comm,PetscMPIInt *);
1156: /*MC
1157: PetscObjectComposeFunctionDynamic - Associates a function with a given PETSc object.
1158:
1159: Collective on PetscObject
1161: Input Parameters:
1162: + obj - the PETSc object; this must be cast with a (PetscObject), for example,
1163: PetscObjectCompose((PetscObject)mat,...);
1164: . name - name associated with the child function
1165: . fname - name of the function
1166: - ptr - function pointer (or PETSC_NULL if using dynamic libraries)
1168: Level: advanced
1170: Synopsis:
1171: PetscErrorCode PetscObjectComposeFunctionDynamic(PetscObject obj,const char name[],const char fname[],void *ptr)
1173: Notes:
1174: To remove a registered routine, pass in a PETSC_NULL rname and fnc().
1176: PetscObjectComposeFunctionDynamic() can be used with any PETSc object (such as
1177: Mat, Vec, KSP, SNES, etc.) or any user-provided object.
1180: work in C++/complex with dynamic link libraries (config/configure.py options --with-shared --with-dynamic)
1181: enabled.
1183: Concepts: objects^composing functions
1184: Concepts: composing functions
1185: Concepts: functions^querying
1186: Concepts: objects^querying
1187: Concepts: querying objects
1189: .seealso: PetscObjectQueryFunction()
1190: M*/
1191: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1192: #define PetscObjectComposeFunctionDynamic(a,b,c,d) PetscObjectComposeFunction(a,b,c,0)
1193: #else
1194: #define PetscObjectComposeFunctionDynamic(a,b,c,d) PetscObjectComposeFunction(a,b,c,(PetscVoidFunction)(d))
1195: #endif
1197: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectQueryFunction(PetscObject,const char[],void (**)(void));
1198: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectSetOptionsPrefix(PetscObject,const char[]);
1199: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectAppendOptionsPrefix(PetscObject,const char[]);
1200: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectPrependOptionsPrefix(PetscObject,const char[]);
1201: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetOptionsPrefix(PetscObject,const char*[]);
1202: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectPublish(PetscObject);
1203: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectChangeTypeName(PetscObject,const char[]);
1204: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectRegisterDestroy(PetscObject);
1205: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectRegisterDestroyAll(void);
1206: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectName(PetscObject);
1207: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscTypeCompare(PetscObject,const char[],PetscTruth*);
1209: /*
1210: Defines PETSc error handling.
1211: */
1212: #include petscerror.h
1214: /*S
1215: PetscOList - Linked list of PETSc objects, accessable by string name
1217: Level: advanced
1219: .seealso: PetscOListAdd(), PetscOListDestroy(), PetscOListFind()
1220: S*/
1221: typedef struct _n_PetscOList *PetscOList;
1223: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOListDestroy(PetscOList *);
1224: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOListFind(PetscOList,const char[],PetscObject*);
1225: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOListReverseFind(PetscOList,PetscObject,char**);
1226: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOListAdd(PetscOList *,const char[],PetscObject);
1227: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOListDuplicate(PetscOList,PetscOList *);
1229: /*
1230: Dynamic library lists. Lists of names of routines in dynamic
1231: link libraries that will be loaded as needed.
1232: */
1233: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListAdd(PetscFList*,const char[],const char[],void (*)(void));
1234: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListDestroy(PetscFList*);
1235: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListFind(MPI_Comm,PetscFList,const char[],void (**)(void));
1236: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListPrintTypes(MPI_Comm,FILE*,const char[],const char[],const char[],const char[],PetscFList);
1237: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1238: #define PetscFListAddDynamic(a,b,p,c) PetscFListAdd(a,b,p,0)
1239: #else
1240: #define PetscFListAddDynamic(a,b,p,c) PetscFListAdd(a,b,p,(void (*)(void))c)
1241: #endif
1242: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListDuplicate(PetscFList,PetscFList *);
1243: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListView(PetscFList,PetscViewer);
1244: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListConcat(const char [],const char [],char []);
1245: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListGet(PetscFList,char ***,int*);
1247: /*S
1248: PetscDLLibraryList - Linked list of dynamics libraries to search for functions
1250: Level: advanced
1252: --with-shared --with-dynamic must be used with config/configure.py to use dynamic libraries
1254: .seealso: PetscDLLibraryOpen()
1255: S*/
1256: typedef struct _n_PetscDLLibraryList *PetscDLLibraryList;
1258: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryRetrieve(MPI_Comm,const char[],char *,int,PetscTruth *);
1259: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryOpen(MPI_Comm,const char[],void **);
1260: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibrarySym(MPI_Comm,PetscDLLibraryList *,const char[],const char[],void **);
1261: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryAppend(MPI_Comm,PetscDLLibraryList *,const char[]);
1262: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryPrepend(MPI_Comm,PetscDLLibraryList *,const char[]);
1263: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryClose(PetscDLLibraryList);
1264: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryPrintPath(void);
1265: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryGetInfo(void*,const char[],const char *[]);
1266: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryCCAAppend(MPI_Comm,PetscDLLibraryList *,const char[]);
1268: /*
1269: Useful utility routines
1270: */
1271: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSplitOwnership(MPI_Comm,PetscInt*,PetscInt*);
1272: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSplitOwnershipBlock(MPI_Comm,PetscInt,PetscInt*,PetscInt*);
1273: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSequentialPhaseBegin(MPI_Comm,PetscMPIInt);
1274: PetscPolymorphicSubroutine(PetscSequentialPhaseBegin,(MPI_Comm comm),(comm,1))
1275: PetscPolymorphicSubroutine(PetscSequentialPhaseBegin,(void),(PETSC_COMM_WORLD,1))
1276: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSequentialPhaseEnd(MPI_Comm,PetscMPIInt);
1277: PetscPolymorphicSubroutine(PetscSequentialPhaseEnd,(MPI_Comm comm),(comm,1))
1278: PetscPolymorphicSubroutine(PetscSequentialPhaseEnd,(void),(PETSC_COMM_WORLD,1))
1279: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscBarrier(PetscObject);
1280: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMPIDump(FILE*);
1282: #define PetscNot(a) ((a) ? PETSC_FALSE : PETSC_TRUE)
1283: /*
1284: Defines basic graphics available from PETSc.
1285: */
1286: #include petscdraw.h
1288: /*
1289: Defines the base data structures for all PETSc objects
1290: */
1292: #include private/petscimpl.h
1294: /*
1295: Defines PETSc profiling.
1296: */
1297: #include petsclog.h
1299: /*
1300: For locking, unlocking and destroying AMS memories associated with
1301: PETSc objects. Not currently used.
1302: */
1303: #define PetscPublishAll(v) 0
1304: #define PetscObjectTakeAccess(obj) 0
1305: #define PetscObjectGrantAccess(obj) 0
1306: #define PetscObjectDepublish(obj) 0
1310: /*
1311: This code allows one to pass a MPI communicator between
1312: C and Fortran. MPI 2.0 defines a standard API for doing this.
1313: The code here is provided to allow PETSc to work with MPI 1.1
1314: standard MPI libraries.
1315: */
1316: EXTERN PetscErrorCode MPICCommToFortranComm(MPI_Comm,int *);
1317: EXTERN PetscErrorCode MPIFortranCommToCComm(int,MPI_Comm*);
1319: /*
1320: Simple PETSc parallel IO for ASCII printing
1321: */
1322: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFixFilename(const char[],char[]);
1323: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFOpen(MPI_Comm,const char[],const char[],FILE**);
1324: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFClose(MPI_Comm,FILE*);
1325: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFPrintf(MPI_Comm,FILE*,const char[],...) PETSC_PRINTF_FORMAT_CHECK(3,4);
1326: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPrintf(MPI_Comm,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3);
1328: /* These are used internally by PETSc ASCII IO routines*/
1329: #include <stdarg.h>
1330: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscVSNPrintf(char*,size_t,const char*,va_list);
1331: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscVFPrintf(FILE*,const char*,va_list);
1333: /*MC
1334: PetscErrorPrintf - Prints error messages.
1336: Not Collective
1338: Synopsis:
1339: PetscErrorCode (*PetscErrorPrintf)(const char format[],...);
1341: Input Parameters:
1342: . format - the usual printf() format string
1344: Options Database Keys:
1345: . -error_output_stderr - cause error messages to be printed to stderr instead of the
1346: (default) stdout
1349: Level: developer
1351: Fortran Note:
1352: This routine is not supported in Fortran.
1354: Concepts: error messages^printing
1355: Concepts: printing^error messages
1357: .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscHelpPrintf()
1358: M*/
1359: EXTERN PETSC_DLLEXPORT PetscErrorCode (*PetscErrorPrintf)(const char[],...);
1361: /*MC
1362: PetscHelpPrintf - Prints help messages.
1364: Not Collective
1366: Synopsis:
1367: PetscErrorCode (*PetscHelpPrintf)(const char format[],...);
1369: Input Parameters:
1370: . format - the usual printf() format string
1372: Level: developer
1374: Fortran Note:
1375: This routine is not supported in Fortran.
1377: Concepts: help messages^printing
1378: Concepts: printing^help messages
1380: .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscErrorPrintf()
1381: M*/
1382: EXTERN PETSC_DLLEXPORT PetscErrorCode (*PetscHelpPrintf)(MPI_Comm,const char[],...);
1384: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPOpen(MPI_Comm,const char[],const char[],const char[],FILE **);
1385: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPClose(MPI_Comm,FILE*);
1386: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSynchronizedPrintf(MPI_Comm,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3);
1387: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSynchronizedFPrintf(MPI_Comm,FILE*,const char[],...) PETSC_PRINTF_FORMAT_CHECK(3,4);
1388: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSynchronizedFlush(MPI_Comm);
1389: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSynchronizedFGets(MPI_Comm,FILE*,size_t,char[]);
1390: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStartMatlab(MPI_Comm,const char[],const char[],FILE**);
1391: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStartJava(MPI_Comm,const char[],const char[],FILE**);
1392: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetPetscDir(const char*[]);
1394: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPopUpSelect(MPI_Comm,char*,char*,int,char**,int*);
1396: /*S
1397: PetscObjectContainer - Simple PETSc object that contains a pointer to any required data
1399: Level: advanced
1401: .seealso: PetscObject, PetscObjectContainerCreate()
1402: S*/
1403: typedef struct _p_PetscObjectContainer* PetscObjectContainer;
1404: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectContainerGetPointer(PetscObjectContainer,void **);
1405: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectContainerSetPointer(PetscObjectContainer,void *);
1406: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectContainerDestroy(PetscObjectContainer);
1407: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectContainerCreate(MPI_Comm comm,PetscObjectContainer *);
1408: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectContainerSetUserDestroy(PetscObjectContainer, PetscErrorCode (*)(void*));
1410: /*
1411: For use in debuggers
1412: */
1416: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscIntView(PetscInt,PetscInt[],PetscViewer);
1417: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscRealView(PetscInt,PetscReal[],PetscViewer);
1418: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscScalarView(PetscInt,PetscScalar[],PetscViewer);
1420: /*
1421: Allows accessing Matlab Engine
1422: */
1423: #include petscmatlab.h
1425: /*
1426: Determine if some of the kernel computation routines use
1427: Fortran (rather than C) for the numerical calculations. On some machines
1428: and compilers (like complex numbers) the Fortran version of the routines
1429: is faster than the C/C++ versions. The flag --with-fortran-kernels
1430: should be used with config/configure.py to turn these on.
1431: */
1432: #if defined(PETSC_USE_FORTRAN_KERNELS)
1434: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTCRL)
1435: #define PETSC_USE_FORTRAN_KERNEL_MULTCRL
1436: #endif
1438: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTCSRPERM)
1439: #define PETSC_USE_FORTRAN_KERNEL_MULTCSRPERM
1440: #endif
1442: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJ)
1443: #define PETSC_USE_FORTRAN_KERNEL_MULTAIJ
1444: #endif
1446: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ)
1447: #define PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ
1448: #endif
1450: #if !defined(PETSC_USE_FORTRAN_KERNEL_NORM)
1451: #define PETSC_USE_FORTRAN_KERNEL_NORM
1452: #endif
1454: #if !defined(PETSC_USE_FORTRAN_KERNEL_MAXPY)
1455: #define PETSC_USE_FORTRAN_KERNEL_MAXPY
1456: #endif
1458: #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ)
1459: #define PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ
1460: #endif
1462: #if !defined(PETSC_USE_FORTRAN_KERNEL_RELAXAIJ)
1463: #define PETSC_USE_FORTRAN_KERNEL_RELAXAIJ
1464: #endif
1466: #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ)
1467: #define PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ
1468: #endif
1470: #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ)
1471: #define PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ
1472: #endif
1474: #if !defined(PETSC_USE_FORTRAN_KERNEL_MDOT)
1475: #define PETSC_USE_FORTRAN_KERNEL_MDOT
1476: #endif
1478: #if !defined(PETSC_USE_FORTRAN_KERNEL_XTIMESY)
1479: #define PETSC_USE_FORTRAN_KERNEL_XTIMESY
1480: #endif
1482: #if !defined(PETSC_USE_FORTRAN_KERNEL_AYPX)
1483: #define PETSC_USE_FORTRAN_KERNEL_AYPX
1484: #endif
1486: #if !defined(PETSC_USE_FORTRAN_KERNEL_WAXPY)
1487: #define PETSC_USE_FORTRAN_KERNEL_WAXPY
1488: #endif
1490: #endif
1492: /*
1493: Macros for indicating code that should be compiled with a C interface,
1494: rather than a C++ interface. Any routines that are dynamically loaded
1495: (such as the PCCreate_XXX() routines) must be wrapped so that the name
1496: mangler does not change the functions symbol name. This just hides the
1498: */
1499: #if defined(__cplusplus)
1502: #else
1505: #endif
1507: /* --------------------------------------------------------------------*/
1509: /*MC
1510: size - integer variable used to contain the number of processors in
1511: the relevent MPI_Comm
1513: Level: beginner
1515: .seealso: rank, comm
1516: M*/
1518: /*MC
1519: rank - integer variable used to contain the number of this processor relative
1520: to all in the relevent MPI_Comm
1522: Level: beginner
1524: .seealso: size, comm
1525: M*/
1527: /*MC
1528: comm - MPI_Comm used in the current routine or object
1530: Level: beginner
1532: .seealso: size, rank
1533: M*/
1535: /*MC
1536: MPI_Comm - the basic object used by MPI to determine which processes are involved in a
1537: communication
1539: Level: beginner
1541: Note: This manual page is a place-holder because MPICH does not have a manual page for MPI_Comm
1543: .seealso: size, rank, comm, PETSC_COMM_WORLD, PETSC_COMM_SELF
1544: M*/
1546: /*MC
1547: PetscScalar - PETSc type that represents either a double precision real number,
1548: a double precision complex number, a single precision real number, a long double or an int
1549: if the code is configured with --with-scalar-type=complex,float,longdouble,int
1551: Level: beginner
1553: .seealso: PetscReal, PassiveReal, PassiveScalar
1554: M*/
1556: /*MC
1557: PetscReal - PETSc type that represents a real number version of PetscScalar
1559: Level: beginner
1561: .seealso: PetscScalar, PassiveReal, PassiveScalar
1562: M*/
1564: /*MC
1565: PassiveScalar - PETSc type that represents a PetscScalar
1566: Level: beginner
1568: This is the same as a PetscScalar except in code that is automatically differentiated it is
1569: treated as a constant (not an indendent or dependent variable)
1571: .seealso: PetscReal, PassiveReal, PetscScalar
1572: M*/
1574: /*MC
1575: PassiveReal - PETSc type that represents a PetscReal
1577: Level: beginner
1579: This is the same as a PetscReal except in code that is automatically differentiated it is
1580: treated as a constant (not an indendent or dependent variable)
1582: .seealso: PetscScalar, PetscReal, PassiveScalar
1583: M*/
1585: /*MC
1586: MPIU_SCALAR - MPI datatype corresponding to PetscScalar
1588: Level: beginner
1590: Note: In MPI calls that require an MPI datatype that matches a PetscScalar or array of PetscScalars
1591: pass this value
1593: .seealso: PetscReal, PassiveReal, PassiveScalar, PetscScalar
1594: M*/
1596: /*
1597: The IBM include files define hz, here we hide it so that it may be used
1598: as a regular user variable.
1599: */
1600: #if defined(hz)
1601: #undef hz
1602: #endif
1604: /* For arrays that contain filenames or paths */
1607: #if defined(PETSC_HAVE_LIMITS_H)
1608: #include <limits.h>
1609: #endif
1610: #if defined(PETSC_HAVE_SYS_PARAM_H)
1611: #include <sys/param.h>
1612: #endif
1613: #if defined(PETSC_HAVE_SYS_TYPES_H)
1614: #include <sys/types.h>
1615: #endif
1616: #if defined(MAXPATHLEN)
1617: # define PETSC_MAX_PATH_LEN MAXPATHLEN
1618: #elif defined(MAX_PATH)
1619: # define PETSC_MAX_PATH_LEN MAX_PATH
1620: #elif defined(_MAX_PATH)
1621: # define PETSC_MAX_PATH_LEN _MAX_PATH
1622: #else
1623: # define PETSC_MAX_PATH_LEN 4096
1624: #endif
1627: #endif