Refactor WebGPU solver methods, and remove deprecated files

Author: nikoscham

NOTICE.md

@@ -11,4 +11,8 @@ FEAScript makes use of the following third-party software:
 
 3. **Comlink**
    - License: Apache 2.0 (https://github.com/GoogleChromeLabs/comlink/blob/main/LICENSE)
-   - Source: https://github.com/GoogleChromeLabs/comlink
+   - Source: https://github.com/GoogleChromeLabs/comlink
+
+4. **taichi.js**
+   - License: MIT (https://github.com/AmesingFlank/taichi.js/blob/main/LICENSE)
+   - Source: https://github.com/AmesingFlank/taichi.js

README.md

@@ -4,20 +4,18 @@
 
 [![npm version](https://img.shields.io/npm/v/feascript)](https://www.npmjs.com/package/feascript)
 
-<!-- [![liberapay](https://img.shields.io/liberapay/receives/FEAScript.svg?logo=liberapay)](https://liberapay.com/FEAScript/) -->
-
 [FEAScript](https://feascript.com/) is a lightweight finite element simulation library written in JavaScript. It empowers users to perform simulations for physics and engineering applications in both browser-based and server-side environments. This is the core library of the FEAScript project.
 
 > 🚧 **FEAScript is currently under heavy development.** Its functionality and interfaces may change rapidly as new features and enhancements are introduced.
 
 ## Contents
 
 - [Ways to Use FEAScript](#ways-to-use-feascript)
-  - [JavaScript API (FEAScript Core)](#javascript-api-feascript-core)
+  - [FEAScript API](#feascript-api)
     - [Use FEAScript in the Browser](#use-feascript-in-the-browser)
     - [Use FEAScript with Node.js](#use-feascript-with-nodejs)
-    - [Use FEAScript with Scribbler](#use-feascript-with-scribbler)
-  - [Visual Editor (FEAScript Platform)](#visual-editor-feascript-platform)
+    - [Use FEAScript in JavaScript Playgrounds](#use-feascript-in-javascript-playgrounds)
+  - [FEAScript Platform](#feascript-platform)
 - [Quick Example](#quick-example)
 - [Support FEAScript](#support-feascript)
 - [Contributing](#contributing)
@@ -27,22 +25,22 @@
 
 FEAScript offers two main approaches to creating simulations:
 
-1. **[JavaScript API (FEAScript Core)](#javascript-api-feascript-core)** – For developers comfortable with coding, providing full programmatic control in browsers, Node.js, or interactive notebooks.
-2. **[Visual Editor (FEAScript Platform)](#visual-editor-feascript-platform)** – For users who prefer a no-code approach, offering a block-based visual interface built with [Blockly](https://developers.google.com/blockly).
+1. **[FEAScript API](#feascript-api)** – For developers comfortable with coding, providing full programmatic control in browsers, Node.js, or interactive notebooks.
+2. **[FEAScript Platform](#feascript-platform)** – For users who prefer a no-code approach, offering a block-based visual interface built with [Blockly](https://blockly.com/).
 
 Each approach is explained in detail below.
 
-### JavaScript API (FEAScript Core)
+### FEAScript API
 
-The JavaScript API is the core programmatic interface for FEAScript. Written entirely in pure JavaScript, it runs in three environments:
+The FEAScript API is the core programmatic interface for FEAScript. Written entirely in pure JavaScript, it runs in three environments:
 
 1. **[In the browser](#use-feascript-in-the-browser)** – Use FEAScript in a simple HTML page, running simulations locally without additional installations or cloud services.
 2. **[With Node.js](#use-feascript-with-nodejs)** – Use FEAScript in server-side JavaScript applications or CLI tools.
-3. **[With Scribbler](#use-feascript-with-scribbler)** – Use FEAScript in the [Scribbler](https://scribbler.live/) interactive JavaScript notebook environment.
+3. **[In JavaScript playgrounds](#use-feascript-in-javascript-playgrounds)** – Use FEAScript in the [Scribbler](https://scribbler.live/) interactive JavaScript notebook environment.
 
 #### Use FEAScript in the Browser
 
-You can use FEAScript in browser environments in two ways:
+You can use FEAScript in browser environments in three ways:
 
 - **Import from Hosted ESM Build:**
 
@@ -52,6 +50,14 @@ You can use FEAScript in browser environments in two ways:
   </script>
   ```
 
+- **Import from CDN:**
+
+  ```html
+  <script type="module">
+    import { FEAScriptModel } from "https://cdn.jsdelivr.net/gh/FEAScript/FEAScript-core/dist/feascript.esm.js";
+  </script>
+  ```
+
 - **Download and Use Locally:**
 
   You can download the latest stable release from [GitHub Releases](https://github.com/FEAScript/FEAScript-core/releases).
@@ -89,27 +95,29 @@ When running examples from within this repository, this step isn’t needed as t
 
 👉 Explore Node.js use cases on the [examples directory](https://github.com/FEAScript/FEAScript-core/tree/main/examples).
 
-#### Use FEAScript with Scribbler
+#### Use FEAScript in JavaScript Playgrounds
 
-FEAScript also works well in interactive JavaScript notebook environments where you can write code, visualize results inline, and share your work with others. [Scribbler](https://scribbler.live/) is one such platform that comes with preloaded scientific libraries, making it an excellent choice for FEAScript simulations.
+FEAScript works well in interactive JavaScript playgrounds where you can write code, visualize results inline, and share your work.
 
-👉 Explore FEAScript notebook examples on the [Scribbler Hub](https://hub.scribbler.live/portfolio/#!nikoscham/FEAScript-Scribbler-examples).
+👉 Explore the following examples: 
+- [CodePen (interactive pens)](https://codepen.io/FEAScript)
+- [Scribbler (notebooks)](https://hub.scribbler.live/portfolio/#!nikoscham/FEAScript-Scribbler-examples)
 
-### Visual Editor (FEAScript Platform)
+### FEAScript Platform
 
-For users who prefer a visual approach to creating simulations, we offer the [FEAScript Platform](https://platform.feascript.com/) - a browser-based visual editor built on the [Blockly](https://developers.google.com/blockly) library. This no-code interface allows you to:
+For users who prefer a visual approach to creating simulations, we offer the [FEAScript Platform](https://feascript.com/feascript-platform.html) - a browser-based visual editor built on the [Blockly](https://blockly.com/) library. This no-code interface allows you to:
 
 - Build and run finite element simulations directly in your browser by connecting visual blocks together.
 - Create complex simulations without writing any JavaScript code.
 - Save and load projects in XML format for easy sharing and reuse.
 
-While FEAScript's JavaScript API offers full programmatic control for advanced customization, the FEAScript Platform provides an accessible entry point for users without coding experience.
+While FEAScript API offers full programmatic control for advanced customization, the FEAScript Platform provides an accessible entry point for users without coding experience.
 
-👉 Explore FEAScript Platform examples on our [website](https://feascript.com/#tutorials).
+<!-- > Note: The FEAScript Platform is not yet available -->
 
 ## Quick Example
 
-Here is a minimal browser-based example using the JavaScript API. Adapt paths, solver types, and boundary conditions as needed for your specific problem:
+Here is a minimal browser-based example using the FEAScript API. Adapt paths, solver types, and boundary conditions as needed for your specific problem:
 
 ```html
 <body>

examples/heatConductionScript/heatConduction2DFin/HeatConduction2DFinCG.html

@@ -0,0 +1,92 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Heat Conduction 2D Fin - GPU Jacobi Solver</title>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjs/5.0.0/math.min.js"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/plotly.js/2.27.0/plotly.min.js"></script>
+    <style>
+        body {
+            font-family: Arial, sans-serif;
+            max-width: 1200px;
+            margin: 0 auto;
+            padding: 20px;
+        }
+
+        .result {
+            background-color: #f5f5f5;
+            padding: 10px;
+            margin: 10px 0;
+            border-radius: 3px;
+        }
+
+        .success {
+            color: green;
+        }
+
+        .error {
+            color: red;
+        }
+    </style>
+</head>
+
+<body>
+    <h1>Heat Conduction in 2D Fin - GPU Jacobi Solver</h1>
+    <div id="solutionPlot"></div>
+    <div id="result" class="result"></div>
+
+    <script type="module">
+        import { FEAScriptModel, plotSolution } from "../../../src/index.js";
+
+        window.addEventListener("DOMContentLoaded", async () => {
+            const model = new FEAScriptModel();
+            model.setSolverConfig("heatConductionScript");
+
+            model.setMeshConfig({
+                meshDimension: "2D",
+                elementOrder: "quadratic",
+                numElementsX: 20,
+                numElementsY: 10,
+                maxX: 4000,
+                maxY: 2000,
+            });
+
+            model.addBoundaryCondition("0", ["constantTemp", 200]);
+            model.addBoundaryCondition("1", ["symmetry"]);
+            model.addBoundaryCondition("2", ["convection", 1, 20]);
+            model.addBoundaryCondition("3", ["constantTemp", 200]);
+
+            const resultDiv = document.getElementById("result");
+            resultDiv.innerHTML = "Assembling system and solving with GPU Jacobi...";
+
+            // GPU Jacobi; worker is managed internally by solveLinearSystemAsync
+            model.setSolverMethod("jacobi-gpu");
+
+            // Keep the first arg undefined: the API still accepts an optional computeEngine
+            const { solutionVector, nodesCoordinates } = await model.solveAsync({
+                maxIterations: 10000,
+                tolerance: 1e-3,
+            });
+
+            const n = solutionVector.length;
+            resultDiv.innerHTML = `
+          <div>System size: ${n} x ${n}</div>
+          <div>Solution computed with WebGPU Jacobi</div>
+          <div class="success">SOLUTION COMPLETED</div>
+        `;
+
+            plotSolution(
+                solutionVector,
+                nodesCoordinates,
+                model.solverConfig,
+                model.meshConfig.meshDimension,
+                "contour",
+                "solutionPlot"
+            );
+        });
+    </script>
+</body>
+
+</html>