Polaris.rst.txt 215 KB
Newer Older
Batson Iii's avatar
Batson Iii committed
1
2
.. _3-2:

Batson Iii's avatar
Batson Iii committed
3
4
POLARIS - 2D Light Water Reactor Lattice Physics Module
=======================================================
Batson Iii's avatar
Batson Iii committed
5

Batson Iii's avatar
Batson Iii committed
6
7
8
*M. A. Jessee, W. A. Wieselquist, C. A. Gentry, A. M. Holcomb, S. W. Hart*

ABSTRACT
Batson Iii's avatar
Batson Iii committed
9
10
11
12
13
14
15
16
17
18
19
20
21

Polaris is a new module for SCALE 6.2 that provides 2D lattice physics
analysis capability for light water reactor (LWR) fuel designs. Polaris
uses a new multigroup self-shielding method called the Embedded Self
Shielding Method (ESSM) and a new transport solver based on the Method
of Characteristics (MoC). The ESSM computes multigroup self-shielded
cross sections using Bondarenko interpolation methods. The background
cross section used in the interpolation is determined by iterative 2D
MoC fixed source transport calculations. Polaris is integrated with
ORIGEN for depletion calculations. Each pin—or each radial subregion of
the pin—is depleted based on the local power distribution. An optional
critical spectrum calculation is incorporated into the depletion
calculation and the output edits of few-group homogenized cross
Batson Iii's avatar
Batson Iii committed
22
sections. Few-group cross sections are archived to an ``xfile016`` file,
Batson Iii's avatar
Batson Iii committed
23
24
25
26
which can be used in subsequent core simulator calculations. Polaris
provides an easy-to-use input format to allow users to set up lattice
models with minimal lines of input.

Batson Iii's avatar
Batson Iii committed
27
ACKNOWLEDGMENTS
Batson Iii's avatar
Batson Iii committed
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

The authors express gratitude to Brad Rearden and Stephen Bowman for
their supervision of Polaris development for the US Nuclear Regulatory
Commission (NRC). The author acknowledges Don Algama and Mourad Aissa of
the NRC for their support of the project. Appreciation is extended to
the ATLAS development team—Jordan Lefebvre, Rob Lefebvre, and Adam
Thompson—for their development of the ATLAS Ray Tracing Geometry package
used in the Polaris MoC solver. Appreciation is also extended to Ugur
Mertyurek, Brian Ade, Ben Betzler, Scott Palmtag, and Andrew Godfrey for
testing and benchmarking efforts and also Sheila Walker for finalizing
the publication of this document.

.. _3-2-1:

Introduction
------------

Batson Iii's avatar
Batson Iii committed
45
Polaris was introduced in SCALE 6.2 to provide 2D lattice physics
Batson Iii's avatar
Batson Iii committed
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
analysis capability for light water reactor (LWR) fuel designs. For
multigroup cross section processing, Polaris uses the Embedded
Self-Shielding Method (ESSM) :cite:`williams_embedded_2012`. Unlike SCALE multigroup sequences that
use XSProc, ESSM does not require user-defined unit cell definitions.
ESSM computes multigroup cross sections using Bondarenko interpolation
methods. The background cross section used in the interpolation is
determined by iterative 2D fixed source transport calculations. Both the
ESSM fixed source calculations and the keff calculation utilize a new
Method of Characteristics (MoC) transport solver developed in the
Exnihilo computational package.

Polaris is integrated with ORIGEN for depletion calculations. Each
pin—or each radial subregion of the pin—is depleted based on the local
power distribution. An optional critical spectrum calculation is
incorporated into the depletion calculation and the output edits of
few-group homogenized cross sections. Few-group cross sections are
archived to an xfile016 file, which can be used in subsequent core
simulator calculations. A complete description of the Polaris
computational methods is provided in :cite:`jessee_polaris_2014`.

Polaris provides an easy-to-use input format to allow users to set up
lattice models with minimal lines of input. All recognized Polaris
commands are shown in :numref:`tab3-2-1`. Note that many commands support short
and long forms. The allowed basic *Types* for input are described in
:numref:`tab3-2-2`. The special Polaris *TYPES* are shown in :numref:`tab3-2-3`. The
convention used in this manual is that basic types appear italicized and
capitalized (*Type*), while special Polaris types appear in all caps
(*TYPE*).

.. _tab3-2-1:
.. table:: Polaris commands.
  :align: center

Batson Iii's avatar
Batson Iii committed
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
  +---------------------------+---------------+--------------+
  | *card*                    | *long*        | *short*      |
  |                           |               |              |
  |                           | *command*     | *command(s)* |
  +===========================+===============+==============+
  | system                    | system        | sys          |
  +---------------------------+---------------+--------------+
  | geometry                  | geometry      | geom         |
  +---------------------------+---------------+--------------+
  | composition               | composition   | comp         |
  +---------------------------+---------------+--------------+
  | property                  | property      | prop         |
  +---------------------------+---------------+--------------+
  | material                  | material      | mat          |
  +---------------------------+---------------+--------------+
  | burnup                    | bu or dbu     | -            |
  +---------------------------+---------------+--------------+
  | power                     | power         | pow          |
  +---------------------------+---------------+--------------+
  | options                   | option        | opt          |
  +---------------------------+---------------+--------------+
  | time                      | t or dt       | -            |
  +---------------------------+---------------+--------------+
  | state                     | state         | -            |
  +---------------------------+---------------+--------------+
  | branch block              | branch        | -            |
  +---------------------------+---------------+--------------+
  | pin geometry component    | pin           | -            |
  +---------------------------+---------------+--------------+
  | assembly pin map          | pinmap        | -            |
  +---------------------------+---------------+--------------+
  | assembly channel          | channel       | -            |
  +---------------------------+---------------+--------------+
  | assembly half gap         | hgap          | -            |
  +---------------------------+---------------+--------------+
  | channel box               | box           | -            |
  +---------------------------+---------------+--------------+
  | shield                    | shield        | -            |
  +---------------------------+---------------+--------------+
  | deplete                   | deplete       | -            |
  +---------------------------+---------------+--------------+
  | slab geometry component   | slab          | -            |
  +---------------------------+---------------+--------------+
  | power basis materials     | basis         | -            |
  +---------------------------+---------------+--------------+
  | assembly inserts          | insert        | -            |
  +---------------------------+---------------+--------------+
  | assembly control elements | control       | -            |
  |                           |               |              |
  | water cross geometry      | cross         | -            |
  |                           |               |              |
  | displacement maps         | dxmap (dymap) | -            |
  |                           |               |              |
  | spatial meshing           | mesh          | -            |
  |                           |               |              |
  | detector tallies          | detector      | -            |
  |                           |               |              |
  | operating histories       | history       | -            |
  |                           |               |              |
  | restart cumulative burnup | bui (ti)      | -            |
  +---------------------------+---------------+--------------+
Batson Iii's avatar
Batson Iii committed
140
141
142
143
144
145
146
147
148
149
150

.. _tab3-2-2:
.. table:: Basic Types in Polaris input.
  :align: center

  +-----------------+-----------------+-----------------+-----------------+
  | *basic Type*    | *description*   | *examples*      | *incorrect      |
  |                 |                 |                 | examples*       |
  +=================+=================+=================+=================+
  | *Word*          | starts with a   | uox             | uox_enr5.1      |
  |                 | character A-Z   |                 |                 |
Batson Iii's avatar
Batson Iii committed
151
152
153
  |                 | or a-z and      | bor_water_500pp | 316SS           |
  |                 | includes        | m               |                 |
  |                 | characters,     |                 | uox-3.1         |
Batson Iii's avatar
Batson Iii committed
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
  |                 | numbers,        | FUEL            |                 |
  |                 | underscores     |                 |                 |
  +-----------------+-----------------+-----------------+-----------------+
  | *Int*           | integer         | 17              | 31.4            |
  |                 |                 |                 | uox             |
  |                 |                 | 92235           |                 |
  |                 |                 |                 |                 |
  |                 |                 | 2               |                 |
  |                 |                 |                 |                 |
  |                 |                 | 565             |                 |
  +-----------------+-----------------+-----------------+-----------------+
  | *Bool*          | boolean/logical | yes             | TRUE            |
  |                 |                 |                 | No              |
  |                 |                 | false           |                 |
  +-----------------+-----------------+-----------------+-----------------+
  | *Real*          | any number      | 565             | yes             |
  |                 |                 |                 | bor_water       |
  |                 |                 | 10.257          |                 |
  |                 |                 |                 |                 |
  |                 |                 | 1.5e-6          |                 |
  +-----------------+-----------------+-----------------+-----------------+
  | *String*        | a single or     | "INFMED"        | Includes spaces |
  |                 | double quoted   |                 |                 |
  |                 | string          | "Includes       |                 |
  |                 |                 | spaces"         |                 |
  |                 |                 |                 |                 |
  |                 |                 | 'NONE'          |                 |
  +-----------------+-----------------+-----------------+-----------------+
  | *Value*         | any non-word    |                 | *Int*\ \|\ *Boo\|
  |                 |                 |                 | l*\ \|\ *Real*\ |
  |                 |                 |                 | \|\ *String*    |
  +-----------------+-----------------+-----------------+-----------------+

.. _tab3-2-3:
.. table:: Special Polaris Types.
  :align: center

  +-----------------------+-----------------------+-----------------------+
  | *Polaris Type*        | *description*         | *Variants*            |
  +=======================+=======================+=======================+
  | *STYPE*               | system type           | *PWR*\ \|\ *BWR*      |
  +-----------------------+-----------------------+-----------------------+
  | *GTYPE*               | geometry type         | *ASSM*\ \|\ *REFL*    |
  +-----------------------+-----------------------+-----------------------+
  | *CTYPE*               | composition type      | *NUM*\ \|\ *WT*\ \|\  |
  |                       |                       | *FORM*\ \|\ *CONC*\ \ |
Batson Iii's avatar
Batson Iii committed
200
201
202
  |                       |                       | |\ *LW*\ \|\ *UOX*\ \ |
  |                       |                       | |\ *ENRU*\ \|\ *UN*\  |
  |                       |                       | \|\ *USI*             |
Batson Iii's avatar
Batson Iii committed
203
  +-----------------------+-----------------------+-----------------------+
Batson Iii's avatar
Batson Iii committed
204
  | *PTYPE*               | property type         | *SOLP*\ \|\ *DOPANT*  |
Batson Iii's avatar
Batson Iii committed
205
  +-----------------------+-----------------------+-----------------------+
Batson Iii's avatar
Batson Iii committed
206
  | *ETYPE*               | control element type  | *RODLET*\ \|\ *BLADE* |
Batson Iii's avatar
Batson Iii committed
207
208
209
210
211
  +-----------------------+-----------------------+-----------------------+
  | *OTYPE*               | option type           | *KEFF*\ \|\ *BOND*\ \ |
  |                       |                       | |\ *ESSM*\ \|\ *CRITS |
  |                       |                       | PEC*\ \|\ *FG*\ \|\ * |
  |                       |                       | DEPL*\ \|\ *RUN*\ \|\ |
Batson Iii's avatar
Batson Iii committed
212
213
  |                       |                       | *PRINT*\ \|\ *GAMMA*  |
  |                       |                       | \ \|\ *GEOM*          |
Batson Iii's avatar
Batson Iii committed
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
  +-----------------------+-----------------------+-----------------------+

The Polaris input supports a very flexible input scheme that allows some
elements to be suppressed for better readability. With *key=value* type
input, when the standard order of keys is used, the keys may be
suppressed. Consider the following input specification as an example.

.. highlight:: scale

::

  geometry GNAME : ASSM npins=Int ppitch=Real [sym=FULL|SE]

The geometry card requires a geometry name (GNAME) in the first group,
then a geometry type (*GTYPE*) which is *ASSM* here indicating an
assembly geometry. The remaining arguments have keys: “npins” with an
integer value, “ppitch” with a real value, and the optional “sym” with
either *FULL* or *SE* values (optional arguments are always shown in
square brackets: [sym=*FULL*\ \|\ *SE*]. The default value is
underlined: (*FULL*). The pipe “|” shows an *or* relation i.e., *FULL*
Batson Iii's avatar
Batson Iii committed
234
235
or *SE* is an acceptable value ). With the flexible input processing, the following inputs are all valid
and identical.
Batson Iii's avatar
Batson Iii committed
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264

::

  geometry FuelNode : ASSM npins=15 ppitch=1.43 sym=FULL
  geometry FuelNode : ASSM 15 1.43 FULL
  geometry FuelNode : ASSM sym=FULL ppitch=1.43 npins=15
  geometry FuelNode : ASSM 15 1.43
  geometry FuelNode ASSM 15 1.43

The group separator “:” is suppressed in the last variant. This is
possible in any situation where (1) the group is implicitly terminated
by running out of arguments or (2) the next type does not match the
expected type in the current group. For example, consider the hgap card:

::

  hgap [ d ] [: M ]

In this card, d and M are values (without keys) defined as *Real* and
material name (MNAME), respectively. The following form would
automatically bypass the *Real* value, which allows a default, and set
the interassembly gap material name as COOL.2.

::

  hgap COOL.2

.. _3-2-2:

Batson Iii's avatar
Batson Iii committed
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
SCALE 6.3 Polaris Input Updates
-------------------------------

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 section
describes the new and modified input cards that are included in the
Polaris input format for SCALE 6.3, which are accessible as part of the
release of SCALE 6.2.3.

