FVBCs System

For an overview of MOOSE FV please see Finite Volume Design Decisions in MOOSE.

The finite volume method (FVM) distinguishes between two types of boundary conditions.

* FVDirichletBC prescribes values of the FVM variables on the boundary. This boundary condition acts similarly to Dirichlet boundary conditions in FEM but it is implemented using a ghost element method.

* FVFluxBC prescribes the flux on a boundary. This boundary condition is similar to integrated boundary conditions in FEM.

Currently, the FVDirichletBC category only contains a single class that applies a fixed value on the boundary. In the future, more specialized classes will be added.

FVBCs block

FVM boundary conditions are added to simulation input files in the FVBCs as in the example below.

Listing 1: Example of the FVBCs block in a MOOSE input file.

[FVBCs]
  [left]
    type = FVNeumannBC
    variable = v
    boundary = left
    value = 5
  []
  [right]
    type = FVDirichletBC
    variable = v
    boundary = right
    value = 42
  []
[]

In this example input, a diffusion equation with flux boundary conditions on the left and Dirichlet boundary conditions on the right is solved. To understand the differences between these two boundary conditions, let's start with the diffusion equation:

$var element = document.getElementById("moose-equation-20c8aeff-8be9-4dfc-89a2-36f4630fe243");katex.render(" - \\nabla \\cdot D \\nabla v = 0.", element, {displayMode:true,throwOnError:false});$

and the boundary conditions on the left:

$var element = document.getElementById("moose-equation-3c8d3d12-a7ee-40ce-b2b7-c3e70be0c468");katex.render(" - D \\nabla v \\cdot \\vec{n}= 5,", element, {displayMode:true,throwOnError:false});$

where $var element = document.getElementById("moose-equation-e9115df2-17e0-4d04-ba7e-4f0fcc860db5");katex.render("\\vec{n}", element, {displayMode:false,throwOnError:false});$ is the outward normal and on the right:

$var element = document.getElementById("moose-equation-a8988e0d-0647-4624-b563-a0bf7b754c71");katex.render(" v = 42.", element, {displayMode:true,throwOnError:false});$

For seeing how the flux boundary condition is applied, the diffusion equation is integrated over the extent of an element adjacent to the left boundary and Gauss' theorem is applied to the divergence:

$var element = document.getElementById("moose-equation-f3bbd829-8167-47e2-889b-2f735d2689fa");katex.render(" -\\int_{\\Omega} \\nabla \\cdot D \\nabla v dV = -\\int_{\\partial \\Omega_l} D \\nabla v \\cdot \\vec{n} dA -\\int_{\\partial \\Omega \\setminus \\partial \\Omega_l} D \\nabla v \\cdot \\vec{n} dA = 5 A_{\\partial \\Omega_l} -\\int_{\\partial \\Omega \\setminus \\partial \\Omega_l} D \\nabla v \\cdot \\vec{n} dA=0,", element, {displayMode:true,throwOnError:false});$

where $var element = document.getElementById("moose-equation-7c70d20b-7cd8-47ae-88fd-a62864322bc3");katex.render("\\Omega", element, {displayMode:false,throwOnError:false});$ is the element volume, $var element = document.getElementById("moose-equation-1c9bf7f2-2948-4472-96b5-787fb374b9cf");katex.render("\\partial \\Omega_l", element, {displayMode:false,throwOnError:false});$ are all faces that belong to the left sideset, $var element = document.getElementById("moose-equation-74cb9731-c41f-40b4-93b8-fc995f6d756c");katex.render("\\partial \\Omega", element, {displayMode:false,throwOnError:false});$ are all faces, and $var element = document.getElementById("moose-equation-fa783ba4-c937-4143-ab51-cda96c86503c");katex.render("A_{\\partial \\Omega_l}", element, {displayMode:false,throwOnError:false});$ is the area of face. Flux boundary conditions are applied by replacing appropriate terms in the FVM balance by the value of the flux prescribed on the boundary.

Dirichlet boundary conditions are applied differently. Let us first write a balance equation for an element that is adjacent to the right boundary:

$var element = document.getElementById("moose-equation-cd463e04-2e06-4216-a9b1-5f93c7448c98");katex.render(" -\\int_{\\partial \\Omega_r} D \\nabla v \\cdot \\vec{n} dA -\\int_{\\partial \\Omega \\setminus \\partial \\Omega_r} D \\nabla v \\cdot \\vec{n} dA =0,", element, {displayMode:true,throwOnError:false});$

