Skip to content

Commit 28f4849

Browse files
committed
Update GLC block docstring to match thermodynamics style
1 parent 43f1dc0 commit 28f4849

1 file changed

Lines changed: 50 additions & 13 deletions

File tree

  • src/pathsim_chem/tritium

src/pathsim_chem/tritium/glc.py

Lines changed: 50 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -349,19 +349,56 @@ def solve(params):
349349

350350

351351
class GLC(pathsim.blocks.Function):
352-
"""
353-
Gas Liquid Contactor model block. Inherits from Function block.
354-
355-
More details about the model can be found in: https://doi.org/10.13182/FST95-A30485
356-
357-
Args:
358-
P_in: Inlet operating pressure [Pa]
359-
L: Column height [m]
360-
D: Column diameter [m]
361-
T: Temperature [K]
362-
g: Gravitational acceleration [m/s^2], default is 9.81
363-
initial_nb_of_elements: Initial number of elements for BVP solver
364-
BCs: Boundary conditions type, "C-C" (Closed-Closed) or "O-C" (Open-Closed), default is "C-C"
352+
r"""Counter-current bubble column gas-liquid contactor (GLC) for tritium extraction.
353+
354+
Solves the coupled, non-linear, second-order boundary value problem that
355+
describes tritium transport between a liquid metal (LiPb) stream and a
356+
purge gas in a counter-current bubble column. The model is based on
357+
C. Malara (1995) and accounts for axial dispersion, interfacial mass
358+
transfer via Sieverts' law, and hydrostatic pressure variation along
359+
the column.
360+
361+
The block is intended for steady-state tritium extraction calculations
362+
in fusion blanket systems. At each evaluation it computes
363+
temperature-dependent fluid properties, dimensionless groups, and solves
364+
the BVP using ``scipy.integrate.solve_bvp``.
365+
366+
Reference: https://doi.org/10.13182/FST95-A30485
367+
368+
**Input ports:**
369+
``c_T_in`` -- dissolved tritium concentration in liquid inlet [mol/m³],
370+
``flow_l`` -- liquid mass flow rate [kg/s],
371+
``y_T2_inlet`` -- T₂ mole fraction in inlet gas [-],
372+
``flow_g`` -- gas mass flow rate [kg/s].
373+
374+
**Output ports:**
375+
``c_T_out`` -- dissolved tritium concentration in liquid outlet [mol/m³],
376+
``y_T2_out`` -- T₂ mole fraction in outlet gas [-],
377+
``eff`` -- extraction efficiency [-],
378+
``P_out`` -- total gas outlet pressure [Pa],
379+
``Q_l`` -- liquid volumetric flow rate [m³/s],
380+
``Q_g_out`` -- gas volumetric flow rate at outlet [m³/s],
381+
``n_T_out_liquid`` -- tritium molar flow in liquid outlet [mol/s],
382+
``n_T_out_gas`` -- tritium molar flow in gas outlet [mol/s].
383+
384+
Parameters
385+
----------
386+
P_in : float
387+
Inlet operating pressure [Pa].
388+
L : float
389+
Column height [m].
390+
D : float
391+
Column diameter [m].
392+
T : float
393+
Operating temperature [K]. Used to compute temperature-dependent
394+
LiPb properties (density, viscosity, Sieverts' constant, etc.).
395+
BCs : str
396+
Boundary condition type for the BVP: ``"C-C"`` (closed-closed) or
397+
``"O-C"`` (open-closed).
398+
g : float, optional
399+
Gravitational acceleration [m/s²]. Default: ``scipy.constants.g``.
400+
initial_nb_of_elements : int, optional
401+
Number of mesh elements for the initial BVP grid. Default: 20.
365402
"""
366403

367404
input_port_labels = {

0 commit comments

Comments
 (0)