To maximize backwards compatibility for input files developed with the
original SCALE 6.2.0 release, the new and modified input cards are not
available *by default* with SCALE 6.2.3. The new and modified input
cards were activated if the input file begins with =polaris_6.3 rather
than =polaris. The suffix “_6.3” is an indicator to the Polaris input
processor to use the SCALE 6.3 input format. For the SCALE 6.3 release,
the original input cards supported in the SCALE 6.2 input format will be
available if the input file begins with =polaris_6.2, with the new SCALE
6.3 defaults being used for inputs with =polaris.

The new input cards to model BWR geometries include:

-  **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.

The modified input cards to model BWR geometries include:

-  **pin** – define circular and square-based geometry zones, as well as
   arbitrarily sized pins, e.g. size=1.5 water rod in some 9x9 BWR
   lattice designs; and

-  **box** – define channel box geometry with arbitrary number of zones
   and cutout regions.

For neutron/gamma detector modeling, there is a new **detector** card
and an addition to the existing **option <FG>** card to enable output to
the few-group cross section output (T16) file.

To control the gamma calculation, an **option <GAMMA>** has been added.

A grain property was added to model materials with randomly distributed
grains, e.g. TRISO.

The new input cards for time-dependent modeling include:

-  **history** – define one or more operating histories in the input
   file; and

-  **bui** (or **ti**) – define restart cumulative burnup (or time)
   values.

The modified input cards for time-dependent modeling include:

-  **state** – define one or more time-independent or time-dependent
   state properties;

-  **bu** (or **t**) – define cumulative burnup (or time) values; and

-  **dbu** (or **dt**) – define incremental burnup (or time) values.

Example input files are included in the ${SCALE}/regression/input
directory:

-  polaris.6.3.atrium9x9.inp and polaris.6.3.atrium10x10.inp –
   prototypic ATRIUM models;

-  polaris.6.3.blade1.inp and polaris.6.3.blade2.inp – control <BLADE>
   examples;

-  polaris.6.3.ge7x7.inp through polaris.6.3.ge10x10.inp – prototypic GE
   models;

-  polaris.6.3.svea100.inp and polaris.6.3.svea64.inp – prototypic SVEA
   models; and

-  polarisHistory.inp: history example.

.. _3-2-3:

Batson Iii's avatar
Batson Iii committed
358
359
360
361
362
363
364
365
Setup
-----

The cards in this section generally appear at the beginning of an input
file. Note that the manual is organized with each card starting a new
page. This is especially convenient when printing a few cards across
different sections.

Batson Iii's avatar
Batson Iii committed
366
.. _3-2-3-1:
Batson Iii's avatar
Batson Iii committed
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402

title – case title lines
~~~~~~~~~~~~~~~~~~~~~~~~

**title** Line\ :sub:`1` Line\ :sub:`2` … Line\ :sub:`i` …
Line\ :sub:`N`

+----------------+----------+----------+-----------------------------+-----------------+
| **param**      | **type** | **name** | **details**                 | **default**     |
+----------------+----------+----------+-----------------------------+-----------------+
| Line\ :sub:`i` | *String* | line     | used in output file headers | "DEFAULT TITLE" |
+----------------+----------+----------+-----------------------------+-----------------+

Examples:

::

  title "Westinghouse 15x15"

  title "Westinghouse 15x15"
          "Condition: Hot Full Power"
          "Date: 10/18/2012"

Comments:

The **title** card gives a title to this Polaris case, which appears as
a descriptive header on the output file. The additional lines may be
used to document a subcase or to embed additional information in the
output file in an orderly way (e.g., author, date, project identifier).

The **title** card is optional.

See also:

**lib**

Batson Iii's avatar
Batson Iii committed
403
.. _3-2-3-2:
Batson Iii's avatar
Batson Iii committed
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451

library – nuclear data libraries
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

**lib** [mg=*String*]

+-------------+-------------+-------------+-------------+-------------+
| **param**   | **type**    | **name**    | **details** | **default** |
+-------------+-------------+-------------+-------------+-------------+
| mg          | *String*    | multigroup  | multigroup  | “fine_n”    |
|             |             | library     | cross       |             |
|             |             |             | section     |             |
|             |             |             | library     |             |
+-------------+-------------+-------------+-------------+-------------+

Examples:

::

  % a name of library in the DATA directory
  % use SCALE 252g ENDF/B-VII.1 library
  lib "fine_n"   % SAME AS "V7-252"

  % use SCALE 56g ENDF/B-VII.1 library
  lib mg="broad_n"   % SAME AS mg="V7-56"

  % a name of a local library in the temporary working directory
  % (useful in SAMPLER calculations)
  lib "perturbed_xs_library"

  % fully specified path
  lib "C:\scale6.2\data\scale.rev04.xn252v7.1"

Comments:

The **lib** card specifies the multigroup library location. See SCALE’s
FileNameAliases.txt file in the installation directory for up-to-date
library aliases for the fine and broad group libraries provided in
SCALE’s data directory. Only the 252-group and the 56-group cross
section libraries can be used in Polaris. Full specification of the file
path is acceptable, as in the final example shown above.

The **lib** card is optional.

See also:

**title**

Batson Iii's avatar
Batson Iii committed
452
.. _3-2-4:
Batson Iii's avatar
Batson Iii committed
453
454
455
456
457
458
459
460
461
462
463
464
465

Geometry
--------

The highest level structures in the model are named and defined with a
**geometry** card. The general outline for a geometry definition is
shown below. Two types of geometry are currently supported, *ASSM* for
pressurized water reactor (PWR) or boiling water reactor (BWR)
assemblies with fuel elements in a square-pitch, and *REFL* for an
assembly-adjacent reflector.

**geom** GNAME : GTYPE *arguments*

Batson Iii's avatar
Batson Iii committed
466

Batson Iii's avatar
Batson Iii committed
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
+-------------+--------+---------------------+--------------------------+-----------+
| *argument*  | *type* | *name*              | *details*                | *default* |
+-------------+--------+---------------------+--------------------------+-----------+
| GNAME       | *Word* | geometry name       |                          |           |
+-------------+--------+---------------------+--------------------------+-----------+
| *GTYPE*     | *-*    | geometry type       |                          |           |
+-------------+--------+---------------------+--------------------------+-----------+
|             | *ASSM* | assembly            | see **pin** & **pinmap** |           |
+-------------+--------+---------------------+--------------------------+-----------+
|             | *REFL* | reflector           | see **slab**             |           |
+-------------+--------+---------------------+--------------------------+-----------+
| *arguments* | -      | remaining arguments | depends on *GTYPE*       |           |
+-------------+--------+---------------------+--------------------------+-----------+

The control element geometry is also enumerated with types, as shown
below. To model PWR-type rod cluster control assemblies (RCCAs), the
*RODLET* element type is used in conjunction with **pin** definitions.
In future releases of Polaris, other control element types, such as
Batson Iii's avatar
Batson Iii committed
485
BWR-type control blades will be supported..
Batson Iii's avatar
Batson Iii committed
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500

**control** INAME : ETYPE *arguments*

+-------------+----------+----------------------+--------------------+-----------+
| *Argument*  | *type*   | *name*               | *details*          | *default* |
+-------------+----------+----------------------+--------------------+-----------+
| INAME       | *Word*   | control element name |                    |           |
+-------------+----------+----------------------+--------------------+-----------+
| *ETYPE*     | *-*      | control element type |                    |           |
+-------------+----------+----------------------+--------------------+-----------+
|             | *RODLET* | PWR-type RCCA        | requires PINIDs    |           |
+-------------+----------+----------------------+--------------------+-----------+
| *arguments* | -        | remaining arguments  | depends on *ETYPE* |           |
+-------------+----------+----------------------+--------------------+-----------+

Batson Iii's avatar
Batson Iii committed
501
.. _3-2-4-1:
Batson Iii's avatar
Batson Iii committed
502

Batson Iii's avatar
Batson Iii committed
503
504
eometry<ASSM> – assembly
~~~~~~~~~~~~~~~~~~~~~~~~
Batson Iii's avatar
Batson Iii committed
505

Batson Iii's avatar
Batson Iii committed
506
507
508
509
| **geom** GNAME : *ASSM*
|     npins=\ *Int*
|     ppitch=\ *Real*
|     [sym=*FULL\|SE*]
Batson Iii's avatar
Batson Iii committed
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

+-----------+----------+----------------+------------------------+-------------+
| **param** | **type** | **name**       | **details**            | **default** |
+-----------+----------+----------------+------------------------+-------------+
| GNAME     | *Word*   | assembly name  |                        |             |
+-----------+----------+----------------+------------------------+-------------+
| *GTYPE*   | *ASSM*   |                |                        |             |
+-----------+----------+----------------+------------------------+-------------+
| npins     | *Int*    | number of pins | on each side of        |             |
|           |          |                | the assembly           |             |
+-----------+----------+----------------+------------------------+-------------+
| ppitch    | Real     | pin pitch      | units: cm              |             |
+-----------+----------+----------------+------------------------+-------------+
| sym       | FULL|SE  | symmetry       | assembly symmetry      | *FULL*      |
|           |          |                | FULL: no symmetry      |             |
|           |          |                | SE: south-east quarter |             |
+-----------+----------+----------------+------------------------+-------------+

Examples:

::

  % simple pincell
  geom MyPin : ASSM 1 1.5

  % 17x17 Westinghouse with 1.26 cm pin pitch in quarter symmetry
  geom FuelNode : ASSM 17 1.26 sym=SE

Comments:

Batson Iii's avatar
Batson Iii committed
540
541
542
543
544
545
546
547
548
549
550
551
Examples:

% simple pincell

geom MyPin : ASSM 1 1.5

% 17x17 Westinghouse with 1.26 cm pin pitch in quarter symmetry

geom FuelNode : ASSM 17 1.26 sym=SE

Comments:

Batson Iii's avatar
Batson Iii committed
552
553
554
555
556
557
558
559
560
The assembly geometry describes the basic elements of an assembly. The
**pin** and **pinmap** cards are required to finalize the assembly
geometry. The **hgap** card specifies the interassembly half gap, and
the **channel** specifies the channel material for the assembly.

See also:

**pinmap**, **pin, hgap, box, channel, control**, **insert**

Batson Iii's avatar
Batson Iii committed
561
.. _3-2-4-2:
Batson Iii's avatar
Batson Iii committed
562
563
564
565

geometry<REFL> – reflector
~~~~~~~~~~~~~~~~~~~~~~~~~~

Batson Iii's avatar
Batson Iii committed
566
567
568

| **geom** GNAME : *REFL*
|          thick=\ *REAL*
Batson Iii's avatar
Batson Iii committed
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596

+-----------+----------+----------------+-------------+-------------+
| **param** | **type** | **name**       | **details** | **default** |
+-----------+----------+----------------+-------------+-------------+
| GNAME     | *Word*   | reflector name |             |             |
+-----------+----------+----------------+-------------+-------------+
| *GTYPE*   | *REFL*   |                |             |             |
+-----------+----------+----------------+-------------+-------------+
| thick     | *Real*   | thickness      | units: cm   |             |
+-----------+----------+----------------+-------------+-------------+

Examples:

::

  % defines a 20 cm reflector
  geom ReflectorNode : REFL 20.0

Comments:

The reflector geometry describes the basic elements of a simple
slab-type reflector. The **slab** card can be used to define geometric
dimensions and mesh for the reflector geometry.

See also:

**slab**

Batson Iii's avatar
Batson Iii committed
597
.. _3-2-4-3:
Batson Iii's avatar
Batson Iii committed
598

Batson Iii's avatar
Batson Iii committed
599
Channel – materials and mesh options
Batson Iii's avatar
Batson Iii committed
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

**channel** [M\ :sub:`chan` =MCLASS]

+-------------+-------------+-------------+-------------+-------------+
| **param**   | **type**    | **name**    | **details** | **default** |
+-------------+-------------+-------------+-------------+-------------+
| M\ :sub:`ch\| MCLASS      | material    | initializes | \*          |
| an`         |             | class       | materials   |             |
|             |             |             | in          |             |
|             |             |             | outermost   |             |
|             |             |             | **pin**     |             |
|             |             |             | zone        |             |
+-------------+-------------+-------------+-------------+-------------+
| \*By        |             |             |             |             |
| default,    |             |             |             |             |
| M\ :sub:`ch\|             |             |             |             |
| an`         |             |             |             |             |
| will be set |             |             |             |             |
| to COOL by  |             |             |             |             |
| “system     |             |             |             |             |
| PWR” and    |             |             |             |             |
| “system     |             |             |             |             |
| BWR.”       |             |             |             |             |
| Otherwise,  |             |             |             |             |
| M\ :sub:`ch\|             |             |             |             |
| an`         |             |             |             |             |
| is          |             |             |             |             |
| required.   |             |             |             |             |
+-------------+-------------+-------------+-------------+-------------+

Examples:

::

  % define the channel material class to be COOL
  channel COOL

Comments:

The **channel** card is used to set the default channel material class
for the outermost region of each pin, typically containing reactor
coolant. See the **material** card for a description of material
classes.

See also:

**pin, material, geometry<ASSM>**

Batson Iii's avatar
Batson Iii committed
649
.. _3-2-4-4:
Batson Iii's avatar
Batson Iii committed
650
651
652
653

