PolarisA.rst.txt 25.6 KB
Newer Older
Batson Iii's avatar
Batson Iii committed
1
2
.. _3-2a:

Batson Iii's avatar
Batson Iii committed
3
SCALE 6.2 Polaris Input Format
Batson Iii's avatar
Batson Iii committed
4
5
6
7
8
9
10
11
==============================

For the release of SCALE 6.2.3, several new input cards were implemented
into Polaris to model boiling water reactor (BWR) geometries and
neutron/gamma detectors, which requires a gamma transport calculation.
Moreover, improvements to existing input cards were implemented, along
with the ability to specify time-dependent state properties and the
ability to specify one or more depletion histories. This appendix
Batson Iii's avatar
Batson Iii committed
12
13
documents the SCALE 6.2 input cards that were included in the Polaris
input format which are accessible as part of the release of SCALE 6.3.
Batson Iii's avatar
Batson Iii committed
14

Batson Iii's avatar
Batson Iii committed
15
16
17
18
The old input cards are not available *by default* with SCALE 6.3, and
should be considered deprecated. To maximize backwards compatibility for
input files developed with the original SCALE 6.2.0 release, the old
input options are available if the input file begins with =polaris_6.2.
Batson Iii's avatar
Batson Iii committed
19

Batson Iii's avatar
Batson Iii committed
20
21
The following input cards were introduced in SCALE 6.3 and are not
available by default in SCALE 6.2:
Batson Iii's avatar
Batson Iii committed
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

-  **cross** – define the interior water cross geometry of SVEA assembly
   designs;

-  **dxmap** (or **dymap**) – define displacement maps that indicate
   that translation of the pin center in the x- (or y-) direction;

-  **control <BLADE>** - define the control blade geometry;

-  **mesh** – define advanced spatial meshing options for different
   materials; and

-  **option <GEOM>** – define geometry tolerances, advance meshing
   options, and plotting options.

Batson Iii's avatar
Batson Iii committed
37
-  **option <GAMMA>** – gamma transport calculation
Batson Iii's avatar
Batson Iii committed
38

Batson Iii's avatar
Batson Iii committed
39
-  **detector** – insert a detector geometry
Batson Iii's avatar
Batson Iii committed
40

Batson Iii's avatar
Batson Iii committed
41
-  **history** – time dependent history
Batson Iii's avatar
Batson Iii committed
42

Batson Iii's avatar
Batson Iii committed
43
44
-  **bui [ti]** – initiate calculation with cumulative burnups [time]
   (with restart)
Batson Iii's avatar
Batson Iii committed
45

Batson Iii's avatar
Batson Iii committed
46
-  **property<GRAIN>** – used to model stochastic media
Batson Iii's avatar
Batson Iii committed
47

Batson Iii's avatar
Batson Iii committed
48
49
-  **state** – the generalized state input is preceded by the
   state<MNAME>, state<INAME>, state<GNAME> variants
Batson Iii's avatar
Batson Iii committed
50
51
52

.. _3-2a-1:

Batson Iii's avatar
Batson Iii committed
53
54
box – channel box
-----------------
Batson Iii's avatar
Batson Iii committed
55

Batson Iii's avatar
Batson Iii committed
56
57
**box** [thick=*Real*] [rad=*Real*] [icdist=*Real*] [xrad=*Real*]
[xlen=*Real*] [Mbox=MNAME]
Batson Iii's avatar
Batson Iii committed
58

Batson Iii's avatar
Batson Iii committed
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
+-------------+-------------+-------------+-------------+-------------+
| **param**   | **type**    | **name**    | **details** | **default** |
+-------------+-------------+-------------+-------------+-------------+
| thick       | *Real*      | nominal     | must be >0  | none        |
|             |             | thickness   |             |             |
|             |             | (cm)        |             |             |
+-------------+-------------+-------------+-------------+-------------+
| rad         | *Real*      | inner       | must be >0, | none        |
|             |             | corner      |             |             |
|             |             | radius (cm) | additional  |             |
|             |             |             | constraints |             |
|             |             |             | listed      |             |
|             |             |             | below       |             |
+-------------+-------------+-------------+-------------+-------------+
| icdist      | *Real*      | in-channel  | must be >0  | none        |
|             |             | distance    |             |             |
|             |             | (cm)        |             |             |
+-------------+-------------+-------------+-------------+-------------+
| xrad        | *Real*      | extra       | must be >=  | 0           |
|             |             | corner      | 0           |             |
|             |             | thickness   |             |             |
|             |             | (cm)        |             |             |
+-------------+-------------+-------------+-------------+-------------+
| xlen        | *Real*      | extra       | excludes    | 0           |
|             |             | corner      | rounded     |             |
|             |             | length (cm) | corner      |             |
|             |             |             | length      |             |
+-------------+-------------+-------------+-------------+-------------+
| M\ :sub:`bo\| MNAME       | box         |             | \*          |
| x`          |             | material    |             |             |
+-------------+-------------+-------------+-------------+-------------+
Batson Iii's avatar
Batson Iii committed
90