MOOSE uses the ghost element method to apply Dirichlet boundary conditions for FVM. The process of using a ghost elements is the following:

Place a virtual element across the Dirichlet boundary.
Compute the value of $var element = document.getElementById("moose-equation-5de7fe48-9f47-43ca-a137-0ed174efb632");katex.render("v", element, {displayMode:false,throwOnError:false});$ in the ghost element as the extrapolation of the element value and the desired value on the boundary.
Assign the value of $var element = document.getElementById("moose-equation-442ec4cb-b694-4b59-b789-fc1c5a64be01");katex.render("v", element, {displayMode:false,throwOnError:false});$ in the ghost element.
Evaluate the numerical fluxes as if you were on an interior face.

For implementing the ghost element method an extrapolation must be selected. Currently, MOOSE FVM only supports linear extrapolation. If the value of the Dirichlet boundary condition is denoted by $var element = document.getElementById("moose-equation-4398a49a-7614-45d0-9063-dc3670e00918");katex.render("v_D", element, {displayMode:false,throwOnError:false});$ and the value in the element is denoted by $var element = document.getElementById("moose-equation-accab68d-2067-4e1f-8aab-f49c014e4989");katex.render("v_E", element, {displayMode:false,throwOnError:false});$ , then the ghost element value $var element = document.getElementById("moose-equation-86003f95-188b-403f-ae20-1edb05dc827d");katex.render("v_G", element, {displayMode:false,throwOnError:false});$ is:

$var element = document.getElementById("moose-equation-1e465974-ba5d-4ea1-904f-5f4aee07cad8");katex.render(" v_G = 2 v_D - v_E.", element, {displayMode:true,throwOnError:false});$

The parameters available in boundary conditions are equivalent to FEM boundary conditions and are not discussed in detail here.

FVBCs source code: FVDirichletBC

FVDirichletBC objects assigns a constant value on a boundary. Implementation of a FVM Dirichlet boundary condition usually only requires overriding the boundaryValue method. The boundaryValue method must return the value of the variable on the Dirichlet boundary.

Listing 2: Example source code for FVDirichletBC.

#include "FVDirichletBC.h"

registerMooseObject("MooseApp", FVDirichletBC);

InputParameters
FVDirichletBC::validParams()
{
  InputParameters params = FVDirichletBCBase::validParams();
  params.addClassDescription("Defines a Dirichlet boundary condition for finite volume method.");
  params.addRequiredParam<Real>("value", "value to enforce at the boundary face");
  return params;
}

FVDirichletBC::FVDirichletBC(const InputParameters & parameters)
  : FVDirichletBCBase(parameters), _val(getParam<Real>("value"))
{
}

ADReal
FVDirichletBC::boundaryValue(const FaceInfo & /*fi*/, const Moose::StateArg & /*state*/) const
{
  return _val;
}

FVBCs source code: FVFluxBC

FVNeumannBC objects assign a constant flux on a boundary. Implementation of a flux boundary condition usually only requires overriding the computeQpResidual() method. FVNeumannBC reads a constant value from the parameters and then returns it in computeQpResidual().

Listing 3: Example source code for FVNeumannBC.

#include "FVNeumannBC.h"

registerMooseObject("MooseApp", FVNeumannBC);

InputParameters
FVNeumannBC::validParams()
{
  InputParameters params = FVFluxBC::validParams();
  params.addClassDescription("Neumann boundary condition for finite volume method.");
  params.addParam<Real>("value", 0.0, "The value of the flux crossing the boundary.");
  return params;
}

FVNeumannBC::FVNeumannBC(const InputParameters & parameters)
  : FVFluxBC(parameters), _value(getParam<Real>("value"))
{
}

ADReal
FVNeumannBC::computeQpResidual()
{
  return -_value;
}

FVBCs source code: FVBurgersOutflowBC

Flux boundary conditions can be more complicated than assigning a constant value. In this example, the outflow contribution for the Burgers' equation is computed. The relevant term is (note 1D):

$var element = document.getElementById("moose-equation-a553f4e3-1604-4796-a89d-4638b5084c9f");katex.render("\\frac{1}{2} \\int \\frac{\\partial}{\\partial x}v^2 dx = \\frac{1}{2} \\left(v^2_R n_R + v^2_L n_L\\right),", element, {displayMode:true,throwOnError:false});$