hgap – half distance between assemblies
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Batson Iii's avatar
Batson Iii committed
654
655
656
657
| **hgap** [ d\ :sub:`E` d\ :sub:`N` d\ :sub:`W` d\ :sub:`S` ]
|           [: M\ :sub:`E` M\ :sub:`N` M\ :sub:`W` M\ :sub:`S` ]
|           [: nf\ :sub:`E` nf\ :sub:`N` nf\ :sub:`W` nf\ :sub:`S` ]
|           [: nd\ :sub:`E` nd\ :sub:`N` nd\ :sub:`W` nd\ :sub:`S` ]
Batson Iii's avatar
Batson Iii committed
658
659
660
661
662
663
664
665
666
667
668
669
670
671

+-------------+-------------+-------------+-------------+-------------+
| **param**   | **type**    | **name**    | **details** | **default** |
+-------------+-------------+-------------+-------------+-------------+
| d\ :sub:`i` | *Real*      | list of     | accepts 1,  | 0.0         |
|             |             | widths      | 2, or 4     |             |
|             |             | *with i*:   | values      |             |
|             |             |             |             |             |
|             |             | *E:* east   | E: all      |             |
|             |             |             | hgaps are   |             |
|             |             | *N:* north  | same        |             |
|             |             |             |             |             |
|             |             | *W:* west   | E+N:        |             |
|             |             |             | d\ :sub:`E` |             |
Batson Iii's avatar
Batson Iii committed
672
673
|             |             | *S*: south  | \ =d\ :sub: |             |
|             |             |             | `S`         |             |
Batson Iii's avatar
Batson Iii committed
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
|             |             |             | and         |             |
|             |             |             | d\ :sub:`N` |             |
|             |             |             | \ =d\       |             |
|             |             |             | :sub:`W`    |             |
|             |             |             |             |             |
|             |             |             | units: cm   |             |
+-------------+-------------+-------------+-------------+-------------+
| M\ :sub:`i` | MNAME       | list of     | requires    | \*          |
|             |             |             | same # as   |             |
|             |             | material    | d\ :sub:`i` |             |
|             |             | names       |             |             |
+-------------+-------------+-------------+-------------+-------------+
| **meshing   |             |             |             |             |
| options**   |             |             |             |             |
+-------------+-------------+-------------+-------------+-------------+
| nf\ :sub:`i\| *Int*       | list of     | requires    | 2           |
| `           |             |             | same # as   |             |
|             |             | number of   | d\ :sub:`i` |             |
|             |             | faces per   |             |             |
|             |             | pin         |             |             |
+-------------+-------------+-------------+-------------+-------------+
Batson Iii's avatar
Batson Iii committed
695
696
| nd\ :sub:`i\| *Int*       | list of     | requires    | 1           |
| `           |             |             | same # as   |             |
Batson Iii's avatar
Batson Iii committed
697
698
699
700
|             |             | number of   | d\ :sub:`i` |             |
|             |             | divisions   |             |             |
+-------------+-------------+-------------+-------------+-------------+

Batson Iii's avatar
Batson Iii committed
701
702
703
704
\*By default, **hgap** material will be set to COOL.1 by “system
PWR.” For “system BWR,” the east and south **hgap** materials will be
set to MOD.2, and the west and north **hgap** materials will be set
to MOD.1. Otherwise **hgap** material is required.
Batson Iii's avatar
Batson Iii committed
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731

Examples:

::

  % defines a 17x17 Westinghouse assembly with 1.26 cm pin pitch
  % with 0.04 cm half-gap filled with material COOL.1
  geom w17x17 : ASSM 17 1.26 sym=SE
  hgap 0.04 COOL.1

  % defines a GE 7x7 assembly with 1.88 cm pin pitch
  %   0.48 cm narrow gap on east and south edge
  %   0.95 cm wide gap on north and west edge
  %   narrow gap mesh is 3
  %   wide gap mesh is 4
  %   faces per pin is 2 for both narrow and wide gap
  geom ge7x7 : ASSM 7 1.88
  hgap 0.48 0.95 : MOD.1 MOD.1 : 2 2 : 3 4

Comments:

The **hgap** specifies the outermost geometry region in an assembly. If
a channel **box** exists, then **hgap** specifies the material and mesh
from outer channel box edge to the problem boundary. Otherwise\ **,**
**hgap** specifies the material and mesh from the edge of the fuel array
to the problem boundary. In both cases, **hgap** represents the
half-distance between adjacent assemblies for single assembly
Batson Iii's avatar
Batson Iii committed
732
calculations. Fig. 3.2.1 shows some of the hgap meshing options.
Batson Iii's avatar
Batson Iii committed
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
Referring to the south edge of the assembly, the number of faces per pin
refers to the extra cells introduced by “splitting” the pin cell
boundary, and the number of divisions refers to extra horizontal lines
dividing half gap into smaller width cells.

See also:

**pinmap**, **control**, **insert**, **geometry<ASSM>, channel, box**

.. _fig3-2-1:
.. figure:: figs/Polaris/fig1.png
  :align: center
  :width: 500

  Interassembly half gap meshing variants.

Batson Iii's avatar
Batson Iii committed
749
750
751
752
753
754
755
.. _3-2-4-5:

box – channel box geometry
~~~~~~~~~~~~~~~~~~~~~~~~~~

**box** thick=\ *Real* [rad=*Real*] [hspan=*Real*] [Mbox=MNAME]
[cothick=*Real*] [cobtm=*Real*] [cotop=*Real*]
Batson Iii's avatar
Batson Iii committed
756

Batson Iii's avatar
Batson Iii committed
757
758
759
760
761
| [: t\ :sub:`2` t\ :sub:`3` … t\ :sub:`i` … t\ :sub:`N`
| [: a\ :sub:`2` a\ :sub:`3` … a\ :sub:`i` … a\ :sub:`N`
| [: b\ :sub:`2` b\ :sub:`3` … b\ :sub:`i` … b\ :sub:`N`
| [: M\ :sub:`2` M\ :sub:`3` … M\ :sub:`i` … M\ :sub:`N`
| [: r\ :sub:`2` r\ :sub:`3` … r\ :sub:`i` … r\ :sub:`N+1` ]]]]]
Batson Iii's avatar
Batson Iii committed
762
763

+-------------+-------------+-------------+-------------+-------------+
Batson Iii's avatar
Batson Iii committed
764
| **Param**   | **type**    | **name**    | **details** | **default** |
Batson Iii's avatar
Batson Iii committed
765
+-------------+-------------+-------------+-------------+-------------+
Batson Iii's avatar
Batson Iii committed
766
767
| thick       | *Real*      | nominal     | must be >   |             |
|             |             | thickness   | 0.0         |             |
Batson Iii's avatar
Batson Iii committed
768
769
|             |             | (cm)        |             |             |
+-------------+-------------+-------------+-------------+-------------+
Batson Iii's avatar
Batson Iii committed
770
771
772
773
774
775
776
777
778
779
| rad         | *Real*      | inner       | must be ≥   | 0.0         |
|             |             | corner      | 0.0         |             |
|             |             | radius (cm) |             |             |
+-------------+-------------+-------------+-------------+-------------+
| hspan       | *Real*      | half inner  | -------See  |             |
|             |             | span (cm)   | comments--- |             |
|             |             |             | ----        |             |
+-------------+-------------+-------------+-------------+-------------+
| Mbox        | *MNAME*     | box         |             | :sub:`\*`   |
|             |             | material    |             |             |
Batson Iii's avatar
Batson Iii committed
780
+-------------+-------------+-------------+-------------+-------------+
Batson Iii's avatar
Batson Iii committed
781
782
783
784
| cothick     | *Real*      | interior    | thick >     | 0.0         |
|             |             | cutout      | cothick ≥   |             |
|             |             | region      | 0.0         |             |
|             |             | thickness   |             |             |
Batson Iii's avatar
Batson Iii committed
785
786
|             |             | (cm)        |             |             |
+-------------+-------------+-------------+-------------+-------------+
Batson Iii's avatar
Batson Iii committed
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
| cobtm       | *Real*      | distance    | hspan-rad > | 0.0         |
|             |             | from box    | cobtm ≥ 0.0 |             |
|             |             | centerline  |             |             |
|             |             | to bottom   |             |             |
|             |             | of interior |             |             |
|             |             | cutout      |             |             |
|             |             | region (cm) |             |             |
+-------------+-------------+-------------+-------------+-------------+
| cotop       | *Real*      | distance    | cobtm ≥     | cobtm       |
|             |             | from box    | cotop ≥ 0.0 |             |
|             |             | centerline  |             |             |
|             |             | to top of   |             |             |
|             |             | interior    |             |             |
|             |             | cutout      |             |             |
|             |             | region (cm) |             |             |
+-------------+-------------+-------------+-------------+-------------+
+-------------+-------------+-------------+-------------+-------------+
| **options   |             |             |             |             |
| for         |             |             |             |             |
| additional  |             |             |             |             |
| box zones** |             |             |             |             |
+-------------+-------------+-------------+-------------+-------------+
| t\ :sub:`i` | *Real*      | zone        | must be ≥ 0 |             |
Batson Iii's avatar
Batson Iii committed
810
811
812
|             |             | thickness   |             |             |
|             |             | (cm)        |             |             |
+-------------+-------------+-------------+-------------+-------------+
Batson Iii's avatar
Batson Iii committed
813
814
815
816
817
818
819
| a\ :sub:`i` | *Real*      | distance    | -----See    |             |
|             |             | from box    | comments--- |             |
|             |             | centerline  | --          |             |
|             |             | to bottom   |             |             |
|             |             | of zone     |             |             |
|             |             | cutout      |             |             |
|             |             | region (cm) |             |             |
Batson Iii's avatar
Batson Iii committed
820
+-------------+-------------+-------------+-------------+-------------+
Batson Iii's avatar
Batson Iii committed
821
822
823
824
825
826
827
828
829
830
831
832
833
834
| b\ :sub:`i` | *Real*      | distance    | -----See    |             |
|             |             | from box    | comments--- |             |
|             |             | centerline  | --          |             |
|             |             | to top of   |             |             |
|             |             | zone cutout |             |             |
|             |             | region (cm) |             |             |
+-------------+-------------+-------------+-------------+-------------+
| M\ :sub:`i` | *MNAME*     | zone        | -----See    |             |
|             |             | material    | comments--- |             |
|             |             |             | --          |             |
+-------------+-------------+-------------+-------------+-------------+
| ri          | *Real*      | zone inner  | -----See    |             |
|             |             | corner      | comments--- |             |
|             |             | radius (cm) | --          |             |
Batson Iii's avatar
Batson Iii committed
835
836
+-------------+-------------+-------------+-------------+-------------+

Batson Iii's avatar
Batson Iii committed
837
838
\*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
839
840
841
842
843

Examples:

::

Batson Iii's avatar
Batson Iii committed
844
845
  % simple
  box 0.2
Batson Iii's avatar
Batson Iii committed
846

Batson Iii's avatar
Batson Iii committed
847
848
  % rounded corner, rad 0.9
  box 0.2 0.9
Batson Iii's avatar
Batson Iii committed
849

Batson Iii's avatar
Batson Iii committed
850
851
852
853
854
855
856
857
  % rounded corner and user-defined inner span
  box 0.2 0.9 6.7

  % two zones
  box 0.2 0.9 6.7
    : 0.2
    : 4.0
    : 4.3
Batson Iii's avatar
Batson Iii committed
858
859
860

Comments:

Batson Iii's avatar
Batson Iii committed
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
The **box** specifies the channel box geometry that surrounds the
**pinmap**. The three primary dimensions of the channel box are the
thickness (thick), the inner corner radius (rad), and the half inner
span (hspan). Several additional dimensions for both **box** and
**cross** are defined with respect to the channel box center. The
channel box center is not to be confused with the lattice center: the
former is the centroid of the inner channel box square boundary and the
latter will depend on the wide and narrow gap dimensions provided on the
**hgap** card. By default, the half inner span is equal to the half pin
pitch multiplied by the number of pins on each side of the assembly (see
npins and ppitch on the **geometry<ASSM>** card). If a **cross** card is
applied, the default half inner span is increased by the half width of
the interior cross buffer region (see hwidth on the **cross** card).

Additional channel box zones can be specified on the **box** card. The
additional zones are useful for defining thick corner regions of the
channel box. Each additional zone must have a user-defined thickness
(t\ :sub:`i`, i = 2 to N). Note that the starting index begins at “2”
rather than “1” because the zone 1 thickness has already been defined by
the “thick” input field.

“Cutout regions” may be defined in which a portion of the channel box
zone is replaced by the corresponding **hgap** material along the
horizontal and vertical centerlines of the channel box. The cutout
region is defined by the distance from the channel box centerline to the
bottom additional channel box zone (a\ :sub:`i`) and the top of the
channel box zone (b\ :sub:`i`). The values of a\ :sub:`i` and b\ :sub:`i`
determine the size of trapezoidal cutout region centered along each face
of the channel box. The b\ :sub:`i` value must be greater than or equal
to the a\ :sub:`i` value. The a\ :sub:`i` value must be greater than or
equal to the previous zone’s b\ :sub:`i` value, i.e., b\ :sub:`i-1`. By
default, a\ :sub:`2` and b\ :sub:`2` are zero. If only M cutout regions
are specified for N additional zones, i.e., M < N, both a\ :sub:`i` and
b\ :sub:`i` is set to b\ :sub:`M` for i = M+1 to N.

