Description="Stopping criteria for the l2 norm of relative liquid velocity changes between solution checkpoints."
MinOccurs=0
MaxOccurs=1
value{
@@ -44,6 +45,7 @@ solution{
}
}
vl_linf_norm{
Description="Stopping criteria for the l:math:`\infty`-norm of relative liquid velocity changes between solution checkpoints."
MinOccurs=0
MaxOccurs=1
value{
@@ -53,6 +55,7 @@ solution{
}
}
vv_l2_norm{
Description="Stopping criteria for the l2 norm of relative vapor velocity changes between solution checkpoints."
MinOccurs=0
MaxOccurs=1
value{
@@ -62,6 +65,7 @@ solution{
}
}
vv_linf_norm{
Description="Stopping criteria for the l:math:`\infty`-norm of relative vapor velocity changes between solution checkpoints."
MinOccurs=0
MaxOccurs=1
value{
@@ -71,6 +75,7 @@ solution{
}
}
vd_l2_norm{
Description="Stopping criteria for the l:math:`\infty`-norm of relative droplet velocity changes between solution checkpoints."
MinOccurs=0
MaxOccurs=1
value{
@@ -80,6 +85,7 @@ solution{
}
}
vd_linf_norm{
Description="Stopping criteria for the l2 norm of relative coolant temperature changes between solution checkpoints."
MinOccurs=0
MaxOccurs=1
value{
@@ -89,6 +95,7 @@ solution{
}
}
Tcool_l2_norm{
Description="Stopping criteria for the l2 norm of relative coolant temperature changes between solution checkpoints."
MinOccurs=0
MaxOccurs=1
value{
@@ -98,6 +105,7 @@ solution{
}
}
Tcool_linf_norm{
Description="Stopping criteria for the l:math:`\infty`-norm of relative coolant temperature changes between solution checkpoints."
MinOccurs=0
MaxOccurs=1
value{
@@ -107,6 +115,7 @@ solution{
}
}
Tsolid_l2_norm{
Description="Stopping criteria for the l2 norm of relative solid temperature changes between solution checkpoints."
MinOccurs=0
MaxOccurs=1
value{
@@ -116,6 +125,7 @@ solution{
}
}
Tsolid_linf_norm{
Description="Stopping criteria for the l:math:`\infty`-norm of relative solid temperature changes between solution checkpoints."
MinOccurs=0
MaxOccurs=1
value{
@@ -125,6 +135,7 @@ solution{
}
}
dt_ratio{
Description="Solid-Fluid dt ratio for a steady state simulation - Feature to be implemented in a future release."
MinOccurs=0
MaxOccurs=1
value{
@@ -135,12 +146,16 @@ solution{
}
}
transient{
Description="Specify this group to model a transient solution."
MinOccurs=0
MaxOccurs=1
group{
Description="Declares a transient group within which the transient model parameters are specified."
### Appearance="Must be > zero"
MinOccurs=0
MaxOccurs=NoLimit
dtmin{
Description="The minimum (group) time step for a transient simulation."
### Units="s"
MinOccurs=0
MaxOccurs=1
@@ -154,6 +169,8 @@ solution{
}
}
dtmax{
Description="The maximum (group) time step for a transient simulation."
### Appearance="Must be > zero"
MinOccurs=0
MaxOccurs=1
value{
@@ -169,6 +186,7 @@ solution{
}
}
edits{
Description="The maximum (group) edit frequency for a transient simulation."
MinOccurs=0
MaxOccurs=1
value{
@@ -182,6 +200,7 @@ solution{
}
}
tend{
Description="The (group) end time for a transient simulation."
MinOccurs=1
MaxOccurs=1
value{
@@ -198,10 +217,12 @@ solution{
initial{
Description="Declares the initial condition block."
MinOccurs=1
MaxOccurs=1
ChildExactlyOne=[mflux, mdot]
mflux{
Description="Initial mass flux for the system."
MinOccurs=0
MaxOccurs=1
value{
@@ -211,6 +232,7 @@ initial{
}
}
mdot{
Description="Initial (total) mass flow rate for the system."
MinOccurs=0
MaxOccurs=1
value{
@@ -220,6 +242,7 @@ initial{
}
}
temp{
Description="Initial temperature for the system."
MinOccurs=1
MaxOccurs=1
value{
@@ -229,6 +252,8 @@ initial{
}
}
enth{
Description="Initial enthalpy for the system - Feature to be implemented in a future release."
### Appearance="If enthalpy is provided along with temperature, the enthalpy will apply to the liquid and temperature will be used for the solids."
MinOccurs=0
MaxOccurs=1
value{
@@ -238,6 +263,7 @@ initial{
}
}
qprime{
Description="Initial average linear heat rate for the system."
MinOccurs=0
MaxOccurs=1
value{
@@ -247,6 +273,7 @@ initial{
}
}
press{
Description="Initial fluid (static) pressure for the system."
MinOccurs=1
MaxOccurs=1
value{
@@ -259,9 +286,12 @@ initial{
ChildUniqueness="ch_geo/id/value"
ch_geo{
Description="Use to specify a reference geometry which can be referenced when defining channels."
MinOccurs=0
MaxOccurs=NoLimit
id{
Description="ID of the channel geometry object."
### Appearance="ID can be string or integer type"
MinOccurs=1
MaxOccurs=1
value{
@@ -271,6 +301,7 @@ ch_geo{
}
}
geo{
Description="Channel geometric parameters of the channel geometry object. It should be two values with the first one being nominal channel flow area and the second one being the nominal channel wetted perimeter."
MinOccurs=1
MaxOccurs=1
value{
@@ -286,9 +317,11 @@ ch_geo{
ChildExactlyOne=["ch/id/value"=1]
ChildUniqueness="ch/id/value"
ch{
Description="Defines a channel in the model. There are three different ways in which the channel geometry can be defined. The first, is by specifying each individual geometric parameter alongside their respective keyword (e.g., area, pw), the second, is by pointing to a reference channel geometric object defined in geo_ref, and the third, is by listing all the channel geometry parameters at once using the 'geo' keyword. The Channel mesh parameters can be specified individually or listed all at once under the 'mesh' keyword."
MinOccurs=1
MaxOccurs=NoLimit
id{
Description="Stopping criteria for the l:math:`\infty`-norm of relative pressure changes between solution checkpoints."
MinOccurs=1
MaxOccurs=1
value{
@@ -301,6 +334,8 @@ ch{
ChildExactlyOne=[area, geo, geo_ref]
ChildExactlyOne=[pw, geo, geo_ref]
area{
Description="Flow area of the channel."
### Units="m**2"
MinOccurs=0
MaxOccurs=1
value{
@@ -311,6 +346,7 @@ ch{
ChildExactlyOne="../pw"
}
pw{
Description="Wetted perimeter of the channel."
MinOccurs=0
MaxOccurs=1
value{
@@ -321,6 +357,7 @@ ch{
ChildExactlyOne="../area"
}
geo{
Description="A shortcut to writing 'area' and 'pw' separately. Accepts two values, which should be flow area and wetted perimeter."
MinOccurs=0
MaxOccurs=1
value{
@@ -330,6 +367,8 @@ ch{
}
}
geo_ref{
Description="ID of the channel geometry object defined in the ch_geo block."
### Appearance="ID must be defined in the ch_geo block"
MinOccurs=0
MaxOccurs=1
value{
@@ -344,6 +383,7 @@ ch{
ChildAtMostOne=[xdim, mesh]
ChildAtMostOne=[ydim, mesh]
x{
Description="Geometric center of the bounding box around the channel in the x-direction."
MinOccurs=0
MaxOccurs=1
ChildExactlyOne="../y"
@@ -356,6 +396,7 @@ ch{
}
}
y{
Description="Geometric center of the bounding box around the channel in the y-direction."
MinOccurs=0
MaxOccurs=1
ChildExactlyOne="../x"
@@ -368,6 +409,7 @@ ch{
}
}
xdim{
Description="Length of the channel bounding box in the x-direction."
MinOccurs=0
MaxOccurs=1
ChildExactlyOne="../x"
@@ -381,6 +423,7 @@ ch{
}
}
ydim{
Description="Length of the channel bounding box in the y-direction."
MinOccurs=0
MaxOccurs=1
ChildExactlyOne="../x"
@@ -394,6 +437,7 @@ ch{
}
}
mesh{
Description="A shortcut to specify the mesh parameters in the following order; x, y, xdim, and ydim"
MinOccurs=0
MaxOccurs=1
value{
@@ -403,20 +447,24 @@ ch{
}
}
bc{
Description="Specify the boundary conditions for the channel. If the BCs are not specified, the inlet bc is defined as a mass flow rate/temperature bc and the outlet bc is defined as a pressure/temperature bc, using system 'initial' conditions. The mass flow rate/enthalpy bc and pressure/enthalpy bc will implemented in a future release."
MinOccurs=0
MaxOccurs=NoLimit
ChildExactlyOne=[inlet, outlet]
inlet{
Description="Specify the boundary conditions for the channel inlet."
MinOccurs=0
MaxOccurs=1
}
outlet{
Description="Specify the boundary conditions for the channel outlet."
MinOccurs=0
MaxOccurs=1
}
# press and mdot/mflux cannot both be specified
ChildAtMostOne=[press, mdot, mflux]
mflux{
Description="Mass flux for the specified channel bc."
MinOccurs=0
MaxOccurs=1
value{
@@ -426,6 +474,7 @@ ch{
}
}
mdot{
Description="Mass flow rate for the specified bc."
MinOccurs=0
MaxOccurs=1
value{
@@ -435,6 +484,7 @@ ch{
}
}
temp{
Description="Temperature for the specified bc."
MinOccurs=0
MaxOccurs=1
value{
@@ -444,6 +494,7 @@ ch{
}
}
press{
Description="Fluid pressure for the specified bc."
MinOccurs=0
MaxOccurs=1
value{
@@ -461,9 +512,11 @@ ch{
ChildExactlyOne=["section/id/value"=1]
ChildUniqueness="section/id"
section{
Description="Declares an axial section in this model."
MinOccurs=1
MaxOccurs=NoLimit
id{
Description="Specify the ID of the section."
MinOccurs=1
MaxOccurs=1
ValType=Int
@@ -471,6 +524,8 @@ section{
ChildExactlyOne=[num_levels, dz]
ChildExactlyOne=[height, dz]
num_levels{
Description="Number of axial mesh volumes (uniform mesh) for the section."
### Appearance="Both num_levels and height must be specified as a pair or dz must be specified."
MinOccurs=0
MaxOccurs=1
ChildExactlyOne="../height"
@@ -482,6 +537,7 @@ section{
}
}
height{
Description="Height of an axial mesh volume (uniform mesh) for the section."
MinOccurs=0
MaxOccurs=1
ChildExactlyOne="../num_levels"
@@ -493,6 +549,7 @@ section{
}
}
dz{
Description="List of heights of all the axial mesh volumes for the section. Can be used to specify a non-uniform mesh."
MinOccurs = 0
MaxOccurs = 1
value{
@@ -506,9 +563,11 @@ section{
ChildUniqueness="gap/id/value"
ChildAtMostOne=["gap/id/value"=1]
gap{
Description="Declares a gap in the model."
MinOccurs=0
MaxOccurs=NoLimit
id{
Description="Specify the gap ID."
MinOccurs=1
MaxOccurs=1
value{
@@ -518,6 +577,8 @@ gap{
}
}
chconn{
Description="A pair of the connected channel IDs for the gap."
### Appearance="The channel IDs must be defined in the ch block."
MinOccurs=1
MaxOccurs=1
value{
@@ -527,6 +588,7 @@ gap{
}
}
length{
Description="The length of the gap defined as the distance between the channel centroids."
MinOccurs=1
MaxOccurs=1
value{
@@ -536,6 +598,7 @@ gap{
}
}
width{
Description="The width of the gap defined as the distance across the other direction."
MinOccurs=1
MaxOccurs=1
value{
@@ -549,9 +612,11 @@ gap{
ChildAtMostOne=["solid_geo/id/value"=1]
ChildUniqueness="solid_geo/id"
solid_geo{
Description="Specify a reference solid geometry which can be referenced when defining solids."
MinOccurs=0
MaxOccurs=NoLimit
id{
Description="Specify the ID of the reference solid geometry."
MinOccurs=1
MaxOccurs=1
value{
@@ -561,6 +626,7 @@ solid_geo{
}
}
type{
Description="Specify the type of the reference solid geometry."
MinOccurs=1
MaxOccurs=1
ValType=String
@@ -578,6 +644,7 @@ solid_geo{
}
}
dout{
Description="Outer diameter of the reference solid geometry"
MinOccurs=0
MaxOccurs=1
value{
@@ -588,6 +655,7 @@ solid_geo{
}
}
din{
Description="Inner diameter of the reference solid geometry"
MinOccurs=0
MaxOccurs=1
value{
@@ -598,6 +666,7 @@ solid_geo{
}
}
tclad{
Description="Fuel clad thickness"
MinOccurs=0
MaxOccurs=1
value{
@@ -612,9 +681,11 @@ solid_geo{
ChildAtMostOne=["solid/id"=1]
ChildUniqueness="solid/id"
solid{
Description="Declares solid objects in the model."
MinOccurs=0
MaxOccurs=NoLimit
id{
Description="Specify the ID of the solid object."
MinOccurs=1
MaxOccurs=1
value{
@@ -625,6 +696,8 @@ solid{
}
}
geo{
Description="ID of the solid reference geometry defined in the solid_geo block."
### Appearance="ID must exist in the 'solid_geo' block"
MinOccurs=1
MaxOccurs=1
value{
@@ -636,6 +709,7 @@ solid{
}
}
chconn{
Description="List of all channel IDs connected to the solid object."
MinOccurs=1
MaxOccurs=1
value{
@@ -649,6 +723,7 @@ solid{
}
}
pct{
Description="List of azimuthal percentages of all channels connected to the solid object. The list size must match the number of connected channels specified in 'chconn'."
MinOccurs=1
MaxOccurs=1
value{
@@ -660,6 +735,8 @@ solid{
}
}
axpow{
Description="ID of the axial power table (if defined)"
### Appearance="ID must exist in the 'axialpow' block"
MinOccurs=0
MaxOccurs=1
value{
@@ -675,9 +752,11 @@ solid{
ChildAtMostOne=["axialpow/id/value"=1]
ChildUniqueness="axialpow/id"
axialpow{
Description="Specify the axial power table(s) block using a list of axial locations and power factors for a steady state simulation alongside a series of time groups for a transient simulation."
MinOccurs=0
MaxOccurs=NoLimit
id{
Description="Specify the id of the axial power table."
MinOccurs=1
MaxOccurs=1
value{
@@ -687,6 +766,7 @@ axialpow{
}
}
z{
Description="Specify the list of axial locations for the axial power table."
MinOccurs=1
MaxOccurs=1
ChildAtLeastOne=["../pow", "../time"]
@@ -700,6 +780,8 @@ axialpow{
# The user may either specify z/pow if not transient, or z and a series of time groups
ChildExactlyOne=[pow, time]
pow{
Description="Specify the list of axial power factor for the axial power table for a steady state simulation."
### Appearance="The list length should match the list of axial locations."
MinOccurs=0
MaxOccurs=1
ChildExactlyOne="../z"
@@ -711,6 +793,7 @@ axialpow{
}
}
time{
Description="Specify a series of starting time groups at which the axial power factors are applied for the axial power table for a transient simulation."
MinOccurs=0
MaxOccurs=NoLimit
value{
@@ -720,6 +803,8 @@ axialpow{
MinValInc=0.0
}
pow{
Description="For a transient simulation, list the power factors for the axial power table for a given start time."
### Appearance="The list length should match the list of axial locations."
MinOccurs=1
MaxOccurs=1
value{
@@ -777,9 +862,11 @@ loss{
ChildAtMostOne=["domain/id/value"=1]
ChildUniqueness="domain/id/value"
domain{
Description="Specifies the parallel domain information using a list of channels, connected solid rods and the domain indices that own each rod."
MinOccurs=0
MaxOccurs=NoLimit
id{
Description="Specify the parallel domain ID."
MinOccurs=1
MaxOccurs=1
value{
@@ -790,6 +877,7 @@ domain{
}
}
chans{
Description="This may be a single channel or a list of channels to which the parallel domain defined in this 'domain' group will be applied."
MinOccurs=1
MaxOccurs=1
value{
@@ -800,6 +888,7 @@ domain{
}
}
solids{
Description="This may be a single solid rod or a list of solid rods to which the parallel domain defined in this 'domain' group will be applied."
MinOccurs=0
MaxOccurs=1
value{
@@ -811,6 +900,8 @@ domain{
}
}
solid_owners{
Description="This is a list of parallel domain indices which own the solid rods defined in the 'solids' group."
### Appearance="The list length must match the length of the list of the solid rods for the specified 'domain' group and the parallel domain indices must match the parallel domain IDs defined in the model."