where $var element = document.getElementById("moose-equation-94e36278-40ff-4378-8138-87cdb4d8a807");katex.render("v_R", element, {displayMode:false,throwOnError:false});$ and $var element = document.getElementById("moose-equation-8e1aa176-b8c7-4962-97b8-87241892dfe0");katex.render("v_L", element, {displayMode:false,throwOnError:false});$ are the values of $var element = document.getElementById("moose-equation-21c0fdd9-3793-460e-bc7b-4804c91d90c8");katex.render("v", element, {displayMode:false,throwOnError:false});$ on the left and right boundaries of the element and $var element = document.getElementById("moose-equation-0bace61b-7c3f-4fc2-a6f0-00acb438b0f6");katex.render("n_R", element, {displayMode:false,throwOnError:false});$ and $var element = document.getElementById("moose-equation-b5d17330-5121-4ce1-ad64-7311f64ad69e");katex.render("n_L", element, {displayMode:false,throwOnError:false});$ are the outward normals on these faces. Let's assume that the left side is a boundary face where the FVBurgersOutflowBC is applied. On that boundary we have $var element = document.getElementById("moose-equation-a7670a2c-4bbc-470a-b7c7-4b5365ec8e46");katex.render("n_L = -1", element, {displayMode:false,throwOnError:false});$ . The FVBurgersOutflowBC boundary condition uses upwinding, i.e. it uses the element value $var element = document.getElementById("moose-equation-98aa62b4-0236-41da-a6a6-a9127820bf97");katex.render("v", element, {displayMode:false,throwOnError:false});$ as boundary values on outflow faces.

The code listed below first checks if the left is actually an outflow side by using the cell value of the $var element = document.getElementById("moose-equation-1166c6ab-d26e-4ae4-8b4c-9d5ed36eb68a");katex.render("v", element, {displayMode:false,throwOnError:false});$ (element average, upwinding!) and dotting it with the normal. If $var element = document.getElementById("moose-equation-dc5fe0ee-8e81-4724-8044-929cd6454542");katex.render("v n_L > 0", element, {displayMode:false,throwOnError:false});$ , then the left is an outflow side. In this case the contribution $var element = document.getElementById("moose-equation-3cfb703c-3a6d-465b-a369-e306cae9548f");katex.render("1/2 v^2 n_L", element, {displayMode:false,throwOnError:false});$ is added, otherwise no contribution is added.

Listing 4: Outflow boundary condition for the Burgers' equation.

FVBurgersOutflowBC::computeQpResidual()
{
  mooseAssert(_face_info->elem().dim() == 1, "FVBurgersOutflowBC works only in 1D");

  ADReal r = 0;
  // only add this on outflow faces
  if (_u[_qp] * _normal(0) > 0)
    r = 0.5 * _u[_qp] * _u[_qp] * _normal(0);
  return r;
}

In this case, the boundary condition does not represent a fixed inflow, but rather a free outflow condition.

Available Objects

Moose App
FVADFunctorDirichletBCUses the value of a functor to set a Dirichlet boundary value.
FVBoundaryIntegralValueConstraintThis class is used to enforce integral of phi = boundary area * phi_0 with a Lagrange multiplier approach.
FVConstantScalarOutflowBCConstant velocity scalar advection boundary conditions for finite volume method.
FVDirichletBCDefines a Dirichlet boundary condition for finite volume method.
FVFunctionDirichletBCImposes the essential boundary condition $var element = document.getElementById("moose-equation-49330d78-57b3-4f38-a60a-cac8dba34a55");katex.render("u=g(t,\\vec{x})", element, {displayMode:false,throwOnError:false});$ , where $var element = document.getElementById("moose-equation-3c7c0040-3ea3-4e58-9b03-bd8ceeb79c3f");katex.render("g", element, {displayMode:false,throwOnError:false});$ is a (possibly) time and space-dependent MOOSE Function.
FVFunctionNeumannBCNeumann boundary condition for finite volume method.
FVFunctorDirichletBCUses the value of a functor to set a Dirichlet boundary value.
FVFunctorNeumannBCNeumann boundary condition for the finite volume method.
FVNeumannBCNeumann boundary condition for finite volume method.
FVOrthogonalBoundaryDiffusionImposes an orthogonal diffusion boundary term with specified boundary function.
FVPostprocessorDirichletBCDefines a Dirichlet boundary condition for finite volume method.

(moose/test/tests/fvkernels/fv_simple_diffusion/neumann.i)

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 10
  ny = 10
[]

[Variables]
  [u]
  []
  [v]
    family = MONOMIAL
    order = CONSTANT
    fv = true
  []
[]

[Kernels]
  [diff]
    type = ADDiffusion
    variable = u
  []
