Actual source code: pinit.c

petsc-master 2017-10-18
Report Typos and Errors

  2: /*
  3:    This file defines the initialization of PETSc, including PetscInitialize()
  4: */
  5:  #include <petsc/private/petscimpl.h>
  6:  #include <petscvalgrind.h>
  7:  #include <petscviewer.h>

  9: #if defined(PETSC_USE_LOG)
 10: extern PetscErrorCode PetscLogInitialize(void);
 11: #endif

 13: #if defined(PETSC_SERIALIZE_FUNCTIONS)
 14: PetscFPT PetscFPTData = 0;
 15: #endif

 17: #if defined(PETSC_HAVE_CUDA)
 18: cublasHandle_t cublasv2handle = NULL;
 19: #endif

 21: #if defined(PETSC_HAVE_SAWS)
 22:  #include <petscviewersaws.h>
 23: #endif
 24: /* -----------------------------------------------------------------------------------------*/

 26: extern FILE *petsc_history;

 28: extern PetscErrorCode PetscInitialize_DynamicLibraries(void);
 29: extern PetscErrorCode PetscFinalize_DynamicLibraries(void);
 30: extern PetscErrorCode PetscFunctionListPrintAll(void);
 31: extern PetscErrorCode PetscSequentialPhaseBegin_Private(MPI_Comm,int);
 32: extern PetscErrorCode PetscSequentialPhaseEnd_Private(MPI_Comm,int);
 33: extern PetscErrorCode PetscCloseHistoryFile(FILE**);

 35: /* user may set this BEFORE calling PetscInitialize() */
 36: MPI_Comm PETSC_COMM_WORLD = MPI_COMM_NULL;

 38: PetscMPIInt Petsc_Counter_keyval   = MPI_KEYVAL_INVALID;
 39: PetscMPIInt Petsc_InnerComm_keyval = MPI_KEYVAL_INVALID;
 40: PetscMPIInt Petsc_OuterComm_keyval = MPI_KEYVAL_INVALID;

 42: /*
 43:      Declare and set all the string names of the PETSc enums
 44: */
 45: const char *const PetscBools[]     = {"FALSE","TRUE","PetscBool","PETSC_",0};
 46: const char *const PetscCopyModes[] = {"COPY_VALUES","OWN_POINTER","USE_POINTER","PetscCopyMode","PETSC_",0};
 47: const char *const PetscDataTypes[] = {"INT","DOUBLE","COMPLEX","LONG","SHORT","FLOAT",
 48:                                       "CHAR","LOGICAL","ENUM","BOOL","LONGDOUBLE","OBJECT","FUNCTION","PetscDataType","PETSC_",0};

 50: PetscBool PetscPreLoadingUsed = PETSC_FALSE;
 51: PetscBool PetscPreLoadingOn   = PETSC_FALSE;

 53: PetscInt PetscHotRegionDepth;

 55: #if defined(PETSC_HAVE_THREADSAFETY)
 56: PetscSpinlock PetscViewerASCIISpinLockOpen;
 57: PetscSpinlock PetscViewerASCIISpinLockStdout;
 58: PetscSpinlock PetscViewerASCIISpinLockStderr;
 59: PetscSpinlock PetscCommSpinLock;
 60: #endif

 62: /*
 63:        Checks the options database for initializations related to the
 64:     PETSc components
 65: */
 66: PetscErrorCode  PetscOptionsCheckInitial_Components(void)
 67: {
 68:   PetscBool      flg1;

 72:   PetscOptionsHasName(NULL,NULL,"-help",&flg1);
 73:   if (flg1) {
 74: #if defined(PETSC_USE_LOG)
 75:     MPI_Comm comm = PETSC_COMM_WORLD;
 76:     (*PetscHelpPrintf)(comm,"------Additional PETSc component options--------\n");
 77:     (*PetscHelpPrintf)(comm," -log_exclude: <vec,mat,pc.ksp,snes>\n");
 78:     (*PetscHelpPrintf)(comm," -info_exclude: <null,vec,mat,pc,ksp,snes,ts>\n");
 79:     (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");
 80: #endif
 81:   }
 82:   return(0);
 83: }

 85: /*
 86:       PetscInitializeNoPointers - Calls PetscInitialize() from C/C++ without the pointers to argc and args

 88:    Collective

 90:    Level: advanced

 92:     Notes: this is called only by the PETSc MATLAB and Julia interface. Even though it might start MPI it sets the flag to
 93:      indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to
 94:      be called multiple times from MATLAB and Julia without the problem of trying to initialize MPI more than once.

 96:      Turns off PETSc signal handling because that can interact with MATLAB's signal handling causing random crashes.

 98: .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
 99: */
100: PetscErrorCode  PetscInitializeNoPointers(int argc,char **args,const char *filename,const char *help)
101: {
103:   int            myargc   = argc;
104:   char           **myargs = args;

107:   PetscInitialize(&myargc,&myargs,filename,help);
108:   PetscPopSignalHandler();
109:   PetscBeganMPI = PETSC_FALSE;
110:   PetscFunctionReturn(ierr);
111: }

113: /*
114:       Used by MATLAB and Julia interface to get communicator
115: */
116: PetscErrorCode  PetscGetPETSC_COMM_SELF(MPI_Comm *comm)
117: {
119:   *comm = PETSC_COMM_SELF;
120:   return(0);
121: }

123: /*@C
124:       PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without
125:         the command line arguments.

127:    Collective

129:    Level: advanced

131: .seealso: PetscInitialize(), PetscInitializeFortran()
132: @*/
133: PetscErrorCode  PetscInitializeNoArguments(void)
134: {
136:   int            argc   = 0;
137:   char           **args = 0;

140:   PetscInitialize(&argc,&args,NULL,NULL);
141:   PetscFunctionReturn(ierr);
142: }

144: /*@
145:       PetscInitialized - Determine whether PETSc is initialized.

147:    Level: beginner

149: .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
150: @*/
151: PetscErrorCode PetscInitialized(PetscBool  *isInitialized)
152: {
153:   *isInitialized = PetscInitializeCalled;
154:   return 0;
155: }

157: /*@
158:       PetscFinalized - Determine whether PetscFinalize() has been called yet

160:    Level: developer

162: .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
163: @*/
164: PetscErrorCode  PetscFinalized(PetscBool  *isFinalized)
165: {
166:   *isFinalized = PetscFinalizeCalled;
167:   return 0;
168: }

170: extern PetscErrorCode PetscOptionsCheckInitial_Private(void);

172: /*
173:        This function is the MPI reduction operation used to compute the sum of the
174:    first half of the datatype and the max of the second half.
175: */
176: MPI_Op MPIU_MAXSUM_OP = 0;

178: PETSC_INTERN void MPIAPI MPIU_MaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype)
179: {
180:   PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt;

183:   if (*datatype != MPIU_2INT) {
184:     (*PetscErrorPrintf)("Can only handle MPIU_2INT data types");
185:     MPI_Abort(MPI_COMM_WORLD,1);
186:   }

188:   for (i=0; i<count; i++) {
189:     xout[2*i]    = PetscMax(xout[2*i],xin[2*i]);
190:     xout[2*i+1] += xin[2*i+1];
191:   }
192:   PetscFunctionReturnVoid();
193: }

