MachNumberAux

Computes Mach number.

The Mach number is computed as:

var element = document.getElementById("moose-equation-abb43c05-4abf-4a87-86b7-082e965785cb");katex.render("\\text{Mach number} = \\dfrac{\\text{velocity}}{\\text{speed of sound}}", element, {displayMode:true,throwOnError:false,macros:{"\\eqc":"\\,,","\\eqp":"\\,.","\\pd":"\\frac{\\partial #1}{\\partial #2}","\\pr":"\\left(#1\\right)","\\ddt":"\\frac{d #1}{d t}"}});

Example usage:

Listing 1: Single phase example

[AuxKernels<<<{"href": "../../syntax/AuxKernels/index.html"}>>>]
  [mach_aux]
    type = MachNumberAux<<<{"description": "Computes Mach number.", "href": "MachNumberAux.html"}>>>
    variable<<<{"description": "The name of the variable that this object applies to"}>>> = mach_no
    vel<<<{"description": "x-component of phase velocity"}>>> = vel
    v<<<{"description": "Specific volume"}>>> = v
    e<<<{"description": "Specific internal energy"}>>> = e
    fp<<<{"description": "The name of fluid properties object to use."}>>> = fp
  []
[]

[Postprocessors<<<{"href": "../../syntax/Postprocessors/index.html"}>>>]
  [mach_no]
    type = ElementalVariableValue<<<{"description": "Outputs an elemental variable value at a particular location", "href": "../postprocessors/ElementalVariableValue.html"}>>>
    variable<<<{"description": "The variable to be monitored"}>>> = mach_no
    elementid<<<{"description": "The ID of the element where we monitor"}>>> = 0
  []
[]

[Problem<<<{"href": "../../syntax/Problem/index.html"}>>>]
  solve = false
[]

[Executioner<<<{"href": "../../syntax/Executioner/index.html"}>>>]
  type = Transient
  dt = 1
  num_steps = 1
  abort_on_solve_fail = true
[]

[Outputs<<<{"href": "../../syntax/Outputs/index.html"}>>>]
  csv<<<{"description": "Output the scalar variable and postprocessors to a *.csv file using the default CSV output."}>>> = true
  execute_on<<<{"description": "The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html."}>>> = TIMESTEP_END
[]

The variables v, e, vel are created when a single phase component is present in the input file. If not using the component syntax, the user is responsible for creating the variables and computing them.

Input Parameters

eSpecific internal energy
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Specific internal energy
fpThe name of fluid properties object to use.
C++ Type:UserObjectName
Controllable:No
Description:The name of fluid properties object to use.
vSpecific volume
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Specific volume
variableThe name of the variable that this object applies to
C++ Type:AuxVariableName
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable that this object applies to
velx-component of phase velocity
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:x-component of phase velocity

Required Parameters

blockThe list of blocks (ids or names) that this object will be applied
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:The list of blocks (ids or names) that this object will be applied
boundaryThe list of boundaries (ids or names) from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The list of boundaries (ids or names) from the mesh where this object applies
check_boundary_restrictedTrueWhether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh
Default:True
C++ Type:bool
Controllable:No
Description:Whether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh
execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
Default:LINEAR TIMESTEP_END
C++ Type:ExecFlagEnum
Options:XFEM_MARK, FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, LINEAR_CONVERGENCE, NONLINEAR, NONLINEAR_CONVERGENCE, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, MULTIAPP_FIXED_POINT_CONVERGENCE, FINAL, CUSTOM, PRE_DISPLACE
Controllable:No
Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Controllable:Yes
Description:Set the enabled status of the MooseObject.
seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Controllable:No
Description:The seed for the master random number generator
use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
Default:False
C++ Type:bool
Controllable:No
Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters

prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
Default:False
C++ Type:bool
Controllable:No
Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

Material Property Retrieval Parameters

Input Files

(modules/thermal_hydraulics/test/tests/auxkernels/mach_number/1phase.i)

(modules/thermal_hydraulics/test/tests/auxkernels/mach_number/1phase.i)

[GlobalParams]
  family = MONOMIAL
  order = CONSTANT
[]

[Mesh]
  type = GeneratedMesh
  dim = 1
  nx = 1
  allow_renumbering = false
[]

[FluidProperties]
  [fp]
    type = StiffenedGasFluidProperties
    gamma = 2.35
    q = -1167e3
    q_prime = 0
    p_inf = 1.e9
    cv = 1816
  []
[]

[AuxVariables]
  [mach_no]
  []
  [v]
    initial_condition = 1e-3
  []
  [e]
    initial_condition = 1e5
  []
  [vel]
    initial_condition = 10.
  []
[]

[AuxKernels]
  [mach_aux]
    type = MachNumberAux
    variable = mach_no
    vel = vel
    v = v
    e = e
    fp = fp
  []
[]

[Postprocessors]
  [mach_no]
    type = ElementalVariableValue
    variable = mach_no
    elementid = 0
  []
[]

[Problem]
  solve = false
[]

[Executioner]
  type = Transient
  dt = 1
  num_steps = 1
  abort_on_solve_fail = true
[]

[Outputs]
  csv = true
  execute_on = TIMESTEP_END
[]

(modules/thermal_hydraulics/test/tests/auxkernels/mach_number/1phase.i)

[GlobalParams]
  family = MONOMIAL
  order = CONSTANT
[]

[Mesh]
  type = GeneratedMesh
  dim = 1
  nx = 1
  allow_renumbering = false
[]

[FluidProperties]
  [fp]
    type = StiffenedGasFluidProperties
    gamma = 2.35
    q = -1167e3
    q_prime = 0
    p_inf = 1.e9
    cv = 1816
  []
[]

[AuxVariables]
  [mach_no]
  []
  [v]
    initial_condition = 1e-3
  []
  [e]
    initial_condition = 1e5
  []
  [vel]
    initial_condition = 10.
  []
[]

[AuxKernels]
  [mach_aux]
    type = MachNumberAux
    variable = mach_no
    vel = vel
    v = v
    e = e
    fp = fp
  []
[]

[Postprocessors]
  [mach_no]
    type = ElementalVariableValue
    variable = mach_no
    elementid = 0
  []
[]

[Problem]
  solve = false
[]

[Executioner]
  type = Transient
  dt = 1
  num_steps = 1
  abort_on_solve_fail = true
[]

[Outputs]
  csv = true
  execute_on = TIMESTEP_END
[]

Example usage :
Input Parameters
Input Files