SATauStabilized3Eqn

This is the material class used to add the turbulent diffusion strong residual contribution for the stabilization of the energy equation.

Overview

This material class computes strong residuals for the temperature advection-diffusion equation and adjusts the $var element = document.getElementById("moose-equation-cb8ab777-8636-470b-a720-72fabd57a9c9");katex.render("\\tau", element, {displayMode:false,throwOnError:false});$ stabilization parameter for use in pressure-stabilized (PSPG) and streamline-upwind (SUPG) kernels. SATauStabilized3Eqn includes all functionality from INSADStabilized3Eqn for thermal-hydraulics modeling with INSAD kernels from the MOOSE Navier-Stokes physics module and SATauMaterial for Spalart-Allmaras turbulence modeling.

Example Input File Syntax

Input Parameters

mu_tildeSpalart-Allmaras turbulence viscosity variable
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Spalart-Allmaras turbulence viscosity variable
pressureThe pressure
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The pressure
temperatureThe temperature
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The temperature
velocityThe velocity
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The velocity
wall_distance_varWall distance aux variable name
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Wall distance aux variable name

Required Parameters

alpha1Multiplicative factor on the stabilization parameter tau.
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Multiplicative factor on the stabilization parameter tau.
blockThe list of blocks (ids or names) that this object will be applied
C++ Type:std::vector<SubdomainName>
Unit:(no unit assumed)
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>
Unit:(no unit assumed)
Controllable:No
Description:The list of boundaries (ids or names) from the mesh where this object applies
computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.
constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
Default:NONE
C++ Type:MooseEnum
Unit:(no unit assumed)
Options:NONE, ELEMENT, SUBDOMAIN
Controllable:No
Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
cp_namecpThe name of the specific heat capacity
Default:cp
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:The name of the specific heat capacity
declare_suffixAn optional suffix parameter that can be appended to any declared 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 declared properties. The suffix will be prepended with a '_' character.
grad_k_namegrad_kthe name of the gradient of the thermal conductivity material property
Default:grad_k
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:the name of the gradient of the thermal conductivity material property
k_namekthe name of the thermal conductivity material property
Default:k
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:the name of the thermal conductivity material property
mu_namemuThe name of the dynamic viscosity
Default:mu
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:The name of the dynamic viscosity
prandtl_number0.85Turbulent Prandtl number
Default:0.85
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Turbulent Prandtl number
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.
rho_namerhoThe name of the density
Default:rho
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:The name of the density
use_ft2_termFalseWhether to apply the f_t2 term in the equation
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether to apply the f_t2 term in the equation
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
Unit:(no unit assumed)
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.

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
Controllable:Yes
Description:Set the enabled status of the MooseObject.
implicitTrueDetermines whether this object is calculated using an implicit or explicit form
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Determines whether this object is calculated using an implicit or explicit form
seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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

output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:List of material properties, from this material, to output (outputs must also be defined to an output type)
outputsnone Vector of output names where you would like to restrict the output of variables(s) associated with this object
Default:none
C++ Type:std::vector<OutputName>
Unit:(no unit assumed)
Controllable:No
Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

Outputs Parameters

Input Files

(tests/sa-model/heat_turbulent_diffusion.i)
(tests/sa-model/channel_flow_with_heat.i)

(tests/sa-model/heat_turbulent_diffusion.i)

[GlobalParams]
  pressure = p
  velocity = vel
[]

[Mesh]
  [gmg]
    type = GeneratedMeshGenerator
    dim = 2
    nx = 10
    ny = 10
  []
[]

[Variables]
  [temp]
  []
[]

[AuxVariables]
  [mu_tilde]
    initial_condition = 1
  []
  [vel]
    family = LAGRANGE_VEC
    order = FIRST
  []
  [p]
  []
  [wall_dist]
  []
[]

[Kernels]
  [turbulent_diffusion]
    type = INSADEnergyTurbulentDiffusion
    variable = temp
    mu_tilde = mu_tilde
  []
[]

[BCs]
  [left]
    type = ADDirichletBC
    variable = temp
    boundary = 'left'
    value = 1
  []
  [right]
    type = ADDirichletBC
    variable = temp
    boundary = 'right'
    value = 0
  []
[]