Batson Iii's avatar
Batson Iii committed
91
..
Batson Iii's avatar
Batson Iii committed
92

Batson Iii's avatar
Batson Iii committed
93
94
  \*By default, **box** material will be set to CAN.1 by “system BWR.”
  Otherwise **box** material is required.
Batson Iii's avatar
Batson Iii committed
95

Batson Iii's avatar
Batson Iii committed
96
.. highlight:: scale
Batson Iii's avatar
Batson Iii committed
97
98
99

::

Batson Iii's avatar
Batson Iii committed
100
101
102
103
104
105
  % GE 7x7 assembly with 1.88 cm pin pitch
  %   0.48 cm narrow gap
  %   0.95 cm wide gap
  system BWR
  geom ge7x7 : ASSM 7 1.88
  hgap 0.48 0.95
Batson Iii's avatar
Batson Iii committed
106

Batson Iii's avatar
Batson Iii committed
107
108
109
110
111
  % Box geometry
  %   0.2 thickness
  %   0.97 inner corner radius
  %   0.14 in-channel distance
  box 0.2 0.97 0.14
Batson Iii's avatar
Batson Iii committed
112

Batson Iii's avatar
Batson Iii committed
113
114
  % Same example, all variables
  box 0.2 0.97 0.14 0 0 CAN.1
Batson Iii's avatar
Batson Iii committed
115
116
117

Comments:

Batson Iii's avatar
Batson Iii committed
118
119
120
121
122
123
The **box** specifies the channel box geometry and material that
surround the array of fuel pins.

.. image:: figs/PolarisA/img1.png
  :align: center
  :width: 1400
Batson Iii's avatar
Batson Iii committed
124
125
126

See also:

Batson Iii's avatar
Batson Iii committed
127
**hgap**
Batson Iii's avatar
Batson Iii committed
128
129
130
131

.. _fig3-2a-1:
.. figure:: figs/PolarisA/fig1.png
  :align: center
Batson Iii's avatar
Batson Iii committed
132
  :width: 500
Batson Iii's avatar
Batson Iii committed
133

Batson Iii's avatar
Batson Iii committed
134
  Box geometry example (uniform thickness).
Batson Iii's avatar
Batson Iii committed
135
136
137
138

.. _fig3-2a-2:
.. figure:: figs/PolarisA/fig2.png
  :align: center
Batson Iii's avatar
Batson Iii committed
139
  :width: 500
Batson Iii's avatar
Batson Iii committed
140

Batson Iii's avatar
Batson Iii committed
141
  Box geometry example (thick corners).
Batson Iii's avatar
Batson Iii committed
142

Batson Iii's avatar
Batson Iii committed
143
.. _3-2a-2:
Batson Iii's avatar
Batson Iii committed
144

Batson Iii's avatar
Batson Iii committed
145
146
pin – pin or pincell
--------------------
Batson Iii's avatar
Batson Iii committed
147

Batson Iii's avatar
Batson Iii committed
148
149
pin – pin or pincell
^^^^^^^^^^^^^^^^^^^^^
Batson Iii's avatar
Batson Iii committed
150

Batson Iii's avatar
Batson Iii committed
151
152
153
154
155
156
157
| **pin** PINID [nsect=*Int*] [nring=*Int*] [size=*Int*]
| : r\ :sub:`1` r\ :sub:`2` … r\ :sub:`i` … r\ :sub:`N`
| : M\ :sub:`1` M\ :sub:`2` … M\ :sub:`i` … M\ :sub:`N` [M\ :sub:`out`]
| [: nr\ :sub:`1` nr\ :sub:`2` … nr\ :sub:`i` … nr\ :sub:`N`
  nr\ :sub:`out`]
| [: ns\ :sub:`1` ns\ :sub:`2` … ns\ :sub:`i` … ns\ :sub:`N`
  ns\ :sub:`out`]
Batson Iii's avatar
Batson Iii committed
158
159
160
161

.. list-table::
  :align: center

Batson Iii's avatar
Batson Iii committed
162
163
  * - .. image:: figs/PolarisA/tab3-2a-2.svg
        :width: 700
Batson Iii's avatar
Batson Iii committed
164

