@galihru/mnp-material 0.1.1 → 0.1.3

package/README.md

@@ -1,72 +1,153 @@
-# @galihru/mnp-material
-
-Scientific dielectric-response models for plasmonic simulations.
-JavaScript port of the [mnpbem-material](https://pypi.org/project/mnpbem-material/) Python module.
-
-## Features
-
-- Constant dielectric model for homogeneous media
-- Drude free-electron model for metals (Au, Ag, Al)
-- Tabulated `(E, n, k)` optical constants with wavelength interpolation
-- Complex arithmetic utilities
-
-## Implemented Formulations
-
-### Constant Dielectric
-
-![ε(λ) = ε₀](https://latex.codecogs.com/svg.latex?\varepsilon(\lambda)=\varepsilon_0)
-
-Wave number in medium:
-
-![k(λ) = (2π/λ)√ε](https://latex.codecogs.com/svg.latex?k(\lambda)=\frac{2\pi}{\lambda}\sqrt{\varepsilon})
-
-### Drude Model
-
-For free-electron metals (Au, Ag, Al):
-
-![ε(ω) = ε∞ - ωp²/(ω(ω+iγ))](https://latex.codecogs.com/svg.latex?\varepsilon(\omega)=\varepsilon_\infty-\frac{\omega_p^2}{\omega(\omega+i\gamma)})
-
-Energy–wavelength conversion:
-
-![ω_eV = 1239.84 / λ_nm](https://latex.codecogs.com/svg.latex?\omega_{\mathrm{eV}}=\frac{1239.84}{\lambda_{\mathrm{nm}}})
-
-### Tabulated Material
-
-Given tabulated optical constants `(E, n, k)`:
-
-![ε = (n + ik)²](https://latex.codecogs.com/svg.latex?\varepsilon=(n+ik)^2)
-
-## Install
-
-```bash
-npm install @galihru/mnp-material
-```
-
-## API
-
-```js
-import {
-  constantEpsilon,
-  drudeEpsilon,
-  makeDrudeMaterial,
-  wavenumberInMedium,
-  complex, add, sub, mul, div, sqrtComplex,
-  EV_TO_NM, HARTREE_EV
-} from "@galihru/mnp-material";
-
-// Drude model for gold at 548.1 nm
-const epsAu = drudeEpsilon("Au", 548.1);
-console.log(epsAu); // { re: ..., im: ... }
-
-// Constant dielectric (water, n ≈ 1.33)
-const epsWater = constantEpsilon(1.33 ** 2, 548.1);
-
-// Wave number in medium
-const k = wavenumberInMedium(epsWater, 548.1);
-```
-
-## Author
-
-**GALIH RIDHO UTOMO** — g4lihru@students.unnes.ac.id  
+# @galihru/mnp-material
+
+Analytical dielectric-function models for metallic nanoparticles in the framework of plasmonic nanophotonics. Provides frequency-dependent complex permittivity via the Drude free-electron model and constant dielectric approximation, with complex wave-number computation � all operating natively in the wavelength domain (?, nm).
+
+---
+
+## Physical Background
+
+The optical response of a metallic nanoparticle is governed by its frequency-dependent complex dielectric function e(?). This package implements two analytical models and the wave-number relation used in electrodynamic simulations.
+
+---
+
+## Implemented Models
+
+### 1. Energy�Wavelength Conversion
+
+All models accept wavelength in nanometres. The photon energy is computed as:
+
+![? = C/?](https://latex.codecogs.com/svg.latex?\omega\,[\mathrm{eV}]=\frac{C}{\lambda\,[\mathrm{nm}]},\quad%20C=1239.841984\,\mathrm{eV{\cdot}nm})
+
+---
+
+### 2. Drude Free-Electron Model
+
+Describes the dielectric response of free-electron metals:
+
+![e(?) = e8 - ?p�/(?(?+i?))](https://latex.codecogs.com/svg.latex?\varepsilon(\omega)=\varepsilon_\infty-\frac{\omega_p^2}{\omega(\omega+i\gamma)})
+
+**Parameters:**
+- **e8** � high-frequency (interband) dielectric constant
+- **??** � bulk plasma frequency, derived from electron density via the Wigner�Seitz radius *r?*:
+
+![?p from rs](https://latex.codecogs.com/svg.latex?\rho_0=\frac{3}{4\pi%20r_s^3},\qquad\omega_p=\sqrt{4\pi\rho_0}\times%2027.2116\,\mathrm{eV})
+
+- **?** � phenomenological Drude damping rate (scattering)
+
+**Built-in material table:**
+
+| Material | *r?* (a.u.) | e8 | ? (eV) | ?? (eV) |
+|---|---|---|---|---|
+| `Au` / `gold` | 3.00 | 10.0 | 0.066 | ~9.07 |
+| `Ag` / `silver` | 3.00 | 3.3 | 0.022 | ~9.07 |
+| `Al` / `aluminum` | 2.07 | 1.0 | 1.06 | ~15.8 |
+
+---
+
+### 3. Constant Dielectric Model
+
+For non-dispersive homogeneous embedding media (glass, water, vacuum):
+
+![e(?) = e0](https://latex.codecogs.com/svg.latex?\varepsilon(\lambda)=\varepsilon_0,\quad\varepsilon_0\in\mathbb{C})
+
+---
+
+### 4. Wave Number in Medium
+
+Complex wave number for light propagating through a dielectric:
+
+![k(?) = (2p/?)ve](https://latex.codecogs.com/svg.latex?k(\lambda)=\frac{2\pi}{\lambda}\sqrt{\varepsilon(\lambda)}\quad[\mathrm{nm}^{-1}])
+
+---
+
+## Install
+
+```bash
+npm install @galihru/mnp-material
+```
+
+---
+
+## API Reference
+
+### `drudeEpsilon(materialName, wavelengthNm)`
+
+Returns the complex Drude permittivity for a built-in metal at one or multiple wavelengths.
+
+```js
+import { drudeEpsilon } from "@galihru/mnp-material";
+
+// Single wavelength ? { re, im }
+const eps = drudeEpsilon("Au", 548.1);
+
+// Wavelength array ? [{ re, im }, ...]
+const spectra = drudeEpsilon("Ag", [400, 500, 600, 700]);
+```
+
+---
+
+### `makeDrudeMaterial(name)`
+
+Returns the raw Drude parameter object for a given metal name.
+
+```js
+import { makeDrudeMaterial } from "@galihru/mnp-material";
+
+const au = makeDrudeMaterial("Au");
+// ? { name: "Au", eps0: 10.0, gammad: 0.066, wp: 9.07 }
+```
+
+---
+
+### `constantEpsilon(value, wavelengthNm)`
+
+Returns a wavelength-independent complex permittivity.
+
+```js
+import { constantEpsilon } from "@galihru/mnp-material";
+
+// Water: n = 1.33 ? e = n� � 1.769
+const epsWater = constantEpsilon(1.769, 548.1);
+// ? { re: 1.769, im: 0 }
+```
+
+---
+
+### `wavenumberInMedium(wavelengthNm, epsilonComplex)`
+
+Computes the complex wave number k = (2p/?)ve.
+
+```js
+import { constantEpsilon, wavenumberInMedium } from "@galihru/mnp-material";
+
+const eps = constantEpsilon(1.769, 548.1);
+const k = wavenumberInMedium(548.1, eps);
+// ? { re: ..., im: ... }   [nm?�]
+```
+
+---
+
+### Complex Arithmetic Utilities
+
+```js
+import { complex, add, sub, mul, div, sqrtComplex, fromReal } from "@galihru/mnp-material";
+
+const z1 = complex(-5.2, 1.3);     // -5.2 + 1.3i
+const z2 = fromReal(2.0);          //  2.0 + 0i
+const prod = mul(z1, z2);          // ? { re: -10.4, im: 2.6 }
+const root = sqrtComplex(z1);      // ? { re: ..., im: ... }
+```
+
+---
+
+## Keywords
+
+plasmonics � dielectric-function � drude-model � nanoparticle � nanophotonics � permittivity � gold � silver � electrodynamics � optics
+
+---
+
+## Author
+
+**GALIH RIDHO UTOMO** � g4lihru@students.unnes.ac.id  
+Universitas Negeri Semarang (UNNES)  
 License: GPL-2.0-only
-

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@galihru/mnp-material",
-  "version": "0.1.1",
-  "description": "Material dielectric models for plasmonic electrodynamics.",
+  "version": "0.1.3",
+  "description": "Analytical dielectric-function models for metallic nanoparticles in plasmonic nanophotonics.",
   "type": "module",
   "main": "./src/index.js",
   "exports": {
@@ -11,6 +11,18 @@
     "src",
     "README.md"
   ],
+  "keywords": [
+    "plasmonics",
+    "dielectric-function",
+    "drude-model",
+    "nanoparticle",
+    "nanophotonics",
+    "permittivity",
+    "gold",
+    "silver",
+    "electrodynamics",
+    "optics"
+  ],
   "author": "GALIH RIDHO UTOMO <g4lihru@students.unnes.ac.id>",
   "license": "GPL-2.0-only",
   "repository": {