[Materials]
  [const_mat]
    type = ADGenericConstantMaterial
    prop_names = 'cp rho mu k grad_k'
    prop_values = '1 1 1 1 0'
  []
  [sa_mat]
    type = SATauStabilized3Eqn
    alpha = 0.33333
    mu_tilde = mu_tilde
    wall_distance_var = wall_dist
    use_ft2_term = true
    temperature = temp
  []
[]

[Executioner]
  type = Steady
  solve_type = 'NEWTON'
[]

[Outputs]
  [exodus]
    type = Exodus
    execute_on = final
  []
[]

[Debug]
  show_var_residual_norms = true
[]

(tests/sa-model/channel_flow_with_heat.i)

Re = 1.375e4
density = 1      # kg cm-3
D = 1
inlet = 1
viscosity = '${fparse density * inlet * D / Re}'    # dynamic viscosity, mu = nu * rho, kg cm-1 s-1
alpha = 0.33333           # INS SUPG and PSPG stabilization parameter
cp = 1
k = '${fparse viscosity * cp / 0.85}'

[GlobalParams]
  integrate_p_by_parts = false
  viscous_form = 'traction'
  pressure = p
  velocity = vel
  temperature = temp
[]

[Mesh]
  [channel]
    type = CartesianMeshGenerator
    dim = 2
    dx = '0.05 0.2 19.75'
    dy = '0.3 0.1 0.05 0.05'
    ix = '20 1 79'
    iy = '10 5 5 10'
  []
  [corner_node]
    type = ExtraNodesetGenerator
    input = channel
    new_boundary = 'pinned_node'
    coord = '20 0.5'
  []
[]

[Problem]
  type = FEProblem
[]

[Variables]
  [vel]
    family = LAGRANGE_VEC
    order = FIRST
  []
  [p]
  []
  [mu_tilde]
    initial_condition = '${fparse viscosity * 5}'
  []
  [temp]
    initial_condition = 300
  []
[]

[AuxVariables]
  [mu_turbulence]
  []
  [wall_dist]
  []
  [velx]
  []
  [vely]
  []
  [wall_shear_stress]
    family = MONOMIAL
    order = CONSTANT
  []
  [turbulent_stress]
    family = MONOMIAL
    order = CONSTANT
  []
[]

[Kernels]
  [mass]
    type = INSADMass
    variable = p
  []
  [mass_pspg]
    type = INSADMassPSPG
    variable = p
  []

  [momentum_advection]
    type = INSADMomentumAdvection
    variable = vel
  []
  [momentum_viscous]
    type = INSADMomentumViscous
    variable = vel
  []
  [momentum_turbulent_viscous]
    type = INSADMomentumTurbulentViscous
    variable = vel
    mu_tilde = mu_tilde
  []
  [momentum_pressure]
    type = INSADMomentumPressure
    variable = vel
  []
  [momentum_supg]
    type = INSADMomentumSUPG
    variable = vel
  []
  [momentum_time]
    type = INSADMomentumTimeDerivative
    variable = vel
  []

  [mu_tilde_time]
    type = SATimeDerivative
    variable = mu_tilde
  []
  [mu_tilde_space]
    type = SATurbulentViscosity
    variable = mu_tilde
  []
  [mu_tilde_supg]
    type = SATurbulentViscositySUPG
    variable = mu_tilde
  []

  [temperature_advection]
    type = INSADEnergyAdvection
    variable = temp
  []
  [temp_conduction]
    type = ADHeatConduction
    variable = temp
    thermal_conductivity = 'k'
  []
  [temp_turbulent_diffusion]
    type = INSADEnergyTurbulentDiffusion
    variable = temp
    mu_tilde = mu_tilde
  []
  [temp_source]
    type = INSADEnergySource
    variable = temp
    source_function = '1'
  []
  [temp_supg]
    type = INSADEnergySUPG
    variable = temp
  []
  [temp_time]
    type = INSADHeatConductionTimeDerivative
    variable = temp
  []
[]