Batson Iii's avatar
Batson Iii committed
165
..
Batson Iii's avatar
Batson Iii committed
166

Batson Iii's avatar
Batson Iii committed
167
168
169
170
   \*If not specified, the material class MCLASS is taken from the
   **channel** card (M\ :sub:`chan`) and set to the first member of that
   class, “M\ :sub:`chan`.1.” For example if M\ :sub:`chan`\ =“COOL,”
   then M\ :sub:`out`\ = “COOL.1.”
Batson Iii's avatar
Batson Iii committed
171

Batson Iii's avatar
Batson Iii committed
172
Examples:
Batson Iii's avatar
Batson Iii committed
173

Batson Iii's avatar
Batson Iii committed
174
::
Batson Iii's avatar
Batson Iii committed
175

Batson Iii's avatar
Batson Iii committed
176
177
178
  %standard fuel pin
  pin 1 : 0.4096 0.418 0.475
        : FUEL   GAS   CLAD
Batson Iii's avatar
Batson Iii committed
179

Batson Iii's avatar
Batson Iii committed
180
181
182
  %empty guide tube
  pin E :        0.561 0.602
        :       COOL.1 CLAD.1
Batson Iii's avatar
Batson Iii committed
183

Batson Iii's avatar
Batson Iii committed
184
185
186
  %pyrex
  pin P : 0.214 0.231 0.241 0.427 0.437 0.484 0.561 0.602
        : GAS   TUBE  GAS   BP.3  GAS   TUBE  COOL  CLAD
Batson Iii's avatar
Batson Iii committed
187

Batson Iii's avatar
Batson Iii committed
188
189
190
  %standard fuel pin with explicit material in the outermost region
  pin 1 : 0.4096 0.418 0.475
        : FUEL   GAS   CLAD   COOL.6
Batson Iii's avatar
Batson Iii committed
191
192


Batson Iii's avatar
Batson Iii committed
193
194
195
196
197
  %standard fuel pin with explicit ring and sector mesh
  pin 1 : 0.4096 0.418 0.475
        : FUEL   GAS   CLAD
        : 5      1     1      0   %5 rings in fuel
        : 8      1     1      1   %8 sectors only in fuel
Batson Iii's avatar
Batson Iii committed
198
199


Batson Iii's avatar
Batson Iii committed
200
201
202
  %large central 2x2 water rod in 4x4 assembly
  pin W size=2 : 0.8
               : COOL
Batson Iii's avatar
Batson Iii committed
203

Batson Iii's avatar
Batson Iii committed
204
205
206
207
208
209
  %pinmap must show adjacent Ws
  pinmap
  F F F F
  F W W F
  F W W F
  F F F F
Batson Iii's avatar
Batson Iii committed
210
211
212

Comments:

Batson Iii's avatar
Batson Iii committed
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
The **pin** card is one of the basic building blocks of the assembly
model. It is the only geometry component which allows an integer (*Int*)
identifier as well as a *Word*—all other geometric identifiers use
*Word*. Note that the materials are required, except for the last
M\ :sub:`out`, which can be used to overwrite the material given by a
**channel** for the outermost region in the pincell. The various pin
cell meshing options are displayed in :numref:`fig3-2a-3`. Note that extra
rings in the radial zones create equal area regions, whereas rings in
the outermost region create equal distance divisions between the last
radius and the pincell boundary. Extra sectors create additional
azimuthal divisions. A negative value of sectors is allowed and can be
used to rotate the sector mesh by a half angle, e.g., ns=4 looks like ⊕
and ns=-4 looks like ⊗.

The total number of cells used in the transport calculation is
determined from both the number of rings and the number of sectors. With
the MoC transport solver, the fidelity of the solution is also dictated
by the number of azimuthal and polar angles and ray spacing. These
parameters are changed on the **option<KEFF>** card.

Due to self-shielding and depletion, each cell could be modeled as a
unique material with its own cross section data. However, this is
prohibitively memory intensive and typically not necessary. The
**shield** card provides the mechanism to control the additional
self-shielded materials introduced.
Batson Iii's avatar
Batson Iii committed
238
239
240

See also:

Batson Iii's avatar
Batson Iii committed
241
pinmap, control, insert, channel, system, option<KEFF>, shield
Batson Iii's avatar
Batson Iii committed
242

Batson Iii's avatar
Batson Iii committed
243
244
.. _fig3-2a-3:
.. figure:: figs/PolarisA/fig3.png
Batson Iii's avatar
Batson Iii committed
245
246
247
  :align: center
  :width: 500

Batson Iii's avatar
Batson Iii committed
248
  Pincell meshing variants.
