driftlet 0.16.4 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. package/README.md +3 -3
  2. package/docs/device.md +28 -14
  3. package/docs/kit.md +3 -1
  4. package/docs/numerics.md +12 -0
  5. package/docs/statistics.md +2 -1
  6. package/docs/templates.md +260 -0
  7. package/llms.txt +106 -300
  8. package/package.json +15 -3
  9. package/src/channels.js +6 -4
  10. package/src/checks.js +7 -2
  11. package/src/data.js +5 -1
  12. package/src/device.js +10 -4
  13. package/src/devices.js +2 -0
  14. package/src/equation.js +2 -1
  15. package/src/errors.js +33 -0
  16. package/src/grid.js +12 -0
  17. package/src/index.js +17 -7
  18. package/src/junction.js +3 -1
  19. package/src/kit.js +1 -1
  20. package/src/live.js +2 -0
  21. package/src/particles.js +2 -0
  22. package/src/plot.js +4 -0
  23. package/src/polarization.js +4 -3
  24. package/src/recorder.js +2 -1
  25. package/src/solution.js +20 -5
  26. package/src/solver.js +70 -16
  27. package/src/sources.js +8 -1
  28. package/src/stack.js +14 -1
  29. package/src/statistics.js +1 -1
  30. package/src/traces.js +3 -0
  31. package/src/types.js +5 -2
  32. package/types/channels.d.ts +3 -3
  33. package/types/checks.d.ts +1 -1
  34. package/types/data.d.ts +3 -3
  35. package/types/devices.d.ts +1 -1
  36. package/types/equation.d.ts +1 -1
  37. package/types/errors.d.ts +8 -0
  38. package/types/index.d.ts +2 -5
  39. package/types/junction.d.ts +2 -2
  40. package/types/kit.d.ts +1 -1
  41. package/types/live.d.ts +1 -1
  42. package/types/particles.d.ts +1 -1
  43. package/types/plot.d.ts +3 -3
  44. package/types/polarization.d.ts +1 -1
  45. package/types/recorder.d.ts +1 -1
  46. package/types/solver.d.ts +2 -0
  47. package/types/sources.d.ts +7 -7
  48. package/types/traces.d.ts +1 -1
  49. package/types/types.d.ts +11 -2
package/types/types.d.ts CHANGED
@@ -390,7 +390,8 @@ export type PortDef = {
390
390
  /**
391
391
  * with reactions: species
392
392
  * on the electrode's sites, Langmuir (μ = μ° + RT ln(θ/θ₀)), capacity in mol of sites per m² of electrode,
393
- * shared; a reaction with `bare: true` runs only on the bare fraction θ₀ = 1 − Σθ
393
+ * shared; reactions run on Langmuir sites (what fills sites needs bare ones), and one with `bare: true`
394
+ * needs a bare site even if it fills none (θ₀ = 1 − Σθ)
394
395
  */
395
396
  surface?: Record<string, {
396
397
  mu0: number;
@@ -551,7 +552,11 @@ export type Solution = {
551
552
  left: ContactResult;
552
553
  right: ContactResult;
553
554
  };
554
- gates: {
555
+ /**
556
+ * the charge on a gate or
557
+ * Stern plate at a capacitive contact
558
+ */
559
+ plates: {
555
560
  left?: {
556
561
  V: number;
557
562
  D: number;
@@ -665,6 +670,10 @@ export type ImpedanceResult = {
665
670
  mu: Record<string, ComplexProfile>;
666
671
  c: Record<string, ComplexProfile>;
667
672
  }[];
673
+ /**
674
+ * the steady state's warnings, which hold for its impedance too
675
+ */
676
+ warnings: string[];
668
677
  };
669
678
  export type ComplexProfile = {
670
679
  re: Float64Array;