[]

[FVKernels]
  [diff]
    type = FVDiffusion
    variable = v
    coeff = coeff
  []
[]

[FVBCs]
  [left]
    type = FVNeumannBC
    variable = v
    boundary = left
    value = 5
  []
  [right]
    type = FVDirichletBC
    variable = v
    boundary = right
    value = 42
  []
[]

[Materials]
  [diff]
    type = ADGenericFunctorMaterial
    prop_names = 'coeff'
    prop_values = '1'
  []
[]

[BCs]
  [left]
    type = ADNeumannBC
    variable = u
    boundary = left
    value = 5
  []
  [right]
    type = ADDirichletBC
    variable = u
    boundary = right
    value = 42
  []
[]

[Executioner]
  type = Steady
  solve_type = 'PJFNK'
  petsc_options_iname = '-pc_type -pc_hypre_type'
  petsc_options_value = 'hypre boomeramg'
[]

[Outputs]
  exodus = true
[]

(moose/framework/src/fvbcs/FVDirichletBC.C)

// This file is part of the MOOSE framework
// https://www.mooseframework.org
//
// All rights reserved, see COPYRIGHT for full restrictions
// https://github.com/idaholab/moose/blob/master/COPYRIGHT
//
// Licensed under LGPL 2.1, please see LICENSE for details
// https://www.gnu.org/licenses/lgpl-2.1.html

#include "FVDirichletBC.h"

registerMooseObject("MooseApp", FVDirichletBC);

InputParameters
FVDirichletBC::validParams()
{
  InputParameters params = FVDirichletBCBase::validParams();
  params.addClassDescription("Defines a Dirichlet boundary condition for finite volume method.");
  params.addRequiredParam<Real>("value", "value to enforce at the boundary face");
  return params;
}

FVDirichletBC::FVDirichletBC(const InputParameters & parameters)
  : FVDirichletBCBase(parameters), _val(getParam<Real>("value"))
{
}

ADReal
FVDirichletBC::boundaryValue(const FaceInfo & /*fi*/, const Moose::StateArg & /*state*/) const
{
  return _val;
}

(moose/framework/src/fvbcs/FVNeumannBC.C)

// This file is part of the MOOSE framework
// https://www.mooseframework.org
//
// All rights reserved, see COPYRIGHT for full restrictions
// https://github.com/idaholab/moose/blob/master/COPYRIGHT
//
// Licensed under LGPL 2.1, please see LICENSE for details
// https://www.gnu.org/licenses/lgpl-2.1.html

#include "FVNeumannBC.h"

registerMooseObject("MooseApp", FVNeumannBC);

InputParameters
FVNeumannBC::validParams()
{
  InputParameters params = FVFluxBC::validParams();
  params.addClassDescription("Neumann boundary condition for finite volume method.");
  params.addParam<Real>("value", 0.0, "The value of the flux crossing the boundary.");
  return params;
}

FVNeumannBC::FVNeumannBC(const InputParameters & parameters)
  : FVFluxBC(parameters), _value(getParam<Real>("value"))
{
}

ADReal
FVNeumannBC::computeQpResidual()
{
  return -_value;
}

(moose/test/src/fvbcs/FVBurgersOutflowBC.C)

// This file is part of the MOOSE framework
// https://www.mooseframework.org
//
// All rights reserved, see COPYRIGHT for full restrictions
// https://github.com/idaholab/moose/blob/master/COPYRIGHT
//
// Licensed under LGPL 2.1, please see LICENSE for details
// https://www.gnu.org/licenses/lgpl-2.1.html

#include "FVBurgersOutflowBC.h"

registerMooseObject("MooseTestApp", FVBurgersOutflowBC);

InputParameters
FVBurgersOutflowBC::validParams()
{
  InputParameters params = FVFluxBC::validParams();
  return params;
}

FVBurgersOutflowBC::FVBurgersOutflowBC(const InputParameters & parameters) : FVFluxBC(parameters) {}

ADReal
FVBurgersOutflowBC::computeQpResidual()
{
  mooseAssert(_face_info->elem().dim() == 1, "FVBurgersOutflowBC works only in 1D");

  ADReal r = 0;
  // only add this on outflow faces
  if (_u[_qp] * _normal(0) > 0)
    r = 0.5 * _u[_qp] * _u[_qp] * _normal(0);
  return r;
}

FVBCs block
FVBCs source code : FVDirichletBC
FVBCs source code : FVFluxBC
FVBCs source code : FVBurgersOutflowBC
Available Objects