[AuxKernels]
  [mu_space]
    type = SATurbulentViscosityAux
    variable = mu_turbulence
    mu_tilde = mu_tilde
  []
  [wall_distance]
    type = WallDistanceAux
    variable = wall_dist
    walls = 'top'
    execute_on = initial
  []
  [velx]
    type = VectorVariableComponentAux
    variable = velx
    vector_variable = vel
    component = x
  []
  [vely]
    type = VectorVariableComponentAux
    variable = vely
    vector_variable = vel
    component = y
  []
  [wall_shear_stress]
    type = WallShearStressAux
    variable = wall_shear_stress
    boundary = top
  []
  [turbulent_stress]
    type = TurbulentStressAux
    variable = turbulent_stress
    mu_tilde = mu_tilde
  []
[]

[Functions]
  [xfunc]
    type = ParsedFunction
    expression = '${fparse inlet}'
  []
  [mu_func]
    type = ParsedFunction
    expression = 'if(y=0.5, 0, ${fparse viscosity * 5})'
  []
[]

[ICs]
  [velocity]
    type = VectorFunctionIC
    function_x = xfunc
    function_y = 0
    variable = vel
  []
[]

[BCs]
  [no_slip]
    type = ADVectorFunctionDirichletBC
    variable = vel
    boundary = 'top'
    function_x = 0
    function_y = 0
  []
  [inlet]
    type = ADVectorFunctionDirichletBC
    variable = vel
    boundary = 'left'
    function_x = xfunc
    function_y = 0
  []
  [outlet]
    type = INSADMomentumTurbulentNoBCBC
    variable = vel
    boundary = 'right'
    mu_tilde = mu_tilde
  []
  [outlet_supg]
    type = INSADMomentumSUPGBC
    variable = vel
    boundary = 'right'
  []
  [outlet_pspg]
    type = INSADMassPSPGBC
    variable = p
    boundary = 'right'
  []
  [symmetry]
    type = ADVectorFunctionDirichletBC
    variable = vel
    boundary = 'bottom'
    set_x_comp = false
    function_y = 0
  []

  [pressure_pin]
    type = DirichletBC
    variable = p
    boundary = 'pinned_node'
    value = 0
  []

  [mu_inlet]
    type = FunctionDirichletBC
    variable = mu_tilde
    boundary = 'left'
    function = mu_func
  []
  [mu_wall]
    type = DirichletBC
    variable = mu_tilde
    boundary = 'top'
    value = 0
  []
  [mu_outlet]
    type = SATurbulentViscosityNoBCBC
    variable = mu_tilde
    boundary = 'right'
  []
  [mu_outlet_supg]
    type = SATurbulentViscositySUPGBC
    variable = mu_tilde
    boundary = 'right'
  []

  [temperature_inlet]
    type = DirichletBC
    variable = temp
    boundary = 'left'
    value = 300
  []
[]

[Materials]
  [ad_mat]
    type = ADGenericConstantMaterial
    prop_names = 'rho mu cp k grad_k'
    prop_values = '${density} ${viscosity} ${cp} ${k} 0'
  []
  [sa_mat]
    type = SATauStabilized3Eqn
    alpha = ${alpha}
    mu_tilde = mu_tilde
    wall_distance_var = wall_dist
    use_ft2_term = true
  []
[]

[Executioner]
  type = Transient
  end_time = 30

  solve_type = 'NEWTON'
  petsc_options = '-snes_converged_reason -ksp_converged_reason -snes_linesearch_monitor'
  petsc_options_iname = '-pc_type -pc_factor_shift_type -pc_factor_mat_solver_package'
  petsc_options_value = 'lu       NONZERO               superlu_dist'
  line_search = none

  automatic_scaling = true
  compute_scaling_once = false
  resid_vs_jac_scaling_param = 0.1
  off_diagonals_in_auto_scaling = true

  nl_rel_tol = 1e-8
  nl_abs_tol = 1e-13
  nl_max_its = 10

  dtmin = 1
  dtmax = 10
  [TimeStepper]
    type = IterationAdaptiveDT
    dt = 1
    cutback_factor = 0.9
    growth_factor = 1.2
    optimal_iterations = 6
    iteration_window = 1
    linear_iteration_ratio = 1000
  []
[]

[Preconditioning]
  [SMP]
    type = SMP
    full = true
  []
[]

[Outputs]
  [exodus]
    type = Exodus
    execute_on = final
  []
[]

[Debug]
  show_var_residual_norms = true
[]

Overview
Example Input File Syntax
Input Parameters
Input Files