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 } 36e55864a3SBarry Smith PetscOptionsObject->next = 0; 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); 9053acd3b1SBarry Smith (*amsopt)->next = 0; 9153acd3b1SBarry Smith (*amsopt)->set = PETSC_FALSE; 926356e834SBarry Smith (*amsopt)->type = t; 9353acd3b1SBarry Smith (*amsopt)->data = 0; 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 1113fc1eb6aSBarry Smith Collective on MPI_Comm 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; 1525b02f95dSBarry Smith char *tmp = 0; 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: 345e55864a3SBarry Smith ierr = PetscFunctionListPrintTypes(PETSC_COMM_WORLD,stdout,PetscOptionsObject->prefix,next->option,next->text,next->man,next->flist,(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" 374*a8d69d7bSBarry Smith "<script type=\"text/javascript\" src=\"https://www.mcs.anl.gov/research/projects/saws/js/jquery-1.9.1.js\"></script>\n" 375*a8d69d7bSBarry 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); 637e55864a3SBarry Smith PetscOptionsObject->next = 0; 63853acd3b1SBarry Smith PetscFunctionReturn(0); 63953acd3b1SBarry Smith } 64053acd3b1SBarry Smith 64153acd3b1SBarry Smith /*@C 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 64653acd3b1SBarry Smith Input Parameters: 64753acd3b1SBarry Smith + opt - option name 64853acd3b1SBarry Smith . text - short string that describes the option 64953acd3b1SBarry Smith . man - manual page with additional information on option 65053acd3b1SBarry Smith . list - array containing the list of choices, followed by the enum name, followed by the enum prefix, followed by a null 6510fdccdaeSBarry Smith - currentvalue - the current value; caller is responsible for setting this value correctly. Normally this is done with either 6520fdccdaeSBarry Smith $ PetscOptionsEnum(..., obj->value,&object->value,...) or 6530fdccdaeSBarry Smith $ value = defaultvalue 6540fdccdaeSBarry Smith $ PetscOptionsEnum(..., value,&value,&flg); 6550fdccdaeSBarry Smith $ if (flg) { 65653acd3b1SBarry Smith 65753acd3b1SBarry Smith Output Parameter: 65853acd3b1SBarry Smith + value - the value to return 659b32e0204SMatthew G Knepley - set - PETSC_TRUE if found, else PETSC_FALSE 66053acd3b1SBarry Smith 66153acd3b1SBarry Smith Level: beginner 66253acd3b1SBarry Smith 66353acd3b1SBarry Smith Concepts: options database 66453acd3b1SBarry Smith 66595452b02SPatrick Sanan Notes: 66695452b02SPatrick Sanan Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 66753acd3b1SBarry Smith 66853acd3b1SBarry Smith list is usually something like PCASMTypes or some other predefined list of enum names 66953acd3b1SBarry Smith 6702efd9cb1SBarry Smith If the user does not supply the option at all value is NOT changed. Thus 6712efd9cb1SBarry Smith you should ALWAYS initialize value if you access it without first checking if the set flag is true. 6722efd9cb1SBarry Smith 673989712b9SBarry Smith The default/currentvalue passed into this routine does not get transferred to the output value variable automatically. 674989712b9SBarry Smith 67553acd3b1SBarry Smith .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 676acfcf0e5SJed Brown PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 677acfcf0e5SJed Brown PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 67853acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 67953acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 680acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 681a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 68253acd3b1SBarry Smith @*/ 6834416b707SBarry 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) 68453acd3b1SBarry Smith { 68553acd3b1SBarry Smith PetscErrorCode ierr; 68653acd3b1SBarry Smith PetscInt ntext = 0; 687aa5bb8c0SSatish Balay PetscInt tval; 688ace3abfcSBarry Smith PetscBool tflg; 68953acd3b1SBarry Smith 69053acd3b1SBarry Smith PetscFunctionBegin; 69153acd3b1SBarry Smith while (list[ntext++]) { 692e32f2f54SBarry Smith if (ntext > 50) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"List argument appears to be wrong or have more than 50 entries"); 69353acd3b1SBarry Smith } 694e32f2f54SBarry Smith if (ntext < 3) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"List argument must have at least two entries: typename and type prefix"); 69553acd3b1SBarry Smith ntext -= 3; 696e55864a3SBarry Smith ierr = PetscOptionsEList_Private(PetscOptionsObject,opt,text,man,list,ntext,list[currentvalue],&tval,&tflg);CHKERRQ(ierr); 697aa5bb8c0SSatish Balay /* with PETSC_USE_64BIT_INDICES sizeof(PetscInt) != sizeof(PetscEnum) */ 698aa5bb8c0SSatish Balay if (tflg) *value = (PetscEnum)tval; 699aa5bb8c0SSatish Balay if (set) *set = tflg; 70053acd3b1SBarry Smith PetscFunctionReturn(0); 70153acd3b1SBarry Smith } 70253acd3b1SBarry Smith 703d3e47460SLisandro Dalcin /*@C 704d3e47460SLisandro Dalcin PetscOptionsEnumArray - Gets an array of enum values for a particular 705d3e47460SLisandro Dalcin option in the database. 706d3e47460SLisandro Dalcin 707d3e47460SLisandro Dalcin Logically Collective on the communicator passed in PetscOptionsBegin() 708d3e47460SLisandro Dalcin 709d3e47460SLisandro Dalcin Input Parameters: 710d3e47460SLisandro Dalcin + opt - the option one is seeking 711d3e47460SLisandro Dalcin . text - short string describing option 712d3e47460SLisandro Dalcin . man - manual page for option 71322d58ec6SMatthew G. Knepley . list - array containing the list of choices, followed by the enum name, followed by the enum prefix, followed by a null 714d3e47460SLisandro Dalcin - n - maximum number of values 715d3e47460SLisandro Dalcin 716d3e47460SLisandro Dalcin Output Parameter: 717d3e47460SLisandro Dalcin + value - location to copy values 718d3e47460SLisandro Dalcin . n - actual number of values found 719d3e47460SLisandro Dalcin - set - PETSC_TRUE if found, else PETSC_FALSE 720d3e47460SLisandro Dalcin 721d3e47460SLisandro Dalcin Level: beginner 722d3e47460SLisandro Dalcin 723d3e47460SLisandro Dalcin Notes: 724d3e47460SLisandro Dalcin The array must be passed as a comma separated list. 725d3e47460SLisandro Dalcin 726d3e47460SLisandro Dalcin There must be no intervening spaces between the values. 727d3e47460SLisandro Dalcin 728d3e47460SLisandro Dalcin Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 729d3e47460SLisandro Dalcin 730d3e47460SLisandro Dalcin Concepts: options database^array of enums 731d3e47460SLisandro Dalcin 732d3e47460SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 733d3e47460SLisandro Dalcin PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 734d3e47460SLisandro Dalcin PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 735d3e47460SLisandro Dalcin PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 736d3e47460SLisandro Dalcin PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 737d3e47460SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList(), PetscOptionsRealArray() 738d3e47460SLisandro Dalcin @*/ 7394416b707SBarry 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) 740d3e47460SLisandro Dalcin { 741d3e47460SLisandro Dalcin PetscInt i,nlist = 0; 7424416b707SBarry Smith PetscOptionItem amsopt; 743d3e47460SLisandro Dalcin PetscErrorCode ierr; 744d3e47460SLisandro Dalcin 745d3e47460SLisandro Dalcin PetscFunctionBegin; 746d3e47460SLisandro 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"); 747d3e47460SLisandro Dalcin if (nlist < 3) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"List argument must have at least two entries: typename and type prefix"); 748d3e47460SLisandro Dalcin nlist -= 3; /* drop enum name, prefix, and null termination */ 749d3e47460SLisandro Dalcin if (0 && !PetscOptionsObject->count) { /* XXX Requires additional support */ 750d3e47460SLisandro Dalcin PetscEnum *vals; 7514416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_INT_ARRAY/*XXX OPTION_ENUM_ARRAY*/,&amsopt);CHKERRQ(ierr); 752d3e47460SLisandro Dalcin ierr = PetscStrNArrayallocpy(nlist,list,(char***)&amsopt->list);CHKERRQ(ierr); 753d3e47460SLisandro Dalcin amsopt->nlist = nlist; 754d3e47460SLisandro Dalcin ierr = PetscMalloc1(*n,(PetscEnum**)&amsopt->data);CHKERRQ(ierr); 755d3e47460SLisandro Dalcin amsopt->arraylength = *n; 756d3e47460SLisandro Dalcin vals = (PetscEnum*)amsopt->data; 757d3e47460SLisandro Dalcin for (i=0; i<*n; i++) vals[i] = value[i]; 758d3e47460SLisandro Dalcin } 759c5929fdfSBarry Smith ierr = PetscOptionsGetEnumArray(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,list,value,n,set);CHKERRQ(ierr); 760d3e47460SLisandro Dalcin if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 761d3e47460SLisandro Dalcin ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s <%s",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",opt+1,list[value[0]]);CHKERRQ(ierr); 762d3e47460SLisandro Dalcin for (i=1; i<*n; i++) {ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm,",%s",list[value[i]]);CHKERRQ(ierr);} 763d3e47460SLisandro Dalcin ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm,">: %s (choose from)",text);CHKERRQ(ierr); 764d3e47460SLisandro Dalcin for (i=0; i<nlist; i++) {ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," %s",list[i]);CHKERRQ(ierr);} 765d3e47460SLisandro Dalcin ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," (%s)\n",ManSection(man));CHKERRQ(ierr); 766d3e47460SLisandro Dalcin } 767d3e47460SLisandro Dalcin PetscFunctionReturn(0); 768d3e47460SLisandro Dalcin } 769d3e47460SLisandro Dalcin 77053acd3b1SBarry Smith /* -------------------------------------------------------------------------------------------------------------*/ 77153acd3b1SBarry Smith /*@C 77253acd3b1SBarry Smith PetscOptionsInt - Gets the integer value for a particular option in the database. 77353acd3b1SBarry Smith 7743f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 77553acd3b1SBarry Smith 77653acd3b1SBarry Smith Input Parameters: 77753acd3b1SBarry Smith + opt - option name 77853acd3b1SBarry Smith . text - short string that describes the option 77953acd3b1SBarry Smith . man - manual page with additional information on option 7800fdccdaeSBarry Smith - currentvalue - the current value; caller is responsible for setting this value correctly. Normally this is done with either 7810fdccdaeSBarry Smith $ PetscOptionsInt(..., obj->value,&object->value,...) or 7820fdccdaeSBarry Smith $ value = defaultvalue 7830fdccdaeSBarry Smith $ PetscOptionsInt(..., value,&value,&flg); 7840fdccdaeSBarry Smith $ if (flg) { 78553acd3b1SBarry Smith 78653acd3b1SBarry Smith Output Parameter: 78753acd3b1SBarry Smith + value - the integer value to return 78853acd3b1SBarry Smith - flg - PETSC_TRUE if found, else PETSC_FALSE 78953acd3b1SBarry Smith 79095452b02SPatrick Sanan Notes: 79195452b02SPatrick Sanan If the user does not supply the option at all value is NOT changed. Thus 7922efd9cb1SBarry Smith you should ALWAYS initialize value if you access it without first checking if the set flag is true. 7932efd9cb1SBarry Smith 794989712b9SBarry Smith The default/currentvalue passed into this routine does not get transferred to the output value variable automatically. 795989712b9SBarry Smith 79653acd3b1SBarry Smith Level: beginner 79753acd3b1SBarry Smith 79853acd3b1SBarry Smith Concepts: options database^has int 79953acd3b1SBarry Smith 80095452b02SPatrick Sanan Notes: 80195452b02SPatrick Sanan Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 80253acd3b1SBarry Smith 80353acd3b1SBarry Smith .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 804acfcf0e5SJed Brown PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 805acfcf0e5SJed Brown PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 80653acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 80753acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 808acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 809a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 81053acd3b1SBarry Smith @*/ 8114416b707SBarry Smith PetscErrorCode PetscOptionsInt_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscInt currentvalue,PetscInt *value,PetscBool *set) 81253acd3b1SBarry Smith { 81353acd3b1SBarry Smith PetscErrorCode ierr; 8144416b707SBarry Smith PetscOptionItem amsopt; 81512655325SBarry Smith PetscBool wasset; 81653acd3b1SBarry Smith 81753acd3b1SBarry Smith PetscFunctionBegin; 818e55864a3SBarry Smith if (!PetscOptionsObject->count) { 8194416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_INT,&amsopt);CHKERRQ(ierr); 8206356e834SBarry Smith ierr = PetscMalloc(sizeof(PetscInt),&amsopt->data);CHKERRQ(ierr); 82112655325SBarry Smith *(PetscInt*)amsopt->data = currentvalue; 8223e211508SBarry Smith 823c5929fdfSBarry Smith ierr = PetscOptionsGetInt(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,¤tvalue,&wasset);CHKERRQ(ierr); 8243e211508SBarry Smith if (wasset) { 82512655325SBarry Smith *(PetscInt*)amsopt->data = currentvalue; 8263e211508SBarry Smith } 827af6d86caSBarry Smith } 82889a13869SBarry Smith ierr = PetscOptionsGetInt(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,value,set);CHKERRQ(ierr); 829e55864a3SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 8301a1499c8SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s <%d>: %s (%s)\n",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",opt+1,currentvalue,text,ManSection(man));CHKERRQ(ierr); 83153acd3b1SBarry Smith } 83253acd3b1SBarry Smith PetscFunctionReturn(0); 83353acd3b1SBarry Smith } 83453acd3b1SBarry Smith 83553acd3b1SBarry Smith /*@C 83653acd3b1SBarry Smith PetscOptionsString - Gets the string value for a particular option in the database. 83753acd3b1SBarry Smith 8383f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 83953acd3b1SBarry Smith 84053acd3b1SBarry Smith Input Parameters: 84153acd3b1SBarry Smith + opt - option name 84253acd3b1SBarry Smith . text - short string that describes the option 84353acd3b1SBarry Smith . man - manual page with additional information on option 8440fdccdaeSBarry Smith . currentvalue - the current value; caller is responsible for setting this value correctly. This is not used to set value 845bcbf2dc5SJed Brown - len - length of the result string including null terminator 84653acd3b1SBarry Smith 84753acd3b1SBarry Smith Output Parameter: 84853acd3b1SBarry Smith + value - the value to return 84953acd3b1SBarry Smith - flg - PETSC_TRUE if found, else PETSC_FALSE 85053acd3b1SBarry Smith 85153acd3b1SBarry Smith Level: beginner 85253acd3b1SBarry Smith 85353acd3b1SBarry Smith Concepts: options database^has int 85453acd3b1SBarry Smith 85595452b02SPatrick Sanan Notes: 85695452b02SPatrick Sanan Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 85753acd3b1SBarry Smith 8587fccdfe4SBarry 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). 8597fccdfe4SBarry Smith 8602efd9cb1SBarry Smith If the user does not supply the option at all value is NOT changed. Thus 8612efd9cb1SBarry Smith you should ALWAYS initialize value if you access it without first checking if the set flag is true. 8622efd9cb1SBarry Smith 863989712b9SBarry Smith The default/currentvalue passed into this routine does not get transferred to the output value variable automatically. 864989712b9SBarry Smith 8652efd9cb1SBarry Smith 86689a13869SBarry Smith .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 867acfcf0e5SJed Brown PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 868acfcf0e5SJed Brown PetscOptionsInt(), PetscOptionsReal(), PetscOptionsBool(), 86953acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 87053acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 871acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 872a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 87353acd3b1SBarry Smith @*/ 8744416b707SBarry 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) 87553acd3b1SBarry Smith { 87653acd3b1SBarry Smith PetscErrorCode ierr; 8774416b707SBarry Smith PetscOptionItem amsopt; 87853acd3b1SBarry Smith 87953acd3b1SBarry Smith PetscFunctionBegin; 8801a1499c8SBarry Smith if (!PetscOptionsObject->count) { 8814416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_STRING,&amsopt);CHKERRQ(ierr); 88264facd6cSBarry Smith /* must use system malloc since SAWs may free this */ 8830fdccdaeSBarry Smith ierr = PetscStrdup(currentvalue ? currentvalue : "",(char**)&amsopt->data);CHKERRQ(ierr); 884af6d86caSBarry Smith } 885c5929fdfSBarry Smith ierr = PetscOptionsGetString(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,value,len,set);CHKERRQ(ierr); 886e55864a3SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 8871a1499c8SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s <%s>: %s (%s)\n",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",opt+1,currentvalue,text,ManSection(man));CHKERRQ(ierr); 88853acd3b1SBarry Smith } 88953acd3b1SBarry Smith PetscFunctionReturn(0); 89053acd3b1SBarry Smith } 89153acd3b1SBarry Smith 89253acd3b1SBarry Smith /*@C 89353acd3b1SBarry Smith PetscOptionsReal - Gets the PetscReal value for a particular option in the database. 89453acd3b1SBarry Smith 8953f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 89653acd3b1SBarry Smith 89753acd3b1SBarry Smith Input Parameters: 89853acd3b1SBarry Smith + opt - option name 89953acd3b1SBarry Smith . text - short string that describes the option 90053acd3b1SBarry Smith . man - manual page with additional information on option 9010fdccdaeSBarry Smith - currentvalue - the current value; caller is responsible for setting this value correctly. Normally this is done with either 9020fdccdaeSBarry Smith $ PetscOptionsReal(..., obj->value,&object->value,...) or 9030fdccdaeSBarry Smith $ value = defaultvalue 9040fdccdaeSBarry Smith $ PetscOptionsReal(..., value,&value,&flg); 9050fdccdaeSBarry Smith $ if (flg) { 90653acd3b1SBarry Smith 90753acd3b1SBarry Smith Output Parameter: 90853acd3b1SBarry Smith + value - the value to return 90953acd3b1SBarry Smith - flg - PETSC_TRUE if found, else PETSC_FALSE 91053acd3b1SBarry Smith 91195452b02SPatrick Sanan Notes: 91295452b02SPatrick Sanan If the user does not supply the option at all value is NOT changed. Thus 9132efd9cb1SBarry Smith you should ALWAYS initialize value if you access it without first checking if the set flag is true. 9142efd9cb1SBarry Smith 915989712b9SBarry Smith The default/currentvalue passed into this routine does not get transferred to the output value variable automatically. 916989712b9SBarry Smith 91753acd3b1SBarry Smith Level: beginner 91853acd3b1SBarry Smith 91953acd3b1SBarry Smith Concepts: options database^has int 92053acd3b1SBarry Smith 92195452b02SPatrick Sanan Notes: 92295452b02SPatrick Sanan Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 92353acd3b1SBarry Smith 92489a13869SBarry Smith .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 925acfcf0e5SJed Brown PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 926acfcf0e5SJed Brown PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 92753acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 92853acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 929acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 930a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 93153acd3b1SBarry Smith @*/ 9324416b707SBarry Smith PetscErrorCode PetscOptionsReal_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscReal currentvalue,PetscReal *value,PetscBool *set) 93353acd3b1SBarry Smith { 93453acd3b1SBarry Smith PetscErrorCode ierr; 9354416b707SBarry Smith PetscOptionItem amsopt; 93653acd3b1SBarry Smith 93753acd3b1SBarry Smith PetscFunctionBegin; 938e55864a3SBarry Smith if (!PetscOptionsObject->count) { 9394416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_REAL,&amsopt);CHKERRQ(ierr); 940538aa990SBarry Smith ierr = PetscMalloc(sizeof(PetscReal),&amsopt->data);CHKERRQ(ierr); 941a297a907SKarl Rupp 9420fdccdaeSBarry Smith *(PetscReal*)amsopt->data = currentvalue; 943538aa990SBarry Smith } 944c5929fdfSBarry Smith ierr = PetscOptionsGetReal(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,value,set);CHKERRQ(ierr); 9451a1499c8SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 9461a1499c8SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s <%g>: %s (%s)\n",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",opt+1,(double)currentvalue,text,ManSection(man));CHKERRQ(ierr); 94753acd3b1SBarry Smith } 94853acd3b1SBarry Smith PetscFunctionReturn(0); 94953acd3b1SBarry Smith } 95053acd3b1SBarry Smith 95153acd3b1SBarry Smith /*@C 95253acd3b1SBarry Smith PetscOptionsScalar - Gets the scalar value for a particular option in the database. 95353acd3b1SBarry Smith 9543f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 95553acd3b1SBarry Smith 95653acd3b1SBarry Smith Input Parameters: 95753acd3b1SBarry Smith + opt - option name 95853acd3b1SBarry Smith . text - short string that describes the option 95953acd3b1SBarry Smith . man - manual page with additional information on option 9600fdccdaeSBarry Smith - currentvalue - the current value; caller is responsible for setting this value correctly. Normally this is done with either 9610fdccdaeSBarry Smith $ PetscOptionsScalar(..., obj->value,&object->value,...) or 9620fdccdaeSBarry Smith $ value = defaultvalue 9630fdccdaeSBarry Smith $ PetscOptionsScalar(..., value,&value,&flg); 9640fdccdaeSBarry Smith $ if (flg) { 9650fdccdaeSBarry Smith 96653acd3b1SBarry Smith 96753acd3b1SBarry Smith Output Parameter: 96853acd3b1SBarry Smith + value - the value to return 96953acd3b1SBarry Smith - flg - PETSC_TRUE if found, else PETSC_FALSE 97053acd3b1SBarry Smith 97195452b02SPatrick Sanan Notes: 97295452b02SPatrick Sanan If the user does not supply the option at all value is NOT changed. Thus 9732efd9cb1SBarry Smith you should ALWAYS initialize value if you access it without first checking if the set flag is true. 9742efd9cb1SBarry Smith 975989712b9SBarry Smith The default/currentvalue passed into this routine does not get transferred to the output value variable automatically. 976989712b9SBarry Smith 97753acd3b1SBarry Smith Level: beginner 97853acd3b1SBarry Smith 97953acd3b1SBarry Smith Concepts: options database^has int 98053acd3b1SBarry Smith 98195452b02SPatrick Sanan Notes: 98295452b02SPatrick Sanan Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 98353acd3b1SBarry Smith 98489a13869SBarry Smith .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 985acfcf0e5SJed Brown PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 986acfcf0e5SJed Brown PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 98753acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 98853acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 989acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 990a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 99153acd3b1SBarry Smith @*/ 9924416b707SBarry Smith PetscErrorCode PetscOptionsScalar_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscScalar currentvalue,PetscScalar *value,PetscBool *set) 99353acd3b1SBarry Smith { 99453acd3b1SBarry Smith PetscErrorCode ierr; 99553acd3b1SBarry Smith 99653acd3b1SBarry Smith PetscFunctionBegin; 99753acd3b1SBarry Smith #if !defined(PETSC_USE_COMPLEX) 9980fdccdaeSBarry Smith ierr = PetscOptionsReal(opt,text,man,currentvalue,value,set);CHKERRQ(ierr); 99953acd3b1SBarry Smith #else 1000c5929fdfSBarry Smith ierr = PetscOptionsGetScalar(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,value,set);CHKERRQ(ierr); 100153acd3b1SBarry Smith #endif 100253acd3b1SBarry Smith PetscFunctionReturn(0); 100353acd3b1SBarry Smith } 100453acd3b1SBarry Smith 100553acd3b1SBarry Smith /*@C 100690d69ab7SBarry 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 100790d69ab7SBarry Smith its value is set to false. 100853acd3b1SBarry Smith 10093f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 101053acd3b1SBarry Smith 101153acd3b1SBarry Smith Input Parameters: 101253acd3b1SBarry Smith + opt - option name 101353acd3b1SBarry Smith . text - short string that describes the option 101453acd3b1SBarry Smith - man - manual page with additional information on option 101553acd3b1SBarry Smith 101653acd3b1SBarry Smith Output Parameter: 101753acd3b1SBarry Smith . flg - PETSC_TRUE if found, else PETSC_FALSE 101853acd3b1SBarry Smith 101953acd3b1SBarry Smith Level: beginner 102053acd3b1SBarry Smith 102153acd3b1SBarry Smith Concepts: options database^has int 102253acd3b1SBarry Smith 102395452b02SPatrick Sanan Notes: 102495452b02SPatrick Sanan Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 102553acd3b1SBarry Smith 102689a13869SBarry Smith .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 1027acfcf0e5SJed Brown PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 1028acfcf0e5SJed Brown PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 102953acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 103053acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1031acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1032a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 103353acd3b1SBarry Smith @*/ 10344416b707SBarry Smith PetscErrorCode PetscOptionsName_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscBool *flg) 103553acd3b1SBarry Smith { 103653acd3b1SBarry Smith PetscErrorCode ierr; 10374416b707SBarry Smith PetscOptionItem amsopt; 103853acd3b1SBarry Smith 103953acd3b1SBarry Smith PetscFunctionBegin; 1040e55864a3SBarry Smith if (!PetscOptionsObject->count) { 10414416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_BOOL,&amsopt);CHKERRQ(ierr); 1042ace3abfcSBarry Smith ierr = PetscMalloc(sizeof(PetscBool),&amsopt->data);CHKERRQ(ierr); 1043a297a907SKarl Rupp 1044ace3abfcSBarry Smith *(PetscBool*)amsopt->data = PETSC_FALSE; 10451ae3d29cSBarry Smith } 1046c5929fdfSBarry Smith ierr = PetscOptionsHasName(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,flg);CHKERRQ(ierr); 1047e55864a3SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 1048e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s: %s (%s)\n",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",opt+1,text,ManSection(man));CHKERRQ(ierr); 104953acd3b1SBarry Smith } 105053acd3b1SBarry Smith PetscFunctionReturn(0); 105153acd3b1SBarry Smith } 105253acd3b1SBarry Smith 105353acd3b1SBarry Smith /*@C 1054a264d7a6SBarry Smith PetscOptionsFList - Puts a list of option values that a single one may be selected from 105553acd3b1SBarry Smith 10563f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 105753acd3b1SBarry Smith 105853acd3b1SBarry Smith Input Parameters: 105953acd3b1SBarry Smith + opt - option name 106053acd3b1SBarry Smith . text - short string that describes the option 106153acd3b1SBarry Smith . man - manual page with additional information on option 106253acd3b1SBarry Smith . list - the possible choices 10630fdccdaeSBarry Smith . currentvalue - the current value; caller is responsible for setting this value correctly. Normally this is done with 10640fdccdaeSBarry Smith $ PetscOptionsFlist(..., obj->value,value,len,&flg); 10650fdccdaeSBarry Smith $ if (flg) { 10663cc1e11dSBarry Smith - len - the length of the character array value 106753acd3b1SBarry Smith 106853acd3b1SBarry Smith Output Parameter: 106953acd3b1SBarry Smith + value - the value to return 107053acd3b1SBarry Smith - set - PETSC_TRUE if found, else PETSC_FALSE 107153acd3b1SBarry Smith 107253acd3b1SBarry Smith Level: intermediate 107353acd3b1SBarry Smith 107495452b02SPatrick Sanan Notes: 107595452b02SPatrick Sanan Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 107653acd3b1SBarry Smith 10772efd9cb1SBarry Smith If the user does not supply the option at all value is NOT changed. Thus 10782efd9cb1SBarry Smith you should ALWAYS initialize value if you access it without first checking if the set flag is true. 10792efd9cb1SBarry Smith 1080989712b9SBarry Smith The default/currentvalue passed into this routine does not get transferred to the output value variable automatically. 1081989712b9SBarry Smith 108253acd3b1SBarry Smith See PetscOptionsEList() for when the choices are given in a string array 108353acd3b1SBarry Smith 108453acd3b1SBarry Smith To get a listing of all currently specified options, 108588c29154SBarry Smith see PetscOptionsView() or PetscOptionsGetAll() 108653acd3b1SBarry Smith 1087eabe10d7SBarry Smith Developer Note: This cannot check for invalid selection because of things like MATAIJ that are not included in the list 1088eabe10d7SBarry Smith 108953acd3b1SBarry Smith Concepts: options database^list 109053acd3b1SBarry Smith 109189a13869SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 1092acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 109353acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 109453acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1095acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1096a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList(), PetscOptionsEnum() 109753acd3b1SBarry Smith @*/ 10984416b707SBarry 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) 109953acd3b1SBarry Smith { 110053acd3b1SBarry Smith PetscErrorCode ierr; 11014416b707SBarry Smith PetscOptionItem amsopt; 110253acd3b1SBarry Smith 110353acd3b1SBarry Smith PetscFunctionBegin; 11041a1499c8SBarry Smith if (!PetscOptionsObject->count) { 11054416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,ltext,man,OPTION_FLIST,&amsopt);CHKERRQ(ierr); 110664facd6cSBarry Smith /* must use system malloc since SAWs may free this */ 11070fdccdaeSBarry Smith ierr = PetscStrdup(currentvalue ? currentvalue : "",(char**)&amsopt->data);CHKERRQ(ierr); 11083cc1e11dSBarry Smith amsopt->flist = list; 11093cc1e11dSBarry Smith } 1110c5929fdfSBarry Smith ierr = PetscOptionsGetString(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,value,len,set);CHKERRQ(ierr); 11111a1499c8SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 11121a1499c8SBarry Smith ierr = PetscFunctionListPrintTypes(PetscOptionsObject->comm,stdout,PetscOptionsObject->prefix,opt,ltext,man,list,currentvalue);CHKERRQ(ierr);CHKERRQ(ierr); 111353acd3b1SBarry Smith } 111453acd3b1SBarry Smith PetscFunctionReturn(0); 111553acd3b1SBarry Smith } 111653acd3b1SBarry Smith 111753acd3b1SBarry Smith /*@C 111853acd3b1SBarry Smith PetscOptionsEList - Puts a list of option values that a single one may be selected from 111953acd3b1SBarry Smith 11203f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 112153acd3b1SBarry Smith 112253acd3b1SBarry Smith Input Parameters: 112353acd3b1SBarry Smith + opt - option name 112453acd3b1SBarry Smith . ltext - short string that describes the option 112553acd3b1SBarry Smith . man - manual page with additional information on option 1126a264d7a6SBarry Smith . list - the possible choices (one of these must be selected, anything else is invalid) 112753acd3b1SBarry Smith . ntext - number of choices 11280fdccdaeSBarry Smith - currentvalue - the current value; caller is responsible for setting this value correctly. Normally this is done with 11290fdccdaeSBarry Smith $ PetscOptionsElist(..., obj->value,&value,&flg); 11300fdccdaeSBarry Smith $ if (flg) { 11310fdccdaeSBarry Smith 113253acd3b1SBarry Smith 113353acd3b1SBarry Smith Output Parameter: 113453acd3b1SBarry Smith + value - the index of the value to return 113553acd3b1SBarry Smith - set - PETSC_TRUE if found, else PETSC_FALSE 113653acd3b1SBarry Smith 113753acd3b1SBarry Smith Level: intermediate 113853acd3b1SBarry Smith 113995452b02SPatrick Sanan Notes: 114095452b02SPatrick Sanan Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 114153acd3b1SBarry Smith 11422efd9cb1SBarry Smith If the user does not supply the option at all value is NOT changed. Thus 11432efd9cb1SBarry Smith you should ALWAYS initialize value if you access it without first checking if the set flag is true. 11442efd9cb1SBarry Smith 1145a264d7a6SBarry Smith See PetscOptionsFList() for when the choices are given in a PetscFunctionList() 114653acd3b1SBarry Smith 114753acd3b1SBarry Smith Concepts: options database^list 114853acd3b1SBarry Smith 114989a13869SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 1150acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 115153acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 115253acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1153acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1154a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEnum() 115553acd3b1SBarry Smith @*/ 11564416b707SBarry 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) 115753acd3b1SBarry Smith { 115853acd3b1SBarry Smith PetscErrorCode ierr; 115953acd3b1SBarry Smith PetscInt i; 11604416b707SBarry Smith PetscOptionItem amsopt; 116153acd3b1SBarry Smith 116253acd3b1SBarry Smith PetscFunctionBegin; 11631a1499c8SBarry Smith if (!PetscOptionsObject->count) { 11644416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,ltext,man,OPTION_ELIST,&amsopt);CHKERRQ(ierr); 116564facd6cSBarry Smith /* must use system malloc since SAWs may free this */ 11660fdccdaeSBarry Smith ierr = PetscStrdup(currentvalue ? currentvalue : "",(char**)&amsopt->data);CHKERRQ(ierr); 11676991f827SBarry Smith ierr = PetscStrNArrayallocpy(ntext,list,(char***)&amsopt->list);CHKERRQ(ierr); 11681ae3d29cSBarry Smith amsopt->nlist = ntext; 11691ae3d29cSBarry Smith } 1170c5929fdfSBarry Smith ierr = PetscOptionsGetEList(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,list,ntext,value,set);CHKERRQ(ierr); 11711a1499c8SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 1172e3f729a5SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s <%s> %s (choose one of)",PetscOptionsObject->prefix?PetscOptionsObject->prefix:"",opt+1,currentvalue,ltext);CHKERRQ(ierr); 117353acd3b1SBarry Smith for (i=0; i<ntext; i++) { 1174e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," %s",list[i]);CHKERRQ(ierr); 117553acd3b1SBarry Smith } 1176e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," (%s)\n",ManSection(man));CHKERRQ(ierr); 117753acd3b1SBarry Smith } 117853acd3b1SBarry Smith PetscFunctionReturn(0); 117953acd3b1SBarry Smith } 118053acd3b1SBarry Smith 118153acd3b1SBarry Smith /*@C 1182acfcf0e5SJed Brown PetscOptionsBoolGroupBegin - First in a series of logical queries on the options database for 1183d5649816SBarry Smith which at most a single value can be true. 118453acd3b1SBarry Smith 11853f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 118653acd3b1SBarry Smith 118753acd3b1SBarry Smith Input Parameters: 118853acd3b1SBarry Smith + opt - option name 118953acd3b1SBarry Smith . text - short string that describes the option 119053acd3b1SBarry Smith - man - manual page with additional information on option 119153acd3b1SBarry Smith 119253acd3b1SBarry Smith Output Parameter: 119353acd3b1SBarry Smith . flg - whether that option was set or not 119453acd3b1SBarry Smith 119553acd3b1SBarry Smith Level: intermediate 119653acd3b1SBarry Smith 119795452b02SPatrick Sanan Notes: 119895452b02SPatrick Sanan Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 119953acd3b1SBarry Smith 1200acfcf0e5SJed Brown Must be followed by 0 or more PetscOptionsBoolGroup()s and PetscOptionsBoolGroupEnd() 120153acd3b1SBarry Smith 120253acd3b1SBarry Smith Concepts: options database^logical group 120353acd3b1SBarry Smith 120489a13869SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 1205acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 120653acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 120753acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1208acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1209a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 121053acd3b1SBarry Smith @*/ 12114416b707SBarry Smith PetscErrorCode PetscOptionsBoolGroupBegin_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscBool *flg) 121253acd3b1SBarry Smith { 121353acd3b1SBarry Smith PetscErrorCode ierr; 12144416b707SBarry Smith PetscOptionItem amsopt; 121553acd3b1SBarry Smith 121653acd3b1SBarry Smith PetscFunctionBegin; 1217e55864a3SBarry Smith if (!PetscOptionsObject->count) { 12184416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_BOOL,&amsopt);CHKERRQ(ierr); 1219ace3abfcSBarry Smith ierr = PetscMalloc(sizeof(PetscBool),&amsopt->data);CHKERRQ(ierr); 1220a297a907SKarl Rupp 1221ace3abfcSBarry Smith *(PetscBool*)amsopt->data = PETSC_FALSE; 12221ae3d29cSBarry Smith } 122368b16fdaSBarry Smith *flg = PETSC_FALSE; 1224c5929fdfSBarry Smith ierr = PetscOptionsGetBool(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,flg,NULL);CHKERRQ(ierr); 1225e55864a3SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 1226e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," Pick at most one of -------------\n");CHKERRQ(ierr); 1227e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s: %s (%s)\n",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",opt+1,text,ManSection(man));CHKERRQ(ierr); 122853acd3b1SBarry Smith } 122953acd3b1SBarry Smith PetscFunctionReturn(0); 123053acd3b1SBarry Smith } 123153acd3b1SBarry Smith 123253acd3b1SBarry Smith /*@C 1233acfcf0e5SJed Brown PetscOptionsBoolGroup - One in a series of logical queries on the options database for 1234d5649816SBarry Smith which at most a single value can be true. 123553acd3b1SBarry Smith 12363f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 123753acd3b1SBarry Smith 123853acd3b1SBarry Smith Input Parameters: 123953acd3b1SBarry Smith + opt - option name 124053acd3b1SBarry Smith . text - short string that describes the option 124153acd3b1SBarry Smith - man - manual page with additional information on option 124253acd3b1SBarry Smith 124353acd3b1SBarry Smith Output Parameter: 124453acd3b1SBarry Smith . flg - PETSC_TRUE if found, else PETSC_FALSE 124553acd3b1SBarry Smith 124653acd3b1SBarry Smith Level: intermediate 124753acd3b1SBarry Smith 124895452b02SPatrick Sanan Notes: 124995452b02SPatrick Sanan Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 125053acd3b1SBarry Smith 1251acfcf0e5SJed Brown Must follow a PetscOptionsBoolGroupBegin() and preceded a PetscOptionsBoolGroupEnd() 125253acd3b1SBarry Smith 125353acd3b1SBarry Smith Concepts: options database^logical group 125453acd3b1SBarry Smith 125589a13869SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 1256acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 125753acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 125853acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1259acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1260a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 126153acd3b1SBarry Smith @*/ 12624416b707SBarry Smith PetscErrorCode PetscOptionsBoolGroup_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscBool *flg) 126353acd3b1SBarry Smith { 126453acd3b1SBarry Smith PetscErrorCode ierr; 12654416b707SBarry Smith PetscOptionItem amsopt; 126653acd3b1SBarry Smith 126753acd3b1SBarry Smith PetscFunctionBegin; 1268e55864a3SBarry Smith if (!PetscOptionsObject->count) { 12694416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_BOOL,&amsopt);CHKERRQ(ierr); 1270ace3abfcSBarry Smith ierr = PetscMalloc(sizeof(PetscBool),&amsopt->data);CHKERRQ(ierr); 1271a297a907SKarl Rupp 1272ace3abfcSBarry Smith *(PetscBool*)amsopt->data = PETSC_FALSE; 12731ae3d29cSBarry Smith } 127417326d04SJed Brown *flg = PETSC_FALSE; 1275c5929fdfSBarry Smith ierr = PetscOptionsGetBool(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,flg,NULL);CHKERRQ(ierr); 1276e55864a3SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 1277e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s: %s (%s)\n",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",opt+1,text,ManSection(man));CHKERRQ(ierr); 127853acd3b1SBarry Smith } 127953acd3b1SBarry Smith PetscFunctionReturn(0); 128053acd3b1SBarry Smith } 128153acd3b1SBarry Smith 128253acd3b1SBarry Smith /*@C 1283acfcf0e5SJed Brown PetscOptionsBoolGroupEnd - Last in a series of logical queries on the options database for 1284d5649816SBarry Smith which at most a single value can be true. 128553acd3b1SBarry Smith 12863f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 128753acd3b1SBarry Smith 128853acd3b1SBarry Smith Input Parameters: 128953acd3b1SBarry Smith + opt - option name 129053acd3b1SBarry Smith . text - short string that describes the option 129153acd3b1SBarry Smith - man - manual page with additional information on option 129253acd3b1SBarry Smith 129353acd3b1SBarry Smith Output Parameter: 129453acd3b1SBarry Smith . flg - PETSC_TRUE if found, else PETSC_FALSE 129553acd3b1SBarry Smith 129653acd3b1SBarry Smith Level: intermediate 129753acd3b1SBarry Smith 129895452b02SPatrick Sanan Notes: 129995452b02SPatrick Sanan Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 130053acd3b1SBarry Smith 1301acfcf0e5SJed Brown Must follow a PetscOptionsBoolGroupBegin() 130253acd3b1SBarry Smith 130353acd3b1SBarry Smith Concepts: options database^logical group 130453acd3b1SBarry Smith 130589a13869SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 1306acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 130753acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 130853acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1309acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1310a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 131153acd3b1SBarry Smith @*/ 13124416b707SBarry Smith PetscErrorCode PetscOptionsBoolGroupEnd_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscBool *flg) 131353acd3b1SBarry Smith { 131453acd3b1SBarry Smith PetscErrorCode ierr; 13154416b707SBarry Smith PetscOptionItem amsopt; 131653acd3b1SBarry Smith 131753acd3b1SBarry Smith PetscFunctionBegin; 1318e55864a3SBarry Smith if (!PetscOptionsObject->count) { 13194416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_BOOL,&amsopt);CHKERRQ(ierr); 1320ace3abfcSBarry Smith ierr = PetscMalloc(sizeof(PetscBool),&amsopt->data);CHKERRQ(ierr); 1321a297a907SKarl Rupp 1322ace3abfcSBarry Smith *(PetscBool*)amsopt->data = PETSC_FALSE; 13231ae3d29cSBarry Smith } 132417326d04SJed Brown *flg = PETSC_FALSE; 1325c5929fdfSBarry Smith ierr = PetscOptionsGetBool(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,flg,NULL);CHKERRQ(ierr); 1326e55864a3SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 1327e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s: %s (%s)\n",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",opt+1,text,ManSection(man));CHKERRQ(ierr); 132853acd3b1SBarry Smith } 132953acd3b1SBarry Smith PetscFunctionReturn(0); 133053acd3b1SBarry Smith } 133153acd3b1SBarry Smith 133253acd3b1SBarry Smith /*@C 1333acfcf0e5SJed Brown PetscOptionsBool - Determines if a particular option is in the database with a true or false 133453acd3b1SBarry Smith 13353f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 133653acd3b1SBarry Smith 133753acd3b1SBarry Smith Input Parameters: 133853acd3b1SBarry Smith + opt - option name 133953acd3b1SBarry Smith . text - short string that describes the option 1340868c398cSBarry Smith . man - manual page with additional information on option 134194ae4db5SBarry Smith - currentvalue - the current value 134253acd3b1SBarry Smith 134353acd3b1SBarry Smith Output Parameter: 134453acd3b1SBarry Smith . flg - PETSC_TRUE or PETSC_FALSE 134553acd3b1SBarry Smith . set - PETSC_TRUE if found, else PETSC_FALSE 134653acd3b1SBarry Smith 13472efd9cb1SBarry Smith Notes: 13482efd9cb1SBarry Smith TRUE, true, YES, yes, nostring, and 1 all translate to PETSC_TRUE 13492efd9cb1SBarry Smith FALSE, false, NO, no, and 0 all translate to PETSC_FALSE 13502efd9cb1SBarry Smith 13512efd9cb1SBarry 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 13522efd9cb1SBarry Smith is equivalent to -requested_bool true 13532efd9cb1SBarry Smith 13542efd9cb1SBarry Smith If the user does not supply the option at all flg is NOT changed. Thus 13552efd9cb1SBarry Smith you should ALWAYS initialize the flg if you access it without first checking if the set flag is true. 13562efd9cb1SBarry Smith 135753acd3b1SBarry Smith Level: beginner 135853acd3b1SBarry Smith 135953acd3b1SBarry Smith Concepts: options database^logical 136053acd3b1SBarry Smith 136195452b02SPatrick Sanan Notes: 136295452b02SPatrick Sanan Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 136353acd3b1SBarry Smith 136489a13869SBarry Smith .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 1365acfcf0e5SJed Brown PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 1366acfcf0e5SJed Brown PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 136753acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 136853acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1369acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1370a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 137153acd3b1SBarry Smith @*/ 13724416b707SBarry Smith PetscErrorCode PetscOptionsBool_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscBool currentvalue,PetscBool *flg,PetscBool *set) 137353acd3b1SBarry Smith { 137453acd3b1SBarry Smith PetscErrorCode ierr; 1375ace3abfcSBarry Smith PetscBool iset; 13764416b707SBarry Smith PetscOptionItem amsopt; 137753acd3b1SBarry Smith 137853acd3b1SBarry Smith PetscFunctionBegin; 1379e55864a3SBarry Smith if (!PetscOptionsObject->count) { 13804416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_BOOL,&amsopt);CHKERRQ(ierr); 1381ace3abfcSBarry Smith ierr = PetscMalloc(sizeof(PetscBool),&amsopt->data);CHKERRQ(ierr); 1382a297a907SKarl Rupp 138394ae4db5SBarry Smith *(PetscBool*)amsopt->data = currentvalue; 1384af6d86caSBarry Smith } 1385c5929fdfSBarry Smith ierr = PetscOptionsGetBool(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,flg,&iset);CHKERRQ(ierr); 138653acd3b1SBarry Smith if (set) *set = iset; 13871a1499c8SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 138894ae4db5SBarry Smith const char *v = PetscBools[currentvalue]; 13891a1499c8SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s: <%s> %s (%s)\n",PetscOptionsObject->prefix?PetscOptionsObject->prefix:"",opt+1,v,text,ManSection(man));CHKERRQ(ierr); 139053acd3b1SBarry Smith } 139153acd3b1SBarry Smith PetscFunctionReturn(0); 139253acd3b1SBarry Smith } 139353acd3b1SBarry Smith 139453acd3b1SBarry Smith /*@C 139553acd3b1SBarry Smith PetscOptionsRealArray - Gets an array of double values for a particular 139653acd3b1SBarry Smith option in the database. The values must be separated with commas with 139753acd3b1SBarry Smith no intervening spaces. 139853acd3b1SBarry Smith 13993f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 140053acd3b1SBarry Smith 140153acd3b1SBarry Smith Input Parameters: 140253acd3b1SBarry Smith + opt - the option one is seeking 140353acd3b1SBarry Smith . text - short string describing option 140453acd3b1SBarry Smith . man - manual page for option 140553acd3b1SBarry Smith - nmax - maximum number of values 140653acd3b1SBarry Smith 140753acd3b1SBarry Smith Output Parameter: 140853acd3b1SBarry Smith + value - location to copy values 140953acd3b1SBarry Smith . nmax - actual number of values found 141053acd3b1SBarry Smith - set - PETSC_TRUE if found, else PETSC_FALSE 141153acd3b1SBarry Smith 141253acd3b1SBarry Smith Level: beginner 141353acd3b1SBarry Smith 141453acd3b1SBarry Smith Notes: 141553acd3b1SBarry Smith The user should pass in an array of doubles 141653acd3b1SBarry Smith 141753acd3b1SBarry Smith Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 141853acd3b1SBarry Smith 141953acd3b1SBarry Smith Concepts: options database^array of strings 142053acd3b1SBarry Smith 142189a13869SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 1422acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 142353acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 142453acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1425acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1426a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 142753acd3b1SBarry Smith @*/ 14284416b707SBarry Smith PetscErrorCode PetscOptionsRealArray_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscReal value[],PetscInt *n,PetscBool *set) 142953acd3b1SBarry Smith { 143053acd3b1SBarry Smith PetscErrorCode ierr; 143153acd3b1SBarry Smith PetscInt i; 14324416b707SBarry Smith PetscOptionItem amsopt; 143353acd3b1SBarry Smith 143453acd3b1SBarry Smith PetscFunctionBegin; 1435e55864a3SBarry Smith if (!PetscOptionsObject->count) { 1436e26ddf31SBarry Smith PetscReal *vals; 1437e26ddf31SBarry Smith 14384416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_REAL_ARRAY,&amsopt);CHKERRQ(ierr); 1439e55864a3SBarry Smith ierr = PetscMalloc((*n)*sizeof(PetscReal),&amsopt->data);CHKERRQ(ierr); 1440e26ddf31SBarry Smith vals = (PetscReal*)amsopt->data; 1441e26ddf31SBarry Smith for (i=0; i<*n; i++) vals[i] = value[i]; 1442e26ddf31SBarry Smith amsopt->arraylength = *n; 1443e26ddf31SBarry Smith } 1444c5929fdfSBarry Smith ierr = PetscOptionsGetRealArray(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,value,n,set);CHKERRQ(ierr); 1445e55864a3SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 1446a519f713SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s <%g",PetscOptionsObject->prefix?PetscOptionsObject->prefix:"",opt+1,(double)value[0]);CHKERRQ(ierr); 144753acd3b1SBarry Smith for (i=1; i<*n; i++) { 1448e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm,",%g",(double)value[i]);CHKERRQ(ierr); 144953acd3b1SBarry Smith } 1450e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm,">: %s (%s)\n",text,ManSection(man));CHKERRQ(ierr); 145153acd3b1SBarry Smith } 145253acd3b1SBarry Smith PetscFunctionReturn(0); 145353acd3b1SBarry Smith } 145453acd3b1SBarry Smith 1455050cccc3SHong Zhang /*@C 1456050cccc3SHong Zhang PetscOptionsScalarArray - Gets an array of Scalar values for a particular 1457050cccc3SHong Zhang option in the database. The values must be separated with commas with 1458050cccc3SHong Zhang no intervening spaces. 1459050cccc3SHong Zhang 1460050cccc3SHong Zhang Logically Collective on the communicator passed in PetscOptionsBegin() 1461050cccc3SHong Zhang 1462050cccc3SHong Zhang Input Parameters: 1463050cccc3SHong Zhang + opt - the option one is seeking 1464050cccc3SHong Zhang . text - short string describing option 1465050cccc3SHong Zhang . man - manual page for option 1466050cccc3SHong Zhang - nmax - maximum number of values 1467050cccc3SHong Zhang 1468050cccc3SHong Zhang Output Parameter: 1469050cccc3SHong Zhang + value - location to copy values 1470050cccc3SHong Zhang . nmax - actual number of values found 1471050cccc3SHong Zhang - set - PETSC_TRUE if found, else PETSC_FALSE 1472050cccc3SHong Zhang 1473050cccc3SHong Zhang Level: beginner 1474050cccc3SHong Zhang 1475050cccc3SHong Zhang Notes: 1476050cccc3SHong Zhang The user should pass in an array of doubles 1477050cccc3SHong Zhang 1478050cccc3SHong Zhang Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 1479050cccc3SHong Zhang 1480050cccc3SHong Zhang Concepts: options database^array of strings 1481050cccc3SHong Zhang 148289a13869SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 1483050cccc3SHong Zhang PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 1484050cccc3SHong Zhang PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 1485050cccc3SHong Zhang PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1486050cccc3SHong Zhang PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1487050cccc3SHong Zhang PetscOptionsFList(), PetscOptionsEList() 1488050cccc3SHong Zhang @*/ 14894416b707SBarry Smith PetscErrorCode PetscOptionsScalarArray_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscScalar value[],PetscInt *n,PetscBool *set) 1490050cccc3SHong Zhang { 1491050cccc3SHong Zhang PetscErrorCode ierr; 1492050cccc3SHong Zhang PetscInt i; 14934416b707SBarry Smith PetscOptionItem amsopt; 1494050cccc3SHong Zhang 1495050cccc3SHong Zhang PetscFunctionBegin; 1496050cccc3SHong Zhang if (!PetscOptionsObject->count) { 1497050cccc3SHong Zhang PetscScalar *vals; 1498050cccc3SHong Zhang 14994416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_SCALAR_ARRAY,&amsopt);CHKERRQ(ierr); 1500050cccc3SHong Zhang ierr = PetscMalloc((*n)*sizeof(PetscScalar),&amsopt->data);CHKERRQ(ierr); 1501050cccc3SHong Zhang vals = (PetscScalar*)amsopt->data; 1502050cccc3SHong Zhang for (i=0; i<*n; i++) vals[i] = value[i]; 1503050cccc3SHong Zhang amsopt->arraylength = *n; 1504050cccc3SHong Zhang } 1505c5929fdfSBarry Smith ierr = PetscOptionsGetScalarArray(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,value,n,set);CHKERRQ(ierr); 1506050cccc3SHong Zhang if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 150795f3a755SJose 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); 1508050cccc3SHong Zhang for (i=1; i<*n; i++) { 150995f3a755SJose E. Roman ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm,",%g+%gi",(double)PetscRealPart(value[i]),(double)PetscImaginaryPart(value[i]));CHKERRQ(ierr); 1510050cccc3SHong Zhang } 1511050cccc3SHong Zhang ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm,">: %s (%s)\n",text,ManSection(man));CHKERRQ(ierr); 1512050cccc3SHong Zhang } 1513050cccc3SHong Zhang PetscFunctionReturn(0); 1514050cccc3SHong Zhang } 151553acd3b1SBarry Smith 151653acd3b1SBarry Smith /*@C 151753acd3b1SBarry Smith PetscOptionsIntArray - Gets an array of integers for a particular 1518b32a342fSShri Abhyankar option in the database. 151953acd3b1SBarry Smith 15203f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 152153acd3b1SBarry Smith 152253acd3b1SBarry Smith Input Parameters: 152353acd3b1SBarry Smith + opt - the option one is seeking 152453acd3b1SBarry Smith . text - short string describing option 152553acd3b1SBarry Smith . man - manual page for option 1526f8a50e2bSBarry Smith - n - maximum number of values 152753acd3b1SBarry Smith 152853acd3b1SBarry Smith Output Parameter: 152953acd3b1SBarry Smith + value - location to copy values 1530f8a50e2bSBarry Smith . n - actual number of values found 153153acd3b1SBarry Smith - set - PETSC_TRUE if found, else PETSC_FALSE 153253acd3b1SBarry Smith 153353acd3b1SBarry Smith Level: beginner 153453acd3b1SBarry Smith 153553acd3b1SBarry Smith Notes: 1536b32a342fSShri Abhyankar The array can be passed as 1537bebe2cf6SSatish Balay a comma separated list: 0,1,2,3,4,5,6,7 15380fd488f5SShri Abhyankar a range (start-end+1): 0-8 15390fd488f5SShri Abhyankar a range with given increment (start-end+1:inc): 0-7:2 1540bebe2cf6SSatish Balay a combination of values and ranges separated by commas: 0,1-8,8-15:2 1541b32a342fSShri Abhyankar 1542b32a342fSShri Abhyankar There must be no intervening spaces between the values. 154353acd3b1SBarry Smith 154453acd3b1SBarry Smith Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 154553acd3b1SBarry Smith 1546b32a342fSShri Abhyankar Concepts: options database^array of ints 154753acd3b1SBarry Smith 154889a13869SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 1549acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 155053acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 155153acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1552acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1553a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList(), PetscOptionsRealArray() 155453acd3b1SBarry Smith @*/ 15554416b707SBarry Smith PetscErrorCode PetscOptionsIntArray_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscInt value[],PetscInt *n,PetscBool *set) 155653acd3b1SBarry Smith { 155753acd3b1SBarry Smith PetscErrorCode ierr; 155853acd3b1SBarry Smith PetscInt i; 15594416b707SBarry Smith PetscOptionItem amsopt; 156053acd3b1SBarry Smith 156153acd3b1SBarry Smith PetscFunctionBegin; 1562e55864a3SBarry Smith if (!PetscOptionsObject->count) { 1563e26ddf31SBarry Smith PetscInt *vals; 1564e26ddf31SBarry Smith 15654416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_INT_ARRAY,&amsopt);CHKERRQ(ierr); 1566854ce69bSBarry Smith ierr = PetscMalloc1(*n,(PetscInt**)&amsopt->data);CHKERRQ(ierr); 1567e26ddf31SBarry Smith vals = (PetscInt*)amsopt->data; 1568e26ddf31SBarry Smith for (i=0; i<*n; i++) vals[i] = value[i]; 1569e26ddf31SBarry Smith amsopt->arraylength = *n; 1570e26ddf31SBarry Smith } 1571c5929fdfSBarry Smith ierr = PetscOptionsGetIntArray(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,value,n,set);CHKERRQ(ierr); 1572e55864a3SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 1573e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s <%d",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",opt+1,value[0]);CHKERRQ(ierr); 157453acd3b1SBarry Smith for (i=1; i<*n; i++) { 1575e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm,",%d",value[i]);CHKERRQ(ierr); 157653acd3b1SBarry Smith } 1577e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm,">: %s (%s)\n",text,ManSection(man));CHKERRQ(ierr); 157853acd3b1SBarry Smith } 157953acd3b1SBarry Smith PetscFunctionReturn(0); 158053acd3b1SBarry Smith } 158153acd3b1SBarry Smith 158253acd3b1SBarry Smith /*@C 158353acd3b1SBarry Smith PetscOptionsStringArray - Gets an array of string values for a particular 158453acd3b1SBarry Smith option in the database. The values must be separated with commas with 158553acd3b1SBarry Smith no intervening spaces. 158653acd3b1SBarry Smith 15873f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 158853acd3b1SBarry Smith 158953acd3b1SBarry Smith Input Parameters: 159053acd3b1SBarry Smith + opt - the option one is seeking 159153acd3b1SBarry Smith . text - short string describing option 159253acd3b1SBarry Smith . man - manual page for option 159353acd3b1SBarry Smith - nmax - maximum number of strings 159453acd3b1SBarry Smith 159553acd3b1SBarry Smith Output Parameter: 159653acd3b1SBarry Smith + value - location to copy strings 159753acd3b1SBarry Smith . nmax - actual number of strings found 159853acd3b1SBarry Smith - set - PETSC_TRUE if found, else PETSC_FALSE 159953acd3b1SBarry Smith 160053acd3b1SBarry Smith Level: beginner 160153acd3b1SBarry Smith 160253acd3b1SBarry Smith Notes: 160353acd3b1SBarry Smith The user should pass in an array of pointers to char, to hold all the 160453acd3b1SBarry Smith strings returned by this function. 160553acd3b1SBarry Smith 160653acd3b1SBarry Smith The user is responsible for deallocating the strings that are 160753acd3b1SBarry Smith returned. The Fortran interface for this routine is not supported. 160853acd3b1SBarry Smith 160953acd3b1SBarry Smith Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 161053acd3b1SBarry Smith 161153acd3b1SBarry Smith Concepts: options database^array of strings 161253acd3b1SBarry Smith 161389a13869SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 1614acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 161553acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 161653acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1617acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1618a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 161953acd3b1SBarry Smith @*/ 16204416b707SBarry Smith PetscErrorCode PetscOptionsStringArray_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],char *value[],PetscInt *nmax,PetscBool *set) 162153acd3b1SBarry Smith { 162253acd3b1SBarry Smith PetscErrorCode ierr; 16234416b707SBarry Smith PetscOptionItem amsopt; 162453acd3b1SBarry Smith 162553acd3b1SBarry Smith PetscFunctionBegin; 1626e55864a3SBarry Smith if (!PetscOptionsObject->count) { 16274416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_STRING_ARRAY,&amsopt);CHKERRQ(ierr); 1628854ce69bSBarry Smith ierr = PetscMalloc1(*nmax,(char**)&amsopt->data);CHKERRQ(ierr); 1629a297a907SKarl Rupp 16301ae3d29cSBarry Smith amsopt->arraylength = *nmax; 16311ae3d29cSBarry Smith } 1632c5929fdfSBarry Smith ierr = PetscOptionsGetStringArray(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,value,nmax,set);CHKERRQ(ierr); 1633e55864a3SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 1634e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s <string1,string2,...>: %s (%s)\n",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",opt+1,text,ManSection(man));CHKERRQ(ierr); 163553acd3b1SBarry Smith } 163653acd3b1SBarry Smith PetscFunctionReturn(0); 163753acd3b1SBarry Smith } 163853acd3b1SBarry Smith 1639e2446a98SMatthew Knepley /*@C 1640acfcf0e5SJed Brown PetscOptionsBoolArray - Gets an array of logical values (true or false) for a particular 1641e2446a98SMatthew Knepley option in the database. The values must be separated with commas with 1642e2446a98SMatthew Knepley no intervening spaces. 1643e2446a98SMatthew Knepley 16443f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 1645e2446a98SMatthew Knepley 1646e2446a98SMatthew Knepley Input Parameters: 1647e2446a98SMatthew Knepley + opt - the option one is seeking 1648e2446a98SMatthew Knepley . text - short string describing option 1649e2446a98SMatthew Knepley . man - manual page for option 1650e2446a98SMatthew Knepley - nmax - maximum number of values 1651e2446a98SMatthew Knepley 1652e2446a98SMatthew Knepley Output Parameter: 1653e2446a98SMatthew Knepley + value - location to copy values 1654e2446a98SMatthew Knepley . nmax - actual number of values found 1655e2446a98SMatthew Knepley - set - PETSC_TRUE if found, else PETSC_FALSE 1656e2446a98SMatthew Knepley 1657e2446a98SMatthew Knepley Level: beginner 1658e2446a98SMatthew Knepley 1659e2446a98SMatthew Knepley Notes: 1660e2446a98SMatthew Knepley The user should pass in an array of doubles 1661e2446a98SMatthew Knepley 1662e2446a98SMatthew Knepley Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 1663e2446a98SMatthew Knepley 1664e2446a98SMatthew Knepley Concepts: options database^array of strings 1665e2446a98SMatthew Knepley 166689a13869SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 1667acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 1668e2446a98SMatthew Knepley PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 1669e2446a98SMatthew Knepley PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1670acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1671a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 1672e2446a98SMatthew Knepley @*/ 16734416b707SBarry Smith PetscErrorCode PetscOptionsBoolArray_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscBool value[],PetscInt *n,PetscBool *set) 1674e2446a98SMatthew Knepley { 1675e2446a98SMatthew Knepley PetscErrorCode ierr; 1676e2446a98SMatthew Knepley PetscInt i; 16774416b707SBarry Smith PetscOptionItem amsopt; 1678e2446a98SMatthew Knepley 1679e2446a98SMatthew Knepley PetscFunctionBegin; 1680e55864a3SBarry Smith if (!PetscOptionsObject->count) { 1681ace3abfcSBarry Smith PetscBool *vals; 16821ae3d29cSBarry Smith 16834416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_BOOL_ARRAY,&amsopt);CHKERRQ(ierr); 16841a1499c8SBarry Smith ierr = PetscMalloc1(*n,(PetscBool**)&amsopt->data);CHKERRQ(ierr); 1685ace3abfcSBarry Smith vals = (PetscBool*)amsopt->data; 16861ae3d29cSBarry Smith for (i=0; i<*n; i++) vals[i] = value[i]; 16871ae3d29cSBarry Smith amsopt->arraylength = *n; 16881ae3d29cSBarry Smith } 1689c5929fdfSBarry Smith ierr = PetscOptionsGetBoolArray(PetscOptionsObject->options,PetscOptionsObject->prefix,opt,value,n,set);CHKERRQ(ierr); 1690e55864a3SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 1691e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s <%d",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",opt+1,value[0]);CHKERRQ(ierr); 1692e2446a98SMatthew Knepley for (i=1; i<*n; i++) { 1693e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm,",%d",value[i]);CHKERRQ(ierr); 1694e2446a98SMatthew Knepley } 1695e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm,">: %s (%s)\n",text,ManSection(man));CHKERRQ(ierr); 1696e2446a98SMatthew Knepley } 1697e2446a98SMatthew Knepley PetscFunctionReturn(0); 1698e2446a98SMatthew Knepley } 1699e2446a98SMatthew Knepley 17008cc676e6SMatthew G Knepley /*@C 1701d1da0b69SBarry Smith PetscOptionsViewer - Gets a viewer appropriate for the type indicated by the user 17028cc676e6SMatthew G Knepley 17038cc676e6SMatthew G Knepley Logically Collective on the communicator passed in PetscOptionsBegin() 17048cc676e6SMatthew G Knepley 17058cc676e6SMatthew G Knepley Input Parameters: 17068cc676e6SMatthew G Knepley + opt - option name 17078cc676e6SMatthew G Knepley . text - short string that describes the option 17088cc676e6SMatthew G Knepley - man - manual page with additional information on option 17098cc676e6SMatthew G Knepley 17108cc676e6SMatthew G Knepley Output Parameter: 17118cc676e6SMatthew G Knepley + viewer - the viewer 17128cc676e6SMatthew G Knepley - set - PETSC_TRUE if found, else PETSC_FALSE 17138cc676e6SMatthew G Knepley 17148cc676e6SMatthew G Knepley Level: beginner 17158cc676e6SMatthew G Knepley 17168cc676e6SMatthew G Knepley Concepts: options database^has int 17178cc676e6SMatthew G Knepley 171895452b02SPatrick Sanan Notes: 171995452b02SPatrick Sanan Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 17208cc676e6SMatthew G Knepley 17215a7113b9SPatrick Sanan See PetscOptionsGetViewer() for the format of the supplied viewer and its options 17228cc676e6SMatthew G Knepley 172389a13869SBarry Smith .seealso: PetscOptionsGetViewer(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 17248cc676e6SMatthew G Knepley PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 17258cc676e6SMatthew G Knepley PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 17268cc676e6SMatthew G Knepley PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 17278cc676e6SMatthew G Knepley PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 17288cc676e6SMatthew G Knepley PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1729a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 17308cc676e6SMatthew G Knepley @*/ 17314416b707SBarry Smith PetscErrorCode PetscOptionsViewer_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscViewer *viewer,PetscViewerFormat *format,PetscBool *set) 17328cc676e6SMatthew G Knepley { 17338cc676e6SMatthew G Knepley PetscErrorCode ierr; 17344416b707SBarry Smith PetscOptionItem amsopt; 17358cc676e6SMatthew G Knepley 17368cc676e6SMatthew G Knepley PetscFunctionBegin; 17371a1499c8SBarry Smith if (!PetscOptionsObject->count) { 17384416b707SBarry Smith ierr = PetscOptionItemCreate_Private(PetscOptionsObject,opt,text,man,OPTION_STRING,&amsopt);CHKERRQ(ierr); 173964facd6cSBarry Smith /* must use system malloc since SAWs may free this */ 17405b02f95dSBarry Smith ierr = PetscStrdup("",(char**)&amsopt->data);CHKERRQ(ierr); 17418cc676e6SMatthew G Knepley } 174216413a6aSBarry Smith ierr = PetscOptionsGetViewer(PetscOptionsObject->comm,PetscOptionsObject->options,PetscOptionsObject->prefix,opt,viewer,format,set);CHKERRQ(ierr); 1743e55864a3SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 1744e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," -%s%s <%s>: %s (%s)\n",PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "",opt+1,"",text,ManSection(man));CHKERRQ(ierr); 17458cc676e6SMatthew G Knepley } 17468cc676e6SMatthew G Knepley PetscFunctionReturn(0); 17478cc676e6SMatthew G Knepley } 17488cc676e6SMatthew G Knepley 174953acd3b1SBarry Smith 175053acd3b1SBarry Smith /*@C 1751b52f573bSBarry Smith PetscOptionsHead - Puts a heading before listing any more published options. Used, for example, 175253acd3b1SBarry Smith in KSPSetFromOptions_GMRES(). 175353acd3b1SBarry Smith 17543f9fe445SBarry Smith Logically Collective on the communicator passed in PetscOptionsBegin() 175553acd3b1SBarry Smith 175653acd3b1SBarry Smith Input Parameter: 175753acd3b1SBarry Smith . head - the heading text 175853acd3b1SBarry Smith 175953acd3b1SBarry Smith 176053acd3b1SBarry Smith Level: intermediate 176153acd3b1SBarry Smith 176295452b02SPatrick Sanan Notes: 176395452b02SPatrick Sanan Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 176453acd3b1SBarry Smith 1765b52f573bSBarry Smith Can be followed by a call to PetscOptionsTail() in the same function. 176653acd3b1SBarry Smith 176753acd3b1SBarry Smith Concepts: options database^subheading 176853acd3b1SBarry Smith 176989a13869SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 1770acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 177153acd3b1SBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 177253acd3b1SBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1773acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1774a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 177553acd3b1SBarry Smith @*/ 17764416b707SBarry Smith PetscErrorCode PetscOptionsHead(PetscOptionItems *PetscOptionsObject,const char head[]) 177753acd3b1SBarry Smith { 177853acd3b1SBarry Smith PetscErrorCode ierr; 177953acd3b1SBarry Smith 178053acd3b1SBarry Smith PetscFunctionBegin; 1781e55864a3SBarry Smith if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) { 1782e55864a3SBarry Smith ierr = (*PetscHelpPrintf)(PetscOptionsObject->comm," %s\n",head);CHKERRQ(ierr); 178353acd3b1SBarry Smith } 178453acd3b1SBarry Smith PetscFunctionReturn(0); 178553acd3b1SBarry Smith } 178653acd3b1SBarry Smith 178753acd3b1SBarry Smith 178853acd3b1SBarry Smith 178953acd3b1SBarry Smith 179053acd3b1SBarry Smith 179153acd3b1SBarry Smith 1792