Batson Iii's avatar
Batson Iii committed
249

Batson Iii's avatar
Batson Iii committed
250
.. _3-2a-3:
Batson Iii's avatar
Batson Iii committed
251

Batson Iii's avatar
Batson Iii committed
252
253
bu – initiate calculation with cumulative burnups
-------------------------------------------------
Batson Iii's avatar
Batson Iii committed
254

Batson Iii's avatar
Batson Iii committed
255
256
**bu** [units=*GWD/MTIHM*\ \|\ *MWD/MTIHM*] : [b\ :sub:`1` b\ :sub:`2` …
b\ :sub:`i` … b\ :sub:`N`]
Batson Iii's avatar
Batson Iii committed
257

Batson Iii's avatar
Batson Iii committed
258
259
260
261
262
263
264
265
266
267
268
+-------------+-------------+------------------+-------------+-------------+
| **param**   | **Type**    | **name**         | **details** | **default** |
+-------------+-------------+------------------+-------------+-------------+
| units       | GWD/MTIHM\| | burnup units     |             | GWD/MTIHM   |
|             |             |                  |             |             |
|             | MWD/MTIHM   |                  |             |             |
+-------------+-------------+------------------+-------------+-------------+
| b\ :sub:`i` | *Real*      | list of          |             | 0           |
|             |             |                  |             |             |
|             |             | absolute burnups |             |             |
+-------------+-------------+------------------+-------------+-------------+
Batson Iii's avatar
Batson Iii committed
269
270
271
272
273
274
275

Examples:

::

  % simple depletion case with constant power and absolute/cumulative burnups
  power 40
Batson Iii's avatar
Batson Iii committed
276
  bu 0 5 10 15 20 30 40 50 60 80
Batson Iii's avatar
Batson Iii committed
277
278

  % using MWd/MTIHM units with variable power
Batson Iii's avatar
Batson Iii committed
279
  % 40 W/gIHM for 05000 MWD/MTIHM, then 30 W/gIHM for 500010000 MWD/MTIHM
Batson Iii's avatar
Batson Iii committed
280
  power  40    30
Batson Iii's avatar
Batson Iii committed
281
  bu MWD/MTIHM: 0 5000 10000
Batson Iii's avatar
Batson Iii committed
282

Batson Iii's avatar
Batson Iii committed
283
284
  % combine burn/time cards
  % 20 W/gIHM for 05 then 510 GWD/MTIHM steps, then
Batson Iii's avatar
Batson Iii committed
285
286
  % 40 W/gIHM for a 5-day step then 30 W/gIHM for a 5-day step
  power 20
Batson Iii's avatar
Batson Iii committed
287
  bu   GWD/MTIHM :  5 10 GWD/MTIHM
Batson Iii's avatar
Batson Iii committed
288
  power 40 30
Batson Iii's avatar
Batson Iii committed
289
  dt  DAYS :   5  5
Batson Iii's avatar
Batson Iii committed
290
291
292
293

Comments:

The **bu** card initiates a calculation for a given sequence of
Batson Iii's avatar
Batson Iii committed
294
295
296
297
298
299
300
301
302
cumulative burnups. A burnup or time card usually follows a **power**
card, the two effectively specifying the power history. If multiple
burnups are given, then the **power** card must have either a single
power or a list of powers the same size as the list times. A value of 0
is implicit at the beginning of the first burnup list. Multiple
burnup/time cards may be specified in an input. This can be convenient
for switching units or changing from burnup-based to time-based
depletion. Internal automatic substeps are always in effect unless
modified with the **option<DEPL>** card.
Batson Iii's avatar
Batson Iii committed
303
304
305

See also:

Batson Iii's avatar
Batson Iii committed
306
t, dt, dbu, power, option<DEPL>, branch, deplete
Batson Iii's avatar
Batson Iii committed
307

Batson Iii's avatar
Batson Iii committed
308
.. _3-2a-4:
Batson Iii's avatar
Batson Iii committed
309

Batson Iii's avatar
Batson Iii committed
310
311
dbu – initiate calculation with incremental burnups
---------------------------------------------------
Batson Iii's avatar
Batson Iii committed
312

Batson Iii's avatar
Batson Iii committed
313
314
**dbu** [units=*GWD/MTIHM*\ \|\ *MWD/MTIHM*] : [b\ :sub:`1` b\ :sub:`2` …
b\ :sub:`i` … b\ :sub:`N`]
Batson Iii's avatar
Batson Iii committed
315
316
317
318
319
320
321
322

