FVMatAdvection

Computes the residual of advective term using finite volume method.

The FVMatAdvection kernel is similar to the FVAdvection kernel except that:

the velocity is a material property instead of a constant vector, so it may vary throughout the domain
an advected quantity

In order to solve for the velocity, one needs to add a VariableMaterial, such as the INSFVMaterial to store a copy of the velocity variable as a material property.

As we are expanding the functor material & variable capability, having the velocity as a material property will no longer be required.

Example input syntax

In this example, the kernels are set up for a steady state advection problem of both momentum and mass. For the former the advected_quantity is set to the momentum. This case uses a constant unit density. Please refer to the Navier Stokes module for more advanced fluid flow capabilities.

[FVKernels]
  # del * rho * velocity * velocity
  [adv_rho_u]
    type = FVMatAdvection
    variable = fv_vel
    vel = 'fv_velocity'
    advected_quantity = 'rho_u'
  []

  # del * rho * velocity
  [adv_rho]
    type = FVMatAdvection
    variable = fv_rho
    vel = 'fv_velocity'
  []
[]

Input Parameters

variableThe name of the finite volume variable this kernel applies to
C++ Type:NonlinearVariableName
Controllable:No
Description:The name of the finite volume variable this kernel applies to
veladvection velocity
C++ Type:MooseFunctorName
Controllable:No
Description:advection velocity

Required Parameters

advected_interp_methodupwindThe interpolation to use for the advected quantity. Options are 'upwind', 'average', and 'skewness-corrected' with the default being 'upwind'.
Default:upwind
C++ Type:MooseEnum
Options:average, upwind, skewness-corrected
Controllable:No
Description:The interpolation to use for the advected quantity. Options are 'upwind', 'average', and 'skewness-corrected' with the default being 'upwind'.
advected_quantityAn optional parameter for specifying an advected quantity from a material property. If this is not specified, then the advected quantity will simply be the variable that this object is acting on
C++ Type:MooseFunctorName
Controllable:No
Description:An optional parameter for specifying an advected quantity from a material property. If this is not specified, then the advected quantity will simply be the variable that this object is acting on
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
boundaries_to_forceThe set of boundaries to force execution of this FVFluxKernel on.
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The set of boundaries to force execution of this FVFluxKernel on.
boundaries_to_not_forceThe set of boundaries to not force execution of this FVFluxKernel on.
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The set of boundaries to not force execution of this FVFluxKernel on.
force_boundary_executionFalseWhether to force execution of this object on the boundary.
Default:False
C++ Type:bool
Controllable:No
Description:Whether to force execution of this object on the boundary.
ghost_layers1The number of layers of elements to ghost.
Default:1
C++ Type:unsigned short
Controllable:No
Description:The number of layers of elements to ghost.
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
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_point_neighborsFalseWhether to use point neighbors, which introduces additional ghosting to that used for simple face neighbors.
Default:False
C++ Type:bool
Controllable:No
Description:Whether to use point neighbors, which introduces additional ghosting to that used for simple face neighbors.

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.
implicitTrueDetermines whether this object is calculated using an implicit or explicit form
Default:True
C++ Type:bool
Controllable:No
Description:Determines whether this object is calculated using an implicit or explicit form
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

extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
C++ Type:std::vector<TagName>
Controllable:No
Description:The extra tags for the matrices this Kernel should fill
extra_vector_tagsThe extra tags for the vectors this Kernel should fill
C++ Type:std::vector<TagName>
Controllable:No
Description:The extra tags for the vectors this Kernel should fill
matrix_tagssystemThe tag for the matrices this Kernel should fill
Default:system
C++ Type:MultiMooseEnum
Options:nontime, system
Controllable:No
Description:The tag for the matrices this Kernel should fill
vector_tagsnontimeThe tag for the vectors this Kernel should fill
Default:nontime
C++ Type:MultiMooseEnum
Options:nontime, time
Controllable:No
Description:The tag for the vectors this Kernel should fill

Tagging Parameters

Input Files

(test/tests/variables/caching_fv_variables/fv_caching.i)
(test/tests/fvkernels/mms/mat-advection-diffusion.i)
(test/tests/fvkernels/mms/mass-mom-mat-advection-diffusion/input.i)
(test/tests/fvkernels/fv_euler/fv_euler.i)
(test/tests/fvkernels/mms/mat-advection.i)

