1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
|
<center><a href="https://gitlab.com/petsc/petsc/-/blob/966382dc56242773704ef5f5cee7aa2db3ebc577/include/petscoptions.h">Actual source code: petscoptions.h</a></center><br>
<html>
<head>
<title></title>
<meta name="generator" content="c2html 0.9.6">
<meta name="date" content="2025-04-30T18:14:50+00:00">
</head>
<body bgcolor="#FFFFFF">
<pre width=80>
<a name="line1"> 1: </a><font color="#B22222">/*</font>
<a name="line2"> 2: </a><font color="#B22222"> Routines to determine options set in the options database.</font>
<a name="line3"> 3: </a><font color="#B22222">*/</font>
<a name="line4"> 4: </a><font color="#A020F0">#pragma once</font>
<a name="line6"> 6: </a>#include <A href="../include/petscsys.h.html"><petscsys.h></A>
<a name="line7"> 7: </a>#include <A href="../include/petscviewertypes.h.html"><petscviewertypes.h></A>
<a name="line9"> 9: </a><font color="#B22222">/* SUBMANSEC = Sys */</font>
<a name="line11"> 11: </a><font color="#4169E1">typedef</font> <font color="#4169E1">enum</font> {
<a name="line12"> 12: </a> PETSC_OPT_CODE,
<a name="line13"> 13: </a> PETSC_OPT_COMMAND_LINE,
<a name="line14"> 14: </a> PETSC_OPT_FILE,
<a name="line15"> 15: </a> PETSC_OPT_ENVIRONMENT,
<a name="line16"> 16: </a> NUM_PETSC_OPT_SOURCE
<a name="line17"> 17: </a>} PetscOptionSource;
<a name="line19"> 19: </a><strong><font color="#228B22">#define PETSC_MAX_OPTION_NAME 512</font></strong>
<a name="line20"> 20: </a><font color="#4169E1">typedef struct _n_PetscOptions *PetscOptions;</font>
<a name="line21"> 21: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsCreate.html">PetscOptionsCreate</a>(PetscOptions *)</font></strong>;
<a name="line22"> 22: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsPush.html">PetscOptionsPush</a>(PetscOptions)</font></strong>;
<a name="line23"> 23: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsPop.html">PetscOptionsPop</a>(void)</font></strong>;
<a name="line24"> 24: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsDestroy.html">PetscOptionsDestroy</a>(PetscOptions *)</font></strong>;
<a name="line25"> 25: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscOptionsCreateDefault(void)</font></strong>;
<a name="line26"> 26: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscOptionsDestroyDefault(void)</font></strong>;
<a name="line28"> 28: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsHasHelp.html">PetscOptionsHasHelp</a>(PetscOptions, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line29"> 29: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsHasName.html">PetscOptionsHasName</a>(PetscOptions, const char[], const char[], <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line30"> 30: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsGetBool.html">PetscOptionsGetBool</a>(PetscOptions, const char[], const char[], <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line31"> 31: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsGetBool3.html">PetscOptionsGetBool3</a>(PetscOptions, const char[], const char[], <a href="../manualpages/Sys/PetscBool3.html">PetscBool3</a> *, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line32"> 32: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>(PetscOptions, const char[], const char[], <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line33"> 33: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsGetMPIInt.html">PetscOptionsGetMPIInt</a>(PetscOptions, const char[], const char[], <a href="../manualpages/Sys/PetscMPIInt.html">PetscMPIInt</a> *, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line34"> 34: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsGetEnum.html">PetscOptionsGetEnum</a>(PetscOptions, const char[], const char[], const char *const *, <a href="../manualpages/Sys/PetscEnum.html">PetscEnum</a> *, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line35"> 35: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsGetEList.html">PetscOptionsGetEList</a>(PetscOptions, const char[], const char[], const char *const *, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line36"> 36: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsGetReal.html">PetscOptionsGetReal</a>(PetscOptions, const char[], const char[], <a href="../manualpages/Sys/PetscReal.html">PetscReal</a> *, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line37"> 37: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsGetScalar.html">PetscOptionsGetScalar</a>(PetscOptions, const char[], const char[], <a href="../manualpages/Sys/PetscScalar.html">PetscScalar</a> *, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line38"> 38: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsGetString.html">PetscOptionsGetString</a>(PetscOptions, const char[], const char[], char[], size_t, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line40"> 40: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsGetBoolArray.html">PetscOptionsGetBoolArray</a>(PetscOptions, const char[], const char[], <a href="../manualpages/Sys/PetscBool.html">PetscBool</a>[], <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line41"> 41: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsGetEnumArray.html">PetscOptionsGetEnumArray</a>(PetscOptions, const char[], const char[], const char *const *, <a href="../manualpages/Sys/PetscEnum.html">PetscEnum</a> *, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line42"> 42: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsGetIntArray.html">PetscOptionsGetIntArray</a>(PetscOptions, const char[], const char[], <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>[], <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line43"> 43: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsGetRealArray.html">PetscOptionsGetRealArray</a>(PetscOptions, const char[], const char[], <a href="../manualpages/Sys/PetscReal.html">PetscReal</a>[], <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line44"> 44: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsGetScalarArray.html">PetscOptionsGetScalarArray</a>(PetscOptions, const char[], const char[], <a href="../manualpages/Sys/PetscScalar.html">PetscScalar</a>[], <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line45"> 45: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsGetStringArray.html">PetscOptionsGetStringArray</a>(PetscOptions, const char[], const char[], char *[], <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line47"> 47: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsValidKey.html">PetscOptionsValidKey</a>(const char[], <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line48"> 48: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsSetAlias.html">PetscOptionsSetAlias</a>(PetscOptions, const char[], const char[])</font></strong>;
<a name="line49"> 49: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsSetValue.html">PetscOptionsSetValue</a>(PetscOptions, const char[], const char[])</font></strong>;
<a name="line50"> 50: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsClearValue.html">PetscOptionsClearValue</a>(PetscOptions, const char[])</font></strong>;
<a name="line51"> 51: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsFindPair.html">PetscOptionsFindPair</a>(PetscOptions, const char[], const char[], const char *[], <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line53"> 53: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsGetAll.html">PetscOptionsGetAll</a>(PetscOptions, char *[])</font></strong>;
<a name="line54"> 54: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsAllUsed.html">PetscOptionsAllUsed</a>(PetscOptions, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *)</font></strong>;
<a name="line55"> 55: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsUsed.html">PetscOptionsUsed</a>(PetscOptions, const char[], <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line56"> 56: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsLeft.html">PetscOptionsLeft</a>(PetscOptions)</font></strong>;
<a name="line57"> 57: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsLeftGet.html">PetscOptionsLeftGet</a>(PetscOptions, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *, char ***, char ***)</font></strong>;
<a name="line58"> 58: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsLeftRestore.html">PetscOptionsLeftRestore</a>(PetscOptions, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *, char ***, char ***)</font></strong>;
<a name="line59"> 59: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsView.html">PetscOptionsView</a>(PetscOptions, <a href="../manualpages/Viewer/PetscViewer.html">PetscViewer</a>)</font></strong>;
<a name="line61"> 61: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsReject.html">PetscOptionsReject</a>(PetscOptions, const char[], const char[], const char[])</font></strong>;
<a name="line62"> 62: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsInsert.html">PetscOptionsInsert</a>(PetscOptions, int *, char ***, const char[])</font></strong>;
<a name="line63"> 63: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsInsertFile.html">PetscOptionsInsertFile</a>(<a href="../manualpages/Sys/MPI_Comm.html">MPI_Comm</a>, PetscOptions, const char[], <a href="../manualpages/Sys/PetscBool.html">PetscBool</a>)</font></strong>;
<a name="line64"> 64: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsInsertFileYAML.html">PetscOptionsInsertFileYAML</a>(<a href="../manualpages/Sys/MPI_Comm.html">MPI_Comm</a>, PetscOptions, const char[], <a href="../manualpages/Sys/PetscBool.html">PetscBool</a>)</font></strong>;
<a name="line65"> 65: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsInsertString.html">PetscOptionsInsertString</a>(PetscOptions, const char[])</font></strong>;
<a name="line66"> 66: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsInsertStringYAML.html">PetscOptionsInsertStringYAML</a>(PetscOptions, const char[])</font></strong>;
<a name="line67"> 67: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsInsertArgs.html">PetscOptionsInsertArgs</a>(PetscOptions, int, const char *const *)</font></strong>;
<a name="line68"> 68: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsClear.html">PetscOptionsClear</a>(PetscOptions)</font></strong>;
<a name="line69"> 69: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsPrefixPush.html">PetscOptionsPrefixPush</a>(PetscOptions, const char[])</font></strong>;
<a name="line70"> 70: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsPrefixPop.html">PetscOptionsPrefixPop</a>(PetscOptions)</font></strong>;
<a name="line72"> 72: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsGetenv.html">PetscOptionsGetenv</a>(<a href="../manualpages/Sys/MPI_Comm.html">MPI_Comm</a>, const char[], char[], size_t, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line73"> 73: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscOptionsStringToBool(const char[], <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line74"> 74: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscOptionsStringToInt(const char[], <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *)</font></strong>;
<a name="line75"> 75: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscOptionsStringToReal(const char[], <a href="../manualpages/Sys/PetscReal.html">PetscReal</a> *)</font></strong>;
<a name="line76"> 76: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscOptionsStringToScalar(const char[], <a href="../manualpages/Sys/PetscScalar.html">PetscScalar</a> *)</font></strong>;
<a name="line78"> 78: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsMonitorSet.html">PetscOptionsMonitorSet</a>(<a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> (*)(const char[], const char[], PetscOptionSource, void *), void *, <a href="../manualpages/Sys/PetscCtxDestroyFn.html">PetscCtxDestroyFn</a> *)</font></strong>;
<a name="line79"> 79: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsMonitorDefault.html">PetscOptionsMonitorDefault</a>(const char[], const char[], PetscOptionSource, void *)</font></strong>;
<a name="line81"> 81: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscObjectSetOptions.html">PetscObjectSetOptions</a>(<a href="../manualpages/Sys/PetscObject.html">PetscObject</a>, PetscOptions)</font></strong>;
<a name="line82"> 82: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscObjectGetOptions.html">PetscObjectGetOptions</a>(<a href="../manualpages/Sys/PetscObject.html">PetscObject</a>, PetscOptions *)</font></strong>;
<a name="line84"> 84: </a>PETSC_EXTERN <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> PetscOptionsPublish;
<a name="line86"> 86: </a><font color="#B22222">/*</font>
<a name="line87"> 87: </a><font color="#B22222"> See manual page for <a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()</font>
<a name="line89"> 89: </a><font color="#B22222"> PetscOptionsItem and PetscOptionsItems are a single option (such as ksp_type) and a collection of such single</font>
<a name="line90"> 90: </a><font color="#B22222"> options being handled with a <a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>/End()</font>
<a name="line92"> 92: </a><font color="#B22222">*/</font>
<a name="line93"> 93: </a><font color="#4169E1">typedef</font> <font color="#4169E1">enum</font> {
<a name="line94"> 94: </a> OPTION_INT,
<a name="line95"> 95: </a> OPTION_BOOL,
<a name="line96"> 96: </a> OPTION_REAL,
<a name="line97"> 97: </a> OPTION_FLIST,
<a name="line98"> 98: </a> OPTION_STRING,
<a name="line99"> 99: </a> OPTION_REAL_ARRAY,
<a name="line100">100: </a> OPTION_SCALAR_ARRAY,
<a name="line101">101: </a> OPTION_HEAD,
<a name="line102">102: </a> OPTION_INT_ARRAY,
<a name="line103">103: </a> OPTION_ELIST,
<a name="line104">104: </a> OPTION_BOOL_ARRAY,
<a name="line105">105: </a> OPTION_STRING_ARRAY
<a name="line106">106: </a>} PetscOptionType;
<a name="line108">108: </a><font color="#4169E1">typedef struct _n_PetscOptionItem *PetscOptionItem;</font>
<a name="line109">109: </a><font color="#4169E1"><a name="_n_PetscOptionItem"></a>struct _n_PetscOptionItem </font>{
<a name="line110">110: </a> char *option;
<a name="line111">111: </a> char *text;
<a name="line112">112: </a> void *data; <font color="#B22222">/* used to hold the default value and then any value it is changed to by GUI */</font>
<a name="line113">113: </a> <a href="../manualpages/Sys/PetscFunctionList.html">PetscFunctionList</a> flist; <font color="#B22222">/* used for available values for PetscOptionsList() */</font>
<a name="line114">114: </a> const char *const *list; <font color="#B22222">/* used for available values for <a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>() */</font>
<a name="line115">115: </a> char nlist; <font color="#B22222">/* number of entries in list */</font>
<a name="line116">116: </a> char *man;
<a name="line117">117: </a> <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> arraylength; <font color="#B22222">/* number of entries in data in the case that it is an array (of <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> etc), never a giant value */</font>
<a name="line118">118: </a> <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> set; <font color="#B22222">/* the user has changed this value in the GUI */</font>
<a name="line119">119: </a> PetscOptionType type;
<a name="line120">120: </a> PetscOptionItem next;
<a name="line121">121: </a> char *pman;
<a name="line122">122: </a> void *edata;
<a name="line123">123: </a>};
<a name="line125">125: </a><font color="#4169E1">typedef struct _n_PetscOptionItems *PetscOptionItems;</font>
<a name="line126">126: </a><font color="#4169E1"><a name="_n_PetscOptionItems"></a>struct _n_PetscOptionItems </font>{
<a name="line127">127: </a> <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> count;
<a name="line128">128: </a> PetscOptionItem next;
<a name="line129">129: </a> char *prefix, *pprefix;
<a name="line130">130: </a> char *title;
<a name="line131">131: </a> <a href="../manualpages/Sys/MPI_Comm.html">MPI_Comm</a> comm;
<a name="line132">132: </a> <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> printhelp, changedmethod, alreadyprinted;
<a name="line133">133: </a> <a href="../manualpages/Sys/PetscObject.html">PetscObject</a> object;
<a name="line134">134: </a> PetscOptions options;
<a name="line135">135: </a>};
<a name="line137">137: </a><font color="#A020F0">#if defined(PETSC_CLANG_STATIC_ANALYZER)</font>
<a name="line138">138: </a>extern PetscOptionItems PetscOptionsObject; <font color="#B22222">/* declare this so that the PetscOptions stubs work */</font>
<a name="line139">139: </a><strong><font color="#4169E1"><a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>(<a href="../manualpages/Sys/MPI_Comm.html">MPI_Comm</a>, const char *, const char *, const char *)</font></strong>;
<a name="line140">140: </a><strong><font color="#4169E1"><a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscObjectOptionsBegin.html">PetscObjectOptionsBegin</a>(<a href="../manualpages/Sys/PetscObject.html">PetscObject</a>)</font></strong>;
<a name="line141">141: </a><strong><font color="#4169E1"><a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>(void)</font></strong>;
<a name="line142">142: </a><font color="#A020F0">#else</font>
<a name="line143">143: </a> <font color="#B22222">/*MC</font>
<a name="line144">144: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a> - Begins a set of queries on the options database that are related and should be</font>
<a name="line145">145: </a><font color="#B22222"> displayed on the same window of a GUI that allows the user to set the options interactively. Often one should</font>
<a name="line146">146: </a><font color="#B22222"> use `<a href="../manualpages/Sys/PetscObjectOptionsBegin.html">PetscObjectOptionsBegin</a>()` rather than this call.</font>
<a name="line148">148: </a><font color="#B22222"> Synopsis:</font>
<a name="line149">149: </a>#include <A href="../include/petscoptions.h.html"><petscoptions.h></A>
<a name="line150">150: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>(<a href="../manualpages/Sys/MPI_Comm.html">MPI_Comm</a> comm,const char prefix[],const char title[],const char mansec[])</font>
<a name="line152">152: </a><font color="#B22222"> Collective</font>
<a name="line154">154: </a><font color="#B22222"> Input Parameters:</font>
<a name="line155">155: </a><font color="#B22222">+ comm - communicator that shares GUI</font>
<a name="line156">156: </a><font color="#B22222">. prefix - options prefix for all options displayed on window (optional)</font>
<a name="line157">157: </a><font color="#B22222">. title - short descriptive text, for example "Krylov Solver Options"</font>
<a name="line158">158: </a><font color="#B22222">- mansec - section of manual pages for options, for example `<a href="../manualpages/KSP/KSP.html">KSP</a>` (optional)</font>
<a name="line160">160: </a><font color="#B22222"> Level: intermediate</font>
<a name="line162">162: </a><font color="#B22222"> Notes:</font>
<a name="line163">163: </a><font color="#B22222"> This is a macro that handles its own error checking, it does not return an error code.</font>
<a name="line165">165: </a><font color="#B22222"> The set of queries needs to be ended by a call to `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`.</font>
<a name="line167">167: </a><font color="#B22222"> One can add subheadings with `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`.</font>
<a name="line169">169: </a><font color="#B22222"> Developer Notes:</font>
<a name="line170">170: </a><font color="#B22222"> `PetscOptionsPublish` is set in `PetscOptionsCheckInitial_Private()` with `-saws_options`. When `PetscOptionsPublish` is set the</font>
<a name="line171">171: </a><font color="#B22222"> loop between `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` and `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()` is run THREE times with `PetscOptionsPublishCount` of values -1,0,1.</font>
<a name="line172">172: </a><font color="#B22222"> Otherwise the loop is run ONCE with a `PetscOptionsPublishCount` of 1.</font>
<a name="line173">173: </a><font color="#B22222">+ \-1 - `<a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a>()` etc. just call `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()` etc.</font>
<a name="line174">174: </a><font color="#B22222">. 0 - The GUI objects are created in `<a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a>()` etc. and displayed in `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()` and the options</font>
<a name="line175">175: </a><font color="#B22222"> database updated with user changes; `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()` etc. are also called.</font>
<a name="line176">176: </a><font color="#B22222">- 1 - `<a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a>()` etc. again call `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()` etc. (possibly getting new values), in addition the help message and</font>
<a name="line177">177: </a><font color="#B22222"> default values are printed if -help was given.</font>
<a name="line178">178: </a><font color="#B22222"> When `PetscOptionsObject.changedmethod` is set this causes `PetscOptionsPublishCount` to be reset to -2 (so in the next loop iteration it is -1)</font>
<a name="line179">179: </a><font color="#B22222"> and the whole process is repeated. This is to handle when, for example, the `<a href="../manualpages/KSP/KSPType.html">KSPType</a>` is changed thus changing the list of</font>
<a name="line180">180: </a><font color="#B22222"> options available so they need to be redisplayed so the user can change the. Changing `PetscOptionsObjects.changedmethod` is never</font>
<a name="line181">181: </a><font color="#B22222"> currently set.</font>
<a name="line183">183: </a><font color="#B22222"> Fortran Note:</font>
<a name="line184">184: </a><font color="#B22222"> Returns ierr error code as the final argument per PETSc Fortran API</font>
<a name="line186">186: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsGetReal.html">PetscOptionsGetReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsHasName.html">PetscOptionsHasName</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetString.html">PetscOptionsGetString</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()`,</font>
<a name="line187">187: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsGetIntArray.html">PetscOptionsGetIntArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetRealArray.html">PetscOptionsGetRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`</font>
<a name="line188">188: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsString.html">PetscOptionsString</a>()`, `<a href="../manualpages/Sys/PetscOptionsReal.html">PetscOptionsReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`,</font>
<a name="line189">189: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`,</font>
<a name="line190">190: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`,</font>
<a name="line191">191: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`,</font>
<a name="line192">192: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>()`, `<a href="../manualpages/Sys/PetscObjectOptionsBegin.html">PetscObjectOptionsBegin</a>()`</font>
<a name="line193">193: </a><font color="#B22222">M*/</font>
<a name="line194">194: </a><strong><font color="#228B22"> #define <a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>(comm, prefix, mess, sec) \</font></strong>
<a name="line195">195: </a><strong><font color="#228B22"> do { \</font></strong>
<a name="line196">196: </a><strong><font color="#228B22"> struct _n_PetscOptionItems PetscOptionsObjectBase; \</font></strong>
<a name="line197">197: </a><strong><font color="#228B22"> PetscOptionItems PetscOptionsObject = &PetscOptionsObjectBase; \</font></strong>
<a name="line198">198: </a><strong><font color="#228B22"> <a href="../manualpages/Sys/PetscCall.html">PetscCall</a>(<a href="../manualpages/Sys/PetscMemzero.html">PetscMemzero</a>(PetscOptionsObject, sizeof(*PetscOptionsObject))); \</font></strong>
<a name="line199">199: </a><strong><font color="#228B22"> for (PetscOptionsObject->count = (PetscOptionsPublish ? -1 : 1); PetscOptionsObject->count < 2; PetscOptionsObject->count++) { \</font></strong>
<a name="line200">200: </a><strong><font color="#228B22"> <a href="../manualpages/Sys/PetscCall.html">PetscCall</a>(PetscOptionsBegin_Private(PetscOptionsObject, comm, prefix, mess, sec))</font></strong>
<a name="line202">202: </a> <font color="#B22222">/*MC</font>
<a name="line203">203: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscObjectOptionsBegin.html">PetscObjectOptionsBegin</a> - Begins a set of queries on the options database that are related and should be</font>
<a name="line204">204: </a><font color="#B22222"> displayed on the same window of a GUI that allows the user to set the options interactively.</font>
<a name="line206">206: </a><font color="#B22222"> Synopsis:</font>
<a name="line207">207: </a>#include <A href="../include/petscoptions.h.html"><petscoptions.h></A>
<a name="line208">208: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscObjectOptionsBegin.html">PetscObjectOptionsBegin</a>(<a href="../manualpages/Sys/PetscObject.html">PetscObject</a> obj)</font>
<a name="line210">210: </a><font color="#B22222"> Collective</font>
<a name="line212">212: </a><font color="#B22222"> Input Parameter:</font>
<a name="line213">213: </a><font color="#B22222">. obj - object to set options for</font>
<a name="line215">215: </a><font color="#B22222"> Level: intermediate</font>
<a name="line217">217: </a><font color="#B22222"> Notes:</font>
<a name="line218">218: </a><font color="#B22222"> This is a macro that handles its own error checking, it does not return an error code.</font>
<a name="line220">220: </a><font color="#B22222"> Needs to be ended by a call the `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`</font>
<a name="line222">222: </a><font color="#B22222"> Can add subheadings with `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`</font>
<a name="line224">224: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsGetReal.html">PetscOptionsGetReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsHasName.html">PetscOptionsHasName</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetString.html">PetscOptionsGetString</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()`,</font>
<a name="line225">225: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsGetIntArray.html">PetscOptionsGetIntArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetRealArray.html">PetscOptionsGetRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`</font>
<a name="line226">226: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsString.html">PetscOptionsString</a>()`, `<a href="../manualpages/Sys/PetscOptionsReal.html">PetscOptionsReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`,</font>
<a name="line227">227: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>()`, `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`,</font>
<a name="line228">228: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`,</font>
<a name="line229">229: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`,</font>
<a name="line230">230: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>()`</font>
<a name="line231">231: </a><font color="#B22222">M*/</font>
<a name="line232">232: </a><strong><font color="#228B22"> #define <a href="../manualpages/Sys/PetscObjectOptionsBegin.html">PetscObjectOptionsBegin</a>(obj) \</font></strong>
<a name="line233">233: </a><strong><font color="#228B22"> do { \</font></strong>
<a name="line234">234: </a><strong><font color="#228B22"> struct _n_PetscOptionItems PetscOptionsObjectBase; \</font></strong>
<a name="line235">235: </a><strong><font color="#228B22"> PetscOptionItems PetscOptionsObject = &PetscOptionsObjectBase; \</font></strong>
<a name="line236">236: </a><strong><font color="#228B22"> PetscOptionsObject->options = ((<a href="../manualpages/Sys/PetscObject.html">PetscObject</a>)obj)->options; \</font></strong>
<a name="line237">237: </a><strong><font color="#228B22"> for (PetscOptionsObject->count = (PetscOptionsPublish ? -1 : 1); PetscOptionsObject->count < 2; PetscOptionsObject->count++) { \</font></strong>
<a name="line238">238: </a><strong><font color="#228B22"> <a href="../manualpages/Sys/PetscCall.html">PetscCall</a>(PetscObjectOptionsBegin_Private(obj, PetscOptionsObject))</font></strong>
<a name="line240">240: </a> <font color="#B22222">/*MC</font>
<a name="line241">241: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a> - Ends a set of queries on the options database that are related and should be</font>
<a name="line242">242: </a><font color="#B22222"> displayed on the same window of a GUI that allows the user to set the options interactively.</font>
<a name="line244">244: </a><font color="#B22222"> Synopsis:</font>
<a name="line245">245: </a>#include <A href="../include/petscoptions.h.html"><petscoptions.h></A>
<a name="line246">246: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>(void)</font>
<a name="line248">248: </a><font color="#B22222"> Collective on the comm used in `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` or obj used in `<a href="../manualpages/Sys/PetscObjectOptionsBegin.html">PetscObjectOptionsBegin</a>()`</font>
<a name="line250">250: </a><font color="#B22222"> Level: intermediate</font>
<a name="line252">252: </a><font color="#B22222"> Notes:</font>
<a name="line253">253: </a><font color="#B22222"> Needs to be preceded by a call to `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` or `<a href="../manualpages/Sys/PetscObjectOptionsBegin.html">PetscObjectOptionsBegin</a>()`</font>
<a name="line255">255: </a><font color="#B22222"> This is a macro that handles its own error checking, it does not return an error code.</font>
<a name="line257">257: </a><font color="#B22222"> Fortran Note:</font>
<a name="line258">258: </a><font color="#B22222"> Returns ierr error code as the final argument per PETSc Fortran API</font>
<a name="line260">260: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsGetReal.html">PetscOptionsGetReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsHasName.html">PetscOptionsHasName</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetString.html">PetscOptionsGetString</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()`,</font>
<a name="line261">261: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsGetIntArray.html">PetscOptionsGetIntArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetRealArray.html">PetscOptionsGetRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`</font>
<a name="line262">262: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsString.html">PetscOptionsString</a>()`, `<a href="../manualpages/Sys/PetscOptionsReal.html">PetscOptionsReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`,</font>
<a name="line263">263: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>()`, `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`,</font>
<a name="line264">264: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`,</font>
<a name="line265">265: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`,</font>
<a name="line266">266: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>()`, `<a href="../manualpages/Sys/PetscObjectOptionsBegin.html">PetscObjectOptionsBegin</a>()`</font>
<a name="line267">267: </a><font color="#B22222">M*/</font>
<a name="line268">268: </a><strong><font color="#228B22"> #define <a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>() \</font></strong>
<a name="line269">269: </a><strong><font color="#228B22"> <a href="../manualpages/Sys/PetscCall.html">PetscCall</a>(PetscOptionsEnd_Private(PetscOptionsObject)); \</font></strong>
<a name="line270">270: </a><strong><font color="#228B22"> } \</font></strong>
<a name="line271">271: </a><strong><font color="#228B22"> } \</font></strong>
<a name="line272">272: </a><strong><font color="#228B22"> while (0)</font></strong>
<a name="line273">273: </a><font color="#A020F0">#endif </font><font color="#B22222">/* PETSC_CLANG_STATIC_ANALYZER */</font><font color="#A020F0"></font>
<a name="line275">275: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscOptionsBegin_Private(PetscOptionItems, <a href="../manualpages/Sys/MPI_Comm.html">MPI_Comm</a>, const char[], const char[], const char[])</font></strong>;
<a name="line276">276: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscObjectOptionsBegin_Private(<a href="../manualpages/Sys/PetscObject.html">PetscObject</a>, PetscOptionItems)</font></strong>;
<a name="line277">277: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscOptionsEnd_Private(PetscOptionItems)</font></strong>;
<a name="line278">278: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>(PetscOptionItems, const char[])</font></strong>;
<a name="line280">280: </a><font color="#A020F0">#if defined(PETSC_CLANG_STATIC_ANALYZER)</font>
<a name="line281">281: </a>template <typename... T>
<a name="line282">282: </a><strong><font color="#4169E1">void <a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>(T...)</font></strong>;
<a name="line283">283: </a><strong><font color="#4169E1">void <a href="../manualpages/Sys/PetscOptionsHeadEnd.html">PetscOptionsHeadEnd</a>(void)</font></strong>;
<a name="line284">284: </a>template <typename... T>
<a name="line285">285: </a><strong><font color="#4169E1"><a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsEnum.html">PetscOptionsEnum</a>(T...)</font></strong>;
<a name="line286">286: </a>template <typename... T>
<a name="line287">287: </a><strong><font color="#4169E1"><a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a>(T...)</font></strong>;
<a name="line288">288: </a>template <typename... T>
<a name="line289">289: </a><strong><font color="#4169E1"><a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsBoundedInt.html">PetscOptionsBoundedInt</a>(T...)</font></strong>;
<a name="line290">290: </a>template <typename... T>
<a name="line291">291: </a><strong><font color="#4169E1"><a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsRangeInt.html">PetscOptionsRangeInt</a>(T...)</font></strong>;
<a name="line292">292: </a>template <typename... T>
<a name="line293">293: </a><strong><font color="#4169E1"><a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsReal.html">PetscOptionsReal</a>(T...)</font></strong>;
<a name="line294">294: </a>template <typename... T>
<a name="line295">295: </a><strong><font color="#4169E1"><a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>(T...)</font></strong>;
<a name="line296">296: </a>template <typename... T>
<a name="line297">297: </a><strong><font color="#4169E1"><a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>(T...)</font></strong>;
<a name="line298">298: </a>template <typename... T>
<a name="line299">299: </a><strong><font color="#4169E1"><a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsString.html">PetscOptionsString</a>(T...)</font></strong>;
<a name="line300">300: </a>template <typename... T>
<a name="line301">301: </a><strong><font color="#4169E1"><a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>(T...)</font></strong>;
<a name="line302">302: </a>template <typename... T>
<a name="line303">303: </a><strong><font color="#4169E1"><a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>(T...)</font></strong>;
<a name="line304">304: </a>template <typename... T>
<a name="line305">305: </a><strong><font color="#4169E1"><a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>(T...)</font></strong>;
<a name="line306">306: </a>template <typename... T>
<a name="line307">307: </a><strong><font color="#4169E1"><a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>(T...)</font></strong>;
<a name="line308">308: </a>template <typename... T>
<a name="line309">309: </a><strong><font color="#4169E1"><a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>(T...)</font></strong>;
<a name="line310">310: </a>template <typename... T>
<a name="line311">311: </a><strong><font color="#4169E1"><a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>(T...)</font></strong>;
<a name="line312">312: </a>template <typename... T>
<a name="line313">313: </a><strong><font color="#4169E1"><a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>(T...)</font></strong>;
<a name="line314">314: </a>template <typename... T>
<a name="line315">315: </a><strong><font color="#4169E1"><a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsScalarArray.html">PetscOptionsScalarArray</a>(T...)</font></strong>;
<a name="line316">316: </a>template <typename... T>
<a name="line317">317: </a><strong><font color="#4169E1"><a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsIntArray.html">PetscOptionsIntArray</a>(T...)</font></strong>;
<a name="line318">318: </a>template <typename... T>
<a name="line319">319: </a><strong><font color="#4169E1"><a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>(T...)</font></strong>;
<a name="line320">320: </a>template <typename... T>
<a name="line321">321: </a><strong><font color="#4169E1"><a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsBoolArray.html">PetscOptionsBoolArray</a>(T...)</font></strong>;
<a name="line322">322: </a>template <typename... T>
<a name="line323">323: </a><strong><font color="#4169E1"><a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsEnumArray.html">PetscOptionsEnumArray</a>(T...)</font></strong>;
<a name="line324">324: </a>template <typename... T>
<a name="line325">325: </a><strong><font color="#4169E1"><a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsDeprecated.html">PetscOptionsDeprecated</a>(T...)</font></strong>;
<a name="line326">326: </a>template <typename... T>
<a name="line327">327: </a><strong><font color="#4169E1"><a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscOptionsDeprecatedNoObject(T...)</font></strong>;
<a name="line328">328: </a><font color="#A020F0">#else</font>
<a name="line329">329: </a> <font color="#B22222">/*MC</font>
<a name="line330">330: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a> - Puts a heading before listing any more published options. Used, for example,</font>
<a name="line331">331: </a><font color="#B22222"> in `KSPSetFromOptions_GMRES()`.</font>
<a name="line333">333: </a><font color="#B22222"> Logically Collective on the communicator passed in `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`</font>
<a name="line335">335: </a><font color="#B22222"> Input Parameter:</font>
<a name="line336">336: </a><font color="#B22222">. head - the heading text</font>
<a name="line338">338: </a><font color="#B22222"> Level: developer</font>
<a name="line340">340: </a><font color="#B22222"> Notes:</font>
<a name="line341">341: </a><font color="#B22222"> Handles errors directly, hence does not return an error code</font>
<a name="line343">343: </a><font color="#B22222"> Must be between a `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` and a `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, and `PetscOptionsObject` created in `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` should be the first argument</font>
<a name="line345">345: </a><font color="#B22222"> Must be followed by a call to `<a href="../manualpages/Sys/PetscOptionsHeadEnd.html">PetscOptionsHeadEnd</a>()` in the same function.</font>
<a name="line347">347: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetReal.html">PetscOptionsGetReal</a>()`,</font>
<a name="line348">348: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsHasName.html">PetscOptionsHasName</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetIntArray.html">PetscOptionsGetIntArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetRealArray.html">PetscOptionsGetRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`,</font>
<a name="line349">349: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>()`, `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`,</font>
<a name="line350">350: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`,</font>
<a name="line351">351: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`,</font>
<a name="line352">352: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>()`</font>
<a name="line353">353: </a><font color="#B22222">M*/</font>
<a name="line354">354: </a><strong><font color="#228B22"> #define <a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>(PetscOptionsObject, head) \</font></strong>
<a name="line355">355: </a><strong><font color="#228B22"> do { \</font></strong>
<a name="line356">356: </a><strong><font color="#228B22"> if (PetscOptionsObject->printhelp && PetscOptionsObject->count == 1 && !PetscOptionsObject->alreadyprinted) <a href="../manualpages/Sys/PetscCall.html">PetscCall</a>((*<a href="../manualpages/Sys/PetscHelpPrintf.html">PetscHelpPrintf</a>)(PetscOptionsObject->comm, </font><font color="#666666">" %s\n"</font><font color="#228B22">, head)); \</font></strong>
<a name="line357">357: </a><strong><font color="#228B22"> } while (0)</font></strong>
<a name="line359">359: </a><strong><font color="#228B22"> #define PetscOptionsHead(...) PETSC_DEPRECATED_MACRO(3, 18, 0, </font><font color="#666666">"<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()"</font><font color="#228B22">, ) <a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>(__VA_ARGS__)</font></strong>
<a name="line361">361: </a> <font color="#B22222">/*MC</font>
<a name="line362">362: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsHeadEnd.html">PetscOptionsHeadEnd</a> - Ends a section of options begun with `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`</font>
<a name="line363">363: </a><font color="#B22222"> See, for example, `KSPSetFromOptions_GMRES()`.</font>
<a name="line365">365: </a><font color="#B22222"> Synopsis:</font>
<a name="line366">366: </a>#include <A href="../include/petscoptions.h.html"><petscoptions.h></A>
<a name="line367">367: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsHeadEnd.html">PetscOptionsHeadEnd</a>(void)</font>
<a name="line369">369: </a><font color="#B22222"> Collective on the comm used in `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` or obj used in `<a href="../manualpages/Sys/PetscObjectOptionsBegin.html">PetscObjectOptionsBegin</a>()`</font>
<a name="line371">371: </a><font color="#B22222"> Level: intermediate</font>
<a name="line373">373: </a><font color="#B22222"> Notes:</font>
<a name="line374">374: </a><font color="#B22222"> Must be between a `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` or `<a href="../manualpages/Sys/PetscObjectOptionsBegin.html">PetscObjectOptionsBegin</a>()` and a `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`</font>
<a name="line376">376: </a><font color="#B22222"> Must be preceded by a call to `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()` in the same function.</font>
<a name="line378">378: </a><font color="#B22222"> This needs to be used only if the code below `<a href="../manualpages/Sys/PetscOptionsHeadEnd.html">PetscOptionsHeadEnd</a>()` can be run ONLY once.</font>
<a name="line379">379: </a><font color="#B22222"> See, for example, `PCSetFromOptions_Composite()`. This is a `return(0)` in it for early exit</font>
<a name="line380">380: </a><font color="#B22222"> from the function.</font>
<a name="line382">382: </a><font color="#B22222"> This is only for use with the PETSc options GUI</font>
<a name="line384">384: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetReal.html">PetscOptionsGetReal</a>()`,</font>
<a name="line385">385: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsHasName.html">PetscOptionsHasName</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetIntArray.html">PetscOptionsGetIntArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetRealArray.html">PetscOptionsGetRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`,</font>
<a name="line386">386: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>()`, `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`,</font>
<a name="line387">387: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`,</font>
<a name="line388">388: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`,</font>
<a name="line389">389: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnum.html">PetscOptionsEnum</a>()`</font>
<a name="line390">390: </a><font color="#B22222">M*/</font>
<a name="line391">391: </a><strong><font color="#228B22"> #define <a href="../manualpages/Sys/PetscOptionsHeadEnd.html">PetscOptionsHeadEnd</a>() \</font></strong>
<a name="line392">392: </a><strong><font color="#228B22"> do { \</font></strong>
<a name="line393">393: </a><strong><font color="#228B22"> if (PetscOptionsObject->count != 1) <a href="../manualpages/Sys/PetscFunctionReturn.html">PetscFunctionReturn</a>(<a href="../manualpages/Sys/PetscErrorCode.html">PETSC_SUCCESS</a>); \</font></strong>
<a name="line394">394: </a><strong><font color="#228B22"> } while (0)</font></strong>
<a name="line396">396: </a><strong><font color="#228B22"> #define PetscOptionsTail(...) PETSC_DEPRECATED_MACRO(3, 18, 0, </font><font color="#666666">"<a href="../manualpages/Sys/PetscOptionsHeadEnd.html">PetscOptionsHeadEnd</a>()"</font><font color="#228B22">, ) <a href="../manualpages/Sys/PetscOptionsHeadEnd.html">PetscOptionsHeadEnd</a>(__VA_ARGS__)</font></strong>
<a name="line398">398: </a><font color="#B22222">/*MC</font>
<a name="line399">399: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsEnum.html">PetscOptionsEnum</a> - Gets the enum value for a particular option in the database.</font>
<a name="line401">401: </a><font color="#B22222"> Synopsis:</font>
<a name="line402">402: </a>#include <A href="../include/petscoptions.h.html"><petscoptions.h></A>
<a name="line403">403: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsEnum.html">PetscOptionsEnum</a>(const char opt[], const char text[], const char man[], const char *const *list, <a href="../manualpages/Sys/PetscEnum.html">PetscEnum</a> currentvalue, <a href="../manualpages/Sys/PetscEnum.html">PetscEnum</a> *value, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *set)</font>
<a name="line405">405: </a><font color="#B22222"> Logically Collective on the communicator passed in `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`</font>
<a name="line407">407: </a><font color="#B22222"> Input Parameters:</font>
<a name="line408">408: </a><font color="#B22222">+ opt - option name</font>
<a name="line409">409: </a><font color="#B22222">. text - short string that describes the option</font>
<a name="line410">410: </a><font color="#B22222">. man - manual page with additional information on option</font>
<a name="line411">411: </a><font color="#B22222">. list - array containing the list of choices, followed by the enum name, followed by the enum prefix, followed by a null</font>
<a name="line412">412: </a><font color="#B22222">- currentvalue - the current value; caller is responsible for setting this value correctly. Normally this is done with either</font>
<a name="line413">413: </a><font color="#B22222">.vb</font>
<a name="line414">414: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsEnum.html">PetscOptionsEnum</a>(..., obj->value,&object->value,...) or</font>
<a name="line415">415: </a><font color="#B22222"> value = defaultvalue</font>
<a name="line416">416: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsEnum.html">PetscOptionsEnum</a>(..., value,&value,&set);</font>
<a name="line417">417: </a><font color="#B22222"> if (set) {</font>
<a name="line418">418: </a><font color="#B22222">.ve</font>
<a name="line420">420: </a><font color="#B22222"> Output Parameters:</font>
<a name="line421">421: </a><font color="#B22222">+ value - the value to return</font>
<a name="line422">422: </a><font color="#B22222">- set - `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>` if found, else `<a href="../manualpages/Sys/PETSC_FALSE.html">PETSC_FALSE</a>`</font>
<a name="line424">424: </a><font color="#B22222"> Level: beginner</font>
<a name="line426">426: </a><font color="#B22222"> Notes:</font>
<a name="line427">427: </a><font color="#B22222"> Must be between a `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` and a `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`</font>
<a name="line429">429: </a><font color="#B22222"> `list` is usually something like `PCASMTypes` or some other predefined list of enum names</font>
<a name="line431">431: </a><font color="#B22222"> If the user does not supply the option at all `value` is NOT changed. Thus</font>
<a name="line432">432: </a><font color="#B22222"> you should ALWAYS initialize `value` if you access it without first checking that `set` is `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>`.</font>
<a name="line434">434: </a><font color="#B22222"> The `currentvalue` passed into this routine does not get transferred to the output `value` variable automatically.</font>
<a name="line436">436: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsGetReal.html">PetscOptionsGetReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsHasName.html">PetscOptionsHasName</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetString.html">PetscOptionsGetString</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()`,</font>
<a name="line437">437: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsGetIntArray.html">PetscOptionsGetIntArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetRealArray.html">PetscOptionsGetRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetBool.html">PetscOptionsGetBool</a>()`,</font>
<a name="line438">438: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsString.html">PetscOptionsString</a>()`, `<a href="../manualpages/Sys/PetscOptionsReal.html">PetscOptionsReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`,</font>
<a name="line439">439: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>()`, `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`,</font>
<a name="line440">440: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`,</font>
<a name="line441">441: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`,</font>
<a name="line442">442: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>()`</font>
<a name="line443">443: </a><font color="#B22222">M*/</font>
<a name="line444">444: </a><strong><font color="#228B22"> #define <a href="../manualpages/Sys/PetscOptionsEnum.html">PetscOptionsEnum</a>(opt, text, man, list, currentvalue, value, set) PetscOptionsEnum_Private(PetscOptionsObject, opt, text, man, list, currentvalue, value, set)</font></strong>
<a name="line446">446: </a><font color="#B22222">/*MC</font>
<a name="line447">447: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a> - Gets the integer value for a particular option in the database.</font>
<a name="line449">449: </a><font color="#B22222"> Synopsis:</font>
<a name="line450">450: </a>#include <A href="../include/petscoptions.h.html"><petscoptions.h></A>
<a name="line451">451: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a>(const char opt[], const char text[], const char man[], <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> currentvalue, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *value, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *set)</font>
<a name="line453">453: </a><font color="#B22222"> Logically Collective on the communicator passed in `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`</font>
<a name="line455">455: </a><font color="#B22222"> Input Parameters:</font>
<a name="line456">456: </a><font color="#B22222">+ opt - option name</font>
<a name="line457">457: </a><font color="#B22222">. text - short string that describes the option</font>
<a name="line458">458: </a><font color="#B22222">. man - manual page with additional information on option</font>
<a name="line459">459: </a><font color="#B22222">- currentvalue - the current value; caller is responsible for setting this value correctly. Normally this is done with either</font>
<a name="line460">460: </a><font color="#B22222">.vb</font>
<a name="line461">461: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a>(..., obj->value, &obj->value, ...) or</font>
<a name="line462">462: </a><font color="#B22222"> value = defaultvalue</font>
<a name="line463">463: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a>(..., value, &value, &set);</font>
<a name="line464">464: </a><font color="#B22222"> if (set) {</font>
<a name="line465">465: </a><font color="#B22222">.ve</font>
<a name="line467">467: </a><font color="#B22222"> Output Parameters:</font>
<a name="line468">468: </a><font color="#B22222">+ value - the integer value to return</font>
<a name="line469">469: </a><font color="#B22222">- set - `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>` if found, else `<a href="../manualpages/Sys/PETSC_FALSE.html">PETSC_FALSE</a>`</font>
<a name="line471">471: </a><font color="#B22222"> Level: beginner</font>
<a name="line473">473: </a><font color="#B22222"> Notes:</font>
<a name="line474">474: </a><font color="#B22222"> If the user does not supply the option at all `value` is NOT changed. Thus</font>
<a name="line475">475: </a><font color="#B22222"> you should ALWAYS initialize `value` if you access it without first checking that `set` is `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>`.</font>
<a name="line477">477: </a><font color="#B22222"> The `currentvalue` passed into this routine does not get transferred to the output `value` variable automatically.</font>
<a name="line479">479: </a><font color="#B22222"> Must be between a `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` and a `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`</font>
<a name="line481">481: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsBoundedInt.html">PetscOptionsBoundedInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetReal.html">PetscOptionsGetReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsHasName.html">PetscOptionsHasName</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetString.html">PetscOptionsGetString</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()`,</font>
<a name="line482">482: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsGetIntArray.html">PetscOptionsGetIntArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetRealArray.html">PetscOptionsGetRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetBool.html">PetscOptionsGetBool</a>()`, `<a href="../manualpages/Sys/PetscOptionsRangeInt.html">PetscOptionsRangeInt</a>()`</font>
<a name="line483">483: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsString.html">PetscOptionsString</a>()`, `<a href="../manualpages/Sys/PetscOptionsReal.html">PetscOptionsReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`,</font>
<a name="line484">484: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>()`, `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`,</font>
<a name="line485">485: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`,</font>
<a name="line486">486: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`,</font>
<a name="line487">487: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoundedReal.html">PetscOptionsBoundedReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsRangeReal.html">PetscOptionsRangeReal</a>()`</font>
<a name="line488">488: </a><font color="#B22222">M*/</font>
<a name="line489">489: </a><strong><font color="#228B22"> #define <a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a>(opt, text, man, currentvalue, value, set) PetscOptionsInt_Private(PetscOptionsObject, opt, text, man, currentvalue, value, set, PETSC_INT_MIN, PETSC_INT_MAX)</font></strong>
<a name="line491">491: </a><font color="#B22222">/*MC</font>
<a name="line492">492: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsMPIInt.html">PetscOptionsMPIInt</a> - Gets the MPI integer value for a particular option in the database.</font>
<a name="line494">494: </a><font color="#B22222"> Synopsis:</font>
<a name="line495">495: </a>#include <A href="../include/petscoptions.h.html"><petscoptions.h></A>
<a name="line496">496: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsMPIInt.html">PetscOptionsMPIInt</a>(const char opt[], const char text[], const char man[], <a href="../manualpages/Sys/PetscMPIInt.html">PetscMPIInt</a> currentvalue, <a href="../manualpages/Sys/PetscMPIInt.html">PetscMPIInt</a> *value, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *set)</font>
<a name="line498">498: </a><font color="#B22222"> Logically Collective on the communicator passed in `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`</font>
<a name="line500">500: </a><font color="#B22222"> Input Parameters:</font>
<a name="line501">501: </a><font color="#B22222">+ opt - option name</font>
<a name="line502">502: </a><font color="#B22222">. text - short string that describes the option</font>
<a name="line503">503: </a><font color="#B22222">. man - manual page with additional information on option</font>
<a name="line504">504: </a><font color="#B22222">- currentvalue - the current value; caller is responsible for setting this value correctly. Normally this is done with either</font>
<a name="line505">505: </a><font color="#B22222">.vb</font>
<a name="line506">506: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a>(..., obj->value, &obj->value, ...) or</font>
<a name="line507">507: </a><font color="#B22222"> value = defaultvalue</font>
<a name="line508">508: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a>(..., value, &value, &set);</font>
<a name="line509">509: </a><font color="#B22222"> if (set) {</font>
<a name="line510">510: </a><font color="#B22222">.ve</font>
<a name="line512">512: </a><font color="#B22222"> Output Parameters:</font>
<a name="line513">513: </a><font color="#B22222">+ value - the MPI integer value to return</font>
<a name="line514">514: </a><font color="#B22222">- set - `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>` if found, else `<a href="../manualpages/Sys/PETSC_FALSE.html">PETSC_FALSE</a>`</font>
<a name="line516">516: </a><font color="#B22222"> Level: beginner</font>
<a name="line518">518: </a><font color="#B22222"> Notes:</font>
<a name="line519">519: </a><font color="#B22222"> If the user does not supply the option at all `value` is NOT changed. Thus</font>
<a name="line520">520: </a><font color="#B22222"> you should ALWAYS initialize `value` if you access it without first checking that `set` is `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>`.</font>
<a name="line522">522: </a><font color="#B22222"> The `currentvalue` passed into this routine does not get transferred to the output `value` variable automatically.</font>
<a name="line524">524: </a><font color="#B22222"> Must be between a `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` and a `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`</font>
<a name="line526">526: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsBoundedInt.html">PetscOptionsBoundedInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetReal.html">PetscOptionsGetReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsHasName.html">PetscOptionsHasName</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetString.html">PetscOptionsGetString</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()`,</font>
<a name="line527">527: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsGetIntArray.html">PetscOptionsGetIntArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetRealArray.html">PetscOptionsGetRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetBool.html">PetscOptionsGetBool</a>()`, `<a href="../manualpages/Sys/PetscOptionsRangeInt.html">PetscOptionsRangeInt</a>()`</font>
<a name="line528">528: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsString.html">PetscOptionsString</a>()`, `<a href="../manualpages/Sys/PetscOptionsReal.html">PetscOptionsReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`,</font>
<a name="line529">529: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>()`, `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`,</font>
<a name="line530">530: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`,</font>
<a name="line531">531: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`,</font>
<a name="line532">532: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoundedReal.html">PetscOptionsBoundedReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsRangeReal.html">PetscOptionsRangeReal</a>()`</font>
<a name="line533">533: </a><font color="#B22222">M*/</font>
<a name="line534">534: </a><strong><font color="#228B22"> #define <a href="../manualpages/Sys/PetscOptionsMPIInt.html">PetscOptionsMPIInt</a>(opt, text, man, currentvalue, value, set) PetscOptionsMPIInt_Private(PetscOptionsObject, opt, text, man, currentvalue, value, set, PETSC_MPI_INT_MIN, PETSC_MPI_INT_MAX)</font></strong>
<a name="line536">536: </a><font color="#B22222">/*MC</font>
<a name="line537">537: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsBoundedInt.html">PetscOptionsBoundedInt</a> - Gets an integer value greater than or equal to a given bound for a particular option in the database.</font>
<a name="line539">539: </a><font color="#B22222"> Synopsis:</font>
<a name="line540">540: </a>#include <A href="../include/petscoptions.h.html"><petscoptions.h></A>
<a name="line541">541: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsBoundedInt.html">PetscOptionsBoundedInt</a>(const char opt[], const char text[], const char man[], <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> currentvalue, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *value, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *set, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> bound)</font>
<a name="line543">543: </a><font color="#B22222"> Logically Collective on the communicator passed in `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`</font>
<a name="line545">545: </a><font color="#B22222"> Input Parameters:</font>
<a name="line546">546: </a><font color="#B22222">+ opt - option name</font>
<a name="line547">547: </a><font color="#B22222">. text - short string that describes the option</font>
<a name="line548">548: </a><font color="#B22222">. man - manual page with additional information on option</font>
<a name="line549">549: </a><font color="#B22222">. currentvalue - the current value; caller is responsible for setting this value correctly. Normally this is done with either</font>
<a name="line550">550: </a><font color="#B22222">.vb</font>
<a name="line551">551: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsBoundedInt.html">PetscOptionsBoundedInt</a>(..., obj->value, &obj->value, ...)</font>
<a name="line552">552: </a><font color="#B22222">.ve</font>
<a name="line553">553: </a><font color="#B22222">or</font>
<a name="line554">554: </a><font color="#B22222">.vb</font>
<a name="line555">555: </a><font color="#B22222"> value = defaultvalue</font>
<a name="line556">556: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsBoundedInt.html">PetscOptionsBoundedInt</a>(..., value, &value, &set, ...);</font>
<a name="line557">557: </a><font color="#B22222"> if (set) {</font>
<a name="line558">558: </a><font color="#B22222">.ve</font>
<a name="line559">559: </a><font color="#B22222">- bound - the requested value should be greater than or equal to this bound or an error is generated</font>
<a name="line561">561: </a><font color="#B22222"> Output Parameters:</font>
<a name="line562">562: </a><font color="#B22222">+ value - the integer value to return</font>
<a name="line563">563: </a><font color="#B22222">- set - `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>` if found, else `<a href="../manualpages/Sys/PETSC_FALSE.html">PETSC_FALSE</a>`</font>
<a name="line565">565: </a><font color="#B22222"> Level: beginner</font>
<a name="line567">567: </a><font color="#B22222"> Notes:</font>
<a name="line568">568: </a><font color="#B22222"> If the user does not supply the option at all `value` is NOT changed. Thus</font>
<a name="line569">569: </a><font color="#B22222"> you should ALWAYS initialize `value` if you access it without first checking that `set` is `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>`.</font>
<a name="line571">571: </a><font color="#B22222"> The `currentvalue` passed into this routine does not get transferred to the output `value` variable automatically.</font>
<a name="line573">573: </a><font color="#B22222"> Must be used between a `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` and a `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`</font>
<a name="line575">575: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetReal.html">PetscOptionsGetReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsHasName.html">PetscOptionsHasName</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetString.html">PetscOptionsGetString</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()`,</font>
<a name="line576">576: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsGetIntArray.html">PetscOptionsGetIntArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetRealArray.html">PetscOptionsGetRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetBool.html">PetscOptionsGetBool</a>()`, `<a href="../manualpages/Sys/PetscOptionsRangeInt.html">PetscOptionsRangeInt</a>()`</font>
<a name="line577">577: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsString.html">PetscOptionsString</a>()`, `<a href="../manualpages/Sys/PetscOptionsReal.html">PetscOptionsReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`,</font>
<a name="line578">578: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>()`, `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`,</font>
<a name="line579">579: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`,</font>
<a name="line580">580: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`,</font>
<a name="line581">581: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoundedReal.html">PetscOptionsBoundedReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsRangeReal.html">PetscOptionsRangeReal</a>()`</font>
<a name="line582">582: </a><font color="#B22222">M*/</font>
<a name="line583">583: </a><strong><font color="#228B22"> #define <a href="../manualpages/Sys/PetscOptionsBoundedInt.html">PetscOptionsBoundedInt</a>(opt, text, man, currentvalue, value, set, lb) PetscOptionsInt_Private(PetscOptionsObject, opt, text, man, currentvalue, value, set, lb, PETSC_INT_MAX)</font></strong>
<a name="line585">585: </a><font color="#B22222">/*MC</font>
<a name="line586">586: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsRangeInt.html">PetscOptionsRangeInt</a> - Gets an integer value within a range of values for a particular option in the database.</font>
<a name="line588">588: </a><font color="#B22222"> Synopsis:</font>
<a name="line589">589: </a>#include <A href="../include/petscoptions.h.html"><petscoptions.h></A>
<a name="line590">590: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsRangeInt.html">PetscOptionsRangeInt</a>(const char opt[], const char text[], const char man[], <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> currentvalue, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *value, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *set, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> lb, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> ub)</font>
<a name="line592">592: </a><font color="#B22222"> Logically Collective on the communicator passed in `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`</font>
<a name="line594">594: </a><font color="#B22222"> Input Parameters:</font>
<a name="line595">595: </a><font color="#B22222">+ opt - option name</font>
<a name="line596">596: </a><font color="#B22222">. text - short string that describes the option</font>
<a name="line597">597: </a><font color="#B22222">. man - manual page with additional information on option</font>
<a name="line598">598: </a><font color="#B22222">. currentvalue - the current value; caller is responsible for setting this value correctly. Normally this is done with either</font>
<a name="line599">599: </a><font color="#B22222">.vb</font>
<a name="line600">600: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsRangeInt.html">PetscOptionsRangeInt</a>(..., obj->value, &obj->value, ...)</font>
<a name="line601">601: </a><font color="#B22222">.ve</font>
<a name="line602">602: </a><font color="#B22222">or</font>
<a name="line603">603: </a><font color="#B22222">.vb</font>
<a name="line604">604: </a><font color="#B22222"> value = defaultvalue</font>
<a name="line605">605: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsRangeInt.html">PetscOptionsRangeInt</a>(..., value, &value, &set, ...);</font>
<a name="line606">606: </a><font color="#B22222"> if (set) {</font>
<a name="line607">607: </a><font color="#B22222">.ve</font>
<a name="line608">608: </a><font color="#B22222">. lb - the lower bound, provided value must be greater than or equal to this value or an error is generated</font>
<a name="line609">609: </a><font color="#B22222">- ub - the upper bound, provided value must be less than or equal to this value or an error is generated</font>
<a name="line611">611: </a><font color="#B22222"> Output Parameters:</font>
<a name="line612">612: </a><font color="#B22222">+ value - the integer value to return</font>
<a name="line613">613: </a><font color="#B22222">- set - `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>` if found, else `<a href="../manualpages/Sys/PETSC_FALSE.html">PETSC_FALSE</a>`</font>
<a name="line615">615: </a><font color="#B22222"> Level: beginner</font>
<a name="line617">617: </a><font color="#B22222"> Notes:</font>
<a name="line618">618: </a><font color="#B22222"> If the user does not supply the option at all `value` is NOT changed. Thus</font>
<a name="line619">619: </a><font color="#B22222"> you should ALWAYS initialize `value` if you access it without first checking that `set` is `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>`.</font>
<a name="line621">621: </a><font color="#B22222"> The `currentvalue` passed into this routine does not get transferred to the output `value` variable automatically.</font>
<a name="line623">623: </a><font color="#B22222"> Must be used between a `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` and a `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`</font>
<a name="line625">625: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetReal.html">PetscOptionsGetReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsHasName.html">PetscOptionsHasName</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetString.html">PetscOptionsGetString</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()`,</font>
<a name="line626">626: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsGetIntArray.html">PetscOptionsGetIntArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetRealArray.html">PetscOptionsGetRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetBool.html">PetscOptionsGetBool</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoundedInt.html">PetscOptionsBoundedInt</a>()`</font>
<a name="line627">627: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsString.html">PetscOptionsString</a>()`, `<a href="../manualpages/Sys/PetscOptionsReal.html">PetscOptionsReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`,</font>
<a name="line628">628: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>()`, `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`,</font>
<a name="line629">629: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`,</font>
<a name="line630">630: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`,</font>
<a name="line631">631: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoundedReal.html">PetscOptionsBoundedReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsRangeReal.html">PetscOptionsRangeReal</a>()`</font>
<a name="line632">632: </a><font color="#B22222">M*/</font>
<a name="line633">633: </a><strong><font color="#228B22"> #define <a href="../manualpages/Sys/PetscOptionsRangeInt.html">PetscOptionsRangeInt</a>(opt, text, man, currentvalue, value, set, lb, ub) PetscOptionsInt_Private(PetscOptionsObject, opt, text, man, currentvalue, value, set, lb, ub)</font></strong>
<a name="line635">635: </a><font color="#B22222">/*MC</font>
<a name="line636">636: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsReal.html">PetscOptionsReal</a> - Gets a `<a href="../manualpages/Sys/PetscReal.html">PetscReal</a>` value for a particular option in the database.</font>
<a name="line638">638: </a><font color="#B22222"> Synopsis:</font>
<a name="line639">639: </a>#include <A href="../include/petscoptions.h.html"><petscoptions.h></A>
<a name="line640">640: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsReal.html">PetscOptionsReal</a>(const char opt[], const char text[], const char man[], <a href="../manualpages/Sys/PetscReal.html">PetscReal</a> currentvalue, <a href="../manualpages/Sys/PetscReal.html">PetscReal</a> *value, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *set)</font>
<a name="line642">642: </a><font color="#B22222"> Logically Collective on the communicator passed in `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`</font>
<a name="line644">644: </a><font color="#B22222"> Input Parameters:</font>
<a name="line645">645: </a><font color="#B22222">+ opt - option name</font>
<a name="line646">646: </a><font color="#B22222">. text - short string that describes the option</font>
<a name="line647">647: </a><font color="#B22222">. man - manual page with additional information on option</font>
<a name="line648">648: </a><font color="#B22222">- currentvalue - the current value; caller is responsible for setting this value correctly. Normally this is done with either</font>
<a name="line649">649: </a><font color="#B22222">.vb</font>
<a name="line650">650: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsReal.html">PetscOptionsReal</a>(..., obj->value,&obj->value,...) or</font>
<a name="line651">651: </a><font color="#B22222"> value = defaultvalue</font>
<a name="line652">652: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsReal.html">PetscOptionsReal</a>(..., value,&value,&set);</font>
<a name="line653">653: </a><font color="#B22222"> if (set) {</font>
<a name="line654">654: </a><font color="#B22222">.ve</font>
<a name="line656">656: </a><font color="#B22222"> Output Parameters:</font>
<a name="line657">657: </a><font color="#B22222">+ value - the value to return</font>
<a name="line658">658: </a><font color="#B22222">- set - `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>` if found, else `<a href="../manualpages/Sys/PETSC_FALSE.html">PETSC_FALSE</a>`</font>
<a name="line660">660: </a><font color="#B22222"> Level: beginner</font>
<a name="line662">662: </a><font color="#B22222"> Notes:</font>
<a name="line663">663: </a><font color="#B22222"> If the user does not supply the option at all `value` is NOT changed. Thus</font>
<a name="line664">664: </a><font color="#B22222"> you should ALWAYS initialize `value` if you access it without first checking that `set` is `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>`.</font>
<a name="line666">666: </a><font color="#B22222"> The `currentvalue` passed into this routine does not get transferred to the output `value` variable automatically.</font>
<a name="line668">668: </a><font color="#B22222"> Must be used between a `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` and a `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`</font>
<a name="line670">670: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsGetReal.html">PetscOptionsGetReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsHasName.html">PetscOptionsHasName</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetString.html">PetscOptionsGetString</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()`,</font>
<a name="line671">671: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsGetIntArray.html">PetscOptionsGetIntArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetRealArray.html">PetscOptionsGetRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetBool.html">PetscOptionsGetBool</a>()`,</font>
<a name="line672">672: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsString.html">PetscOptionsString</a>()`, `<a href="../manualpages/Sys/PetscOptionsReal.html">PetscOptionsReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`,</font>
<a name="line673">673: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>()`, `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`,</font>
<a name="line674">674: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`,</font>
<a name="line675">675: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`,</font>
<a name="line676">676: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoundedReal.html">PetscOptionsBoundedReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsRangeReal.html">PetscOptionsRangeReal</a>()`</font>
<a name="line677">677: </a><font color="#B22222">M*/</font>
<a name="line678">678: </a><strong><font color="#228B22"> #define <a href="../manualpages/Sys/PetscOptionsReal.html">PetscOptionsReal</a>(opt, text, man, currentvalue, value, set) PetscOptionsReal_Private(PetscOptionsObject, opt, text, man, currentvalue, value, set, <a href="../manualpages/Sys/PETSC_MIN_REAL.html">PETSC_MIN_REAL</a>, <a href="../manualpages/Sys/PETSC_MAX_REAL.html">PETSC_MAX_REAL</a>)</font></strong>
<a name="line680">680: </a><font color="#B22222">/*MC</font>
<a name="line681">681: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsBoundedReal.html">PetscOptionsBoundedReal</a> - Gets a `<a href="../manualpages/Sys/PetscReal.html">PetscReal</a>` value greater than or equal to a given bound for a particular option in the database.</font>
<a name="line683">683: </a><font color="#B22222"> Synopsis:</font>
<a name="line684">684: </a>#include <A href="../include/petscoptions.h.html"><petscoptions.h></A>
<a name="line685">685: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsBoundedReal.html">PetscOptionsBoundedReal</a>(const char opt[], const char text[], const char man[], <a href="../manualpages/Sys/PetscReal.html">PetscReal</a> currentvalue, <a href="../manualpages/Sys/PetscReal.html">PetscReal</a> *value, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *set, <a href="../manualpages/Sys/PetscReal.html">PetscReal</a> bound)</font>
<a name="line687">687: </a><font color="#B22222"> Logically Collective on the communicator passed in `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`</font>
<a name="line689">689: </a><font color="#B22222"> Input Parameters:</font>
<a name="line690">690: </a><font color="#B22222">+ opt - option name</font>
<a name="line691">691: </a><font color="#B22222">. text - short string that describes the option</font>
<a name="line692">692: </a><font color="#B22222">. man - manual page with additional information on option</font>
<a name="line693">693: </a><font color="#B22222">. currentvalue - the current value; caller is responsible for setting this value correctly. Normally this is done with either</font>
<a name="line694">694: </a><font color="#B22222">.vb</font>
<a name="line695">695: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsBoundedReal.html">PetscOptionsBoundedReal</a>(..., obj->value, &obj->value, ...)</font>
<a name="line696">696: </a><font color="#B22222">.ve</font>
<a name="line697">697: </a><font color="#B22222">or</font>
<a name="line698">698: </a><font color="#B22222">.vb</font>
<a name="line699">699: </a><font color="#B22222"> value = defaultvalue</font>
<a name="line700">700: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsBoundedReal.html">PetscOptionsBoundedReal</a>(..., value, &value, &set, ...);</font>
<a name="line701">701: </a><font color="#B22222"> if (set) {</font>
<a name="line702">702: </a><font color="#B22222">.ve</font>
<a name="line703">703: </a><font color="#B22222">- bound - the requested value should be greater than or equal to this bound or an error is generated</font>
<a name="line705">705: </a><font color="#B22222"> Output Parameters:</font>
<a name="line706">706: </a><font color="#B22222">+ value - the real value to return</font>
<a name="line707">707: </a><font color="#B22222">- set - `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>` if found, else `<a href="../manualpages/Sys/PETSC_FALSE.html">PETSC_FALSE</a>`</font>
<a name="line709">709: </a><font color="#B22222"> Level: beginner</font>
<a name="line711">711: </a><font color="#B22222"> Notes:</font>
<a name="line712">712: </a><font color="#B22222"> If the user does not supply the option at all `value` is NOT changed. Thus</font>
<a name="line713">713: </a><font color="#B22222"> you should ALWAYS initialize `value` if you access it without first checking that `set` is `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>`.</font>
<a name="line715">715: </a><font color="#B22222"> The `currentvalue` passed into this routine does not get transferred to the output `value` variable automatically.</font>
<a name="line717">717: </a><font color="#B22222"> Must be used between a `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` and a `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`</font>
<a name="line719">719: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetReal.html">PetscOptionsGetReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsHasName.html">PetscOptionsHasName</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetString.html">PetscOptionsGetString</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()`,</font>
<a name="line720">720: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsGetIntArray.html">PetscOptionsGetIntArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetRealArray.html">PetscOptionsGetRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetBool.html">PetscOptionsGetBool</a>()`, `<a href="../manualpages/Sys/PetscOptionsRangeInt.html">PetscOptionsRangeInt</a>()`</font>
<a name="line721">721: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsString.html">PetscOptionsString</a>()`, `<a href="../manualpages/Sys/PetscOptionsReal.html">PetscOptionsReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`,</font>
<a name="line722">722: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>()`, `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`,</font>
<a name="line723">723: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`,</font>
<a name="line724">724: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`,</font>
<a name="line725">725: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoundedInt.html">PetscOptionsBoundedInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsRangeReal.html">PetscOptionsRangeReal</a>()`</font>
<a name="line726">726: </a><font color="#B22222">M*/</font>
<a name="line727">727: </a><strong><font color="#228B22"> #define <a href="../manualpages/Sys/PetscOptionsBoundedReal.html">PetscOptionsBoundedReal</a>(opt, text, man, currentvalue, value, set, lb) PetscOptionsReal_Private(PetscOptionsObject, opt, text, man, currentvalue, value, set, lb, <a href="../manualpages/Sys/PETSC_MAX_REAL.html">PETSC_MAX_REAL</a>)</font></strong>
<a name="line729">729: </a><font color="#B22222">/*MC</font>
<a name="line730">730: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsRangeReal.html">PetscOptionsRangeReal</a> - Gets a `<a href="../manualpages/Sys/PetscReal.html">PetscReal</a>` value within a range of values for a particular option in the database.</font>
<a name="line732">732: </a><font color="#B22222"> Synopsis:</font>
<a name="line733">733: </a>#include <A href="../include/petscoptions.h.html"><petscoptions.h></A>
<a name="line734">734: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsRangeReal.html">PetscOptionsRangeReal</a>(const char opt[], const char text[], const char man[], <a href="../manualpages/Sys/PetscReal.html">PetscReal</a> currentvalue, <a href="../manualpages/Sys/PetscReal.html">PetscReal</a> *value, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *set, <a href="../manualpages/Sys/PetscReal.html">PetscReal</a> lb, <a href="../manualpages/Sys/PetscReal.html">PetscReal</a> ub)</font>
<a name="line736">736: </a><font color="#B22222"> Logically Collective on the communicator passed in `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`</font>
<a name="line738">738: </a><font color="#B22222"> Input Parameters:</font>
<a name="line739">739: </a><font color="#B22222">+ opt - option name</font>
<a name="line740">740: </a><font color="#B22222">. text - short string that describes the option</font>
<a name="line741">741: </a><font color="#B22222">. man - manual page with additional information on option</font>
<a name="line742">742: </a><font color="#B22222">. currentvalue - the current value; caller is responsible for setting this value correctly. Normally this is done with either</font>
<a name="line743">743: </a><font color="#B22222">.vb</font>
<a name="line744">744: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsRangeReal.html">PetscOptionsRangeReal</a>(..., obj->value, &obj->value, ...)</font>
<a name="line745">745: </a><font color="#B22222">.ve</font>
<a name="line746">746: </a><font color="#B22222">or</font>
<a name="line747">747: </a><font color="#B22222">.vb</font>
<a name="line748">748: </a><font color="#B22222"> value = defaultvalue</font>
<a name="line749">749: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsRangeReal.html">PetscOptionsRangeReal</a>(..., value, &value, &set, ...);</font>
<a name="line750">750: </a><font color="#B22222"> if (set) {</font>
<a name="line751">751: </a><font color="#B22222">.ve</font>
<a name="line752">752: </a><font color="#B22222">. lb - the lower bound, provided value must be greater than or equal to this value or an error is generated</font>
<a name="line753">753: </a><font color="#B22222">- ub - the upper bound, provided value must be less than or equal to this value or an error is generated</font>
<a name="line755">755: </a><font color="#B22222"> Output Parameters:</font>
<a name="line756">756: </a><font color="#B22222">+ value - the value to return</font>
<a name="line757">757: </a><font color="#B22222">- set - `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>` if found, else `<a href="../manualpages/Sys/PETSC_FALSE.html">PETSC_FALSE</a>`</font>
<a name="line759">759: </a><font color="#B22222"> Level: beginner</font>
<a name="line761">761: </a><font color="#B22222"> Notes:</font>
<a name="line762">762: </a><font color="#B22222"> If the user does not supply the option at all `value` is NOT changed. Thus</font>
<a name="line763">763: </a><font color="#B22222"> you should ALWAYS initialize `value` if you access it without first checking that `set` is `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>`.</font>
<a name="line765">765: </a><font color="#B22222"> The `currentvalue` passed into this routine does not get transferred to the output `value` variable automatically.</font>
<a name="line767">767: </a><font color="#B22222"> Must be used between a `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` and a `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`</font>
<a name="line769">769: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetReal.html">PetscOptionsGetReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsHasName.html">PetscOptionsHasName</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetString.html">PetscOptionsGetString</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()`,</font>
<a name="line770">770: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsGetIntArray.html">PetscOptionsGetIntArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetRealArray.html">PetscOptionsGetRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetBool.html">PetscOptionsGetBool</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoundedInt.html">PetscOptionsBoundedInt</a>()`</font>
<a name="line771">771: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsString.html">PetscOptionsString</a>()`, `<a href="../manualpages/Sys/PetscOptionsReal.html">PetscOptionsReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`,</font>
<a name="line772">772: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>()`, `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`,</font>
<a name="line773">773: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`,</font>
<a name="line774">774: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`,</font>
<a name="line775">775: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>()`, `<a href="../manualpages/Sys/PetscOptionsRangeInt.html">PetscOptionsRangeInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoundedReal.html">PetscOptionsBoundedReal</a>()`</font>
<a name="line776">776: </a><font color="#B22222">M*/</font>
<a name="line777">777: </a><strong><font color="#228B22"> #define <a href="../manualpages/Sys/PetscOptionsRangeReal.html">PetscOptionsRangeReal</a>(opt, text, man, currentvalue, value, set, lb, ub) PetscOptionsReal_Private(PetscOptionsObject, opt, text, man, currentvalue, value, set, lb, ub)</font></strong>
<a name="line779">779: </a><font color="#B22222">/*MC</font>
<a name="line780">780: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a> - Gets the `<a href="../manualpages/Sys/PetscScalar.html">PetscScalar</a>` value for a particular option in the database.</font>
<a name="line782">782: </a><font color="#B22222"> Synopsis:</font>
<a name="line783">783: </a>#include <A href="../include/petscoptions.h.html"><petscoptions.h></A>
<a name="line784">784: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>(const char opt[], const char text[], const char man[], <a href="../manualpages/Sys/PetscScalar.html">PetscScalar</a> currentvalue, <a href="../manualpages/Sys/PetscScalar.html">PetscScalar</a> *value, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *set)</font>
<a name="line786">786: </a><font color="#B22222"> Logically Collective on the communicator passed in `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`</font>
<a name="line788">788: </a><font color="#B22222"> Input Parameters:</font>
<a name="line789">789: </a><font color="#B22222">+ opt - option name</font>
<a name="line790">790: </a><font color="#B22222">. text - short string that describes the option</font>
<a name="line791">791: </a><font color="#B22222">. man - manual page with additional information on option</font>
<a name="line792">792: </a><font color="#B22222">- currentvalue - the current value; caller is responsible for setting this value correctly. Normally this is done with either</font>
<a name="line793">793: </a><font color="#B22222">.vb</font>
<a name="line794">794: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>(..., obj->value,&obj->value,...) or</font>
<a name="line795">795: </a><font color="#B22222"> value = defaultvalue</font>
<a name="line796">796: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>(..., value,&value,&set);</font>
<a name="line797">797: </a><font color="#B22222"> if (set) {</font>
<a name="line798">798: </a><font color="#B22222">.ve</font>
<a name="line800">800: </a><font color="#B22222"> Output Parameters:</font>
<a name="line801">801: </a><font color="#B22222">+ value - the value to return</font>
<a name="line802">802: </a><font color="#B22222">- set - `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>` if found, else `<a href="../manualpages/Sys/PETSC_FALSE.html">PETSC_FALSE</a>`</font>
<a name="line804">804: </a><font color="#B22222"> Level: beginner</font>
<a name="line806">806: </a><font color="#B22222"> Notes:</font>
<a name="line807">807: </a><font color="#B22222"> If the user does not supply the option at all `value` is NOT changed. Thus</font>
<a name="line808">808: </a><font color="#B22222"> you should ALWAYS initialize `value` if you access it without first checking that `set` is `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>`.</font>
<a name="line810">810: </a><font color="#B22222"> The `currentvalue` passed into this routine does not get transferred to the output `value` variable automatically.</font>
<a name="line812">812: </a><font color="#B22222"> Must be used between a `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` and a `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`</font>
<a name="line814">814: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsGetReal.html">PetscOptionsGetReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsHasName.html">PetscOptionsHasName</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetString.html">PetscOptionsGetString</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()`,</font>
<a name="line815">815: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsGetIntArray.html">PetscOptionsGetIntArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetRealArray.html">PetscOptionsGetRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetBool.html">PetscOptionsGetBool</a>()`,</font>
<a name="line816">816: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsString.html">PetscOptionsString</a>()`, `<a href="../manualpages/Sys/PetscOptionsReal.html">PetscOptionsReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`,</font>
<a name="line817">817: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>()`, `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`,</font>
<a name="line818">818: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`,</font>
<a name="line819">819: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`,</font>
<a name="line820">820: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>()`</font>
<a name="line821">821: </a><font color="#B22222">M*/</font>
<a name="line822">822: </a><strong><font color="#228B22"> #define <a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>(opt, text, man, currentvalue, value, set) PetscOptionsScalar_Private(PetscOptionsObject, opt, text, man, currentvalue, value, set)</font></strong>
<a name="line824">824: </a><font color="#B22222">/*MC</font>
<a name="line825">825: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a> - Determines if a particular option has been set in the database. This returns true whether the option is a number, string or boolean, even</font>
<a name="line826">826: </a><font color="#B22222"> its value is set to false.</font>
<a name="line828">828: </a><font color="#B22222"> Synopsis:</font>
<a name="line829">829: </a>#include <A href="../include/petscoptions.h.html"><petscoptions.h></A>
<a name="line830">830: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>(const char opt[], const char text[], const char man[], <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *set)</font>
<a name="line832">832: </a><font color="#B22222"> Logically Collective on the communicator passed in `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`</font>
<a name="line834">834: </a><font color="#B22222"> Input Parameters:</font>
<a name="line835">835: </a><font color="#B22222">+ opt - option name</font>
<a name="line836">836: </a><font color="#B22222">. text - short string that describes the option</font>
<a name="line837">837: </a><font color="#B22222">- man - manual page with additional information on option</font>
<a name="line839">839: </a><font color="#B22222"> Output Parameter:</font>
<a name="line840">840: </a><font color="#B22222">. set - `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>` if found, else `<a href="../manualpages/Sys/PETSC_FALSE.html">PETSC_FALSE</a>`</font>
<a name="line842">842: </a><font color="#B22222"> Level: beginner</font>
<a name="line844">844: </a><font color="#B22222"> Note:</font>
<a name="line845">845: </a><font color="#B22222"> Must be used between a `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` and a `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`</font>
<a name="line847">847: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsGetReal.html">PetscOptionsGetReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsHasName.html">PetscOptionsHasName</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetString.html">PetscOptionsGetString</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()`,</font>
<a name="line848">848: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsGetIntArray.html">PetscOptionsGetIntArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetRealArray.html">PetscOptionsGetRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetBool.html">PetscOptionsGetBool</a>()`,</font>
<a name="line849">849: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsString.html">PetscOptionsString</a>()`, `<a href="../manualpages/Sys/PetscOptionsReal.html">PetscOptionsReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`,</font>
<a name="line850">850: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>()`, `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`,</font>
<a name="line851">851: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`,</font>
<a name="line852">852: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`,</font>
<a name="line853">853: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>()`</font>
<a name="line854">854: </a><font color="#B22222">M*/</font>
<a name="line855">855: </a><strong><font color="#228B22"> #define <a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>(opt, text, man, set) PetscOptionsName_Private(PetscOptionsObject, opt, text, man, set)</font></strong>
<a name="line857">857: </a><font color="#B22222">/*MC</font>
<a name="line858">858: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsString.html">PetscOptionsString</a> - Gets the string value for a particular option in the database.</font>
<a name="line860">860: </a><font color="#B22222"> Synopsis:</font>
<a name="line861">861: </a>#include <A href="../include/petscoptions.h.html"><petscoptions.h></A>
<a name="line862">862: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsString.html">PetscOptionsString</a>(const char opt[], const char text[], const char man[], const char currentvalue[], char value[], size_t len, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *set)</font>
<a name="line864">864: </a><font color="#B22222"> Logically Collective on the communicator passed in `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`</font>
<a name="line866">866: </a><font color="#B22222"> Input Parameters:</font>
<a name="line867">867: </a><font color="#B22222">+ opt - option name</font>
<a name="line868">868: </a><font color="#B22222">. text - short string that describes the option</font>
<a name="line869">869: </a><font color="#B22222">. man - manual page with additional information on option</font>
<a name="line870">870: </a><font color="#B22222">. currentvalue - the current value; caller is responsible for setting this value correctly. This is not used to set value</font>
<a name="line871">871: </a><font color="#B22222">- len - length of the result string including null terminator</font>
<a name="line873">873: </a><font color="#B22222"> Output Parameters:</font>
<a name="line874">874: </a><font color="#B22222">+ value - the value to return</font>
<a name="line875">875: </a><font color="#B22222">- set - `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>` if found, else `<a href="../manualpages/Sys/PETSC_FALSE.html">PETSC_FALSE</a>`</font>
<a name="line877">877: </a><font color="#B22222"> Level: beginner</font>
<a name="line879">879: </a><font color="#B22222"> Notes:</font>
<a name="line880">880: </a><font color="#B22222"> Must be used between a `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` and a `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`</font>
<a name="line882">882: </a><font color="#B22222"> If the user provided no string (for example `-optionname` `-someotheroption`) `set` is set to `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>` (and the string is filled with nulls).</font>
<a name="line884">884: </a><font color="#B22222"> If the user does not supply the option at all `value` is NOT changed. Thus</font>
<a name="line885">885: </a><font color="#B22222"> you should ALWAYS initialize `value` if you access it without first checking that `set` is `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>`.</font>
<a name="line887">887: </a><font color="#B22222"> The `currentvalue` passed into this routine does not get transferred to the output `value` variable automatically.</font>
<a name="line889">889: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsGetReal.html">PetscOptionsGetReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsHasName.html">PetscOptionsHasName</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetString.html">PetscOptionsGetString</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()`,</font>
<a name="line890">890: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsGetIntArray.html">PetscOptionsGetIntArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetRealArray.html">PetscOptionsGetRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetBool.html">PetscOptionsGetBool</a>()`,</font>
<a name="line891">891: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsReal.html">PetscOptionsReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`,</font>
<a name="line892">892: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>()`, `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`,</font>
<a name="line893">893: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`,</font>
<a name="line894">894: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`,</font>
<a name="line895">895: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>()`</font>
<a name="line896">896: </a><font color="#B22222">M*/</font>
<a name="line897">897: </a><strong><font color="#228B22"> #define <a href="../manualpages/Sys/PetscOptionsString.html">PetscOptionsString</a>(opt, text, man, currentvalue, value, len, set) PetscOptionsString_Private(PetscOptionsObject, opt, text, man, currentvalue, value, len, set)</font></strong>
<a name="line899">899: </a><font color="#B22222">/*MC</font>
<a name="line900">900: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a> - Determines if a particular option is in the database with a true or false</font>
<a name="line902">902: </a><font color="#B22222"> Synopsis:</font>
<a name="line903">903: </a>#include <A href="../include/petscoptions.h.html"><petscoptions.h></A>
<a name="line904">904: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>(const char opt[], const char text[], const char man[], <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> currentvalue, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *flg, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *set)</font>
<a name="line906">906: </a><font color="#B22222"> Logically Collective on the communicator passed in `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`</font>
<a name="line908">908: </a><font color="#B22222"> Input Parameters:</font>
<a name="line909">909: </a><font color="#B22222">+ opt - option name</font>
<a name="line910">910: </a><font color="#B22222">. text - short string that describes the option</font>
<a name="line911">911: </a><font color="#B22222">. man - manual page with additional information on option</font>
<a name="line912">912: </a><font color="#B22222">- currentvalue - the current value</font>
<a name="line914">914: </a><font color="#B22222"> Output Parameters:</font>
<a name="line915">915: </a><font color="#B22222">+ flg - `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>` or `<a href="../manualpages/Sys/PETSC_FALSE.html">PETSC_FALSE</a>`</font>
<a name="line916">916: </a><font color="#B22222">- set - `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>` if found, else `<a href="../manualpages/Sys/PETSC_FALSE.html">PETSC_FALSE</a>`</font>
<a name="line918">918: </a><font color="#B22222"> Level: beginner</font>
<a name="line920">920: </a><font color="#B22222"> Notes:</font>
<a name="line921">921: </a><font color="#B22222"> TRUE, true, YES, yes, nostring, and 1 all translate to `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>`</font>
<a name="line922">922: </a><font color="#B22222"> FALSE, false, NO, no, and 0 all translate to `<a href="../manualpages/Sys/PETSC_FALSE.html">PETSC_FALSE</a>`</font>
<a name="line924">924: </a><font color="#B22222"> If the option is given, but no value is provided, then `flg` and `set` are both given the value `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>`. That is `-requested_bool`</font>
<a name="line925">925: </a><font color="#B22222"> is equivalent to `-requested_bool true`</font>
<a name="line927">927: </a><font color="#B22222"> If the user does not supply the option at all `flg` is NOT changed. Thus</font>
<a name="line928">928: </a><font color="#B22222"> you should ALWAYS initialize the `flg` variable if you access it without first checking that the `set` flag is `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>`.</font>
<a name="line930">930: </a><font color="#B22222"> Must be between a `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` and a `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`</font>
<a name="line932">932: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsGetReal.html">PetscOptionsGetReal</a>()`, `<a href="../manualpages/Sys/PetscOptionsHasName.html">PetscOptionsHasName</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetString.html">PetscOptionsGetString</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()`,</font>
<a name="line933">933: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsGetIntArray.html">PetscOptionsGetIntArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetRealArray.html">PetscOptionsGetRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetBool.html">PetscOptionsGetBool</a>()`,</font>
<a name="line934">934: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsInt.html">PetscOptionsInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsString.html">PetscOptionsString</a>()`, `<a href="../manualpages/Sys/PetscOptionsReal.html">PetscOptionsReal</a>()`,</font>
<a name="line935">935: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>()`, `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`,</font>
<a name="line936">936: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`,</font>
<a name="line937">937: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`,</font>
<a name="line938">938: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>()`</font>
<a name="line939">939: </a><font color="#B22222">M*/</font>
<a name="line940">940: </a><strong><font color="#228B22"> #define <a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>(opt, text, man, currentvalue, value, set) PetscOptionsBool_Private(PetscOptionsObject, opt, text, man, currentvalue, value, set)</font></strong>
<a name="line942">942: </a><font color="#B22222">/*MC</font>
<a name="line943">943: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a> - First in a series of logical queries on the options database for</font>
<a name="line944">944: </a><font color="#B22222"> which at most a single value can be true.</font>
<a name="line946">946: </a><font color="#B22222"> Synopsis:</font>
<a name="line947">947: </a>#include <A href="../include/petscoptions.h.html"><petscoptions.h></A>
<a name="line948">948: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>(const char opt[], const char text[], const char man[], <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *set)</font>
<a name="line950">950: </a><font color="#B22222"> Logically Collective on the communicator passed in `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`</font>
<a name="line952">952: </a><font color="#B22222"> Input Parameters:</font>
<a name="line953">953: </a><font color="#B22222">+ opt - option name</font>
<a name="line954">954: </a><font color="#B22222">. text - short string that describes the option</font>
<a name="line955">955: </a><font color="#B22222">- man - manual page with additional information on option</font>
<a name="line957">957: </a><font color="#B22222"> Output Parameter:</font>
<a name="line958">958: </a><font color="#B22222">. set - whether that option was set or not</font>
<a name="line960">960: </a><font color="#B22222"> Level: intermediate</font>
<a name="line962">962: </a><font color="#B22222"> Notes:</font>
<a name="line963">963: </a><font color="#B22222"> Must be used between a `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` and a `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`</font>
<a name="line965">965: </a><font color="#B22222"> Must be followed by 0 or more `<a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>()`s and `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`</font>
<a name="line967">967: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetReal.html">PetscOptionsGetReal</a>()`,</font>
<a name="line968">968: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsHasName.html">PetscOptionsHasName</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetIntArray.html">PetscOptionsGetIntArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetRealArray.html">PetscOptionsGetRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`,</font>
<a name="line969">969: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>()`, `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`,</font>
<a name="line970">970: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`,</font>
<a name="line971">971: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`,</font>
<a name="line972">972: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>()`</font>
<a name="line973">973: </a><font color="#B22222">M*/</font>
<a name="line974">974: </a><strong><font color="#228B22"> #define <a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>(opt, text, man, set) PetscOptionsBoolGroupBegin_Private(PetscOptionsObject, opt, text, man, set)</font></strong>
<a name="line976">976: </a><font color="#B22222">/*MC</font>
<a name="line977">977: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a> - One in a series of logical queries on the options database for</font>
<a name="line978">978: </a><font color="#B22222"> which at most a single value can be true.</font>
<a name="line980">980: </a><font color="#B22222"> Synopsis:</font>
<a name="line981">981: </a>#include <A href="../include/petscoptions.h.html"><petscoptions.h></A>
<a name="line982">982: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>(const char opt[], const char text[], const char man[], <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *set)</font>
<a name="line984">984: </a><font color="#B22222"> Logically Collective on the communicator passed in `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`</font>
<a name="line986">986: </a><font color="#B22222"> Input Parameters:</font>
<a name="line987">987: </a><font color="#B22222">+ opt - option name</font>
<a name="line988">988: </a><font color="#B22222">. text - short string that describes the option</font>
<a name="line989">989: </a><font color="#B22222">- man - manual page with additional information on option</font>
<a name="line991">991: </a><font color="#B22222"> Output Parameter:</font>
<a name="line992">992: </a><font color="#B22222">. set - `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>` if found, else `<a href="../manualpages/Sys/PETSC_FALSE.html">PETSC_FALSE</a>`</font>
<a name="line994">994: </a><font color="#B22222"> Level: intermediate</font>
<a name="line996">996: </a><font color="#B22222"> Notes:</font>
<a name="line997">997: </a><font color="#B22222"> Must be used between a `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` and a `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`</font>
<a name="line999">999: </a><font color="#B22222"> Must follow a `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()` and preceded a `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`</font>
<a name="line1001">1001: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetReal.html">PetscOptionsGetReal</a>()`,</font>
<a name="line1002">1002: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsHasName.html">PetscOptionsHasName</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetIntArray.html">PetscOptionsGetIntArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetRealArray.html">PetscOptionsGetRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`,</font>
<a name="line1003">1003: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>()`, `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`,</font>
<a name="line1004">1004: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`,</font>
<a name="line1005">1005: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`,</font>
<a name="line1006">1006: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>()`</font>
<a name="line1007">1007: </a><font color="#B22222">M*/</font>
<a name="line1008">1008: </a><strong><font color="#228B22"> #define <a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>(opt, text, man, set) PetscOptionsBoolGroup_Private(PetscOptionsObject, opt, text, man, set)</font></strong>
<a name="line1010">1010: </a><font color="#B22222">/*MC</font>
<a name="line1011">1011: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a> - Last in a series of logical queries on the options database for</font>
<a name="line1012">1012: </a><font color="#B22222"> which at most a single value can be true.</font>
<a name="line1014">1014: </a><font color="#B22222"> Synopsis:</font>
<a name="line1015">1015: </a>#include <A href="../include/petscoptions.h.html"><petscoptions.h></A>
<a name="line1016">1016: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>(const char opt[], const char text[], const char man[], <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *set)</font>
<a name="line1018">1018: </a><font color="#B22222"> Logically Collective on the communicator passed in `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`</font>
<a name="line1020">1020: </a><font color="#B22222"> Input Parameters:</font>
<a name="line1021">1021: </a><font color="#B22222">+ opt - option name</font>
<a name="line1022">1022: </a><font color="#B22222">. text - short string that describes the option</font>
<a name="line1023">1023: </a><font color="#B22222">- man - manual page with additional information on option</font>
<a name="line1025">1025: </a><font color="#B22222"> Output Parameter:</font>
<a name="line1026">1026: </a><font color="#B22222">. set - `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>` if found, else `<a href="../manualpages/Sys/PETSC_FALSE.html">PETSC_FALSE</a>`</font>
<a name="line1028">1028: </a><font color="#B22222"> Level: intermediate</font>
<a name="line1030">1030: </a><font color="#B22222"> Notes:</font>
<a name="line1031">1031: </a><font color="#B22222"> Must be used between a `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` and a `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`</font>
<a name="line1033">1033: </a><font color="#B22222"> Must follow a `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()`</font>
<a name="line1035">1035: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetReal.html">PetscOptionsGetReal</a>()`,</font>
<a name="line1036">1036: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsHasName.html">PetscOptionsHasName</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetIntArray.html">PetscOptionsGetIntArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetRealArray.html">PetscOptionsGetRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`,</font>
<a name="line1037">1037: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>()`, `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`,</font>
<a name="line1038">1038: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`,</font>
<a name="line1039">1039: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`,</font>
<a name="line1040">1040: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>()`</font>
<a name="line1041">1041: </a><font color="#B22222">M*/</font>
<a name="line1042">1042: </a><strong><font color="#228B22"> #define <a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>(opt, text, man, set) PetscOptionsBoolGroupEnd_Private(PetscOptionsObject, opt, text, man, set)</font></strong>
<a name="line1044">1044: </a><font color="#B22222">/*MC</font>
<a name="line1045">1045: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a> - Puts a list of option values that a single one may be selected from</font>
<a name="line1047">1047: </a><font color="#B22222"> Synopsis:</font>
<a name="line1048">1048: </a>#include <A href="../include/petscoptions.h.html"><petscoptions.h></A>
<a name="line1049">1049: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>(const char opt[], const char ltext[], const char man[], <a href="../manualpages/Sys/PetscFunctionList.html">PetscFunctionList</a> list, const char currentvalue[], char value[], size_t len, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *set)</font>
<a name="line1051">1051: </a><font color="#B22222"> Logically Collective on the communicator passed in `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`</font>
<a name="line1053">1053: </a><font color="#B22222"> Input Parameters:</font>
<a name="line1054">1054: </a><font color="#B22222">+ opt - option name</font>
<a name="line1055">1055: </a><font color="#B22222">. ltext - short string that describes the option</font>
<a name="line1056">1056: </a><font color="#B22222">. man - manual page with additional information on option</font>
<a name="line1057">1057: </a><font color="#B22222">. list - the possible choices</font>
<a name="line1058">1058: </a><font color="#B22222">. currentvalue - the current value; caller is responsible for setting this value correctly. Normally this is done with</font>
<a name="line1059">1059: </a><font color="#B22222">.vb</font>
<a name="line1060">1060: </a><font color="#B22222"> PetscOptionsFlist(..., obj->value,value,len,&set);</font>
<a name="line1061">1061: </a><font color="#B22222"> if (set) {</font>
<a name="line1062">1062: </a><font color="#B22222">.ve</font>
<a name="line1063">1063: </a><font color="#B22222">- len - the length of the character array value</font>
<a name="line1065">1065: </a><font color="#B22222"> Output Parameters:</font>
<a name="line1066">1066: </a><font color="#B22222">+ value - the value to return</font>
<a name="line1067">1067: </a><font color="#B22222">- set - `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>` if found, else `<a href="../manualpages/Sys/PETSC_FALSE.html">PETSC_FALSE</a>`</font>
<a name="line1069">1069: </a><font color="#B22222"> Level: intermediate</font>
<a name="line1071">1071: </a><font color="#B22222"> Notes:</font>
<a name="line1072">1072: </a><font color="#B22222"> Must be used between a `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` and a `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`</font>
<a name="line1074">1074: </a><font color="#B22222"> If the user does not supply the option at all `value` is NOT changed. Thus</font>
<a name="line1075">1075: </a><font color="#B22222"> you should ALWAYS initialize `value` if you access it without first checking that the `set` flag is `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>`.</font>
<a name="line1077">1077: </a><font color="#B22222"> The `currentvalue` passed into this routine does not get transferred to the output `value` variable automatically.</font>
<a name="line1079">1079: </a><font color="#B22222"> See `<a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>()` for when the choices are given in a string array</font>
<a name="line1081">1081: </a><font color="#B22222"> To get a listing of all currently specified options,</font>
<a name="line1082">1082: </a><font color="#B22222"> see `<a href="../manualpages/Sys/PetscOptionsView.html">PetscOptionsView</a>()` or `<a href="../manualpages/Sys/PetscOptionsGetAll.html">PetscOptionsGetAll</a>()`</font>
<a name="line1084">1084: </a><font color="#B22222"> Developer Note:</font>
<a name="line1085">1085: </a><font color="#B22222"> This cannot check for invalid selection because of things like `<a href="../manualpages/Mat/MATAIJ.html">MATAIJ</a>` that are not included in the list</font>
<a name="line1087">1087: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetReal.html">PetscOptionsGetReal</a>()`,</font>
<a name="line1088">1088: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsHasName.html">PetscOptionsHasName</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetIntArray.html">PetscOptionsGetIntArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetRealArray.html">PetscOptionsGetRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`,</font>
<a name="line1089">1089: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>()`, `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`,</font>
<a name="line1090">1090: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`,</font>
<a name="line1091">1091: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`,</font>
<a name="line1092">1092: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnum.html">PetscOptionsEnum</a>()`</font>
<a name="line1093">1093: </a><font color="#B22222">M*/</font>
<a name="line1094">1094: </a><strong><font color="#228B22"> #define <a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>(opt, ltext, man, list, currentvalue, value, len, set) PetscOptionsFList_Private(PetscOptionsObject, opt, ltext, man, list, currentvalue, value, len, set)</font></strong>
<a name="line1096">1096: </a><font color="#B22222">/*MC</font>
<a name="line1097">1097: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a> - Puts a list of option values that a single one may be selected from</font>
<a name="line1099">1099: </a><font color="#B22222"> Synopsis:</font>
<a name="line1100">1100: </a>#include <A href="../include/petscoptions.h.html"><petscoptions.h></A>
<a name="line1101">1101: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>(const char opt[], const char ltext[], const char man[], const char *const *list, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> ntext, const char currentvalue[], <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *value, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *set)</font>
<a name="line1103">1103: </a><font color="#B22222"> Logically Collective on the communicator passed in `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`</font>
<a name="line1105">1105: </a><font color="#B22222"> Input Parameters:</font>
<a name="line1106">1106: </a><font color="#B22222">+ opt - option name</font>
<a name="line1107">1107: </a><font color="#B22222">. ltext - short string that describes the option</font>
<a name="line1108">1108: </a><font color="#B22222">. man - manual page with additional information on option</font>
<a name="line1109">1109: </a><font color="#B22222">. list - the possible choices (one of these must be selected, anything else is invalid)</font>
<a name="line1110">1110: </a><font color="#B22222">. ntext - number of choices</font>
<a name="line1111">1111: </a><font color="#B22222">- currentvalue - the current value; caller is responsible for setting this value correctly. Normally this is done with</font>
<a name="line1112">1112: </a><font color="#B22222">.vb</font>
<a name="line1113">1113: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>(..., obj->value,&value,&set);</font>
<a name="line1114">1114: </a><font color="#B22222">.ve if (set) {</font>
<a name="line1116">1116: </a><font color="#B22222"> Output Parameters:</font>
<a name="line1117">1117: </a><font color="#B22222">+ value - the index of the value to return</font>
<a name="line1118">1118: </a><font color="#B22222">- set - `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>` if found, else `<a href="../manualpages/Sys/PETSC_FALSE.html">PETSC_FALSE</a>`</font>
<a name="line1120">1120: </a><font color="#B22222"> Level: intermediate</font>
<a name="line1122">1122: </a><font color="#B22222"> Notes:</font>
<a name="line1123">1123: </a><font color="#B22222"> Must be used between a `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` and a `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`</font>
<a name="line1125">1125: </a><font color="#B22222"> If the user does not supply the option at all `value` is NOT changed. Thus</font>
<a name="line1126">1126: </a><font color="#B22222"> you should ALWAYS initialize `value` if you access it without first checking that the `set` flag is `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>`.</font>
<a name="line1128">1128: </a><font color="#B22222"> See `<a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>()` for when the choices are given in a `<a href="../manualpages/Sys/PetscFunctionList.html">PetscFunctionList</a>()`</font>
<a name="line1130">1130: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetReal.html">PetscOptionsGetReal</a>()`,</font>
<a name="line1131">1131: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsHasName.html">PetscOptionsHasName</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetIntArray.html">PetscOptionsGetIntArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetRealArray.html">PetscOptionsGetRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`,</font>
<a name="line1132">1132: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>()`, `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`,</font>
<a name="line1133">1133: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`,</font>
<a name="line1134">1134: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`,</font>
<a name="line1135">1135: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnum.html">PetscOptionsEnum</a>()`</font>
<a name="line1136">1136: </a><font color="#B22222">M*/</font>
<a name="line1137">1137: </a><strong><font color="#228B22"> #define <a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>(opt, ltext, man, list, ntext, currentvalue, value, set) PetscOptionsEList_Private(PetscOptionsObject, opt, ltext, man, list, ntext, currentvalue, value, set)</font></strong>
<a name="line1139">1139: </a><font color="#B22222">/*MC</font>
<a name="line1140">1140: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a> - Gets an array of double values for a particular</font>
<a name="line1141">1141: </a><font color="#B22222"> option in the database. The values must be separated with commas with</font>
<a name="line1142">1142: </a><font color="#B22222"> no intervening spaces.</font>
<a name="line1144">1144: </a><font color="#B22222"> Synopsis:</font>
<a name="line1145">1145: </a>#include <A href="../include/petscoptions.h.html"><petscoptions.h></A>
<a name="line1146">1146: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>(const char opt[], const char text[], const char man[], <a href="../manualpages/Sys/PetscReal.html">PetscReal</a> value[], <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *n, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *set)</font>
<a name="line1148">1148: </a><font color="#B22222"> Logically Collective on the communicator passed in `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`</font>
<a name="line1150">1150: </a><font color="#B22222"> Input Parameters:</font>
<a name="line1151">1151: </a><font color="#B22222">+ opt - the option one is seeking</font>
<a name="line1152">1152: </a><font color="#B22222">. text - short string describing option</font>
<a name="line1153">1153: </a><font color="#B22222">. man - manual page for option</font>
<a name="line1154">1154: </a><font color="#B22222">- n - maximum number of values that value has room for</font>
<a name="line1156">1156: </a><font color="#B22222"> Output Parameters:</font>
<a name="line1157">1157: </a><font color="#B22222">+ value - location to copy values</font>
<a name="line1158">1158: </a><font color="#B22222">. n - actual number of values found</font>
<a name="line1159">1159: </a><font color="#B22222">- set - `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>` if found, else `<a href="../manualpages/Sys/PETSC_FALSE.html">PETSC_FALSE</a>`</font>
<a name="line1161">1161: </a><font color="#B22222"> Level: beginner</font>
<a name="line1163">1163: </a><font color="#B22222"> Note:</font>
<a name="line1164">1164: </a><font color="#B22222"> Must be used between a `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` and a `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`</font>
<a name="line1166">1166: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetReal.html">PetscOptionsGetReal</a>()`,</font>
<a name="line1167">1167: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsHasName.html">PetscOptionsHasName</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetIntArray.html">PetscOptionsGetIntArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetRealArray.html">PetscOptionsGetRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`,</font>
<a name="line1168">1168: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>()`, `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`,</font>
<a name="line1169">1169: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`,</font>
<a name="line1170">1170: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`,</font>
<a name="line1171">1171: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>()`</font>
<a name="line1172">1172: </a><font color="#B22222">M*/</font>
<a name="line1173">1173: </a><strong><font color="#228B22"> #define <a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>(opt, text, man, currentvalue, value, set) PetscOptionsRealArray_Private(PetscOptionsObject, opt, text, man, currentvalue, value, set)</font></strong>
<a name="line1175">1175: </a><font color="#B22222">/*MC</font>
<a name="line1176">1176: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsScalarArray.html">PetscOptionsScalarArray</a> - Gets an array of `<a href="../manualpages/Sys/PetscScalar.html">PetscScalar</a>` values for a particular</font>
<a name="line1177">1177: </a><font color="#B22222"> option in the database. The values must be separated with commas with</font>
<a name="line1178">1178: </a><font color="#B22222"> no intervening spaces.</font>
<a name="line1180">1180: </a><font color="#B22222"> Synopsis:</font>
<a name="line1181">1181: </a>#include <A href="../include/petscoptions.h.html"><petscoptions.h></A>
<a name="line1182">1182: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsScalarArray.html">PetscOptionsScalarArray</a>(const char opt[], const char text[], const char man[], <a href="../manualpages/Sys/PetscScalar.html">PetscScalar</a> value[], <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *n, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *set)</font>
<a name="line1184">1184: </a><font color="#B22222"> Logically Collective on the communicator passed in `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`</font>
<a name="line1186">1186: </a><font color="#B22222"> Input Parameters:</font>
<a name="line1187">1187: </a><font color="#B22222">+ opt - the option one is seeking</font>
<a name="line1188">1188: </a><font color="#B22222">. text - short string describing option</font>
<a name="line1189">1189: </a><font color="#B22222">. man - manual page for option</font>
<a name="line1190">1190: </a><font color="#B22222">- n - maximum number of values allowed in the value array</font>
<a name="line1192">1192: </a><font color="#B22222"> Output Parameters:</font>
<a name="line1193">1193: </a><font color="#B22222">+ value - location to copy values</font>
<a name="line1194">1194: </a><font color="#B22222">. n - actual number of values found</font>
<a name="line1195">1195: </a><font color="#B22222">- set - `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>` if found, else `<a href="../manualpages/Sys/PETSC_FALSE.html">PETSC_FALSE</a>`</font>
<a name="line1197">1197: </a><font color="#B22222"> Level: beginner</font>
<a name="line1199">1199: </a><font color="#B22222"> Note:</font>
<a name="line1200">1200: </a><font color="#B22222"> Must be used between a `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` and a `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`</font>
<a name="line1202">1202: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetReal.html">PetscOptionsGetReal</a>()`,</font>
<a name="line1203">1203: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsHasName.html">PetscOptionsHasName</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetIntArray.html">PetscOptionsGetIntArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetRealArray.html">PetscOptionsGetRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`,</font>
<a name="line1204">1204: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>()`, `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`,</font>
<a name="line1205">1205: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`,</font>
<a name="line1206">1206: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`,</font>
<a name="line1207">1207: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>()`</font>
<a name="line1208">1208: </a><font color="#B22222">M*/</font>
<a name="line1209">1209: </a><strong><font color="#228B22"> #define <a href="../manualpages/Sys/PetscOptionsScalarArray.html">PetscOptionsScalarArray</a>(opt, text, man, currentvalue, value, set) PetscOptionsScalarArray_Private(PetscOptionsObject, opt, text, man, currentvalue, value, set)</font></strong>
<a name="line1211">1211: </a><font color="#B22222">/*MC</font>
<a name="line1212">1212: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsIntArray.html">PetscOptionsIntArray</a> - Gets an array of integers for a particular</font>
<a name="line1213">1213: </a><font color="#B22222"> option in the database.</font>
<a name="line1215">1215: </a><font color="#B22222"> Synopsis:</font>
<a name="line1216">1216: </a>#include <A href="../include/petscoptions.h.html"><petscoptions.h></A>
<a name="line1217">1217: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsIntArray.html">PetscOptionsIntArray</a>(const char opt[], const char text[], const char man[], <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> value[], <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *n, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *set)</font>
<a name="line1219">1219: </a><font color="#B22222"> Logically Collective on the communicator passed in `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`</font>
<a name="line1221">1221: </a><font color="#B22222"> Input Parameters:</font>
<a name="line1222">1222: </a><font color="#B22222">+ opt - the option one is seeking</font>
<a name="line1223">1223: </a><font color="#B22222">. text - short string describing option</font>
<a name="line1224">1224: </a><font color="#B22222">. man - manual page for option</font>
<a name="line1225">1225: </a><font color="#B22222">- n - maximum number of values</font>
<a name="line1227">1227: </a><font color="#B22222"> Output Parameters:</font>
<a name="line1228">1228: </a><font color="#B22222">+ value - location to copy values</font>
<a name="line1229">1229: </a><font color="#B22222">. n - actual number of values found</font>
<a name="line1230">1230: </a><font color="#B22222">- set - `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>` if found, else `<a href="../manualpages/Sys/PETSC_FALSE.html">PETSC_FALSE</a>`</font>
<a name="line1232">1232: </a><font color="#B22222"> Level: beginner</font>
<a name="line1234">1234: </a><font color="#B22222"> Notes:</font>
<a name="line1235">1235: </a><font color="#B22222"> The array can be passed as</font>
<a name="line1236">1236: </a><font color="#B22222">+ a comma separated list - 0,1,2,3,4,5,6,7</font>
<a name="line1237">1237: </a><font color="#B22222">. a range (start\-end+1) - 0-8</font>
<a name="line1238">1238: </a><font color="#B22222">. a range with given increment (start\-end+1:inc) - 0-7:2</font>
<a name="line1239">1239: </a><font color="#B22222">- a combination of values and ranges separated by commas - 0,1-8,8-15:2</font>
<a name="line1241">1241: </a><font color="#B22222"> There must be no intervening spaces between the values.</font>
<a name="line1243">1243: </a><font color="#B22222"> Must be used between a `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` and a `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`</font>
<a name="line1245">1245: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetReal.html">PetscOptionsGetReal</a>()`,</font>
<a name="line1246">1246: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsHasName.html">PetscOptionsHasName</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetIntArray.html">PetscOptionsGetIntArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetRealArray.html">PetscOptionsGetRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`,</font>
<a name="line1247">1247: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>()`, `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`,</font>
<a name="line1248">1248: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`,</font>
<a name="line1249">1249: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`,</font>
<a name="line1250">1250: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>()`</font>
<a name="line1251">1251: </a><font color="#B22222">M*/</font>
<a name="line1252">1252: </a><strong><font color="#228B22"> #define <a href="../manualpages/Sys/PetscOptionsIntArray.html">PetscOptionsIntArray</a>(opt, text, man, currentvalue, value, set) PetscOptionsIntArray_Private(PetscOptionsObject, opt, text, man, currentvalue, value, set)</font></strong>
<a name="line1254">1254: </a><font color="#B22222">/*MC</font>
<a name="line1255">1255: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a> - Gets an array of string values for a particular</font>
<a name="line1256">1256: </a><font color="#B22222"> option in the database. The values must be separated with commas with</font>
<a name="line1257">1257: </a><font color="#B22222"> no intervening spaces.</font>
<a name="line1259">1259: </a><font color="#B22222"> Synopsis:</font>
<a name="line1260">1260: </a>#include <A href="../include/petscoptions.h.html"><petscoptions.h></A>
<a name="line1261">1261: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>(const char opt[], const char text[], const char man[], char *value[], <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *nmax, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *set)</font>
<a name="line1263">1263: </a><font color="#B22222"> Logically Collective on the communicator passed in `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`; No Fortran Support</font>
<a name="line1265">1265: </a><font color="#B22222"> Input Parameters:</font>
<a name="line1266">1266: </a><font color="#B22222">+ opt - the option one is seeking</font>
<a name="line1267">1267: </a><font color="#B22222">. text - short string describing option</font>
<a name="line1268">1268: </a><font color="#B22222">. man - manual page for option</font>
<a name="line1269">1269: </a><font color="#B22222">- nmax - maximum number of strings</font>
<a name="line1271">1271: </a><font color="#B22222"> Output Parameters:</font>
<a name="line1272">1272: </a><font color="#B22222">+ value - location to copy strings</font>
<a name="line1273">1273: </a><font color="#B22222">. nmax - actual number of strings found</font>
<a name="line1274">1274: </a><font color="#B22222">- set - `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>` if found, else `<a href="../manualpages/Sys/PETSC_FALSE.html">PETSC_FALSE</a>`</font>
<a name="line1276">1276: </a><font color="#B22222"> Level: beginner</font>
<a name="line1278">1278: </a><font color="#B22222"> Notes:</font>
<a name="line1279">1279: </a><font color="#B22222"> The user should pass in an array of pointers to char, to hold all the</font>
<a name="line1280">1280: </a><font color="#B22222"> strings returned by this function.</font>
<a name="line1282">1282: </a><font color="#B22222"> The user is responsible for deallocating the strings that are</font>
<a name="line1283">1283: </a><font color="#B22222"> returned.</font>
<a name="line1285">1285: </a><font color="#B22222"> Must be used between a `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` and a `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`</font>
<a name="line1287">1287: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetReal.html">PetscOptionsGetReal</a>()`,</font>
<a name="line1288">1288: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsHasName.html">PetscOptionsHasName</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetIntArray.html">PetscOptionsGetIntArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetRealArray.html">PetscOptionsGetRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`,</font>
<a name="line1289">1289: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>()`, `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`,</font>
<a name="line1290">1290: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`,</font>
<a name="line1291">1291: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`,</font>
<a name="line1292">1292: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>()`</font>
<a name="line1293">1293: </a><font color="#B22222">M*/</font>
<a name="line1294">1294: </a><strong><font color="#228B22"> #define <a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>(opt, text, man, currentvalue, value, set) PetscOptionsStringArray_Private(PetscOptionsObject, opt, text, man, currentvalue, value, set)</font></strong>
<a name="line1296">1296: </a><font color="#B22222">/*MC</font>
<a name="line1297">1297: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsBoolArray.html">PetscOptionsBoolArray</a> - Gets an array of logical values (true or false) for a particular</font>
<a name="line1298">1298: </a><font color="#B22222"> option in the database. The values must be separated with commas with</font>
<a name="line1299">1299: </a><font color="#B22222"> no intervening spaces.</font>
<a name="line1301">1301: </a><font color="#B22222"> Synopsis:</font>
<a name="line1302">1302: </a>#include <A href="../include/petscoptions.h.html"><petscoptions.h></A>
<a name="line1303">1303: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsBoolArray.html">PetscOptionsBoolArray</a>(const char opt[], const char text[], const char man[], <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> value[], <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *n, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *set)</font>
<a name="line1305">1305: </a><font color="#B22222"> Logically Collective on the communicator passed in `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`</font>
<a name="line1307">1307: </a><font color="#B22222"> Input Parameters:</font>
<a name="line1308">1308: </a><font color="#B22222">+ opt - the option one is seeking</font>
<a name="line1309">1309: </a><font color="#B22222">. text - short string describing option</font>
<a name="line1310">1310: </a><font color="#B22222">. man - manual page for option</font>
<a name="line1311">1311: </a><font color="#B22222">- n - maximum number of values allowed in the value array</font>
<a name="line1313">1313: </a><font color="#B22222"> Output Parameters:</font>
<a name="line1314">1314: </a><font color="#B22222">+ value - location to copy values</font>
<a name="line1315">1315: </a><font color="#B22222">. n - actual number of values found</font>
<a name="line1316">1316: </a><font color="#B22222">- set - `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>` if found, else `<a href="../manualpages/Sys/PETSC_FALSE.html">PETSC_FALSE</a>`</font>
<a name="line1318">1318: </a><font color="#B22222"> Level: beginner</font>
<a name="line1320">1320: </a><font color="#B22222"> Notes:</font>
<a name="line1321">1321: </a><font color="#B22222"> The user should pass in an array of `<a href="../manualpages/Sys/PetscBool.html">PetscBool</a>`</font>
<a name="line1323">1323: </a><font color="#B22222"> Must be used between a `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` and a `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`</font>
<a name="line1325">1325: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetReal.html">PetscOptionsGetReal</a>()`,</font>
<a name="line1326">1326: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsHasName.html">PetscOptionsHasName</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetIntArray.html">PetscOptionsGetIntArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetRealArray.html">PetscOptionsGetRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`,</font>
<a name="line1327">1327: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>()`, `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`,</font>
<a name="line1328">1328: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`,</font>
<a name="line1329">1329: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`,</font>
<a name="line1330">1330: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>()`</font>
<a name="line1331">1331: </a><font color="#B22222">M*/</font>
<a name="line1332">1332: </a><strong><font color="#228B22"> #define <a href="../manualpages/Sys/PetscOptionsBoolArray.html">PetscOptionsBoolArray</a>(opt, text, man, currentvalue, value, set) PetscOptionsBoolArray_Private(PetscOptionsObject, opt, text, man, currentvalue, value, set)</font></strong>
<a name="line1334">1334: </a><font color="#B22222">/*MC</font>
<a name="line1335">1335: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsEnumArray.html">PetscOptionsEnumArray</a> - Gets an array of enum values for a particular</font>
<a name="line1336">1336: </a><font color="#B22222"> option in the database.</font>
<a name="line1338">1338: </a><font color="#B22222"> Synopsis:</font>
<a name="line1339">1339: </a>#include <A href="../include/petscoptions.h.html"><petscoptions.h></A>
<a name="line1340">1340: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsEnumArray.html">PetscOptionsEnumArray</a>(const char opt[], const char text[], const char man[], const char *const *list, <a href="../manualpages/Sys/PetscEnum.html">PetscEnum</a> value[], <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *n, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *set)</font>
<a name="line1342">1342: </a><font color="#B22222"> Logically Collective on the communicator passed in `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`</font>
<a name="line1344">1344: </a><font color="#B22222"> Input Parameters:</font>
<a name="line1345">1345: </a><font color="#B22222">+ opt - the option one is seeking</font>
<a name="line1346">1346: </a><font color="#B22222">. text - short string describing option</font>
<a name="line1347">1347: </a><font color="#B22222">. man - manual page for option</font>
<a name="line1348">1348: </a><font color="#B22222">. list - array containing the list of choices, followed by the enum name, followed by the enum prefix, followed by a null</font>
<a name="line1349">1349: </a><font color="#B22222">- n - maximum number of values allowed in the value array</font>
<a name="line1351">1351: </a><font color="#B22222"> Output Parameters:</font>
<a name="line1352">1352: </a><font color="#B22222">+ value - location to copy values</font>
<a name="line1353">1353: </a><font color="#B22222">. n - actual number of values found</font>
<a name="line1354">1354: </a><font color="#B22222">- set - `<a href="../manualpages/Sys/PETSC_TRUE.html">PETSC_TRUE</a>` if found, else `<a href="../manualpages/Sys/PETSC_FALSE.html">PETSC_FALSE</a>`</font>
<a name="line1356">1356: </a><font color="#B22222"> Level: beginner</font>
<a name="line1358">1358: </a><font color="#B22222"> Notes:</font>
<a name="line1359">1359: </a><font color="#B22222"> The array must be passed as a comma separated list.</font>
<a name="line1361">1361: </a><font color="#B22222"> There must be no intervening spaces between the values.</font>
<a name="line1363">1363: </a><font color="#B22222"> Must be used between a `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` and a `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`</font>
<a name="line1365">1365: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsGetInt.html">PetscOptionsGetInt</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetReal.html">PetscOptionsGetReal</a>()`,</font>
<a name="line1366">1366: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsHasName.html">PetscOptionsHasName</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetIntArray.html">PetscOptionsGetIntArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetRealArray.html">PetscOptionsGetRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsGetBool.html">PetscOptionsGetBool</a>()`,</font>
<a name="line1367">1367: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsName.html">PetscOptionsName</a>()`, `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, `<a href="../manualpages/Sys/PetscOptionsHeadBegin.html">PetscOptionsHeadBegin</a>()`,</font>
<a name="line1368">1368: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsStringArray.html">PetscOptionsStringArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsRealArray.html">PetscOptionsRealArray</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`,</font>
<a name="line1369">1369: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsBoolGroupBegin.html">PetscOptionsBoolGroupBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroup.html">PetscOptionsBoolGroup</a>()`, `<a href="../manualpages/Sys/PetscOptionsBoolGroupEnd.html">PetscOptionsBoolGroupEnd</a>()`,</font>
<a name="line1370">1370: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscOptionsFList.html">PetscOptionsFList</a>()`, `<a href="../manualpages/Sys/PetscOptionsEList.html">PetscOptionsEList</a>()`</font>
<a name="line1371">1371: </a><font color="#B22222">M*/</font>
<a name="line1372">1372: </a><strong><font color="#228B22"> #define <a href="../manualpages/Sys/PetscOptionsEnumArray.html">PetscOptionsEnumArray</a>(opt, text, man, list, value, n, set) PetscOptionsEnumArray_Private(PetscOptionsObject, opt, text, man, list, value, n, set)</font></strong>
<a name="line1374">1374: </a><font color="#B22222">/*MC</font>
<a name="line1375">1375: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsDeprecated.html">PetscOptionsDeprecated</a> - mark an option as deprecated, optionally replacing it with `newname`</font>
<a name="line1377">1377: </a><font color="#B22222"> Prints a deprecation warning, unless an option is supplied to suppress.</font>
<a name="line1379">1379: </a><font color="#B22222"> Logically Collective</font>
<a name="line1381">1381: </a><font color="#B22222"> Input Parameters:</font>
<a name="line1382">1382: </a><font color="#B22222">+ oldname - the old, deprecated option</font>
<a name="line1383">1383: </a><font color="#B22222">. newname - the new option, or `NULL` if option is purely removed</font>
<a name="line1384">1384: </a><font color="#B22222">. version - a string describing the version of first deprecation, e.g. "3.9"</font>
<a name="line1385">1385: </a><font color="#B22222">- info - additional information string, or `NULL`.</font>
<a name="line1387">1387: </a><font color="#B22222"> Options Database Key:</font>
<a name="line1388">1388: </a><font color="#B22222">. -options_suppress_deprecated_warnings - do not print deprecation warnings</font>
<a name="line1390">1390: </a><font color="#B22222"> Level: developer</font>
<a name="line1392">1392: </a><font color="#B22222"> Notes:</font>
<a name="line1393">1393: </a><font color="#B22222"> If `newname` is provided then the options database will automatically check the database for `oldname`.</font>
<a name="line1395">1395: </a><font color="#B22222"> The old call `PetscOptionsXXX`(`oldname`) should be removed from the source code when both (1) the call to `<a href="../manualpages/Sys/PetscOptionsDeprecated.html">PetscOptionsDeprecated</a>()` occurs before the</font>
<a name="line1396">1396: </a><font color="#B22222"> new call to `PetscOptionsXXX`(`newname`) and (2) the argument handling of the new call to `PetscOptionsXXX`(`newname`) is identical to the previous call.</font>
<a name="line1397">1397: </a><font color="#B22222"> See `PTScotch_PartGraph_Seq()` for an example of when (1) fails and `SNESTestJacobian()` where an example of (2) fails.</font>
<a name="line1399">1399: </a><font color="#B22222"> Must be called between `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` (or `<a href="../manualpages/Sys/PetscObjectOptionsBegin.html">PetscObjectOptionsBegin</a>()`) and `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`.</font>
<a name="line1400">1400: </a><font color="#B22222"> Only the process of MPI rank zero that owns the `PetscOptionsItems` are argument (managed by `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` or `<a href="../manualpages/Sys/PetscObjectOptionsBegin.html">PetscObjectOptionsBegin</a>()` prints the information</font>
<a name="line1401">1401: </a><font color="#B22222"> If newname is provided, the old option is replaced. Otherwise, it remains in the options database.</font>
<a name="line1402">1402: </a><font color="#B22222"> If an option is not replaced, the info argument should be used to advise the user on how to proceed.</font>
<a name="line1403">1403: </a><font color="#B22222"> There is a limit on the length of the warning printed, so very long strings provided as info may be truncated.</font>
<a name="line1405">1405: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`, `<a href="../manualpages/Sys/PetscOptionsString.html">PetscOptionsString</a>()`, `<a href="../manualpages/Sys/PetscOptionsSetValue.html">PetscOptionsSetValue</a>()`</font>
<a name="line1406">1406: </a><font color="#B22222">M*/</font>
<a name="line1407">1407: </a><strong><font color="#228B22"> #define <a href="../manualpages/Sys/PetscOptionsDeprecated.html">PetscOptionsDeprecated</a>(opt, text, man, info) <a href="../manualpages/Sys/PetscOptionsDeprecated_Private.html">PetscOptionsDeprecated_Private</a>(PetscOptionsObject, opt, text, man, info)</font></strong>
<a name="line1409">1409: </a><font color="#B22222">/*MC</font>
<a name="line1410">1410: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscOptionsDeprecatedMoObject.html">PetscOptionsDeprecatedMoObject</a> - mark an option as deprecated in the global PetscOptionsObject, optionally replacing it with `newname`</font>
<a name="line1412">1412: </a><font color="#B22222"> Prints a deprecation warning, unless an option is supplied to suppress.</font>
<a name="line1414">1414: </a><font color="#B22222"> Logically Collective</font>
<a name="line1416">1416: </a><font color="#B22222"> Input Parameters:</font>
<a name="line1417">1417: </a><font color="#B22222">+ oldname - the old, deprecated option</font>
<a name="line1418">1418: </a><font color="#B22222">. newname - the new option, or `NULL` if option is purely removed</font>
<a name="line1419">1419: </a><font color="#B22222">. version - a string describing the version of first deprecation, e.g. "3.9"</font>
<a name="line1420">1420: </a><font color="#B22222">- info - additional information string, or `NULL`.</font>
<a name="line1422">1422: </a><font color="#B22222"> Options Database Key:</font>
<a name="line1423">1423: </a><font color="#B22222">. -options_suppress_deprecated_warnings - do not print deprecation warnings</font>
<a name="line1425">1425: </a><font color="#B22222"> Level: developer</font>
<a name="line1427">1427: </a><font color="#B22222"> Notes:</font>
<a name="line1428">1428: </a><font color="#B22222"> If `newname` is provided then the options database will automatically check the database for `oldname`.</font>
<a name="line1430">1430: </a><font color="#B22222"> The old call `PetscOptionsXXX`(`oldname`) should be removed from the source code when both (1) the call to `<a href="../manualpages/Sys/PetscOptionsDeprecated.html">PetscOptionsDeprecated</a>()` occurs before the</font>
<a name="line1431">1431: </a><font color="#B22222"> new call to `PetscOptionsXXX`(`newname`) and (2) the argument handling of the new call to `PetscOptionsXXX`(`newname`) is identical to the previous call.</font>
<a name="line1432">1432: </a><font color="#B22222"> See `PTScotch_PartGraph_Seq()` for an example of when (1) fails and `SNESTestJacobian()` where an example of (2) fails.</font>
<a name="line1434">1434: </a><font color="#B22222"> Only the process of MPI rank zero that owns the `PetscOptionsItems` are argument (managed by `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()` or `<a href="../manualpages/Sys/PetscObjectOptionsBegin.html">PetscObjectOptionsBegin</a>()` prints the information</font>
<a name="line1435">1435: </a><font color="#B22222"> If newname is provided, the old option is replaced. Otherwise, it remains in the options database.</font>
<a name="line1436">1436: </a><font color="#B22222"> If an option is not replaced, the info argument should be used to advise the user on how to proceed.</font>
<a name="line1437">1437: </a><font color="#B22222"> There is a limit on the length of the warning printed, so very long strings provided as info may be truncated.</font>
<a name="line1439">1439: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscOptionsBegin.html">PetscOptionsBegin</a>()`, `<a href="../manualpages/Sys/PetscOptionsEnd.html">PetscOptionsEnd</a>()`, `<a href="../manualpages/Sys/PetscOptionsScalar.html">PetscOptionsScalar</a>()`, `<a href="../manualpages/Sys/PetscOptionsBool.html">PetscOptionsBool</a>()`, `<a href="../manualpages/Sys/PetscOptionsString.html">PetscOptionsString</a>()`, `<a href="../manualpages/Sys/PetscOptionsSetValue.html">PetscOptionsSetValue</a>()`</font>
<a name="line1440">1440: </a><font color="#B22222">M*/</font>
<a name="line1441">1441: </a><strong><font color="#228B22"> #define PetscOptionsDeprecatedNoObject(opt, text, man, info) <a href="../manualpages/Sys/PetscOptionsDeprecated_Private.html">PetscOptionsDeprecated_Private</a>(NULL, opt, text, man, info)</font></strong>
<a name="line1442">1442: </a><font color="#A020F0">#endif </font><font color="#B22222">/* PETSC_CLANG_STATIC_ANALYZER */</font><font color="#A020F0"></font>
<a name="line1444">1444: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscOptionsEnum_Private(PetscOptionItems, const char[], const char[], const char[], const char *const *, <a href="../manualpages/Sys/PetscEnum.html">PetscEnum</a>, <a href="../manualpages/Sys/PetscEnum.html">PetscEnum</a> *, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line1445">1445: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscOptionsInt_Private(PetscOptionItems, const char[], const char[], const char[], <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>)</font></strong>;
<a name="line1446">1446: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscOptionsMPIInt_Private(PetscOptionItems, const char[], const char[], const char[], <a href="../manualpages/Sys/PetscMPIInt.html">PetscMPIInt</a>, <a href="../manualpages/Sys/PetscMPIInt.html">PetscMPIInt</a> *, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *, <a href="../manualpages/Sys/PetscMPIInt.html">PetscMPIInt</a>, <a href="../manualpages/Sys/PetscMPIInt.html">PetscMPIInt</a>)</font></strong>;
<a name="line1447">1447: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscOptionsReal_Private(PetscOptionItems, const char[], const char[], const char[], <a href="../manualpages/Sys/PetscReal.html">PetscReal</a>, <a href="../manualpages/Sys/PetscReal.html">PetscReal</a> *, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *, <a href="../manualpages/Sys/PetscReal.html">PetscReal</a>, <a href="../manualpages/Sys/PetscReal.html">PetscReal</a>)</font></strong>;
<a name="line1448">1448: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscOptionsScalar_Private(PetscOptionItems, const char[], const char[], const char[], <a href="../manualpages/Sys/PetscScalar.html">PetscScalar</a>, <a href="../manualpages/Sys/PetscScalar.html">PetscScalar</a> *, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line1449">1449: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscOptionsName_Private(PetscOptionItems, const char[], const char[], const char[], <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line1450">1450: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscOptionsString_Private(PetscOptionItems, const char[], const char[], const char[], const char[], char *, size_t, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line1451">1451: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscOptionsBool_Private(PetscOptionItems, const char[], const char[], const char[], <a href="../manualpages/Sys/PetscBool.html">PetscBool</a>, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line1452">1452: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscOptionsBoolGroupBegin_Private(PetscOptionItems, const char[], const char[], const char[], <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line1453">1453: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscOptionsBoolGroup_Private(PetscOptionItems, const char[], const char[], const char[], <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line1454">1454: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscOptionsBoolGroupEnd_Private(PetscOptionItems, const char[], const char[], const char[], <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line1455">1455: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscOptionsFList_Private(PetscOptionItems, const char[], const char[], const char[], <a href="../manualpages/Sys/PetscFunctionList.html">PetscFunctionList</a>, const char[], char[], size_t, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line1456">1456: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscOptionsEList_Private(PetscOptionItems, const char[], const char[], const char[], const char *const *, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>, const char[], <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line1457">1457: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscOptionsRealArray_Private(PetscOptionItems, const char[], const char[], const char[], <a href="../manualpages/Sys/PetscReal.html">PetscReal</a>[], <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line1458">1458: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscOptionsScalarArray_Private(PetscOptionItems, const char[], const char[], const char[], <a href="../manualpages/Sys/PetscScalar.html">PetscScalar</a>[], <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line1459">1459: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscOptionsIntArray_Private(PetscOptionItems, const char[], const char[], const char[], <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>[], <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line1460">1460: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscOptionsStringArray_Private(PetscOptionItems, const char[], const char[], const char[], char *[], <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line1461">1461: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscOptionsBoolArray_Private(PetscOptionItems, const char[], const char[], const char[], <a href="../manualpages/Sys/PetscBool.html">PetscBool</a>[], <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line1462">1462: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscOptionsEnumArray_Private(PetscOptionItems, const char[], const char[], const char[], const char *const *, <a href="../manualpages/Sys/PetscEnum.html">PetscEnum</a>[], <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> *, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line1463">1463: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscOptionsDeprecated_Private.html">PetscOptionsDeprecated_Private</a>(PetscOptionItems, const char[], const char[], const char[], const char[])</font></strong>;
<a name="line1465">1465: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscObjectAddOptionsHandler.html">PetscObjectAddOptionsHandler</a>(<a href="../manualpages/Sys/PetscObject.html">PetscObject</a>, <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> (*)(<a href="../manualpages/Sys/PetscObject.html">PetscObject</a>, PetscOptionItems, void *), <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> (*)(<a href="../manualpages/Sys/PetscObject.html">PetscObject</a>, void *), void *)</font></strong>;
<a name="line1466">1466: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscObjectProcessOptionsHandlers.html">PetscObjectProcessOptionsHandlers</a>(<a href="../manualpages/Sys/PetscObject.html">PetscObject</a>, PetscOptionItems)</font></strong>;
<a name="line1467">1467: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscObjectDestroyOptionsHandlers.html">PetscObjectDestroyOptionsHandlers</a>(<a href="../manualpages/Sys/PetscObject.html">PetscObject</a>)</font></strong>;
<a name="line1469">1469: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscOptionsLeftError(void)</font></strong>;
</pre>
</body>
</html>
|