+-------------+-------------+---------------------+-------------+-------------+
| **param**   | **Type**    | **name**            | **details** | **default** |
+-------------+-------------+---------------------+-------------+-------------+
| units       | GWD/MTIHM\| | burnup units        |             | GWD/MTIHM   |
|             |             |                     |             |             |
|             | MWD/MTIHM   |                     |             |             |
+-------------+-------------+---------------------+-------------+-------------+
Batson Iii's avatar
Batson Iii committed
323
324
325
326
| b\ :sub:`i` | *Real*      | list of             |             | 0           |
|             |             |                     |             |             |
|             |             | incremental burnups |             |             |
+-------------+-------------+---------------------+-------------+-------------+
Batson Iii's avatar
Batson Iii committed
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345

Examples:

::

  % incremental burnups equivalent to
  %   power 40
  %   bu 0 5 10 15 20 30 40 50 60 80
  power 40
  dbu 5 5 5 5 10 10 10 10 20

Comments:

The **dbu** card initiates a calculation for a given sequence of
*incremental* burnups. Otherwise, it is identical to the **bu** card for
specifying cumulative burnups.

See also:

Batson Iii's avatar
Batson Iii committed
346
**t, dt, bu, power, option<DEPL>, branch, deplete**
Batson Iii's avatar
Batson Iii committed
347

Batson Iii's avatar
Batson Iii committed
348
.. _3-2a-5:
Batson Iii's avatar
Batson Iii committed
349

Batson Iii's avatar
Batson Iii committed
350
351
t – initiate calculation by cumulative time
-------------------------------------------
Batson Iii's avatar
Batson Iii committed
352

Batson Iii's avatar
Batson Iii committed
353
354
355
**t**
[units=*SECONDS*\ \|\ *MINUTES*\ \|\ *HOURS*\ \|\ *DAYS*\ \|\ *YEARS*] :
[t\ :sub:`1` t\ :sub:`2` … t\ :sub:`i` … t\ :sub:`N`]
Batson Iii's avatar
Batson Iii committed
356
357
358
359
360
361
362
363
364

+-------------+-------------+-------------+-------------+-------------+
| **param**   | **Type**    | **name**    | **details** | **default** |
+-------------+-------------+-------------+-------------+-------------+
| units       | *SECONDS*\  | time units  |             | DAYS        |
|             | \|\ *MINUTE |             |             |             |
|             | S*\ \|      |             |             |             |
|             |             |             |             |             |
|             | *HOURS*\ \| |             |             |             |
Batson Iii's avatar
Batson Iii committed
365
|             | \ *DAYS*\ \ |             |             |             |
Batson Iii's avatar
Batson Iii committed
366
367
|             | |\ *YEARS*  |             |             |             |
+-------------+-------------+-------------+-------------+-------------+
Batson Iii's avatar
Batson Iii committed
368
369
370
371
| t\ :sub:`i` | *Real*      | list of     | 0           | 0           |
|             |             |             |             |             |
|             |             | times       |             |             |
+-------------+-------------+-------------+-------------+-------------+
Batson Iii's avatar
Batson Iii committed
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405

Examples:

::

  % burn with 40 W/gIHM for 300 days in 100-day increments
  power 40
  t 100 200 300

  % simulate 2 cycles of time-dependent irradiation with shutdown cooling
  % note that time defaults to DAYs
  %
  % cycle 1
  power 40   30   30   30
  t    100  200  300  400
  power  0
  t    415
  %
  % cycle 2
  power 30   20   20   20
  t    515  615  715  815
  power  0
  t    830

Comments:

The **t** card initiates a calculation for a given sequence of
cumulative/absolute times. One of the time cards (**t**, **dt**, or
**ti)** is required to model periods of decay in conjunction with
**power** 0. Otherwise, the time card **t** is similar in functionality
to the burnup **bu** card but with different units.

See also:

Batson Iii's avatar
Batson Iii committed
406
**dt, bu, dbu, power, option<DEPL>, branch, deplete**
Batson Iii's avatar
Batson Iii committed
407

Batson Iii's avatar
Batson Iii committed
408
.. _3-2a-6:
Batson Iii's avatar
Batson Iii committed
409

Batson Iii's avatar
Batson Iii committed
410
411
dt – initiate calculation by incremental time
---------------------------------------------
Batson Iii's avatar
Batson Iii committed
412

Batson Iii's avatar
Batson Iii committed
413
414
415
**dt**
[units=*SECONDS*\ \|\ *MINUTES*\ \|\ *HOURS*\ \|\ *DAYS*\ \|\ *YEARS*] :
[\ t\ :sub:`1` t\ :sub:`2` … t\ :sub:`i` … t\ :sub:`N`]
Batson Iii's avatar
Batson Iii committed
416
417
418
419
420
421
422
423
424
425
426
427