Additional zones can also have a different inner corner radius
(r\ :sub:`2` … r\ :sub:`N`). The outer corner radius of the last zone may
also be specified (r\ :sub:`N+1`). By default, r\ :sub:`2` is zero if rad
is zero. If rad is greater than zero, the default value of r\ :sub:`2`
is rad+thick. Similar rules apply for determining the default corner
radii for additional zones if they are omitted in the input
specification.

Additional zones can also have a different material (M\ :sub:`i`). By
default, M\ :sub:`2` is M\ :sub:`box`. If additional materials are
omitted in the input, the default value of M\ :sub:`i` is M\ :sub:`i-1`
for i = 3 to N.

The spatial mesh along each face of the channel box will be determined
by the nf values specified on the hgap card.

The four examples listed above are displayed in :numref:`fig3-2-2`. For
additional examples, see the polaris.6.3 regression input files
described at the beginning of :ref:`3-2-2`.

See also:
Batson Iii's avatar
Batson Iii committed
917

Batson Iii's avatar
Batson Iii committed
918
**geometry<ASSM>, hgap, cross**
Batson Iii's avatar
Batson Iii committed
919
920
921
922
923
924

.. _fig3-2-2:
.. figure:: figs/Polaris/fig2.png
  :align: center
  :width: 500

Batson Iii's avatar
Batson Iii committed
925
  Box card examples.
Batson Iii's avatar
Batson Iii committed
926

Batson Iii's avatar
Batson Iii committed
927
.. _3-2-4-6:
Batson Iii's avatar
Batson Iii committed
928

Batson Iii's avatar
Batson Iii committed
929
930
pin – pincell comprised of nested geometry zones of variable shape
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Batson Iii's avatar
Batson Iii committed
931

Batson Iii's avatar
Batson Iii committed
932
933
934
935
| **pin** PINID [size=*Real*]
|           : 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`]
|           [: S\ :sub:`1` S\ :sub:`2` … S\ :sub:`i` … S\ :sub:`N`]
Batson Iii's avatar
Batson Iii committed
936
937


Batson Iii's avatar
Batson Iii committed
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
+-------------+-------------+-------------+-------------+-------------+
| **param**   | **type**    | **name**    | **details** | **default** |
+-------------+-------------+-------------+-------------+-------------+
| PINID       | *Word*\ \|\ | pin         |             |             |
|             | *Int*       | identifier  |             |             |
+-------------+-------------+-------------+-------------+-------------+
| size        | *Real*      | pin size    | must be ≥   | 1.0         |
|             |             | multiplicat | 1.0         |             |
|             |             | ion         |             |             |
|             |             | factor      |             |             |
+-------------+-------------+-------------+-------------+-------------+
| r\ :sub:`i` | *Real*      | zone        | r\ :sub:`1` |             |
|             |             | interior    | must be >   |             |
|             |             | radius (cm) | 0.          |             |
|             |             |             | Additional  |             |
|             |             |             | zones must  |             |
|             |             |             | be >        |             |
|             |             |             | r\ :sub:`i-\|             |
|             |             |             | 1`          |             |
+-------------+-------------+-------------+-------------+-------------+
| M\ :sub:`i` | *MNAME*     | zone        | .1 added if |             |
|             |             | material    | given       |             |
|             |             |             | MCLASS,     |             |
|             |             |             | e.g.,       |             |
|             |             |             | FUELFUEL.1  |             |
+-------------+-------------+-------------+-------------+-------------+
| M\ :sub:`ou\| *MNAME*     | outermost   | .1 added if | \*          |
| t`          |             | zone        | given       |             |
|             |             | material    | MCLASS      |             |
+-------------+-------------+-------------+-------------+-------------+
| S\ :sub:`i` |             | CIR or SQR  | circular    | CIR         |
|             |             | or SQR(X)   | zone or     |             |
|             |             |             | square zone | X=0.0       |
|             |             |             | with        |             |
|             |             |             | optional    |             |
|             |             |             | corner      |             |
|             |             |             | radius, X ≥ |             |
|             |             |             | 0.0         |             |
+-------------+-------------+-------------+-------------+-------------+

\*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
982
983
984
985
986
987

Examples:

::

  %standard fuel pin
Batson Iii's avatar
Batson Iii committed
988
  pin 1 : 0.4096 0.418 0.475 : FUEL.1 GAP.1 CLAD.1
Batson Iii's avatar
Batson Iii committed
989

Batson Iii's avatar
Batson Iii committed
990
991
  %2x2 water rod
  pin W 2.0 : 1.6   1.7 : MOD.1 TUBE.1
Batson Iii's avatar
Batson Iii committed
992

Batson Iii's avatar
Batson Iii committed
993
994
  %3x3 square water box (ATRIUM)
  pin W 3.0 : 1.68 1.75 : MOD.1 TUBE.1 : SQR SQR
Batson Iii's avatar
Batson Iii committed
995

Batson Iii's avatar
Batson Iii committed
996
997
  %noninteger size water rod (GE9x9)
  pin W 1.76 : 1.16 1.259 : MOD.1 TUBE.1 COOL.2
Batson Iii's avatar
Batson Iii committed
998
999
1000
1001

Comments:

The **pin** card is one of the basic building blocks of the assembly
Batson Iii's avatar
Batson Iii committed
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
model. **pin** and **slab** are the only geometry components 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 **pin** geometry is constructed from the inside out, using either
circle zones (defined by the radius) or square zones (defined by the
half-width, and optional corner radius). Different examples of pin
geometries are displayed in :numref:`fig3-2-3`. All meshing options for the
**pin** are provided through the **mesh** card.

If the pin size is an integer value, the pin consumes a size×size
subarray in the **pinmap** (e.g. 1×1, 2×2, 3×3, etc). If the pin size is
noninteger, the pin consumes a *ceil*\ (size)×*ceil*\ (size) subarray in
the **pinmap**. *ceil(x)* represents the ceiling function to round the
value of x to the nearest integer greater than or equal to x. For size
equal to 1.3, each instance of the pin will consume a 2×2 subarray in
the **pinmap**. Each instance of a noninteger-sized pin must share a
location with another instance of a noninteger-sized pin, but not
necessarily the same pin. The shared location must be set to “_” in the
**pinmap**. The identification of the shared location is necessary to
determine the center of each pin. The pin center is at a distance of
size*half pitch*sqrt(2) from the opposite corner of the shared location,
along the diagonal of the pin boundary. An example of an integer-sized
pins is displayed in :numref:`fig3-2-3`. An example of noninteger-sized pins is
displayed in :numref:`fig3-2-4`.
Batson Iii's avatar
Batson Iii committed
1028

Batson Iii's avatar
Batson Iii committed
1029
1030
1031
1032
.. _fig3-2-3:
.. figure:: figs/Polaris/fig3.png
  :align: center
  :width: 500
Batson Iii's avatar
Batson Iii committed
1033

Batson Iii's avatar
Batson Iii committed
1034
  Pin examples with different shape geometries
Batson Iii's avatar
Batson Iii committed
1035
1036
1037
1038

.. _fig3-2-4:
.. figure:: figs/Polaris/fig4.png
  :align: center
Batson Iii's avatar
Batson Iii committed
1039
1040
1041
1042
1043
1044
  :width: 500

  Pin examples with noninteger pin size.

For additional examples, see the polaris.6.3 regression input files
described at the beginning of :ref:`3-2-2`
Batson Iii's avatar
Batson Iii committed
1045

Batson Iii's avatar
Batson Iii committed
1046
1047
1048
See also:

slab, pinmap, channel, mesh
Batson Iii's avatar
Batson Iii committed
1049

Batson Iii's avatar
Batson Iii committed
1050
.. _3-2-4-7:
Batson Iii's avatar
Batson Iii committed
1051
1052
1053
1054

pinmap – pin layout
~~~~~~~~~~~~~~~~~~~

Batson Iii's avatar
Batson Iii committed
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
| **pinmap** PINID\ :sub:`1`
|       PINID\ :sub:`2` …
|       PINID\ :sub:`i` … PINID\ :sub:`N`

+-------------+-------------+-------------+-------------+-------------+
| **param**   | **type**    | **name**    | **details** | **default** |
+-------------+-------------+-------------+-------------+-------------+
| PINID\      | *Word*\ \|\ | list of     | supports    |             |
| :sub:`i`    | *Int*       |             | full,       |             |
|             |             | pin         | quarter, or |             |
|             |             | identifiers | octant      |             |
|             |             |             | symmetry    |             |
|             |             |             |             |             |
|             |             |             | quarter:    |             |
|             |             |             | assumes     |             |
|             |             |             | southeast   |             |
|             |             |             | (SE)        |             |
|             |             |             |             |             |
|             |             |             | octant:     |             |
|             |             |             | assumes     |             |
|             |             |             | south-by-so |             |
|             |             |             | utheast     |             |
|             |             |             | (SSE)       |             |
+-------------+-------------+-------------+-------------+-------------+
Batson Iii's avatar
Batson Iii committed
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145

Examples:

::

  %Westinghouse 17x17 pinmap in octant symmetry
  pinmap
    2
    1 1
    1 1 1
    3 1 1 3
    1 1 1 1 1
    1 1 1 1 1 3
    3 1 1 3 1 1 1
    1 1 1 1 1 1 1 1
    1 1 1 1 1 1 1 1 1

  %Westinghouse 17x17 pinmap in quarter symmetry
  pinmap
    2 1 1 3 1 1 3 1 1
    1 1 1 1 1 1 1 1 1
    1 1 1 1 1 1 1 1 1
    3 1 1 3 1 1 3 1 1
    1 1 1 1 1 1 1 1 1
    1 1 1 1 1 3 1 1 1
    3 1 1 3 1 1 1 1 1
    1 1 1 1 1 1 1 1 1
    1 1 1 1 1 1 1 1 1

  %Westinghouse 17x17 pinmap in full
  pinmap
    1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
    1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
    1 1 1 1 1 3 1 1 3 1 1 3 1 1 1 1 1
    1 1 1 3 1 1 1 1 1 1 1 1 1 3 1 1 1
    1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
    1 1 3 1 1 3 1 1 3 1 1 3 1 1 3 1 1
    1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
    1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
    1 1 3 1 1 3 1 1 2 1 1 3 1 1 3 1 1
    1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
    1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
    1 1 3 1 1 3 1 1 3 1 1 3 1 1 3 1 1
    1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
    1 1 1 3 1 1 1 1 1 1 1 1 1 3 1 1 1
    1 1 1 1 1 3 1 1 3 1 1 3 1 1 1 1 1
    1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
    1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1

  %large central 2x2 water rod in 6x6 assembly
  %pinmap must show adjacent Ws
  pin W size=2 : 0.8
               : COOL
  pinmap
  F F F F F F
  F F F F F F
  F F W W F F
  F F W W F F
  F F F F F F
  F F F F F F

Comments:

The **pinmap** card defines the layout of pin cells in the assembly. The
symmetry is determined by the number of pin identifiers given on the
card and must not be more general than the symmetry option given on the
assembly **geometry** card (i.e., do not define a full pin map for a
Batson Iii's avatar
Batson Iii committed
1146
*sym*\ =SE assembly model). If the **pin** has a large size specifier,
Batson Iii's avatar
Batson Iii committed
1147
1148
1149
1150
1151
*size>1*, then the pinmap must reflect that with those pins occurring in
blocks of size × size.

See also:

Batson Iii's avatar
Batson Iii committed
1152
**pin, control, insert**
Batson Iii's avatar
Batson Iii committed
1153

Batson Iii's avatar
Batson Iii committed
1154
.. _3-2-4-8:
Batson Iii's avatar
Batson Iii committed
1155
1156
1157
1158

control<RODLET> – RCCA-type layout
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Batson Iii's avatar
Batson Iii committed
1159
1160
1161
1162
| **control** INAME: *RODLET*
|           PINID\ :sub:`1`
|           PINID\ :sub:`2` …
|           PINID\ :sub:`i` … PINID\ :sub:`N`
Batson Iii's avatar
Batson Iii committed
1163
1164
1165
1166
1167
1168
1169
1170
1171

+-------------+-------------+-------------+-------------+-------------+
| **param**   | **type**    | **name**    | **details** | **default** |
+-------------+-------------+-------------+-------------+-------------+
| INAME       | *Word*      | insert name |             |             |
+-------------+-------------+-------------+-------------+-------------+
| *ETYPE*     | *RODLET*    |             |             |             |
+-------------+-------------+-------------+-------------+-------------+
| PINID\      | *Word*\ \|\ | list of     | same format |             |
Batson Iii's avatar
Batson Iii committed
1172
| :sub:`i`    | *Int*       |             | as          |             |
Batson Iii's avatar
Batson Iii committed
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
|             |             | pin         | **pinmap**  |             |
|             |             | identifiers |             |             |
|             |             |             | "_"         |             |
|             |             |             | indicate    |             |
|             |             |             | empty       |             |
|             |             |             | locations   |             |
+-------------+-------------+-------------+-------------+-------------+

Examples:

::

  % B4C control rods
  mat GAS.1  : FILLGAS
  mat CLAD.1 : ZIRC4
  mat MOD.1  : LW
  mat TUBE.1 : SS304
  mat CNTL.1 : B4C

  pin B : 0.214  0.231 0.241 0.427 0.437 0.484 0.561 0.602
        : GAS    TUBE  GAS   CNTL  GAS   TUBE  MOD   CLAD

  control  BankD  : RODLET
    _
    _ _
    _ _ _
    B _ _ B
    _ _ _ _ _
    _ _ _ _ _ B
    B _ _ B _ _ _
    _ _ _ _ _ _ _ _
    _ _ _ _ _ _ _ _ _

Comments:

Note that control elements and inserts share the INAME identifiers, so
an insert and a control element cannot have the same name. Different
control rod banks may be included in a single input file using more than
one **control** card with unique INAMEs. The main difference between the
inserts defined by **control** element and **insert** cards is that by
default, *control element materials are not depleted,* whereas *insert
materials are* *depleted*.

The outer dimensions of the tube must be included in the **pin** card
that is inserted.

See also:

**pinmap**, **control**, **insert, state**

Batson Iii's avatar
Batson Iii committed
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
.. _3-2-4-9:

control<BLADE> – BWR control blade
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

| **control** INAME : BLADE hwgthck=\ *Real* sththck=\ *Real* cslnth=\ *Real*
| [sthmat=*MNAME*] [csmat=*MNAME*] [hcsthck=*Real*] [wgcrv=*Real*]
| : ID\ :sub:`1` ID\ :sub:`2` … ID\ :sub:`N`
| : L\ :sub:`1` L\ :sub:`2` ... L\ :sub:`N`
| [: N\ :sub:`1` N\ :sub:`2` … N\ :sub:`N`]

+-------------+-------------+-------------+-------------+-------------+
| **param**   | **type**    | **Name**    | **details** | **default** |
+-------------+-------------+-------------+-------------+-------------+
| hwgthck     | *Real*      | half blade  | must be >0  |             |
|             |             | wing        |             |             |
|             |             | thickness   |             |             |
|             |             | (cm)        |             |             |
+-------------+-------------+-------------+-------------+-------------+
| sththck     | *Real*      | sheath      | must be >=0 |             |
|             |             | thickness   |             |             |
|             |             | (cm)        |             |             |
+-------------+-------------+-------------+-------------+-------------+
| cslnth      | *Real*      | central     | must be     |             |
|             |             | support     | >=hwgthck   |             |
|             |             | length (cm) |             |             |
+-------------+-------------+-------------+-------------+-------------+
| sthmat      | *MNAME*     | sheath      |             | STRUCT.1\   |
|             |             | material    |             | :sup:`\*`   |
+-------------+-------------+-------------+-------------+-------------+
| csmat       | *MNAME*     | central     |             | STRUCT.1\   |
|             |             | support     |             | :sup:`\*`   |
|             |             | material    |             |             |
+-------------+-------------+-------------+-------------+-------------+
| hcsthck     | *Real*      | half        | must be >0  | hwgthck     |
|             |             | central     |             |             |
|             |             | support     |             |             |
|             |             | thickness   |             |             |
|             |             | (cm)        |             |             |
+-------------+-------------+-------------+-------------+-------------+
| wgcrv       | *Real*      | wing tip    | must be >=0 | 0           |
|             |             | radius (cm) |             |             |
+-------------+-------------+-------------+-------------+-------------+
| ID\ :sub:`i`| *Word|Int*  | pin or slab | ------- See |             |
| `           |             | identifier  | comments    |             |
|             |             |             | ----------  |             |
+-------------+-------------+-------------+-------------+-------------+
| L\ :sub:`i` | *Real*      | length of   | ------- See |             |
|             |             | section i   | comments    |             |
|             |             |             | ----------  |             |
+-------------+-------------+-------------+-------------+-------------+
| N\ :sub:`i` | *Real*      | # of pins   | ------- See |             |
|             |             | or slabs in | comments    |             |
|             |             | section i   | ----------  |             |
+-------------+-------------+-------------+-------------+-------------+
| \*Default   |             |             |             |             |
| values for  |             |             |             |             |
| shtmat and  |             |             |             |             |
| csmat are   |             |             |             |             |
| set by      |             |             |             |             |
| “system     |             |             |             |             |
| BWR.” If    |             |             |             |             |
| “system     |             |             |             |             |
| BWR” is     |             |             |             |             |
| omitted,    |             |             |             |             |
| the         |             |             |             |             |
| material    |             |             |             |             |
| definitions |             |             |             |             |
| are         |             |             |             |             |
| required.   |             |             |             |             |
+-------------+-------------+-------------+-------------+-------------+

