Actual source code: petscsys.h

petsc-dev 2014-02-02
Report Typos and Errors
  1: !
  2: !
  3: !  Base include file for Fortran use of the PETSc package.
  4: !
  5: #include "petscconf.h"
 6:  #include petscversion.h
 7:  #include finclude/petscsysdef.h

  9: #if !defined(PETSC_AVOID_MPIF_H)
 10: #include "mpif.h"
 11: #endif

 13: ! ------------------------------------------------------------------------
 14: !     Non Common block Stuff declared first
 15: !
 16: !     Flags
 17: !
 18:       PetscBool  PETSC_TRUE
 19:       PetscBool  PETSC_FALSE
 20: #if defined(PETSC_FORTRAN_PETSCTRUTH_INT)
 21:       parameter (PETSC_TRUE = 1,PETSC_FALSE = 0)
 22: #else
 23:       parameter (PETSC_TRUE = .true.,PETSC_FALSE = .false.)
 24: #endif
 25:       PetscInt   PETSC_DECIDE,PETSC_DETERMINE
 26:       parameter (PETSC_DECIDE=-1,PETSC_DETERMINE=-1)

 28:       PetscInt  PETSC_DEFAULT_INTEGER
 29:       parameter (PETSC_DEFAULT_INTEGER = -2)

 31:       PetscReal PETSC_DEFAULT_REAL
 32:       parameter (PETSC_DEFAULT_REAL=-2.0d0)

 34:       PetscEnum PETSC_FP_TRAP_OFF
 35:       PetscEnum PETSC_FP_TRAP_ON
 36:       parameter (PETSC_FP_TRAP_OFF = 0,PETSC_FP_TRAP_ON = 1)



 40: !
 41: !     Default PetscViewers.
 42: !
 43:       PetscFortranAddr PETSC_VIEWER_DRAW_WORLD
 44:       PetscFortranAddr PETSC_VIEWER_DRAW_SELF
 45:       PetscFortranAddr PETSC_VIEWER_SOCKET_WORLD
 46:       PetscFortranAddr PETSC_VIEWER_SOCKET_SELF
 47:       PetscFortranAddr PETSC_VIEWER_STDOUT_WORLD
 48:       PetscFortranAddr PETSC_VIEWER_STDOUT_SELF
 49:       PetscFortranAddr PETSC_VIEWER_STDERR_WORLD
 50:       PetscFortranAddr PETSC_VIEWER_STDERR_SELF
 51:       PetscFortranAddr PETSC_VIEWER_BINARY_WORLD
 52:       PetscFortranAddr PETSC_VIEWER_BINARY_SELF
 53:       PetscFortranAddr PETSC_VIEWER_MATLAB_WORLD
 54:       PetscFortranAddr PETSC_VIEWER_MATLAB_SELF

 56: !
 57: !     The numbers used below should match those in
 58: !     petsc-private/fortranimpl.h
 59: !
 60:       parameter (PETSC_VIEWER_DRAW_WORLD   = 4)
 61:       parameter (PETSC_VIEWER_DRAW_SELF    = 5)
 62:       parameter (PETSC_VIEWER_SOCKET_WORLD = 6)
 63:       parameter (PETSC_VIEWER_SOCKET_SELF  = 7)
 64:       parameter (PETSC_VIEWER_STDOUT_WORLD = 8)
 65:       parameter (PETSC_VIEWER_STDOUT_SELF  = 9)
 66:       parameter (PETSC_VIEWER_STDERR_WORLD = 10)
 67:       parameter (PETSC_VIEWER_STDERR_SELF  = 11)
 68:       parameter (PETSC_VIEWER_BINARY_WORLD = 12)
 69:       parameter (PETSC_VIEWER_BINARY_SELF  = 13)
 70:       parameter (PETSC_VIEWER_MATLAB_WORLD = 14)
 71:       parameter (PETSC_VIEWER_MATLAB_SELF  = 15)
 72: !
 73: !     PETSc DataTypes
 74: !
 75:       PetscEnum PETSC_INT
 76:       PetscEnum PETSC_DOUBLE
 77:       PetscEnum PETSC_COMPLEX
 78:       PetscEnum PETSC_LONG
 79:       PetscEnum PETSC_SHORT
 80:       PetscEnum PETSC_FLOAT
 81:       PetscEnum PETSC_CHAR
 82:       PetscEnum PETSC_BIT_LOGICAL
 83:       PetscEnum PETSC_ENUM
 84:       PetscEnum PETSC_BOOL
 85:       PetscEnum PETSC___FLOAT128

 87: #if defined(PETSC_USE_REAL_SINGLE)
 88: #define PETSC_REAL PETSC_FLOAT
 89: #elif defined(PETSC_USE_REAL___FLOAT128)
 90: #define PETSC_REAL PETSC___FLOAT128
 91: #else
 92: #define PETSC_REAL PETSC_DOUBLE
 93: #endif
 94: #define PETSC_FORTRANADDR PETSC_LONG

 96:       parameter (PETSC_INT=0,PETSC_DOUBLE=1,PETSC_COMPLEX=2)
 97:       parameter (PETSC_LONG=3,PETSC_SHORT=4,PETSC_FLOAT=5)
 98:       parameter (PETSC_CHAR=6,PETSC_BIT_LOGICAL=7,PETSC_ENUM=8)
 99:       parameter (PETSC_BOOL=9,PETSC___FLOAT128=10)
100: !
101: !
102: !
103:       PetscEnum PETSC_COPY_VALUES
104:       PetscEnum PETSC_OWN_POINTER
105:       PetscEnum PETSC_USE_POINTER

107:       parameter (PETSC_COPY_VALUES = 0)
108:       parameter (PETSC_OWN_POINTER = 1)
109:       parameter (PETSC_USE_POINTER = 2)
110: !
111: ! ------------------------------------------------------------------------
112: !     PETSc mathematics include file. Defines certain basic mathematical
113: !    constants and functions for working with single and double precision
114: !    floating point numbers as well as complex and integers.
115: !
116: !     Representation of complex i
117: !
118:       PetscFortranComplex PETSC_i
119: #if defined(PETSC_USE_REAL_SINGLE)
120:       parameter (PETSC_i = (0.0e0,1.0e0))
121: #else
122:       parameter (PETSC_i = (0.0d0,1.0d0))
123: #endif

125: !
126: !     Basic constants
127: !
128:       PetscReal PETSC_PI
129:       PetscReal PETSC_MAX_REAL
130:       PetscReal PETSC_MIN_REAL

132: #if defined(PETSC_USE_REAL_SINGLE)
133:       parameter (PETSC_PI = 3.1415926)
134:       parameter (PETSC_MAX_REAL = 3.40282346638528860e+38)
135:       parameter (PETSC_MIN_REAL = -3.40282346638528860e+38)
136: #else
137:       parameter (PETSC_PI = 3.14159265358979323846264d0)
138:       parameter (PETSC_MAX_REAL = 1.7976931348623157d308)
139:       parameter (PETSC_MIN_REAL = -1.7976931348623157d308)
140: #endif

142:       PetscReal PETSC_MACHINE_EPSILON
143:       PetscReal PETSC_SQRT_MACHINE_EPSILON
144:       PetscReal PETSC_SMALL

146: #if defined(PETSC_USE_REAL_SINGLE)
147:       parameter (PETSC_MACHINE_EPSILON = 1.e-7)
148:       parameter (PETSC_SQRT_MACHINE_EPSILON = 3.e-4)
149:       parameter (PETSC_SMALL = 1.e-5)
150: #else
151:       parameter (PETSC_MACHINE_EPSILON = 1.d-14)
152:       parameter (PETSC_SQRT_MACHINE_EPSILON = 1.d-7)
153:       parameter (PETSC_SMALL = 1.d-10)
154: #endif
155: !
156: ! ----------------------------------------------------------------------------
157: !    BEGIN PETSc aliases for MPI_ constants
158: !
159:       integer MPIU_SCALAR
160: #if defined(PETSC_USE_COMPLEX)
161: #if defined (PETSC_USE_REAL_SINGLE)
162:       parameter(MPIU_SCALAR = MPI_COMPLEX)
163: #else
164:       parameter(MPIU_SCALAR = MPI_DOUBLE_COMPLEX)
165: #endif
166: #else
167: #if defined (PETSC_USE_REAL_SINGLE)
168:       parameter (MPIU_SCALAR = MPI_REAL)
169: #else
170:       parameter(MPIU_SCALAR = MPI_DOUBLE_PRECISION)
171: #endif
172: #endif

174:       integer MPIU_INTEGER
175: #if defined(PETSC_USE_64BIT_INDICES)
176:       parameter(MPIU_INTEGER = MPI_INTEGER8)
177: #else
178:       parameter(MPIU_INTEGER = MPI_INTEGER)
179: #endif

181: !
182: ! ----------------------------------------------------------------------------
183: !    BEGIN COMMON-BLOCK VARIABLES
184: !
185: !
186: !     PETSc world communicator
187: !
188:       MPI_Comm PETSC_COMM_WORLD
189:       MPI_Comm PETSC_COMM_SELF
190: !
191: !     Fortran Null
192: !
193:       PetscChar(80)       PETSC_NULL_CHARACTER
194:       PetscInt            PETSC_NULL_INTEGER
195:       PetscFortranDouble  PETSC_NULL_DOUBLE
196:       PetscObject         PETSC_NULL_OBJECT
197: !
198: !      A PETSC_NULL_FUNCTION pointer
199: !
200:       external PETSC_NULL_FUNCTION
201:       PetscScalar   PETSC_NULL_SCALAR
202:       PetscReal     PETSC_NULL_REAL
203:       PetscBool     PETSC_NULL_BOOL
204: !
205: !     Common Block to store some of the PETSc constants.
206: !     which can be set - only at runtime.
207: !
208: !
209: !     A string should be in a different common block
210: !
211:       common /petscfortran1/ PETSC_NULL_CHARACTER
212:       common /petscfortran2/ PETSC_NULL_INTEGER
213:       common /petscfortran4/ PETSC_NULL_SCALAR
214:       common /petscfortran5/ PETSC_NULL_DOUBLE
215:       common /petscfortran6/ PETSC_NULL_REAL
216:       common /petscfortran7/ PETSC_NULL_BOOL
217:       common /petscfortran8/ PETSC_NULL_OBJECT
218:       common /petscfortran9/ PETSC_COMM_WORLD
219:       common /petscfortran10/ PETSC_COMM_SELF
220: !
221: !     Possible arguments to PetscPushErrorHandler()
222: !
223:       external PETSCTRACEBACKERRORHANDLER
224:       external PETSCABORTERRORHANDLER
225:       external PETSCEMACSCLIENTERRORHANDLER
226:       external PETSCATTACHDEBUGGERERRORHANDLER
227:       external PETSCIGNOREERRORHANDLER
228: !
229:       external PetscIsInfOrNanScalar
230:       external PetscIsInfOrNanReal
231:       PetscBool  PetscIsInfOrNanScalar
232:       PetscBool  PetscIsInfOrNanReal


235: !    END COMMON-BLOCK VARIABLES
236: ! ----------------------------------------------------------------------------
237: !
238: !
239: !     Random numbers
240: !
241: #define PETSCRAND 'rand'
242: #define PETSCRAND48 'rand48'
243: #define PETSCSPRNG 'sprng'
244: !
245: !
246: !
247:       PetscEnum PETSC_BINARY_INT_SIZE
248:       PetscEnum PETSC_BINARY_FLOAT_SIZE
249:       PetscEnum PETSC_BINARY_CHAR_SIZE
250:       PetscEnum PETSC_BINARY_SHORT_SIZE
251:       PetscEnum PETSC_BINARY_DOUBLE_SIZE
252:       PetscEnum PETSC_BINARY_SCALAR_SIZE

254:       parameter (PETSC_BINARY_INT_SIZE = 4)
255:       parameter (PETSC_BINARY_FLOAT_SIZE = 4)
256:       parameter (PETSC_BINARY_CHAR_SIZE = 1)
257:       parameter (PETSC_BINARY_SHORT_SIZE = 2)
258:       parameter (PETSC_BINARY_DOUBLE_SIZE = 8)
259: #if defined(PETSC_USE_COMPLEX)
260:       parameter (PETSC_BINARY_SCALAR_SIZE = 16)
261: #else
262:       parameter (PETSC_BINARY_SCALAR_SIZE = 8)
263: #endif

265:       PetscEnum PETSC_BINARY_SEEK_SET
266:       PetscEnum PETSC_BINARY_SEEK_CUR
267:       PetscEnum PETSC_BINARY_SEEK_END

269:       parameter (PETSC_BINARY_SEEK_SET = 0,PETSC_BINARY_SEEK_CUR = 1)
270:       parameter (PETSC_BINARY_SEEK_END = 2)

272:       PetscEnum PETSC_BUILDTWOSIDED_ALLREDUCE
273:       PetscEnum PETSC_BUILDTWOSIDED_IBARRIER
274:       parameter (PETSC_BUILDTWOSIDED_ALLREDUCE = 0)
275:       parameter (PETSC_BUILDTWOSIDED_IBARRIER = 1)
276: !