Chi-Tech
lbs__LBSGroupset.h
Go to the documentation of this file.
1/** \defgroup lbs__LBSGroupset lbs.LBSGroupset
2
3
4\ingroup LuaLBSGroupsets
5Input Parameters for groupsets.
6
7<B>Note:</B> This object is not constructable
8## Required Input parameters
9\htmlonly
10
11<div style="display: block;">
12<button type="button" class="droppy2" style=
13"
14background-color: #edf0f5;
15color: #9373A5;
16cursor: pointer;
17border: none;
18text-align: left;
19outline: none;
20font-size: 15px;
21margin: 2px 2px;
22border: 2px solid #687372;
23display: block;
24width: 100%;
25vertical-align: middle;
26padding-top: 4px;
27padding-bottom: 0px;
28"
29><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>
30<div class="content" style="display: none;">
31 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. A handle to an angular quadrature
32</p>
33</div>
34
35<button type="button" class="droppy2" style=
36"
37background-color: #edf0f5;
38color: #9373A5;
39cursor: pointer;
40border: none;
41text-align: left;
42outline: none;
43font-size: 15px;
44margin: 2px 2px;
45border: 2px solid #687372;
46display: block;
47width: 100%;
48vertical-align: middle;
49padding-top: 4px;
50padding-bottom: 0px;
51"
52><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>
53<div class="content" style="display: none;">
54 <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>
55</p>
56</div>
57
58</div>
59\endhtmlonly
60
61## Optional Input parameters
62\htmlonly
63
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>allow_cycles</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspFlag indicating whether cycles are to be allowed or not</span></button>
83<div class="content" style="display: none;">
84 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Flag indicating whether cycles are to be allowed or not
85</p>
86 <p>Default value: <TT style="color:grey">true</TT></p>
87</div>
88
89<button type="button" class="droppy2" style=
90"
91background-color: #edf0f5;
92color: #9373A5;
93cursor: pointer;
94border: none;
95text-align: left;
96outline: none;
97font-size: 15px;
98margin: 2px 2px;
99border: 2px solid #687372;
100display: block;
101width: 100%;
102vertical-align: middle;
103padding-top: 4px;
104padding-bottom: 0px;
105"
106><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>
107<div class="content" style="display: none;">
108 <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
109</p>
110 <p>Default value: <TT style="color:grey">1</TT></p>
111 <p>Allowable values: <TT>>= 1</TT></p>
112</div>
113
114<button type="button" class="droppy2" style=
115"
116background-color: #edf0f5;
117color: #9373A5;
118cursor: pointer;
119border: none;
120text-align: left;
121outline: none;
122font-size: 15px;
123margin: 2px 2px;
124border: 2px solid #687372;
125display: block;
126width: 100%;
127vertical-align: middle;
128padding-top: 4px;
129padding-bottom: 0px;
130"
131><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>
132<div class="content" style="display: none;">
133 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. The angle aggregation method to use during sweeping
134</p>
135 <p>Default value: <TT style="color:grey">"polar"</TT></p>
136 <p>Allowable values: <TT>"polar", "single", "azimuthal"</TT></p>
137</div>
138
139<button type="button" class="droppy2" style=
140"
141background-color: #edf0f5;
142color: #9373A5;
143cursor: pointer;
144border: none;
145text-align: left;
146outline: none;
147font-size: 15px;
148margin: 2px 2px;
149border: 2px solid #687372;
150display: block;
151width: 100%;
152vertical-align: middle;
153padding-top: 4px;
154padding-bottom: 0px;
155"
156><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>
157<div class="content" style="display: none;">
158 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Flag to turn on Two-Grid Acceleration for this groupset
159</p>
160 <p>Default value: <TT style="color:grey">false</TT></p>
161</div>
162
163<button type="button" class="droppy2" style=
164"
165background-color: #edf0f5;
166color: #9373A5;
167cursor: pointer;
168border: none;
169text-align: left;
170outline: none;
171font-size: 15px;
172margin: 2px 2px;
173border: 2px solid #687372;
174display: block;
175width: 100%;
176vertical-align: middle;
177padding-top: 4px;
178padding-bottom: 0px;
179"
180><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>
181<div class="content" style="display: none;">
182 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Flag to turn on within-group Diffusion Synthetic Acceleration for this groupset
183</p>
184 <p>Default value: <TT style="color:grey">false</TT></p>
185</div>
186
187<button type="button" class="droppy2" style=
188"
189background-color: #edf0f5;
190color: #9373A5;
191cursor: pointer;
192border: none;
193text-align: left;
194outline: none;
195font-size: 15px;
196margin: 2px 2px;
197border: 2px solid #687372;
198display: block;
199width: 100%;
200vertical-align: middle;
201padding-top: 4px;
202padding-bottom: 0px;
203"
204><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>
205<div class="content" style="display: none;">
206 <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.
207</p>
208 <p>Default value: <TT style="color:grey">30</TT></p>
209 <p>Allowable values: <TT>>= 1</TT></p>
210</div>
211
212<button type="button" class="droppy2" style=
213"
214background-color: #edf0f5;
215color: #9373A5;
216cursor: pointer;
217border: none;
218text-align: left;
219outline: none;
220font-size: 15px;
221margin: 2px 2px;
222border: 2px solid #687372;
223display: block;
224width: 100%;
225vertical-align: middle;
226padding-top: 4px;
227padding-bottom: 0px;
228"
229><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>
230<div class="content" style="display: none;">
231 <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
232</p>
233 <p>Default value: <TT style="color:grey">1</TT></p>
234 <p>Allowable values: <TT>>= 1</TT></p>
235</div>
236
237<button type="button" class="droppy2" style=
238"
239background-color: #edf0f5;
240color: #9373A5;
241cursor: pointer;
242border: none;
243text-align: left;
244outline: none;
245font-size: 15px;
246margin: 2px 2px;
247border: 2px solid #687372;
248display: block;
249width: 100%;
250vertical-align: middle;
251padding-top: 4px;
252padding-bottom: 0px;
253"
254><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>
255<div class="content" style="display: none;">
256 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. The iterative method to use for inner linear solves
257</p>
258 <p>Default value: <TT style="color:grey">"richardson"</TT></p>
259 <p>Allowable values: <TT>"richardson", "gmres", "bicgstab"</TT></p>
260</div>
261
262<button type="button" class="droppy2" style=
263"
264background-color: #edf0f5;
265color: #9373A5;
266cursor: pointer;
267border: none;
268text-align: left;
269outline: none;
270font-size: 15px;
271margin: 2px 2px;
272border: 2px solid #687372;
273display: block;
274width: 100%;
275vertical-align: middle;
276padding-top: 4px;
277padding-bottom: 0px;
278"
279><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>
280<div class="content" style="display: none;">
281 <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Inner linear solver residual absolute tolerance
282</p>
283 <p>Default value: <TT style="color:grey">1e-06(double)</TT></p>
284 <p>Allowable values: <TT>>= 1e-18(double)</TT></p>
285</div>
286
287<button type="button" class="droppy2" style=
288"
289background-color: #edf0f5;
290color: #9373A5;
291cursor: pointer;
292border: none;
293text-align: left;
294outline: none;
295font-size: 15px;
296margin: 2px 2px;
297border: 2px solid #687372;
298display: block;
299width: 100%;
300vertical-align: middle;
301padding-top: 4px;
302padding-bottom: 0px;
303"
304><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>
305<div class="content" style="display: none;">
306 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. Inner linear solver maximum iterations
307</p>
308 <p>Default value: <TT style="color:grey">200</TT></p>
309 <p>Allowable values: <TT>>= 0</TT></p>
310</div>
311
312<button type="button" class="droppy2" style=
313"
314background-color: #edf0f5;
315color: #9373A5;
316cursor: pointer;
317border: none;
318text-align: left;
319outline: none;
320font-size: 15px;
321margin: 2px 2px;
322border: 2px solid #687372;
323display: block;
324width: 100%;
325vertical-align: middle;
326padding-top: 4px;
327padding-bottom: 0px;
328"
329><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>
330<div class="content" style="display: none;">
331 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Turns on a log of sweep events
332</p>
333 <p>Default value: <TT style="color:grey">false</TT></p>
334</div>
335
336<button type="button" class="droppy2" style=
337"
338background-color: #edf0f5;
339color: #9373A5;
340cursor: pointer;
341border: none;
342text-align: left;
343outline: none;
344font-size: 15px;
345margin: 2px 2px;
346border: 2px solid #687372;
347display: block;
348width: 100%;
349vertical-align: middle;
350padding-top: 4px;
351padding-bottom: 0px;
352"
353><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>
354<div class="content" style="display: none;">
355 <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Two-Grid DSA linear absolute tolerance
356</p>
357 <p>Default value: <TT style="color:grey">0.0001(double)</TT></p>
358</div>
359
360<button type="button" class="droppy2" style=
361"
362background-color: #edf0f5;
363color: #9373A5;
364cursor: pointer;
365border: none;
366text-align: left;
367outline: none;
368font-size: 15px;
369margin: 2px 2px;
370border: 2px solid #687372;
371display: block;
372width: 100%;
373vertical-align: middle;
374padding-top: 4px;
375padding-bottom: 0px;
376"
377><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>
378<div class="content" style="display: none;">
379 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. Two-Grid DSA linear maximum iterations
380</p>
381 <p>Default value: <TT style="color:grey">30</TT></p>
382</div>
383
384<button type="button" class="droppy2" style=
385"
386background-color: #edf0f5;
387color: #9373A5;
388cursor: pointer;
389border: none;
390text-align: left;
391outline: none;
392font-size: 15px;
393margin: 2px 2px;
394border: 2px solid #687372;
395display: block;
396width: 100%;
397vertical-align: middle;
398padding-top: 4px;
399padding-bottom: 0px;
400"
401><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>
402<div class="content" style="display: none;">
403 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. PETSc options to pass to TGDSA solver
404</p>
405 <p>Default value: <TT style="color:grey">""</TT></p>
406</div>
407
408<button type="button" class="droppy2" style=
409"
410background-color: #edf0f5;
411color: #9373A5;
412cursor: pointer;
413border: none;
414text-align: left;
415outline: none;
416font-size: 15px;
417margin: 2px 2px;
418border: 2px solid #687372;
419display: block;
420width: 100%;
421vertical-align: middle;
422padding-top: 4px;
423padding-bottom: 0px;
424"
425><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>
426<div class="content" style="display: none;">
427 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. If true, TGDSA routines will print verbosely
428</p>
429 <p>Default value: <TT style="color:grey">false</TT></p>
430</div>
431
432<button type="button" class="droppy2" style=
433"
434background-color: #edf0f5;
435color: #9373A5;
436cursor: pointer;
437border: none;
438text-align: left;
439outline: none;
440font-size: 15px;
441margin: 2px 2px;
442border: 2px solid #687372;
443display: block;
444width: 100%;
445vertical-align: middle;
446padding-top: 4px;
447padding-bottom: 0px;
448"
449><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>
450<div class="content" style="display: none;">
451 <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Within-group DSA linear absolute tolerance
452</p>
453 <p>Default value: <TT style="color:grey">0.0001(double)</TT></p>
454</div>
455
456<button type="button" class="droppy2" style=
457"
458background-color: #edf0f5;
459color: #9373A5;
460cursor: pointer;
461border: none;
462text-align: left;
463outline: none;
464font-size: 15px;
465margin: 2px 2px;
466border: 2px solid #687372;
467display: block;
468width: 100%;
469vertical-align: middle;
470padding-top: 4px;
471padding-bottom: 0px;
472"
473><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>
474<div class="content" style="display: none;">
475 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. Within-group DSA linear maximum iterations
476</p>
477 <p>Default value: <TT style="color:grey">30</TT></p>
478</div>
479
480<button type="button" class="droppy2" style=
481"
482background-color: #edf0f5;
483color: #9373A5;
484cursor: pointer;
485border: none;
486text-align: left;
487outline: none;
488font-size: 15px;
489margin: 2px 2px;
490border: 2px solid #687372;
491display: block;
492width: 100%;
493vertical-align: middle;
494padding-top: 4px;
495padding-bottom: 0px;
496"
497><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>
498<div class="content" style="display: none;">
499 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. PETSc options to pass to WGDSA solver
500</p>
501 <p>Default value: <TT style="color:grey">""</TT></p>
502</div>
503
504<button type="button" class="droppy2" style=
505"
506background-color: #edf0f5;
507color: #9373A5;
508cursor: pointer;
509border: none;
510text-align: left;
511outline: none;
512font-size: 15px;
513margin: 2px 2px;
514border: 2px solid #687372;
515display: block;
516width: 100%;
517vertical-align: middle;
518padding-top: 4px;
519padding-bottom: 0px;
520"
521><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>
522<div class="content" style="display: none;">
523 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. If true, WGDSA routines will print verbosely
524</p>
525 <p>Default value: <TT style="color:grey">false</TT></p>
526</div>
527
528</div>
529\endhtmlonly
530
531\htmlonly
532
533<script>
534
535{
536 var coll = document.getElementsByClassName("droppy2");
537 var i;
538
539 for (i = 0; i < coll.length; i++) {
540 coll[i].addEventListener("click", function() {
541 this.classList.toggle("active");
542 var content = this.nextElementSibling;
543 if (content.style.display === "block") {
544 content.style.display = "none";
545 this.childNodes[0].innerText = "►"
546 } else {
547 content.style.display = "block";
548 this.children[0].innerText = "▼"
549 }
550 });
551 }
552}</script>
553
554\endhtmlonly
555
556*/