Comments:

The **blade** card defines a control blade geometry. The control blade
identifier (INAME) can be used to insert the control blade using
**state** or **add** statements to define histories or branches
respectively. INAME=yes inserts the control blade into the northwest
corner of the lattice.

The control blade geometry is described with reference to the blade wing
on the northern edge of the lattice in :numref:`fig3-2-5`. The blade wing on the
west edge is a reflection of the northern edge wing along the diagonal
symmetry line that extends from the northwest corner to the southeast
corner of the lattice.

The two primary regions of the blade are the central support and the
active blade wing. The central support has a length (cslnth), half width
(hcsthck), and material (csmat). The central support half width is the
vertical distance between the north face of the lattice and the south
boundary of the central support. The central support length is the
horizontal distance from west face of the lattice to the east boundary
of the central support. See :numref:`fig3-2-5` for details.

The active portion of the blade wing begins at the east boundary of the
central support. The active portion has a half width (hwgthck), sheath
thickness (sththck), sheath material (sthmat), and wing tip radius
(wgcrv). The half width is the vertical distance between the north face
of the lattice and the southern boundary of the active blade wing,
including the sheath. The wing tip radius can be any nonnegative number.
If the radius is zero, the wing tip is a straight edge.

The active portion of the blade wing is subdivided into sections. Each
section has a length (L\ :sub:`i`), and identifier associated with a pin
or slab (ID\ :sub:`i`), and the number of pins or slabs for each section
(N\ :sub:`i`). The list of section lengths and section identifiers is
required and must have consistent list lengths. The final list for
number of pin/slabs per section is optional. If omitted, the default
number of pin or slabs per section is one.

.. _fig3-2-5:
.. figure:: figs/Polaris/fig5.png
  :align: center
  :width: 500

  Control blade example.

If there is only one **pin** in a pin section, the pin is placed in the
section center. If there are multiple pins, the first and last pin are
positioned flush against the west and east section boundary
respectively, and the interior pins are uniformly spaced between the two
edge pins. Slab sections are built from the blade centerline in the
vertical direction towards the interior sheath boundary. Each slab zone
has width equal to the section length. Each slab zone can be subdivided
in the vertical direction by the zone nx parameter on the **slab** card.
The slab zone can be subdivided in the horizontal direction by the
product of the zone ny parameter and the number of slabs in the blade
wing section.

The blade is further subdivided by the **mesh** nf/nd settings for
**hgap** material in the north and west bypass region, typically MOD.1
for models that include **system BWR.**

See also: pin, slab, mesh, system BWR

.. _3-2-4-10:
Batson Iii's avatar
Batson Iii committed
1359
1360
1361
1362

insert – insert layout
~~~~~~~~~~~~~~~~~~~~~~

Batson Iii's avatar
Batson Iii committed
1363
1364
1365
1366
| **insert** INAME:
|     PINID\ :sub:`1`
|     PINID\ :sub:`2` …
|     PINID\ :sub:`i` … PINID\ :sub:`N`
Batson Iii's avatar
Batson Iii committed
1367
1368
1369
1370
1371
1372
1373

+-------------+-------------+-------------+-------------+-------------+
| **param**   | **type**    | **name**    | **details** | **default** |
+-------------+-------------+-------------+-------------+-------------+
| INAME       | *Word*      | insert name |             |             |
+-------------+-------------+-------------+-------------+-------------+
| PINID\      | *Word*\ \|\ | list of     | same format |             |
Batson Iii's avatar
Batson Iii committed
1374
| :sub:`i`    | *Int*       |             | as          |             |
Batson Iii's avatar
Batson Iii committed
1375
1376
1377
1378
1379
1380
1381
1382
|             |             | pin         | **pinmap**  |             |
|             |             | identifiers |             |             |
|             |             |             | "_"         |             |
|             |             |             | indicate    |             |
|             |             |             | empty       |             |
|             |             |             | locations   |             |
+-------------+-------------+-------------+-------------+-------------+

Batson Iii's avatar
Batson Iii committed
1383

Batson Iii's avatar
Batson Iii committed
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
Examples:

::

  %pyrex inserts
  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

  insert PyrexInserts :
    _
    _ _
    _ _ _
    P _ _ P
    _ _ _ _ _
    _ _ _ _ _ P
    P _ _ P _ _ _
    _ _ _ _ _ _ _ _
    _ _ _ _ _ _ _ _ _

Batson Iii's avatar
Batson Iii committed
1403

Batson Iii's avatar
Batson Iii committed
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
Comments:

The **insert** card defines a set of pins to be used to model inserts
such as WABA. When the **insert** is “in,” the insert pins replace
*overlapping regions* of the pins defined on the assembly **pinmap**. An
underscore (_) is used to indicate locations without inserts. See the
notes on the **control<RODLET>** card for additional guidelines.

See also:

**pinmap**, **control**, **insert**

Batson Iii's avatar
Batson Iii committed
1416
.. _3-2-4-11:
Batson Iii's avatar
Batson Iii committed
1417
1418
1419
1420
1421

slab – slab geometry
~~~~~~~~~~~~~~~~~~~~

| **slab** [SLABID]
Batson Iii's avatar
Batson Iii committed
1422
1423
1424
1425
|       : t\ :sub:`1` t\ :sub:`2` … t\ :sub:`i` … t\ :sub:`N`
|       : M\ :sub:`1` M\ :sub:`2` … M\ :sub:`i` … M\ :sub:`N`
|       [: nx\ :sub:`1` nx\ :sub:`2` … nx\ :sub:`i` … nx\ :sub:`N` ]
|       [: ny\ :sub:`1` ny\ :sub:`2` … ny\ :sub:`i` … ny\ :sub:`N` ]
Batson Iii's avatar
Batson Iii committed
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485

+-------------+-------------+-------------+-------------+-------------+
| **param**   | **type**    | **name**    | **details** | **default** |
+-------------+-------------+-------------+-------------+-------------+
| SLABID      | *Word*      | slab        |             | reflector   |
|             |             | geometry    |             | GNAME       |
|             |             | identifier  |             |             |
+-------------+-------------+-------------+-------------+-------------+
| t\ :sub:`i` | *Real*      | list of     | units: cm   |             |
|             |             |             |             |             |
|             |             | slab        |             |             |
|             |             | thicknesses |             |             |
+-------------+-------------+-------------+-------------+-------------+
| M\ :sub:`i` | MNAME       | list of     |             |             |
|             |             |             |             |             |
|             |             | material    |             |             |
|             |             | names       |             |             |
+-------------+-------------+-------------+-------------+-------------+
| **meshing   |             |             |             |             |
| options**   |             |             |             |             |
+-------------+-------------+-------------+-------------+-------------+
| nx\ :sub:`i`| *Int*       | list of     |             | 1           |
|             |             |             |             |             |
|             |             | number of   |             |             |
|             |             | x-divisions |             |             |
+-------------+-------------+-------------+-------------+-------------+
| ny\ :sub:`i`| *Int*       | list of     |             | 1           |
|             |             |             |             |             |
|             |             | number of   |             |             |
|             |             | y-divisions |             |             |
+-------------+-------------+-------------+-------------+-------------+

Examples:

::

  % a reflector definition
  % 2.22 cm of baffle
  % 15 cm of moderator
  geom ReflectorNode : REFL 17.22
    slab 2.22 15 : BAFFLE.1  MOD.1

Comments:

The **slab** card may be used to define three things: (1) the materials
and thicknesses of a reflector initiated on a **geometry** card, (2)
slabs in a control blade, and (3) spacer grids. If the first argument
identifier is *not present,* then the first purpose of describing the
various material thicknesses in a reflector is assumed. The meshing
options allow each material slab to be spatially refined in x and y,
increasing the number of cells in the transport problem. The meshing
option for the number of x divisions creates the equivalent of
additional “sub-slabs” in each user-defined slab thickness. The
y-divisions create additional cells vertically. The default of one
y-division corresponds to the entire assembly.

See also:

**geometry<REFL>**

Batson Iii's avatar
Batson Iii committed
1486
.. _3-2-4-12:
Batson Iii's avatar
Batson Iii committed
1487

Batson Iii's avatar
Batson Iii committed
1488
1489
cross – cross geometry
~~~~~~~~~~~~~~~~~~~~~~
Batson Iii's avatar
Batson Iii committed
1490

Batson Iii's avatar
Batson Iii committed
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
| **cross** hwidth=\ *Real* lthick=\ *Real*
| [Mcross=*MNAME*] [row=*Int*] [Min=*MNAME*] [ld=*Int*] [Mout=*MNAME*]
| [ : x\ :sub:`1` x\ :sub:`2` … x\ :sub:`N`]
| [ : y\ :sub:`1` y\ :sub:`2` … y\ :sub:`N`]
| [ : yin\ :sub:`1` yin\ :sub:`2` … yin\ :sub:`N`]
| [ : nx\ :sub:`1` nx\ :sub:`2` … nx\ :sub:`N-1`]
| [ : ny\ :sub:`1` ny\ :sub:`2` … ny\ :sub:`N-1`]

.. list-table::
  :align: center

  * - .. image:: figs/Polaris/tab3-2-4-12.svg
        :width: 500

