FunctorNeumannBC

Imposes the integrated boundary condition $var element = document.getElementById("moose-equation-6c90b8ba-879c-447d-9c64-2590c68bbcad");katex.render("\\frac{\\partial u}{\\partial n}=h(t,\\vec{x})", element, {displayMode:false,throwOnError:false});$ , where $var element = document.getElementById("moose-equation-16c393a9-2bf1-47d3-b7f2-93025da3084b");katex.render("h", element, {displayMode:false,throwOnError:false});$ is a functor.

Description

FunctorNeumannBC is a generalization of ADNeumannBC which is used for imposing flux boundary conditions on systems of partial differential equations (PDEs) where the flux is represented by a spatially- and temporally-varying MOOSE Function. That is, for a PDE of the form $var element = document.getElementById("moose-equation-ed3a8c2e-4547-4799-aaaf-4597e2167771");katex.render("\\begin{aligned} -\\nabla^2 u &= f && \\quad \\in \\Omega \\\\ u &= g(t,\\vec{x}) && \\quad \\in \\partial \\Omega_D \\\\ \\frac{\\partial u}{\\partial n} &= h(t,\\vec{x}) && \\quad \\in \\partial \\Omega_N, \\end{aligned}", element, {displayMode:true,throwOnError:false});$ where $var element = document.getElementById("moose-equation-903e8525-552b-41d5-ad15-cc2b423971d6");katex.render("\\Omega \\subset \\mathbb{R}^n", element, {displayMode:false,throwOnError:false});$ is the domain, and $var element = document.getElementById("moose-equation-7b771f41-1578-47f5-975d-4e1105fca917");katex.render("\\partial \\Omega = \\partial \\Omega_D \\cup \\partial \\Omega_N", element, {displayMode:false,throwOnError:false});$ is its boundary, a FunctorNeumannBC object can be used to impose the third condition if the function is well-defined for all relevant times and $var element = document.getElementById("moose-equation-e0dea03e-e173-42d9-b7f9-7d864f29259a");katex.render("\\vec{x} \\in \\partial \\Omega_N", element, {displayMode:false,throwOnError:false});$ . In this case, the parameters "functor" and "coefficient" are functors, whose product represents the mathematical function $var element = document.getElementById("moose-equation-4f2da3d9-1834-4667-b0c1-3bc425bb7968");katex.render("h(t,\\vec{x})", element, {displayMode:false,throwOnError:false});$ (or $var element = document.getElementById("moose-equation-c0d078a7-a768-4bad-88f2-c31b550f13ba");katex.render("-h(t,\\vec{x})", element, {displayMode:false,throwOnError:false});$ if "flux_is_inward" is set to false), and the user must define one or more sidesets corresponding to the boundary subset $var element = document.getElementById("moose-equation-99ccc89b-9e47-4e6e-97d5-8aec008b531d");katex.render("\\partial \\Omega_N", element, {displayMode:false,throwOnError:false});$ via the "boundary" parameter.

Input Parameters

boundaryThe list of boundary IDs from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Unit:(no unit assumed)
Controllable:No
Description:The list of boundary IDs from the mesh where this object applies
functorThe functor to impose. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
C++ Type:MooseFunctorName
Unit:(no unit assumed)
Controllable:No
Description:The functor to impose. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
variableThe name of the variable that this residual object operates on
C++ Type:NonlinearVariableName
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable that this residual object operates on

Required Parameters

coefficient1An optional functor coefficient to multiply the imposed functor. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
Default:1
C++ Type:MooseFunctorName
Unit:(no unit assumed)
Controllable:No
Description:An optional functor coefficient to multiply the imposed functor. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
displacementsThe displacements
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The displacements
flux_is_inwardTrueSet to true if a positive evaluation of the provided functor corresponds to a flux in the inward direction; else the outward direction
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Set to true if a positive evaluation of the provided functor corresponds to a flux in the inward direction; else the outward direction
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
Unit:(no unit assumed)
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.

Optional Parameters

absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution
C++ Type:std::vector<TagName>
Unit:(no unit assumed)
Controllable:No
Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution
extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
C++ Type:std::vector<TagName>
Unit:(no unit assumed)
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>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
Options:nontime, time
Controllable:No
Description:The tag for the vectors this Kernel should fill

Tagging Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.
diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
C++ Type:std::vector<AuxVariableName>
Unit:(no unit assumed)
Controllable:No
Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Unit:(no unit assumed)
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
Unit:(no unit assumed)
Controllable:No
Description:Determines whether this object is calculated using an implicit or explicit form
save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
C++ Type:std::vector<AuxVariableName>
Unit:(no unit assumed)
Controllable:No
Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Unit:(no unit assumed)
Controllable:No
Description:The seed for the master random number generator
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
Unit:(no unit assumed)
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

Description
Input Parameters