Chi-Tech
lbs__DiffusionDFEMSolver.h
Go to the documentation of this file.
1/** \defgroup lbs__DiffusionDFEMSolver DiffusionDFEMSolver
2
3
4
5\ingroup lbs__LBSSolver
6
7
8
9## Example usage:
10Create this object:
11\code
12params =
13{
14 param_name1 = value1,
15 param_name2 = value2,
16 --etc.
17}
18lbs.DiffusionDFEMSolver.Create(params)
19\endcode
20## Required Input parameters
21\htmlonly
22
23<div style="display: block;">
24<button type="button" class="droppy2" style=
25"
26background-color: #edf0f5;
27color: #9373A5;
28cursor: pointer;
29border: none;
30text-align: left;
31outline: none;
32font-size: 15px;
33margin: 2px 2px;
34border: 2px solid #687372;
35display: block;
36width: 100%;
37vertical-align: middle;
38padding-top: 4px;
39padding-bottom: 0px;
40"
41><span class="arrow" style="padding-left: 0px;">►</span><TT><B>groupsets</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspAn array of blocks each specifying the input parameters for a <TT>lbs::LBSGroupset</TT></span></button>
42<div class="content" style="display: none;">
43 <p><I>type=</I><span style="color: blue;"><TT>ARRAY</TT></span>. An array of blocks each specifying the input parameters for a <TT>lbs::LBSGroupset</TT>.
44</p>
45<div class="content" style="padding-left: 20px;">
46<HR><button type="button" class="droppy2" style=
47"
48background-color: #ffffff;
49color: #000000;
50cursor: pointer;
51border: none;
52text-align: left;
53outline: none;
54font-size: 15px;
55margin: 2px 2px;
56
57display: block;
58vertical-align: middle;
59padding-top: 4px;
60padding-bottom: 0px;
61"
62><span class="arrow" style="padding-left: 0px;">►</span><B>Required parameters for lbs::LBSGroupset</B></button>
63<div class="content" style="display: none;padding-left: 20px;">
64<div style="display: block;">
65<button type="button" class="droppy2" style=
66"
67background-color: #edf0f5;
68color: #9373A5;
69cursor: pointer;
70border: none;
71text-align: left;
72outline: none;
73font-size: 15px;
74margin: 2px 2px;
75border: 2px solid #687372;
76display: block;
77width: 100%;
78vertical-align: middle;
79padding-top: 4px;
80padding-bottom: 0px;
81"
82><span class="arrow" style="padding-left: 0px;">►</span><TT><B>angular_quadrature_handle</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspA handle to an angular quadrature</span></button>
83<div class="content" style="display: none;">
84 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. A handle to an angular quadrature
85</p>
86</div>
87
88<button type="button" class="droppy2" style=
89"
90background-color: #edf0f5;
91color: #9373A5;
92cursor: pointer;
93border: none;
94text-align: left;
95outline: none;
96font-size: 15px;
97margin: 2px 2px;
98border: 2px solid #687372;
99display: block;
100width: 100%;
101vertical-align: middle;
102padding-top: 4px;
103padding-bottom: 0px;
104"
105><span class="arrow" style="padding-left: 0px;">►</span><TT><B>groups_from_to</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspThe first and last group id this groupset operates on</span></button>
106<div class="content" style="display: none;">
107 <p><I>type=</I><span style="color: blue;"><TT>ARRAY</TT></span>. The first and last group id this groupset operates on. e.g. A 4 group problem <TT>groups_from_to= {0, 3}</TT>
108</p>
109</div>
110
111</div>
112</div>
113<button type="button" class="droppy2" style=
114"
115background-color: #ffffff;
116color: #000000;
117cursor: pointer;
118border: none;
119text-align: left;
120outline: none;
121font-size: 15px;
122margin: 2px 2px;
123
124display: block;
125vertical-align: middle;
126padding-top: 4px;
127padding-bottom: 0px;
128"
129><span class="arrow" style="padding-left: 0px;">►</span><B>Optional parameters for lbs::LBSGroupset</B></button>
130<div class="content" style="display: none;padding-left: 20px;">
131<div style="display: block;">
132<button type="button" class="droppy2" style=
133"
134background-color: #edf0f5;
135color: #9373A5;
136cursor: pointer;
137border: none;
138text-align: left;
139outline: none;
140font-size: 15px;
141margin: 2px 2px;
142border: 2px solid #687372;
143display: block;
144width: 100%;
145vertical-align: middle;
146padding-top: 4px;
147padding-bottom: 0px;
148"
149><span class="arrow" style="padding-left: 0px;">►</span><TT><B>allow_cycles</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspFlag indicating whether cycles are to be allowed or not</span></button>
150<div class="content" style="display: none;">
151 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Flag indicating whether cycles are to be allowed or not
152</p>
153 <p>Default value: <TT style="color:grey">true</TT></p>
154</div>
155
156<button type="button" class="droppy2" style=
157"
158background-color: #edf0f5;
159color: #9373A5;
160cursor: pointer;
161border: none;
162text-align: left;
163outline: none;
164font-size: 15px;
165margin: 2px 2px;
166border: 2px solid #687372;
167display: block;
168width: 100%;
169vertical-align: middle;
170padding-top: 4px;
171padding-bottom: 0px;
172"
173><span class="arrow" style="padding-left: 0px;">►</span><TT><B>angle_aggregation_num_subsets</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspThe number of subsets to apply to sets of angles that have been aggregated</span></button>
174<div class="content" style="display: none;">
175 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. The number of subsets to apply to sets of angles that have been aggregated. This is useful for increasing pipeline size for parallel simulations
176</p>
177 <p>Default value: <TT style="color:grey">1</TT></p>
178 <p>Allowable values: <TT>>= 1</TT></p>
179</div>
180
181<button type="button" class="droppy2" style=
182"
183background-color: #edf0f5;
184color: #9373A5;
185cursor: pointer;
186border: none;
187text-align: left;
188outline: none;
189font-size: 15px;
190margin: 2px 2px;
191border: 2px solid #687372;
192display: block;
193width: 100%;
194vertical-align: middle;
195padding-top: 4px;
196padding-bottom: 0px;
197"
198><span class="arrow" style="padding-left: 0px;">►</span><TT><B>angle_aggregation_type</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspThe angle aggregation method to use during sweeping</span></button>
199<div class="content" style="display: none;">
200 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. The angle aggregation method to use during sweeping
201</p>
202 <p>Default value: <TT style="color:grey">"polar"</TT></p>
203 <p>Allowable values: <TT>"polar", "single", "azimuthal"</TT></p>
204</div>
205
206<button type="button" class="droppy2" style=
207"
208background-color: #edf0f5;
209color: #9373A5;
210cursor: pointer;
211border: none;
212text-align: left;
213outline: none;
214font-size: 15px;
215margin: 2px 2px;
216border: 2px solid #687372;
217display: block;
218width: 100%;
219vertical-align: middle;
220padding-top: 4px;
221padding-bottom: 0px;
222"
223><span class="arrow" style="padding-left: 0px;">►</span><TT><B>apply_tgdsa</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspFlag to turn on Two-Grid Acceleration for this groupset</span></button>
224<div class="content" style="display: none;">
225 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Flag to turn on Two-Grid Acceleration for this groupset
226</p>
227 <p>Default value: <TT style="color:grey">false</TT></p>
228</div>
229
230<button type="button" class="droppy2" style=
231"
232background-color: #edf0f5;
233color: #9373A5;
234cursor: pointer;
235border: none;
236text-align: left;
237outline: none;
238font-size: 15px;
239margin: 2px 2px;
240border: 2px solid #687372;
241display: block;
242width: 100%;
243vertical-align: middle;
244padding-top: 4px;
245padding-bottom: 0px;
246"
247><span class="arrow" style="padding-left: 0px;">►</span><TT><B>apply_wgdsa</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspFlag to turn on within-group Diffusion Synthetic Acceleration for this groupset</span></button>
248<div class="content" style="display: none;">
249 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Flag to turn on within-group Diffusion Synthetic Acceleration for this groupset
250</p>
251 <p>Default value: <TT style="color:grey">false</TT></p>
252</div>
253
254<button type="button" class="droppy2" style=
255"
256background-color: #edf0f5;
257color: #9373A5;
258cursor: pointer;
259border: none;
260text-align: left;
261outline: none;
262font-size: 15px;
263margin: 2px 2px;
264border: 2px solid #687372;
265display: block;
266width: 100%;
267vertical-align: middle;
268padding-top: 4px;
269padding-bottom: 0px;
270"
271><span class="arrow" style="padding-left: 0px;">►</span><TT><B>gmres_restart_interval</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspIf this inner linear solver is gmres, sets the number of iterations before a restart occurs</span></button>
272<div class="content" style="display: none;">
273 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. If this inner linear solver is gmres, sets the number of iterations before a restart occurs.
274</p>
275 <p>Default value: <TT style="color:grey">30</TT></p>
276 <p>Allowable values: <TT>>= 1</TT></p>
277</div>
278
279<button type="button" class="droppy2" style=
280"
281background-color: #edf0f5;
282color: #9373A5;
283cursor: pointer;
284border: none;
285text-align: left;
286outline: none;
287font-size: 15px;
288margin: 2px 2px;
289border: 2px solid #687372;
290display: block;
291width: 100%;
292vertical-align: middle;
293padding-top: 4px;
294padding-bottom: 0px;
295"
296><span class="arrow" style="padding-left: 0px;">►</span><TT><B>groupset_num_subsets</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspThe number of subsets to apply to the set of groups in this set</span></button>
297<div class="content" style="display: none;">
298 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. The number of subsets to apply to the set of groups in this set. This is useful for increasing pipeline size for parallel simulations
299</p>
300 <p>Default value: <TT style="color:grey">1</TT></p>
301 <p>Allowable values: <TT>>= 1</TT></p>
302</div>
303
304<button type="button" class="droppy2" style=
305"
306background-color: #edf0f5;
307color: #9373A5;
308cursor: pointer;
309border: none;
310text-align: left;
311outline: none;
312font-size: 15px;
313margin: 2px 2px;
314border: 2px solid #687372;
315display: block;
316width: 100%;
317vertical-align: middle;
318padding-top: 4px;
319padding-bottom: 0px;
320"
321><span class="arrow" style="padding-left: 0px;">►</span><TT><B>inner_linear_method</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspThe iterative method to use for inner linear solves</span></button>
322<div class="content" style="display: none;">
323 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. The iterative method to use for inner linear solves
324</p>
325 <p>Default value: <TT style="color:grey">"richardson"</TT></p>
326 <p>Allowable values: <TT>"richardson", "gmres", "bicgstab"</TT></p>
327</div>
328
329<button type="button" class="droppy2" style=
330"
331background-color: #edf0f5;
332color: #9373A5;
333cursor: pointer;
334border: none;
335text-align: left;
336outline: none;
337font-size: 15px;
338margin: 2px 2px;
339border: 2px solid #687372;
340display: block;
341width: 100%;
342vertical-align: middle;
343padding-top: 4px;
344padding-bottom: 0px;
345"
346><span class="arrow" style="padding-left: 0px;">►</span><TT><B>l_abs_tol</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspInner linear solver residual absolute tolerance</span></button>
347<div class="content" style="display: none;">
348 <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Inner linear solver residual absolute tolerance
349</p>
350 <p>Default value: <TT style="color:grey">1e-06(double)</TT></p>
351 <p>Allowable values: <TT>>= 1e-18(double)</TT></p>
352</div>
353
354<button type="button" class="droppy2" style=
355"
356background-color: #edf0f5;
357color: #9373A5;
358cursor: pointer;
359border: none;
360text-align: left;
361outline: none;
362font-size: 15px;
363margin: 2px 2px;
364border: 2px solid #687372;
365display: block;
366width: 100%;
367vertical-align: middle;
368padding-top: 4px;
369padding-bottom: 0px;
370"
371><span class="arrow" style="padding-left: 0px;">►</span><TT><B>l_max_its</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspInner linear solver maximum iterations</span></button>
372<div class="content" style="display: none;">
373 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. Inner linear solver maximum iterations
374</p>
375 <p>Default value: <TT style="color:grey">200</TT></p>
376 <p>Allowable values: <TT>>= 0</TT></p>
377</div>
378
379<button type="button" class="droppy2" style=
380"
381background-color: #edf0f5;
382color: #9373A5;
383cursor: pointer;
384border: none;
385text-align: left;
386outline: none;
387font-size: 15px;
388margin: 2px 2px;
389border: 2px solid #687372;
390display: block;
391width: 100%;
392vertical-align: middle;
393padding-top: 4px;
394padding-bottom: 0px;
395"
396><span class="arrow" style="padding-left: 0px;">►</span><TT><B>log_sweep_events</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspTurns on a log of sweep events</span></button>
397<div class="content" style="display: none;">
398 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Turns on a log of sweep events
399</p>
400 <p>Default value: <TT style="color:grey">false</TT></p>
401</div>
402
403<button type="button" class="droppy2" style=
404"
405background-color: #edf0f5;
406color: #9373A5;
407cursor: pointer;
408border: none;
409text-align: left;
410outline: none;
411font-size: 15px;
412margin: 2px 2px;
413border: 2px solid #687372;
414display: block;
415width: 100%;
416vertical-align: middle;
417padding-top: 4px;
418padding-bottom: 0px;
419"
420><span class="arrow" style="padding-left: 0px;">►</span><TT><B>tgdsa_l_abs_tol</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspTwo-Grid DSA linear absolute tolerance</span></button>
421<div class="content" style="display: none;">
422 <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Two-Grid DSA linear absolute tolerance
423</p>
424 <p>Default value: <TT style="color:grey">0.0001(double)</TT></p>
425</div>
426
427<button type="button" class="droppy2" style=
428"
429background-color: #edf0f5;
430color: #9373A5;
431cursor: pointer;
432border: none;
433text-align: left;
434outline: none;
435font-size: 15px;
436margin: 2px 2px;
437border: 2px solid #687372;
438display: block;
439width: 100%;
440vertical-align: middle;
441padding-top: 4px;
442padding-bottom: 0px;
443"
444><span class="arrow" style="padding-left: 0px;">►</span><TT><B>tgdsa_l_max_its</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspTwo-Grid DSA linear maximum iterations</span></button>
445<div class="content" style="display: none;">
446 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. Two-Grid DSA linear maximum iterations
447</p>
448 <p>Default value: <TT style="color:grey">30</TT></p>
449</div>
450
451<button type="button" class="droppy2" style=
452"
453background-color: #edf0f5;
454color: #9373A5;
455cursor: pointer;
456border: none;
457text-align: left;
458outline: none;
459font-size: 15px;
460margin: 2px 2px;
461border: 2px solid #687372;
462display: block;
463width: 100%;
464vertical-align: middle;
465padding-top: 4px;
466padding-bottom: 0px;
467"
468><span class="arrow" style="padding-left: 0px;">►</span><TT><B>tgdsa_petsc_options</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspPETSc options to pass to TGDSA solver</span></button>
469<div class="content" style="display: none;">
470 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. PETSc options to pass to TGDSA solver
471</p>
472 <p>Default value: <TT style="color:grey">""</TT></p>
473</div>
474
475<button type="button" class="droppy2" style=
476"
477background-color: #edf0f5;
478color: #9373A5;
479cursor: pointer;
480border: none;
481text-align: left;
482outline: none;
483font-size: 15px;
484margin: 2px 2px;
485border: 2px solid #687372;
486display: block;
487width: 100%;
488vertical-align: middle;
489padding-top: 4px;
490padding-bottom: 0px;
491"
492><span class="arrow" style="padding-left: 0px;">►</span><TT><B>tgdsa_verbose</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspIf true, TGDSA routines will print verbosely</span></button>
493<div class="content" style="display: none;">
494 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. If true, TGDSA routines will print verbosely
495</p>
496 <p>Default value: <TT style="color:grey">false</TT></p>
497</div>
498
499<button type="button" class="droppy2" style=
500"
501background-color: #edf0f5;
502color: #9373A5;
503cursor: pointer;
504border: none;
505text-align: left;
506outline: none;
507font-size: 15px;
508margin: 2px 2px;
509border: 2px solid #687372;
510display: block;
511width: 100%;
512vertical-align: middle;
513padding-top: 4px;
514padding-bottom: 0px;
515"
516><span class="arrow" style="padding-left: 0px;">►</span><TT><B>wgdsa_l_abs_tol</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspWithin-group DSA linear absolute tolerance</span></button>
517<div class="content" style="display: none;">
518 <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Within-group DSA linear absolute tolerance
519</p>
520 <p>Default value: <TT style="color:grey">0.0001(double)</TT></p>
521</div>
522
523<button type="button" class="droppy2" style=
524"
525background-color: #edf0f5;
526color: #9373A5;
527cursor: pointer;
528border: none;
529text-align: left;
530outline: none;
531font-size: 15px;
532margin: 2px 2px;
533border: 2px solid #687372;
534display: block;
535width: 100%;
536vertical-align: middle;
537padding-top: 4px;
538padding-bottom: 0px;
539"
540><span class="arrow" style="padding-left: 0px;">►</span><TT><B>wgdsa_l_max_its</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspWithin-group DSA linear maximum iterations</span></button>
541<div class="content" style="display: none;">
542 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. Within-group DSA linear maximum iterations
543</p>
544 <p>Default value: <TT style="color:grey">30</TT></p>
545</div>
546
547<button type="button" class="droppy2" style=
548"
549background-color: #edf0f5;
550color: #9373A5;
551cursor: pointer;
552border: none;
553text-align: left;
554outline: none;
555font-size: 15px;
556margin: 2px 2px;
557border: 2px solid #687372;
558display: block;
559width: 100%;
560vertical-align: middle;
561padding-top: 4px;
562padding-bottom: 0px;
563"
564><span class="arrow" style="padding-left: 0px;">►</span><TT><B>wgdsa_petsc_options</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspPETSc options to pass to WGDSA solver</span></button>
565<div class="content" style="display: none;">
566 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. PETSc options to pass to WGDSA solver
567</p>
568 <p>Default value: <TT style="color:grey">""</TT></p>
569</div>
570
571<button type="button" class="droppy2" style=
572"
573background-color: #edf0f5;
574color: #9373A5;
575cursor: pointer;
576border: none;
577text-align: left;
578outline: none;
579font-size: 15px;
580margin: 2px 2px;
581border: 2px solid #687372;
582display: block;
583width: 100%;
584vertical-align: middle;
585padding-top: 4px;
586padding-bottom: 0px;
587"
588><span class="arrow" style="padding-left: 0px;">►</span><TT><B>wgdsa_verbose</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspIf true, WGDSA routines will print verbosely</span></button>
589<div class="content" style="display: none;">
590 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. If true, WGDSA routines will print verbosely
591</p>
592 <p>Default value: <TT style="color:grey">false</TT></p>
593</div>
594
595</div>
596</div>
597</div>
598</div>
599
600<button type="button" class="droppy2" style=
601"
602background-color: #edf0f5;
603color: #9373A5;
604cursor: pointer;
605border: none;
606text-align: left;
607outline: none;
608font-size: 15px;
609margin: 2px 2px;
610border: 2px solid #687372;
611display: block;
612width: 100%;
613vertical-align: middle;
614padding-top: 4px;
615padding-bottom: 0px;
616"
617><span class="arrow" style="padding-left: 0px;">►</span><TT><B>num_groups</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspThe total number of groups within the solver</span></button>
618<div class="content" style="display: none;">
619 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. The total number of groups within the solver
620</p>
621</div>
622
623</div>
624\endhtmlonly
625
626## Optional Input parameters
627\htmlonly
628
629<div style="display: block;">
630<button type="button" class="droppy2" style=
631"
632background-color: #edf0f5;
633color: #9373A5;
634cursor: pointer;
635border: none;
636text-align: left;
637outline: none;
638font-size: 15px;
639margin: 2px 2px;
640border: 2px solid #687372;
641display: block;
642width: 100%;
643vertical-align: middle;
644padding-top: 4px;
645padding-bottom: 0px;
646"
647><span class="arrow" style="padding-left: 0px;">►</span><TT><B>dt</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspDesired initial timestep size</span></button>
648<div class="content" style="display: none;">
649 <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Desired initial timestep size.
650</p>
651 <p>Default value: <TT style="color:grey">0.01(double)</TT></p>
652 <p>Allowable values: <TT>>= 1e-12(double)</TT></p>
653</div>
654
655<button type="button" class="droppy2" style=
656"
657background-color: #edf0f5;
658color: #9373A5;
659cursor: pointer;
660border: none;
661text-align: left;
662outline: none;
663font-size: 15px;
664margin: 2px 2px;
665border: 2px solid #687372;
666display: block;
667width: 100%;
668vertical-align: middle;
669padding-top: 4px;
670padding-bottom: 0px;
671"
672><span class="arrow" style="padding-left: 0px;">►</span><TT><B>end_time</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspTransient end-time if applicable</span></button>
673<div class="content" style="display: none;">
674 <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Transient end-time if applicable.
675</p>
676 <p>Default value: <TT style="color:grey">1(double)</TT></p>
677</div>
678
679<button type="button" class="droppy2" style=
680"
681background-color: #edf0f5;
682color: #9373A5;
683cursor: pointer;
684border: none;
685text-align: left;
686outline: none;
687font-size: 15px;
688margin: 2px 2px;
689border: 2px solid #687372;
690display: block;
691width: 100%;
692vertical-align: middle;
693padding-top: 4px;
694padding-bottom: 0px;
695"
696><span class="arrow" style="padding-left: 0px;">►</span><TT><B>max_time_steps</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspMaximum number of timesteps to allow</span></button>
697<div class="content" style="display: none;">
698 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. Maximum number of timesteps to allow. Negative values disables this.
699</p>
700 <p>Default value: <TT style="color:grey">-1</TT></p>
701</div>
702
703<button type="button" class="droppy2" style=
704"
705background-color: #edf0f5;
706color: #9373A5;
707cursor: pointer;
708border: none;
709text-align: left;
710outline: none;
711font-size: 15px;
712margin: 2px 2px;
713border: 2px solid #687372;
714display: block;
715width: 100%;
716vertical-align: middle;
717padding-top: 4px;
718padding-bottom: 0px;
719"
720><span class="arrow" style="padding-left: 0px;">►</span><TT><B>name</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspA text name to associate with the solver</span></button>
721<div class="content" style="display: none;">
722 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. A text name to associate with the solver. This name will be used in status messages and verbose iterative convergence monitors.
723</p>
724 <p>Default value: <TT style="color:grey">"LBSDiffusionDFEMSolver"</TT></p>
725</div>
726
727<button type="button" class="droppy2" style=
728"
729background-color: #edf0f5;
730color: #9373A5;
731cursor: pointer;
732border: none;
733text-align: left;
734outline: none;
735font-size: 15px;
736margin: 2px 2px;
737border: 2px solid #687372;
738display: block;
739width: 100%;
740vertical-align: middle;
741padding-top: 4px;
742padding-bottom: 0px;
743"
744><span class="arrow" style="padding-left: 0px;">►</span><TT><B>options</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspBlock of options</span></button>
745<div class="content" style="display: none;">
746 <p><I>type=</I><span style="color: blue;"><TT>BLOCK</TT></span>. Block of options. See <TT>lbs::OptionsBlock</TT>.
747</p>
748<div class="content" style="padding-left: 20px;">
749<HR><button type="button" class="droppy2" style=
750"
751background-color: #ffffff;
752color: #000000;
753cursor: pointer;
754border: none;
755text-align: left;
756outline: none;
757font-size: 15px;
758margin: 2px 2px;
759
760display: block;
761vertical-align: middle;
762padding-top: 4px;
763padding-bottom: 0px;
764"
765><span class="arrow" style="padding-left: 0px;">►</span><B>Optional parameters for lbs::OptionsBlock</B></button>
766<div class="content" style="display: none;padding-left: 20px;">
767<div style="display: block;">
768<button type="button" class="droppy2" style=
769"
770background-color: #edf0f5;
771color: #9373A5;
772cursor: pointer;
773border: none;
774text-align: left;
775outline: none;
776font-size: 15px;
777margin: 2px 2px;
778border: 2px solid #687372;
779display: block;
780width: 100%;
781vertical-align: middle;
782padding-top: 4px;
783padding-bottom: 0px;
784"
785><span class="arrow" style="padding-left: 0px;">►</span><TT><B>boundary_conditions</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspA table contain sub-tables for each boundary specification</span></button>
786<div class="content" style="display: none;">
787 <p><I>type=</I><span style="color: blue;"><TT>ARRAY</TT></span>. A table contain sub-tables for each boundary specification.
788</p>
789 <p>Default value: <TT style="color:grey"></TT></p>
790<div class="content" style="padding-left: 40px;">
791<HR><button type="button" class="droppy2" style=
792"
793background-color: #ffffff;
794color: #000000;
795cursor: pointer;
796border: none;
797text-align: left;
798outline: none;
799font-size: 15px;
800margin: 2px 2px;
801
802display: block;
803vertical-align: middle;
804padding-top: 4px;
805padding-bottom: 0px;
806"
807><span class="arrow" style="padding-left: 0px;">►</span><B>Required parameters for lbs::BoundaryOptionsBlock</B></button>
808<div class="content" style="display: none;padding-left: 20px;">
809<div style="display: block;">
810<button type="button" class="droppy2" style=
811"
812background-color: #edf0f5;
813color: #9373A5;
814cursor: pointer;
815border: none;
816text-align: left;
817outline: none;
818font-size: 15px;
819margin: 2px 2px;
820border: 2px solid #687372;
821display: block;
822width: 100%;
823vertical-align: middle;
824padding-top: 4px;
825padding-bottom: 0px;
826"
827><span class="arrow" style="padding-left: 0px;">►</span><TT><B>name</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspBoundary name that identifies the specific boundary</span></button>
828<div class="content" style="display: none;">
829 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. Boundary name that identifies the specific boundary
830</p>
831 <p>Allowable values: <TT>"xmin", "xmax", "ymin", "ymax", "zmin", "zmax"</TT></p>
832</div>
833
834<button type="button" class="droppy2" style=
835"
836background-color: #edf0f5;
837color: #9373A5;
838cursor: pointer;
839border: none;
840text-align: left;
841outline: none;
842font-size: 15px;
843margin: 2px 2px;
844border: 2px solid #687372;
845display: block;
846width: 100%;
847vertical-align: middle;
848padding-top: 4px;
849padding-bottom: 0px;
850"
851><span class="arrow" style="padding-left: 0px;">►</span><TT><B>type</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspBoundary type specification</span></button>
852<div class="content" style="display: none;">
853 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. Boundary type specification.
854</p>
855 <p>Allowable values: <TT>"vacuum", "incident_isotropic", "reflecting", "incident_anisotropic_heterogeneous"</TT></p>
856</div>
857
858</div>
859</div>
860<button type="button" class="droppy2" style=
861"
862background-color: #ffffff;
863color: #000000;
864cursor: pointer;
865border: none;
866text-align: left;
867outline: none;
868font-size: 15px;
869margin: 2px 2px;
870
871display: block;
872vertical-align: middle;
873padding-top: 4px;
874padding-bottom: 0px;
875"
876><span class="arrow" style="padding-left: 0px;">►</span><B>Optional parameters for lbs::BoundaryOptionsBlock</B></button>
877<div class="content" style="display: none;padding-left: 20px;">
878<div style="display: block;">
879<button type="button" class="droppy2" style=
880"
881background-color: #edf0f5;
882color: #9373A5;
883cursor: pointer;
884border: none;
885text-align: left;
886outline: none;
887font-size: 15px;
888margin: 2px 2px;
889border: 2px solid #687372;
890display: block;
891width: 100%;
892vertical-align: middle;
893padding-top: 4px;
894padding-bottom: 0px;
895"
896><span class="arrow" style="padding-left: 0px;">►</span><TT><B>function_name</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspText name of the lua function to be called for this boundary condition</span></button>
897<div class="content" style="display: none;">
898 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. Text name of the lua function to be called for this boundary condition. For more on this boundary condition type.
899</p>
900 <p>Default value: <TT style="color:grey">""</TT></p>
901</div>
902
903<button type="button" class="droppy2" style=
904"
905background-color: #edf0f5;
906color: #9373A5;
907cursor: pointer;
908border: none;
909text-align: left;
910outline: none;
911font-size: 15px;
912margin: 2px 2px;
913border: 2px solid #687372;
914display: block;
915width: 100%;
916vertical-align: middle;
917padding-top: 4px;
918padding-bottom: 0px;
919"
920><span class="arrow" style="padding-left: 0px;">►</span><TT><B>group_strength</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspRequired only if `type` is `"incident_isotropic"`</span></button>
921<div class="content" style="display: none;">
922 <p><I>type=</I><span style="color: blue;"><TT>ARRAY</TT></span>. Required only if `type` is `"incident_isotropic"`. An array of isotropic strength per group
923</p>
924 <p>Default value: <TT style="color:grey"></TT></p>
925</div>
926
927</div>
928</div>
929</div>
930</div>
931
932<button type="button" class="droppy2" style=
933"
934background-color: #edf0f5;
935color: #9373A5;
936cursor: pointer;
937border: none;
938text-align: left;
939outline: none;
940font-size: 15px;
941margin: 2px 2px;
942border: 2px solid #687372;
943display: block;
944width: 100%;
945vertical-align: middle;
946padding-top: 4px;
947padding-bottom: 0px;
948"
949><span class="arrow" style="padding-left: 0px;">►</span><TT><B>field_function_prefix</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspPrefix to use on all field functions</span></button>
950<div class="content" style="display: none;">
951 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. Prefix to use on all field functions. Default: `""`. By default this option is empty but if specified then flux moments will exported as `prefix_phi_gXXX_mYYY` where `XXX` is the zero padded 3 digit group number and similarly for `YYY`. The underscore after "prefix" is added automatically.
952</p>
953 <p>Default value: <TT style="color:grey">""</TT></p>
954</div>
955
956<button type="button" class="droppy2" style=
957"
958background-color: #edf0f5;
959color: #9373A5;
960cursor: pointer;
961border: none;
962text-align: left;
963outline: none;
964font-size: 15px;
965margin: 2px 2px;
966border: 2px solid #687372;
967display: block;
968width: 100%;
969vertical-align: middle;
970padding-top: 4px;
971padding-bottom: 0px;
972"
973><span class="arrow" style="padding-left: 0px;">►</span><TT><B>field_function_prefix_option</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspPrefix option on field function names</span></button>
974<div class="content" style="display: none;">
975 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. Prefix option on field function names. Default: `"prefix"`. Can be `"prefix"` or `"solver_name"`. By default this option is `"prefix"` which means it uses the designated "prefix" (another option), however, that is defaulted to nothing. Therefore, default behavior is to export flux moment fields functions as `phi_gXXX_mYYY` where `XXX` is the zero padded 3 digit group number and similarly for `YYY`.
976</p>
977 <p>Default value: <TT style="color:grey">"prefix"</TT></p>
978 <p>Allowable values: <TT>"prefix", "solver_name"</TT></p>
979</div>
980
981<button type="button" class="droppy2" style=
982"
983background-color: #edf0f5;
984color: #9373A5;
985cursor: pointer;
986border: none;
987text-align: left;
988outline: none;
989font-size: 15px;
990margin: 2px 2px;
991border: 2px solid #687372;
992display: block;
993width: 100%;
994vertical-align: middle;
995padding-top: 4px;
996padding-bottom: 0px;
997"
998><span class="arrow" style="padding-left: 0px;">►</span><TT><B>power_default_kappa</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspDefault `kappa` value (Energy released per fission) to use for power generation when cross sections do not have `kappa` values</span></button>
999<div class="content" style="display: none;">
1000 <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Default `kappa` value (Energy released per fission) to use for power generation when cross sections do not have `kappa` values. Default: 3.20435e-11 Joule (corresponding to 200 MeV per fission).
1001</p>
1002 <p>Default value: <TT style="color:grey">3.20435e-11(double)</TT></p>
1003</div>
1004
1005<button type="button" class="droppy2" style=
1006"
1007background-color: #edf0f5;
1008color: #9373A5;
1009cursor: pointer;
1010border: none;
1011text-align: left;
1012outline: none;
1013font-size: 15px;
1014margin: 2px 2px;
1015border: 2px solid #687372;
1016display: block;
1017width: 100%;
1018vertical-align: middle;
1019padding-top: 4px;
1020padding-bottom: 0px;
1021"
1022><span class="arrow" style="padding-left: 0px;">►</span><TT><B>power_field_function_on</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspFlag to control the creation of the power generation field function</span></button>
1023<div class="content" style="display: none;">
1024 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Flag to control the creation of the power generation field function. If set to `true` then a field function will be created with the general name `<solver_name>_power_generation`.
1025</p>
1026 <p>Default value: <TT style="color:grey">false</TT></p>
1027</div>
1028
1029<button type="button" class="droppy2" style=
1030"
1031background-color: #edf0f5;
1032color: #9373A5;
1033cursor: pointer;
1034border: none;
1035text-align: left;
1036outline: none;
1037font-size: 15px;
1038margin: 2px 2px;
1039border: 2px solid #687372;
1040display: block;
1041width: 100%;
1042vertical-align: middle;
1043padding-top: 4px;
1044padding-bottom: 0px;
1045"
1046><span class="arrow" style="padding-left: 0px;">►</span><TT><B>power_normalization</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspPower normalization factor to use</span></button>
1047<div class="content" style="display: none;">
1048 <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Power normalization factor to use. Supply a negative or zero number to turn this off.
1049</p>
1050 <p>Default value: <TT style="color:grey">-1(double)</TT></p>
1051</div>
1052
1053<button type="button" class="droppy2" style=
1054"
1055background-color: #edf0f5;
1056color: #9373A5;
1057cursor: pointer;
1058border: none;
1059text-align: left;
1060outline: none;
1061font-size: 15px;
1062margin: 2px 2px;
1063border: 2px solid #687372;
1064display: block;
1065width: 100%;
1066vertical-align: middle;
1067padding-top: 4px;
1068padding-bottom: 0px;
1069"
1070><span class="arrow" style="padding-left: 0px;">►</span><TT><B>read_restart_data</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspFlag indicating whether restart data is to be read</span></button>
1071<div class="content" style="display: none;">
1072 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Flag indicating whether restart data is to be read.
1073</p>
1074 <p>Default value: <TT style="color:grey">false</TT></p>
1075</div>
1076
1077<button type="button" class="droppy2" style=
1078"
1079background-color: #edf0f5;
1080color: #9373A5;
1081cursor: pointer;
1082border: none;
1083text-align: left;
1084outline: none;
1085font-size: 15px;
1086margin: 2px 2px;
1087border: 2px solid #687372;
1088display: block;
1089width: 100%;
1090vertical-align: middle;
1091padding-top: 4px;
1092padding-bottom: 0px;
1093"
1094><span class="arrow" style="padding-left: 0px;">►</span><TT><B>read_restart_file_base</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspFile base name to use when reading restart data</span></button>
1095<div class="content" style="display: none;">
1096 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. File base name to use when reading restart data.
1097</p>
1098 <p>Default value: <TT style="color:grey">"restart"</TT></p>
1099</div>
1100
1101<button type="button" class="droppy2" style=
1102"
1103background-color: #edf0f5;
1104color: #9373A5;
1105cursor: pointer;
1106border: none;
1107text-align: left;
1108outline: none;
1109font-size: 15px;
1110margin: 2px 2px;
1111border: 2px solid #687372;
1112display: block;
1113width: 100%;
1114vertical-align: middle;
1115padding-top: 4px;
1116padding-bottom: 0px;
1117"
1118><span class="arrow" style="padding-left: 0px;">►</span><TT><B>read_restart_folder_name</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspFolder name to use when reading restart data</span></button>
1119<div class="content" style="display: none;">
1120 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. Folder name to use when reading restart data.
1121</p>
1122 <p>Default value: <TT style="color:grey">"YRestart"</TT></p>
1123</div>
1124
1125<button type="button" class="droppy2" style=
1126"
1127background-color: #edf0f5;
1128color: #9373A5;
1129cursor: pointer;
1130border: none;
1131text-align: left;
1132outline: none;
1133font-size: 15px;
1134margin: 2px 2px;
1135border: 2px solid #687372;
1136display: block;
1137width: 100%;
1138vertical-align: middle;
1139padding-top: 4px;
1140padding-bottom: 0px;
1141"
1142><span class="arrow" style="padding-left: 0px;">►</span><TT><B>save_angular_flux</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspFlag indicating whether angular fluxes are to be stored or not</span></button>
1143<div class="content" style="display: none;">
1144 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Flag indicating whether angular fluxes are to be stored or not.
1145</p>
1146 <p>Default value: <TT style="color:grey">false</TT></p>
1147</div>
1148
1149<button type="button" class="droppy2" style=
1150"
1151background-color: #edf0f5;
1152color: #9373A5;
1153cursor: pointer;
1154border: none;
1155text-align: left;
1156outline: none;
1157font-size: 15px;
1158margin: 2px 2px;
1159border: 2px solid #687372;
1160display: block;
1161width: 100%;
1162vertical-align: middle;
1163padding-top: 4px;
1164padding-bottom: 0px;
1165"
1166><span class="arrow" style="padding-left: 0px;">►</span><TT><B>scattering_order</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspDefines the level of harmonic expansion for the scattering source</span></button>
1167<div class="content" style="display: none;">
1168 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. Defines the level of harmonic expansion for the scattering source.
1169</p>
1170 <p>Default value: <TT style="color:grey">1</TT></p>
1171</div>
1172
1173<button type="button" class="droppy2" style=
1174"
1175background-color: #edf0f5;
1176color: #9373A5;
1177cursor: pointer;
1178border: none;
1179text-align: left;
1180outline: none;
1181font-size: 15px;
1182margin: 2px 2px;
1183border: 2px solid #687372;
1184display: block;
1185width: 100%;
1186vertical-align: middle;
1187padding-top: 4px;
1188padding-bottom: 0px;
1189"
1190><span class="arrow" style="padding-left: 0px;">►</span><TT><B>spatial_discretization</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspWhat spatial discretization to use</span></button>
1191<div class="content" style="display: none;">
1192 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. What spatial discretization to use. Currently only `"pwld"` is supported
1193</p>
1194 <p>Default value: <TT style="color:grey">"pwld"</TT></p>
1195 <p>Allowable values: <TT>"pwld"</TT></p>
1196</div>
1197
1198<button type="button" class="droppy2" style=
1199"
1200background-color: #edf0f5;
1201color: #9373A5;
1202cursor: pointer;
1203border: none;
1204text-align: left;
1205outline: none;
1206font-size: 15px;
1207margin: 2px 2px;
1208border: 2px solid #687372;
1209display: block;
1210width: 100%;
1211vertical-align: middle;
1212padding-top: 4px;
1213padding-bottom: 0px;
1214"
1215><span class="arrow" style="padding-left: 0px;">►</span><TT><B>sweep_eager_limit</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspThe eager limit to be used in message size during sweep initialization</span></button>
1216<div class="content" style="display: none;">
1217 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. The eager limit to be used in message size during sweep initialization.
1218 This expects to be followed by a size in bytes (Max 64,0000)See note below.\n\n ###Note on the Eager limit
1219The eager limit is the message size limit before which non-blocking MPI sendcalls will execute without waiting for a matching receive call. The limit isplatform dependent but in general 64 kb. Some systems have 32 kb as a limitand therefore we use that as a default limit in ChiTech. There is a fineinterplay between message size and the shear amount of messages that will besent. In general smaller messages tend to be more efficient, however, whenthere are too many small messages being sent around the communication systemon the given platform will start to suffer. One can gain a small amount ofparallel efficiency by lowering this limit, however, there is a point wherethe parallel efficiency will actually get worse so use with caution.
1220</p>
1221 <p>Default value: <TT style="color:grey">32000</TT></p>
1222</div>
1223
1224<button type="button" class="droppy2" style=
1225"
1226background-color: #edf0f5;
1227color: #9373A5;
1228cursor: pointer;
1229border: none;
1230text-align: left;
1231outline: none;
1232font-size: 15px;
1233margin: 2px 2px;
1234border: 2px solid #687372;
1235display: block;
1236width: 100%;
1237vertical-align: middle;
1238padding-top: 4px;
1239padding-bottom: 0px;
1240"
1241><span class="arrow" style="padding-left: 0px;">►</span><TT><B>use_precursors</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspFlag for using delayed neutron precursors</span></button>
1242<div class="content" style="display: none;">
1243 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Flag for using delayed neutron precursors.
1244</p>
1245 <p>Default value: <TT style="color:grey">false</TT></p>
1246</div>
1247
1248<button type="button" class="droppy2" style=
1249"
1250background-color: #edf0f5;
1251color: #9373A5;
1252cursor: pointer;
1253border: none;
1254text-align: left;
1255outline: none;
1256font-size: 15px;
1257margin: 2px 2px;
1258border: 2px solid #687372;
1259display: block;
1260width: 100%;
1261vertical-align: middle;
1262padding-top: 4px;
1263padding-bottom: 0px;
1264"
1265><span class="arrow" style="padding-left: 0px;">►</span><TT><B>use_source_moments</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspFlag for ignoring fixed sources and selectively using source moments obtained elsewhere</span></button>
1266<div class="content" style="display: none;">
1267 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Flag for ignoring fixed sources and selectively using source moments obtained elsewhere.
1268</p>
1269 <p>Default value: <TT style="color:grey">false</TT></p>
1270</div>
1271
1272<button type="button" class="droppy2" style=
1273"
1274background-color: #edf0f5;
1275color: #9373A5;
1276cursor: pointer;
1277border: none;
1278text-align: left;
1279outline: none;
1280font-size: 15px;
1281margin: 2px 2px;
1282border: 2px solid #687372;
1283display: block;
1284width: 100%;
1285vertical-align: middle;
1286padding-top: 4px;
1287padding-bottom: 0px;
1288"
1289><span class="arrow" style="padding-left: 0px;">►</span><TT><B>verbose_ags_iterations</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspFlag to control verbosity of across-groupset iterations</span></button>
1290<div class="content" style="display: none;">
1291 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Flag to control verbosity of across-groupset iterations.
1292</p>
1293 <p>Default value: <TT style="color:grey">false</TT></p>
1294</div>
1295
1296<button type="button" class="droppy2" style=
1297"
1298background-color: #edf0f5;
1299color: #9373A5;
1300cursor: pointer;
1301border: none;
1302text-align: left;
1303outline: none;
1304font-size: 15px;
1305margin: 2px 2px;
1306border: 2px solid #687372;
1307display: block;
1308width: 100%;
1309vertical-align: middle;
1310padding-top: 4px;
1311padding-bottom: 0px;
1312"
1313><span class="arrow" style="padding-left: 0px;">►</span><TT><B>verbose_inner_iterations</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspFlag to control verbosity of inner iterations</span></button>
1314<div class="content" style="display: none;">
1315 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Flag to control verbosity of inner iterations.
1316</p>
1317 <p>Default value: <TT style="color:grey">true</TT></p>
1318</div>
1319
1320<button type="button" class="droppy2" style=
1321"
1322background-color: #edf0f5;
1323color: #9373A5;
1324cursor: pointer;
1325border: none;
1326text-align: left;
1327outline: none;
1328font-size: 15px;
1329margin: 2px 2px;
1330border: 2px solid #687372;
1331display: block;
1332width: 100%;
1333vertical-align: middle;
1334padding-top: 4px;
1335padding-bottom: 0px;
1336"
1337><span class="arrow" style="padding-left: 0px;">►</span><TT><B>verbose_outer_iterations</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspFlag to control verbosity of across-groupset iterations</span></button>
1338<div class="content" style="display: none;">
1339 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Flag to control verbosity of across-groupset iterations.
1340</p>
1341 <p>Default value: <TT style="color:grey">true</TT></p>
1342</div>
1343
1344<button type="button" class="droppy2" style=
1345"
1346background-color: #edf0f5;
1347color: #9373A5;
1348cursor: pointer;
1349border: none;
1350text-align: left;
1351outline: none;
1352font-size: 15px;
1353margin: 2px 2px;
1354border: 2px solid #687372;
1355display: block;
1356width: 100%;
1357vertical-align: middle;
1358padding-top: 4px;
1359padding-bottom: 0px;
1360"
1361><span class="arrow" style="padding-left: 0px;">►</span><TT><B>write_restart_data</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspFlag indicating whether restart data is to be written</span></button>
1362<div class="content" style="display: none;">
1363 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Flag indicating whether restart data is to be written.
1364</p>
1365 <p>Default value: <TT style="color:grey">false</TT></p>
1366</div>
1367
1368<button type="button" class="droppy2" style=
1369"
1370background-color: #edf0f5;
1371color: #9373A5;
1372cursor: pointer;
1373border: none;
1374text-align: left;
1375outline: none;
1376font-size: 15px;
1377margin: 2px 2px;
1378border: 2px solid #687372;
1379display: block;
1380width: 100%;
1381vertical-align: middle;
1382padding-top: 4px;
1383padding-bottom: 0px;
1384"
1385><span class="arrow" style="padding-left: 0px;">►</span><TT><B>write_restart_file_base</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspFile base name to use when writing restart data</span></button>
1386<div class="content" style="display: none;">
1387 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. File base name to use when writing restart data.
1388</p>
1389 <p>Default value: <TT style="color:grey">"restart"</TT></p>
1390</div>
1391
1392<button type="button" class="droppy2" style=
1393"
1394background-color: #edf0f5;
1395color: #9373A5;
1396cursor: pointer;
1397border: none;
1398text-align: left;
1399outline: none;
1400font-size: 15px;
1401margin: 2px 2px;
1402border: 2px solid #687372;
1403display: block;
1404width: 100%;
1405vertical-align: middle;
1406padding-top: 4px;
1407padding-bottom: 0px;
1408"
1409><span class="arrow" style="padding-left: 0px;">►</span><TT><B>write_restart_folder_name</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspFolder name to use when writing restart data</span></button>
1410<div class="content" style="display: none;">
1411 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. Folder name to use when writing restart data.
1412</p>
1413 <p>Default value: <TT style="color:grey">"YRestart"</TT></p>
1414</div>
1415
1416<button type="button" class="droppy2" style=
1417"
1418background-color: #edf0f5;
1419color: #9373A5;
1420cursor: pointer;
1421border: none;
1422text-align: left;
1423outline: none;
1424font-size: 15px;
1425margin: 2px 2px;
1426border: 2px solid #687372;
1427display: block;
1428width: 100%;
1429vertical-align: middle;
1430padding-top: 4px;
1431padding-bottom: 0px;
1432"
1433><span class="arrow" style="padding-left: 0px;">►</span><TT><B>write_restart_interval</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspInterval at which restart data is to be written</span></button>
1434<div class="content" style="display: none;">
1435 <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Interval at which restart data is to be written. Currently not implemented.
1436</p>
1437 <p>Default value: <TT style="color:grey">30(double)</TT></p>
1438</div>
1439
1440</div>
1441</div>
1442</div>
1443</div>
1444
1445<button type="button" class="droppy2" style=
1446"
1447background-color: #edf0f5;
1448color: #9373A5;
1449cursor: pointer;
1450border: none;
1451text-align: left;
1452outline: none;
1453font-size: 15px;
1454margin: 2px 2px;
1455border: 2px solid #687372;
1456display: block;
1457width: 100%;
1458vertical-align: middle;
1459padding-top: 4px;
1460padding-bottom: 0px;
1461"
1462><span class="arrow" style="padding-left: 0px;">►</span><TT><B>start_time</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspTransient start-time if applicable</span></button>
1463<div class="content" style="display: none;">
1464 <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Transient start-time if applicable.
1465</p>
1466 <p>Default value: <TT style="color:grey">0(double)</TT></p>
1467</div>
1468
1469<button type="button" class="droppy2" style=
1470"
1471background-color: #edf0f5;
1472color: #9373A5;
1473cursor: pointer;
1474border: none;
1475text-align: left;
1476outline: none;
1477font-size: 15px;
1478margin: 2px 2px;
1479border: 2px solid #687372;
1480display: block;
1481width: 100%;
1482vertical-align: middle;
1483padding-top: 4px;
1484padding-bottom: 0px;
1485"
1486><span class="arrow" style="padding-left: 0px;">►</span><TT><B>time</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspCurrent time of the solver</span></button>
1487<div class="content" style="display: none;">
1488 <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Current time of the solver.
1489</p>
1490 <p>Default value: <TT style="color:grey">0(double)</TT></p>
1491</div>
1492
1493<button type="button" class="droppy2" style=
1494"
1495background-color: #edf0f5;
1496color: #9373A5;
1497cursor: pointer;
1498border: none;
1499text-align: left;
1500outline: none;
1501font-size: 15px;
1502margin: 2px 2px;
1503border: 2px solid #687372;
1504display: block;
1505width: 100%;
1506vertical-align: middle;
1507padding-top: 4px;
1508padding-bottom: 0px;
1509"
1510><span class="arrow" style="padding-left: 0px;">►</span><TT><B>timestepper</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspHandle to a timestepper</span></button>
1511<div class="content" style="display: none;">
1512 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. Handle to a timestepper. If not supplied then a ConstantTimeStepper will be created.
1513</p>
1514 <p>Default value: <TT style="color:grey">0</TT></p>
1515</div>
1516
1517</div>
1518\endhtmlonly
1519
1520\htmlonly
1521
1522<script>
1523
1524{
1525 var coll = document.getElementsByClassName("droppy2");
1526 var i;
1527
1528 for (i = 0; i < coll.length; i++) {
1529 coll[i].addEventListener("click", function() {
1530 this.classList.toggle("active");
1531 var content = this.nextElementSibling;
1532 if (content.style.display === "block") {
1533 content.style.display = "none";
1534 this.childNodes[0].innerText = "►"
1535 } else {
1536 content.style.display = "block";
1537 this.children[0].innerText = "▼"
1538 }
1539 });
1540 }
1541}</script>
1542
1543\endhtmlonly
1544
1545### Usage Examples:
1546\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_KEigenvalueMIP2D_1a_QBlock_lua
1547\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_KEigenvalueMIP2D_1b_QBlock_lua
1548\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_KEigenvalueMIP1D_1G_lua
1549\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_3a_DSA_ortho_lua
1550\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_1b_Ortho_lua
1551*/