195: /*
196:     Returns the max of the first entry owned by this processor and the
197: sum of the second entry.

199:     The reason sizes[2*i] contains lengths sizes[2*i+1] contains flag of 1 if length is nonzero
200: is so that the MPIU_MAXSUM_OP() can set TWO values, if we passed in only sizes[i] with lengths
201: there would be no place to store the both needed results.
202: */
203: PetscErrorCode  PetscMaxSum(MPI_Comm comm,const PetscInt sizes[],PetscInt *max,PetscInt *sum)
204: {

208: #if defined(PETSC_HAVE_MPI_REDUCE_SCATTER_BLOCK)
209:   {
210:     struct {PetscInt max,sum;} work;
211:     MPI_Reduce_scatter_block((void*)sizes,&work,1,MPIU_2INT,MPIU_MAXSUM_OP,comm);
212:     *max = work.max;
213:     *sum = work.sum;
214:   }
215: #else
216:   {
217:     PetscMPIInt    size,rank;
218:     struct {PetscInt max,sum;} *work;
219:     MPI_Comm_size(comm,&size);
220:     MPI_Comm_rank(comm,&rank);
221:     PetscMalloc1(size,&work);
222:     MPIU_Allreduce((void*)sizes,work,size,MPIU_2INT,MPIU_MAXSUM_OP,comm);
223:     *max = work[rank].max;
224:     *sum = work[rank].sum;
225:     PetscFree(work);
226:   }
227: #endif
228:   return(0);
229: }