(test/tests/fvkernels/fv_euler/fv_euler.i)

[Mesh]
  [gen]
    type = GeneratedMeshGenerator
    dim = 1
    nx = 20
  []
[]

[Variables]
  # we have to impose non-zero initial conditions in order to avoid an initially
  # singular matrix
  [fv_vel]
    order = CONSTANT
    family = MONOMIAL
    fv = true
    initial_condition = 2
  []
  [fv_rho]
    order = CONSTANT
    family = MONOMIAL
    fv = true
    initial_condition = 2
  []
[]

[FVKernels]
  # del * rho * velocity * velocity
  [adv_rho_u]
    type = FVMatAdvection
    variable = fv_vel
    vel = 'fv_velocity'
    advected_quantity = 'rho_u'
  []

  # del * rho * velocity
  [adv_rho]
    type = FVMatAdvection
    variable = fv_rho
    vel = 'fv_velocity'
  []
[]


[FVBCs]
  [left_vel]
    type = FVDirichletBC
    variable = fv_vel
    value = 1
    boundary = 'left'
  []
  [left_rho]
    type = FVDirichletBC
    variable = fv_rho
    value = 1
    boundary = 'left'
  []

  # del * rho * velocity * velocity
  [right_vel]
    type = FVMatAdvectionOutflowBC
    variable = fv_vel
    vel = 'fv_velocity'
    advected_quantity = 'rho_u'
    boundary = 'right'
  []

  # del * rho * velocity
  [adv_rho]
    type = FVMatAdvectionOutflowBC
    variable = fv_rho
    vel = 'fv_velocity'
    boundary = 'right'
  []
[]

[Materials]
  [euler_material]
    type = ADCoupledVelocityMaterial
    vel_x = fv_vel
    rho = fv_rho
    velocity = 'fv_velocity'
  []
[]

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

[Outputs]
  [out]
    type = Exodus
    execute_on = 'final'
  []
[]

(test/tests/variables/caching_fv_variables/fv_caching.i)

[Mesh]
  [cmg]
    type = CartesianMeshGenerator
    dim = 2
    dx = '1.5 2.4 0.1'
    dy = '1.3 0.9'
    ix = '2 1 1'
    iy = '2 3'
    subdomain_id = '0 1 1 2 2 2'
  []
[]

[Variables]
  [u]
    type = MooseVariableFVReal
  []
[]

[FVKernels]
  [diff]
    type = FVDiffusion
    variable = u
    coeff = 1
  []

  [adv]
    type = FVMatAdvection
    variable = u
    vel = v_mat
  []

  [body_force]
    type = FVBodyForce
    variable = u
    value = 10
  []
[]

[FVBCs]
  [left]
    type = FVDirichletBC
    variable = u
    boundary = 'left'
    value = 1
  []

  [right]
    type = FVDirichletBC
    variable = u
    boundary = 'right'
    value = 1
  []

  [top]
    type = FVNeumannBC
    variable = u
    value = 1
    boundary = 'top'
  []
[]

[Materials]
  [v_mat]
    type = ADGenericVectorFunctorMaterial
    prop_names = 'v_mat'
    prop_values = '4 0 0'
  []
[]

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

[Outputs]
  exodus = true
[]

(test/tests/fvkernels/mms/mat-advection-diffusion.i)

diff=1.1
a=1.1

[GlobalParams]
  advected_interp_method = 'average'
[]

[Mesh]
  [./gen_mesh]
    type = GeneratedMeshGenerator
    dim = 1
    xmin = -0.6
    xmax = 0.6
    nx = 64
  [../]
[]

[Variables]
  [./v]
    family = MONOMIAL
    order = CONSTANT
    fv = true
  [../]
[]

[FVKernels]
  [./advection]
    type = FVMatAdvection
    variable = v
    vel = 'fv_velocity'
  [../]
  [./diffusion]
    type = FVDiffusion
    variable = v
    coeff = coeff
  [../]
  [body_v]
    type = FVBodyForce
    variable = v
    function = 'forcing'
  []
[]

