17d0a6c19SBarry Smith 21a1499c8SBarry Smith 353acd3b1SBarry Smith /* 43fc1eb6aSBarry Smith Implements the higher-level options database querying methods. These are self-documenting and can attach at runtime to 53fc1eb6aSBarry Smith GUI code to display the options and get values from the users. 653acd3b1SBarry Smith 753acd3b1SBarry Smith */ 853acd3b1SBarry Smith 9af0996ceSBarry Smith #include <petsc/private/petscimpl.h> /*I "petscsys.h" I*/ 10665c2dedSJed Brown #include <petscviewer.h> 1153acd3b1SBarry Smith 122aa6d131SJed Brown #define ManSection(str) ((str) ? (str) : "None") 132aa6d131SJed Brown 1453acd3b1SBarry Smith /* 1553acd3b1SBarry Smith Keep a linked list of options that have been posted and we are waiting for 163fc1eb6aSBarry Smith user selection. See the manual page for PetscOptionsBegin() 1753acd3b1SBarry Smith 1853acd3b1SBarry Smith Eventually we'll attach this beast to a MPI_Comm 1953acd3b1SBarry Smith */ 20e55864a3SBarry Smith 2153acd3b1SBarry Smith 2253acd3b1SBarry Smith /* 2353acd3b1SBarry Smith Handles setting up the data structure in a call to PetscOptionsBegin() 2453acd3b1SBarry Smith */ 254416b707SBarry Smith PetscErrorCode PetscOptionsBegin_Private(PetscOptionItems *PetscOptionsObject,MPI_Comm comm,const char prefix[],const char title[],const char mansec[]) 2653acd3b1SBarry Smith { 2753acd3b1SBarry Smith PetscErrorCode ierr; 2853acd3b1SBarry Smith 2953acd3b1SBarry Smith PetscFunctionBegin; 300eb63584SBarry Smith if (!PetscOptionsObject->alreadyprinted) { 319de0f6ecSBarry Smith if (!PetscOptionsHelpPrintedSingleton) { 329de0f6ecSBarry Smith ierr = PetscOptionsHelpPrintedCreate(&PetscOptionsHelpPrintedSingleton);CHKERRQ(ierr); 339de0f6ecSBarry Smith } 349de0f6ecSBarry Smith ierr = PetscOptionsHelpPrintedCheck(PetscOptionsHelpPrintedSingleton,prefix,title,&PetscOptionsObject->alreadyprinted);CHKERRQ(ierr); 350eb63584SBarry Smith } 36*02c9f0b5SLisandro Dalcin PetscOptionsObject->next = NULL; 37e55864a3SBarry Smith PetscOptionsObject->comm = comm; 38e55864a3SBarry Smith PetscOptionsObject->changedmethod = PETSC_FALSE; 39a297a907SKarl Rupp 40e55864a3SBarry Smith ierr = PetscStrallocpy(prefix,&PetscOptionsObject->prefix);CHKERRQ(ierr); 41e55864a3SBarry Smith ierr = PetscStrallocpy(title,&PetscOptionsObject->title);CHKERRQ(ierr); 4253acd3b1SBarry Smith 432d747510SLisandro Dalcin ierr = PetscOptionsHasHelp(PetscOptionsObject->options,&PetscOptionsObject->printhelp);CHKERRQ(ierr); 44e55864a3SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1) { 45e55864a3SBarry Smith if (!PetscOptionsObject->alreadyprinted) { 4653acd3b1SBarry Smith ierr = (*PetscHelpPrintf)(comm,"%s -------------------------------------------------\n",title);CHKERRQ(ierr); 4753acd3b1SBarry Smith } 4861b37b28SSatish Balay } 4953acd3b1SBarry Smith PetscFunctionReturn(0); 5053acd3b1SBarry Smith } 5153acd3b1SBarry Smith 523194b578SJed Brown /* 533194b578SJed Brown Handles setting up the data structure in a call to PetscObjectOptionsBegin() 543194b578SJed Brown */ 554416b707SBarry Smith PetscErrorCode PetscObjectOptionsBegin_Private(PetscOptionItems *PetscOptionsObject,PetscObject obj) 563194b578SJed Brown { 573194b578SJed Brown PetscErrorCode ierr; 583194b578SJed Brown char title[256]; 593194b578SJed Brown PetscBool flg; 603194b578SJed Brown 613194b578SJed Brown PetscFunctionBegin; 623194b578SJed Brown PetscValidHeader(obj,1); 63e55864a3SBarry Smith PetscOptionsObject->object = obj; 64e55864a3SBarry Smith PetscOptionsObject->alreadyprinted = obj->optionsprinted; 65a297a907SKarl Rupp 663194b578SJed Brown ierr = PetscStrcmp(obj->description,obj->class_name,&flg);CHKERRQ(ierr); 673194b578SJed Brown if (flg) { 688caf3d72SBarry Smith ierr = PetscSNPrintf(title,sizeof(title),"%s options",obj->class_name);CHKERRQ(ierr); 693194b578SJed Brown } else { 708caf3d72SBarry Smith ierr = PetscSNPrintf(title,sizeof(title),"%s (%s) options",obj->description,obj->class_name);CHKERRQ(ierr); 713194b578SJed Brown } 72e55864a3SBarry Smith ierr = PetscOptionsBegin_Private(PetscOptionsObject,obj->comm,obj->prefix,title,obj->mansec);CHKERRQ(ierr); 733194b578SJed Brown PetscFunctionReturn(0); 743194b578SJed Brown } 753194b578SJed Brown 7653acd3b1SBarry Smith /* 7753acd3b1SBarry Smith Handles adding another option to the list of options within this particular PetscOptionsBegin() PetscOptionsEnd() 7853acd3b1SBarry Smith */ 794416b707SBarry Smith static int PetscOptionItemCreate_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscOptionType t,PetscOptionItem *amsopt) 8053acd3b1SBarry Smith { 8153acd3b1SBarry Smith int ierr; 824416b707SBarry Smith PetscOptionItem next; 833be6e4c3SJed Brown PetscBool valid; 8453acd3b1SBarry Smith 8553acd3b1SBarry Smith PetscFunctionBegin; 863be6e4c3SJed Brown ierr = PetscOptionsValidKey(opt,&valid);CHKERRQ(ierr); 873be6e4c3SJed Brown if (!valid) SETERRQ1(PETSC_COMM_WORLD,PETSC_ERR_ARG_INCOMP,"The option '%s' is not a valid key",opt); 883be6e4c3SJed Brown 89b00a9115SJed Brown ierr = PetscNew(amsopt);CHKERRQ(ierr); 90*02c9f0b5SLisandro Dalcin (*amsopt)->next = NULL; 9153acd3b1SBarry Smith (*amsopt)->set = PETSC_FALSE; 926356e834SBarry Smith (*amsopt)->type = t; 93*02c9f0b5SLisandro Dalcin (*amsopt)->data = NULL; 9461b37b28SSatish Balay 9553acd3b1SBarry Smith ierr = PetscStrallocpy(text,&(*amsopt)->text);CHKERRQ(ierr); 9653acd3b1SBarry Smith ierr = PetscStrallocpy(opt,&(*amsopt)->option);CHKERRQ(ierr); 976356e834SBarry Smith ierr = PetscStrallocpy(man,&(*amsopt)->man);CHKERRQ(ierr); 9853acd3b1SBarry Smith 99e55864a3SBarry Smith if (!PetscOptionsObject->next) PetscOptionsObject->next = *amsopt; 100a297a907SKarl Rupp else { 101e55864a3SBarry Smith next = PetscOptionsObject->next; 10253acd3b1SBarry Smith while (next->next) next = next->next; 10353acd3b1SBarry Smith next->next = *amsopt; 10453acd3b1SBarry Smith } 10553acd3b1SBarry Smith PetscFunctionReturn(0); 10653acd3b1SBarry Smith } 10753acd3b1SBarry Smith 108aee2cecaSBarry Smith /* 1093fc1eb6aSBarry Smith PetscScanString - Gets user input via stdin from process and broadcasts to all processes 1103fc1eb6aSBarry Smith 111d083f849SBarry Smith Collective 1123fc1eb6aSBarry Smith 1133fc1eb6aSBarry Smith Input Parameters: 1143fc1eb6aSBarry Smith + commm - communicator for the broadcast, must be PETSC_COMM_WORLD 1153fc1eb6aSBarry Smith . n - length of the string, must be the same on all processes 1163fc1eb6aSBarry Smith - str - location to store input 117aee2cecaSBarry Smith 118aee2cecaSBarry Smith Bugs: 119aee2cecaSBarry Smith . Assumes process 0 of the given communicator has access to stdin 120aee2cecaSBarry Smith 121aee2cecaSBarry Smith */ 1223fc1eb6aSBarry Smith static PetscErrorCode PetscScanString(MPI_Comm comm,size_t n,char str[]) 123aee2cecaSBarry Smith { 124330cf3c9SBarry Smith size_t i; 125aee2cecaSBarry Smith char c; 1263fc1eb6aSBarry Smith PetscMPIInt rank,nm; 127aee2cecaSBarry Smith PetscErrorCode ierr; 128aee2cecaSBarry Smith 129aee2cecaSBarry Smith PetscFunctionBegin; 130aee2cecaSBarry Smith ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 131aee2cecaSBarry Smith if (!rank) { 132aee2cecaSBarry Smith c = (char) getchar(); 133aee2cecaSBarry Smith i = 0; 134aee2cecaSBarry Smith while (c != '\n' && i < n-1) { 135aee2cecaSBarry Smith str[i++] = c; 136aee2cecaSBarry Smith c = (char)getchar(); 137aee2cecaSBarry Smith } 138aee2cecaSBarry Smith str[i] = 0; 139aee2cecaSBarry Smith } 1404dc2109aSBarry Smith ierr = PetscMPIIntCast(n,&nm);CHKERRQ(ierr); 1413fc1eb6aSBarry Smith ierr = MPI_Bcast(str,nm,MPI_CHAR,0,comm);CHKERRQ(ierr); 142aee2cecaSBarry Smith PetscFunctionReturn(0); 143aee2cecaSBarry Smith } 144aee2cecaSBarry Smith 1455b02f95dSBarry Smith /* 1465b02f95dSBarry Smith This is needed because certain strings may be freed by SAWs, hence we cannot use PetscStrallocpy() 1475b02f95dSBarry Smith */ 1485b02f95dSBarry Smith static PetscErrorCode PetscStrdup(const char s[],char *t[]) 1495b02f95dSBarry Smith { 1505b02f95dSBarry Smith PetscErrorCode ierr; 1515b02f95dSBarry Smith size_t len; 152*02c9f0b5SLisandro Dalcin char *tmp = NULL; 1535b02f95dSBarry Smith 1545b02f95dSBarry Smith PetscFunctionBegin; 1555b02f95dSBarry Smith if (s) { 1565b02f95dSBarry Smith ierr = PetscStrlen(s,&len);CHKERRQ(ierr); 157f416af30SBarry Smith tmp = (char*) malloc((len+1)*sizeof(char)); 1585b02f95dSBarry Smith if (!tmp) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_MEM,"No memory to duplicate string"); 1595b02f95dSBarry Smith ierr = PetscStrcpy(tmp,s);CHKERRQ(ierr); 1605b02f95dSBarry Smith } 1615b02f95dSBarry Smith *t = tmp; 1625b02f95dSBarry Smith PetscFunctionReturn(0); 1635b02f95dSBarry Smith } 1645b02f95dSBarry Smith 1655b02f95dSBarry Smith 166aee2cecaSBarry Smith /* 1673cc1e11dSBarry Smith PetscOptionsGetFromTextInput - Presents all the PETSc Options processed by the program so the user may change them at runtime 168aee2cecaSBarry Smith 16995452b02SPatrick Sanan Notes: 17095452b02SPatrick Sanan this isn't really practical, it is just to demonstrate the principle 171aee2cecaSBarry Smith 1727781c08eSBarry Smith A carriage return indicates no change from the default; but this like -ksp_monitor <stdout> the default is actually not stdout the default 1737781c08eSBarry Smith is to do nothing so to get it to use stdout you need to type stdout. This is kind of bug? 1747781c08eSBarry Smith 175aee2cecaSBarry Smith Bugs: 1767781c08eSBarry Smith + All processes must traverse through the exact same set of option queries due to the call to PetscScanString() 1773cc1e11dSBarry Smith . Internal strings have arbitrary length and string copies are not checked that they fit into string space 178aee2cecaSBarry Smith - Only works for PetscInt == int, PetscReal == double etc 179aee2cecaSBarry Smith 18095452b02SPatrick Sanan Developer Notes: 18195452b02SPatrick Sanan Normally the GUI that presents the options the user and retrieves the values would be running in a different 1823cc1e11dSBarry Smith address space and communicating with the PETSc program 1833cc1e11dSBarry Smith 184aee2cecaSBarry Smith */ 1854416b707SBarry Smith PetscErrorCode PetscOptionsGetFromTextInput(PetscOptionItems *PetscOptionsObject) 1866356e834SBarry Smith { 1876356e834SBarry Smith PetscErrorCode ierr; 1884416b707SBarry Smith PetscOptionItem next = PetscOptionsObject->next; 1896356e834SBarry Smith char str[512]; 1907781c08eSBarry Smith PetscBool bid; 191a4404d99SBarry Smith PetscReal ir,*valr; 192330cf3c9SBarry Smith PetscInt *vald; 193330cf3c9SBarry Smith size_t i; 1946356e834SBarry Smith 1952a409bb0SBarry Smith PetscFunctionBegin; 196e55864a3SBarry Smith ierr = (*PetscPrintf)(PETSC_COMM_WORLD,"%s -------------------------------------------------\n",PetscOptionsObject->title);CHKERRQ(ierr); 1976356e834SBarry Smith while (next) { 1986356e834SBarry Smith switch (next->type) { 1996356e834SBarry Smith case OPTION_HEAD: 2006356e834SBarry Smith break; 201e26ddf31SBarry Smith case OPTION_INT_ARRAY: 202e55864a3SBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,"-%s%s <",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",next->option+1);CHKERRQ(ierr); 203e26ddf31SBarry Smith vald = (PetscInt*) next->data; 204e26ddf31SBarry Smith for (i=0; i<next->arraylength; i++) { 205e26ddf31SBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,"%d",vald[i]);CHKERRQ(ierr); 206e26ddf31SBarry Smith if (i < next->arraylength-1) { 207e26ddf31SBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,",");CHKERRQ(ierr); 208e26ddf31SBarry Smith } 209e26ddf31SBarry Smith } 210e26ddf31SBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,">: %s (%s) ",next->text,next->man);CHKERRQ(ierr); 211e26ddf31SBarry Smith ierr = PetscScanString(PETSC_COMM_WORLD,512,str);CHKERRQ(ierr); 212e26ddf31SBarry Smith if (str[0]) { 213e26ddf31SBarry Smith PetscToken token; 214e26ddf31SBarry Smith PetscInt n=0,nmax = next->arraylength,*dvalue = (PetscInt*)next->data,start,end; 215e26ddf31SBarry Smith size_t len; 216e26ddf31SBarry Smith char *value; 217ace3abfcSBarry Smith PetscBool foundrange; 218e26ddf31SBarry Smith 219e26ddf31SBarry Smith next->set = PETSC_TRUE; 220e26ddf31SBarry Smith value = str; 221e26ddf31SBarry Smith ierr = PetscTokenCreate(value,',',&token);CHKERRQ(ierr); 222e26ddf31SBarry Smith ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 223e26ddf31SBarry Smith while (n < nmax) { 224e26ddf31SBarry Smith if (!value) break; 225e26ddf31SBarry Smith 226e26ddf31SBarry Smith /* look for form d-D where d and D are integers */ 227e26ddf31SBarry Smith foundrange = PETSC_FALSE; 228e26ddf31SBarry Smith ierr = PetscStrlen(value,&len);CHKERRQ(ierr); 229e26ddf31SBarry Smith if (value[0] == '-') i=2; 230e26ddf31SBarry Smith else i=1; 231330cf3c9SBarry Smith for (;i<len; i++) { 232e26ddf31SBarry Smith if (value[i] == '-') { 233e32f2f54SBarry Smith if (i == len-1) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_USER,"Error in %D-th array entry %s\n",n,value); 234e26ddf31SBarry Smith value[i] = 0; 235cfbddea1SSatish Balay ierr = PetscOptionsStringToInt(value,&start);CHKERRQ(ierr); 236cfbddea1SSatish Balay ierr = PetscOptionsStringToInt(value+i+1,&end);CHKERRQ(ierr); 237e32f2f54SBarry Smith if (end <= start) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_USER,"Error in %D-th array entry, %s-%s cannot have decreasing list",n,value,value+i+1); 238e32f2f54SBarry Smith if (n + end - start - 1 >= nmax) SETERRQ4(PETSC_COMM_SELF,PETSC_ERR_USER,"Error in %D-th array entry, not enough space in left in array (%D) to contain entire range from %D to %D",n,nmax-n,start,end); 239e26ddf31SBarry Smith for (; start<end; start++) { 240e26ddf31SBarry Smith *dvalue = start; dvalue++;n++; 241e26ddf31SBarry Smith } 242e26ddf31SBarry Smith foundrange = PETSC_TRUE; 243e26ddf31SBarry Smith break; 244e26ddf31SBarry Smith } 245e26ddf31SBarry Smith } 246e26ddf31SBarry Smith if (!foundrange) { 247cfbddea1SSatish Balay ierr = PetscOptionsStringToInt(value,dvalue);CHKERRQ(ierr); 248e26ddf31SBarry Smith dvalue++; 249e26ddf31SBarry Smith n++; 250e26ddf31SBarry Smith } 251e26ddf31SBarry Smith ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 252e26ddf31SBarry Smith } 2538c74ee41SBarry Smith ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 254e26ddf31SBarry Smith } 255e26ddf31SBarry Smith break; 256e26ddf31SBarry Smith case OPTION_REAL_ARRAY: 257e55864a3SBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,"-%s%s <",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",next->option+1);CHKERRQ(ierr); 258e26ddf31SBarry Smith valr = (PetscReal*) next->data; 259e26ddf31SBarry Smith for (i=0; i<next->arraylength; i++) { 260e26ddf31SBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,"%g",valr[i]);CHKERRQ(ierr); 261e26ddf31SBarry Smith if (i < next->arraylength-1) { 262e26ddf31SBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,",");CHKERRQ(ierr); 263e26ddf31SBarry Smith } 264e26ddf31SBarry Smith } 265e26ddf31SBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,">: %s (%s) ",next->text,next->man);CHKERRQ(ierr); 266e26ddf31SBarry Smith ierr = PetscScanString(PETSC_COMM_WORLD,512,str);CHKERRQ(ierr); 267e26ddf31SBarry Smith if (str[0]) { 268e26ddf31SBarry Smith PetscToken token; 269e26ddf31SBarry Smith PetscInt n = 0,nmax = next->arraylength; 270e26ddf31SBarry Smith PetscReal *dvalue = (PetscReal*)next->data; 271e26ddf31SBarry Smith char *value; 272e26ddf31SBarry Smith 273e26ddf31SBarry Smith next->set = PETSC_TRUE; 274e26ddf31SBarry Smith value = str; 275e26ddf31SBarry Smith ierr = PetscTokenCreate(value,',',&token);CHKERRQ(ierr); 276e26ddf31SBarry Smith ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 277e26ddf31SBarry Smith while (n < nmax) { 278e26ddf31SBarry Smith if (!value) break; 279cfbddea1SSatish Balay ierr = PetscOptionsStringToReal(value,dvalue);CHKERRQ(ierr); 280e26ddf31SBarry Smith dvalue++; 281e26ddf31SBarry Smith n++; 282e26ddf31SBarry Smith ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 283e26ddf31SBarry Smith } 2848c74ee41SBarry Smith ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 285e26ddf31SBarry Smith } 286e26ddf31SBarry Smith break; 2876356e834SBarry Smith case OPTION_INT: 288e55864a3SBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,"-%s%s <%d>: %s (%s) ",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",next->option+1,*(int*)next->data,next->text,next->man);CHKERRQ(ierr); 2893fc1eb6aSBarry Smith ierr = PetscScanString(PETSC_COMM_WORLD,512,str);CHKERRQ(ierr); 2903fc1eb6aSBarry Smith if (str[0]) { 291d25d7f95SJed Brown #if defined(PETSC_SIZEOF_LONG_LONG) 292d25d7f95SJed Brown long long lid; 293d25d7f95SJed Brown sscanf(str,"%lld",&lid); 2941a1499c8SBarry Smith if (lid > PETSC_MAX_INT || lid < PETSC_MIN_INT) SETERRQ3(PETSC_COMM_WORLD,PETSC_ERR_ARG_OUTOFRANGE,"Argument: -%s%s %lld",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",next->option+1,lid); 295c272547aSJed Brown #else 296d25d7f95SJed Brown long lid; 297d25d7f95SJed Brown sscanf(str,"%ld",&lid); 2981a1499c8SBarry Smith if (lid > PETSC_MAX_INT || lid < PETSC_MIN_INT) SETERRQ3(PETSC_COMM_WORLD,PETSC_ERR_ARG_OUTOFRANGE,"Argument: -%s%s %ld",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",next->option+1,lid); 299c272547aSJed Brown #endif 300a297a907SKarl Rupp 301d25d7f95SJed Brown next->set = PETSC_TRUE; 302d25d7f95SJed Brown *((PetscInt*)next->data) = (PetscInt)lid; 303aee2cecaSBarry Smith } 304aee2cecaSBarry Smith break; 305aee2cecaSBarry Smith case OPTION_REAL: 306e55864a3SBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,"-%s%s <%g>: %s (%s) ",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",next->option+1,*(double*)next->data,next->text,next->man);CHKERRQ(ierr); 3073fc1eb6aSBarry Smith ierr = PetscScanString(PETSC_COMM_WORLD,512,str);CHKERRQ(ierr); 3083fc1eb6aSBarry Smith if (str[0]) { 309ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL_SINGLE) 310a4404d99SBarry Smith sscanf(str,"%e",&ir); 311570b7f6dSBarry Smith #elif defined(PETSC_USE_REAL___FP16) 312570b7f6dSBarry Smith float irtemp; 313570b7f6dSBarry Smith sscanf(str,"%e",&irtemp); 314570b7f6dSBarry Smith ir = irtemp; 315ce63c4c1SBarry Smith #elif defined(PETSC_USE_REAL_DOUBLE) 316aee2cecaSBarry Smith sscanf(str,"%le",&ir); 317ce63c4c1SBarry Smith #elif defined(PETSC_USE_REAL___FLOAT128) 318d9822059SBarry Smith ir = strtoflt128(str,0); 319d9822059SBarry Smith #else 320513dbe71SLisandro Dalcin SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"Unknown scalar type"); 321a4404d99SBarry Smith #endif 322aee2cecaSBarry Smith next->set = PETSC_TRUE; 323aee2cecaSBarry Smith *((PetscReal*)next->data) = ir; 324aee2cecaSBarry Smith } 325aee2cecaSBarry Smith break; 3267781c08eSBarry Smith case OPTION_BOOL: 32783355fc5SBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,"-%s%s <%s>: %s (%s) ",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",next->option+1,*(PetscBool*)next->data ? "true": "false",next->text,next->man);CHKERRQ(ierr); 3287781c08eSBarry Smith ierr = PetscScanString(PETSC_COMM_WORLD,512,str);CHKERRQ(ierr); 3297781c08eSBarry Smith if (str[0]) { 3307781c08eSBarry Smith ierr = PetscOptionsStringToBool(str,&bid);CHKERRQ(ierr); 3317781c08eSBarry Smith next->set = PETSC_TRUE; 3327781c08eSBarry Smith *((PetscBool*)next->data) = bid; 3337781c08eSBarry Smith } 3347781c08eSBarry Smith break; 335aee2cecaSBarry Smith case OPTION_STRING: 336e55864a3SBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,"-%s%s <%s>: %s (%s) ",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",next->option+1,(char*)next->data,next->text,next->man);CHKERRQ(ierr); 3373fc1eb6aSBarry Smith ierr = PetscScanString(PETSC_COMM_WORLD,512,str);CHKERRQ(ierr); 3383fc1eb6aSBarry Smith if (str[0]) { 339aee2cecaSBarry Smith next->set = PETSC_TRUE; 34064facd6cSBarry Smith /* must use system malloc since SAWs may free this */ 3415b02f95dSBarry Smith ierr = PetscStrdup(str,(char**)&next->data);CHKERRQ(ierr); 3426356e834SBarry Smith } 3436356e834SBarry Smith break; 344a264d7a6SBarry Smith case OPTION_FLIST: 34544ef3d73SBarry Smith ierr = PetscFunctionListPrintTypes(PETSC_COMM_WORLD,stdout,PetscOptionsObject->prefix,next->option,next->text,next->man,next->flist,(char*)next->data,(char*)next->data);CHKERRQ(ierr); 3463cc1e11dSBarry Smith ierr = PetscScanString(PETSC_COMM_WORLD,512,str);CHKERRQ(ierr); 3473cc1e11dSBarry Smith if (str[0]) { 348e55864a3SBarry Smith PetscOptionsObject->changedmethod = PETSC_TRUE; 3493cc1e11dSBarry Smith next->set = PETSC_TRUE; 35064facd6cSBarry Smith /* must use system malloc since SAWs may free this */ 3515b02f95dSBarry Smith ierr = PetscStrdup(str,(char**)&next->data);CHKERRQ(ierr); 3523cc1e11dSBarry Smith } 3533cc1e11dSBarry Smith break; 354b432afdaSMatthew Knepley default: 355b432afdaSMatthew Knepley break; 3566356e834SBarry Smith } 3576356e834SBarry Smith next = next->next; 3586356e834SBarry Smith } 3596356e834SBarry Smith PetscFunctionReturn(0); 3606356e834SBarry Smith } 3616356e834SBarry Smith 362e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 363e04113cfSBarry Smith #include <petscviewersaws.h> 364d5649816SBarry Smith 365d5649816SBarry Smith static int count = 0; 366d5649816SBarry Smith 367e04113cfSBarry Smith PetscErrorCode PetscOptionsSAWsDestroy(void) 368d5649816SBarry Smith { 3692657e9d9SBarry Smith PetscFunctionBegin; 370d5649816SBarry Smith PetscFunctionReturn(0); 371d5649816SBarry Smith } 372d5649816SBarry Smith 3739c1e0ce8SBarry Smith static const char *OptionsHeader = "<head>\n" 374a8d69d7bSBarry Smith "<script type=\"text/javascript\" src=\"https://www.mcs.anl.gov/research/projects/saws/js/jquery-1.9.1.js\"></script>\n" 375a8d69d7bSBarry Smith "<script type=\"text/javascript\" src=\"https://www.mcs.anl.gov/research/projects/saws/js/SAWs.js\"></script>\n" 376d1fc0251SBarry Smith "<script type=\"text/javascript\" src=\"js/PETSc.js\"></script>\n" 37764bbc9efSBarry Smith "<script>\n" 37864bbc9efSBarry Smith "jQuery(document).ready(function() {\n" 37964bbc9efSBarry Smith "PETSc.getAndDisplayDirectory(null,\"#variablesInfo\")\n" 38064bbc9efSBarry Smith "})\n" 38164bbc9efSBarry Smith "</script>\n" 38264bbc9efSBarry Smith "</head>\n"; 3831423471aSBarry Smith 3841423471aSBarry Smith /* Determines the size and style of the scroll region where PETSc options selectable from users are displayed */ 3851423471aSBarry Smith static const char *OptionsBodyBottom = "<div id=\"variablesInfo\" style=\"background-color:lightblue;height:auto;max-height:500px;overflow:scroll;\"></div>\n<br>\n</body>"; 38664bbc9efSBarry Smith 387b3506946SBarry Smith /* 3887781c08eSBarry Smith PetscOptionsSAWsInput - Presents all the PETSc Options processed by the program so the user may change them at runtime using the SAWs 389b3506946SBarry Smith 390b3506946SBarry Smith Bugs: 391b3506946SBarry Smith + All processes must traverse through the exact same set of option queries do to the call to PetscScanString() 392b3506946SBarry Smith . Internal strings have arbitrary length and string copies are not checked that they fit into string space 393b3506946SBarry Smith - Only works for PetscInt == int, PetscReal == double etc 394b3506946SBarry Smith 395b3506946SBarry Smith 396b3506946SBarry Smith */ 3974416b707SBarry Smith PetscErrorCode PetscOptionsSAWsInput(PetscOptionItems *PetscOptionsObject) 398b3506946SBarry Smith { 399b3506946SBarry Smith PetscErrorCode ierr; 4004416b707SBarry Smith PetscOptionItem next = PetscOptionsObject->next; 401d5649816SBarry Smith static int mancount = 0; 402b3506946SBarry Smith char options[16]; 4037aab2a10SBarry Smith PetscBool changedmethod = PETSC_FALSE; 404a23eb982SSurtai Han PetscBool stopasking = PETSC_FALSE; 40588a9752cSBarry Smith char manname[16],textname[16]; 4062657e9d9SBarry Smith char dir[1024]; 407b3506946SBarry Smith 4082a409bb0SBarry Smith PetscFunctionBegin; 409b3506946SBarry Smith /* the next line is a bug, this will only work if all processors are here, the comm passed in is ignored!!! */ 410b3506946SBarry Smith sprintf(options,"Options_%d",count++); 411a297a907SKarl Rupp 4127325c4a4SBarry Smith PetscOptionsObject->pprefix = PetscOptionsObject->prefix; /* SAWs will change this, so cannot pass prefix directly */ 4131bc75a8dSBarry Smith 414d50831c4SBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Options/%s","_title");CHKERRQ(ierr); 41583355fc5SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&PetscOptionsObject->title,1,SAWs_READ,SAWs_STRING)); 4167781c08eSBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Options/%s","prefix");CHKERRQ(ierr); 41783355fc5SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&PetscOptionsObject->pprefix,1,SAWs_READ,SAWs_STRING)); 4182657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,("/PETSc/Options/ChangedMethod",&changedmethod,1,SAWs_WRITE,SAWs_BOOLEAN)); 419a23eb982SSurtai Han PetscStackCallSAWs(SAWs_Register,("/PETSc/Options/StopAsking",&stopasking,1,SAWs_WRITE,SAWs_BOOLEAN)); 420b3506946SBarry Smith 421b3506946SBarry Smith while (next) { 422d50831c4SBarry Smith sprintf(manname,"_man_%d",mancount); 4232657e9d9SBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Options/%s",manname);CHKERRQ(ierr); 4247781c08eSBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&next->man,1,SAWs_READ,SAWs_STRING)); 425d50831c4SBarry Smith sprintf(textname,"_text_%d",mancount++); 4267781c08eSBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Options/%s",textname);CHKERRQ(ierr); 4277781c08eSBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&next->text,1,SAWs_READ,SAWs_STRING)); 4289f32e415SBarry Smith 429b3506946SBarry Smith switch (next->type) { 430b3506946SBarry Smith case OPTION_HEAD: 431b3506946SBarry Smith break; 432b3506946SBarry Smith case OPTION_INT_ARRAY: 4337781c08eSBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Options/%s",next->option);CHKERRQ(ierr); 4342657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,next->data,next->arraylength,SAWs_WRITE,SAWs_INT)); 435b3506946SBarry Smith break; 436b3506946SBarry Smith case OPTION_REAL_ARRAY: 4377781c08eSBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Options/%s",next->option);CHKERRQ(ierr); 4382657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,next->data,next->arraylength,SAWs_WRITE,SAWs_DOUBLE)); 439b3506946SBarry Smith break; 440b3506946SBarry Smith case OPTION_INT: 4417781c08eSBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Options/%s",next->option);CHKERRQ(ierr); 4422657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,next->data,1,SAWs_WRITE,SAWs_INT)); 443b3506946SBarry Smith break; 444b3506946SBarry Smith case OPTION_REAL: 4457781c08eSBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Options/%s",next->option);CHKERRQ(ierr); 4462657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,next->data,1,SAWs_WRITE,SAWs_DOUBLE)); 447b3506946SBarry Smith break; 4487781c08eSBarry Smith case OPTION_BOOL: 4497781c08eSBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Options/%s",next->option);CHKERRQ(ierr); 4502657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,next->data,1,SAWs_WRITE,SAWs_BOOLEAN)); 4511ae3d29cSBarry Smith break; 4527781c08eSBarry Smith case OPTION_BOOL_ARRAY: 4537781c08eSBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Options/%s",next->option);CHKERRQ(ierr); 4542657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,next->data,next->arraylength,SAWs_WRITE,SAWs_BOOLEAN)); 45571f08665SBarry Smith break; 456b3506946SBarry Smith case OPTION_STRING: 4577781c08eSBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Options/%s",next->option);CHKERRQ(ierr); 4587781c08eSBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&next->data,1,SAWs_WRITE,SAWs_STRING)); 4591ae3d29cSBarry Smith break; 4601ae3d29cSBarry Smith case OPTION_STRING_ARRAY: 4617781c08eSBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Options/%s",next->option);CHKERRQ(ierr); 4622657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,next->data,next->arraylength,SAWs_WRITE,SAWs_STRING)); 463b3506946SBarry Smith break; 464a264d7a6SBarry Smith case OPTION_FLIST: 465a264d7a6SBarry Smith { 466a264d7a6SBarry Smith PetscInt ntext; 4677781c08eSBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Options/%s",next->option);CHKERRQ(ierr); 4687781c08eSBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&next->data,1,SAWs_WRITE,SAWs_STRING)); 469a264d7a6SBarry Smith ierr = PetscFunctionListGet(next->flist,(const char***)&next->edata,&ntext);CHKERRQ(ierr); 470a264d7a6SBarry Smith PetscStackCallSAWs(SAWs_Set_Legal_Variable_Values,(dir,ntext,next->edata)); 471a264d7a6SBarry Smith } 472a264d7a6SBarry Smith break; 4731ae3d29cSBarry Smith case OPTION_ELIST: 474a264d7a6SBarry Smith { 475a264d7a6SBarry Smith PetscInt ntext = next->nlist; 4767781c08eSBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Options/%s",next->option);CHKERRQ(ierr); 4777781c08eSBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&next->data,1,SAWs_WRITE,SAWs_STRING)); 478ead66b60SBarry Smith ierr = PetscMalloc1((ntext+1),(char***)&next->edata);CHKERRQ(ierr); 4791ae3d29cSBarry Smith ierr = PetscMemcpy(next->edata,next->list,ntext*sizeof(char*));CHKERRQ(ierr); 480a264d7a6SBarry Smith PetscStackCallSAWs(SAWs_Set_Legal_Variable_Values,(dir,ntext,next->edata)); 481a264d7a6SBarry Smith } 482a264d7a6SBarry Smith break; 483b3506946SBarry Smith default: 484b3506946SBarry Smith break; 485b3506946SBarry Smith } 486b3506946SBarry Smith next = next->next; 487b3506946SBarry Smith } 488b3506946SBarry Smith 489b3506946SBarry Smith /* wait until accessor has unlocked the memory */ 49064bbc9efSBarry Smith PetscStackCallSAWs(SAWs_Push_Header,("index.html",OptionsHeader)); 49164bbc9efSBarry Smith PetscStackCallSAWs(SAWs_Push_Body,("index.html",2,OptionsBodyBottom)); 4927aab2a10SBarry Smith ierr = PetscSAWsBlock();CHKERRQ(ierr); 49364bbc9efSBarry Smith PetscStackCallSAWs(SAWs_Pop_Header,("index.html")); 49464bbc9efSBarry Smith PetscStackCallSAWs(SAWs_Pop_Body,("index.html",2)); 495b3506946SBarry Smith 49688a9752cSBarry Smith /* determine if any values have been set in GUI */ 49783355fc5SBarry Smith next = PetscOptionsObject->next; 49888a9752cSBarry Smith while (next) { 49988a9752cSBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Options/%s",next->option);CHKERRQ(ierr); 500f7b25cf6SBarry Smith PetscStackCallSAWs(SAWs_Selected,(dir,(int*)&next->set)); 50188a9752cSBarry Smith next = next->next; 50288a9752cSBarry Smith } 50388a9752cSBarry Smith 504b3506946SBarry Smith /* reset counter to -2; this updates the screen with the new options for the selected method */ 505f7b25cf6SBarry Smith if (changedmethod) PetscOptionsObject->count = -2; 506b3506946SBarry Smith 507a23eb982SSurtai Han if (stopasking) { 508a23eb982SSurtai Han PetscOptionsPublish = PETSC_FALSE; 50912655325SBarry Smith PetscOptionsObject->count = 0;//do not ask for same thing again 510a23eb982SSurtai Han } 511a23eb982SSurtai Han 5129a492a5cSBarry Smith PetscStackCallSAWs(SAWs_Delete,("/PETSc/Options")); 513b3506946SBarry Smith PetscFunctionReturn(0); 514b3506946SBarry Smith } 515b3506946SBarry Smith #endif 516b3506946SBarry Smith 5174416b707SBarry Smith PetscErrorCode PetscOptionsEnd_Private(PetscOptionItems *PetscOptionsObject) 51853acd3b1SBarry Smith { 51953acd3b1SBarry Smith PetscErrorCode ierr; 5204416b707SBarry Smith PetscOptionItem last; 5216356e834SBarry Smith char option[256],value[1024],tmp[32]; 522330cf3c9SBarry Smith size_t j; 52353acd3b1SBarry Smith 52453acd3b1SBarry Smith PetscFunctionBegin; 52583355fc5SBarry Smith if (PetscOptionsObject->next) { 52683355fc5SBarry Smith if (!PetscOptionsObject->count) { 527a264d7a6SBarry Smith #if defined(PETSC_HAVE_SAWS) 528f7b25cf6SBarry Smith ierr = PetscOptionsSAWsInput(PetscOptionsObject);CHKERRQ(ierr); 529b3506946SBarry Smith #else 530e55864a3SBarry Smith ierr = PetscOptionsGetFromTextInput(PetscOptionsObject);CHKERRQ(ierr); 531b3506946SBarry Smith #endif 532aee2cecaSBarry Smith } 533aee2cecaSBarry Smith } 5346356e834SBarry Smith 535e55864a3SBarry Smith ierr = PetscFree(PetscOptionsObject->title);CHKERRQ(ierr); 5366356e834SBarry Smith 537e26ddf31SBarry Smith /* reset counter to -2; this updates the screen with the new options for the selected method */ 538e55864a3SBarry Smith if (PetscOptionsObject->changedmethod) PetscOptionsObject->count = -2; 5397a72a596SBarry Smith /* reset alreadyprinted flag */ 540e55864a3SBarry Smith PetscOptionsObject->alreadyprinted = PETSC_FALSE; 541e55864a3SBarry Smith if (PetscOptionsObject->object) PetscOptionsObject->object->optionsprinted = PETSC_TRUE; 542e55864a3SBarry Smith PetscOptionsObject->object = NULL; 54353acd3b1SBarry Smith 544e55864a3SBarry Smith while (PetscOptionsObject->next) { 545e55864a3SBarry Smith if (PetscOptionsObject->next->set) { 546e55864a3SBarry Smith if (PetscOptionsObject->prefix) { 54753acd3b1SBarry Smith ierr = PetscStrcpy(option,"-");CHKERRQ(ierr); 548e55864a3SBarry Smith ierr = PetscStrcat(option,PetscOptionsObject->prefix);CHKERRQ(ierr); 549e55864a3SBarry Smith ierr = PetscStrcat(option,PetscOptionsObject->next->option+1);CHKERRQ(ierr); 5506356e834SBarry Smith } else { 551e55864a3SBarry Smith ierr = PetscStrcpy(option,PetscOptionsObject->next->option);CHKERRQ(ierr); 5526356e834SBarry Smith } 5536356e834SBarry Smith 554e55864a3SBarry Smith switch (PetscOptionsObject->next->type) { 5556356e834SBarry Smith case OPTION_HEAD: 5566356e834SBarry Smith break; 5576356e834SBarry Smith case OPTION_INT_ARRAY: 558e55864a3SBarry Smith sprintf(value,"%d",(int)((PetscInt*)PetscOptionsObject->next->data)[0]); 559e55864a3SBarry Smith for (j=1; j<PetscOptionsObject->next->arraylength; j++) { 560e55864a3SBarry Smith sprintf(tmp,"%d",(int)((PetscInt*)PetscOptionsObject->next->data)[j]); 5616356e834SBarry Smith ierr = PetscStrcat(value,",");CHKERRQ(ierr); 5626356e834SBarry Smith ierr = PetscStrcat(value,tmp);CHKERRQ(ierr); 5636356e834SBarry Smith } 5646356e834SBarry Smith break; 5656356e834SBarry Smith case OPTION_INT: 566e55864a3SBarry Smith sprintf(value,"%d",(int) *(PetscInt*)PetscOptionsObject->next->data); 5676356e834SBarry Smith break; 5686356e834SBarry Smith case OPTION_REAL: 569e55864a3SBarry Smith sprintf(value,"%g",(double) *(PetscReal*)PetscOptionsObject->next->data); 5706356e834SBarry Smith break; 5716356e834SBarry Smith case OPTION_REAL_ARRAY: 572e55864a3SBarry Smith sprintf(value,"%g",(double)((PetscReal*)PetscOptionsObject->next->data)[0]); 573e55864a3SBarry Smith for (j=1; j<PetscOptionsObject->next->arraylength; j++) { 574e55864a3SBarry Smith sprintf(tmp,"%g",(double)((PetscReal*)PetscOptionsObject->next->data)[j]); 5756356e834SBarry Smith ierr = PetscStrcat(value,",");CHKERRQ(ierr); 5766356e834SBarry Smith ierr = PetscStrcat(value,tmp);CHKERRQ(ierr); 5776356e834SBarry Smith } 5786356e834SBarry Smith break; 579050cccc3SHong Zhang case OPTION_SCALAR_ARRAY: 58095f3a755SJose E. Roman sprintf(value,"%g+%gi",(double)PetscRealPart(((PetscScalar*)PetscOptionsObject->next->data)[0]),(double)PetscImaginaryPart(((PetscScalar*)PetscOptionsObject->next->data)[0])); 581050cccc3SHong Zhang for (j=1; j<PetscOptionsObject->next->arraylength; j++) { 58295f3a755SJose E. Roman sprintf(tmp,"%g+%gi",(double)PetscRealPart(((PetscScalar*)PetscOptionsObject->next->data)[j]),(double)PetscImaginaryPart(((PetscScalar*)PetscOptionsObject->next->data)[j])); 583050cccc3SHong Zhang ierr = PetscStrcat(value,",");CHKERRQ(ierr); 584050cccc3SHong Zhang ierr = PetscStrcat(value,tmp);CHKERRQ(ierr); 585050cccc3SHong Zhang } 586050cccc3SHong Zhang break; 5877781c08eSBarry Smith case OPTION_BOOL: 588e55864a3SBarry Smith sprintf(value,"%d",*(int*)PetscOptionsObject->next->data); 5896356e834SBarry Smith break; 5907781c08eSBarry Smith case OPTION_BOOL_ARRAY: 591e55864a3SBarry Smith sprintf(value,"%d",(int)((PetscBool*)PetscOptionsObject->next->data)[0]); 592e55864a3SBarry Smith for (j=1; j<PetscOptionsObject->next->arraylength; j++) { 593e55864a3SBarry Smith sprintf(tmp,"%d",(int)((PetscBool*)PetscOptionsObject->next->data)[j]); 5941ae3d29cSBarry Smith ierr = PetscStrcat(value,",");CHKERRQ(ierr); 5951ae3d29cSBarry Smith ierr = PetscStrcat(value,tmp);CHKERRQ(ierr); 5961ae3d29cSBarry Smith } 5971ae3d29cSBarry Smith break; 598a264d7a6SBarry Smith case OPTION_FLIST: 5996991f827SBarry Smith ierr = PetscStrcpy(value,(char*)PetscOptionsObject->next->data);CHKERRQ(ierr); 6006991f827SBarry Smith break; 6011ae3d29cSBarry Smith case OPTION_ELIST: 602e55864a3SBarry Smith ierr = PetscStrcpy(value,(char*)PetscOptionsObject->next->data);CHKERRQ(ierr); 6036356e834SBarry Smith break; 6041ae3d29cSBarry Smith case OPTION_STRING: 605e55864a3SBarry Smith ierr = PetscStrcpy(value,(char*)PetscOptionsObject->next->data);CHKERRQ(ierr); 606d51da6bfSBarry Smith break; 6071ae3d29cSBarry Smith case OPTION_STRING_ARRAY: 608e55864a3SBarry Smith sprintf(value,"%s",((char**)PetscOptionsObject->next->data)[0]); 609e55864a3SBarry Smith for (j=1; j<PetscOptionsObject->next->arraylength; j++) { 610e55864a3SBarry Smith sprintf(tmp,"%s",((char**)PetscOptionsObject->next->data)[j]); 6111ae3d29cSBarry Smith ierr = PetscStrcat(value,",");CHKERRQ(ierr); 6121ae3d29cSBarry Smith ierr = PetscStrcat(value,tmp);CHKERRQ(ierr); 6131ae3d29cSBarry Smith } 6146356e834SBarry Smith break; 6156356e834SBarry Smith } 616c5929fdfSBarry Smith ierr = PetscOptionsSetValue(PetscOptionsObject->options,option,value);CHKERRQ(ierr); 6176356e834SBarry Smith } 6186991f827SBarry Smith if (PetscOptionsObject->next->type == OPTION_ELIST) { 6196991f827SBarry Smith ierr = PetscStrNArrayDestroy(PetscOptionsObject->next->nlist,(char ***)&PetscOptionsObject->next->list);CHKERRQ(ierr); 6206991f827SBarry Smith } 621e55864a3SBarry Smith ierr = PetscFree(PetscOptionsObject->next->text);CHKERRQ(ierr); 622e55864a3SBarry Smith ierr = PetscFree(PetscOptionsObject->next->option);CHKERRQ(ierr); 623e55864a3SBarry Smith ierr = PetscFree(PetscOptionsObject->next->man);CHKERRQ(ierr); 624e55864a3SBarry Smith ierr = PetscFree(PetscOptionsObject->next->edata);CHKERRQ(ierr); 625c979a496SBarry Smith 62683355fc5SBarry Smith if ((PetscOptionsObject->next->type == OPTION_STRING) || (PetscOptionsObject->next->type == OPTION_FLIST) || (PetscOptionsObject->next->type == OPTION_ELIST)){ 62783355fc5SBarry Smith free(PetscOptionsObject->next->data); 628c979a496SBarry Smith } else { 62983355fc5SBarry Smith ierr = PetscFree(PetscOptionsObject->next->data);CHKERRQ(ierr); 630c979a496SBarry Smith } 6317781c08eSBarry Smith 63283355fc5SBarry Smith last = PetscOptionsObject->next; 63383355fc5SBarry Smith PetscOptionsObject->next = PetscOptionsObject->next->next; 6346356e834SBarry Smith ierr = PetscFree(last);CHKERRQ(ierr); 6356356e834SBarry Smith } 636f59f755dSBarry Smith ierr = PetscFree(PetscOptionsObject->prefix);CHKERRQ(ierr); 637*02c9f0b5SLisandro Dalcin PetscOptionsObject->next = NULL; 63853acd3b1SBarry Smith PetscFunctionReturn(0); 63953acd3b1SBarry Smith } 64053acd3b1SBarry Smith 64188aa4217SBarry Smith /*MC 64253acd3b1SBarry Smith PetscOptionsEnum - Gets the enum value for a particular option in the database. 64353acd3b1SBarry Smith 6443f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 64553acd3b1SBarry Smith 64688aa4217SBarry Smith Synopsis: 64788aa4217SBarry Smith #include "petscsys.h" 64888aa4217SBarry Smith PetscErrorCode PetscOptionsEnum(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],const char *const *list,PetscEnum currentvalue,PetscEnum *value,PetscBool *set) 64988aa4217SBarry Smith 65053acd3b1SBarry Smith Input Parameters: 65153acd3b1SBarry Smith + opt - option name 65253acd3b1SBarry Smith . text - short string that describes the option 65353acd3b1SBarry Smith . man - manual page with additional information on option 65453acd3b1SBarry Smith . list - array containing the list of choices, followed by the enum name, followed by the enum prefix, followed by a null 6550fdccdaeSBarry Smith - currentvalue - the current value; caller is responsible for setting this value correctly. Normally this is done with either 6560fdccdaeSBarry Smith $ PetscOptionsEnum(..., obj->value,&object->value,...) or 6570fdccdaeSBarry Smith $ value = defaultvalue 6580fdccdaeSBarry Smith $ PetscOptionsEnum(..., value,&value,&flg); 6590fdccdaeSBarry Smith $ if (flg) { 66053acd3b1SBarry Smith 66153acd3b1SBarry Smith Output Parameter: 66253acd3b1SBarry Smith + value - the value to return 663b32e0204SMatthew G Knepley - set - PETSC_TRUE if found, else PETSC_FALSE 66453acd3b1SBarry Smith 66553acd3b1SBarry Smith Level: beginner 66653acd3b1SBarry Smith 66795452b02SPatrick Sanan Notes: 66895452b02SPatrick Sanan Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 66953acd3b1SBarry Smith 67053acd3b1SBarry Smith list is usually something like PCASMTypes or some other predefined list of enum names 67153acd3b1SBarry Smith 6722efd9cb1SBarry Smith If the user does not supply the option at all value is NOT changed. Thus 6732efd9cb1SBarry Smith you should ALWAYS initialize value if you access it without first checking if the set flag is true. 6742efd9cb1SBarry Smith 675989712b9SBarry Smith The default/currentvalue passed into this routine does not get transferred to the output value variable automatically. 676989712b9SBarry Smith 67753acd3b1SBarry Smith .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 678acfcf0e5SJed Brown PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 679acfcf0e5SJed Brown PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 68053acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 68153acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 682acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 683a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 68488aa4217SBarry Smith M*/ 68588aa4217SBarry Smith 6864416b707SBarry Smith PetscErrorCode PetscOptionsEnum_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],const char *const *list,PetscEnum currentvalue,PetscEnum *value,PetscBool *set) 68753acd3b1SBarry Smith { 68853acd3b1SBarry Smith PetscErrorCode ierr; 68953acd3b1SBarry Smith PetscInt ntext = 0; 690aa5bb8c0SSatish Balay PetscInt tval; 691ace3abfcSBarry Smith PetscBool tflg; 69253acd3b1SBarry Smith 69353acd3b1SBarry Smith PetscFunctionBegin; 69453acd3b1SBarry Smith while (list[ntext++]) { 695e32f2f54SBarry Smith if (ntext > 50) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"List argument appears to be wrong or have more than 50 entries"); 69653acd3b1SBarry Smith } 697e32f2f54SBarry Smith if (ntext < 3) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"List argument must have at least two entries: typename and type prefix"); 69853acd3b1SBarry Smith ntext -= 3; 699e55864a3SBarry Smith ierr = PetscOptionsEList_Private(PetscOptionsObject,opt,text,man,list,ntext,list[currentvalue],&tval,&tflg);CHKERRQ(ierr); 700aa5bb8c0SSatish Balay /* with PETSC_USE_64BIT_INDICES sizeof(PetscInt) != sizeof(PetscEnum) */ 701aa5bb8c0SSatish Balay if (tflg) *value = (PetscEnum)tval; 702aa5bb8c0SSatish Balay if (set) *set = tflg; 70353acd3b1SBarry Smith PetscFunctionReturn(0); 70453acd3b1SBarry Smith } 70553acd3b1SBarry Smith 70688aa4217SBarry Smith /*MC 707d3e47460SLisandro Dalcin PetscOptionsEnumArray - Gets an array of enum values for a particular 708d3e47460SLisandro Dalcin option in the database. 709d3e47460SLisandro Dalcin 710d3e47460SLisandro Dalcin Logically Collective on the communicator passed in PetscOptionsBegin() 711d3e47460SLisandro Dalcin 71288aa4217SBarry Smith Synopsis: 71388aa4217SBarry Smith #include "petscsys.h" 71488aa4217SBarry Smith PetscErrorCode PetscOptionsEnumArray(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],const char *const *list,PetscEnum value[],PetscInt *n,PetscBool *set) 71588aa4217SBarry Smith 716d3e47460SLisandro Dalcin Input Parameters: 717d3e47460SLisandro Dalcin + opt - the option one is seeking 718d3e47460SLisandro Dalcin . text - short string describing option 719d3e47460SLisandro Dalcin . man - manual page for option 72022d58ec6SMatthew G. Knepley . list - array containing the list of choices, followed by the enum name, followed by the enum prefix, followed by a null 721d3e47460SLisandro Dalcin - n - maximum number of values 722d3e47460SLisandro Dalcin 723d3e47460SLisandro Dalcin Output Parameter: 724d3e47460SLisandro Dalcin + value - location to copy values 725d3e47460SLisandro Dalcin . n - actual number of values found 726d3e47460SLisandro Dalcin - set - PETSC_TRUE if found, else PETSC_FALSE 727d3e47460SLisandro Dalcin 728d3e47460SLisandro Dalcin Level: beginner 729d3e47460SLisandro Dalcin 730d3e47460SLisandro Dalcin Notes: 731d3e47460SLisandro Dalcin The array must be passed as a comma separated list. 732d3e47460SLisandro Dalcin 733d3e47460SLisandro Dalcin There must be no intervening spaces between the values. 734d3e47460SLisandro Dalcin 735d3e47460SLisandro Dalcin Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 736d3e47460SLisandro Dalcin 737d3e47460SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 738d3e47460SLisandro Dalcin PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 739d3e47460SLisandro Dalcin PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 740d3e47460SLisandro Dalcin PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 741d3e47460SLisandro Dalcin PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 742d3e47460SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList(), PetscOptionsRealArray() 74388aa4217SBarry Smith M*/ 74488aa4217SBarry Smith 7454416b707SBarry Smith PetscErrorCode PetscOptionsEnumArray_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],const char *const *list,PetscEnum value[],PetscInt *n,PetscBool *set) 746d3e47460SLisandro Dalcin { 747d3e47460SLisandro Dalcin PetscInt i,nlist = 0; 7484416b707SBarry Smith PetscOptionItem amsopt; 749d3e47460SLisandro Dalcin PetscErrorCode ierr; 750d3e47460SLisandro Dalcin 751d3e47460SLisandro Dalcin PetscFunctionBegin; 752d3e47460SLisandro Dalcin while (list[nlist++]) if (nlist > 50) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"List argument appears to be wrong or have more than 50 entries"); 753d3e47460SLisandro Dalcin if (nlist < 3) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"List argument must have at least two entries: typename and type prefix"); 754d3e47460SLisandro Dalcin nlist -= 3; /* drop enum name, prefix, and null termination */ 755d3e47460SLisandro Dalcin if (0 && !PetscOptionsObject->count) { /* XXX Requires additional support */ 756d3e47460SLisandro Dalcin PetscEnum *vals; 7574416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_INT_ARRAY/*XXX OPTION_ENUM_ARRAY*/,&amsopt);CHKERRQ(ierr); 758d3e47460SLisandro Dalcin ierr = PetscStrNArrayallocpy(nlist,list,(char***)&amsopt->list);CHKERRQ(ierr); 759d3e47460SLisandro Dalcin amsopt->nlist = nlist; 760d3e47460SLisandro Dalcin ierr = PetscMalloc1(*n,(PetscEnum**)&amsopt->data);CHKERRQ(ierr); 761d3e47460SLisandro Dalcin amsopt->arraylength = *n; 762d3e47460SLisandro Dalcin vals = (PetscEnum*)amsopt->data; 763d3e47460SLisandro Dalcin for (i=0; i<*n; i++) vals[i] = value[i]; 764d3e47460SLisandro Dalcin } 765c5929fdfSBarry Smith ierr = PetscOptionsGetEnumArray(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,list,value,n,set);CHKERRQ(ierr); 766d3e47460SLisandro Dalcin if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 767d3e47460SLisandro Dalcin ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s <%s",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",opt+1,list[value[0]]);CHKERRQ(ierr); 768d3e47460SLisandro Dalcin for (i=1; i<*n; i++) {ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm,",%s",list[value[i]]);CHKERRQ(ierr);} 769d3e47460SLisandro Dalcin ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm,">: %s (choose from)",text);CHKERRQ(ierr); 770d3e47460SLisandro Dalcin for (i=0; i<nlist; i++) {ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," %s",list[i]);CHKERRQ(ierr);} 771d3e47460SLisandro Dalcin ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," (%s)\n",ManSection(man));CHKERRQ(ierr); 772d3e47460SLisandro Dalcin } 773d3e47460SLisandro Dalcin PetscFunctionReturn(0); 774d3e47460SLisandro Dalcin } 775d3e47460SLisandro Dalcin 77688aa4217SBarry Smith /*MC 7775a856986SBarry Smith PetscOptionsBoundedInt - Gets an integer value greater than or equal a given bound for a particular option in the database. 7785a856986SBarry Smith 7795a856986SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 7805a856986SBarry Smith 78188aa4217SBarry Smith Synopsis: 78288aa4217SBarry Smith #include "petscsys.h" 78388aa4217SBarry Smith PetscErrorCode PetscOptionsBoundInt(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscInt currentvalue,PetscInt *value,PetscBool *flg,PetscInt bound) 78488aa4217SBarry Smith 7855a856986SBarry Smith Input Parameters: 7865a856986SBarry Smith + opt - option name 7875a856986SBarry Smith . text - short string that describes the option 7885a856986SBarry Smith . man - manual page with additional information on option 7895a856986SBarry Smith . currentvalue - the current value; caller is responsible for setting this value correctly. Normally this is done with either 79088aa4217SBarry Smith $ PetscOptionsInt(..., obj->value,&obj->value,...) or 7915a856986SBarry Smith $ value = defaultvalue 7925a856986SBarry Smith $ PetscOptionsInt(..., value,&value,&flg); 7935a856986SBarry Smith $ if (flg) { 79488aa4217SBarry Smith - bound - the requested value should be greater than or equal this bound or an error is generated 7955a856986SBarry Smith 7965a856986SBarry Smith Output Parameter: 7975a856986SBarry Smith + value - the integer value to return 7985a856986SBarry Smith - flg - PETSC_TRUE if found, else PETSC_FALSE 7995a856986SBarry Smith 8005a856986SBarry Smith Notes: 8015a856986SBarry Smith If the user does not supply the option at all value is NOT changed. Thus 8025a856986SBarry Smith you should ALWAYS initialize value if you access it without first checking if the set flag is true. 8035a856986SBarry Smith 8045a856986SBarry Smith The default/currentvalue passed into this routine does not get transferred to the output value variable automatically. 8055a856986SBarry Smith 8065a856986SBarry Smith Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 8075a856986SBarry Smith 8085a856986SBarry Smith Level: beginner 8095a856986SBarry Smith 8105a856986SBarry Smith .seealso: PetscOptionsInt(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 8115a856986SBarry Smith PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), PetscOptionsRangeInt() 8125a856986SBarry Smith PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 8135a856986SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 8145a856986SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 8155a856986SBarry Smith PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 8165a856986SBarry Smith PetscOptionsFList(), PetscOptionsEList() 81788aa4217SBarry Smith M*/ 8185a856986SBarry Smith 81988aa4217SBarry Smith /*MC 8205a856986SBarry Smith PetscOptionsRangeInt - Gets an integer value within a range of values for a particular option in the database. 8215a856986SBarry Smith 8225a856986SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 8235a856986SBarry Smith 82488aa4217SBarry Smith Synopsis: 82588aa4217SBarry Smith #include "petscsys.h" 82688aa4217SBarry Smith PetscErrorCode PetscOptionsRangeInt(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscInt currentvalue,PetscInt *value,PetscBool *flg,PetscInt lb,PetscInt ub) 82788aa4217SBarry Smith 8285a856986SBarry Smith Input Parameters: 8295a856986SBarry Smith + opt - option name 8305a856986SBarry Smith . text - short string that describes the option 8315a856986SBarry Smith . man - manual page with additional information on option 8325a856986SBarry Smith . currentvalue - the current value; caller is responsible for setting this value correctly. Normally this is done with either 83388aa4217SBarry Smith $ PetscOptionsInt(..., obj->value,&obj->value,...) or 8345a856986SBarry Smith $ value = defaultvalue 8355a856986SBarry Smith $ PetscOptionsInt(..., value,&value,&flg); 8365a856986SBarry Smith $ if (flg) { 83788aa4217SBarry Smith . lb - the lower bound, provided value must be greater than or equal to this value or an error is generated 83888aa4217SBarry Smith - ub - the upper bound, provided value must be less than or equal to this value or an error is generated 8395a856986SBarry Smith 8405a856986SBarry Smith Output Parameter: 8415a856986SBarry Smith + value - the integer value to return 8425a856986SBarry Smith - flg - PETSC_TRUE if found, else PETSC_FALSE 8435a856986SBarry Smith 8445a856986SBarry Smith Notes: 8455a856986SBarry Smith If the user does not supply the option at all value is NOT changed. Thus 8465a856986SBarry Smith you should ALWAYS initialize value if you access it without first checking if the set flag is true. 8475a856986SBarry Smith 8485a856986SBarry Smith The default/currentvalue passed into this routine does not get transferred to the output value variable automatically. 8495a856986SBarry Smith 8505a856986SBarry Smith Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 8515a856986SBarry Smith 8525a856986SBarry Smith Level: beginner 8535a856986SBarry Smith 8545a856986SBarry Smith .seealso: PetscOptionsInt(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 8555a856986SBarry Smith PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), PetscOptionsBoundedInt() 8565a856986SBarry Smith PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 8575a856986SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 8585a856986SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 8595a856986SBarry Smith PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 8605a856986SBarry Smith PetscOptionsFList(), PetscOptionsEList() 86188aa4217SBarry Smith M*/ 8625a856986SBarry Smith 86388aa4217SBarry Smith /*MC 86453acd3b1SBarry Smith PetscOptionsInt - Gets the integer value for a particular option in the database. 86553acd3b1SBarry Smith 8663f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 86753acd3b1SBarry Smith 86888aa4217SBarry Smith Synopsis: 86988aa4217SBarry Smith #include "petscsys.h" 87088aa4217SBarry Smith PetscErrorCode PetscOptionsInt(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscInt currentvalue,PetscInt *value,PetscBool *flg)) 87188aa4217SBarry Smith 87288aa4217SBarry Smith 87353acd3b1SBarry Smith Input Parameters: 87453acd3b1SBarry Smith + opt - option name 87553acd3b1SBarry Smith . text - short string that describes the option 87653acd3b1SBarry Smith . man - manual page with additional information on option 8770fdccdaeSBarry Smith - currentvalue - the current value; caller is responsible for setting this value correctly. Normally this is done with either 87888aa4217SBarry Smith $ PetscOptionsInt(..., obj->value,&obj->value,...) or 8790fdccdaeSBarry Smith $ value = defaultvalue 8800fdccdaeSBarry Smith $ PetscOptionsInt(..., value,&value,&flg); 8810fdccdaeSBarry Smith $ if (flg) { 88253acd3b1SBarry Smith 88353acd3b1SBarry Smith Output Parameter: 88453acd3b1SBarry Smith + value - the integer value to return 88553acd3b1SBarry Smith - flg - PETSC_TRUE if found, else PETSC_FALSE 88653acd3b1SBarry Smith 88795452b02SPatrick Sanan Notes: 88895452b02SPatrick Sanan If the user does not supply the option at all value is NOT changed. Thus 8892efd9cb1SBarry Smith you should ALWAYS initialize value if you access it without first checking if the set flag is true. 8902efd9cb1SBarry Smith 891989712b9SBarry Smith The default/currentvalue passed into this routine does not get transferred to the output value variable automatically. 892989712b9SBarry Smith 89395452b02SPatrick Sanan Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 89453acd3b1SBarry Smith 8955a856986SBarry Smith Level: beginner 8965a856986SBarry Smith 8975a856986SBarry Smith .seealso: PetscOptionsBoundedInt(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 8985a856986SBarry Smith PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), PetscOptionsRangeInt() 899acfcf0e5SJed Brown PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 90053acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 90153acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 902acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 903a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 90488aa4217SBarry Smith M*/ 90588aa4217SBarry Smith 9065a856986SBarry Smith PetscErrorCode PetscOptionsInt_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscInt currentvalue,PetscInt *value,PetscBool *set,PetscInt lb,PetscInt ub) 90753acd3b1SBarry Smith { 90853acd3b1SBarry Smith PetscErrorCode ierr; 9094416b707SBarry Smith PetscOptionItem amsopt; 91012655325SBarry Smith PetscBool wasset; 91153acd3b1SBarry Smith 91253acd3b1SBarry Smith PetscFunctionBegin; 9135a856986SBarry Smith if (currentvalue < lb) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Current value %D less than allowed bound %D",currentvalue,lb); 914c5910190SPierre Jolivet if (currentvalue > ub) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Current value %D greater than allowed bound %D",currentvalue,ub); 915e55864a3SBarry Smith if (!PetscOptionsObject->count) { 9164416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_INT,&amsopt);CHKERRQ(ierr); 9176356e834SBarry Smith ierr = PetscMalloc(sizeof(PetscInt),&amsopt->data);CHKERRQ(ierr); 91812655325SBarry Smith *(PetscInt*)amsopt->data = currentvalue; 9193e211508SBarry Smith 920c5929fdfSBarry Smith ierr = PetscOptionsGetInt(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,¤tvalue,&wasset);CHKERRQ(ierr); 9213e211508SBarry Smith if (wasset) { 92212655325SBarry Smith *(PetscInt*)amsopt->data = currentvalue; 9233e211508SBarry Smith } 924af6d86caSBarry Smith } 92544ef3d73SBarry Smith ierr = PetscOptionsGetInt(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,value,&wasset);CHKERRQ(ierr); 9265a856986SBarry Smith if (wasset && *value < lb) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Newly set value %D less than allowed bound %D",*value,lb); 9275a856986SBarry Smith if (wasset && *value > ub) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Newly set value %D greater than allowed bound %D",*value,ub); 92844ef3d73SBarry Smith if (set) *set = wasset; 929e55864a3SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 9300e4c290aSBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s <now %D : formerly %D>: %s (%s)\n",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",opt+1,wasset && value ? *value : currentvalue,currentvalue,text,ManSection(man));CHKERRQ(ierr); 93153acd3b1SBarry Smith } 93253acd3b1SBarry Smith PetscFunctionReturn(0); 93353acd3b1SBarry Smith } 93453acd3b1SBarry Smith 93588aa4217SBarry Smith /*MC 93653acd3b1SBarry Smith PetscOptionsString - Gets the string value for a particular option in the database. 93753acd3b1SBarry Smith 9383f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 93953acd3b1SBarry Smith 94088aa4217SBarry Smith Synopsis: 94188aa4217SBarry Smith #include "petscsys.h" 94288aa4217SBarry Smith PetscErrorCode PetscOptionsString(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],const char currentvalue[],char value[],size_t len,PetscBool *set) 94388aa4217SBarry Smith 94453acd3b1SBarry Smith Input Parameters: 94553acd3b1SBarry Smith + opt - option name 94653acd3b1SBarry Smith . text - short string that describes the option 94753acd3b1SBarry Smith . man - manual page with additional information on option 9480fdccdaeSBarry Smith . currentvalue - the current value; caller is responsible for setting this value correctly. This is not used to set value 949bcbf2dc5SJed Brown - len - length of the result string including null terminator 95053acd3b1SBarry Smith 95153acd3b1SBarry Smith Output Parameter: 95253acd3b1SBarry Smith + value - the value to return 95353acd3b1SBarry Smith - flg - PETSC_TRUE if found, else PETSC_FALSE 95453acd3b1SBarry Smith 95553acd3b1SBarry Smith Level: beginner 95653acd3b1SBarry Smith 95795452b02SPatrick Sanan Notes: 95895452b02SPatrick Sanan Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 95953acd3b1SBarry Smith 9607fccdfe4SBarry Smith Even if the user provided no string (for example -optionname -someotheroption) the flag is set to PETSC_TRUE (and the string is fulled with nulls). 9617fccdfe4SBarry Smith 9622efd9cb1SBarry Smith If the user does not supply the option at all value is NOT changed. Thus 9632efd9cb1SBarry Smith you should ALWAYS initialize value if you access it without first checking if the set flag is true. 9642efd9cb1SBarry Smith 965989712b9SBarry Smith The default/currentvalue passed into this routine does not get transferred to the output value variable automatically. 966989712b9SBarry Smith 9672efd9cb1SBarry Smith 96889a13869SBarry Smith .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 969acfcf0e5SJed Brown PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 970acfcf0e5SJed Brown PetscOptionsInt(), PetscOptionsReal(), PetscOptionsBool(), 97153acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 97253acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 973acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 974a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 97588aa4217SBarry Smith M*/ 97688aa4217SBarry Smith 9774416b707SBarry Smith PetscErrorCode PetscOptionsString_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],const char currentvalue[],char value[],size_t len,PetscBool *set) 97853acd3b1SBarry Smith { 97953acd3b1SBarry Smith PetscErrorCode ierr; 9804416b707SBarry Smith PetscOptionItem amsopt; 98144ef3d73SBarry Smith PetscBool lset; 98253acd3b1SBarry Smith 98353acd3b1SBarry Smith PetscFunctionBegin; 9841a1499c8SBarry Smith if (!PetscOptionsObject->count) { 9854416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_STRING,&amsopt);CHKERRQ(ierr); 98664facd6cSBarry Smith /* must use system malloc since SAWs may free this */ 9870fdccdaeSBarry Smith ierr = PetscStrdup(currentvalue ? currentvalue : "",(char**)&amsopt->data);CHKERRQ(ierr); 988af6d86caSBarry Smith } 98944ef3d73SBarry Smith ierr = PetscOptionsGetString(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,value,len,&lset);CHKERRQ(ierr); 99044ef3d73SBarry Smith if (set) *set = lset; 991e55864a3SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 9920e4c290aSBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s <now %s : formerly %s>: %s (%s)\n",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",opt+1,lset && value ? value : currentvalue,currentvalue,text,ManSection(man));CHKERRQ(ierr); 99353acd3b1SBarry Smith } 99453acd3b1SBarry Smith PetscFunctionReturn(0); 99553acd3b1SBarry Smith } 99653acd3b1SBarry Smith 99788aa4217SBarry Smith /*MC 99853acd3b1SBarry Smith PetscOptionsReal - Gets the PetscReal value for a particular option in the database. 99953acd3b1SBarry Smith 10003f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 100153acd3b1SBarry Smith 100288aa4217SBarry Smith Synopsis: 100388aa4217SBarry Smith #include "petscsys.h" 100488aa4217SBarry Smith PetscErrorCode PetscOptionsReal(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscReal currentvalue,PetscReal *value,PetscBool *set) 100588aa4217SBarry Smith 100653acd3b1SBarry Smith Input Parameters: 100753acd3b1SBarry Smith + opt - option name 100853acd3b1SBarry Smith . text - short string that describes the option 100953acd3b1SBarry Smith . man - manual page with additional information on option 10100fdccdaeSBarry Smith - currentvalue - the current value; caller is responsible for setting this value correctly. Normally this is done with either 101188aa4217SBarry Smith $ PetscOptionsReal(..., obj->value,&obj->value,...) or 10120fdccdaeSBarry Smith $ value = defaultvalue 10130fdccdaeSBarry Smith $ PetscOptionsReal(..., value,&value,&flg); 10140fdccdaeSBarry Smith $ if (flg) { 101553acd3b1SBarry Smith 101653acd3b1SBarry Smith Output Parameter: 101753acd3b1SBarry Smith + value - the value to return 101853acd3b1SBarry Smith - flg - PETSC_TRUE if found, else PETSC_FALSE 101953acd3b1SBarry Smith 102095452b02SPatrick Sanan Notes: 102195452b02SPatrick Sanan If the user does not supply the option at all value is NOT changed. Thus 10222efd9cb1SBarry Smith you should ALWAYS initialize value if you access it without first checking if the set flag is true. 10232efd9cb1SBarry Smith 1024989712b9SBarry Smith The default/currentvalue passed into this routine does not get transferred to the output value variable automatically. 1025989712b9SBarry Smith 102695452b02SPatrick Sanan Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 102753acd3b1SBarry Smith 10285a856986SBarry Smith Level: beginner 10295a856986SBarry Smith 103089a13869SBarry Smith .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 1031acfcf0e5SJed Brown PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 1032acfcf0e5SJed Brown PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 103353acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 103453acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1035acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1036a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 103788aa4217SBarry Smith M*/ 103888aa4217SBarry Smith 10394416b707SBarry Smith PetscErrorCode PetscOptionsReal_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscReal currentvalue,PetscReal *value,PetscBool *set) 104053acd3b1SBarry Smith { 104153acd3b1SBarry Smith PetscErrorCode ierr; 10424416b707SBarry Smith PetscOptionItem amsopt; 104344ef3d73SBarry Smith PetscBool lset; 104453acd3b1SBarry Smith 104553acd3b1SBarry Smith PetscFunctionBegin; 1046e55864a3SBarry Smith if (!PetscOptionsObject->count) { 10474416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_REAL,&amsopt);CHKERRQ(ierr); 1048538aa990SBarry Smith ierr = PetscMalloc(sizeof(PetscReal),&amsopt->data);CHKERRQ(ierr); 1049a297a907SKarl Rupp 10500fdccdaeSBarry Smith *(PetscReal*)amsopt->data = currentvalue; 1051538aa990SBarry Smith } 105244ef3d73SBarry Smith ierr = PetscOptionsGetReal(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,value,&lset);CHKERRQ(ierr); 105344ef3d73SBarry Smith if (set) *set = lset; 10541a1499c8SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 10550e4c290aSBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s <%g : %g>: %s (%s)\n",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",opt+1,lset && value ? (double)*value : (double) currentvalue,(double)currentvalue,text,ManSection(man));CHKERRQ(ierr); 105653acd3b1SBarry Smith } 105753acd3b1SBarry Smith PetscFunctionReturn(0); 105853acd3b1SBarry Smith } 105953acd3b1SBarry Smith 106088aa4217SBarry Smith /*MC 106153acd3b1SBarry Smith PetscOptionsScalar - Gets the scalar value for a particular option in the database. 106253acd3b1SBarry Smith 10633f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 106453acd3b1SBarry Smith 106588aa4217SBarry Smith Synopsis: 106688aa4217SBarry Smith #include "petscsys.h" 106788aa4217SBarry Smith PetscErrorCode PetscOptionsScalar(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscScalar currentvalue,PetscScalar *value,PetscBool *set) 106888aa4217SBarry Smith 106953acd3b1SBarry Smith Input Parameters: 107053acd3b1SBarry Smith + opt - option name 107153acd3b1SBarry Smith . text - short string that describes the option 107253acd3b1SBarry Smith . man - manual page with additional information on option 10730fdccdaeSBarry Smith - currentvalue - the current value; caller is responsible for setting this value correctly. Normally this is done with either 107488aa4217SBarry Smith $ PetscOptionsScalar(..., obj->value,&obj->value,...) or 10750fdccdaeSBarry Smith $ value = defaultvalue 10760fdccdaeSBarry Smith $ PetscOptionsScalar(..., value,&value,&flg); 10770fdccdaeSBarry Smith $ if (flg) { 10780fdccdaeSBarry Smith 107953acd3b1SBarry Smith 108053acd3b1SBarry Smith Output Parameter: 108153acd3b1SBarry Smith + value - the value to return 108253acd3b1SBarry Smith - flg - PETSC_TRUE if found, else PETSC_FALSE 108353acd3b1SBarry Smith 108495452b02SPatrick Sanan Notes: 108595452b02SPatrick Sanan If the user does not supply the option at all value is NOT changed. Thus 10862efd9cb1SBarry Smith you should ALWAYS initialize value if you access it without first checking if the set flag is true. 10872efd9cb1SBarry Smith 1088989712b9SBarry Smith The default/currentvalue passed into this routine does not get transferred to the output value variable automatically. 1089989712b9SBarry Smith 109095452b02SPatrick Sanan Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 109153acd3b1SBarry Smith 10925a856986SBarry Smith Level: beginner 10935a856986SBarry Smith 109489a13869SBarry Smith .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 1095acfcf0e5SJed Brown PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 1096acfcf0e5SJed Brown PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 109753acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 109853acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1099acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1100a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 110188aa4217SBarry Smith M*/ 110288aa4217SBarry Smith 11034416b707SBarry Smith PetscErrorCode PetscOptionsScalar_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscScalar currentvalue,PetscScalar *value,PetscBool *set) 110453acd3b1SBarry Smith { 110553acd3b1SBarry Smith PetscErrorCode ierr; 110653acd3b1SBarry Smith 110753acd3b1SBarry Smith PetscFunctionBegin; 110853acd3b1SBarry Smith #if !defined(PETSC_USE_COMPLEX) 11090fdccdaeSBarry Smith ierr = PetscOptionsReal(opt,text,man,currentvalue,value,set);CHKERRQ(ierr); 111053acd3b1SBarry Smith #else 1111c5929fdfSBarry Smith ierr = PetscOptionsGetScalar(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,value,set);CHKERRQ(ierr); 111253acd3b1SBarry Smith #endif 111353acd3b1SBarry Smith PetscFunctionReturn(0); 111453acd3b1SBarry Smith } 111553acd3b1SBarry Smith 111688aa4217SBarry Smith /*MC 111790d69ab7SBarry Smith PetscOptionsName - Determines if a particular option has been set in the database. This returns true whether the option is a number, string or boolean, even 111890d69ab7SBarry Smith its value is set to false. 111953acd3b1SBarry Smith 11203f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 112153acd3b1SBarry Smith 112288aa4217SBarry Smith Synopsis: 112388aa4217SBarry Smith #include "petscsys.h" 112488aa4217SBarry Smith PetscErrorCode PetscOptionsName(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscBool *flg) 112588aa4217SBarry Smith 112653acd3b1SBarry Smith Input Parameters: 112753acd3b1SBarry Smith + opt - option name 112853acd3b1SBarry Smith . text - short string that describes the option 112953acd3b1SBarry Smith - man - manual page with additional information on option 113053acd3b1SBarry Smith 113153acd3b1SBarry Smith Output Parameter: 113253acd3b1SBarry Smith . flg - PETSC_TRUE if found, else PETSC_FALSE 113353acd3b1SBarry Smith 113453acd3b1SBarry Smith Level: beginner 113553acd3b1SBarry Smith 113695452b02SPatrick Sanan Notes: 113795452b02SPatrick Sanan Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 113853acd3b1SBarry Smith 113989a13869SBarry Smith .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 1140acfcf0e5SJed Brown PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 1141acfcf0e5SJed Brown PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 114253acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 114353acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1144acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1145a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 114688aa4217SBarry Smith M*/ 114788aa4217SBarry Smith 11484416b707SBarry Smith PetscErrorCode PetscOptionsName_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscBool *flg) 114953acd3b1SBarry Smith { 115053acd3b1SBarry Smith PetscErrorCode ierr; 11514416b707SBarry Smith PetscOptionItem amsopt; 115253acd3b1SBarry Smith 115353acd3b1SBarry Smith PetscFunctionBegin; 1154e55864a3SBarry Smith if (!PetscOptionsObject->count) { 11554416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_BOOL,&amsopt);CHKERRQ(ierr); 1156ace3abfcSBarry Smith ierr = PetscMalloc(sizeof(PetscBool),&amsopt->data);CHKERRQ(ierr); 1157a297a907SKarl Rupp 1158ace3abfcSBarry Smith *(PetscBool*)amsopt->data = PETSC_FALSE; 11591ae3d29cSBarry Smith } 1160c5929fdfSBarry Smith ierr = PetscOptionsHasName(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,flg);CHKERRQ(ierr); 1161e55864a3SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 1162e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s: %s (%s)\n",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",opt+1,text,ManSection(man));CHKERRQ(ierr); 116353acd3b1SBarry Smith } 116453acd3b1SBarry Smith PetscFunctionReturn(0); 116553acd3b1SBarry Smith } 116653acd3b1SBarry Smith 116788aa4217SBarry Smith /*MC 1168a264d7a6SBarry Smith PetscOptionsFList - Puts a list of option values that a single one may be selected from 116953acd3b1SBarry Smith 11703f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 117153acd3b1SBarry Smith 117288aa4217SBarry Smith Synopsis: 117388aa4217SBarry Smith #include "petscsys.h" 117488aa4217SBarry Smith PetscErrorCode PetscOptionsFList(PetscOptionItems *PetscOptionsObject,const char opt[],const char ltext[],const char man[],PetscFunctionList list,const char currentvalue[],char value[],size_t len,PetscBool *set) 117588aa4217SBarry Smith 117653acd3b1SBarry Smith Input Parameters: 117753acd3b1SBarry Smith + opt - option name 117853acd3b1SBarry Smith . text - short string that describes the option 117953acd3b1SBarry Smith . man - manual page with additional information on option 118053acd3b1SBarry Smith . list - the possible choices 11810fdccdaeSBarry Smith . currentvalue - the current value; caller is responsible for setting this value correctly. Normally this is done with 11820fdccdaeSBarry Smith $ PetscOptionsFlist(..., obj->value,value,len,&flg); 11830fdccdaeSBarry Smith $ if (flg) { 11843cc1e11dSBarry Smith - len - the length of the character array value 118553acd3b1SBarry Smith 118653acd3b1SBarry Smith Output Parameter: 118753acd3b1SBarry Smith + value - the value to return 118853acd3b1SBarry Smith - set - PETSC_TRUE if found, else PETSC_FALSE 118953acd3b1SBarry Smith 119053acd3b1SBarry Smith Level: intermediate 119153acd3b1SBarry Smith 119295452b02SPatrick Sanan Notes: 119395452b02SPatrick Sanan Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 119453acd3b1SBarry Smith 11952efd9cb1SBarry Smith If the user does not supply the option at all value is NOT changed. Thus 11962efd9cb1SBarry Smith you should ALWAYS initialize value if you access it without first checking if the set flag is true. 11972efd9cb1SBarry Smith 1198989712b9SBarry Smith The default/currentvalue passed into this routine does not get transferred to the output value variable automatically. 1199989712b9SBarry Smith 120053acd3b1SBarry Smith See PetscOptionsEList() for when the choices are given in a string array 120153acd3b1SBarry Smith 120253acd3b1SBarry Smith To get a listing of all currently specified options, 120388c29154SBarry Smith see PetscOptionsView() or PetscOptionsGetAll() 120453acd3b1SBarry Smith 1205eabe10d7SBarry Smith Developer Note: This cannot check for invalid selection because of things like MATAIJ that are not included in the list 1206eabe10d7SBarry Smith 120789a13869SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 1208acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 120953acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 121053acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1211acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1212a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList(), PetscOptionsEnum() 121388aa4217SBarry Smith M*/ 121488aa4217SBarry Smith 12154416b707SBarry Smith PetscErrorCode PetscOptionsFList_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char ltext[],const char man[],PetscFunctionList list,const char currentvalue[],char value[],size_t len,PetscBool *set) 121653acd3b1SBarry Smith { 121753acd3b1SBarry Smith PetscErrorCode ierr; 12184416b707SBarry Smith PetscOptionItem amsopt; 121944ef3d73SBarry Smith PetscBool lset; 122053acd3b1SBarry Smith 122153acd3b1SBarry Smith PetscFunctionBegin; 12221a1499c8SBarry Smith if (!PetscOptionsObject->count) { 12234416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,ltext,man,OPTION_FLIST,&amsopt);CHKERRQ(ierr); 122464facd6cSBarry Smith /* must use system malloc since SAWs may free this */ 12250fdccdaeSBarry Smith ierr = PetscStrdup(currentvalue ? currentvalue : "",(char**)&amsopt->data);CHKERRQ(ierr); 12263cc1e11dSBarry Smith amsopt->flist = list; 12273cc1e11dSBarry Smith } 122844ef3d73SBarry Smith ierr = PetscOptionsGetString(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,value,len,&lset);CHKERRQ(ierr); 122944ef3d73SBarry Smith if (set) *set = lset; 12301a1499c8SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 1231c3b366b1Sprj- ierr = PetscFunctionListPrintTypes(PetscOptionsObject->comm,stdout,PetscOptionsObject->prefix,opt,ltext,man,list,currentvalue,lset && value ? value : currentvalue);CHKERRQ(ierr); 123253acd3b1SBarry Smith } 123353acd3b1SBarry Smith PetscFunctionReturn(0); 123453acd3b1SBarry Smith } 123553acd3b1SBarry Smith 123688aa4217SBarry Smith /*MC 123753acd3b1SBarry Smith PetscOptionsEList - Puts a list of option values that a single one may be selected from 123853acd3b1SBarry Smith 12393f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 124053acd3b1SBarry Smith 124188aa4217SBarry Smith Synopsis: 124288aa4217SBarry Smith #include "petscsys.h" 124388aa4217SBarry Smith PetscErrorCode PetscOptionsEList(PetscOptionItems *PetscOptionsObject,const char opt[],const char ltext[],const char man[],const char *const *list,PetscInt ntext,const char currentvalue[],PetscInt *value,PetscBool *set) 124488aa4217SBarry Smith 124553acd3b1SBarry Smith Input Parameters: 124653acd3b1SBarry Smith + opt - option name 124753acd3b1SBarry Smith . ltext - short string that describes the option 124853acd3b1SBarry Smith . man - manual page with additional information on option 1249a264d7a6SBarry Smith . list - the possible choices (one of these must be selected, anything else is invalid) 125053acd3b1SBarry Smith . ntext - number of choices 12510fdccdaeSBarry Smith - currentvalue - the current value; caller is responsible for setting this value correctly. Normally this is done with 12520fdccdaeSBarry Smith $ PetscOptionsElist(..., obj->value,&value,&flg); 12530fdccdaeSBarry Smith $ if (flg) { 12540fdccdaeSBarry Smith 125553acd3b1SBarry Smith 125653acd3b1SBarry Smith Output Parameter: 125753acd3b1SBarry Smith + value - the index of the value to return 125853acd3b1SBarry Smith - set - PETSC_TRUE if found, else PETSC_FALSE 125953acd3b1SBarry Smith 126053acd3b1SBarry Smith Level: intermediate 126153acd3b1SBarry Smith 126295452b02SPatrick Sanan Notes: 126395452b02SPatrick Sanan Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 126453acd3b1SBarry Smith 12652efd9cb1SBarry Smith If the user does not supply the option at all value is NOT changed. Thus 12662efd9cb1SBarry Smith you should ALWAYS initialize value if you access it without first checking if the set flag is true. 12672efd9cb1SBarry Smith 1268a264d7a6SBarry Smith See PetscOptionsFList() for when the choices are given in a PetscFunctionList() 126953acd3b1SBarry Smith 127089a13869SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 1271acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 127253acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 127353acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1274acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1275a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEnum() 127688aa4217SBarry Smith M*/ 127788aa4217SBarry Smith 12784416b707SBarry Smith PetscErrorCode PetscOptionsEList_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char ltext[],const char man[],const char *const *list,PetscInt ntext,const char currentvalue[],PetscInt *value,PetscBool *set) 127953acd3b1SBarry Smith { 128053acd3b1SBarry Smith PetscErrorCode ierr; 128153acd3b1SBarry Smith PetscInt i; 12824416b707SBarry Smith PetscOptionItem amsopt; 128344ef3d73SBarry Smith PetscBool lset; 128453acd3b1SBarry Smith 128553acd3b1SBarry Smith PetscFunctionBegin; 12861a1499c8SBarry Smith if (!PetscOptionsObject->count) { 12874416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,ltext,man,OPTION_ELIST,&amsopt);CHKERRQ(ierr); 128864facd6cSBarry Smith /* must use system malloc since SAWs may free this */ 12890fdccdaeSBarry Smith ierr = PetscStrdup(currentvalue ? currentvalue : "",(char**)&amsopt->data);CHKERRQ(ierr); 12906991f827SBarry Smith ierr = PetscStrNArrayallocpy(ntext,list,(char***)&amsopt->list);CHKERRQ(ierr); 12911ae3d29cSBarry Smith amsopt->nlist = ntext; 12921ae3d29cSBarry Smith } 129344ef3d73SBarry Smith ierr = PetscOptionsGetEList(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,list,ntext,value,&lset);CHKERRQ(ierr); 129444ef3d73SBarry Smith if (set) *set = lset; 12951a1499c8SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 12960e4c290aSBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s <now %s : formerly %s> %s (choose one of)",PetscOptionsObject->prefix?PetscOptionsObject->prefix:"",opt+1,lset && value ? list[*value] : currentvalue,currentvalue,ltext);CHKERRQ(ierr); 129753acd3b1SBarry Smith for (i=0; i<ntext; i++) { 1298e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," %s",list[i]);CHKERRQ(ierr); 129953acd3b1SBarry Smith } 1300e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," (%s)\n",ManSection(man));CHKERRQ(ierr); 130153acd3b1SBarry Smith } 130253acd3b1SBarry Smith PetscFunctionReturn(0); 130353acd3b1SBarry Smith } 130453acd3b1SBarry Smith 130588aa4217SBarry Smith /*MC 1306acfcf0e5SJed Brown PetscOptionsBoolGroupBegin - First in a series of logical queries on the options database for 1307d5649816SBarry Smith which at most a single value can be true. 130853acd3b1SBarry Smith 13093f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 131053acd3b1SBarry Smith 131188aa4217SBarry Smith Synopsis: 131288aa4217SBarry Smith #include "petscsys.h" 131388aa4217SBarry Smith PetscErrorCode PetscOptionsBoolGroupBegin(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscBool *flg) 131488aa4217SBarry Smith 131553acd3b1SBarry Smith Input Parameters: 131653acd3b1SBarry Smith + opt - option name 131753acd3b1SBarry Smith . text - short string that describes the option 131853acd3b1SBarry Smith - man - manual page with additional information on option 131953acd3b1SBarry Smith 132053acd3b1SBarry Smith Output Parameter: 132153acd3b1SBarry Smith . flg - whether that option was set or not 132253acd3b1SBarry Smith 132353acd3b1SBarry Smith Level: intermediate 132453acd3b1SBarry Smith 132595452b02SPatrick Sanan Notes: 132695452b02SPatrick Sanan Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 132753acd3b1SBarry Smith 1328acfcf0e5SJed Brown Must be followed by 0 or more PetscOptionsBoolGroup()s and PetscOptionsBoolGroupEnd() 132953acd3b1SBarry Smith 133089a13869SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 1331acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 133253acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 133353acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1334acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1335a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 133688aa4217SBarry Smith M*/ 133788aa4217SBarry Smith 13384416b707SBarry Smith PetscErrorCode PetscOptionsBoolGroupBegin_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscBool *flg) 133953acd3b1SBarry Smith { 134053acd3b1SBarry Smith PetscErrorCode ierr; 13414416b707SBarry Smith PetscOptionItem amsopt; 134253acd3b1SBarry Smith 134353acd3b1SBarry Smith PetscFunctionBegin; 1344e55864a3SBarry Smith if (!PetscOptionsObject->count) { 13454416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_BOOL,&amsopt);CHKERRQ(ierr); 1346ace3abfcSBarry Smith ierr = PetscMalloc(sizeof(PetscBool),&amsopt->data);CHKERRQ(ierr); 1347a297a907SKarl Rupp 1348ace3abfcSBarry Smith *(PetscBool*)amsopt->data = PETSC_FALSE; 13491ae3d29cSBarry Smith } 135068b16fdaSBarry Smith *flg = PETSC_FALSE; 1351c5929fdfSBarry Smith ierr = PetscOptionsGetBool(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,flg,NULL);CHKERRQ(ierr); 1352e55864a3SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 1353e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," Pick at most one of -------------\n");CHKERRQ(ierr); 1354e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s: %s (%s)\n",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",opt+1,text,ManSection(man));CHKERRQ(ierr); 135553acd3b1SBarry Smith } 135653acd3b1SBarry Smith PetscFunctionReturn(0); 135753acd3b1SBarry Smith } 135853acd3b1SBarry Smith 135988aa4217SBarry Smith /*MC 1360acfcf0e5SJed Brown PetscOptionsBoolGroup - One in a series of logical queries on the options database for 1361d5649816SBarry Smith which at most a single value can be true. 136253acd3b1SBarry Smith 13633f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 136453acd3b1SBarry Smith 136588aa4217SBarry Smith Synopsis: 136688aa4217SBarry Smith #include "petscsys.h" 136788aa4217SBarry Smith PetscErrorCode PetscOptionsBoolGroup(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscBool *flg) 136888aa4217SBarry Smith 136953acd3b1SBarry Smith Input Parameters: 137053acd3b1SBarry Smith + opt - option name 137153acd3b1SBarry Smith . text - short string that describes the option 137253acd3b1SBarry Smith - man - manual page with additional information on option 137353acd3b1SBarry Smith 137453acd3b1SBarry Smith Output Parameter: 137553acd3b1SBarry Smith . flg - PETSC_TRUE if found, else PETSC_FALSE 137653acd3b1SBarry Smith 137753acd3b1SBarry Smith Level: intermediate 137853acd3b1SBarry Smith 137995452b02SPatrick Sanan Notes: 138095452b02SPatrick Sanan Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 138153acd3b1SBarry Smith 1382acfcf0e5SJed Brown Must follow a PetscOptionsBoolGroupBegin() and preceded a PetscOptionsBoolGroupEnd() 138353acd3b1SBarry Smith 138489a13869SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 1385acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 138653acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 138753acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1388acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1389a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 139088aa4217SBarry Smith M*/ 139188aa4217SBarry Smith 13924416b707SBarry Smith PetscErrorCode PetscOptionsBoolGroup_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscBool *flg) 139353acd3b1SBarry Smith { 139453acd3b1SBarry Smith PetscErrorCode ierr; 13954416b707SBarry Smith PetscOptionItem amsopt; 139653acd3b1SBarry Smith 139753acd3b1SBarry Smith PetscFunctionBegin; 1398e55864a3SBarry Smith if (!PetscOptionsObject->count) { 13994416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_BOOL,&amsopt);CHKERRQ(ierr); 1400ace3abfcSBarry Smith ierr = PetscMalloc(sizeof(PetscBool),&amsopt->data);CHKERRQ(ierr); 1401a297a907SKarl Rupp 1402ace3abfcSBarry Smith *(PetscBool*)amsopt->data = PETSC_FALSE; 14031ae3d29cSBarry Smith } 140417326d04SJed Brown *flg = PETSC_FALSE; 1405c5929fdfSBarry Smith ierr = PetscOptionsGetBool(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,flg,NULL);CHKERRQ(ierr); 1406e55864a3SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 1407e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s: %s (%s)\n",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",opt+1,text,ManSection(man));CHKERRQ(ierr); 140853acd3b1SBarry Smith } 140953acd3b1SBarry Smith PetscFunctionReturn(0); 141053acd3b1SBarry Smith } 141153acd3b1SBarry Smith 141288aa4217SBarry Smith /*MC 1413acfcf0e5SJed Brown PetscOptionsBoolGroupEnd - Last in a series of logical queries on the options database for 1414d5649816SBarry Smith which at most a single value can be true. 141553acd3b1SBarry Smith 14163f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 141753acd3b1SBarry Smith 141888aa4217SBarry Smith Synopsis: 141988aa4217SBarry Smith #include "petscsys.h" 142088aa4217SBarry Smith PetscErrorCode PetscOptionsBoolGroupEnd(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscBool *flg) 142188aa4217SBarry Smith 142253acd3b1SBarry Smith Input Parameters: 142353acd3b1SBarry Smith + opt - option name 142453acd3b1SBarry Smith . text - short string that describes the option 142553acd3b1SBarry Smith - man - manual page with additional information on option 142653acd3b1SBarry Smith 142753acd3b1SBarry Smith Output Parameter: 142853acd3b1SBarry Smith . flg - PETSC_TRUE if found, else PETSC_FALSE 142953acd3b1SBarry Smith 143053acd3b1SBarry Smith Level: intermediate 143153acd3b1SBarry Smith 143295452b02SPatrick Sanan Notes: 143395452b02SPatrick Sanan Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 143453acd3b1SBarry Smith 1435acfcf0e5SJed Brown Must follow a PetscOptionsBoolGroupBegin() 143653acd3b1SBarry Smith 143789a13869SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 1438acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 143953acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 144053acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1441acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1442a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 144388aa4217SBarry Smith M*/ 144488aa4217SBarry Smith 14454416b707SBarry Smith PetscErrorCode PetscOptionsBoolGroupEnd_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscBool *flg) 144653acd3b1SBarry Smith { 144753acd3b1SBarry Smith PetscErrorCode ierr; 14484416b707SBarry Smith PetscOptionItem amsopt; 144953acd3b1SBarry Smith 145053acd3b1SBarry Smith PetscFunctionBegin; 1451e55864a3SBarry Smith if (!PetscOptionsObject->count) { 14524416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_BOOL,&amsopt);CHKERRQ(ierr); 1453ace3abfcSBarry Smith ierr = PetscMalloc(sizeof(PetscBool),&amsopt->data);CHKERRQ(ierr); 1454a297a907SKarl Rupp 1455ace3abfcSBarry Smith *(PetscBool*)amsopt->data = PETSC_FALSE; 14561ae3d29cSBarry Smith } 145717326d04SJed Brown *flg = PETSC_FALSE; 1458c5929fdfSBarry Smith ierr = PetscOptionsGetBool(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,flg,NULL);CHKERRQ(ierr); 1459e55864a3SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 1460e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s: %s (%s)\n",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",opt+1,text,ManSection(man));CHKERRQ(ierr); 146153acd3b1SBarry Smith } 146253acd3b1SBarry Smith PetscFunctionReturn(0); 146353acd3b1SBarry Smith } 146453acd3b1SBarry Smith 146588aa4217SBarry Smith /*MC 1466acfcf0e5SJed Brown PetscOptionsBool - Determines if a particular option is in the database with a true or false 146753acd3b1SBarry Smith 14683f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 146953acd3b1SBarry Smith 147088aa4217SBarry Smith Synopsis: 147188aa4217SBarry Smith #include "petscsys.h" 147288aa4217SBarry Smith PetscErrorCode PetscOptionsBool(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscBool currentvalue,PetscBool *flg,PetscBool *set) 147388aa4217SBarry Smith 147453acd3b1SBarry Smith Input Parameters: 147553acd3b1SBarry Smith + opt - option name 147653acd3b1SBarry Smith . text - short string that describes the option 1477868c398cSBarry Smith . man - manual page with additional information on option 147894ae4db5SBarry Smith - currentvalue - the current value 147953acd3b1SBarry Smith 148053acd3b1SBarry Smith Output Parameter: 1481a2b725a8SWilliam Gropp + flg - PETSC_TRUE or PETSC_FALSE 1482a2b725a8SWilliam Gropp - set - PETSC_TRUE if found, else PETSC_FALSE 148353acd3b1SBarry Smith 14842efd9cb1SBarry Smith Notes: 14852efd9cb1SBarry Smith TRUE, true, YES, yes, nostring, and 1 all translate to PETSC_TRUE 14862efd9cb1SBarry Smith FALSE, false, NO, no, and 0 all translate to PETSC_FALSE 14872efd9cb1SBarry Smith 14882efd9cb1SBarry Smith If the option is given, but no value is provided, then flg and set are both given the value PETSC_TRUE. That is -requested_bool 14892efd9cb1SBarry Smith is equivalent to -requested_bool true 14902efd9cb1SBarry Smith 14912efd9cb1SBarry Smith If the user does not supply the option at all flg is NOT changed. Thus 14922efd9cb1SBarry Smith you should ALWAYS initialize the flg if you access it without first checking if the set flag is true. 14932efd9cb1SBarry Smith 149495452b02SPatrick Sanan Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 149553acd3b1SBarry Smith 14965a856986SBarry Smith Level: beginner 14975a856986SBarry Smith 149889a13869SBarry Smith .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 1499acfcf0e5SJed Brown PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 1500acfcf0e5SJed Brown PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 150153acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 150253acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1503acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1504a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 150588aa4217SBarry Smith M*/ 150688aa4217SBarry Smith 15074416b707SBarry Smith PetscErrorCode PetscOptionsBool_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscBool currentvalue,PetscBool *flg,PetscBool *set) 150853acd3b1SBarry Smith { 150953acd3b1SBarry Smith PetscErrorCode ierr; 1510ace3abfcSBarry Smith PetscBool iset; 15114416b707SBarry Smith PetscOptionItem amsopt; 151253acd3b1SBarry Smith 151353acd3b1SBarry Smith PetscFunctionBegin; 1514e55864a3SBarry Smith if (!PetscOptionsObject->count) { 15154416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_BOOL,&amsopt);CHKERRQ(ierr); 1516ace3abfcSBarry Smith ierr = PetscMalloc(sizeof(PetscBool),&amsopt->data);CHKERRQ(ierr); 1517a297a907SKarl Rupp 151894ae4db5SBarry Smith *(PetscBool*)amsopt->data = currentvalue; 1519af6d86caSBarry Smith } 1520c5929fdfSBarry Smith ierr = PetscOptionsGetBool(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,flg,&iset);CHKERRQ(ierr); 152153acd3b1SBarry Smith if (set) *set = iset; 15221a1499c8SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 152344ef3d73SBarry Smith const char *v = PetscBools[currentvalue], *vn = PetscBools[iset && flg ? *flg : currentvalue]; 152444ef3d73SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s: <%s : %s> %s (%s)\n",PetscOptionsObject->prefix?PetscOptionsObject->prefix:"",opt+1,v,vn,text,ManSection(man));CHKERRQ(ierr); 152553acd3b1SBarry Smith } 152653acd3b1SBarry Smith PetscFunctionReturn(0); 152753acd3b1SBarry Smith } 152853acd3b1SBarry Smith 152988aa4217SBarry Smith /*MC 153053acd3b1SBarry Smith PetscOptionsRealArray - Gets an array of double values for a particular 153153acd3b1SBarry Smith option in the database. The values must be separated with commas with 153253acd3b1SBarry Smith no intervening spaces. 153353acd3b1SBarry Smith 15343f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 153553acd3b1SBarry Smith 153688aa4217SBarry Smith Synopsis: 153788aa4217SBarry Smith #include "petscsys.h" 153888aa4217SBarry Smith PetscErrorCode PetscOptionsRealArray(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscReal value[],PetscInt *n,PetscBool *set) 153988aa4217SBarry Smith 154053acd3b1SBarry Smith Input Parameters: 154153acd3b1SBarry Smith + opt - the option one is seeking 154253acd3b1SBarry Smith . text - short string describing option 154353acd3b1SBarry Smith . man - manual page for option 154453acd3b1SBarry Smith - nmax - maximum number of values 154553acd3b1SBarry Smith 154653acd3b1SBarry Smith Output Parameter: 154753acd3b1SBarry Smith + value - location to copy values 154853acd3b1SBarry Smith . nmax - actual number of values found 154953acd3b1SBarry Smith - set - PETSC_TRUE if found, else PETSC_FALSE 155053acd3b1SBarry Smith 155153acd3b1SBarry Smith Level: beginner 155253acd3b1SBarry Smith 155353acd3b1SBarry Smith Notes: 155453acd3b1SBarry Smith The user should pass in an array of doubles 155553acd3b1SBarry Smith 155653acd3b1SBarry Smith Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 155753acd3b1SBarry Smith 155889a13869SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 1559acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 156053acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 156153acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1562acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1563a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 156488aa4217SBarry Smith M*/ 156588aa4217SBarry Smith 15664416b707SBarry Smith PetscErrorCode PetscOptionsRealArray_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscReal value[],PetscInt *n,PetscBool *set) 156753acd3b1SBarry Smith { 156853acd3b1SBarry Smith PetscErrorCode ierr; 156953acd3b1SBarry Smith PetscInt i; 15704416b707SBarry Smith PetscOptionItem amsopt; 157153acd3b1SBarry Smith 157253acd3b1SBarry Smith PetscFunctionBegin; 1573e55864a3SBarry Smith if (!PetscOptionsObject->count) { 1574e26ddf31SBarry Smith PetscReal *vals; 1575e26ddf31SBarry Smith 15764416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_REAL_ARRAY,&amsopt);CHKERRQ(ierr); 1577e55864a3SBarry Smith ierr = PetscMalloc((*n)*sizeof(PetscReal),&amsopt->data);CHKERRQ(ierr); 1578e26ddf31SBarry Smith vals = (PetscReal*)amsopt->data; 1579e26ddf31SBarry Smith for (i=0; i<*n; i++) vals[i] = value[i]; 1580e26ddf31SBarry Smith amsopt->arraylength = *n; 1581e26ddf31SBarry Smith } 1582c5929fdfSBarry Smith ierr = PetscOptionsGetRealArray(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,value,n,set);CHKERRQ(ierr); 1583e55864a3SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 1584a519f713SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s <%g",PetscOptionsObject->prefix?PetscOptionsObject->prefix:"",opt+1,(double)value[0]);CHKERRQ(ierr); 158553acd3b1SBarry Smith for (i=1; i<*n; i++) { 1586e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm,",%g",(double)value[i]);CHKERRQ(ierr); 158753acd3b1SBarry Smith } 1588e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm,">: %s (%s)\n",text,ManSection(man));CHKERRQ(ierr); 158953acd3b1SBarry Smith } 159053acd3b1SBarry Smith PetscFunctionReturn(0); 159153acd3b1SBarry Smith } 159253acd3b1SBarry Smith 159388aa4217SBarry Smith /*MC 1594050cccc3SHong Zhang PetscOptionsScalarArray - Gets an array of Scalar values for a particular 1595050cccc3SHong Zhang option in the database. The values must be separated with commas with 1596050cccc3SHong Zhang no intervening spaces. 1597050cccc3SHong Zhang 1598050cccc3SHong Zhang Logically Collective on the communicator passed in PetscOptionsBegin() 1599050cccc3SHong Zhang 160088aa4217SBarry Smith Synopsis: 160188aa4217SBarry Smith #include "petscsys.h" 160288aa4217SBarry Smith PetscErrorCode PetscOptionsScalarArray(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscScalar value[],PetscInt *n,PetscBool *set) 160388aa4217SBarry Smith 1604050cccc3SHong Zhang Input Parameters: 1605050cccc3SHong Zhang + opt - the option one is seeking 1606050cccc3SHong Zhang . text - short string describing option 1607050cccc3SHong Zhang . man - manual page for option 1608050cccc3SHong Zhang - nmax - maximum number of values 1609050cccc3SHong Zhang 1610050cccc3SHong Zhang Output Parameter: 1611050cccc3SHong Zhang + value - location to copy values 1612050cccc3SHong Zhang . nmax - actual number of values found 1613050cccc3SHong Zhang - set - PETSC_TRUE if found, else PETSC_FALSE 1614050cccc3SHong Zhang 1615050cccc3SHong Zhang Level: beginner 1616050cccc3SHong Zhang 1617050cccc3SHong Zhang Notes: 1618050cccc3SHong Zhang The user should pass in an array of doubles 1619050cccc3SHong Zhang 1620050cccc3SHong Zhang Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 1621050cccc3SHong Zhang 162289a13869SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 1623050cccc3SHong Zhang PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 1624050cccc3SHong Zhang PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 1625050cccc3SHong Zhang PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1626050cccc3SHong Zhang PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1627050cccc3SHong Zhang PetscOptionsFList(), PetscOptionsEList() 162888aa4217SBarry Smith M*/ 162988aa4217SBarry Smith 16304416b707SBarry Smith PetscErrorCode PetscOptionsScalarArray_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscScalar value[],PetscInt *n,PetscBool *set) 1631050cccc3SHong Zhang { 1632050cccc3SHong Zhang PetscErrorCode ierr; 1633050cccc3SHong Zhang PetscInt i; 16344416b707SBarry Smith PetscOptionItem amsopt; 1635050cccc3SHong Zhang 1636050cccc3SHong Zhang PetscFunctionBegin; 1637050cccc3SHong Zhang if (!PetscOptionsObject->count) { 1638050cccc3SHong Zhang PetscScalar *vals; 1639050cccc3SHong Zhang 16404416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_SCALAR_ARRAY,&amsopt);CHKERRQ(ierr); 1641050cccc3SHong Zhang ierr = PetscMalloc((*n)*sizeof(PetscScalar),&amsopt->data);CHKERRQ(ierr); 1642050cccc3SHong Zhang vals = (PetscScalar*)amsopt->data; 1643050cccc3SHong Zhang for (i=0; i<*n; i++) vals[i] = value[i]; 1644050cccc3SHong Zhang amsopt->arraylength = *n; 1645050cccc3SHong Zhang } 1646c5929fdfSBarry Smith ierr = PetscOptionsGetScalarArray(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,value,n,set);CHKERRQ(ierr); 1647050cccc3SHong Zhang if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 164895f3a755SJose E. Roman ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s <%g+%gi",PetscOptionsObject->prefix?PetscOptionsObject->prefix:"",opt+1,(double)PetscRealPart(value[0]),(double)PetscImaginaryPart(value[0]));CHKERRQ(ierr); 1649050cccc3SHong Zhang for (i=1; i<*n; i++) { 165095f3a755SJose E. Roman ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm,",%g+%gi",(double)PetscRealPart(value[i]),(double)PetscImaginaryPart(value[i]));CHKERRQ(ierr); 1651050cccc3SHong Zhang } 1652050cccc3SHong Zhang ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm,">: %s (%s)\n",text,ManSection(man));CHKERRQ(ierr); 1653050cccc3SHong Zhang } 1654050cccc3SHong Zhang PetscFunctionReturn(0); 1655050cccc3SHong Zhang } 165653acd3b1SBarry Smith 165788aa4217SBarry Smith /*MC 165853acd3b1SBarry Smith PetscOptionsIntArray - Gets an array of integers for a particular 1659b32a342fSShri Abhyankar option in the database. 166053acd3b1SBarry Smith 16613f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 166253acd3b1SBarry Smith 166388aa4217SBarry Smith Synopsis: 166488aa4217SBarry Smith #include "petscsys.h" 166588aa4217SBarry Smith PetscErrorCode PetscOptionsIntArray(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscInt value[],PetscInt *n,PetscBool *set) 166688aa4217SBarry Smith 166753acd3b1SBarry Smith Input Parameters: 166853acd3b1SBarry Smith + opt - the option one is seeking 166953acd3b1SBarry Smith . text - short string describing option 167053acd3b1SBarry Smith . man - manual page for option 1671f8a50e2bSBarry Smith - n - maximum number of values 167253acd3b1SBarry Smith 167353acd3b1SBarry Smith Output Parameter: 167453acd3b1SBarry Smith + value - location to copy values 1675f8a50e2bSBarry Smith . n - actual number of values found 167653acd3b1SBarry Smith - set - PETSC_TRUE if found, else PETSC_FALSE 167753acd3b1SBarry Smith 167853acd3b1SBarry Smith Level: beginner 167953acd3b1SBarry Smith 168053acd3b1SBarry Smith Notes: 1681b32a342fSShri Abhyankar The array can be passed as 1682bebe2cf6SSatish Balay a comma separated list: 0,1,2,3,4,5,6,7 16830fd488f5SShri Abhyankar a range (start-end+1): 0-8 16840fd488f5SShri Abhyankar a range with given increment (start-end+1:inc): 0-7:2 1685bebe2cf6SSatish Balay a combination of values and ranges separated by commas: 0,1-8,8-15:2 1686b32a342fSShri Abhyankar 1687b32a342fSShri Abhyankar There must be no intervening spaces between the values. 168853acd3b1SBarry Smith 168953acd3b1SBarry Smith Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 169053acd3b1SBarry Smith 169189a13869SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 1692acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 169353acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 169453acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1695acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1696a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList(), PetscOptionsRealArray() 169788aa4217SBarry Smith M*/ 169888aa4217SBarry Smith 16994416b707SBarry Smith PetscErrorCode PetscOptionsIntArray_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscInt value[],PetscInt *n,PetscBool *set) 170053acd3b1SBarry Smith { 170153acd3b1SBarry Smith PetscErrorCode ierr; 170253acd3b1SBarry Smith PetscInt i; 17034416b707SBarry Smith PetscOptionItem amsopt; 170453acd3b1SBarry Smith 170553acd3b1SBarry Smith PetscFunctionBegin; 1706e55864a3SBarry Smith if (!PetscOptionsObject->count) { 1707e26ddf31SBarry Smith PetscInt *vals; 1708e26ddf31SBarry Smith 17094416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_INT_ARRAY,&amsopt);CHKERRQ(ierr); 1710854ce69bSBarry Smith ierr = PetscMalloc1(*n,(PetscInt**)&amsopt->data);CHKERRQ(ierr); 1711e26ddf31SBarry Smith vals = (PetscInt*)amsopt->data; 1712e26ddf31SBarry Smith for (i=0; i<*n; i++) vals[i] = value[i]; 1713e26ddf31SBarry Smith amsopt->arraylength = *n; 1714e26ddf31SBarry Smith } 1715c5929fdfSBarry Smith ierr = PetscOptionsGetIntArray(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,value,n,set);CHKERRQ(ierr); 1716e55864a3SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 1717e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s <%d",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",opt+1,value[0]);CHKERRQ(ierr); 171853acd3b1SBarry Smith for (i=1; i<*n; i++) { 1719e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm,",%d",value[i]);CHKERRQ(ierr); 172053acd3b1SBarry Smith } 1721e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm,">: %s (%s)\n",text,ManSection(man));CHKERRQ(ierr); 172253acd3b1SBarry Smith } 172353acd3b1SBarry Smith PetscFunctionReturn(0); 172453acd3b1SBarry Smith } 172553acd3b1SBarry Smith 172688aa4217SBarry Smith /*MC 172753acd3b1SBarry Smith PetscOptionsStringArray - Gets an array of string values for a particular 172853acd3b1SBarry Smith option in the database. The values must be separated with commas with 172953acd3b1SBarry Smith no intervening spaces. 173053acd3b1SBarry Smith 17313f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 173253acd3b1SBarry Smith 173388aa4217SBarry Smith Synopsis: 173488aa4217SBarry Smith #include "petscsys.h" 173588aa4217SBarry Smith PetscErrorCode PetscOptionsStringArray(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],char *value[],PetscInt *nmax,PetscBool *set) 173688aa4217SBarry Smith 173753acd3b1SBarry Smith Input Parameters: 173853acd3b1SBarry Smith + opt - the option one is seeking 173953acd3b1SBarry Smith . text - short string describing option 174053acd3b1SBarry Smith . man - manual page for option 174153acd3b1SBarry Smith - nmax - maximum number of strings 174253acd3b1SBarry Smith 174353acd3b1SBarry Smith Output Parameter: 174453acd3b1SBarry Smith + value - location to copy strings 174553acd3b1SBarry Smith . nmax - actual number of strings found 174653acd3b1SBarry Smith - set - PETSC_TRUE if found, else PETSC_FALSE 174753acd3b1SBarry Smith 174853acd3b1SBarry Smith Level: beginner 174953acd3b1SBarry Smith 175053acd3b1SBarry Smith Notes: 175153acd3b1SBarry Smith The user should pass in an array of pointers to char, to hold all the 175253acd3b1SBarry Smith strings returned by this function. 175353acd3b1SBarry Smith 175453acd3b1SBarry Smith The user is responsible for deallocating the strings that are 175553acd3b1SBarry Smith returned. The Fortran interface for this routine is not supported. 175653acd3b1SBarry Smith 175753acd3b1SBarry Smith Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 175853acd3b1SBarry Smith 175989a13869SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 1760acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 176153acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 176253acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1763acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1764a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 176588aa4217SBarry Smith M*/ 176688aa4217SBarry Smith 17674416b707SBarry Smith PetscErrorCode PetscOptionsStringArray_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],char *value[],PetscInt *nmax,PetscBool *set) 176853acd3b1SBarry Smith { 176953acd3b1SBarry Smith PetscErrorCode ierr; 17704416b707SBarry Smith PetscOptionItem amsopt; 177153acd3b1SBarry Smith 177253acd3b1SBarry Smith PetscFunctionBegin; 1773e55864a3SBarry Smith if (!PetscOptionsObject->count) { 17744416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_STRING_ARRAY,&amsopt);CHKERRQ(ierr); 1775854ce69bSBarry Smith ierr = PetscMalloc1(*nmax,(char**)&amsopt->data);CHKERRQ(ierr); 1776a297a907SKarl Rupp 17771ae3d29cSBarry Smith amsopt->arraylength = *nmax; 17781ae3d29cSBarry Smith } 1779c5929fdfSBarry Smith ierr = PetscOptionsGetStringArray(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,value,nmax,set);CHKERRQ(ierr); 1780e55864a3SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 1781e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s <string1,string2,...>: %s (%s)\n",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",opt+1,text,ManSection(man));CHKERRQ(ierr); 178253acd3b1SBarry Smith } 178353acd3b1SBarry Smith PetscFunctionReturn(0); 178453acd3b1SBarry Smith } 178553acd3b1SBarry Smith 178688aa4217SBarry Smith /*MC 1787acfcf0e5SJed Brown PetscOptionsBoolArray - Gets an array of logical values (true or false) for a particular 1788e2446a98SMatthew Knepley option in the database. The values must be separated with commas with 1789e2446a98SMatthew Knepley no intervening spaces. 1790e2446a98SMatthew Knepley 17913f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 1792e2446a98SMatthew Knepley 179388aa4217SBarry Smith Synopsis: 179488aa4217SBarry Smith #include "petscsys.h" 179588aa4217SBarry Smith PetscErrorCode PetscOptionsBoolArray(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscBool value[],PetscInt *n,PetscBool *set) 179688aa4217SBarry Smith 1797e2446a98SMatthew Knepley Input Parameters: 1798e2446a98SMatthew Knepley + opt - the option one is seeking 1799e2446a98SMatthew Knepley . text - short string describing option 1800e2446a98SMatthew Knepley . man - manual page for option 1801e2446a98SMatthew Knepley - nmax - maximum number of values 1802e2446a98SMatthew Knepley 1803e2446a98SMatthew Knepley Output Parameter: 1804e2446a98SMatthew Knepley + value - location to copy values 1805e2446a98SMatthew Knepley . nmax - actual number of values found 1806e2446a98SMatthew Knepley - set - PETSC_TRUE if found, else PETSC_FALSE 1807e2446a98SMatthew Knepley 1808e2446a98SMatthew Knepley Level: beginner 1809e2446a98SMatthew Knepley 1810e2446a98SMatthew Knepley Notes: 1811e2446a98SMatthew Knepley The user should pass in an array of doubles 1812e2446a98SMatthew Knepley 1813e2446a98SMatthew Knepley Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 1814e2446a98SMatthew Knepley 181589a13869SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 1816acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 1817e2446a98SMatthew Knepley PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 1818e2446a98SMatthew Knepley PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1819acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1820a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 182188aa4217SBarry Smith M*/ 182288aa4217SBarry Smith 18234416b707SBarry Smith PetscErrorCode PetscOptionsBoolArray_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscBool value[],PetscInt *n,PetscBool *set) 1824e2446a98SMatthew Knepley { 1825e2446a98SMatthew Knepley PetscErrorCode ierr; 1826e2446a98SMatthew Knepley PetscInt i; 18274416b707SBarry Smith PetscOptionItem amsopt; 1828e2446a98SMatthew Knepley 1829e2446a98SMatthew Knepley PetscFunctionBegin; 1830e55864a3SBarry Smith if (!PetscOptionsObject->count) { 1831ace3abfcSBarry Smith PetscBool *vals; 18321ae3d29cSBarry Smith 18334416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_BOOL_ARRAY,&amsopt);CHKERRQ(ierr); 18341a1499c8SBarry Smith ierr = PetscMalloc1(*n,(PetscBool**)&amsopt->data);CHKERRQ(ierr); 1835ace3abfcSBarry Smith vals = (PetscBool*)amsopt->data; 18361ae3d29cSBarry Smith for (i=0; i<*n; i++) vals[i] = value[i]; 18371ae3d29cSBarry Smith amsopt->arraylength = *n; 18381ae3d29cSBarry Smith } 1839c5929fdfSBarry Smith ierr = PetscOptionsGetBoolArray(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,value,n,set);CHKERRQ(ierr); 1840e55864a3SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 1841e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s <%d",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",opt+1,value[0]);CHKERRQ(ierr); 1842e2446a98SMatthew Knepley for (i=1; i<*n; i++) { 1843e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm,",%d",value[i]);CHKERRQ(ierr); 1844e2446a98SMatthew Knepley } 1845e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm,">: %s (%s)\n",text,ManSection(man));CHKERRQ(ierr); 1846e2446a98SMatthew Knepley } 1847e2446a98SMatthew Knepley PetscFunctionReturn(0); 1848e2446a98SMatthew Knepley } 1849e2446a98SMatthew Knepley 185088aa4217SBarry Smith /*MC 1851d1da0b69SBarry Smith PetscOptionsViewer - Gets a viewer appropriate for the type indicated by the user 18528cc676e6SMatthew G Knepley 18538cc676e6SMatthew G Knepley Logically Collective on the communicator passed in PetscOptionsBegin() 18548cc676e6SMatthew G Knepley 185588aa4217SBarry Smith Synopsis: 185688aa4217SBarry Smith #include "petscsys.h" 185788aa4217SBarry Smith PetscErrorCode PetscOptionsViewer(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscViewer *viewer,PetscViewerFormat *format,PetscBool *set) 185888aa4217SBarry Smith 18598cc676e6SMatthew G Knepley Input Parameters: 18608cc676e6SMatthew G Knepley + opt - option name 18618cc676e6SMatthew G Knepley . text - short string that describes the option 18628cc676e6SMatthew G Knepley - man - manual page with additional information on option 18638cc676e6SMatthew G Knepley 18648cc676e6SMatthew G Knepley Output Parameter: 18658cc676e6SMatthew G Knepley + viewer - the viewer 18668cc676e6SMatthew G Knepley - set - PETSC_TRUE if found, else PETSC_FALSE 18678cc676e6SMatthew G Knepley 18688cc676e6SMatthew G Knepley Level: beginner 18698cc676e6SMatthew G Knepley 187095452b02SPatrick Sanan Notes: 187195452b02SPatrick Sanan Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 18728cc676e6SMatthew G Knepley 18735a7113b9SPatrick Sanan See PetscOptionsGetViewer() for the format of the supplied viewer and its options 18748cc676e6SMatthew G Knepley 187589a13869SBarry Smith .seealso: PetscOptionsGetViewer(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 18768cc676e6SMatthew G Knepley PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 18778cc676e6SMatthew G Knepley PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 18788cc676e6SMatthew G Knepley PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 18798cc676e6SMatthew G Knepley PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 18808cc676e6SMatthew G Knepley PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1881a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 188288aa4217SBarry Smith M*/ 188388aa4217SBarry Smith 18844416b707SBarry Smith PetscErrorCode PetscOptionsViewer_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscViewer *viewer,PetscViewerFormat *format,PetscBool *set) 18858cc676e6SMatthew G Knepley { 18868cc676e6SMatthew G Knepley PetscErrorCode ierr; 18874416b707SBarry Smith PetscOptionItem amsopt; 18888cc676e6SMatthew G Knepley 18898cc676e6SMatthew G Knepley PetscFunctionBegin; 18901a1499c8SBarry Smith if (!PetscOptionsObject->count) { 18914416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_STRING,&amsopt);CHKERRQ(ierr); 189264facd6cSBarry Smith /* must use system malloc since SAWs may free this */ 18935b02f95dSBarry Smith ierr = PetscStrdup("",(char**)&amsopt->data);CHKERRQ(ierr); 18948cc676e6SMatthew G Knepley } 189516413a6aSBarry Smith ierr = PetscOptionsGetViewer(PetscOptionsObject->comm,PetscOptionsObject->options,PetscOptionsObject->prefix,opt,viewer,format,set);CHKERRQ(ierr); 1896e55864a3SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 1897e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s <%s>: %s (%s)\n",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",opt+1,"",text,ManSection(man));CHKERRQ(ierr); 18988cc676e6SMatthew G Knepley } 18998cc676e6SMatthew G Knepley PetscFunctionReturn(0); 19008cc676e6SMatthew G Knepley } 19018cc676e6SMatthew G Knepley 190253acd3b1SBarry Smith /*@C 1903b52f573bSBarry Smith PetscOptionsHead - Puts a heading before listing any more published options. Used, for example, 190453acd3b1SBarry Smith in KSPSetFromOptions_GMRES(). 190553acd3b1SBarry Smith 19063f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 190753acd3b1SBarry Smith 190853acd3b1SBarry Smith Input Parameter: 190953acd3b1SBarry Smith . head - the heading text 191053acd3b1SBarry Smith 191153acd3b1SBarry Smith 191253acd3b1SBarry Smith Level: intermediate 191353acd3b1SBarry Smith 191495452b02SPatrick Sanan Notes: 191595452b02SPatrick Sanan Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 191653acd3b1SBarry Smith 1917b52f573bSBarry Smith Can be followed by a call to PetscOptionsTail() in the same function. 191853acd3b1SBarry Smith 191989a13869SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 1920acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 192153acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 192253acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1923acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1924a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 192553acd3b1SBarry Smith @*/ 19264416b707SBarry Smith PetscErrorCode PetscOptionsHead(PetscOptionItems *PetscOptionsObject,const char head[]) 192753acd3b1SBarry Smith { 192853acd3b1SBarry Smith PetscErrorCode ierr; 192953acd3b1SBarry Smith 193053acd3b1SBarry Smith PetscFunctionBegin; 1931e55864a3SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 1932e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," %s\n",head);CHKERRQ(ierr); 193353acd3b1SBarry Smith } 193453acd3b1SBarry Smith PetscFunctionReturn(0); 193553acd3b1SBarry Smith } 193653acd3b1SBarry Smith 193753acd3b1SBarry Smith 193853acd3b1SBarry Smith 193953acd3b1SBarry Smith 194053acd3b1SBarry Smith 194153acd3b1SBarry Smith 1942