Update MCT documentation

Adds mapping to access Parameter sensitivities to MCT documentation fix function documentation makeParamID()
cadet · Oct 22, 2024 · d8de618 · d8de618
1 parent 302b487
commit d8de618
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/doc/interface/unit_operations/multi_channel_transport_model.rst b/doc/interface/unit_operations/multi_channel_transport_model.rst
@@ -131,6 +131,11 @@ For information on model equations, refer to :ref:`multi_channel_transport_model
     e^k_{N1} & \dots & e^k_{N(N-1)} & 0 
     \end{bmatrix}    
 
+   For addressing the exchange rates as a parameter senstivity, the mapping is as follows:
+
+  - :math:`\texttt{SENS_BOUNDPHASE}` *Channel from* 
+  - :math:`\texttt{SENS_PARTYPE}` *Channel to* 
+
    ================  ========================  ===============================================
    **Type:** double  **Range:** :math:`[0,1]`  **Length:** :math:`\texttt{NCHANNEL}*\texttt{NCHANNEL}*\texttt{NCOMP}`
    ================  ========================  ===============================================

diff --git a/include/cadet/ParameterId.hpp b/include/cadet/ParameterId.hpp
@@ -211,6 +211,7 @@ inline ParameterId makeParamId(const std::string& name, const UnitOpIdx unitOper
  * @param [in] name Hash of the parameter name
  * @param [in] unitOperation Index of the unit operation this parameter belongs to
  * @param [in] component Index of the component this parameter belongs to
+ * @param [in] parType Index of the particle type this parameter belongs to
  * @param [in] boundState Index of the bound state this parameter belongs to
  * @param [in] reaction Index of the reaction this parameter belongs to
  * @param [in] section Index of the section this parameter belongs to