Difference between revisions of "Ants Cerberus input/output manual"
(→Input variables) |
(→Output variables) |
||
| Line 457: | Line 457: | ||
== Output variables == | == Output variables == | ||
| − | {| class="wikitable" | + | {|class="wikitable" style="text-align: left;" |
| − | ! | + | !Name |
| − | ! | + | !Size and type |
| + | !Availability | ||
| + | !Explanation | ||
| + | !Notes | ||
|- | |- | ||
| − | | | + | | <tt>Ants_ov_boron </tt> <span id="Ants_ov_boron "></span> |
| − | | | + | | 1*float64 |
| + | | | ||
| + | | Current global boron (ppm). | ||
| + | | | ||
|- | |- | ||
| − | | | + | | <tt>Ants_ov_convergence_criterion_boron </tt> <span id="Ants_ov_convergence_criterion_boron "></span> |
| − | | | + | | 1*float64 |
| + | | | ||
| + | | Current value for the convergence limit | ||
| + | | | ||
|- | |- | ||
| − | | | + | | <tt>Ants_ov_convergence_criterion_fission_source </tt> <span id="Ants_ov_convergence_criterion_fission_source "></span> |
| − | | | + | | 1*float64 |
| + | | | ||
| + | | Current value for the convergence limit | ||
| + | | | ||
|- | |- | ||
| − | | | + | | <tt>Ants_ov_convergence_criterion_fission_source_l2</tt> <span id="Ants_ov_convergence_criterion_fission_source_l2"></span> |
| − | | | + | | 1*float64 |
| + | | | ||
| + | | Current value for the convergence limit | ||
| + | | | ||
|- | |- | ||
| − | | | + | | <tt>Ants_ov_convergence_criterion_flux </tt> <span id="Ants_ov_convergence_criterion_flux "></span> |
| − | | | + | | 1*float64 |
| + | | | ||
| + | | Current value for the convergence limit | ||
| + | | | ||
|- | |- | ||
| − | |Ants_ov_convergence_criterion_keff | + | | <tt>Ants_ov_convergence_criterion_keff </tt> <span id="Ants_ov_convergence_criterion_keff "></span> |
| − | | | + | | 1*float64 |
| + | | | ||
| + | | Current value for the convergence limit | ||
| + | | | ||
|- | |- | ||
| − | | | + | | <tt>Ants_ov_convergence_criterion_partial_current </tt> <span id="Ants_ov_convergence_criterion_partial_current "></span> |
| − | | | + | | 1*float64 |
| + | | | ||
| + | | Current value for the convergence limit | ||
| + | | | ||
|- | |- | ||
| − | | | + | | <tt>Ants_ov_convergence_criterion_poison_density </tt> <span id="Ants_ov_convergence_criterion_poison_density "></span> |
| − | | | + | | 1*float64 |
| + | | | ||
| + | | Current value for the convergence limit | ||
| + | | | ||
|- | |- | ||
| − | | | + | | <tt>Ants_ov_convergence_criterion_power </tt> <span id="Ants_ov_convergence_criterion_power "></span> |
| − | | | + | | 1*float64 |
| + | | | ||
| + | | Current value for the convergence limit | ||
| + | | | ||
|- | |- | ||
| − | | | + | | <tt>Ants_ov_convergence_parameter_boron </tt> <span id="Ants_ov_convergence_parameter_boron "></span> |
| − | | | + | | 1*float64 |
| + | | | ||
| + | | Current evaluated value for convergence parameter | ||
| + | | | ||
|- | |- | ||
| − | | | + | | <tt>Ants_ov_convergence_parameter_fission_source </tt> <span id="Ants_ov_convergence_parameter_fission_source "></span> |
| − | | | + | | 1*float64 |
| + | | | ||
| + | | Current evaluated value for convergence parameter | ||
| + | | | ||
|- | |- | ||
| − | | | + | | <tt>Ants_ov_convergence_parameter_fission_source_l2</tt> <span id="Ants_ov_convergence_parameter_fission_source_l2"></span> |
| − | | | + | | 1*float64 |
| + | | | ||
| + | | Current evaluated value for convergence parameter | ||
| + | | | ||
|- | |- | ||
| − | | | + | | <tt>Ants_ov_convergence_parameter_flux </tt> <span id="Ants_ov_convergence_parameter_flux "></span> |
| − | | | + | | 1*float64 |
| + | | | ||
| + | | Current evaluated value for convergence parameter | ||
| + | | | ||
|- | |- | ||
| − | | | + | | <tt>Ants_ov_convergence_parameter_keff </tt> <span id="Ants_ov_convergence_parameter_keff "></span> |
| − | | | + | | 1*float64 |
| + | | | ||
| + | | Current evaluated value for convergence parameter | ||
| + | | | ||
|- | |- | ||
| − | | | + | | <tt>Ants_ov_convergence_parameter_partial_current </tt> <span id="Ants_ov_convergence_parameter_partial_current "></span> |
| − | | | + | | 1*float64 |
| + | | | ||
| + | | Current evaluated value for convergence parameter | ||
| + | | | ||
|- | |- | ||
| − | | | + | | <tt>Ants_ov_convergence_parameter_poison_density </tt> <span id="Ants_ov_convergence_parameter_poison_density "></span> |
| − | | | + | | 1*float64 |
| + | | | ||
| + | | Current evaluated value for convergence parameter | ||
| + | | | ||
|- | |- | ||
| − | | | + | | <tt>Ants_ov_convergence_parameter_power </tt> <span id="Ants_ov_convergence_parameter_power "></span> |
| − | | | + | | 1*float64 |
| + | | | ||
| + | | Current evaluated value for convergence parameter | ||
| + | | | ||
|- | |- | ||
| − | | | + | | <tt>Ants_ov_cr_bank_height_<identifier></tt> <span id="Ants_ov_cr_bank_height"></span> |
| − | | | + | | 1*float64 |
| + | | If controlrod group load is defined in input. | ||
| + | | Current axial height (cm) of this control rod identifier. | ||
| + | | Height of CR lowest end from geometry bottom. | ||
|- | |- | ||
| − | | | + | | <tt>Ants_ov_is_boron_global </tt> <span id="Ants_ov_is_boron_global "></span> |
| − | | | + | | 1*int64 |
| + | | | ||
| + | | Does group constant evaluation currently use a global (1) or calculation-node-local (0) value for boron? | ||
| + | | | ||
|- | |- | ||
| − | | | + | | <tt>Ants_ov_keff </tt> <span id="Ants_ov_keff "></span> |
| − | | | + | | 1*float64 |
| + | | | ||
| + | | Current value for keff. Either evaluated for current boron or given as input. | ||
| + | | | ||
|- | |- | ||
| − | | | + | | <tt>Ants_ov_max_mdep_nuclide </tt> <span id="Ants_ov_max_mdep_nuclide "></span> |
| − | | | + | | 1*int64 |
| + | | | ||
| + | | Maximum number of microdepletion nuclides in any region of any material in the calculation. | ||
| + | | | ||
|- | |- | ||
| − | | | + | | <tt>Ants_ov_max_mdep_region </tt> <span id="Ants_ov_max_mdep_region "></span> |
| − | | | + | | 1*int64 |
| + | | | ||
| + | | Maximum number of microdepletion regions in any material in the calculation. | ||
| + | | | ||
|- | |- | ||
| − | | | + | | <tt>Ants_ov_mean_burnup </tt> <span id="Ants_ov_mean_burnup "></span> |
| − | | | + | | 1*float64 |
| + | | | ||
| + | | Mean burnup in the system. | ||
| + | | Calculated correctly from fueled parts? | ||
|- | |- | ||
| − | | | + | | <tt>Ants_ov_min_eigenvalue_calculated </tt> <span id="Ants_ov_min_eigenvalue_calculated "></span> |
| − | | | + | | 1*float64 |
| + | | | ||
| + | | The smallest (absolute) local node eigenvalue calculated, before critical node treatments were applied. | ||
| + | | | ||
|- | |- | ||
| − | | | + | | <tt>Ants_ov_min_eigenvalue_used </tt> <span id="Ants_ov_min_eigenvalue_used "></span> |
| − | | | + | | 1*float64 |
| + | | | ||
| + | | The smallest (absolute) local node eigenvalue used, after critical node treatments were applied. | ||
| + | | | ||
|- | |- | ||
| − | | | + | | <tt>Ants_ov_num_group </tt> <span id="Ants_ov_num_group "></span> |
| − | | | + | | 1*int64 |
| + | | | ||
| + | | Number of neutron groups in the calculation. | ||
| + | | | ||
|- | |- | ||
| − | | | + | | <tt>Ants_ov_num_moment </tt> <span id="Ants_ov_num_moment "></span> |
| − | | | + | | 1*int64 |
| + | | | ||
| + | | Number of directional flux moments in the calculation. | ||
| + | | | ||
| + | |- | ||
| + | | <tt>Ants_ov_num_polynomial </tt> <span id="Ants_ov_num_polynomial "></span> | ||
| + | | 1*int64 | ||
| + | | | ||
| + | | Number of polynomial terms in the polynomial expansions. | ||
| + | | | ||
| + | |- | ||
| + | | <tt>Ants_ov_num_precursor_group </tt> <span id="Ants_ov_num_precursor_group "></span> | ||
| + | | 1*int64 | ||
| + | | | ||
| + | | Number of precursor groups in the calculation. | ||
| + | | | ||
| + | |- | ||
| + | | <tt>Ants_ov_total_power </tt> <span id="Ants_ov_total_power "></span> | ||
| + | | 1*float64 | ||
| + | | | ||
| + | | Current evaluated total power. | ||
| + | | | ||
|} | |} | ||
Revision as of 12:59, 30 October 2023
Ants may take input and give output variables and fields from or to Cerberus. Many input variables are shared with the Ants input file and some are only possible to be given via Cerberus.
Contents
Input variables
| Name | Size and type | Availability | Explanation | Related input cards | Notes |
|---|---|---|---|---|---|
| Ants_iv_boron | 1*float64 | Global value for coolant boron content (ppm) to be used in all nodes. | iteration boron | ||
| Ants_iv_control_variable | 1*int64 | Set the control variable for critical variable iteration. | iteration control_variable | See cerberus.krakendefs.ants.AntsControlVar | |
| Ants_iv_convergence_criterion_boron | 1*float64 | iteration conv_crit_boron | |||
| Ants_iv_convergence_criterion_fission_source | 1*float64 | iteration conv_crit_fsrc | |||
| Ants_iv_convergence_criterion_fission_source_l2 | 1*float64 | iteration conv_crit_fsrc_l2 | |||
| Ants_iv_convergence_criterion_flux | 1*float64 | iteration conv_crit_flux | |||
| Ants_iv_convergence_criterion_keff | 1*float64 | iteration conv_crit_keff | |||
| Ants_iv_convergence_criterion_partial_current | 1*float64 | iteration conv_crit_partial_current | |||
| Ants_iv_convergence_criterion_poison_density | 1*float64 | iteration conv_crit_poison_density | |||
| Ants_iv_convergence_criterion_power | 1*float64 | iteration conv_crit_power | |||
| Ants_iv_corrector_method | 1*int64 | Which type of corrector time integration to use for depletion? | See cerberus.krakendefs.ants.AntsCorrector | ||
| Ants_iv_corrector_num_substep | 1*int64 | Number of depletion substeps to take on corrector. Default: ?? | |||
| Ants_iv_cr_bank_height_<identifier> | 1*float64 | If controlrod group load is defined in input. | controlrod group height | Defined as height of CR lowest end from geometry bottom. | |
| Ants_iv_critical_node_method | 1*int64 | iteration critical_node_method | See cerberus.krakendefs.ants.AntsCriticalNodeMethod | ||
| Ants_iv_critical_node_shift | 1*float64 | iteration critical_node_shift | |||
| Ants_iv_critical_node_shift_increment | 1*float64 | ||||
| Ants_iv_decay_num_substep | 1*int64 | Number of depletion substeps to take during decay. Default: ?? | |||
| Ants_iv_depletion_type | 1*int64 | The type of solution used for depleting materials. | See cerberus.krakendefs.ants.AntsDepStyle | ||
| Ants_iv_disable_abundant_messages | 1*int64 | If set to 1, disables some abundant warning messages from Ants, printing of which may slow down the calculation. Default value: 0. | |||
| Ants_iv_eigenvalue_critical_limit | 1*float64 | iteration eigenvalue_critical_limit | |||
| Ants_iv_eigenvalue_critical_limit_fix_sign | 1*float64 | ||||
| Ants_iv_eigenvalue_real_limit | 1*float64 | iteration eigenvalue_real_limit | |||
| Ants_iv_keff | 1*float64 | Input keff for boron iteration (Ants_iv_control_variable) or for transient calculations. Default: 1.0 | |||
| Ants_iv_normalization_variable | 1*int64 | Set the variable to which the neutronics solution is normalized or disable normalization. | iteration normalization_type | See cerberus.krakendefs.ants.AntsNormalization | |
| Ants_iv_num_datafield_point | 1*int64 | Number of points for which coordinates (Ants_iv_datafield_xyz) will be provided to evaluate point-wise homogeneous flux (Ants_ov_datafield_flux). | |||
| Ants_iv_num_inner_iteration | 1*int64 | Number of neutronics inner iterations per outer iteration. | iteration num_inner | ||
| Ants_iv_poison_ff | 1*float64 | Factor for accelerating the time in the evaluation of poison concentrations. Default 1.0. | A factor of 10, for example, means that for 1 second of transient simulated, the poison concentrations are updated as if 10 seconds have been elapsed. | ||
| Ants_iv_predictor_method | 1*int64 | Which type of predictor time integration to use for depletion? | See cerberus.krakendefs.ants.AntsPredictor | ||
| Ants_iv_predictor_num_substep | 1*int64 | Number of depletion substeps to take on predictor. Default: ?? | |||
| Ants_iv_reset_neutronics_state | 1*int64 | If set to 1, the internal neutronics solution of Ants will be reset and the next solution will begin from that state. | Can be used e.g. for resetting Ants between single-node solutions for different node types. | ||
| Ants_iv_samarium_state | 1*int64 | State of samarium chain nuclides during calculation. | iteration samarium_state | See cerberus.krakendefs.ants.AntsSamarium | |
| Ants_iv_total_power | 1*float64 | Set the core total power (W) for flux normalization. | iteration power | ||
| Ants_iv_xenon_state | 1*int64 | State of xenon chain nuclides during calculation. | iteration xenon_state | See cerberus.krakendefs.ants.AntsXenon |
Input fields
| Field name | Description |
|---|---|
| Ants_if_fuel_temperature | |
| Ants_if_boron_concentration | |
| Ants_if_coolant_density | |
| Ants_if_coolant_density_unheated | |
| Ants_if_coolant_temperature | |
| Ants_if_number_density_i135 | |
| Ants_if_number_density_xe135 | |
| Ants_if_number_density_xe135m | |
| Ants_if_number_density_pm149 | |
| Ants_if_number_density_sm149 | |
| Ants_if_coolant_mean_historical_density | |
| Ants_if_burnup | |
| Ants_if_number_density_u238 | |
| Ants_if_number_density_np239 | |
| Ants_if_number_density_pu239 | |
| Ants_if_num_pin |
| Field name | Description |
|---|---|
| Ants_if_xs_absorption | |
| Ants_if_xs_removal | |
| Ants_if_xs_nufission | |
| Ants_if_xs_kappafission | |
| Ants_if_xs_chi_total | |
| Ants_if_xs_diffusion | |
| Ants_if_xs_inversevelocity | |
| Ants_if_xs_fission | |
| Ants_if_xs_chi_prompt | |
| Ants_if_xs_chi_delayed |
| Field name | Description |
|---|---|
| Ants_if_xs_scattering |
| Variable name | Description |
|---|---|
| Ants_if_xs_beta | |
| Ants_if_xs_lambda |
| Field name | Description |
|---|---|
| Ants_if_xs_discontinuityfactor | |
| Ants_if_netcurrent | |
| Ants_if_outcurrent |
| Variable name | Description |
|---|---|
| Ants_if_flux_expansion_coeff | |
| Ants_if_fission_source_expansion_coeff |
| Field name | Description |
|---|---|
| Ants_if_precursor_expansion_coeff |
| Field name | Description |
|---|---|
| Ants_if_supernode_fuel_temperature | |
| Ants_if_supernode_boron_concentration | |
| Ants_if_supernode_coolant_density | |
| Ants_if_supernode_coolant_density_unheated | |
| Ants_if_supernode_coolant_temperature |
| Field name | Description |
|---|---|
| Ants_if_supernode_ppr_burnup |
| Field name | Description |
|---|---|
| Ants_if_ppr_x | |
| Ants_if_ppr_y | |
| Ants_if_ppr_wx | |
| Ants_if_ppr_wy |
| Field name | Description |
|---|---|
| Ants_if_ppr_form_function |
| Field name | Description |
|---|---|
| Ants_if_datafield_xyz |
Output variables
| Name | Size and type | Availability | Explanation | Notes |
|---|---|---|---|---|
| Ants_ov_boron | 1*float64 | Current global boron (ppm). | ||
| Ants_ov_convergence_criterion_boron | 1*float64 | Current value for the convergence limit | ||
| Ants_ov_convergence_criterion_fission_source | 1*float64 | Current value for the convergence limit | ||
| Ants_ov_convergence_criterion_fission_source_l2 | 1*float64 | Current value for the convergence limit | ||
| Ants_ov_convergence_criterion_flux | 1*float64 | Current value for the convergence limit | ||
| Ants_ov_convergence_criterion_keff | 1*float64 | Current value for the convergence limit | ||
| Ants_ov_convergence_criterion_partial_current | 1*float64 | Current value for the convergence limit | ||
| Ants_ov_convergence_criterion_poison_density | 1*float64 | Current value for the convergence limit | ||
| Ants_ov_convergence_criterion_power | 1*float64 | Current value for the convergence limit | ||
| Ants_ov_convergence_parameter_boron | 1*float64 | Current evaluated value for convergence parameter | ||
| Ants_ov_convergence_parameter_fission_source | 1*float64 | Current evaluated value for convergence parameter | ||
| Ants_ov_convergence_parameter_fission_source_l2 | 1*float64 | Current evaluated value for convergence parameter | ||
| Ants_ov_convergence_parameter_flux | 1*float64 | Current evaluated value for convergence parameter | ||
| Ants_ov_convergence_parameter_keff | 1*float64 | Current evaluated value for convergence parameter | ||
| Ants_ov_convergence_parameter_partial_current | 1*float64 | Current evaluated value for convergence parameter | ||
| Ants_ov_convergence_parameter_poison_density | 1*float64 | Current evaluated value for convergence parameter | ||
| Ants_ov_convergence_parameter_power | 1*float64 | Current evaluated value for convergence parameter | ||
| Ants_ov_cr_bank_height_<identifier> | 1*float64 | If controlrod group load is defined in input. | Current axial height (cm) of this control rod identifier. | Height of CR lowest end from geometry bottom. |
| Ants_ov_is_boron_global | 1*int64 | Does group constant evaluation currently use a global (1) or calculation-node-local (0) value for boron? | ||
| Ants_ov_keff | 1*float64 | Current value for keff. Either evaluated for current boron or given as input. | ||
| Ants_ov_max_mdep_nuclide | 1*int64 | Maximum number of microdepletion nuclides in any region of any material in the calculation. | ||
| Ants_ov_max_mdep_region | 1*int64 | Maximum number of microdepletion regions in any material in the calculation. | ||
| Ants_ov_mean_burnup | 1*float64 | Mean burnup in the system. | Calculated correctly from fueled parts? | |
| Ants_ov_min_eigenvalue_calculated | 1*float64 | The smallest (absolute) local node eigenvalue calculated, before critical node treatments were applied. | ||
| Ants_ov_min_eigenvalue_used | 1*float64 | The smallest (absolute) local node eigenvalue used, after critical node treatments were applied. | ||
| Ants_ov_num_group | 1*int64 | Number of neutron groups in the calculation. | ||
| Ants_ov_num_moment | 1*int64 | Number of directional flux moments in the calculation. | ||
| Ants_ov_num_polynomial | 1*int64 | Number of polynomial terms in the polynomial expansions. | ||
| Ants_ov_num_precursor_group | 1*int64 | Number of precursor groups in the calculation. | ||
| Ants_ov_total_power | 1*float64 | Current evaluated total power. |
Output fields
| Field name | Description |
|---|---|
| Ants_of_power | |
| Ants_of_burnup | |
| Ants_of_number_density_i135 | |
| Ants_of_number_density_xe135 | |
| Ants_of_number_density_xe135m | |
| Ants_of_number_density_pm149 | |
| Ants_of_number_density_sm149 | |
| Ants_of_coolant_mean_historical_density | |
| Ants_of_boron_concentration | |
| Ants_of_volume | |
| Ants_of_active_volume | |
| Ants_of_hm_mass | |
| Ants_of_fuel_assembly_index | |
| Ants_of_number_density_u238 | |
| Ants_of_number_density_np239 | |
| Ants_of_number_density_pu239 |
| Field name | Description |
|---|---|
| Ants_of_xs_absorption | |
| Ants_of_xs_removal | |
| Ants_of_xs_nufission | |
| Ants_of_xs_kappafission | |
| Ants_of_xs_chi_total | |
| Ants_of_xs_diffusion | |
| Ants_of_xs_inversevelocity | |
| Ants_of_xs_fission | |
| Ants_of_xs_chi_prompt | |
| Ants_of_xs_chi_delayed | |
| Ants_of_flux |
| Field name | Description |
|---|---|
| Ants_of_xs_scattering |
| Field name | Description |
|---|---|
| Ants_of_xs_beta | |
| Ants_of_xs_lambda |
| Field name | Description |
|---|---|
| Ants_of_xs_discontinuityfactor | |
| Ants_of_surfaceflux | |
| Ants_of_outcurrent |
| Field name | Description |
|---|---|
| Ants_of_flux_expansion_coeff | |
| Ants_of_fission_source_expansion_coeff |
| Field name | Description |
|---|---|
| Ants_of_precursor_expansion_coeff |
| Field name | Description |
|---|---|
| Ants_of_supernode_num_pin | |
| Ants_of_supernode_power |
| Field name | Description |
|---|---|
| Ants_of_supernode_nodal_response |
| Field name | Description |
|---|---|
| Ants_of_supernode_ppr_x | |
| Ants_of_supernode_ppr_y | |
| Ants_of_supernode_ppr_wx | |
| Ants_of_supernode_ppr_wy | |
| Ants_of_supernode_ppr_power | |
| Ants_of_supernode_ppr_burnup | |
| Ants_of_supernode_ppr_hm_mass |
| Field name | Description |
|---|---|
| Ants_of_supernode_ppr_flux | |
| Ants_of_supernode_ppr_power |
| Field name | Description |
|---|---|
| Ants_of_datafield_flux |
| Field name | Description |
|---|---|
| Ants_of_datafield_nodal_response |
Meshes
Ants input and output fields are based on a few different meshes.
Input node mesh
Calculation node mesh
Input node pin mesh
A two level mesh where the first level corresponds to the input node mesh, while the second level is a list of the different pins inside the input node.
Calculation node pin mesh
A two level mesh where the first level corresponds to the calculation node mesh, while the second level is a list of the different pins inside the input node.
Microdepletion mesh
A two level mesh where the first level corresponds to the calculation node mesh, while the second level is a list of the different nuclides in the calculation node.