[FVBCs]
  [boundary]
    type = FVFunctionDirichletBC
    boundary = 'left right'
    function = 'exact'
    variable = v
  []
[]

[Materials]
  [diff]
    type = ADGenericFunctorMaterial
    prop_names = 'coeff'
    prop_values = '${diff}'
  []
  [adv_material]
    type = ADCoupledVelocityMaterial
    vel_x = '${a}'
    rho = 'v'
    velocity = 'fv_velocity'
  []
[]

[Functions]
  [exact]
    type = ParsedFunction
    value = '3*x^2 + 2*x + 1'
  []
  [forcing]
    type = ParsedFunction
    value = '-${diff}*6 + ${a} * (6*x + 2)'
    # value = '-${diff}*6'
  []
[]

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

[Outputs]
  exodus = true
  csv = true
[]

[Postprocessors]
  [./error]
    type = ElementL2Error
    variable = v
    function = exact
    outputs = 'console csv'
    execute_on = 'timestep_end'
  [../]
  [h]
    type = AverageElementSize
    outputs = 'console csv'
    execute_on = 'timestep_end'
  []
[]

(test/tests/fvkernels/mms/mass-mom-mat-advection-diffusion/input.i)

[Mesh]
  [gen]
    type = GeneratedMeshGenerator
    dim = 1
    nx = 2
    xmin = -.6
    xmax = .6
  []
[]

[GlobalParams]
  advected_interp_method = 'average'
[]

[Variables]
  [fv_rho]
    order = CONSTANT
    family = MONOMIAL
    fv = true
    initial_condition = 2
  []
  [fv_vel]
    order = CONSTANT
    family = MONOMIAL
    fv = true
    initial_condition = 2
  []
[]

[FVKernels]
  [adv_rho]
    type = FVMatAdvection
    variable = fv_rho
    vel = 'fv_velocity'
  []

  [diff_rho]
    type = FVDiffusion
    variable = fv_rho
    coeff = coeff
  []

  [forcing_rho]
    type = FVBodyForce
    variable = fv_rho
    function = 'forcing_rho'
  []

  [adv_rho_u]
    type = FVMatAdvection
    variable = fv_vel
    vel = 'fv_velocity'
    advected_quantity = 'rho_u'
  []

  [diff_vel]
    type = FVDiffusion
    variable = fv_vel
    coeff = coeff
  []


  [forcing_vel]
    type = FVBodyForce
    variable = fv_vel
    function = 'forcing_vel'
  []
[]

[FVBCs]
  [boundary_rho]
    type = FVFunctionDirichletBC
    boundary = 'left right'
    function = 'exact_rho'
    variable = fv_rho
  []
  [boundary_vel]
    type = FVFunctionDirichletBC
    boundary = 'left right'
    function = 'exact_vel'
    variable = fv_vel
  []
[]

[Materials]
  [euler_material]
    type = ADCoupledVelocityMaterial
    vel_x = fv_vel
    rho = fv_rho
    velocity = 'fv_velocity'
  []
  [diff]
    type = ADGenericFunctorMaterial
    prop_names = 'coeff'
    prop_values = '1'
  []
[]

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

[Outputs]
  csv = true
  exodus = true
[]

[Functions]
  [forcing_rho]
    type = ParsedFunction
    value = '-1.331*sin(1.1*x)^2 + 1.331*sin(1.1*x) + 1.331*cos(1.1*x)^2'
  []
  [exact_rho]
    type = ParsedFunction
    value = '1.1*sin(1.1*x)'
  []
  [forcing_vel]
    type = ParsedFunction
    value = '-2.9282*sin(1.1*x)^2*cos(1.1*x) + 1.4641*cos(1.1*x)^3 + 1.331*cos(1.1*x)'
  []
  [exact_vel]
    type = ParsedFunction
    value = '1.1*cos(1.1*x)'
  []
[]

[Postprocessors]
  [./l2_rho]
    type = ElementL2Error
    variable = fv_rho
    function = exact_rho
    outputs = 'console csv'
    execute_on = 'timestep_end'
  [../]
  [./l2_vel]
    type = ElementL2Error
    variable = fv_vel
    function = exact_vel
    outputs = 'console csv'
    execute_on = 'timestep_end'
  [../]
  [h]
    type = AverageElementSize
    outputs = 'console csv'
    execute_on = 'timestep_end'
  []
