Fluid Properties Failure Analysis Report

Introduction

The FAR for the Fluid Properties module describes the system functional and non-functional requirements that describe the expected interactions that the software shall provide.

Dependencies

The Fluid Properties module is developed using MOOSE and can itself be based on various MOOSE modules, as such the FAR for the Fluid Properties module is dependent upon the following documents.

Framework Failure Analysis Report

Failure Analysis Requirements

The following is a complete list for all the requirements related to failure analysis for the Fluid Properties module.

fluid_properties: Fp Interrogator
3.6.20The fluid properties interrogator shall throw an error if an incompatible fluid properties object is supplied.
Specification(s): err.wrong_fp_type
Design: FluidPropertiesInterrogator
Issue(s): #12995
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
3.6.21The fluid properties interrogator shall throw an error if an extraneous parameter(s) are supplied.
Specification(s): err.extraneous_parameter
Design: FluidPropertiesInterrogator
Issue(s): #12995
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
3.6.22The fluid properties interrogator shall throw an error if an no valid input sets were supplied.
Specification(s): err.no_params
Design: FluidPropertiesInterrogator
Issue(s): #12995
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException

fluid_properties: Interfaces
3.10.1The system should produce a warning when a scalar NaN is produced and user required that the execution would not terminate
Specification(s): quiet_nan_scalar
Design: NaNInterface
Issue(s): #12234 #12350
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
3.10.2The system should produce a warning when a vector NaN is produced and user required that the execution would not terminate
Specification(s): quiet_nan_vector
Design: NaNInterface
Issue(s): #12234 #12350
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
3.10.3The system should report an error when a NaN is produced by a computation in DEBUG mode, by default
Specification(s): signaling_nan_dbg
Design: NaNInterface
Issue(s): #12234 #12350
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
3.10.6The system should be able to throw an exception when a fluid property evaluation encounters a NaN.
Specification(s): signaling_nan_exception
Design: NaNInterface
Issue(s): #12234 #12350
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException

fluid_properties: Tabulated
3.16.5
The system shall throw an error if
1. if the user-specified pressure boundaries are inverted
2. if the user-specified temperature boundaries are inverted
3. if the user-specified pressure initial guess for variable set inversions is out of bounds
4. if the user-specified temperature initial guess for variable set inversions is out of bounds
Specification(s): exceptions/bad_pressure_bounds, exceptions/bad_temperature_bounds, exceptions/bad_pressure_guess, exceptions/bad_temperature_guess
Design: TabulatedFluidProperties
Issue(s): #20101
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
3.16.6
The system shall be able to
1. error if the desired pressure for a fluid property evaluation is outside the user-specified bounds, when prescribed to error in such conditions
2. error if the desired temperature for a fluid property evaluation is outside the user-specified bounds, when prescribed to error in such conditions
3. declare the solution invalid if the desired pressure for a fluid property evaluation is outside the user-specified bounds, when prescribed to do so in such conditions
4. declare the solution invalid if the desired temperature for a fluid property evaluation is outside the user-specified bounds, when prescribed to do so in such conditions
5. ignore if the desired pressure for a fluid property evaluation is outside the user-specified bounds, when prescribed to ignore in such conditions
6. ignore if the desired temperature for a fluid property evaluation is outside the user-specified bounds, when prescribed to ignore in such conditions
Specification(s): out_of_bounds/error_pressure_out_of_bounds, out_of_bounds/error_temperature_out_of_bounds, out_of_bounds/invalid_pressure_out_of_bounds, out_of_bounds/invalid_temperature_out_of_bounds, out_of_bounds/ignore_pressure_out_of_bounds, out_of_bounds/ignore_temperature_out_of_bounds
Design: TabulatedFluidProperties
Issue(s): #20101
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunExceptionRunApp

fluid_properties: Two Phase Fluid Properties Independent
3.18.3The system shall report an error if 2-phase property interfaces are called on a class designed to handle two single-phase fluid properties.
Specification(s): error:error_on_unimplemented
Design: TwoPhaseFluidPropertiesIndependent
Issue(s): #11641
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException

fluid_properties: Two Phase Ncg Partial Pressure
3.19.2The system shall report an error if an incorrect number of arguments are provided when computing properties from a two-phase with non-condensable gas user object.
Specification(s): error_wrong_number_of_args
Design: TwoPhaseNCGPartialPressureFunction
Issue(s): #28335
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException

