driftlet 1.3.2 → 1.4.0

package/types/types.d.ts

@@ -250,6 +250,28 @@ export type FaceReactionDef = {
      */
     K?: Record<string, number>;
 };
+/**
+ * A face's diffuse layer on one side, in a solution.
+ */
+export type DiffuseLayerResult = {
+    /**
+     * the drop from the side's edge node to the plane, φ_plane − φ_edge (V)
+     */
+    psi: number;
+    /**
+     * the layer's charge (C/m²)
+     */
+    charge: number;
+    /**
+     * each ion's surface excess, ∫ (c − c_edge) dx (mol/m²)
+     */
+    excess: Record<string, number>;
+    /**
+     * each ion's concentration at the plane, c e^{−zFψ/RT} (mol/m³; on a
+     * lattice, over its crowding; for what a face reaction takes or makes there, times its level's drop across the layer)
+     */
+    plane: Record<string, number>;
+};
 /**
  * One face between consecutive regions. For different materials under a 'pinned' or
  * 'capacitive' law, exactly one alignment (step or dipole) is required.
@@ -279,6 +301,14 @@ export type InterfaceDef = {
      * C/m²
      */
     sheetCharge?: number;
+    /**
+     * a Gouy–Chapman diffuse layer below the grid on each strictly
+     * neutral (ε = 0) side of a charged face, of relative permittivity epsr: the side's share of the
+     * face's charge held as its ions' surface excesses, the face's reactions at its plane
+     */
+    diffuse?: {
+        epsr: number;
+    };
     /**
      * per-species laws (default equilibrium
      * where present on both sides and mobile on one, blocked otherwise; a species reacting at the
@@ -717,7 +747,8 @@ export type Solution = {
      * (V) and sheet charge (C/m²), its displacement D (C/m²), each species' flux N across it and each face
      * reaction's net rate (mol/(m²·s), toward +x and forward), how each species that crosses it does (its
      * link type); for those crossing by permeability, the one-way fluxes [toward +x, toward −x] whose
-     * difference is N; with gates, each one's fraction open and the voltage they follow, φ_right − φ_left (V)
+     * difference is N; with gates, each one's fraction open and the voltage they follow, φ_right − φ_left (V; between the diffuse layers' planes, where it has them);
+     * with a diffuse layer, each side's
      */
     interfaces: {
         left: string;
@@ -731,6 +762,10 @@ export type Solution = {
         oneWay?: Record<string, [number, number]>;
         gates?: Record<string, number>;
         V?: number;
+        diffuse?: {
+            left?: DiffuseLayerResult;
+            right?: DiffuseLayerResult;
+        };
     }[];
     /**
      *   each bulk reaction's net rate per node (mol/(m³·s), forward minus backward, NaN where it doesn't