BCs System

under construction:Undocumented System

The BCs system has not been documented. The content listed below should be used as a starting point for documenting the system, which includes the typical automatic documentation associated with a system; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.


# BCs System

## Overview

!! Replace this line with information regarding the BCs system.

## Example Input File Syntax

!! Describe and include an example of how to use the BCs system.

!syntax list /BCs objects=True actions=False subsystems=False

!syntax list /BCs objects=False actions=False subsystems=True

!syntax list /BCs objects=False actions=True subsystems=False

Available Objects

Moose App
ADDirichletBCImposes the essential boundary condition $var element = document.getElementById("moose-equation-8de319dc-aa85-4994-bc98-ade6ed6042cd");katex.render("u=g", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ , where $var element = document.getElementById("moose-equation-ef0607a3-beb5-4b84-ba42-b714eac03df5");katex.render("g", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ is a constant, controllable value.
ADFunctionDirichletBCImposes the essential boundary condition $var element = document.getElementById("moose-equation-3b3d769f-42fb-4be2-8230-d3135d03a2c7");katex.render("u=g", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ , where $var element = document.getElementById("moose-equation-c49e41a7-649d-4fb8-95eb-ffabb90ac7ec");katex.render("g", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ is calculated by a function.
ADFunctionNeumannBCImposes the integrated boundary condition $var element = document.getElementById("moose-equation-f3cbc9ee-a9b5-437c-8ed1-00d5f49dfe04");katex.render("\\frac{\\partial u}{\\partial n}=h(t,\\vec{x})", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ , where $var element = document.getElementById("moose-equation-91048f17-e3d6-4200-b36e-693731de52df");katex.render("h", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ is a (possibly) time and space-dependent MOOSE Function.
ADFunctionPresetBCThe same as ADFunctionDirichletBC except the value is applied before the solve begins
ADNeumannBCImposes the integrated boundary condition $var element = document.getElementById("moose-equation-dbe9c22a-0604-407e-9edd-7306d86b720a");katex.render("\\frac{\\partial u}{\\partial n}=h", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ , where $var element = document.getElementById("moose-equation-8948ee16-1517-4fab-b5ae-4071d87ffc62");katex.render("h", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ is a constant, controllable value.
ADPresetBCSimilar to ADDirichletBC except the value is applied before the solve begins. Deprecated: use ADDirichletBC with preset = true instead.
ADVectorFunctionDirichletBCImposes the essential boundary condition $var element = document.getElementById("moose-equation-11663a0f-aefa-4d59-bc38-36c455d92db2");katex.render("\\vec{u}=\\vec{g}", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ , where $var element = document.getElementById("moose-equation-33cc7353-befb-4183-97e0-3f49fd3b7d32");katex.render("\\vec{g}", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ components are calculated with functions.
ArrayDirichletBCImposes the essential boundary condition $var element = document.getElementById("moose-equation-c209d0cf-b3e2-4568-8884-c98158539cab");katex.render("\\vec{u}=\\vec{g}", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ , where $var element = document.getElementById("moose-equation-ce0d1166-2554-4eab-9789-c863792d46cf");katex.render("\\vec{g}", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ are constant, controllable values.
ArrayPenaltyDirichletBCEnforces a Dirichlet boundary condition in a weak sense with $var element = document.getElementById("moose-equation-304f10b3-b8fb-494d-8efc-8566935475c4");katex.render("p(\\vec{u}^\\ast, \\vec{u} - \\vec{u}_0)", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ , where $var element = document.getElementById("moose-equation-0959bc96-a94e-46f2-b7b1-56f9452cdd33");katex.render("p", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ is the constant scalar penalty; $var element = document.getElementById("moose-equation-73f4f4b4-41ff-4f9f-9b37-8e9cfe09ae93");katex.render("\\vec{u}^\\ast", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ is the test functions and $var element = document.getElementById("moose-equation-33668c5a-e104-49c1-afce-e90e0e821076");katex.render("\\vec{u} - \\vec{u}_0", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ is the differences between the current solution and the Dirichlet data.
ArrayVacuumBCImposes the Robin boundary condition $var element = document.getElementById("moose-equation-1a83e87a-6bdd-4f9a-9753-f7987473a378");katex.render("\\partial_n \\vec{u}=-\\frac{\\vec{\\alpha}}{2}\\vec{u}", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ .
ConvectiveFluxBCDetermines boundary values via the initial and final values, flux, and exposure duration
CoupledVarNeumannBCImposes the integrated boundary condition $var element = document.getElementById("moose-equation-badd7094-e60b-4ad7-b0a5-e01132ed635e");katex.render("\\frac{\\partial u}{\\partial n}=v", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ , where $var element = document.getElementById("moose-equation-0c21d6c2-bf15-4348-9bf4-ad18f446cfee");katex.render("v", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ is a variable.
DGFunctionDiffusionDirichletBC
DiffusionFluxBCComputes a boundary residual contribution consistent with the Diffusion Kernel. Does not impose a boundary condition; instead computes the boundary contribution corresponding to the current value of grad(u) and accumulates it in the residual vector.
DirichletBCImposes the essential boundary condition $var element = document.getElementById("moose-equation-a52e1a1c-f0a1-4b23-b19a-1273b7f6bc29");katex.render("u=g", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ , where $var element = document.getElementById("moose-equation-e17ab2a6-1513-4c7c-89fe-6658b9fc8d49");katex.render("g", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ is a constant, controllable value.
EigenDirichletBCDirichlet BC for eigenvalue solvers
FunctionDirichletBCImposes the essential boundary condition $var element = document.getElementById("moose-equation-fdfd6e20-62f9-4e37-a691-0a6f947b8123");katex.render("u=g(t,\\vec{x})", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ , where $var element = document.getElementById("moose-equation-f690ab59-d748-4f75-8162-18d9c9fad1c0");katex.render("g", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ is a (possibly) time and space-dependent MOOSE Function.
FunctionGradientNeumannBCImposes the integrated boundary condition arising from integration by parts of a diffusion/heat conduction operator, and where the exact solution can be specified.
FunctionNeumannBCImposes the integrated boundary condition $var element = document.getElementById("moose-equation-6475d318-dc7e-425f-bb82-c58039ffab12");katex.render("\\frac{\\partial u}{\\partial n}=h(t,\\vec{x})", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ , where $var element = document.getElementById("moose-equation-721c9f6d-1c54-4b29-bc33-207421f2c5af");katex.render("h", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ is a (possibly) time and space-dependent MOOSE Function.
FunctionPenaltyDirichletBC
FunctionPresetBCThe same as FunctionDirichletBC except the value is applied before the solve begins. Deprecated: use FunctionDirichletBC with preset = true instead.
LagrangeVecDirichletBCImposes the essential boundary condition $var element = document.getElementById("moose-equation-a37b7b78-02d8-4bb0-bb60-0cbf113bfd5b");katex.render("\\vec{u}=\\vec{g}", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ , where $var element = document.getElementById("moose-equation-db35dacc-d650-473d-8273-a958251e2251");katex.render("\\vec{g}", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ are constant, controllable values.
LagrangeVecFunctionDirichletBCImposes the essential boundary condition $var element = document.getElementById("moose-equation-7b7f7708-3c6e-42d8-803e-32b9e2b647df");katex.render("\\vec{u}=\\vec{g}", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ , where $var element = document.getElementById("moose-equation-b5ba1cee-c5df-4f52-a3ba-42a1883e4075");katex.render("\\vec{g}", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ components are calculated with functions.
MatchedValueBCImplements a NodalBC which equates two different Variables' values on a specified boundary.
NeumannBCImposes the integrated boundary condition $var element = document.getElementById("moose-equation-0a7fea09-542e-4392-924a-ffd3cc19d93b");katex.render("\\frac{\\partial u}{\\partial n}=h", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ , where $var element = document.getElementById("moose-equation-157dd064-ce60-4213-a4cc-e4a6abaa674d");katex.render("h", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ is a constant, controllable value.
OneDEqualValueConstraintBC
PenaltyDirichletBCEnforces a Dirichlet boundary condition in a weak sense by penalizing differences between the current solution and the Dirichlet data.
PostprocessorDirichletBC
PostprocessorNeumannBC
PresetBCSimilar to DirichletBC except the value is applied before the solve begins. Deprecated: use DirichletBC with preset = true instead.
SinDirichletBCImposes a time-varying essential boundary condition $var element = document.getElementById("moose-equation-d6195a2c-167f-48bb-b527-bef18594ecb6");katex.render("u=g(t)", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ , where $var element = document.getElementById("moose-equation-dfebe5ef-a7cb-4eea-ae95-ebcb443130d6");katex.render("g(t)", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ varies from an given initial value at time $var element = document.getElementById("moose-equation-9d896582-81b5-4acc-b17b-89ac4386e8ec");katex.render("t=0", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ to a given final value over a specified duration.
SinNeumannBCImposes a time-varying flux boundary condition $var element = document.getElementById("moose-equation-34323e2b-2d68-4bdc-bdb9-dc076d706fed");katex.render("\\frac{\\partial u}{\\partial n}=g(t)", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ , where $var element = document.getElementById("moose-equation-4031d6c1-f978-46dc-9caa-151a2920a725");katex.render("g(t)", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ varies from an given initial value at time $var element = document.getElementById("moose-equation-6ce48f77-f19f-4f3f-bf54-69abcd491757");katex.render("t=0", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ to a given final value over a specified duration.
VacuumBC
VectorDirichletBCImposes the essential boundary condition $var element = document.getElementById("moose-equation-3ca8d4a7-db87-4127-9d2f-9988a7a9563f");katex.render("\\vec{u}=\\vec{g}", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ , where $var element = document.getElementById("moose-equation-1918e03e-3645-4a9f-942c-f4fb0f3e6e56");katex.render("\\vec{g}", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ are constant, controllable values.
VectorFunctionDirichletBCImposes the essential boundary condition $var element = document.getElementById("moose-equation-33341cd8-2ded-4018-8e01-cc479bbce46f");katex.render("\\vec{u}=\\vec{g}", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ , where $var element = document.getElementById("moose-equation-d55cb076-8679-4741-96ad-65d973f90e8a");katex.render("\\vec{g}", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ components are calculated with functions.
VectorNeumannBCImposes the integrated boundary condition $var element = document.getElementById("moose-equation-29d04a24-8148-4a63-b646-b9c75c12b2da");katex.render("\\frac{\\partial u}{\\partial n}=\\vec{V}\\cdot\\hat{n}", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ , where $var element = document.getElementById("moose-equation-b98c5048-8361-48f8-bc19-639d09194be5");katex.render("\\vec{V}", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ is a user-defined, constant vector.
WeakGradientBCComputes a boundary residual contribution consistent with the Diffusion Kernel. Does not impose a boundary condition; instead computes the boundary contribution corresponding to the current value of grad(u) and accumulates it in the residual vector.
Heat Conduction App
ConvectiveFluxFunctionDetermines boundary value by fluid heat transfer coefficient and far-field temperature
CoupledConvectiveFlux
CoupledConvectiveHeatFluxBCConvective heat transfer boundary condition with temperature and heat transfer coefficent given by auxiliary variables.
GapHeatTransferTransfers heat across a gap between two surfaces dependent on the gap geometry specified.
GrayLambertNeumannBCThis BC imposes a heat flux density that is computed from the GrayLambertSurfaceRadiationBase userobject.
HeatConductionBC
InfiniteCylinderRadiativeBCBoundary condition for radiative heat exchange with a cylinderwhere the boundary is approximated as a cylinder as well.
Rdg App
AEFVBCA boundary condition kernel for the advection equation using a cell-centered finite volume method.
Functional Expansion Tools App
FXFluxBCSets a flux boundary condition, evaluated using a FunctionSeries instance. This does not fix the flux, but rather 'strongly encourages' flux agreement by penalizing the differences through contributions to the residual.
FXValueBCImposes a fixed value boundary condition, evaluated using a FunctionSeries instance.
FXValuePenaltyBCSets a value boundary condition, evaluated using a FunctionSeries instance. This does not fix the value, but rather 'strongly encourages' value agreement by penalizing the differences through contributions to the residual.
Navier Stokes App
AdvectionBCBoundary conditions for outflow/outflow of advected quantities: phi * velocity * normal, where phi is the advected quantitiy
EnergyFreeBC
INSMomentumNoBCBCLaplaceFormThis class implements the 'No BC' boundary condition based on the 'Laplace' form of the viscous stress tensor.
INSMomentumNoBCBCTractionFormThis class implements the 'No BC' boundary condition based on the 'traction' form of the viscous stress tensor.
INSTemperatureNoBCBCThis class implements the 'No BC' boundary condition discussed by Griffiths, Papanastiou, and others.
ImplicitNeumannBCThis class implements a form of the Neumann boundary condition in which the boundary term is treated 'implicitly'.
MassFreeBC
MomentumFreeBC
MomentumFreeSlipBC
NSEnergyInviscidSpecifiedBCThis class corresponds to the inviscid part of the 'natural' boundary condition for the energy equation.
NSEnergyInviscidSpecifiedDensityAndVelocityBCThis class corresponds to the inviscid part of the 'natural' boundary condition for the energy equation.
NSEnergyInviscidSpecifiedNormalFlowBCThis class corresponds to the inviscid part of the 'natural' boundary condition for the energy equation.
NSEnergyInviscidSpecifiedPressureBCThis class corresponds to the inviscid part of the 'natural' boundary condition for the energy equation.
NSEnergyInviscidUnspecifiedBCThis class corresponds to the inviscid part of the 'natural' boundary condition for the energy equation.
NSEnergyViscousBCThis class couples together all the variables for the compressible Navier-Stokes equations to allow them to be used in derived IntegratedBC classes.
NSEnergyWeakStagnationBCThe inviscid energy BC term with specified normal flow.
NSImposedVelocityBCImpose Velocity BC.
NSImposedVelocityDirectionBCThis class imposes a velocity direction component as a Dirichlet condition on the appropriate momentum equation.
NSInflowThermalBCThis class is used on a boundary where the incoming flow values (rho, u, v, T) are all completely specified.
NSMassSpecifiedNormalFlowBCThis class implements the mass equation boundary term with a specified value of rho*(u.n) imposed weakly.
NSMassUnspecifiedNormalFlowBCThis class implements the mass equation boundary term with the rho*(u.n) boundary integral computed implicitly.
NSMassWeakStagnationBCThe inviscid energy BC term with specified normal flow.
NSMomentumConvectiveWeakStagnationBCThe convective part (sans pressure term) of the momentum equation boundary integral evaluated at specified stagnation temperature, stagnation pressure, and flow direction values.
NSMomentumInviscidNoPressureImplicitFlowBCMomentum equation boundary condition used when pressure is not integrated by parts.
NSMomentumInviscidSpecifiedNormalFlowBCMomentum equation boundary condition in which pressure is specified (given) and the value of the convective part is allowed to vary (is computed implicitly).
NSMomentumInviscidSpecifiedPressureBCMomentum equation boundary condition in which pressure is specified (given) and the value of the convective part is allowed to vary (is computed implicitly).
NSMomentumPressureWeakStagnationBCThis class implements the pressure term of the momentum equation boundary integral for use in weak stagnation boundary conditions.
NSMomentumViscousBCThis class corresponds to the viscous part of the 'natural' boundary condition for the momentum equations.
NSPenalizedNormalFlowBCThis class penalizes the the value of u.n on the boundary so that it matches some desired value.
NSPressureNeumannBCThis kernel is appropriate for use with a 'zero normal flow' boundary condition in the context of the Euler equations.
NSStagnationPressureBCThis Dirichlet condition imposes the condition p_0 = p_0_desired.
NSStagnationTemperatureBCThis Dirichlet condition imposes the condition T_0 = T_0_desired.
NSThermalBCNS thermal BC.
Porous Flow App
PorousFlowHalfCubicSinkApplies a flux sink to a boundary. The base flux defined by PorousFlowSink is multiplied by a cubic.
PorousFlowHalfGaussianSinkApplies a flux sink to a boundary. The base flux defined by PorousFlowSink is multiplied by a Gaussian.
PorousFlowPiecewiseLinearSinkApplies a flux sink to a boundary. The base flux defined by PorousFlowSink is multiplied by a piecewise linear function.
PorousFlowSinkApplies a flux sink to a boundary.
XFEMApp
CrackTipEnrichmentCutOffBCImposes the essential boundary condition $var element = document.getElementById("moose-equation-43c7a1c4-da83-4ca1-855c-1a4678412143");katex.render("u=g", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ , where $var element = document.getElementById("moose-equation-12acff49-a4d0-4884-81e7-67e4abd9bc10");katex.render("g", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ is a constant, controllable value.
Tensor Mechanics App
ADPressureApplies a pressure on a given boundary in a given direction
CoupledPressureBCApplies a pressure from a variable on a given boundary in a given direction
DashpotBC
DisplacementAboutAxisImplements a boundary condition that enforces rotationaldisplacement around an axis on a boundary
InteractionIntegralBenchmarkBCImplements a boundary condition that enforces a displacement field around a crack tip based on applied stress intensity factors.
PenaltyInclinedNoDisplacementBCPenalty Enforcement of an inclined boundary condition
PresetAccelerationPrescribe acceleration on a given boundary in a given direction
PresetDisplacementPrescribe the displacement on a given boundary in a given direction.
PresetVelocity
PressureApplies a pressure on a given boundary in a given direction
StickyBCImposes the boundary condition $var element = document.getElementById("moose-equation-7763b4cc-0184-4e6e-9615-5f42f15c770c");katex.render("u = u_{old}", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ if $var element = document.getElementById("moose-equation-7b966cb6-835e-4271-b5e1-b3e05d83110c");katex.render("u_{old}", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ exceeds the bounds provided
Peridynamics App
RBMPresetOldValuePDClass to apply a preset BC to nodes with rigid body motion (RBM).
Chemical Reactions App
ChemicalOutFlowBCChemical flux boundary condition

Available Subsystems

Available Actions

Moose App
AddBCAction

Available Objects
Available Subsystems
Available Actions

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools

BCs System

Available Objects

Available Subsystems

Available Actions