231: /* ----------------------------------------------------------------------------*/

233: #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
234: MPI_Op MPIU_SUM = 0;

236: PETSC_EXTERN void PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
237: {
238:   PetscInt i,count = *cnt;

241:   if (*datatype == MPIU_REAL) {
242:     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
243:     for (i=0; i<count; i++) xout[i] += xin[i];
244:   }
245: #if defined(PETSC_HAVE_COMPLEX)
246:   else if (*datatype == MPIU_COMPLEX) {
247:     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
248:     for (i=0; i<count; i++) xout[i] += xin[i];
249:   }
250: #endif
251:   else {
252:     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
253:     MPI_Abort(MPI_COMM_WORLD,1);
254:   }
255:   PetscFunctionReturnVoid();
256: }
257: #endif

259: #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
260: MPI_Op MPIU_MAX = 0;
261: MPI_Op MPIU_MIN = 0;

263: PETSC_EXTERN void PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
264: {
265:   PetscInt i,count = *cnt;

268:   if (*datatype == MPIU_REAL) {
269:     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
270:     for (i=0; i<count; i++) xout[i] = PetscMax(xout[i],xin[i]);
271:   }
272: #if defined(PETSC_HAVE_COMPLEX)
273:   else if (*datatype == MPIU_COMPLEX) {
274:     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
275:     for (i=0; i<count; i++) {
276:       xout[i] = PetscRealPartComplex(xout[i])<PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
277:     }
278:   }
279: #endif
280:   else {
281:     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
282:     MPI_Abort(MPI_COMM_WORLD,1);
283:   }
284:   PetscFunctionReturnVoid();
285: }

287: PETSC_EXTERN void PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
288: {
289:   PetscInt    i,count = *cnt;

292:   if (*datatype == MPIU_REAL) {
293:     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
294:     for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]);
295:   }
296: #if defined(PETSC_HAVE_COMPLEX)
297:   else if (*datatype == MPIU_COMPLEX) {
298:     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
299:     for (i=0; i<count; i++) {
300:       xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
301:     }
302:   }
303: #endif
304:   else {
305:     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types");
306:     MPI_Abort(MPI_COMM_WORLD,1);
307:   }
308:   PetscFunctionReturnVoid();
309: }
310: #endif

