Difference between revisions of "Upcoming:Datamesh Dataifc"

From Serpent Wiki
Jump to: navigation, search
(Created page with "=== datamesh (general mesh definition)<span id="datamesh"></span> === '''datamesh''' ''NAME'' ''TYPE'' ''LC'' ''MIN<sub>1</sub>'' ''MAX<sub>1</sub>'' ''N<sub>1</sub>'' ''MIN...")
 
(dataifc (general interface definition))
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
=== datamesh (general mesh definition)<span id="datamesh"></span> ===
 
=== datamesh (general mesh definition)<span id="datamesh"></span> ===
  
  '''datamesh''' ''NAME'' ''TYPE'' ''LC'' ''MIN<sub>1</sub>'' ''MAX<sub>1</sub>'' ''N<sub>1</sub>'' ''MIN<sub>2</sub>'' ''MAX<sub>2</sub>'' ''N<sub>2</sub>'' ''MIN<sub>3</sub>'' ''MAX<sub>3</sub>'' ''N<sub>3</sub>''
+
  '''datamesh''' ''NAME'' ''TYPE'' ''LC'' ''PARAMETERS''
  
 
Defines a structured mesh that can be used in many places. If the same mesh is used for multiple purposes, the mesh search typically has to be done only once.
 
Defines a structured mesh that can be used in many places. If the same mesh is used for multiple purposes, the mesh search typically has to be done only once.
Line 10: Line 10:
 
|-
 
|-
 
| <tt>''TYPE''</tt>
 
| <tt>''TYPE''</tt>
| : mesh type (1 - cartesian, 2 - cylindrical, 3 - spherical, 4 - hexx, 5 - hexy)
+
| : mesh type (1 - Cartesian, 2 - cylindrical, 4 - hexx, 5 - hexy, 6 - irregularly spaced Cartesian,  7 - irregularly spaced cylindrical, 9 - nested mesh with regular structure)
 
|-
 
|-
 
| <tt>''LC''</tt>
 
| <tt>''LC''</tt>
| : flag to use local coordinates (lowest universe) for mesh-index search instead of global (0/1/yes/no) '''will probably be moved to be the last (optional) parameter'''
+
| : flag to use local coordinates (lowest universe) for mesh-index search instead of global (0/1/yes/no)  
 
|-
 
|-
| <tt>''MIN<sub>n</sub>'' ''MAX<sub>n</sub>'' ''N<sub>n</sub>''</tt>
+
| <tt>''PARAMETERS''</tt>
| : boundaries of the mesh and number of bins in each direction
+
| : Mesh parameters dependent on the mesh type
 
|}
 
|}
  
 
<u>Notes:</u>
 
<u>Notes:</u>
*X
+
*Similar input for unstructured meshes will most likely be added at some point.
 +
 
 +
Mesh parameters for '''type 1''' (Cartesian):
 +
''NX XMIN XMAX NY YMIN YMAX NZ ZMIN ZMAX''
 +
 
 +
Mesh parameters for '''type 2''' (cylindrical):
 +
''NR RMIN RMAX NPHI''
 +
 
 +
Mesh parameters for '''types 4 and 5''' (hexx, hexy):
 +
''N1 1MIN 1MAX N2 2MIN 2MAX NZ ZMIN ZMAX''
 +
 
 +
Mesh parameters for '''type 6''' (irregularly spaced Cartesian):
 +
''NX NY NZ <NX>*XLIM <NY>*YLIM <NZ>*ZLIM
 +
 
 +
Mesh parameters for '''type 7''' (irregularly spaced cylindrical):
 +
''NR NPHI <NR>*RLIM''
 +
 
 +
Mesh parameters for '''type 9''' (nested mesh with regular structure, each mesh cell at level ''N'' contains the same mesh at level ''N+1''):
 +
''NMESH <NMESH>*NAME_OF_MESH_AT_LEVEL_I''
  
 
=== dataifc (general interface definition)<span id="datamesh"></span> ===
 
