BoundaryLinearFVFluxIntegral

Computes the boundary integral of boundary flux contributions from one or more LinearFVFluxKernel objects (e.g. LinearFVDiffusion, LinearFVAdvection). Let $var element = document.getElementById("moose-equation-51f3cbff-f3b7-4fd1-b3ce-171d9eff388f");katex.render("F_k(u)", element, {displayMode:false,throwOnError:false});$ denote the boundary flux computed by kernel $var element = document.getElementById("moose-equation-d0bf61f1-6a2b-4c39-a10b-1a9d34125ae8");katex.render("k", element, {displayMode:false,throwOnError:false});$ . This postprocessor computes

$var element = document.getElementById("moose-equation-647f43e0-7ce8-4f66-bb85-cc6c84ff90e1");katex.render("\\int_S \\sum_k^{N} F_k(u)\\, dS,", element, {displayMode:true,throwOnError:false});$

where $var element = document.getElementById("moose-equation-c0361ab3-57f7-4616-bf89-eaa86c051dff");katex.render("N", element, {displayMode:false,throwOnError:false});$ is the number of kernels listed in "linearfvkernels" and $var element = document.getElementById("moose-equation-b30d588e-9ad7-4134-9dd4-a29c187f8f8e");katex.render("S", element, {displayMode:false,throwOnError:false});$ is the selected sideset.

note

All kernels listed in "linearfvkernels" must act on the same linear FV variable name, and that variable must have a LinearFVBoundaryCondition on every boundary listed for this postprocessor. This is a requirement at the moment because we would like to avoid summing fluxes from different variables/equations.

note

Furthermore, we don't support flux evaluation for internal sidesets (internal to the domain of definition of the linearFV kernels) at the moment. This kernel is supposed to serve as a boundary flux evaluator.

Example Input Syntax