312: /*
313:    Private routine to delete internal tag/name counter storage when a communicator is freed.

315:    This is called by MPI, not by users. This is called by MPI_Comm_free() when the communicator that has this  data as an attribute is freed.

317:    Note: this is declared extern "C" because it is passed to MPI_Keyval_create()

319: */
320: PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelCounter(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
321: {

325:   PetscInfo1(0,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
326:   PetscFree(count_val);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
327:   PetscFunctionReturn(MPI_SUCCESS);
328: }

330: /*
331:   This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Attr_delete) or when the user
332:   calls MPI_Comm_free().

334:   This is the only entry point for breaking the links between inner and outer comms.

336:   This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator.

338:   Note: this is declared extern "C" because it is passed to MPI_Keyval_create()

340: */
341: PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Outer(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
342: {
344:   PetscMPIInt    flg;
345:   union {MPI_Comm comm; void *ptr;} icomm,ocomm;

348:   if (keyval != Petsc_InnerComm_keyval) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval");
349:   icomm.ptr = attr_val;

351:   MPI_Attr_get(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);
352:   if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected reference to outer comm");
353:   if (ocomm.comm != comm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm has reference to non-matching outer comm");
354:   MPI_Attr_delete(icomm.comm,Petsc_OuterComm_keyval); /* Calls Petsc_DelComm_Inner */
355:   PetscInfo1(0,"User MPI_Comm %ld is being freed after removing reference from inner PETSc comm to this outer comm\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
356:   PetscFunctionReturn(MPI_SUCCESS);
357: }

359: /*
360:  * This is invoked on the inner comm when Petsc_DelComm_Outer calls MPI_Attr_delete.  It should not be reached any other way.
361:  */
362: PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Inner(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
363: {

367:   PetscInfo1(0,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
368:   PetscFunctionReturn(MPI_SUCCESS);
369: }

371: #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
372: #if !defined(PETSC_WORDS_BIGENDIAN)
373: PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
374: PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
375: PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
376: #endif
377: #endif

379: int  PetscGlobalArgc   = 0;
380: char **PetscGlobalArgs = 0;
381: PetscSegBuffer PetscCitationsList;

383: PetscErrorCode PetscCitationsInitialize(void)
384: {

388:   PetscSegBufferCreate(1,10000,&PetscCitationsList);
389:   PetscCitationsRegister("@TechReport{petsc-user-ref,\n  Author = {Satish Balay and Shrirang Abhyankar and Mark F. Adams and Jed Brown and Peter Brune\n            and Kris Buschelman and Lisandro Dalcin and Victor Eijkhout and William D. Gropp\n            and Dinesh Kaushik and Matthew G. Knepley\n            and Lois Curfman McInnes and Karl Rupp and Barry F. Smith\n            and Stefano Zampini and Hong Zhang and Hong Zhang},\n  Title = {{PETS}c Users Manual},\n  Number = {ANL-95/11 - Revision 3.8},\n  Institution = {Argonne National Laboratory},\n  Year = {2017}\n}\n",NULL);
390:   PetscCitationsRegister("@InProceedings{petsc-efficient,\n  Author = {Satish Balay and William D. Gropp and Lois Curfman McInnes and Barry F. Smith},\n  Title = {Efficient Management of Parallelism in Object Oriented Numerical Software Libraries},\n  Booktitle = {Modern Software Tools in Scientific Computing},\n  Editor = {E. Arge and A. M. Bruaset and H. P. Langtangen},\n  Pages = {163--202},\n  Publisher = {Birkh{\\\"{a}}user Press},\n  Year = {1997}\n}\n",NULL);
391:   return(0);
392: }

394: /*@C
395:    PetscGetArgs - Allows you to access the raw command line arguments anywhere
396:      after PetscInitialize() is called but before PetscFinalize().

398:    Not Collective

400:    Output Parameters:
401: +  argc - count of number of command line arguments
402: -  args - the command line arguments

404:    Level: intermediate

406:    Notes:
407:       This is usually used to pass the command line arguments into other libraries
408:    that are called internally deep in PETSc or the application.

410:       The first argument contains the program name as is normal for C arguments.

412:    Concepts: command line arguments

414: .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()

416: @*/
417: PetscErrorCode  PetscGetArgs(int *argc,char ***args)
418: {
420:   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
421:   *argc = PetscGlobalArgc;
422:   *args = PetscGlobalArgs;
423:   return(0);
424: }

426: /*@C
427:    PetscGetArguments - Allows you to access the  command line arguments anywhere
428:      after PetscInitialize() is called but before PetscFinalize().

430:    Not Collective

432:    Output Parameters:
433: .  args - the command line arguments

435:    Level: intermediate

437:    Notes:
438:       This does NOT start with the program name and IS null terminated (final arg is void)

440:    Concepts: command line arguments

442: .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()

444: @*/
445: PetscErrorCode  PetscGetArguments(char ***args)
446: {
447:   PetscInt       i,argc = PetscGlobalArgc;

451:   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
452:   if (!argc) {*args = 0; return(0);}
453:   PetscMalloc1(argc,args);
454:   for (i=0; i<argc-1; i++) {
455:     PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);
456:   }
457:   (*args)[argc-1] = 0;
458:   return(0);
459: }

461: /*@C
462:    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()

464:    Not Collective

466:    Output Parameters:
467: .  args - the command line arguments

469:    Level: intermediate

471:    Concepts: command line arguments

473: .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()

475: @*/
476: PetscErrorCode  PetscFreeArguments(char **args)
477: {
478:   PetscInt       i = 0;

482:   if (!args) return(0);
483:   while (args[i]) {
484:     PetscFree(args[i]);
485:     i++;
486:   }
487:   PetscFree(args);
488:   return(0);
489: }

491: #if defined(PETSC_HAVE_SAWS)
492: #include <petscconfiginfo.h>

494: PetscErrorCode  PetscInitializeSAWs(const char help[])
495: {
496:   if (!PetscGlobalRank) {
497:     char           cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline,*options,version[64];
498:     int            port;
499:     PetscBool      flg,rootlocal = PETSC_FALSE,flg2,selectport = PETSC_FALSE;
500:     size_t         applinelen,introlen;
502:     char           sawsurl[256];

504:     PetscOptionsHasName(NULL,NULL,"-saws_log",&flg);
505:     if (flg) {
506:       char  sawslog[PETSC_MAX_PATH_LEN];

508:       PetscOptionsGetString(NULL,NULL,"-saws_log",sawslog,PETSC_MAX_PATH_LEN,NULL);
509:       if (sawslog[0]) {
510:         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(sawslog));
511:       } else {
512:         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(NULL));
513:       }
514:     }
515:     PetscOptionsGetString(NULL,NULL,"-saws_https",cert,PETSC_MAX_PATH_LEN,&flg);
516:     if (flg) {
517:       PetscStackCallSAWs(SAWs_Set_Use_HTTPS,(cert));
518:     }
519:     PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select",&selectport,NULL);
520:     if (selectport) {
521:         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
522:         PetscStackCallSAWs(SAWs_Set_Port,(port));
523:     } else {
524:       PetscOptionsGetInt(NULL,NULL,"-saws_port",&port,&flg);
525:       if (flg) {
526:         PetscStackCallSAWs(SAWs_Set_Port,(port));
527:       }
528:     }
529:     PetscOptionsGetString(NULL,NULL,"-saws_root",root,PETSC_MAX_PATH_LEN,&flg);
530:     if (flg) {
531:       PetscStackCallSAWs(SAWs_Set_Document_Root,(root));
532:       PetscStrcmp(root,".",&rootlocal);
533:     } else {
534:       PetscOptionsHasName(NULL,NULL,"-saws_options",&flg);
535:       if (flg) {
536:         PetscStrreplace(PETSC_COMM_WORLD,"${PETSC_DIR}/share/petsc/saws",root,PETSC_MAX_PATH_LEN);
537:         PetscStackCallSAWs(SAWs_Set_Document_Root,(root));
538:       }
539:     }
540:     PetscOptionsHasName(NULL,NULL,"-saws_local",&flg2);
541:     if (flg2) {
542:       char jsdir[PETSC_MAX_PATH_LEN];
543:       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option");
544:       PetscSNPrintf(jsdir,PETSC_MAX_PATH_LEN,"%s/js",root);
545:       PetscTestDirectory(jsdir,'r',&flg);
546:       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory");
547:       PetscStackCallSAWs(SAWs_Push_Local_Header,());
548:     }
549:     PetscGetProgramName(programname,64);
550:     PetscStrlen(help,&applinelen);
551:     introlen   = 4096 + applinelen;
552:     applinelen += 1024;
553:     PetscMalloc(applinelen,&appline);
554:     PetscMalloc(introlen,&intro);

556:     if (rootlocal) {
557:       PetscSNPrintf(appline,applinelen,"%s.c.html",programname);
558:       PetscTestFile(appline,'r',&rootlocal);
559:     }
560:     PetscOptionsGetAll(NULL,&options);
561:     if (rootlocal && help) {
562:       PetscSNPrintf(appline,applinelen,"<center> Running <a href=\"%s.c.html\">%s</a> %s</center><br><center><pre>%s</pre></center><br>\n",programname,programname,options,help);
563:     } else if (help) {
564:       PetscSNPrintf(appline,applinelen,"<center>Running %s %s</center><br><center><pre>%s</pre></center><br>",programname,options,help);
565:     } else {
566:       PetscSNPrintf(appline,applinelen,"<center> Running %s %s</center><br>\n",programname,options);
567:     }
568:     PetscFree(options);
569:     PetscGetVersion(version,sizeof(version));
570:     PetscSNPrintf(intro,introlen,"<body>\n"
571:                                     "<center><h2> <a href=\"http://www.mcs.anl.gov/petsc\">PETSc</a> Application Web server powered by <a href=\"https://bitbucket.org/saws/saws\">SAWs</a> </h2></center>\n"
572:                                     "<center>This is the default PETSc application dashboard, from it you can access any published PETSc objects or logging data</center><br><center>%s configured with %s</center><br>\n"
573:                                     "%s",version,petscconfigureoptions,appline);
574:     PetscStackCallSAWs(SAWs_Push_Body,("index.html",0,intro));
575:     PetscFree(intro);
576:     PetscFree(appline);
577:     if (selectport) {
578:       PetscBool silent;

580:       SAWs_Initialize();
581:       /* another process may have grabbed the port so keep trying */
582:       while (ierr) {
583:         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
584:         PetscStackCallSAWs(SAWs_Set_Port,(port));
585:         SAWs_Initialize();
586:       }

588:       PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select_silent",&silent,NULL);
589:       if (!silent) {
590:         PetscStackCallSAWs(SAWs_Get_FullURL,(sizeof(sawsurl),sawsurl));
591:         PetscPrintf(PETSC_COMM_WORLD,"Point your browser to %s for SAWs\n",sawsurl);
592:       }
593:     } else {
594:       PetscStackCallSAWs(SAWs_Initialize,());
595:     }
596:     PetscCitationsRegister("@TechReport{ saws,\n"
597:                                   "  Author = {Matt Otten and Jed Brown and Barry Smith},\n"
598:                                   "  Title  = {Scientific Application Web Server (SAWs) Users Manual},\n"
599:                                   "  Institution = {Argonne National Laboratory},\n"
600:                                   "  Year   = 2013\n}\n",NULL);
601:   }
602:   return(0);
603: }
604: #endif

606: /*@C
607:    PetscInitialize - Initializes the PETSc database and MPI.
608:    PetscInitialize() calls MPI_Init() if that has yet to be called,
609:    so this routine should always be called near the beginning of
610:    your program -- usually the very first line!

612:    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set

614:    Input Parameters:
615: +  argc - count of number of command line arguments
616: .  args - the command line arguments
617: .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for
618:           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
619: -  help - [optional] Help message to print, use NULL for no message

621:    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
622:    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
623:    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
624:    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
625:    if different subcommunicators of the job are doing different things with PETSc.

627:    Options Database Keys:
628: +  -help [intro] - prints help method for each option; if intro is given the program stops after printing the introductory help message
629: .  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
630: .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
631: .  -on_error_emacs <machinename> causes emacsclient to jump to error file
632: .  -on_error_abort calls abort() when error detected (no traceback)
633: .  -on_error_mpiabort calls MPI_abort() when error detected
634: .  -error_output_stderr prints error messages to stderr instead of the default stdout
635: .  -error_output_none does not print the error messages (but handles errors in the same way as if this was not called)
636: .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
637: .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
638: .  -stop_for_debugger - Print message on how to attach debugger manually to
639:                         process and wait (-debugger_pause) seconds for attachment
640: .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
641: .  -malloc no - Indicates not to use error-checking malloc
642: .  -malloc_debug - check for memory corruption at EVERY malloc or free
643: .  -malloc_dump - prints a list of all unfreed memory at the end of the run
644: .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds
645: .  -fp_trap - Stops on floating point exceptions (Note that on the
646:               IBM RS6000 this slows code by at least a factor of 10.)
647: .  -no_signal_handler - Indicates not to trap error signals
648: .  -shared_tmp - indicates /tmp directory is shared by all processors
649: .  -not_shared_tmp - each processor has own /tmp
650: .  -tmp - alternative name of /tmp directory
651: .  -get_total_flops - returns total flops done by all processors
652: -  -memory_view - Print memory usage at end of run

654:    Options Database Keys for Profiling:
655:    See Users-Manual: Chapter 13 Profiling for details.
656: +  -info <optional filename> - Prints verbose information to the screen
657: .  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
658: .  -log_sync - Log the synchronization in scatters, inner products and norms
659: .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
660:         hangs without running in the debugger).  See PetscLogTraceBegin().
661: .  -log_view [:filename:format] - Prints summary of flop and timing information to screen or file, see PetscLogView().
662: .  -log_summary [filename] - (Deprecated, use -log_view) Prints summary of flop and timing information to screen. If the filename is specified the
663:         summary is written to the file.  See PetscLogView().
664: .  -log_exclude: <vec,mat,pc.ksp,snes> - excludes subset of object classes from logging
665: .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
666: .  -log [filename] - Logs basic profiline information  See PetscLogDump().
667: -  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)

669:     Only one of -log_trace, -log_view, -log_view, -log_all, -log, or -log_mpe may be used at a time

671:    Options Database Keys for SAWs:
672: +  -saws_port <portnumber> - port number to publish SAWs data, default is 8080
673: .  -saws_port_auto_select - have SAWs select a new unique port number where it publishes the data, the URL is printed to the screen
674:                             this is useful when you are running many jobs that utilize SAWs at the same time
675: .  -saws_log <filename> - save a log of all SAWs communication
676: .  -saws_https <certificate file> - have SAWs use HTTPS instead of HTTP
677: -  -saws_root <directory> - allow SAWs to have access to the given directory to search for requested resources and files

679:    Environmental Variables:
680: +   PETSC_TMP - alternative tmp directory
681: .   PETSC_SHARED_TMP - tmp is shared by all processes
682: .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
683: .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
684: -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to


687:    Level: beginner

689:    Notes:
690:    If for some reason you must call MPI_Init() separately, call
691:    it before PetscInitialize().

693:    Fortran Version:
694:    In Fortran this routine has the format
695: $       call PetscInitialize(file,ierr)

697: +   ierr - error return code
698: -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use PETSC_NULL_CHARACTER to not check for
699:           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files

701:    Important Fortran Note:
702:    In Fortran, you MUST use PETSC_NULL_CHARACTER to indicate a
703:    null character string; you CANNOT just use NULL as
704:    in the C version. See Users-Manual: Chapter 11 PETSc for Fortran Users for details.

706:    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
707:    calling PetscInitialize().

709:    Concepts: initializing PETSc

711: .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()

713: @*/
714: PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
715: {
717: