BoundaryFluxPostprocessor.md|MOOSE

Computes the side integral of a flux entry from a BoundaryFluxBase user object

This post-processor is used to query flux vectors that are computed via objects derived from BoundaryFluxBase. It computes the side integral of the specified entry of the flux at a specified boundary.

This post-processor is useful for conservation tests because the inflow and outflow fluxes for a domain can be integrated. Note that in this case, one still needs to integrate the post-processor over time; this is done with the TotalVariableValue post-processor.

Input Parameters

boundaryThe list of boundary IDs from the mesh where this boundary condition applies
C++ Type:std::vector
Options:
Description:The list of boundary IDs from the mesh where this boundary condition applies
boundary_flux_uoBoundary flux user object name
C++ Type:UserObjectName
Options:
Description:Boundary flux user object name
flux_indexIndex within flux vector to query
C++ Type:unsigned int
Options:
Description:Index within flux vector to query
variablesVariables to pass to boundary flux user object, in the correct order
C++ Type:std::vector
Options:
Description:Variables to pass to boundary flux user object, in the correct order

Required Parameters

execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.
Default:TIMESTEP_END
C++ Type:ExecFlagEnum
Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM TRANSFER
Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.
normalNormal vector for boundary (if requesting override)
C++ Type:libMesh::Point
Options:
Description:Normal vector for boundary (if requesting override)

Optional 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
Options:
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).
control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector
Options:
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Options:
Description:Set the enabled status of the MooseObject.
outputsVector of output names were you would like to restrict the output of variables(s) associated with this object
C++ Type:std::vector
Options:
Description:Vector of output names were 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
Options:
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

Input Files

modules/rdg/test/tests/postprocessors/boundary_flux_postprocessor/boundary_flux_postprocessor.i

modules/rdg/test/tests/postprocessors/boundary_flux_postprocessor/boundary_flux_postprocessor.i

# This input file is used to test BoundaryFluxPostprocessor, which queries
# fluxes computed using user objects derived from BoundaryFluxBase. The boundary
# flux used in this test is TestBoundaryFlux, which expects a solution vector
# of size 3 (call this U = {A, B, C}) and computes a flux of size 2 with the
# following entries:
#
# flux[0] = (A - B) * C * nx
# flux[1] = A * B * nx
#
# where the normal vector used is {nx, ny, nz}.

A = 1
B = 2
C = 3

# Multiple cases are computed in this test. Each corresponds to a different PP object:
#   * flux0_boundary0: boundary 0, flux entry 0, default normal ({-1, 0, 0})
#   * flux0_boundary1: boundary 1, flux entry 0, default normal ({1, 0, 0})
#   * flux0_provided:  boundary 0, flux entry 0, user-provided normal ({2, 0, 0})
#   * flux1_boundary0: boundary 0, flux entry 1, default normal ({-1, 0, 0})

nx_boundary0 = -1
nx_boundary1 = 1
nx_provided  = 2

flux0_boundary0 = ${fparse (A - B) * C * nx_boundary0}
flux0_boundary1 = ${fparse (A - B) * C * nx_boundary1}
flux0_provided  = ${fparse (A - B) * C * nx_provided}
flux1_boundary0 = ${fparse A * B * nx_boundary0}

[GlobalParams]
  order = CONSTANT
  family = MONOMIAL
  execute_on = 'initial timestep_end'
  variables = 'A B C'
[]

[Postprocessors]
  [./flux0_boundary0]
    type = BoundaryFluxPostprocessor
    boundary_flux_uo = boundary_flux_flux0_boundary0
    boundary = 0
    flux_index = 0
  [../]
  [./flux0_boundary1]
    type = BoundaryFluxPostprocessor
    boundary_flux_uo = boundary_flux_flux0_boundary1
    boundary = 1
    flux_index = 0
  [../]
  [./flux0_provided]
    type = BoundaryFluxPostprocessor
    boundary_flux_uo = boundary_flux_flux0_provided
    boundary = 0
    flux_index = 0
    normal = '${nx_provided} 0 0'
  [../]
  [./flux1_boundary0]
    type = BoundaryFluxPostprocessor
    boundary_flux_uo = boundary_flux_flux1_boundary0
    boundary = 0
    flux_index = 1
  [../]

  [./flux0_boundary0_err]
    type = RelativeDifferencePostprocessor
    value1 = flux0_boundary0
    value2 = ${flux0_boundary0}
  [../]
  [./flux0_boundary1_err]
    type = RelativeDifferencePostprocessor
    value1 = flux0_boundary1
    value2 = ${flux0_boundary1}
  [../]
  [./flux0_provided_err]
    type = RelativeDifferencePostprocessor
    value1 = flux0_provided
    value2 = ${flux0_provided}
  [../]
  [./flux1_boundary0_err]
    type = RelativeDifferencePostprocessor
    value1 = flux1_boundary0
    value2 = ${flux1_boundary0}
  [../]
[]

[UserObjects]
  [./boundary_flux_flux0_boundary0]
    type = TestBoundaryFlux
  [../]
  [./boundary_flux_flux0_boundary1]
    type = TestBoundaryFlux
  [../]
  [./boundary_flux_flux0_provided]
    type = TestBoundaryFlux
  [../]
  [./boundary_flux_flux1_boundary0]
    type = TestBoundaryFlux
  [../]
[]

[Variables]
  [./A]
  [../]
  [./B]
  [../]
  [./C]
  [../]
[]

[ICs]
  [./A_ic]
    type = ConstantIC
    variable = A
    value = ${A}
  [../]
  [./B_ic]
    type = ConstantIC
    variable = B
    value = ${B}
  [../]
  [./C_ic]
    type = ConstantIC
    variable = C
    value = ${C}
  [../]
[]

[Mesh]
  type = GeneratedMesh
  dim = 1
[]

[Problem]
  kernel_coverage_check = false
  solve = false
[]

[Executioner]
  type = Transient
  scheme = implicit-euler
  dt = 1
  num_steps = 1
[]

[Outputs]
  csv = true
  show = 'flux0_boundary0_err flux0_boundary1_err flux0_provided_err flux1_boundary0_err'
[]

Input Parameters
Input Files

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools

Input Parameters

Required Parameters

Optional Parameters

Advanced Parameters

Input Files