41><span class="arrow" style="padding-left: 0px;">►</span><TT><B>coord_system</B></TT><span style="color: #c4c1c0;">       Coordinate system to use</span></button>
42<div class="content" style="display: none;">
43 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. Coordinate system to use. Can only be 2 or 3. 2=Cylindrical, 3=Spherical.
44</p>
45</div>
46
47<button type="button" class="droppy2" style=
48"
49background-color: #edf0f5;
50color: #9373A5;
51cursor: pointer;
52border: none;
53text-align: left;
54outline: none;
55font-size: 15px;
56margin: 2px 2px;
57border: 2px solid #687372;
58display: block;
59width: 100%;
60vertical-align: middle;
61padding-top: 4px;
62padding-bottom: 0px;
63"
64><span class="arrow" style="padding-left: 0px;">►</span><TT><B>groupsets</B></TT><span style="color: #c4c1c0;">       An array of blocks each specifying the input parameters for a <TT>lbs::LBSGroupset</TT></span></button>
65<div class="content" style="display: none;">
66 <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>.
105><span class="arrow" style="padding-left: 0px;">►</span><TT><B>angular_quadrature_handle</B></TT><span style="color: #c4c1c0;">       A handle to an angular quadrature</span></button>
106<div class="content" style="display: none;">
107 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. A handle to an angular quadrature
108</p>
109</div>
110
111<button type="button" class="droppy2" style=
112"
113background-color: #edf0f5;
114color: #9373A5;
115cursor: pointer;
116border: none;
117text-align: left;
118outline: none;
119font-size: 15px;
120margin: 2px 2px;
121border: 2px solid #687372;
122display: block;
123width: 100%;
124vertical-align: middle;
125padding-top: 4px;
126padding-bottom: 0px;
127"
128><span class="arrow" style="padding-left: 0px;">►</span><TT><B>groups_from_to</B></TT><span style="color: #c4c1c0;">       The first and last group id this groupset operates on</span></button>
129<div class="content" style="display: none;">
130 <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>
131</p>
132</div>
133
134</div>
135</div>
136<button type="button" class="droppy2" style=
137"
138background-color: #ffffff;
139color: #000000;
140cursor: pointer;
141border: none;
142text-align: left;
143outline: none;
144font-size: 15px;
145margin: 2px 2px;
146
147display: block;
148vertical-align: middle;
149padding-top: 4px;
150padding-bottom: 0px;
151"
152><span class="arrow" style="padding-left: 0px;">►</span><B>Optional parameters for lbs::LBSGroupset</B></button>
172><span class="arrow" style="padding-left: 0px;">►</span><TT><B>allow_cycles</B></TT><span style="color: #c4c1c0;">       Flag indicating whether cycles are to be allowed or not</span></button>
173<div class="content" style="display: none;">
174 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Flag indicating whether cycles are to be allowed or not
196><span class="arrow" style="padding-left: 0px;">►</span><TT><B>angle_aggregation_num_subsets</B></TT><span style="color: #c4c1c0;">       The number of subsets to apply to sets of angles that have been aggregated</span></button>
197<div class="content" style="display: none;">
198 <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
246><span class="arrow" style="padding-left: 0px;">►</span><TT><B>apply_tgdsa</B></TT><span style="color: #c4c1c0;">       Flag to turn on Two-Grid Acceleration for this groupset</span></button>
247<div class="content" style="display: none;">
248 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Flag to turn on Two-Grid Acceleration for this groupset
270><span class="arrow" style="padding-left: 0px;">►</span><TT><B>apply_wgdsa</B></TT><span style="color: #c4c1c0;">       Flag to turn on within-group Diffusion Synthetic Acceleration for this groupset</span></button>
271<div class="content" style="display: none;">
272 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Flag to turn on within-group Diffusion Synthetic Acceleration for this groupset
294><span class="arrow" style="padding-left: 0px;">►</span><TT><B>gmres_restart_interval</B></TT><span style="color: #c4c1c0;">       If this inner linear solver is gmres, sets the number of iterations before a restart occurs</span></button>
295<div class="content" style="display: none;">
296 <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.
319><span class="arrow" style="padding-left: 0px;">►</span><TT><B>groupset_num_subsets</B></TT><span style="color: #c4c1c0;">       The number of subsets to apply to the set of groups in this set</span></button>
320<div class="content" style="display: none;">
321 <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
344><span class="arrow" style="padding-left: 0px;">►</span><TT><B>inner_linear_method</B></TT><span style="color: #c4c1c0;">       The iterative method to use for inner linear solves</span></button>
345<div class="content" style="display: none;">
346 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. The iterative method to use for inner linear solves
419><span class="arrow" style="padding-left: 0px;">►</span><TT><B>log_sweep_events</B></TT><span style="color: #c4c1c0;">       Turns on a log of sweep events</span></button>
420<div class="content" style="display: none;">
421 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Turns on a log of sweep events
640><span class="arrow" style="padding-left: 0px;">►</span><TT><B>num_groups</B></TT><span style="color: #c4c1c0;">       The total number of groups within the solver</span></button>
641<div class="content" style="display: none;">
642 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. The total number of groups within the solver
643</p>
644</div>
645
646</div>
647\endhtmlonly
648
649## Optional Input parameters
650\htmlonly
651
652<div style="display: block;">
653<button type="button" class="droppy2" style=
654"
655background-color: #edf0f5;
656color: #9373A5;
657cursor: pointer;
658border: none;
659text-align: left;
660outline: none;
661font-size: 15px;
662margin: 2px 2px;
663border: 2px solid #687372;
664display: block;
665width: 100%;
666vertical-align: middle;
667padding-top: 4px;
668padding-bottom: 0px;
669"
670><span class="arrow" style="padding-left: 0px;">►</span><TT><B>directions_sweep_order_to_print</B></TT><span style="color: #c4c1c0;">       List of direction id's for which sweep ordering info is to be printed</span></button>
671<div class="content" style="display: none;">
672 <p><I>type=</I><span style="color: blue;"><TT>ARRAY</TT></span>. List of direction id's for which sweep ordering info is to be printed.
743><span class="arrow" style="padding-left: 0px;">►</span><TT><B>max_time_steps</B></TT><span style="color: #c4c1c0;">       Maximum number of timesteps to allow</span></button>
744<div class="content" style="display: none;">
745 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. Maximum number of timesteps to allow. Negative values disables this.
767><span class="arrow" style="padding-left: 0px;">►</span><TT><B>name</B></TT><span style="color: #c4c1c0;">       A text name to associate with the solver</span></button>
768<div class="content" style="display: none;">
769 <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.
874><span class="arrow" style="padding-left: 0px;">►</span><TT><B>name</B></TT><span style="color: #c4c1c0;">       Boundary name that identifies the specific boundary</span></button>
875<div class="content" style="display: none;">
876 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. Boundary name that identifies the specific boundary
943><span class="arrow" style="padding-left: 0px;">►</span><TT><B>function_name</B></TT><span style="color: #c4c1c0;">       Text name of the lua function to be called for this boundary condition</span></button>
944<div class="content" style="display: none;">
945 <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.
967><span class="arrow" style="padding-left: 0px;">►</span><TT><B>group_strength</B></TT><span style="color: #c4c1c0;">       Required only if `type` is `"incident_isotropic"`</span></button>
968<div class="content" style="display: none;">
969 <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
996><span class="arrow" style="padding-left: 0px;">►</span><TT><B>field_function_prefix</B></TT><span style="color: #c4c1c0;">       Prefix to use on all field functions</span></button>
997<div class="content" style="display: none;">
998 <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.
1020><span class="arrow" style="padding-left: 0px;">►</span><TT><B>field_function_prefix_option</B></TT><span style="color: #c4c1c0;">       Prefix option on field function names</span></button>
1021<div class="content" style="display: none;">
1022 <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`.
1045><span class="arrow" style="padding-left: 0px;">►</span><TT><B>power_default_kappa</B></TT><span style="color: #c4c1c0;">       Default `kappa` value (Energy released per fission) to use for power generation when cross sections do not have `kappa` values</span></button>
1046<div class="content" style="display: none;">
1047 <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).
1069><span class="arrow" style="padding-left: 0px;">►</span><TT><B>power_field_function_on</B></TT><span style="color: #c4c1c0;">       Flag to control the creation of the power generation field function</span></button>
1070<div class="content" style="display: none;">
1071 <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`.
1095 <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.
1117><span class="arrow" style="padding-left: 0px;">►</span><TT><B>read_restart_data</B></TT><span style="color: #c4c1c0;">       Flag indicating whether restart data is to be read</span></button>
1118<div class="content" style="display: none;">
1119 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Flag indicating whether restart data is to be read.
1141><span class="arrow" style="padding-left: 0px;">►</span><TT><B>read_restart_file_base</B></TT><span style="color: #c4c1c0;">       File base name to use when reading restart data</span></button>
1142<div class="content" style="display: none;">
1143 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. File base name to use when reading restart data.
1165><span class="arrow" style="padding-left: 0px;">►</span><TT><B>read_restart_folder_name</B></TT><span style="color: #c4c1c0;">       Folder name to use when reading restart data</span></button>
1166<div class="content" style="display: none;">
1167 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. Folder name to use when reading restart data.
1189><span class="arrow" style="padding-left: 0px;">►</span><TT><B>save_angular_flux</B></TT><span style="color: #c4c1c0;">       Flag indicating whether angular fluxes are to be stored or not</span></button>
1190<div class="content" style="display: none;">
1191 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Flag indicating whether angular fluxes are to be stored or not.
1213><span class="arrow" style="padding-left: 0px;">►</span><TT><B>scattering_order</B></TT><span style="color: #c4c1c0;">       Defines the level of harmonic expansion for the scattering source</span></button>
1214<div class="content" style="display: none;">
1215 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. Defines the level of harmonic expansion for the scattering source.
1262><span class="arrow" style="padding-left: 0px;">►</span><TT><B>sweep_eager_limit</B></TT><span style="color: #c4c1c0;">       The eager limit to be used in message size during sweep initialization</span></button>
1263<div class="content" style="display: none;">
1264 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. The eager limit to be used in message size during sweep initialization.
1265 This expects to be followed by a size in bytes (Max 64,0000)See note below.\n\n ###Note on the Eager limit
1266The 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.
1312><span class="arrow" style="padding-left: 0px;">►</span><TT><B>use_source_moments</B></TT><span style="color: #c4c1c0;">       Flag for ignoring fixed sources and selectively using source moments obtained elsewhere</span></button>
1313<div class="content" style="display: none;">
1314 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Flag for ignoring fixed sources and selectively using source moments obtained elsewhere.
1336><span class="arrow" style="padding-left: 0px;">►</span><TT><B>verbose_ags_iterations</B></TT><span style="color: #c4c1c0;">       Flag to control verbosity of across-groupset iterations</span></button>
1337<div class="content" style="display: none;">
1338 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Flag to control verbosity of across-groupset iterations.
1360><span class="arrow" style="padding-left: 0px;">►</span><TT><B>verbose_inner_iterations</B></TT><span style="color: #c4c1c0;">       Flag to control verbosity of inner iterations</span></button>
1361<div class="content" style="display: none;">
1362 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Flag to control verbosity of inner iterations.
1384><span class="arrow" style="padding-left: 0px;">►</span><TT><B>verbose_outer_iterations</B></TT><span style="color: #c4c1c0;">       Flag to control verbosity of across-groupset iterations</span></button>
1385<div class="content" style="display: none;">
1386 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Flag to control verbosity of across-groupset iterations.
1408><span class="arrow" style="padding-left: 0px;">►</span><TT><B>write_restart_data</B></TT><span style="color: #c4c1c0;">       Flag indicating whether restart data is to be written</span></button>
1409<div class="content" style="display: none;">
1410 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Flag indicating whether restart data is to be written.
1432><span class="arrow" style="padding-left: 0px;">►</span><TT><B>write_restart_file_base</B></TT><span style="color: #c4c1c0;">       File base name to use when writing restart data</span></button>
1433<div class="content" style="display: none;">
1434 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. File base name to use when writing restart data.
1456><span class="arrow" style="padding-left: 0px;">►</span><TT><B>write_restart_folder_name</B></TT><span style="color: #c4c1c0;">       Folder name to use when writing restart data</span></button>
1457<div class="content" style="display: none;">
1458 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. Folder name to use when writing restart data.
1480><span class="arrow" style="padding-left: 0px;">►</span><TT><B>write_restart_interval</B></TT><span style="color: #c4c1c0;">       Interval at which restart data is to be written</span></button>
1481<div class="content" style="display: none;">
1482 <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Interval at which restart data is to be written. Currently not implemented.
1533><span class="arrow" style="padding-left: 0px;">►</span><TT><B>sweep_type</B></TT><span style="color: #c4c1c0;">       The sweep type to use for sweep operatorations</span></button>
1534<div class="content" style="display: none;">
1535 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. The sweep type to use for sweep operatorations.
1558><span class="arrow" style="padding-left: 0px;">►</span><TT><B>time</B></TT><span style="color: #c4c1c0;">       Current time of the solver</span></button>
1559<div class="content" style="display: none;">
1560 <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Current time of the solver.
1582><span class="arrow" style="padding-left: 0px;">►</span><TT><B>timestepper</B></TT><span style="color: #c4c1c0;">       Handle to a timestepper</span></button>
1583<div class="content" style="display: none;">
1584 <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.