- 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
- passive_scalarpassive scalar functor. 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:passive scalar functor. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
- rhoDensity functor. 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:Density functor. 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 boundary condition applies to
C++ Type:NonlinearVariableName
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable that this boundary condition applies to
- vel_xThe x-axis velocity. 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 x-axis velocity. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
WCNSFVScalarFluxBC
Flux boundary conditions for scalar quantity advection.
The flux for scalar quantity is:
with the scalar quantity flux, the density, the fluid speed, the inlet value of the scalar quantity, the mass flow rate and the inlet area.
There are three options for specifying the scalar flux:
specifying the surface integrated scalar quantity flow rate directly, which is then divided by the area of the inlet to obtain the local flux.
specifying an inlet velocity postprocessor and an inlet value for the scalar quantity.
specifying the inlet value for the scalar quantity, a postprocessor for the mass flow rate, a density functor and the inlet surface area. These last three quantities are used to compute the inlet velocity.
This boundary condition works with postprocessors, which may be replaced by constant values in the input. The intended use case for this boundary condition is to be receiving its value from a coupled application, using a Receiver postprocessor.
Determining Flow Direction
The isInflow()
method is used to determine if the boundary is an inflow boundary. The user must at least set one of the following parameters "scalar_flux_pp", "mdot_pp", or "velocity_pp". The code checks the parameters in the following order:
- if "mdot_pp" is provided, "mdot_pp" indicates inflow,
- else if "velocity_pp" is provided, "velocity_pp" indicates inflow,
- else if "scalar_flux_pp" is provided, "scalar_flux_pp" indicates inflow.
Example input syntax
In this example input, the inlet boundary conditions to the scalar quantity conservation equation is specified using a WCNSFVScalarFluxBC
. The scalar quantity flux is specified using the mass flow rate and the inlet area.
Input Parameters
- area_ppInlet area as a postprocessor
C++ Type:PostprocessorName
Unit:(no unit assumed)
Controllable:No
Description:Inlet area as a postprocessor
- direction0 0 0The direction of the flow at the boundary. This is mainly used for cases when an inlet angle needs to be defined with respect to the normal and when a boundary is defined on an internal face where the normal can point in both directions. Use positive mass flux and velocity magnitude if the flux aligns with this direction vector.
Default:0 0 0
C++ Type:libMesh::Point
Unit:(no unit assumed)
Controllable:No
Description:The direction of the flow at the boundary. This is mainly used for cases when an inlet angle needs to be defined with respect to the normal and when a boundary is defined on an internal face where the normal can point in both directions. Use positive mass flux and velocity magnitude if the flux aligns with this direction vector.
- displacementsThe displacements
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The displacements
- mdot_ppPostprocessor with the inlet mass flow rate
C++ Type:PostprocessorName
Unit:(no unit assumed)
Controllable:No
Description:Postprocessor with the inlet mass flow rate
- 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.
- scalar_flux_ppPostprocessor with the inlet scalar flow rate
C++ Type:PostprocessorName
Unit:(no unit assumed)
Controllable:No
Description:Postprocessor with the inlet scalar flow rate
- scalar_value_ppPostprocessor with the inlet scalar concentration
C++ Type:PostprocessorName
Unit:(no unit assumed)
Controllable:No
Description:Postprocessor with the inlet scalar concentration
- scaling_factor1To scale the mass flux
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:To scale the mass flux
- 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.
- vel_yThe y-axis velocity. 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 y-axis velocity. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
- vel_zThe z-axis velocity. 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 z-axis velocity. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
- velocity_ppPostprocessor with the inlet velocity norm
C++ Type:PostprocessorName
Unit:(no unit assumed)
Controllable:No
Description:Postprocessor with the inlet velocity norm
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)
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)
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.
- 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
- 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.