[./err.wrong_fp_type]
  type = RunException
  input = 'err.wrong_fp_type.i'
  allow_warnings = true
  method = 'OPT'
  threading = '!pthreads'
  expect_err = "The type of the parameter 'fp' must be derived from type 'SinglePhaseFluidProperties', 'VaporMixtureFluidProperties', or 'TwoPhaseFluidProperties'"

  requirement = "The fluid properties interrogator shall throw an error if an
      incompatible fluid properties object is supplied."
  issues = '#12995'
  design = 'FluidPropertiesInterrogator.md'
[../]

[./err.extraneous_parameter]
  type = RunException
  input = '1ph.rho_e.i'
  allow_warnings = true
  method = 'OPT'
  threading = '!pthreads'
  expect_err = "\(rho\,e\) has been specified\; T cannot be specified\."
  cli_args = "FluidPropertiesInterrogator/T=300"

  requirement = "The fluid properties interrogator shall throw an error if an
      extraneous parameter(s) are supplied."
  issues = '#12995'
  design = 'FluidPropertiesInterrogator.md'
[../]

[./err.no_params]
  type = RunException
  input = 'err.no_params.i'
  allow_warnings = true
  method = 'OPT'
  threading = '!pthreads'
  expect_err = "For one-phase fluid properties\, you must provide one of the following
combinations of thermodynamic properties:"

  requirement = "The fluid properties interrogator shall throw an error if an
      no valid input sets were supplied."
  issues = '#12995'
  design = 'FluidPropertiesInterrogator.md'
[../]

[quiet_nan_scalar]
  type = 'RunException'
  input = 'nan_interface.i'
  cli_args = 'FluidProperties/fp/emit_on_nan=warning'
  allow_test_objects = True
  method = 'DBG'
  threading = '!pthreads'

  requirement = 'The system should produce a warning when a scalar NaN is produced and user required that the execution would not terminate'
  expect_err = "fp: A NaN was produced."
  issues = '#12234 #12350'
[]

[quiet_nan_vector]
  type = 'RunException'
  input = 'nan_interface.i'
  cli_args = 'FluidProperties/fp/emit_on_nan=warning Kernels/test_kernel/test_vector_version=true'
  allow_test_objects = True
  method = 'DBG'
  threading = '!pthreads'

  requirement = 'The system should produce a warning when a vector NaN is produced and user required that the execution would not terminate'
  expect_err = "fp: A NaN was produced."
  issues = '#12234 #12350'
[]

[signaling_nan_dbg]
  type = 'RunException'
  input = 'nan_interface.i'
  allow_test_objects = True
  method = 'DBG'
  threading = '!pthreads'

  requirement = 'The system should report an error when a NaN is produced by a computation in DEBUG mode, by default'
  expect_err = "fp: A NaN was produced."
  issues = '#12234 #12350'
[]

[signaling_nan_exception]
  type = 'RunException'
  input = 'nan_interface.i'
  cli_args = 'FluidProperties/fp/emit_on_nan=exception Executioner/type=Transient'
  allow_test_objects = True
  allow_warnings = true
  expect_err = 'Solve failed and timestep already at or below dtmin'

  requirement = 'The system should be able to throw an exception when a fluid property evaluation encounters a NaN.'
  issues = '#12234 #12350'
  recover = False
[]

[bad_pressure_bounds]
  type = RunException
  input = 'tabulated.i'
  cli_args = 'FluidProperties/tabulated/pressure_min=1e6 FluidProperties/tabulated/pressure_max=1e5'
  expect_err = 'pressure_max must be greater than pressure_min'
  detail = 'if the user-specified pressure boundaries are inverted'
[]

[bad_temperature_bounds]
  type = RunException
  input = 'tabulated.i'
  cli_args = 'FluidProperties/tabulated/temperature_min=1e3 FluidProperties/tabulated/temperature_max=1e2'
  expect_err = 'temperature_max must be greater than temperature_min'
  detail = 'if the user-specified temperature boundaries are inverted'
[]

[bad_pressure_guess]
  type = RunException
  input = 'tabulated_v_e.i'
  cli_args = "FluidProperties/tabulated/p_initial_guess=10 FluidProperties/tabulated/save_file=false FluidProperties/tabulated/fp=co2"
  expect_err = 'Pressure initial guess for \(p,T\), \(v,e\) conversions 10 is outside the range of tabulated pressure'
  detail = 'if the user-specified pressure initial guess for variable set inversions is out of bounds'
[]