[Postprocessors<<<{"href": "../../syntax/Postprocessors/index.html"}>>>]
  [flux_left_total]
    type = BoundaryLinearFVFluxIntegral<<<{"description": "Computes the side integral of selected LinearFVFluxKernel boundary flux contributions.", "href": "BoundaryLinearFVFluxIntegral.html"}>>>
    boundary<<<{"description": "The list of boundary IDs from the mesh where this object applies"}>>> = left
    linearfvkernels<<<{"description": "List of LinearFVFluxKernels whose boundary fluxes are integrated."}>>> = 'diffusion advection'
  []
  [flux_left_diff]
    type = BoundaryLinearFVFluxIntegral<<<{"description": "Computes the side integral of selected LinearFVFluxKernel boundary flux contributions.", "href": "BoundaryLinearFVFluxIntegral.html"}>>>
    boundary<<<{"description": "The list of boundary IDs from the mesh where this object applies"}>>> = left
    linearfvkernels<<<{"description": "List of LinearFVFluxKernels whose boundary fluxes are integrated."}>>> = 'diffusion'
  []
  [flux_left_adv]
    type = BoundaryLinearFVFluxIntegral<<<{"description": "Computes the side integral of selected LinearFVFluxKernel boundary flux contributions.", "href": "BoundaryLinearFVFluxIntegral.html"}>>>
    boundary<<<{"description": "The list of boundary IDs from the mesh where this object applies"}>>> = left
    linearfvkernels<<<{"description": "List of LinearFVFluxKernels whose boundary fluxes are integrated."}>>> = 'advection'
  []
  [flux_right_total]
    type = BoundaryLinearFVFluxIntegral<<<{"description": "Computes the side integral of selected LinearFVFluxKernel boundary flux contributions.", "href": "BoundaryLinearFVFluxIntegral.html"}>>>
    boundary<<<{"description": "The list of boundary IDs from the mesh where this object applies"}>>> = right
    linearfvkernels<<<{"description": "List of LinearFVFluxKernels whose boundary fluxes are integrated."}>>> = 'diffusion advection'
  []
  [flux_right_diff]
    type = BoundaryLinearFVFluxIntegral<<<{"description": "Computes the side integral of selected LinearFVFluxKernel boundary flux contributions.", "href": "BoundaryLinearFVFluxIntegral.html"}>>>
    boundary<<<{"description": "The list of boundary IDs from the mesh where this object applies"}>>> = right
    linearfvkernels<<<{"description": "List of LinearFVFluxKernels whose boundary fluxes are integrated."}>>> = 'diffusion'
  []
  [flux_right_adv]
    type = BoundaryLinearFVFluxIntegral<<<{"description": "Computes the side integral of selected LinearFVFluxKernel boundary flux contributions.", "href": "BoundaryLinearFVFluxIntegral.html"}>>>
    boundary<<<{"description": "The list of boundary IDs from the mesh where this object applies"}>>> = right
    linearfvkernels<<<{"description": "List of LinearFVFluxKernels whose boundary fluxes are integrated."}>>> = 'advection'
  []
  [flux_left_sum_error]
    type = ParsedPostprocessor<<<{"description": "Computes a parsed expression with post-processors", "href": "ParsedPostprocessor.html"}>>>
    expression<<<{"description": "function expression"}>>> = 'f_total - f_diff - f_adv'
    pp_names<<<{"description": "Post-processors arguments"}>>> = 'flux_left_total flux_left_diff flux_left_adv'
    pp_symbols<<<{"description": "Symbol associated with each post-processor argument"}>>> = 'f_total f_diff f_adv'
  []
  [flux_right_sum_error]
    type = ParsedPostprocessor<<<{"description": "Computes a parsed expression with post-processors", "href": "ParsedPostprocessor.html"}>>>
    expression<<<{"description": "function expression"}>>> = 'f_total - f_diff - f_adv'
    pp_names<<<{"description": "Post-processors arguments"}>>> = 'flux_right_total flux_right_diff flux_right_adv'
    pp_symbols<<<{"description": "Symbol associated with each post-processor argument"}>>> = 'f_total f_diff f_adv'
  []
  [flux_balance]
    type = ParsedPostprocessor<<<{"description": "Computes a parsed expression with post-processors", "href": "ParsedPostprocessor.html"}>>>
    expression<<<{"description": "function expression"}>>> = 'f_left + f_right'
    pp_names<<<{"description": "Post-processors arguments"}>>> = 'flux_left_total flux_right_total'
    pp_symbols<<<{"description": "Symbol associated with each post-processor argument"}>>> = 'f_left f_right'
  []
  # These are the analytic solutions, when we refine we get closer and closer
  [analytic_flux_left_adv]
    type = ParsedPostprocessor<<<{"description": "Computes a parsed expression with post-processors", "href": "ParsedPostprocessor.html"}>>>
    expression<<<{"description": "function expression"}>>> = '-v'
    constant_names<<<{"description": "Vector of constants used in the parsed function (use this for kB etc.)"}>>> = 'v'
    constant_expressions<<<{"description": "Vector of values for the constants in constant_names (can be an FParser expression)"}>>> = '0.5'
  []
  [analytic_flux_left_diff]
    type = ParsedPostprocessor<<<{"description": "Computes a parsed expression with post-processors", "href": "ParsedPostprocessor.html"}>>>
    expression<<<{"description": "function expression"}>>> = '-v / (exp(v / k * L) - 1)'
    constant_names<<<{"description": "Vector of constants used in the parsed function (use this for kB etc.)"}>>> = 'v k L'
    constant_expressions<<<{"description": "Vector of values for the constants in constant_names (can be an FParser expression)"}>>> = '0.5 0.5 1'
  []
  [analytic_flux_right_adv]
    type = ParsedPostprocessor<<<{"description": "Computes a parsed expression with post-processors", "href": "ParsedPostprocessor.html"}>>>
    expression<<<{"description": "function expression"}>>> = '0'
  []
  [analytic_flux_right_diff]
    type = ParsedPostprocessor<<<{"description": "Computes a parsed expression with post-processors", "href": "ParsedPostprocessor.html"}>>>
    expression<<<{"description": "function expression"}>>> = 'v * exp(v / k * L) / (exp(v / k * L) - 1)'
    constant_names<<<{"description": "Vector of constants used in the parsed function (use this for kB etc.)"}>>> = 'v k L'
    constant_expressions<<<{"description": "Vector of values for the constants in constant_names (can be an FParser expression)"}>>> = '0.5 0.5 1'
  []
[]

Input Parameters

boundaryThe list of boundary IDs from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The list of boundary IDs from the mesh where this object applies
linearfvkernelsList of LinearFVFluxKernels whose boundary fluxes are integrated.
C++ Type:std::vector<std::string>
Controllable:No
Description:List of LinearFVFluxKernels whose boundary fluxes are integrated.

Required Parameters

allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
Default:False
C++ Type:bool
Controllable:No
Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
execute_onTIMESTEP_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:TIMESTEP_END
C++ Type:ExecFlagEnum
Options: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, TRANSFER
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.
execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
Default:0
C++ Type:int
Controllable:No
Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
force_postauxFalseForces the UserObject to be executed in POSTAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in POSTAUX
force_preauxFalseForces the UserObject to be executed in PREAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREAUX
force_preicFalseForces the UserObject to be executed in PREIC during initial setup
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREIC during initial setup

Execution Scheduling 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.
outputsVector of output names where you would like to restrict the output of variables(s) associated with this object
C++ Type:std::vector<OutputName>
Controllable:No
Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object
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

(moose/test/tests/postprocessors/linearfv_flux_integral/linearfv_flux_integral.i)

[Mesh]
  [gmg]
    type = GeneratedMeshGenerator
    dim = 1
    nx = 100
  []
[]

[Problem]
  linear_sys_names = 'u_sys'
[]

[Variables]
  [u]
    type = MooseLinearVariableFVReal
    solver_sys = 'u_sys'
    initial_condition = 0.25
  []
[]

[FVInterpolationMethods]
  [upwind]
    type = FVAdvectedUpwind
  []
[]

[LinearFVKernels]
  [diffusion]
    type = LinearFVDiffusion
    variable = u
    diffusion_coeff = 0.5
    use_nonorthogonal_correction = false
  []
  [advection]
    type = LinearFVAdvection
    variable = u
    velocity = '0.5 0 0'
    advected_interp_method_name = upwind
  []
[]

[LinearFVBCs]
  [left]
    type = LinearFVAdvectionDiffusionFunctorDirichletBC
    variable = u
    boundary = left
    functor = 1
  []
  [right]
    type = LinearFVAdvectionDiffusionFunctorDirichletBC
    variable = u
    boundary = right
    functor = 0
  []
[]

[Postprocessors]
  [flux_left_total]
    type = BoundaryLinearFVFluxIntegral
    boundary = left
    linearfvkernels = 'diffusion advection'
  []
  [flux_left_diff]
    type = BoundaryLinearFVFluxIntegral
    boundary = left
    linearfvkernels = 'diffusion'
  []
  [flux_left_adv]
    type = BoundaryLinearFVFluxIntegral
    boundary = left
    linearfvkernels = 'advection'
  []
  [flux_right_total]
    type = BoundaryLinearFVFluxIntegral
    boundary = right
    linearfvkernels = 'diffusion advection'
  []
  [flux_right_diff]
    type = BoundaryLinearFVFluxIntegral
    boundary = right
    linearfvkernels = 'diffusion'
  []
  [flux_right_adv]
    type = BoundaryLinearFVFluxIntegral
    boundary = right
    linearfvkernels = 'advection'
  []
  [flux_left_sum_error]
    type = ParsedPostprocessor
    expression = 'f_total - f_diff - f_adv'
    pp_names = 'flux_left_total flux_left_diff flux_left_adv'
    pp_symbols = 'f_total f_diff f_adv'
  []
  [flux_right_sum_error]
    type = ParsedPostprocessor
    expression = 'f_total - f_diff - f_adv'
    pp_names = 'flux_right_total flux_right_diff flux_right_adv'
    pp_symbols = 'f_total f_diff f_adv'
  []
  [flux_balance]
    type = ParsedPostprocessor
    expression = 'f_left + f_right'
    pp_names = 'flux_left_total flux_right_total'
    pp_symbols = 'f_left f_right'
  []
  # These are the analytic solutions, when we refine we get closer and closer
  [analytic_flux_left_adv]
    type = ParsedPostprocessor
    expression = '-v'
    constant_names = 'v'
    constant_expressions = '0.5'
  []
  [analytic_flux_left_diff]
    type = ParsedPostprocessor
    expression = '-v / (exp(v / k * L) - 1)'
    constant_names = 'v k L'
    constant_expressions = '0.5 0.5 1'
  []
  [analytic_flux_right_adv]
    type = ParsedPostprocessor
    expression = '0'
  []
  [analytic_flux_right_diff]
    type = ParsedPostprocessor
    expression = 'v * exp(v / k * L) / (exp(v / k * L) - 1)'
    constant_names = 'v k L'
    constant_expressions = '0.5 0.5 1'
  []
[]

[Executioner]
  type = Steady
  system_names = u_sys
  l_tol = 1e-12
  l_abs_tol = 1e-12
  petsc_options_iname = '-pc_type'
  petsc_options_value = 'lu'
[]

[Outputs]
  csv = true
  execute_on = timestep_end
[]

Example Input Syntax
Input Parameters