Comments:

The cross card performs two tasks. First, it subdivides the pinmap into
four subarrays, optionally adding a horizontal and vertical gap between
the subarrays. The row parameter is uses to subdivide the pinmap. If the
pinmap is 10×10 and row=5, each of the four subarrays is 5×5. If the
pinmap is 10×10 and row=4, the northwest subarray is 4×4, the northeast
subarray is 4×6, the southwest subarray is 6×4, and the southeast
subarray is 6×6. The hwidth parameter controls the half-spacing of the
horizontal and vertical gap in between the subarrays. The hwidth
parameter must be ≥ 0.0 and if hwidth is > 0.0, the gap is filled with
material M\ :sub:`out` (default is COOL.2 with system BWR).

The second task is the insertion of the cross structure into the lattice
geometry. The process is described with reference to the example in Fig.
:numref:`fig3-2-6`. In the example, the **pinmap** is 9×9 and row=3, hwidth=1.5, and
hspan=10.5. The top left plot contains the four following lines:

1. the line in the center of the vertical cross gap,

2. the line in the center of the horizontal cross gap,

3. the diagonal line from the northwest (NW) channel box corner to the
   southeast (SE) corner, and

4. the diagonal line, perpendicular to line 3, passing through the
   intersection of line 1 and line 2.

These four lines intersect and form 8 separate regions, i.e., octants,
within the channel box interior. The intersection point, i.e., cross
center, is not necessarily equal to the box center as shown in this
example. In the top left plot, the red triangle represents the WNW
octant. In the bottom left plot, the red triangle represents the SSE
octant.

::

  % Centered cruciform flow channel
  cross   0.625  0.08  5
  : -6.86 -6.53 -5.20 -4.81 -3.77 -3.39 -2.05  0.0  2.05  3.39  3.77  4.81  5.20  6.53  6.86
  : 0.625  0.0   0.0   0.24  0.24  0.0   0.0  2.05  0.0   0.0   0.24  0.24  0.0   0.0   0.625

.. _fig3-2-6:
.. figure:: figs/Polaris/fig6.png
  :align: center
  :width: 500

  Construction of the BWR cross geometry (full example shown later).

The cross structure is defined be a series of vertices (x\ :sub:`i`,
y\ :sub:`i`). Shown as yellow points in the top left plot, the **cross**
vertices are defined based on an origin displayed as the red point,
which is the intersection of the inner west edge of the channel box and
the horizontal line in that passes through the cross center.

The top plots demonstrate how Polaris inserts a section of the cross
into the WNW octant. In the top left plot, the blue polygon is
constructed based on the first two vertices defined on the **cross**
card: (0.0,1.0) and (4.0,0.5). The intersection of the blue polygon and
red polygon is inserted into the lattice and filled with cross interior
material (M\ :sub:`in`). The liner is then inserted **above** the blue
polygon, padded by the liner thickness (lthick), and clipped by WNW red
polygon if needed.

Similarly, the bottom plots demonstrate insertion into the SSE octant.
For SSE insertions, the origin and the **cross** vertices are rotated 90
degrees about the cross center. The blue polygon is constructed from the
second and third vertices on the **cross** card: (4.0,0.5) and (11,0.5).
The intersection of the blue polygon and red polygon is inserted into
the lattice and filled with cross interior material (M\ :sub:`in`). The
liner is then inserted **above** the blue polygon, padded by the liner
thickness (lthick), and clipped by SSE red polygon if needed.

For each consecutive set of **cross** vertices, Polaris inserts a
polygonal region into each of the 8 octants. The **cross** vertices are
entered in the input as an x-values list followed by a y-values list of
the same length. The coordinate system of the x- and y- lists is
displayed in the top left plot of Fig. 3.2.6. The coordinate system is
transformed based on the following rules for each octant:

-  WNW, ENE: no transform,

-  NNW, SSW: reflected across the diagonal line from NW to SE channel
   box corners,

-  NNE, SSE: rotated 90 degrees about the cross center, and

-  ESE, WSW: reflected across the line in the center of the horizontal
   cross gap.

The cross liner is inserted above the cross vertex values. The liner has
a uniform thickness (lthick) and uniform material (M\ :sub:`cross`). The
uniform liner thickness is constructed with a miter joint at each cross
vertex as shown in the following diagram:

.. image:: figs/Polaris/diag1.png
  :align: center
  :width: 300

After the set of y-values on the **cross** card, an optional list of
interior y-values can be specified. The length of the interior y-values
list must be equal to the length of the x- and y- lists. The optional
interior y-values list is used to split the polygons into two material
regions as shown in the following diagram:

.. image:: figs/Polaris/diag2.png
  :align: center
  :width: 300

For the left-hand polygon, y\ :sub:`in,i-1` is the same as
y\ :sub:`i-1`, but y\ :sub:`in,i` is less than y\ :sub:`i`. In this
scenario, the trapezoid region is filled with M\ :sub:`in`, and the
triangular region is filled with M\ :sub:`cross`. Similarly for the
right-hand polygon, the lower trapezoid is filled with M\ :sub:`in` and
the upper trapezoid is filled with M\ :sub:`cross`. Note that the
uniform liner above the y-values is not shown for simplicity.

The interior y-list values can be specified in one of two ways. First, a
positive value may be entered that is greater than or equal to zero and
less than or equal to the corresponding y-value. Second, a negative
value may be entered that represents the relative distance of the
interior y-value below the corresponding y-value. Note the Polaris input
processor interprets “-0” different than “0”. “-0” implies that the
internal y-value is the same as the y-value. “0” implies that the
internal y-value is zero. If the interior y-list is omitted, the default
for all internal y-values is “-0”, i.e., the polygon regions defined are
completely filled with M\ :sub:`in`.

In addition to the interior y-values list, two additional lists can be
used to refine the spatial mesh in the x- and y- directions. The list of
nx- and ny- values subdivide the polygon regions along the x- and y-
directions respectively. Both lists must have one less entry than the
x-, y-, and y\ :sub:`in`- lists. If omitted, the default values for both
the nx- and ny- lists are 1, i.e., no additional spatial refinement is
applied to the polygon regions. For refinement in the y-direction, only
the M\ :sub:`in` material is refined. The following diagram shows nx=2
refinement for the left polygon and ny=2 refinement for the right
polygon:

.. image:: figs/Polaris/diag3.png
  :align: center
  :width: 300

The full cross example from :numref:`fig3-2-6` is displayed in the top left plot
of :numref:`fig3-2-7`. The bottom plot shows a centered cross structure with a
diamond water box and empty pins surrounding the water box.

For additional examples, see the polaris.6.3 regression input files
described at the beginning of :ref:`3-2-2`.

See also:

**box, system BWR, pinmap**

.. _fig3-2-7:
.. figure:: figs/Polaris/fig7.png
  :align: center
  :width: 500

  Additional cross examples.

.. _3-2-4-13:

dxmap and dymap – pin-by-pin displacement maps
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

| **dxmap** d\ :sub:`1` d\ :sub:`2` … d\ :sub:`i` … d\ :sub:`N`
| **dymap** d\ :sub:`1` d\ :sub:`2` … d\ :sub:`i` … d\ :sub:`N`

+-----------------+-----------------+-----------------+-----------------+
| **param**       | **type**        | **details**     | **default**     |
+-----------------+-----------------+-----------------+-----------------+
| d\ :sub:`i`     | *Real*          | pin center      | 0.0             |
|                 |                 | displacement    |                 |
|                 |                 | value in the x  |                 |
|                 |                 | or y direction  |                 |
|                 |                 | (cm)            |                 |
+-----------------+-----------------+-----------------+-----------------+

Comments:

The dxmap and dymap cards displace pins from their natural position in
the geometry (see comments for the pin card). If displacement maps are
required, both the dxmap and dymap must be specified in the input and
they must have the same length. However, the length of the displacement
maps does not have to equal of length of the pinmap if the displacement
maps have reduced symmetry. For integer-sized pins greater than 1, the
displacement value should be entered in the northwest corner element of
the size×size subarray. For noninteger-sized pins, the displacement
value should be in the corner element opposite of shared corner
location. Note the following symmetry restrictions for the displacement
maps:

-  dy\ :sub:`i` value must be zero on a horizontal symmetry line for an
   odd×odd pinmap,

-  dx\ :sub:`i` value must be zero on a vertical symmetry line for an
   odd×odd pinmap, and

-  dx\ :sub:`i` must equal dy\ :sub:`i` for an element on a diagonal
   symmetry line.

Examples:

::

  dxmap
    0.0  0.0  0.0  0.0  0.0
    0.0  0.2  0.0  0.0 -0.2
    0.0  0.0  0.0  0.0  0.0
    0.0  0.0  0.0  0.0  0.0
    0.0  0.0  0.0  0.0  0.0
  dymap
    0.0  0.0  0.0  0.0  0.0
    0.0  0.0  0.0  0.0  0.0
    0.0  0.0  0.0  0.0  0.0
    0.0  0.2  0.0  0.0  0.0
    0.0  0.0  0.0 -0.1  0.0

.. image:: figs/Polaris/diag4.png
  :align: center
  :width: 400

See also:

**pinmap**

.. _3-2-4-14:
Batson Iii's avatar
Batson Iii committed
1733

Batson Iii's avatar
Batson Iii committed
1734
1735
1736
1737
1738
1739
mesh – advanced material dependent meshing options
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

| **mesh** MSPEC : [m=*Real*] [nx=*Int*] [ny=*Int*] [mx=*Real*] [my=*Real*]
|         [nr=*Int*] [ns=*Int*] [mr=*Real*] [ms=*Real*]
|         [nf=*Int*] [nd=*Int*] [mf=*Real*] [md=*Real*]
Batson Iii's avatar
Batson Iii committed
1740
1741

+-------------+-------------+-------------+-------------+-------------+
Batson Iii's avatar
Batson Iii committed
1742
| **param**   | **type**    | **name**    | **details** | **default** |
Batson Iii's avatar
Batson Iii committed
1743
+-------------+-------------+-------------+-------------+-------------+
Batson Iii's avatar
Batson Iii committed
1744
1745
| MSPEC       | *MCLASS     | material    |             |             |
|             | \|MNAME*    | identifier  |             |             |
Batson Iii's avatar
Batson Iii committed
1746
+-------------+-------------+-------------+-------------+-------------+
Batson Iii's avatar
Batson Iii committed
1747
1748
| nx          | *Int*       | # of x      | must be >0  | MeshNumX\   |
|             |             | divisions   |             | :sup:`\*`   |
Batson Iii's avatar
Batson Iii committed
1749
+-------------+-------------+-------------+-------------+-------------+
Batson Iii's avatar
Batson Iii committed
1750
1751
| ny          | *Int*       | # of y      | must be >0  | MeshNumY\   |
|             |             | divisions   |             | :sup:`\*`   |
Batson Iii's avatar
Batson Iii committed
1752
+-------------+-------------+-------------+-------------+-------------+
Batson Iii's avatar
Batson Iii committed
1753
1754
| nr          | *Int*       | # of radial | must be >0  | MeshNumRing |
|             |             | rings       |             | s\ :sup:`\*`|
Batson Iii's avatar
Batson Iii committed
1755
1756
|             |             |             |             |             |
+-------------+-------------+-------------+-------------+-------------+
Batson Iii's avatar
Batson Iii committed
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
| ns          | *Int*       | # of radial | must be     | MeshNumSect |
|             |             | sectors     | nonzero     | ors\        |
|             |             |             |             | :sup:`\*`   |
+-------------+-------------+-------------+-------------+-------------+
| nf          | *Int*       | # of        | must be >0  | 2\          |
|             |             | faces/pin   |             | :sup:`\*\*` |
+-------------+-------------+-------------+-------------+-------------+
| nd          | *Int*       | # of gap    | must be >0  | 1           |
|             |             | divisions   |             |             |
+-------------+-------------+-------------+-------------+-------------+
| **meshing   |             |             |             |             |
| multiplier\ |             |             |             |             |
| s**         |             |             |             |             |
+-------------+-------------+-------------+-------------+-------------+
| m           | *Real*      | global      | must be >0  | 1.0         |
|             |             | multiplier  |             |             |
+-------------+-------------+-------------+-------------+-------------+
| mx          | *Real*      | x divisions | must be >0  | 1.0         |
+-------------+-------------+-------------+-------------+-------------+
| my          | *Real*      | y divisions | must be >0  | 1.0         |
+-------------+-------------+-------------+-------------+-------------+
| mr          | *Real*      | radial      | must be >0  | 1.0         |
|             |             | rings       |             |             |
+-------------+-------------+-------------+-------------+-------------+
| ms          | *Real*      | radial      | must be >0  | 1.0         |
|             |             | sectors     |             |             |
+-------------+-------------+-------------+-------------+-------------+
| mf          | *Real*      | faces/pin   | must be >0  | 1.0         |
+-------------+-------------+-------------+-------------+-------------+
| md          | *Real*      | gap         | must be >0  | 1.0         |
|             |             | divisions   |             |             |
+-------------+-------------+-------------+-------------+-------------+

:sup:`\*` The global mesh default values are set on the **option <GEOM>**
card using the parameter name in the table above.

:sup:`\*\*` Default number of faces per pin is 1. Default is 2 for **system
BWR** or **system PWR.**


Examples:

::

  mesh COOL : nr=3 ns=4 nx=2 ny=2 %coolant mesh: 3 ring, 4 sectors, 2 in x and y

  mesh MOD.1 : nf=2 nd=4          %mesh used for wide gap (MOD.1): nf=2 nd=4

  mesh MOD.2 : nf=2 nd=3          %mesh used for narrow gap (MOD.2): nf=2 nd=3

  mesh FUEL : mr=2.0              %double the fuel radial mesh

  mesh FUEL.2 : m=3.0             %triple all mesh values for FUEL.2

  mesh CLAD : ms=0.5              %coarsen the clad sector mesh by a factor of 1/2.

Comments:

Polaris supports three different mesh types: 1) cylindrical mesh for CIR
shapes in the pin card, 2) Cartesian mesh for SQR shapes in the pin
card, and 3) a special Cartesian mesh for the region external to the
pinmap region. As shown in the examples above, the mesh card is used to
define, refine, or coarsen the mesh parameters for one or more of the
mesh types associated with a given material class or material name. The
default values for mesh parameters are defined through the option<GEOM>
card and the system card. The default values on the option<GEOM> card
are nr=1, ns=1, nx=1, ny=1, nf=1, nd=1, and MeshMult=1.0. The “MeshMult”
multiplier from the option<GEOM> is a global mesh multiplier applied in
conjunction with any material-specific multiplier (see option<GEOM>
example for details). If system BWR or system PWR is applied, new
default values include nf=2, ns=8, and nr=2 (only for the channel
material class). If the final mesh value is noninteger, Polaris rounds
down to determine the applied value.

See also: pin, system, option<GEOM>

.. _3-2-4-15:

detector – insert a detector geometry
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

| **det DNAME : PINID at=PINID|GNAME loc=String**
|           **: rx=RSPEC fmat=MNAME rmat=MNAME**

.. list-table::
  :align: center

  * - .. image:: figs/Polaris/tab3-2-4-15.svg
        :width: 600

Examples:

::

  % declare detector materials
  mat DET.2 : SS304 %transmitter
  mat DET.3 : Al 2.7 %active material matrix (with u235 dopant not modeled)

  % declare detector geometry
  % - transmitting wire
  % - active material
  % - sheath
  pin PD : 0.03 0.04 0.0787
  : DET.2 DET.3 TUBE.1

  %u235 for reaction rate material
  mat DET.1 : detu 1e-5
     comp detu : WT u235=99.9 u238=0.1

  % place detector D1, described by pin PD
  % into instrument tube pin.IT, at the center
  % with signal proportional to fission in material DET.1
  % but with flux inside material matrix DET.3
  det D1 : pin.PD at=pin.IT loc=CENTER
  : R(n,FIS) fmat=DET.3 rmat=DET.1

  % enable detector output in XFile16
  opt FG DetectorEdit=D1

Comments:

The **detector** card is not intended to produce arbitrary reaction
rates, but model a simple, discrete detector inserted into the geometry.
The first line of detector input defines the detector and where it
should be placed. The second line of input defines the “signal” the
detector produces. The most complex piece of the input is the reaction
specificer (RSPEC) which denotes the units (reaction rate or energy
rate), incident particle, and type of reaction. For example, neutron
absorption rate would be denoted “R(n,ABS)” and gamma energy deposition
rate “E(g,CAP)”.

The detector signal is collected for the material specified as the flux
material, “fmat”. In some cases, e.g. PWR fission detector modeling, it
is desirable to model a reaction rate for fissile material that does not
exist, e.g. a U-235 fission rate in an gaseous fission chamber that does
not have trace amounts of U-235 present in the composition definition.
The optional reaction material, “rmat”, gives a way to specify this type
of scenario. In this case the “fmat” would be a physical material in the
model like the detector fill gas whereas the “rmat” would be another
material (not present in the model) with composition and temperature
defined appropriately.

.. _3-2-5:

Materials
---------

A material contains two main types of information: (1) the
*composition*, or distribution of nuclides, and (2) *the properties*
which include basic (required) properties like density and temperature,
and as well as (optional) properties like soluble poison content, void,
or grid spacer smearing. The composition is defined by a **composition**
card. The basic specification for a material is shown below.

[**mat** MNAME : CNAME [dens=*Real*] [temp=*Real*] [: *properties*]]

+-------------+-------------+-------------+-------------+-------------+
| **argument**| **type**    | **name**    | **details** | **default** |
Batson Iii's avatar
Batson Iii committed
1915
|             |             |             |             |             |
Batson Iii's avatar
Batson Iii committed
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
+-------------+-------------+-------------+-------------+-------------+
| MNAME=      | *Word*.\ *I\| material    | used to     |             |
|             | nt*         | name        | reference   |             |
| MCLASS.MSUB |             |             | this        |             |
|             |             |             | material    |             |
+-------------+-------------+-------------+-------------+-------------+
| CNAME       | Word        | composition |             |             |
|             |             | name        |             |             |
+-------------+-------------+-------------+-------------+-------------+
| dens        | Real        | density     | basic       | composition |
|             |             |             | property    | reference   |
|             |             |             |             | density, if |
|             |             |             | units:      | defined     |
|             |             |             | g/cm\       |             |
|             |             |             | :sup:`3`    |             |
+-------------+-------------+-------------+-------------+-------------+
| temp        | Real        | temperature | basic       | 293         |
|             |             |             | property    |             |
|             |             |             |             |             |
|             |             |             | units: K    |             |
+-------------+-------------+-------------+-------------+-------------+
| *properties*| Word=Value  | properties  | extra       | no extra    |
|             |             |             | properties  | properties  |
|             |             |             | are defined |             |
|             |             |             | with        |             |
|             |             |             | **property**|             |
Batson Iii's avatar
Batson Iii committed
1942
|             |             |             | cards       |             |
Batson Iii's avatar
Batson Iii committed
1943
|             |             |             |             |             |
Batson Iii's avatar
Batson Iii committed
1944
1945
+-------------+-------------+-------------+-------------+-------------+

Batson Iii's avatar
Batson Iii committed
1946

Batson Iii's avatar
Batson Iii committed
1947
1948
1949
1950
1951
1952
A material name has two parts, the material class, or MCLASS, and a
member identifier, or MSUB. For example, FUEL.2 has an MCLASS=FUEL and
an MSUB=2. **All properties are defined by MCLASS.** The composition
referenced by CNAME is created with a **composition** card, as shown
below.

Batson Iii's avatar
Batson Iii committed
1953
[**comp** CNAME : CTYPE *arguments*]
Batson Iii's avatar
Batson Iii committed
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970

+-------------+-------------+-------------+-------------+-------------+
| *argument*  | *type*      | *Name*      | *details*   | *default*   |
+-------------+-------------+-------------+-------------+-------------+
| CNAME       | *Word*      | composition | used to     |             |
|             |             | name        | reference   |             |
|             |             |             | this        |             |
|             |             |             | composition |             |
|             |             |             | later in    |             |
|             |             |             | materials   |             |
|             |             |             | and         |             |
|             |             |             | property    |             |
|             |             |             | definitions |             |
+-------------+-------------+-------------+-------------+-------------+
| *CTYPE*     | *-*         | composition |             |             |
|             |             | type        |             |             |
+-------------+-------------+-------------+-------------+-------------+
Batson Iii's avatar
Batson Iii committed
1971
|             | General     |             |             |             |
Batson Iii's avatar
Batson Iii committed
1972
|             | Composition |             |             |             |
Batson Iii's avatar
Batson Iii committed
1973
|             | Constructors|             |             |             |
Batson Iii's avatar
Batson Iii committed
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
+-------------+-------------+-------------+-------------+-------------+
|             | *NUM*       | number      |             |             |
|             |             | fraction    |             |             |
+-------------+-------------+-------------+-------------+-------------+
|             | *WT*        | weight      |             |             |
|             |             | fraction    |             |             |
+-------------+-------------+-------------+-------------+-------------+
|             | *FORM*      | Formula     |             |             |
+-------------+-------------+-------------+-------------+-------------+
|             | *CONC*      | Concentrati\|             |             |
|             |             | ons         |             |             |
+-------------+-------------+-------------+-------------+-------------+
Batson Iii's avatar
Batson Iii committed
1986
|             | Reactor     |             |             |             |
Batson Iii's avatar
Batson Iii committed
1987
|             | Composition |             |             |             |
Batson Iii's avatar
Batson Iii committed
1988
|             | Constructors|             |             |             |
Batson Iii's avatar
Batson Iii committed
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
+-------------+-------------+-------------+-------------+-------------+
|             | *LW*        | borated     |             |             |
|             |             | light water |             |             |
+-------------+-------------+-------------+-------------+-------------+
|             | *UOX*       | uranium     |             |             |
|             |             | oxide fuel  |             |             |
+-------------+-------------+-------------+-------------+-------------+
| *arguments* | -           | remaining   | depends on  |             |
|             |             | arguments   | *CTYPE*     |             |
+-------------+-------------+-------------+-------------+-------------+

Additional properties are defined with the **property** card, which
defines the property PNAME for a material class MCLASS\ **.** The
property type, *PTYPE,* determines the remaining arguments.

**prop** PNAME MCLASS : PTYPE *arguments*

+-------------+-------------+-------------+-------------+-------------+
| **argument**| **type**    | **name**    | **details** | **default** |
|             |             |             |             |             |
+-------------+-------------+-------------+-------------+-------------+
| PNAME       | *Word*      | property    | used to     |             |
|             |             | name        | reference   |             |
|             |             |             | this        |             |
|             |             |             | property    |             |
+-------------+-------------+-------------+-------------+-------------+
| *PTYPE*     | *PTYPE*     | property    |             |             |
|             |             | type        |             |             |
+-------------+-------------+-------------+-------------+-------------+
|             | *SOLP*      | soluble     | used to     |             |
|             |             | poison      | define      |             |
|             |             |             | soluble     |             |
|             |             |             | boron       |             |
|             |             |             | content     |             |
+-------------+-------------+-------------+-------------+-------------+
| *arguments* | -           | remaining   | depends on  |             |
|             |             | arguments   | *PTYPE*     |             |
+-------------+-------------+-------------+-------------+-------------+

Batson Iii's avatar
Batson Iii committed
2028
.. _3-2-5-1:
Batson Iii's avatar
Batson Iii committed
2029

Batson Iii's avatar
Batson Iii committed
2030
material - material
Batson Iii's avatar
Batson Iii committed
2031
2032
~~~~~~~~~~~~~~~~~~~

Batson Iii's avatar
Batson Iii committed
2033

Batson Iii's avatar
Batson Iii committed
2034
| **mat** MNAME : CNAME [dens=*Real*] [temp=*Real*]
Batson Iii's avatar
Batson Iii committed
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
| [: p\ :sub:`1`\ =val\ :sub:`1` p\ :sub:`2`\ =val\ :sub:`2` … p\ :sub:`i`\ =val\ :sub:`i` … p\ :sub:`N`\ =val\ :sub:`N`]

+-------------+-------------+-------------+-------------+-------------+
| **argument**| **type**    | **name**    | **details** | **default** |
|             |             |             |             |             |
+-------------+-------------+-------------+-------------+-------------+
| MNAME       | *Word*.\ *I\| material    | uses form   |             |
|             | nt*         | name        | MCLASS.MSUB |             |
+-------------+-------------+-------------+-------------+-------------+
| CNAME       | *Word*      | composition |             |             |
|             |             | name        |             |             |
+-------------+-------------+-------------+-------------+-------------+
| dens        | *Real*      | density     | *basic      | composition |
|             |             |             | property*   |             |
|             |             |             |             | reference   |
|             |             |             | units:      | density     |
|             |             |             | g/cm\       |             |
|             |             |             | :sup:`3`    |             |
+-------------+-------------+-------------+-------------+-------------+
| temp        | *Real*      | temperature | *basic      | 293         |
|             |             |             | property*   |             |
|             |             |             |             |             |
|             |             |             | units: K    |             |
+-------------+-------------+-------------+-------------+-------------+
| p\ :sub:`i` | PNAME=Value | properties  | *additional | 0           |
| \ =val\     |             |             | properties* |             |
| :sub:`i`    |             |             |             |             |
+-------------+-------------+-------------+-------------+-------------+
Batson Iii's avatar
Batson Iii committed
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093

Examples:

::

  % define a gas gap material
  mat GAP.1  : FILLGAS

  % define a 3.5% enriched fuel material
  comp uox_e350 : UOX 3.5
  mat FUEL.1 : uox_e350 dens=10.257 temp=900

  % define a cladding material
  mat CLAD.1 : ZIRC4

  % define a guide tube material
  mat TUBE.1 : SS304

  % define a control rod material
  mat CNTL.1 : AIC

Comments:

Material properties may be set on either a **material** card or on a
**state** card. If a temperature is specified rather than a density, the
“temp=” key must be used to skip over the density argument.

See also:

**state, composition, property**

Batson Iii's avatar
Batson Iii committed
2094
.. _3-2-5-2:
Batson Iii's avatar
Batson Iii committed
2095
2096
2097
2098

composition<NUM|WT> – general atom/wt fraction
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Batson Iii's avatar
Batson Iii committed
2099
| **comp** CNAME: *NUM|WT*
Batson Iii's avatar
Batson Iii committed
2100
2101
2102
2103
| [scale= *PCT\|ABS|PPM*]
| [norm=*Bool*]
| [refdens=*Real*]
| [structure=*Function]*
Batson Iii's avatar
Batson Iii committed
2104
2105
2106
2107
2108
2109
2110
| id\ :sub:`1`\ =val\ :sub:`1` id\ :sub:`2`\ =val\ :sub:`2` … id\ :sub:`i`\ =val\ :sub:`i` … id\ :sub:`N`\ =val\ :sub:`N`