+-------------+-------------+-------------+-------------+-------------+
| **param**   | **Type**    | **name**    | **details** | **default** |
+-------------+-------------+-------------+-------------+-------------+
| units       | *SECONDS*\  | time units  |             | DAYS        |
|             | \|\ *MINUTE |             |             |             |
|             | S*\ \|      |             |             |             |
|             |             |             |             |             |
|             | *HOURS*\ \| |             |             |             |
|             | \ *DAYS*\ \ |             |             |             |
|             | |\ *YEARS*  |             |             |             |
+-------------+-------------+-------------+-------------+-------------+
Batson Iii's avatar
Batson Iii committed
428
| t\ :sub:`i` | *Real*      | list of     | 0           | 0           |
Batson Iii's avatar
Batson Iii committed
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
|             |             |             |             |             |
|             |             | times       |             |             |
+-------------+-------------+-------------+-------------+-------------+

Examples:

::

  % burn with 40 W/gIHM for 300 days in 100-day increments equivalent to
  %     power 40
  %     t 100 200 300
  power 40
  dt 100 100 100

  % decay for 30 minutes
  power 0
  dt 30 MINUTES

Comments:

The **dt** card is identical to the cumulative time card **t** except
that the values given are incremental.

See also:

Batson Iii's avatar
Batson Iii committed
454
t, bu, dbu, power, option<DEPL>, branch, deplete
Batson Iii's avatar
Batson Iii committed
455

Batson Iii's avatar
Batson Iii committed
456
.. _3-2a-7:
Batson Iii's avatar
Batson Iii committed
457

Batson Iii's avatar
Batson Iii committed
458
459
option<ESSM> – embedded self-shielding
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Batson Iii's avatar
Batson Iii committed
460

Batson Iii's avatar
Batson Iii committed
461
462
463
| **opt** *ESSM*
| [key\ :sub:`1`\ =val\ :sub:`1` key\ :sub:`2`\ =val\ :sub:`2` …
  key\ :sub:`i`\ =val\ :sub:`i` … key\ :sub:`N`\ =val\ :sub:`N`]
Batson Iii's avatar
Batson Iii committed
464
465
466
467

.. list-table::
  :align: center

Batson Iii's avatar
Batson Iii committed
468
469
  * - .. image:: figs/PolarisA/tab3-2a-7.svg
        :width: 700
Batson Iii's avatar
Batson Iii committed
470
471
472
473
474

Examples:

::

Batson Iii's avatar
Batson Iii committed
475
476
  % change within group solver to use source iterations
  opt ESSM WithinGroupSolver=SOURCE
Batson Iii's avatar
Batson Iii committed
477

Batson Iii's avatar
Batson Iii committed
478
.. _3-2a-8:
Batson Iii's avatar
Batson Iii committed
479

Batson Iii's avatar
Batson Iii committed
480
481
option<FG> – few-group cross section generation
-----------------------------------------------
Batson Iii's avatar
Batson Iii committed
482

Batson Iii's avatar
Batson Iii committed
483
484
485
486
| **opt** *FG*
|     [AdjointMode=String InvVelMode=String]
|     [: b\ :sub:`1` b\ :sub:`2` … b\ :sub:`i` … b\ :sub:`N` ]
|     [: E\ :sub:`1` E\ :sub:`2` … E\ :sub:`i` … E\ :sub:`N-1` ]
Batson Iii's avatar
Batson Iii committed
487

