Standardize naming patterns across the FEAScript codebase by:

Renaming files:

FEAWorkerScript.js to workerScript.js
FEAWrapperScript.js to wrapperScript.js

Renaming classes:

FEAWorkerScript to FEAScriptWorker
FEAWorkerWrapper to workerWrapper

Updating all references in HTML examples and index.js export

Author: nikoscham

examples/solidHeatTransferScript/HeatConduction2DFin/HeatConduction2DFinWorker.html

@@ -47,7 +47,7 @@ <h1>Heat Conduction in a Two-Dimensional Fin Example (Worker)</h1>
     <!-- Import FEAScript library -->
     <script type="module">
       import {
-        FEAWorkerScript,
+        FEAScriptWorker,
         plotSolution,
         printVersion,
       } from "https://core.feascript.com/src/index.js";
@@ -60,8 +60,8 @@ <h1>Heat Conduction in a Two-Dimensional Fin Example (Worker)</h1>
         document.getElementById("loading").style.display = "block";
 
         try {
-          // Create a new FEAWorkerScript instance
-          const model = new FEAWorkerScript();
+          // Create a new FEAScriptWorker instance
+          const model = new FEAScriptWorker();
 
           // Ensure the worker is ready
           await model.ping();

src/index.js

@@ -11,4 +11,4 @@
 export { FEAScriptModel } from "./FEAScript.js";
 export { plotSolution } from "./visualization/plotSolutionScript.js";
 export { printVersion, logSystem } from "./utilities/loggingScript.js";
-export { FEAWorkerScript } from "./FEAWorkerScript.js";
+export { FEAScriptWorker } from "./workers/workerScript.js";

src/methods/jacobiMethodScript.js

@@ -48,7 +48,7 @@ export function jacobiMethod(A, b, x0, maxIterations = 100, tolerance = 1e-7) {
     // Update x for next iteration
     x = [...xNew];
 
-    // If difference is small enough, we've converged
+    // Successfully converged if maxDiff is less than tolerance
     if (maxDiff < tolerance) {
       return {
         solution: x,
@@ -58,7 +58,7 @@ export function jacobiMethod(A, b, x0, maxIterations = 100, tolerance = 1e-7) {
     }
   }
 
-  // If we reach here, we didn't converge within maxIterations
+  // maxIterations were reached without convergence
   return {
     solution: x,
     iterations: maxIterations,

src/FEAWorkerScript.js renamed to src/workers/workerScript.js

@@ -10,13 +10,13 @@
 
 // import * as Comlink from "https://unpkg.com/comlink/dist/esm/comlink.mjs";
 // The Web Worker functionality now uses the local Comlink library to avoid CORS issues
-import * as Comlink from "./vendor/comlink.mjs";
-import { basicLog } from "./utilities/loggingScript.js";
+import * as Comlink from "../vendor/comlink.mjs";
+import { basicLog } from "../utilities/loggingScript.js";
 
-export class FEAWorkerScript {
+export class FEAScriptWorker {
   /**
-   * Constructor to initialize the FEAWorkerScript class
-   * Sets up the worker and initializes the FEAWorkerWrapper.
+   * Constructor to initialize the FEAScriptWorker class
+   * Sets up the worker and initializes the workerWrapper.
    */
   constructor() {
     this.worker = null;
@@ -34,18 +34,18 @@ export class FEAWorkerScript {
   async _initWorker() {
     try {
       this.worker = new Worker(
-        new URL("./FEAWrapperScript.js", import.meta.url),
+        new URL("./wrapperScript.js", import.meta.url),
         {
           type: "module",
         }
       );
 
       this.worker.onerror = (event) => {
-        console.error("FEAWorkerScript: Worker error:", event);
+        console.error("FEAScriptWorker: Worker error:", event);
       };
-      const FEAWorkerWrapper = Comlink.wrap(this.worker);
+      const workerWrapper = Comlink.wrap(this.worker);
 
-      this.feaWorker = await new FEAWorkerWrapper();
+      this.feaWorker = await new workerWrapper();
 
       this.isReady = true;
     } catch (error) {
@@ -88,7 +88,7 @@ export class FEAWorkerScript {
    */
   async setSolverConfig(solverConfig) {
     await this._ensureReady();
-    basicLog(`FEAWorkerScript: Setting solver config to: ${solverConfig}`);
+    basicLog(`FEAScriptWorker: Setting solver config to: ${solverConfig}`);
     return this.feaWorker.setSolverConfig(solverConfig);
   }
 
@@ -99,7 +99,7 @@ export class FEAWorkerScript {
    */
   async setMeshConfig(meshConfig) {
     await this._ensureReady();
-    basicLog(`FEAWorkerScript: Setting mesh config`);
+    basicLog(`FEAScriptWorker: Setting mesh config`);
     return this.feaWorker.setMeshConfig(meshConfig);
   }
 
@@ -112,7 +112,7 @@ export class FEAWorkerScript {
   async addBoundaryCondition(boundaryKey, condition) {
     await this._ensureReady();
     basicLog(
-      `FEAWorkerScript: Adding boundary condition for boundary: ${boundaryKey}`
+      `FEAScriptWorker: Adding boundary condition for boundary: ${boundaryKey}`
     );
     return this.feaWorker.addBoundaryCondition(boundaryKey, condition);
   }
@@ -124,7 +124,7 @@ export class FEAWorkerScript {
    */
   async setSolverMethod(solverMethod) {
     await this._ensureReady();
-    basicLog(`FEAWorkerScript: Setting solver method to: ${solverMethod}`);
+    basicLog(`FEAScriptWorker: Setting solver method to: ${solverMethod}`);
     return this.feaWorker.setSolverMethod(solverMethod);
   }
 
@@ -134,14 +134,14 @@ export class FEAWorkerScript {
    */
   async solve() {
     await this._ensureReady();
-    basicLog("FEAWorkerScript: Requesting solution from worker...");
+    basicLog("FEAScriptWorker: Requesting solution from worker...");
 
     const startTime = performance.now();
     const result = await this.feaWorker.solve();
     const endTime = performance.now();
 
     basicLog(
-      `FEAWorkerScript: Solution completed in ${(
+      `FEAScriptWorker: Solution completed in ${(
         (endTime - startTime) /
         1000
       ).toFixed(2)}s`

src/FEAWrapperScript.js renamed to src/workers/wrapperScript.js

@@ -10,17 +10,17 @@
 
 // import * as Comlink from "https://unpkg.com/comlink/dist/esm/comlink.mjs";
 // The Web Worker functionality now uses the local Comlink library to avoid CORS issues
-import * as Comlink from "./vendor/comlink.mjs";
-import { FEAScriptModel } from "./FEAScript.js";
+import * as Comlink from "../vendor/comlink.mjs";
+import { FEAScriptModel } from "../FEAScript.js";
 import { create, all } from "https://cdn.jsdelivr.net/npm/mathjs@latest/+esm";
 
 const math = create(all);
 
 globalThis.math = math;
 
-class FEAWorkerWrapper {
+class workerWrapper {
   /**
-   * Constructor to initialize the FEAWorkerWrapper class.
+   * Constructor to initialize the workerWrapper class.
    * Creates an instance of the FEAScriptModel.
    * @throws Will throw an error if the FEAScriptModel fails to initialize.
    */
@@ -152,4 +152,4 @@ class FEAWorkerWrapper {
   }
 }
 
-Comlink.expose(FEAWorkerWrapper);
+Comlink.expose(workerWrapper);