.. list-table::
  :align: center

  * - .. image:: figs/Polaris/tab3-2-5-2.svg
        :width: 600
Batson Iii's avatar
Batson Iii committed
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148

Examples:

::

  % create a plutonium vector and then plutonium oxide
  comp puvec : WT scale=PCT
    Pu238=1.2
    Pu239=63.3
    Pu240=21.0
    Pu241=8.6
    Pu242=5.9
  comp puox : FORM puvec=1 O=2

  % create an 85/10/5 Ag/In/Cd composition
  % using 10% In, 5% Cd,
  % and filling the remainder up to 100% with Ag
  comp aic : WT In=10 Cd=5 Ag=-100

Comments:

IDs in weight or number fraction-based compositions may be any of the
following:

-  nuclide IDs (*Int*), e.g., 92235,

-  nuclide names (*Word*), e.g., U235 or u235,

-  element Z numbers (*Int*), e.g., 92,

-  element names (*Word*), e.g., U or u, or

-  other composition names (CNAME).

See also:

**composition<FORM>**

Batson Iii's avatar
Batson Iii committed
2149
.. _3-2-5-3:
Batson Iii's avatar
Batson Iii committed
2150
2151
2152
2153

composition<FORM> – general chemical formula
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Batson Iii's avatar
Batson Iii committed
2154
2155
2156
2157
| **comp** CNAME : *FORM*
|         [refdens=*Real*]
|         [structure=*Function*]
|         id\ :sub:`1`\ =val\ :sub:`1` id\ :sub:`2`\ =val\ :sub:`2` … id\ :sub:`i`\ =val\ :sub:`i` … id\ :sub:`N`\ =val\ :sub:`N`
Batson Iii's avatar
Batson Iii committed
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176

+-------------+-------------+-------------+-------------+-------------+
| **param**   | **Type**    | **name**    | **details** | **default** |
+-------------+-------------+-------------+-------------+-------------+
| CNAME       | *Word*      | composition |             |             |
|             |             | name        |             |             |
+-------------+-------------+-------------+-------------+-------------+
| CTYPE       | *FORM*      | formula     |             |             |
+-------------+-------------+-------------+-------------+-------------+
| refdens     | *Real*      | reference   | default     | \*          |
|             |             | density     | density for |             |
|             |             |             | materials   |             |
|             |             |             | using this  |             |
|             |             |             | composition |             |
|             |             |             |             |             |
|             |             |             | units:      |             |
|             |             |             | g/cm\       |             |
|             |             |             | :sup:`3`    |             |
+-------------+-------------+-------------+-------------+-------------+
Batson Iii's avatar
Batson Iii committed
2177
2178
2179
| structure   | *Function*  | structure   | see         | FREE        |
|             |             |             | Structure   |             |
|             |             |             | names       |             |
Batson Iii's avatar
Batson Iii committed
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
+-------------+-------------+-------------+-------------+-------------+
| id\ :sub:`i`| Word|Int=\  | id/value    | see         |             |
| \ =val\     | *Real*      | pairs       | acceptable  |             |
| :sub:`i`    |             |             | id forms    |             |
|             |             |             | below       |             |
|             |             |             |             |             |
|             |             |             | values in   |             |
|             |             |             | atoms per   |             |
|             |             |             | molecule    |             |
|             |             |             |             |             |
|             |             |             | (e.g.,      |             |
Batson Iii's avatar
Batson Iii committed
2191
2192
|             |             |             | H\ :sub:`2`\|             |
|             |             |             | O           |             |
Batson Iii's avatar
Batson Iii committed
2193
2194
2195
2196
2197
|             |             |             | is given as |             |
|             |             |             | "H"=2       |             |
|             |             |             | "O"=1)      |             |
+-------------+-------------+-------------+-------------+-------------+

Batson Iii's avatar
Batson Iii committed
2198
2199
2200
\*The density property must be defined for each *material* either
explicitly on the material card itself or implicitly through the
“reference density” of the material’s composition.
Batson Iii's avatar
Batson Iii committed
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234

Examples:

::

  % define Gd2O3 using element names
  % (using elements implies natural abundances used in isotopics)
  comp gd2o3 : FORM Gd=2 O=3

  % define Gd2O3 using 100% Gd 155
  comp gd2o3 : FORM Gd155=2 O=3

  % define D2O using nuclide IDs and element names
  comp d2o : FORM 1002=2 8000=3
  comp d2o : FORM H2=2 O=3

Comments:

IDs in formula-based composition may be any of the following:

-  nuclide IDs (*Int*), e.g., 92235,

-  nuclide names (*Word*), e.g., U235 or u235,

-  element Z numbers (*Int*), e.g., 92,

-  element names (*Word*), e.g., U or u, or

-  other composition names (CNAME).

See also:

**composition<NUM|WT>, composition<CONC>**

Batson Iii's avatar
Batson Iii committed
2235
.. _3-2-5-4:
Batson Iii's avatar
Batson Iii committed
2236
2237
2238
2239

composition<CONC> – general number density
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Batson Iii's avatar
Batson Iii committed
2240

Batson Iii's avatar
Batson Iii committed
2241
| **comp** CNAME : *CONC* [refdens=Real]
Batson Iii's avatar
Batson Iii committed
2242
| id\ :sub:`1`\ =val\ :sub:`1` id\ :sub:`2`\ =val\ :sub:`2` … id\ :sub:`i`\ =val\ :sub:`i` … id\ :sub:`N`\ =val\ :sub:`N`
Batson Iii's avatar
Batson Iii committed
2243

Batson Iii's avatar
Batson Iii committed
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
+-------------+-------------+-------------+-------------+-------------+
| **param**   | **type**    | **name**    | **details** | **default** |
+-------------+-------------+-------------+-------------+-------------+
| CNAME       | *Word*      | composition |             |             |
|             |             | name        |             |             |
+-------------+-------------+-------------+-------------+-------------+
| *CTYPE*     | *CONC*      | concentrati\|             |             |
|             |             | on          |             |             |
+-------------+-------------+-------------+-------------+-------------+
| refdens     | Real        | reference   | default     | \*\*        |
|             |             | density     | density for |             |
|             |             |             | materials   |             |
|             |             |             | using this  |             |
|             |             |             | composition |             |
|             |             |             |             |             |
|             |             |             | units:      |             |
|             |             |             | g/cm\       |             |
|             |             |             | :sup:`3`    |             |
+-------------+-------------+-------------+-------------+-------------+
| id\ :sub:`i`| Int=Real    | id/value    | see         |             |
| \ =val\     |             | pairs       | acceptable  |             |
| :sub:`i`    |             |             | id forms    |             |
|             |             |             | below       |             |
|             |             |             |             |             |
|             |             |             | **note:     |             |
|             |             |             | cannot use  |             |
|             |             |             | other       |             |
|             |             |             | CNAMEs for  |             |
|             |             |             | IDs in CONC |             |
|             |             |             | input**     |             |
|             |             |             |             |             |
|             |             |             | units:      |             |
|             |             |             | #/barn-cm   |             |
+-------------+-------------+-------------+-------------+-------------+


\**A reference density is automatically calculated from
concentrations input. If specified, it will simply scale up
concentrations linearly.
Batson Iii's avatar
Batson Iii committed
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332

::

  % pyrex composition
  comp pyrex_e125 : CONC
           5010=9.63266E-04
           5011=3.90172E-03
           8016=4.67761E-02
          14028=1.81980E-02
          14029=9.24474E-04
          14030=6.10133E-04

  % fuel composition
  comp uox_e310_gd180 : CONC
          92234=3.18096E-06
          92235=3.90500E-04
          92236=1.79300E-06
          92238=2.10299E-02
          64152=3.35960E-06
          64154=3.66190E-05
          64155=2.48606E-04
          64156=3.43849E-04
          64157=2.62884E-04
          64158=4.17255E-04
          64160=3.67198E-04
           8016=4.53705E-02

  % wet annular burnable absorber (WABA) composition
  comp waba : CONC
           5010=2.98553E-03
           5011=1.21192E-02
           6000=3.77001E-03
           8016=5.85563E-02
          13027=3.90223E-02

Comments:

IDs in concentration-based composition may be any of the following:

-  nuclide IDs (*Int*), e.g., 92235;

-  nuclide names (*Word*), e.g., U235 or u235;

-  element Z numbers (*Int*), e.g., 92;

-  element names (*Word*), e.g., U or u; and

-  SCALE-specific Nuclide IDs (*Int*), e.g., 3006000 (Only available for
   comp(CONC) card).

Batson Iii's avatar
Batson Iii committed
2333
2334
2335
.. Not working, 92 not working, 92000 works , not working (comments on bullets 2-5, respectively)


Batson Iii's avatar
Batson Iii committed
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
Other composition names (CNAME) *cannot* be used in a concentration
definition. To easily ensure consistency of input when comparing codes,
the composition input should be used in the concentrations described
here. In all other cases, the other **composition** constructors are
recommended because they are much simpler and easier to use.

See also:

**composition<FORM>, composition<NUM|WT>**

Batson Iii's avatar
Batson Iii committed
2346
.. _3-2-5-5:
Batson Iii's avatar
Batson Iii committed
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368

composition<LW> – borated light water
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

**comp** CNAME : *LW* [borppm=*Real*] [refdens=*Real*]

+-------------+-------------+-------------+-------------+-------------+
| **param**   | **Type**    | **name**    | **details** | **default** |
+-------------+-------------+-------------+-------------+-------------+
| CNAME       | *Word*      | composition |             |             |
|             |             | name        |             |             |
+-------------+-------------+-------------+-------------+-------------+
| *CTYPE*     | *LW*        | light water |             |             |
+-------------+-------------+-------------+-------------+-------------+
| borppm      | *Real*      | boron       | parts per   | \*          |
|             |             |             | million by  |             |
|             |             |             | weight of   |             |
|             |             |             | natural     |             |
|             |             |             | boron (B)   |             |
|             |             |             | in          |             |
|             |             |             | light water |             |
|             |             |             | (H\ :sub:`2`|             |
Batson Iii's avatar
Batson Iii committed
2369
|             |             |             | \ O)        |             |
Batson Iii's avatar
Batson Iii committed
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
+-------------+-------------+-------------+-------------+-------------+
| refdens     | *Real*      | reference   | default     | 0.0         |
|             |             | density     | density for |             |
|             |             |             | materials   |             |
|             |             |             | using this  |             |
|             |             |             | composition |             |
|             |             |             |             |             |
|             |             |             | units:      |             |
|             |             |             | g/cm\       |             |
|             |             |             | :sup:`3`    |             |
+-------------+-------------+-------------+-------------+-------------+

Batson Iii's avatar
Batson Iii committed
2382
2383
2384
\*The density property must be defined for each *material* either
explicitly on the material card itself or implicitly through the
“reference density” of the material’s composition.
Batson Iii's avatar
Batson Iii committed
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408

Examples:

::

  % define a 600ppm boron moderator composition
  comp mod_600ppm : LW 600

  % same composition using FORM and WT
  comp mod : FORM H=2 O=1
  comp mod_600ppm : WT scale=PPM norm=yes
                    mod=1e6 B=600

Comments:

Internally, the borated light water composition is built from
**composition<FORM>** and **composition<WT>** cards assuming natural
boron. To use different boron isotopics such as depleted or enriched
boron, the more general composition cards should be used.

See also:

**composition<FORM>, composition<WT>**

Batson Iii's avatar
Batson Iii committed
2409
.. _3-2-5-6:
Batson Iii's avatar
Batson Iii committed
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461

composition<UOX> –UO\ :sub:`2` fuel
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

**comp** CNAME : UOX enr=\ *Real* [bu=*Real*] [refdens=*Real*]

+-------------+-------------+-------------+-------------+-------------+
| **param**   | **type**    | **name**    | **details** | **default** |
+-------------+-------------+-------------+-------------+-------------+
| CNAME       | *Word*      | composition |             |             |
|             |             | name        |             |             |
+-------------+-------------+-------------+-------------+-------------+
| *CTYPE*     | *UOX*       | uranium     |             |             |
|             |             | dioxide     |             |             |
+-------------+-------------+-------------+-------------+-------------+
| enr         | *Real*      | enrichment  | U-235 wt. % |             |
|             |             |             |             |             |
|             |             |             | (see        |             |
|             |             |             | **compositi\|             |
|             |             |             | on<ENRU>**  |             |
|             |             |             | for         |             |
|             |             |             | formula)    |             |
+-------------+-------------+-------------+-------------+-------------+
| bu          | *Real*      | burnup      | only        | 0\*         |
|             |             |             | available   |             |
|             |             |             | for         |             |
|             |             |             | 0≤bu≤100    |             |
|             |             |             |             |             |
|             |             |             | units:      |             |
|             |             |             | GWd/MTU     |             |
+-------------+-------------+-------------+-------------+-------------+
| refdens     | *Real*      | reference   | default     | \*\*        |
|             |             | density     | density for |             |
|             |             |             | materials   |             |
|             |             |             | using this  |             |
|             |             |             | composition |             |
|             |             |             |             |             |