=== dataifc (general interface definition)<span id="datamesh"></span> ===
Line 33: Line 51:
 
|-
 
|-
 
| <tt>''DATAFILE''</tt>
 
| <tt>''DATAFILE''</tt>
| : path to file containing the data (one value for each mesh cell)
+
| : path to file containing the data (one value for each mesh cell). Atomic densities use the default unit 10<sup>24</sup>/cm<sup>3</sup>.
 
|-
 
|-
 
| <tt>''ZAI''</tt>
 
| <tt>''ZAI''</tt>
Line 43: Line 61:
  
 
<u>Notes:</u>
 
<u>Notes:</u>
*Input syntax will probably undergo big changes.
+
*Input syntax may undergo changes.
 
*The material must already contain the nuclide for which the atomic density is being linked.
 
*The material must already contain the nuclide for which the atomic density is being linked.
 
*If the material contains more than one instance of the nuclide (can happen with mixtures), the data will most likely not be applied properly.
 
*If the material contains more than one instance of the nuclide (can happen with mixtures), the data will most likely not be applied properly.

Latest revision as of 14:54, 8 February 2021

This page describes an upcoming feature being developed for Serpent 2, which is not yet available in the publicly distributed version.

datamesh (general mesh definition)

datamesh NAME TYPE LC PARAMETERS

Defines a structured mesh that can be used in many places. If the same mesh is used for multiple purposes, the mesh search typically has to be done only once.

NAME  : name of the mesh
TYPE  : mesh type (1 - Cartesian, 2 - cylindrical, 4 - hexx, 5 - hexy, 6 - irregularly spaced Cartesian, 7 - irregularly spaced cylindrical, 9 - nested mesh with regular structure)
LC  : flag to use local coordinates (lowest universe) for mesh-index search instead of global (0/1/yes/no)
PARAMETERS  : Mesh parameters dependent on the mesh type

Notes:

  • Similar input for unstructured meshes will most likely be added at some point.

Mesh parameters for type 1 (Cartesian):

NX XMIN XMAX NY YMIN YMAX NZ ZMIN ZMAX

Mesh parameters for type 2 (cylindrical):

NR RMIN RMAX NPHI

Mesh parameters for types 4 and 5 (hexx, hexy):

N1 1MIN 1MAX N2 2MIN 2MAX NZ ZMIN ZMAX

Mesh parameters for type 6 (irregularly spaced Cartesian):

NX NY NZ <NX>*XLIM <NY>*YLIM <NZ>*ZLIM

Mesh parameters for type 7 (irregularly spaced cylindrical):

NR NPHI <NR>*RLIM

Mesh parameters for type 9 (nested mesh with regular structure, each mesh cell at level N contains the same mesh at level N+1):

NMESH <NMESH>*NAME_OF_MESH_AT_LEVEL_I

dataifc (general interface definition)

dataifc MESHNAME DATAFILE adens ZAI MATERIAL

Defines an interface providing some data to Serpent on some mesh. The data can be updated during runtime. Currently only used for bringing in atomic densities.

MESHNAME  : name of the mesh that the data lies on
DATAFILE  : path to file containing the data (one value for each mesh cell). Atomic densities use the default unit 1024/cm3.
ZAI  : the ZAI of the nuclide for which the atomic density is supplied (e.g. 50100 for B-10)
MATERIAL  : name of the material for which to apply the atomic density

Notes:

  • Input syntax may undergo changes.
  • The material must already contain the nuclide for which the atomic density is being linked.
  • If the material contains more than one instance of the nuclide (can happen with mixtures), the data will most likely not be applied properly.
  • One should be able to supply the atomic density of ZAI to more than one material with the same interface by simply supplying a (space separated) material name list instead of a single material name. hasn't been tested
  • Will most likely not work properly with burnable materials.
  • Has only been tested with optimization mode 4, might yield strange results or crash for other optimization modes.
  • Has not been tested with multi-physics interfaces, might yield strange results or crash.