Batson Iii's avatar
Batson Iii committed
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
+-----------------+-----------------+-----------------+-----------------+
| **param**       | **type**        | **details**     | **default**     |
+=================+=================+=================+=================+
| AdjointMode     | *String*        | type of adjoint | "INFMED"        |
|                 |                 | calculation to  |                 |
|                 |                 | use in          |                 |
|                 |                 | few-group data  |                 |
|                 |                 | generation      |                 |
|                 |                 |                 |                 |
|                 |                 | "INFMED":       |                 |
|                 |                 | infinite medium |                 |
|                 |                 | adjoint         |                 |
|                 |                 |                 |                 |
|                 |                 | "CRITICAL":     |                 |
|                 |                 | critical        |                 |
|                 |                 | spectrum        |                 |
|                 |                 | adjoint         |                 |
|                 |                 |                 |                 |
|                 |                 | "UNIFORM":      |                 |
|                 |                 | uniform adjoint |                 |
+-----------------+-----------------+-----------------+-----------------+
| InvVelMode      | *String*        | weighting       | “FORWARD”       |
|                 |                 | option for      |                 |
|                 |                 | few-group       |                 |
|                 |                 | inverse         |                 |
|                 |                 | velocities      |                 |
|                 |                 |                 |                 |
|                 |                 | “FORWARD”:      |                 |
|                 |                 | forward flux    |                 |
|                 |                 | weighting       |                 |
|                 |                 |                 |                 |
|                 |                 | “ADJOINT”:      |                 |
|                 |                 | adjoint flux    |                 |
|                 |                 | weighting       |                 |
+-----------------+-----------------+-----------------+-----------------+
| b\ :sub:`i`     | *Real*          | list of burnups | all burnups     |
|                 |                 | to include in   | available       |
|                 |                 | output          |                 |
|                 |                 | few-group cross |                 |
|                 |                 | section         |                 |
|                 |                 | database, e.g., |                 |
|                 |                 | XFile16 output  |                 |
|                 |                 |                 |                 |
|                 |                 | units: GWd/MTHM |                 |
+-----------------+-----------------+-----------------+-----------------+
| E\ :sub:`i`     | *Real*          | note descending | 0.625 eV        |
|                 |                 | order and only  | division (two   |
|                 |                 | N-1 divisions   | groups)         |
|                 |                 | are needed for  |                 |
|                 |                 | an N group      |                 |
|                 |                 | structure       |                 |
|                 |                 |                 |                 |
|                 |                 | E\ :sub:`0` is  |                 |
|                 |                 | maximum energy  |                 |
|                 |                 | (typically 2e7  |                 |
|                 |                 | eV)             |                 |
|                 |                 |                 |                 |
|                 |                 | E\ :sub:`N` is  |                 |
|                 |                 | minimum         |                 |
|                 |                 | (typically 1e-5 |                 |
|                 |                 | eV)             |                 |
|                 |                 |                 |                 |
|                 |                 | units: eV       |                 |
+-----------------+-----------------+-----------------+-----------------+
Batson Iii's avatar
Batson Iii committed
552
553
554
555
556

Examples:

::

Batson Iii's avatar
Batson Iii committed
557
558
  % enable the critical spectrum adjoint
  opt FG AdjointMode="CRITICAL"
Batson Iii's avatar
Batson Iii committed
559

Batson Iii's avatar
Batson Iii committed
560
561
  %only include 0,10,15,20 GWd/MTHM burnups in few-group outputs, including XFile16
  opt FG : 0 10 15 20
Batson Iii's avatar
Batson Iii committed
562

Batson Iii's avatar
Batson Iii committed
563
564
  %redefine group energy divisions for 3 groups with divisions at 10 and 0.625 eV
  opt FG : : 10 0.625
Batson Iii's avatar
Batson Iii committed
565

Batson Iii's avatar
Batson Iii committed
566
.. _3-2a-9:
Batson Iii's avatar
Batson Iii committed
567

Batson Iii's avatar
Batson Iii committed
568
569
state<MNAME> – material state
-----------------------------
Batson Iii's avatar
Batson Iii committed
570

Batson Iii's avatar
Batson Iii committed
571
572
573
| **state** MNAME|MCLASS :
| p\ :sub:`1`\ =val\ :sub:`1` p\ :sub:`2`\ =val\ :sub:`2` …
  p\ :sub:`i`\ =val\ :sub:`i` … p\ :sub:`N`\ =val\ :sub:`N`
Batson Iii's avatar
Batson Iii committed
574

Batson Iii's avatar
Batson Iii committed
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
+-------------+-------------+-------------+-------------+-------------+
| **param**   | **type**    | **name**    | **details** | **default** |
+-------------+-------------+-------------+-------------+-------------+
| MNAME|MCLAS\| -           | material    | use ALL for |             |
| S           |             | name or     | all         |             |
|             |             |             | materials   |             |
|             |             | material    |             |             |
|             |             | class       |             |             |
+-------------+-------------+-------------+-------------+-------------+
| p\ :sub:`i` | PNAME       | property    |             |             |
|             |             | name        |             |             |
+-------------+-------------+-------------+-------------+-------------+
| val\        | *Value*     | property    |             |             |
| :sub:`i`    |             | value       |             |             |
+-------------+-------------+-------------+-------------+-------------+
Batson Iii's avatar
Batson Iii committed
590

Batson Iii's avatar
Batson Iii committed
591
Examples:
Batson Iii's avatar
Batson Iii committed
592

Batson Iii's avatar
Batson Iii committed
593
::
Batson Iii's avatar
Batson Iii committed
594

Batson Iii's avatar
Batson Iii committed
595
596
597
  % reset to hot zero power conditions
  state ALL  : temp=565
  state COOL : dens=0.75
