ValueRangeInterface

Interface to check if a value is within specified bounds and handle the cases appropriately.

Description

ValueRangeInterface provides an ability to check if variables passed into internal methods are out of a specified range via the validateValueIsInRange method. If the value is out of the specified range, a series of options are available, such as throw an error, warn, or do nothing, via the value_range_behavior input parameter.

[Materials<<<{"href": "../../syntax/Materials/index.html"}>>>]
  [mat]
    type = ADValueRangeInterfaceTester
    u = u
    value_range_behavior = ERROR
    outputs = all
  []
[]

(test/tests/value_range_interface/range_check.i)

[Problem]
  solve = true
[]

[Mesh]
  [mesh]
    type = GeneratedMeshGenerator
    dim = 1
  []
[]

[Variables]
  [u]
    initial_condition = 0.1
  []
[]

[BCs]
  [u_side]
    type = DirichletBC
    variable = u
    boundary = left
    value = 0.3
  []
[]

[Kernels]
  [dt]
    type = TimeDerivative
    variable = u
  []
  [diff]
    type = ADMatDiffusion
    variable = u
    diffusivity = dummy
  []
[]

[Materials]
  [mat]
    type = ADValueRangeInterfaceTester
    u = u
    value_range_behavior = ERROR
    outputs = all
  []
[]

[Executioner]
  type = Transient
  petsc_options_iname = '-snes_force_interation'
  petsc_options_value = '1'
  end_time = 2
  dtmin = 1
[]

Description