Skip to content

Commit 9a221b0

Browse files
committed
wip doc
1 parent 973c747 commit 9a221b0

9 files changed

+692
-1154
lines changed

doc/interface/unit_operations/2d_general_rate_model.rst

Lines changed: 0 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -9,79 +9,6 @@ Group /input/model/unit_XXX - UNIT_TYPE = GENERAL_RATE_MODEL_2D
99
For information on model equations, refer to :ref:`2d_general_rate_model_model`.
1010

1111

12-
``UNIT_TYPE``
13-
14-
Specifies the type of unit operation model
15-
16-
================ ================================================= =============
17-
**Type:** string **Range:** :math:`\texttt{GENERAL_RATE_MODEL_2D}` **Length:** 1
18-
================ ================================================= =============
19-
20-
``NCOMP``
21-
22-
Number of chemical components in the chromatographic medium
23-
24-
============= ========================= =============
25-
**Type:** int **Range:** :math:`\geq 1` **Length:** 1
26-
============= ========================= =============
27-
28-
``ADSORPTION_MODEL``
29-
30-
Specifies the type of binding model of each particle type (or of all particle types if length is 1)
31-
32-
================ ========================================== ==========================================
33-
**Type:** string **Range:** See Section :ref:`FFAdsorption` **Length:** :math:`1 / \texttt{NPARTYPE}`
34-
================ ========================================== ==========================================
35-
36-
``ADSORPTION_MODEL_MULTIPLEX``
37-
38-
Multiplexing mode of :math:`\texttt{ADSORPTION_MODEL}`. If set to 0, each particle type has a different binding model and the length of :math:`\texttt{ADSORPTION_MODEL}` is :math:`\texttt{NPARTYPE}`. If set to 1, all particle types share the same binding model and the length of :math:`\texttt{ADSORPTION_MODEL}` is 1. This field is optional and inferred from the length of :math:`\texttt{ADSORPTION_MODEL}` if left out.
39-
40-
============= =========================== =============
41-
**Type:** int **Range:** :math:`\{0, 1\}` **Length:** 1
42-
============= =========================== =============
43-
44-
``NBOUND``
45-
46-
Number of bound states for each component in each particle type in type-major ordering
47-
48-
============= ========================= ==========================================================================
49-
**Type:** int **Range:** :math:`\geq 0` **Length:** :math:`\texttt{NCOMP} / \texttt{NPARTYPE} \cdot \texttt{NCOMP}`
50-
============= ========================= ==========================================================================
51-
52-
``REACTION_MODEL_BULK``
53-
54-
Specifies the type of reaction model of the bulk volume. The model is configured in the subgroup :math:`\texttt{reaction_bulk}`.
55-
56-
================ ======================================== =============
57-
**Type:** string **Range:** See Section :ref:`FFReaction` **Length:** 1
58-
================ ======================================== =============
59-
60-
``REACTION_MODEL_PARTICLES``
61-
62-
Specifies the type of reaction model of each particle type (or of all particle types if length is 1). The model is configured in the subgroup :math:`\texttt{reaction_particle}`, or :math:`\texttt{reaction_particle_XXX}` in case of disabled multiplexing.
63-
64-
================ ======================================== ==========================================
65-
**Type:** string **Range:** See Section :ref:`FFReaction` **Length:** :math:`1 / \texttt{NPARTYPE}`
66-
================ ======================================== ==========================================
67-
68-
``REACTION_MODEL_PARTICLES_MULTIPLEX``
69-
70-
Multiplexing mode of :math:`\texttt{REACTION_MODEL_PARTICLES}`. If set to 0, each particle type has a different reaction model and the length of :math:`\texttt{REACTION_MODEL_PARTICLES}` is :math:`\texttt{NPARTYPE}`. If set to 1, all particle types share the same reaction model and the length of :math:`\texttt{REACTION_MODEL_PARTICLES}` is 1. This field is optional and inferred from the length of :math:`\texttt{REACTION_MODEL_PARTICLES}` if left out.
71-
72-
============= =========================== =============
73-
**Type:** int **Range:** :math:`\{0, 1\}` **Length:** 1
74-
============= =========================== =============
75-
76-
``INIT_C``
77-
78-
Initial concentrations for each component in all radial zones the bulk mobile phase (length :math:`\texttt{NCOMP}`), or for each component in each radial zone (length :math:`\texttt{NCOMP} \cdot \texttt{NRAD}`, ordering radial-major)
79-
80-
**Unit:** :math:`\mathrm{mol}\,\mathrm{m}_{\mathrm{IV}}^{-3}`
81-
82-
================ ========================= =========================================================================
83-
**Type:** double **Range:** :math:`\geq 0` **Length:** :math:`\texttt{NCOMP} / \texttt{NCOMP} \cdot \texttt{NRAD}`
84-
================ ========================= =========================================================================
8512

8613
``INIT_CP``
8714

doc/interface/unit_operations/axial_flow_column_1D_config.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,8 +129,14 @@ For information on model equations, refer to :ref:`axial_flow_column_1D_model`.
129129
================ ============================= ==================================================
130130

131131

132+
Group /input/model/unit_XXX/particle_type_XXX
133+
---------------------------------------------
134+
135+
Each particle type is specified in another subgroup `particle_type_XXX`, see :ref:`particle_model_config`.
136+
137+
132138
Group /input/model/unit_XXX/discretization - UNIT_TYPE - COLUMN_MODEL_1D
133-
----------------------------------------------------------------------------------------
139+
-------------------------------------------------------------------------
134140

135141
``USE_ANALYTIC_JACOBIAN``
136142

@@ -224,6 +230,8 @@ Finite Volumes
224230
**Type:** string **Range:** :math:`\texttt{WENO}` **Length:** 1
225231
================ ================================ =============
226232

233+
The following FV discretization parameters are only required if particles are present:
234+
227235
``GS_TYPE``
228236

229237
Type of Gram-Schmidt orthogonalization, see IDAS guide Section 4.5.7.3, p. 41f. A value of :math:`0` enables classical Gram-Schmidt, a value of 1 uses modified Gram-Schmidt.

0 commit comments

Comments
 (0)