Batson Iii's avatar
Batson Iii committed
598
599


Batson Iii's avatar
Batson Iii committed
600
601
602
  % set channel/bypass materials to different ppm boron
  state COOL : boron=0
  state BYP  : boron=600
Batson Iii's avatar
Batson Iii committed
603

Batson Iii's avatar
Batson Iii committed
604
605
  % set all materials with a boron property
  state ALL : boron=300
Batson Iii's avatar
Batson Iii committed
606

Batson Iii's avatar
Batson Iii committed
607
Comments:
Batson Iii's avatar
Batson Iii committed
608

Batson Iii's avatar
Batson Iii committed
609
610
The **state** card declares the *base state* for materials and the *base
state* of possible control elements or insert elements.
Batson Iii's avatar
Batson Iii committed
611

Batson Iii's avatar
Batson Iii committed
612
**See also: material, deplete, system**
Batson Iii's avatar
Batson Iii committed
613

Batson Iii's avatar
Batson Iii committed
614
.. _3-2a-10:
Batson Iii's avatar
Batson Iii committed
615

Batson Iii's avatar
Batson Iii committed
616
617
state<INAME> – insert/control state
-----------------------------------
Batson Iii's avatar
Batson Iii committed
618

Batson Iii's avatar
Batson Iii committed
619
**state** INAME : in=\ *Bool*
Batson Iii's avatar
Batson Iii committed
620

Batson Iii's avatar
Batson Iii committed
621
622
623
624
625
626
627
628
629
+-----------+----------+----------------------+-------------------+-------------+
| **param** | **type** | **name**             | **details**       | **default** |
+-----------+----------+----------------------+-------------------+-------------+
| INAME     | -        | insert name or       |                   |             |
|           |          |                      |                   |             |
|           |          | control element name |                   |             |
+-----------+----------+----------------------+-------------------+-------------+
| in        | Bool     | insertion            | "in=" is required |             |
+-----------+----------+----------------------+-------------------+-------------+
Batson Iii's avatar
Batson Iii committed
630
631
632
633
634

Examples:

::

Batson Iii's avatar
Batson Iii committed
635
636
637
638
639
640
  % insert bank D control rods
  state BankD : in=true
  % remove inserts named Ins6A
  state Ins6A false
  % perform reflector calculation
  state ReflectorNode : in=true
Batson Iii's avatar
Batson Iii committed
641

Batson Iii's avatar
Batson Iii committed
642
Comments:
Batson Iii's avatar
Batson Iii committed
643

Batson Iii's avatar
Batson Iii committed
644
645
646
This form of the **state** card is required to insert any control
element or inserts. By default, inserts and control elements are out
when defined.
Batson Iii's avatar
Batson Iii committed
647

Batson Iii's avatar
Batson Iii committed
648
See also:
Batson Iii's avatar
Batson Iii committed
649

Batson Iii's avatar
Batson Iii committed
650
**material, deplete, system**
Batson Iii's avatar
Batson Iii committed
651

Batson Iii's avatar
Batson Iii committed
652
.. _3-2a-11:
Batson Iii's avatar
Batson Iii committed
653

Batson Iii's avatar
Batson Iii committed
654
655
state<GNAME> – geometry state
-----------------------------
Batson Iii's avatar
Batson Iii committed
656

Batson Iii's avatar
Batson Iii committed
657
**state** GNAME : pres=Bool
Batson Iii's avatar
Batson Iii committed
658

Batson Iii's avatar
Batson Iii committed
659
660
661
662
663
664
665
+-----------+----------+---------------+---------------------+-------------+
| **param** | **type** | **name**      | **details**         | **default** |
+-----------+----------+---------------+---------------------+-------------+
| GNAME     | -        | geometry name |                     |             |
+-----------+----------+---------------+---------------------+-------------+
| pres      | Bool     | present       | “pres=” is required |             |
+-----------+----------+---------------+---------------------+-------------+
Batson Iii's avatar
Batson Iii committed
666
667
668
669
670

Examples:

::

Batson Iii's avatar
Batson Iii committed
671
672
673
  % disable reflector calculation even though
  % reflector geometry is present
  state ReflectorNode : pres=false
Batson Iii's avatar
Batson Iii committed
674
675
676

Comments:

Batson Iii's avatar
Batson Iii committed
677
678
679
680
681
682
683
684
685
The geometry version of the **state** card is used to declare which
geometric elements are present in the system. The geometry version of
the **add** card is useful for performing branch calculations for
reflector nodes. Note that an assembly geometry must be present to
perform a calculation.

See also:

**geometry<REFL>, state<MNAME>, state<INAME>**