From d8e7cf3b4413ce88caa30b16f6c0d5bad9a699ba Mon Sep 17 00:00:00 2001 From: wfullmer Date: Thu, 21 Aug 2025 14:22:35 -0400 Subject: [PATCH 1/2] add mass flow as BC type --- .../user_guide/inputs/boundary_conditions.rst | 25 ++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/docs/source_docs/user_guide/inputs/boundary_conditions.rst b/docs/source_docs/user_guide/inputs/boundary_conditions.rst index bd5a0d2..8ab99f6 100644 --- a/docs/source_docs/user_guide/inputs/boundary_conditions.rst +++ b/docs/source_docs/user_guide/inputs/boundary_conditions.rst @@ -50,7 +50,14 @@ using the ``bc.[region].[fluid]`` prefix. +------------------------+------------------------------------------------------------------------+-------------+-----------+ | temperature | Fluid temperature [required if bc_region_type='mi' or 'pi'] | Real | 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ -| velocity | Velocity components [required if bc_region_type='mi'] | Reals | 0 0 0 | +| velocity | Velocity components [required if bc_region_type='mi' | Reals | 0 0 0 | +| | and volflow or massflow not specified] | | | ++------------------------+------------------------------------------------------------------------+-------------+-----------+ +| volflow | Volumetric flowrate [required if bc_region_type='mi' | Real | 0 | +| | and velocity or massflow not specified] | | | ++------------------------+------------------------------------------------------------------------+-------------+-----------+ +| massflow | Mass flowrate [required if bc_region_type='mi' | Real | 0 | +| | and velocity or volflow not specified] | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | delp_dir | Direction for specified pressure drop. Note that this direction | Int | 0 | | | should also be periodic. | | | @@ -61,6 +68,10 @@ using the ``bc.[region].[fluid]`` prefix. | | and bc_region_type='mi' or 'pi']. | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ +Note that for a ``mi`` only one of ``velocity`` or ``volflow`` or ``massflow`` should be specified. +Additionally, velocity can be specified as a vector or a scalar, the latter of which is applied +normal to the inflow plane, as with volflow and massflow. + Below is an example for specifying boundary conditions for fluid (``fluid``). .. code-block:: none @@ -151,15 +162,21 @@ provided when appropriate. +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +=====================+=======================================================================+=============+===========+ -| fluid.velocity | (Required if not `volflow`) Inflow fluid velocity on EB faces | Reals | 0 0 0 | +| fluid.velocity | (Required if not `volflow` or `massflow`) | | | +| | Inflow fluid velocity on EB faces | Reals | 0 0 0 | | | contained in the (tridimensional) region. | | | | | Note that if only one value is specified, that is assumed to | | | | | be the magnitude in the direction of the EB face's normal. | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ -| fluid.volflow | (Required if not `velocity`) Inflow BC for fluid volumetric flow | Real | 0 | +| fluid.volflow | (Required if not `velocity` or `massflow`) | | | +| | Inflow BC for fluid volumetric flow | Real | 0 | | | rate in the (tridimensional) region. The flow is assumed to be | | | | | normal to the EB surface in the region. | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ +| fluid.massflow | (Required if not `velocity` or `volflow`) | | | +| | Inflow BC for fluid mass flow rate in the (tridimensional) region. | Real | 0 | +| | The flow is assumed to be normal to the EB surface in the region. | | | ++---------------------+-----------------------------------------------------------------------+-------------+-----------+ | fluid.volfrac | (Required) Volume fraction. | Real | 0 | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | eb.normal | (Optional) When specified, only cells with EB face normal that is | Reals | 0 0 0 | @@ -170,6 +187,8 @@ provided when appropriate. | | tolerance (in degrees) for choosing cells with a specific normal. | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ +Note that only one of ``velocity`` or ``volflow`` or ``massflow`` should be specified. + Below is an example for specifying a normal inflow velocity magnitude for a region `eb-flow`. .. code-block:: none -- GitLab From acc93bf2d28a06098e022ad55e1ed7ffcd8dc790 Mon Sep 17 00:00:00 2001 From: wfullmer Date: Thu, 21 Aug 2025 14:32:55 -0400 Subject: [PATCH 2/2] space in flowrate --- docs/source_docs/user_guide/inputs/boundary_conditions.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source_docs/user_guide/inputs/boundary_conditions.rst b/docs/source_docs/user_guide/inputs/boundary_conditions.rst index 8ab99f6..bf097d4 100644 --- a/docs/source_docs/user_guide/inputs/boundary_conditions.rst +++ b/docs/source_docs/user_guide/inputs/boundary_conditions.rst @@ -53,10 +53,10 @@ using the ``bc.[region].[fluid]`` prefix. | velocity | Velocity components [required if bc_region_type='mi' | Reals | 0 0 0 | | | and volflow or massflow not specified] | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ -| volflow | Volumetric flowrate [required if bc_region_type='mi' | Real | 0 | +| volflow | Volumetric flow rate [required if bc_region_type='mi' | Real | 0 | | | and velocity or massflow not specified] | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ -| massflow | Mass flowrate [required if bc_region_type='mi' | Real | 0 | +| massflow | Mass flow rate [required if bc_region_type='mi' | Real | 0 | | | and velocity or volflow not specified] | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | delp_dir | Direction for specified pressure drop. Note that this direction | Int | 0 | -- GitLab