[bad_temperature_guess]
  type = RunException
  input = 'tabulated_v_e.i'
  cli_args = "FluidProperties/tabulated/T_initial_guess=1e5 FluidProperties/tabulated/save_file=false FluidProperties/tabulated/fp=co2"
  expect_err = 'Temperature initial guess for \(p,T\), \(v,e\) conversions 100000 is outside the range of tabulated temperature'
  detail = 'if the user-specified temperature initial guess for variable set inversions is out of bounds'
[]

[error_pressure_out_of_bounds]
  type = RunException
  input = 'tabulated.i'
  cli_args = 'AuxVariables/pressure/initial_condition=1e4 FluidProperties/tabulated/error_on_out_of_bounds=true'
  expect_err = 'is outside the range of tabulated pressure'
  detail = 'error if the desired pressure for a fluid property evaluation is outside the user-specified bounds, when prescribed to error in such conditions'
[]

[error_temperature_out_of_bounds]
  type = RunException
  input = 'tabulated.i'
  cli_args = 'AuxVariables/temperature/initial_condition=250 FluidProperties/tabulated/error_on_out_of_bounds=true'
  expect_err = 'is outside the range of tabulated temperature'
  detail = 'error if the desired temperature for a fluid property evaluation is outside the user-specified bounds, when prescribed to error in such conditions'
[]

[invalid_pressure_out_of_bounds]
  type = RunException
  input = 'tabulated.i'
  cli_args = "AuxVariables/pressure/initial_condition=1e4 FluidProperties/tabulated/out_of_bounds_behavior=declare_invalid Problem/solve=true Kernels/diff/type=MatDiffusion Kernels/diff/diffusivity=viscosity"
  expect_err = 'Pressure out of bounds'
  detail = 'declare the solution invalid if the desired pressure for a fluid property evaluation is outside the user-specified bounds, when prescribed to do so in such conditions'
[]

[invalid_temperature_out_of_bounds]
  type = RunException
  input = 'tabulated.i'
  cli_args = "AuxVariables/temperature/initial_condition=250 FluidProperties/tabulated/out_of_bounds_behavior=declare_invalid Problem/solve=true Kernels/diff/type=MatDiffusion Kernels/diff/diffusivity=viscosity"
  expect_err = 'Temperature out of bounds'
  detail = 'declare the solution invalid if the desired temperature for a fluid property evaluation is outside the user-specified bounds, when prescribed to do so in such conditions'
[]

[ignore_pressure_out_of_bounds]
  type = RunApp
  input = 'tabulated.i'
  cli_args = 'AuxVariables/pressure/initial_condition=1e4 FluidProperties/tabulated/out_of_bounds_behavior=ignore '
  detail = 'ignore if the desired pressure for a fluid property evaluation is outside the user-specified bounds, when prescribed to ignore in such conditions'
[]

[ignore_temperature_out_of_bounds]
  type = RunApp
  input = 'tabulated.i'
  cli_args = 'AuxVariables/temperature/initial_condition=250 FluidProperties/tabulated/out_of_bounds_behavior=ignore'
  detail = 'ignore if the desired temperature for a fluid property evaluation is outside the user-specified bounds, when prescribed to ignore in such conditions'
[]

[error:error_on_unimplemented]
  type = 'RunException'
  input = 'test.i'
  cli_args = "
      AuxVariables/T_sat/family=LAGRANGE
      AuxVariables/T_sat/order=FIRST
      AuxKernels/T_sat_aux/type=SaturationTemperatureAux
      AuxKernels/T_sat_aux/variable=T_sat
      AuxKernels/T_sat_aux/p=p
      AuxKernels/T_sat_aux/fp_2phase=fp_2phase
      AuxKernels/T_sat_aux/execute_on=initial"
  expect_err = "The 2-phase fluid properties class 'TwoPhaseFluidPropertiesIndependent' does not allow calling any 2-phase property interfaces"
  allow_test_objects = true
  threading = '!pthreads'
  requirement = 'The system shall report an error if 2-phase property interfaces are called on a class designed to handle two single-phase fluid properties.'
[]

[error_wrong_number_of_args]
  type = RunException
  input = 'test.i'
  cli_args = "Functions/p_sat_fn/arg2=40000"
  expect_err = "The property call 'p_sat' expects the parameter\(s\) {'arg1'} to be provided, but the provided argument\(s\) were {'arg1', 'arg2'}"
  allow_test_objects = true
  threading = '!pthreads'
  requirement = 'The system shall report an error if an incorrect number of arguments are provided when computing properties from a two-phase with non-condensable gas user object.'
[]

Introduction
Dependencies
Failure Analysis Requirements