[]

(test/tests/fvkernels/fv_euler/fv_euler.i)

[Mesh]
  [gen]
    type = GeneratedMeshGenerator
    dim = 1
    nx = 20
  []
[]

[Variables]
  # we have to impose non-zero initial conditions in order to avoid an initially
  # singular matrix
  [fv_vel]
    order = CONSTANT
    family = MONOMIAL
    fv = true
    initial_condition = 2
  []
  [fv_rho]
    order = CONSTANT
    family = MONOMIAL
    fv = true
    initial_condition = 2
  []
[]

[FVKernels]
  # del * rho * velocity * velocity
  [adv_rho_u]
    type = FVMatAdvection
    variable = fv_vel
    vel = 'fv_velocity'
    advected_quantity = 'rho_u'
  []

  # del * rho * velocity
  [adv_rho]
    type = FVMatAdvection
    variable = fv_rho
    vel = 'fv_velocity'
  []
[]


[FVBCs]
  [left_vel]
    type = FVDirichletBC
    variable = fv_vel
    value = 1
    boundary = 'left'
  []
  [left_rho]
    type = FVDirichletBC
    variable = fv_rho
    value = 1
    boundary = 'left'
  []

  # del * rho * velocity * velocity
  [right_vel]
    type = FVMatAdvectionOutflowBC
    variable = fv_vel
    vel = 'fv_velocity'
    advected_quantity = 'rho_u'
    boundary = 'right'
  []

  # del * rho * velocity
  [adv_rho]
    type = FVMatAdvectionOutflowBC
    variable = fv_rho
    vel = 'fv_velocity'
    boundary = 'right'
  []
[]

[Materials]
  [euler_material]
    type = ADCoupledVelocityMaterial
    vel_x = fv_vel
    rho = fv_rho
    velocity = 'fv_velocity'
  []
[]

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

[Outputs]
  [out]
    type = Exodus
    execute_on = 'final'
  []
[]

(test/tests/fvkernels/mms/mat-advection.i)

a=1.1

[GlobalParams]
  advected_interp_method = 'average'
[]

[Mesh]
  [./gen_mesh]
    type = GeneratedMeshGenerator
    dim = 1
    xmin = -0.6
    xmax = 0.6
    nx = 2
  [../]
[]

[Variables]
  [./v]
    family = MONOMIAL
    order = CONSTANT
    fv = true
  [../]
[]

[FVKernels]
  [./advection]
    type = FVMatAdvection
    variable = v
    vel = 'fv_velocity'
  [../]
  [body_v]
    type = FVBodyForce
    variable = v
    function = 'forcing'
  []
[]

[FVBCs]
  [boundary]
    type = FVMatAdvectionFunctionBC
    boundary = 'left right'
    variable = v
    vel = 'fv_velocity'
    flux_variable_exact_solution = 'exact'
    vel_x_exact_solution = '${a}'
  []
[]

[Materials]
  [adv_material]
    type = ADCoupledVelocityMaterial
    vel_x = '${a}'
    rho = 'v'
    velocity = 'fv_velocity'
  []
[]

[Functions]
  [exact]
    type = ParsedFunction
    value = '1.1 * sin(1.1 * x)'
  []
  [forcing]
    type = ParsedFunction
    value = '${a} * 1.1 * 1.1 * cos(1.1 * x)'
  []
[]

[Executioner]
  type = Steady
  solve_type = 'NEWTON'
  petsc_options_iname = '-pc_type -sub_pc_factor_shift_type'
  petsc_options_value = 'asm      NONZERO'
[]

[Outputs]
  exodus = true
  csv = true
[]

[Postprocessors]
  [./error]
    type = ElementL2Error
    variable = v
    function = exact
    outputs = 'console csv'
    execute_on = 'timestep_end'
  [../]
  [h]
    type = AverageElementSize
    outputs = 'console csv'
    execute_on = 'timestep_end'
  []
[]

Example input syntax
Input Parameters
Input Files

Install MOOSE

New Users

Examples and Tutorials

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools

INL Applications and Remote Access