AdvectiveFluxAux

Compute components of flux vector for advection problems $var element = document.getElementById("moose-equation-f1b43e8d-e518-4820-99b2-5fb55622308d");katex.render("(\\vec{J} \\cdot \\vec{n} = \\vec{v} u \\cdot \\vec{n})", element, {displayMode:false,throwOnError:false});$ .

Description

The AdvectiveFluxAux AuxKernel is used to compute a component of an advective flux vector. The flux is computed as

var element = document.getElementById("moose-equation-79dea294-72c8-433f-8b2d-da0f71df106c");katex.render("\\vec{J} \\cdot \\vec{n} = \\vec{v} u \\cdot \\vec{n}", element, {displayMode:true,throwOnError:false});

where $var element = document.getElementById("moose-equation-95cf088a-ef64-484b-8bfa-6ffa97400278");katex.render("\\vec{J}", element, {displayMode:false,throwOnError:false});$ is the advection flux vector, $var element = document.getElementById("moose-equation-8c91fe29-df25-4c71-b6b0-2f811ebdac44");katex.render("u", element, {displayMode:false,throwOnError:false});$ is the advected quantity, $var element = document.getElementById("moose-equation-a1901a27-d3c2-405d-b242-d4680a115e09");katex.render("\\vec{v}", element, {displayMode:false,throwOnError:false});$ is the velocity, and $var element = document.getElementById("moose-equation-94f976cc-9bb4-4cec-b76a-1be09b8cb6bf");katex.render("\\vec{n}", element, {displayMode:false,throwOnError:false});$ is the normal for the desired component which can be the x, y, z axis or the normal direction (only near boundaries).

This auxkernel supports CONSTANT and FIRST MONOMIAL AuxVariable types. The advection velocity is required with "vel_x" for advection flux calculation. "vel_y" and "vel_z" are needed for 2D and 3D simulations. The advected quantity can be either a variable "advected_variable" or material property "advected_mat_prop".

warning

The expression of the advective flux in this object is generic, as described, and may differ from the advective flux implemented in your physics implementation. If so, you may not use this object to compute the advective flux.

Example Input Syntax

[AuxKernels]
  [flux_x]
    type = AdvectiveFluxAux
    variable = flux_x
    vel_x = u
    vel_y = v
    advected_mat_prop = 'rho'
    component = x
    boundary = 'block_2_right block_2_left'
  []
[]

Input Parameters

componentThe desired component of flux.
C++ Type:MooseEnum
Unit:(no unit assumed)
Options:x, y, z, normal
Controllable:No
Description:The desired component of flux.
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
vel_xx-component of the advecting velocity. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
C++ Type:MooseFunctorName
Unit:(no unit assumed)
Controllable:No
Description:x-component of the advecting velocity. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.

Required Parameters

advected_mat_prop0The advected material property of which to study the flow; useful for finite element simulations
Default:0
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:The advected material property of which to study the flow; useful for finite element simulations
advected_variable0The name of the variable. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
Default:0
C++ Type:MooseFunctorName
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
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
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
Options:NONE, INITIAL, LINEAR, NONLINEAR_CONVERGENCE, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, 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.
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
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.
vel_yy-component of the advecting velocity. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
C++ Type:MooseFunctorName
Unit:(no unit assumed)
Controllable:No
Description:y-component of the advecting velocity. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
vel_zz-component of the advecting velocity. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
C++ Type:MooseFunctorName
Unit:(no unit assumed)
Controllable:No
Description:z-component of the advecting velocity. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.

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.
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

(moose/test/tests/auxkernels/advection_flux/advection_flux_fe.i)

[Mesh]
  [cmg]
    type = CartesianMeshGenerator
    dim = 2
    dx = '0.75 0.75 0.75'
    dy = '0.75 0.75 0.75'
    ix = '2 2 2'
    iy = '2 2 2'
    subdomain_id = '1 1 1
                    1 2 1
                    1 1 1'
  []
  [add_inner_boundaries_top]
    type = SideSetsAroundSubdomainGenerator
    input = cmg
    new_boundary = 'block_2_top'
    block = 2
    normal = '0 1 0'
  []
  [add_inner_boundaries_bot]
    type = SideSetsAroundSubdomainGenerator
    input = add_inner_boundaries_top
    new_boundary = 'block_2_bot'
    block = 2
    normal = '0 -1 0'
  []
  [add_inner_boundaries_right]
    type = SideSetsAroundSubdomainGenerator
    input = add_inner_boundaries_bot
    new_boundary = 'block_2_right'
    block = 2
    normal = '1 0 0'
  []
  [add_inner_boundaries_left]
    type = SideSetsAroundSubdomainGenerator
    input = add_inner_boundaries_right
    new_boundary = 'block_2_left'
    block = 2
    normal = '-1 0 0'
  []
[]

[Variables]
  [u]
  []
  [v]
  []
[]

[ICs]
  [u_blob]
    type = FunctionIC
    variable = u
    function = 'if(x<0.75,if(y<0.75,1,0),0)'
  []

  [v_blob]
    type = FunctionIC
    variable = v
    function = 'if(x<0.75,if(y<0.75,1,0),0)'
  []
[]

[Kernels]
  [udot]
    type = MassLumpedTimeDerivative
    variable = u
  []
  [u_advec]
    type = ConservativeAdvection
    variable = u
    upwinding_type = full
    velocity = '2 0 0'
  []

  [vdot]
    type = MassLumpedTimeDerivative
    variable = v
  []
  [v_advec]
    type = ConservativeAdvection
    variable = v
    upwinding_type = full
    velocity = '0 2 0'
  []
[]

[Materials]
  [rho]
    type = GenericConstantMaterial
    prop_names = 'rho'
    prop_values = '1'
  []
[]

[AuxVariables]
  [flux_x]
    order = FIRST
    family = MONOMIAL
  []
[]

[AuxKernels]
  [flux_x]
    type = AdvectiveFluxAux
    variable = flux_x
    vel_x = u
    vel_y = v
    advected_mat_prop = 'rho'
    component = x
    boundary = 'block_2_right block_2_left'
  []
[]

[Executioner]
  type = Transient
  solve_type = LINEAR
  dt = 0.01
  end_time = 0.02
  l_tol = 1E-14
[]

[Postprocessors]
  [flux_right]
    type = SideIntegralVariablePostprocessor
    variable = flux_x
    boundary = 'block_2_right'
  []
  [flux_right_exact]
    type = SideAdvectiveFluxIntegral
    boundary = 'block_2_right'
    vel_x = u
    vel_y = v
    component = x
    advected_mat_prop = 'rho'
  []
  [flux_left]
    type = SideIntegralVariablePostprocessor
    variable = flux_x
    boundary = 'block_2_left'
  []
  [flux_left_exact]
    type = SideAdvectiveFluxIntegral
    boundary = 'block_2_left'
    vel_x = u
    vel_y = v
    component = x
    advected_mat_prop = 'rho'
  []
[]

[Outputs]
   csv = true
[]

Description
Example Input Syntax
Input Parameters