Enhance documentation and code clarity across multiple scripts by updating function descriptions, organizing imports, and improving formatting for better readability

Author: nikoscham

CONTRIBUTING.md

@@ -20,7 +20,62 @@ Thank you for your interest in contributing! FEAScript is in early development,
    ```
 
    FEAScript can be run on a local server. To start a local server, you can use [Python HTTP Server](https://docs.python.org/3/library/http.server.html):
-      ```bash
-      python -m http.server
-      ```
+
+   ```bash
+   python -m http.server
+   ```
+
    where the server will be available at `http://127.0.0.1:8000/`. Static file server npm packages like [serve](https://github.com/vercel/serve#readme) and [Vite](https://vite.dev/) can also be used.
+
+## File Structure Guidelines
+
+All files in the FEAScript-core codebase should follow this structure:
+
+1. **Banner**: All files start with the FEAScript ASCII art banner
+2. **Imports**:
+   - External imports (from npm packages) first, alphabetically ordered
+   - Internal imports next, grouped by module/folder
+3. **Classes/Functions**: Implementation with proper JSDoc comments
+
+Example:
+
+```javascript
+//   ______ ______           _____           _       _     //
+//  |  ____|  ____|   /\    / ____|         (_)     | |    //
+//  | |__  | |__     /  \  | (___   ___ ____ _ ____ | |_   //
+//  |  __| |  __|   / /\ \  \___ \ / __|  __| |  _ \| __|  //
+//  | |    | |____ / ____ \ ____) | (__| |  | | |_) | |    //
+//  |_|    |______/_/    \_\_____/ \___|_|  |_|  __/| |    //
+//                                            | |   | |    //
+//                                            |_|   | |_   //
+//       Website: https://feascript.com/             \__|  //
+
+// External imports
+import { mathLibrary } from "math-package";
+
+// Internal imports
+import { relatedFunction } from "../utilities/helperScript.js";
+
+/**
+ * Class to handle specific functionality
+ */
+export class MyClass {
+  /**
+   * Constructor to initialize the class
+   * @param {object} options - Configuration options
+   */
+  constructor(options) {
+    // Implementation
+  }
+
+  /**
+   * Function to perform a specific action
+   * @param {number} input - Input value
+   * @returns {number} Processed result
+   */
+  doSomething(input) {
+    // Implementation
+    return input * DEFAULT_VALUE;
+  }
+}
+```

src/FEAScript.js

@@ -8,12 +8,13 @@
 //                                            |_|   | |_   //
 //       Website: https://feascript.com/             \__|  //
 
-import { assembleSolidHeatTransferMat } from "./solvers/solidHeatTransferScript.js";
+// Internal imports
 import { jacobiMethod } from "./methods/jacobiMethodScript.js";
+import { assembleSolidHeatTransferMat } from "./solvers/solidHeatTransferScript.js";
 import { basicLog, debugLog } from "./utilities/loggingScript.js";
 
 /**
- * FEAScript: An open-source finite element simulation library developed in JavaScript
+ * Class to implement finite element analysis in JavaScript
  * @param {string} solverConfig - Parameter specifying the type of solver
  * @param {object} meshConfig - Object containing computational mesh details
  * @param {object} boundaryConditions - Object containing boundary conditions for the finite element analysis
@@ -35,7 +36,11 @@ export class FEAScriptModel {
 
   setMeshConfig(meshConfig) {
     this.meshConfig = meshConfig;
-    debugLog(`Mesh config set with dimensions: ${meshConfig.meshDimension}, elements: ${meshConfig.numElementsX}x${meshConfig.numElementsY || 1}`);
+    debugLog(
+      `Mesh config set with dimensions: ${meshConfig.meshDimension}, elements: ${meshConfig.numElementsX}x${
+        meshConfig.numElementsY || 1
+      }`
+    );
   }
 
   addBoundaryCondition(boundaryKey, condition) {
@@ -83,14 +88,14 @@ export class FEAScriptModel {
       const initialGuess = new Array(residualVector.length).fill(0);
       // Call Jacobi method with desired max iterations and tolerance
       const jacobiResult = jacobiMethod(jacobianMatrix, residualVector, initialGuess, 1000, 1e-6);
-      
+
       // Log convergence information
       if (jacobiResult.converged) {
         debugLog(`Jacobi method converged in ${jacobiResult.iterations} iterations`);
       } else {
         debugLog(`Jacobi method did not converge after ${jacobiResult.iterations} iterations`);
       }
-      
+
       solutionVector = jacobiResult.solution;
     }
     console.timeEnd("systemSolving");

src/mesh/basisFunctionsScript.js

@@ -23,7 +23,7 @@ export class basisFunctions {
   }
 
   /**
-   * Return the basis functions and their derivatives based on the dimension and order
+   * Function to calculate basis functions and their derivatives based on the dimension and order
    * @param {number} ksi - Natural coordinate (for both 1D and 2D)
    * @param {number} [eta] - Second natural coordinate (only for 2D elements)
    * @returns {object} An object containing:

src/mesh/meshGenerationScript.js

@@ -8,13 +8,13 @@
 //                                            |_|   | |_   //
 //       Website: https://feascript.com/             \__|  //
 
-/**
- * Class to handle the generation of structured finite element meshes
- */
-
+// Internal imports
 import { importGmshQuadTri } from "../readers/gmshReaderScript.js";
 import { errorLog } from "../utilities/loggingScript.js";
 
+/**
+ * Class to handle the generation of structured finite element meshes
+ */
 export class meshGeneration {
   /**
    * Constructor to initialize the meshGeneration class
@@ -46,7 +46,7 @@ export class meshGeneration {
   }
 
   /**
-   * Generate the mesh based on the dimension or custom mesh file
+   * Function to generate the mesh based on the dimension or custom mesh file
    * @returns {object} The generated mesh containing node coordinates and total nodes
    */
   generateMesh() {
@@ -64,7 +64,12 @@ export class meshGeneration {
           throw new Error(errorMessage);
         }
       } else if (this.meshDimension === "2D") {
-        if (this.numElementsX === null || this.maxX === null || this.numElementsY === null || this.maxY === null) {
+        if (
+          this.numElementsX === null ||
+          this.maxX === null ||
+          this.numElementsY === null ||
+          this.maxY === null
+        ) {
           const errorMessage =
             "numElementsX, maxX, numElementsY, and maxY are required parameters when generating a 2D mesh from geometry";
           errorLog(errorMessage);
@@ -78,7 +83,7 @@ export class meshGeneration {
   }
 
   /**
-   * Parse a custom mesh JSON file and generate the mesh
+   * Function to parse a custom mesh JSON file and generate the mesh
    * @param {string} meshFilePath - Path to the custom mesh file (JSON format)
    * @returns {object} Mesh data containing coordinates and connectivity
    */
@@ -106,7 +111,7 @@ export class meshGeneration {
   }
 
   /**
-   * Generate a structured mesh based on the msh file
+   * Function to generate a structured mesh based on the msh file
    * @returns {object} An object containing the coordinates of nodes,
    * total number of nodes, nodal numbering (NOP) array, and boundary elements
    */
@@ -118,7 +123,7 @@ export class meshGeneration {
   }
 
   /**
-   * Generate a structured mesh based on the geometry configuration
+   * Function to generate a structured mesh based on the geometry configuration
    * @returns {object} An object containing the coordinates of nodes,
    * total number of nodes, nodal numbering (NOP) array, and boundary elements
    */
@@ -233,21 +238,13 @@ export class meshGeneration {
   }
 
   /**
-   * Find the elements that belong to each boundary for a simple rectangular domain
+   * Function to find the elements that belong to each boundary for a simple rectangular domain
    * @returns {array} An array containing arrays of elements and their adjacent boundary side for each boundary
    * Each element in the array is of the form [elementIndex, side], where side for a rectangular element is:
    * 0 - Bottom side
    * 1 - Left side
    * 2 - Top side
    * 3 - Right side
-   *
-   * Example representation of boundaryElements array in case of a rectangular element:
-   * boundaryElements = [
-   *   [[element1, 0], [element2, 0], [element3, 0], ...], // Bottom boundary
-   *   [[element*, 1], [element*, 1], [element*, 1], ...], // Left boundary
-   *   [[element*, 2], [element*, 2], [element*, 2], ...], // Top boundary
-   *   [[element*, 3], [element*, 3], [element*, 3], ...]  // Right boundary
-   * ];
    */
   findBoundaryElements() {
     const boundaryElements = [];
@@ -294,7 +291,7 @@ export class meshGeneration {
   }
 
   /**
-   * Generate the nodal numbering (NOP) array for a structured mesh
+   * Function to generate the nodal numbering (NOP) array for a structured mesh
    * This array represents the connectivity between elements and their corresponding nodes
    * @param {number} numElementsX - Number of elements along the x-axis
    * @param {number} [numElementsY] - Number of elements along the y-axis (optional for 1D)

src/methods/jacobiMethodScript.js

@@ -9,7 +9,7 @@
 //       Website: https://feascript.com/             \__|  //
 
 /**
- * Solves a system of linear equations using the Jacobi iterative method
+ * Function to solve a system of linear equations using the Jacobi iterative method
  * @param {array} A - The coefficient matrix (must be square)
  * @param {array} b - The right-hand side vector
  * @param {array} x0 - Initial guess for solution vector
@@ -22,9 +22,9 @@
  */
 export function jacobiMethod(A, b, x0, maxIterations = 100, tolerance = 1e-7) {
   const n = A.length; // Size of the square matrix
-  let x = [...x0];    // Current solution (starts with initial guess)
+  let x = [...x0]; // Current solution (starts with initial guess)
   let xNew = new Array(n); // Next iteration's solution
-  
+
   for (let iteration = 0; iteration < maxIterations; iteration++) {
     // Perform one iteration
     for (let i = 0; i < n; i++) {
@@ -38,30 +38,30 @@ export function jacobiMethod(A, b, x0, maxIterations = 100, tolerance = 1e-7) {
       // Update xNew[i] using the Jacobi formula
       xNew[i] = (b[i] - sum) / A[i][i];
     }
-    
+
     // Check convergence
     let maxDiff = 0;
     for (let i = 0; i < n; i++) {
       maxDiff = Math.max(maxDiff, Math.abs(xNew[i] - x[i]));
     }
-    
+
     // Update x for next iteration
     x = [...xNew];
-    
+
     // Successfully converged if maxDiff is less than tolerance
     if (maxDiff < tolerance) {
       return {
         solution: x,
         iterations: iteration + 1,
-        converged: true
+        converged: true,
       };
     }
   }
-  
+
   // maxIterations were reached without convergence
   return {
     solution: x,
     iterations: maxIterations,
-    converged: false
+    converged: false,
   };
-}
+}

src/methods/numericalIntegrationScript.js

@@ -13,17 +13,17 @@
  */
 export class numericalIntegration {
   /**
-   * Constructor to initialize the numIntegration class
+   * Constructor to initialize the numericalIntegration class
    * @param {string} meshDimension - The dimension of the mesh
-   * @param {number} elementOrder - The order of elements
+   * @param {string} elementOrder - The order of elements
    */
   constructor({ meshDimension, elementOrder }) {
     this.meshDimension = meshDimension;
     this.elementOrder = elementOrder;
   }
 
   /**
-   * Return Gauss points and weights based on element configuration
+   * Function to return Gauss points and weights based on element configuration
    * @returns {object} An object containing:
    *  - gaussPoints: Array of Gauss points
    *  - gaussWeights: Array of Gauss weights

src/readers/gmshReaderScript.js

@@ -8,6 +8,11 @@
 //                                            |_|   | |_   //
 //       Website: https://feascript.com/             \__|  //
 
+/**
+ * Function to import mesh data from Gmsh format containing quadrilateral and triangular elements
+ * @param {File} file - The Gmsh file to be parsed
+ * @returns {object} The parsed mesh data including node coordinates, element connectivity, and boundary conditions
+ */
 const importGmshQuadTri = async (file) => {
   let result = {
     nodesXCoordinates: [],
@@ -17,7 +22,7 @@ const importGmshQuadTri = async (file) => {
       triangleElements: [],
     },
     boundaryElements: [],
-    boundaryConditions: [], 
+    boundaryConditions: [],
     gmshV: 0,
     ascii: false,
     fltBytes: "8",
@@ -54,9 +59,9 @@ const importGmshQuadTri = async (file) => {
     numElements: 0,
   };
   let elementsProcessedInBlock = 0;
-  
+
   let boundaryElementsByTag = {};
-  
+
   while (lineIndex < lines.length) {
     const line = lines[lineIndex];
 
@@ -136,10 +141,7 @@ const importGmshQuadTri = async (file) => {
         continue;
       }
 
-      if (
-        nodeBlocksProcessed < nodeEntityBlocks &&
-        currentNodeBlock.numNodes === 0
-      ) {
+      if (nodeBlocksProcessed < nodeEntityBlocks && currentNodeBlock.numNodes === 0) {
         currentNodeBlock = {
           dim: parseInt(parts[0], 10),
           tag: parseInt(parts[1], 10),
@@ -156,11 +158,7 @@ const importGmshQuadTri = async (file) => {
       }
 
       if (nodeTagsCollected < currentNodeBlock.numNodes) {
-        for (
-          let i = 0;
-          i < parts.length && nodeTagsCollected < currentNodeBlock.numNodes;
-          i++
-        ) {
+        for (let i = 0; i < parts.length && nodeTagsCollected < currentNodeBlock.numNodes; i++) {
           nodeTags.push(parseInt(parts[i], 10));
           nodeTagsCollected++;
         }
@@ -199,10 +197,7 @@ const importGmshQuadTri = async (file) => {
         continue;
       }
 
-      if (
-        elementBlocksProcessed < elementEntityBlocks &&
-        currentElementBlock.numElements === 0
-      ) {
+      if (elementBlocksProcessed < elementEntityBlocks && currentElementBlock.numElements === 0) {
         currentElementBlock = {
           dim: parseInt(parts[0], 10),
           tag: parseInt(parts[1], 10),
@@ -211,8 +206,7 @@ const importGmshQuadTri = async (file) => {
         };
 
         result.elementTypes[currentElementBlock.elementType] =
-          (result.elementTypes[currentElementBlock.elementType] || 0) +
-          currentElementBlock.numElements;
+          (result.elementTypes[currentElementBlock.elementType] || 0) + currentElementBlock.numElements;
 
         elementsProcessedInBlock = 0;
         lineIndex++;
@@ -225,16 +219,15 @@ const importGmshQuadTri = async (file) => {
 
         if (currentElementBlock.elementType === 1) {
           const physicalTag = currentElementBlock.tag;
-          
+
           if (!boundaryElementsByTag[physicalTag]) {
             boundaryElementsByTag[physicalTag] = [];
           }
-          
+
           boundaryElementsByTag[physicalTag].push(nodeIndices);
         } else if (currentElementBlock.elementType === 2) {
           result.nodalNumbering.triangleElements.push(nodeIndices);
         } else if (currentElementBlock.elementType === 3) {
-          
           result.nodalNumbering.quadElements.push(nodeIndices);
         }
 
@@ -250,42 +243,34 @@ const importGmshQuadTri = async (file) => {
     lineIndex++;
   }
 
-  result.physicalPropMap.forEach(prop => {
-    if (prop.dimension === 1) {  
+  result.physicalPropMap.forEach((prop) => {
+    if (prop.dimension === 1) {
       const boundaryNodes = boundaryElementsByTag[prop.tag] || [];
-      
+
       if (boundaryNodes.length > 0) {
         result.boundaryConditions.push({
           name: prop.name,
           tag: prop.tag,
-          nodes: boundaryNodes
+          nodes: boundaryNodes,
         });
       }
     }
   });
 
-  processBoundaryElements(
-    result.nodalNumbering.triangleElements,
-    result.boundaryElements,
-    3,
-    "triangle"
-  );
-  processBoundaryElements(
-    result.nodalNumbering.quadElements,
-    result.boundaryElements,
-    4,
-    "quad"
-  );
+  processBoundaryElements(result.nodalNumbering.triangleElements, result.boundaryElements, 3, "triangle");
+  processBoundaryElements(result.nodalNumbering.quadElements, result.boundaryElements, 4, "quad");
 
   return result;
 };
 
-function processBoundaryElements(
-  elements,
-  boundaryElements,
-  numNodes,
-  elementType
-) {
+/**
+ * Function to process boundary elements from a mesh
+ * @param {array} elements - Array of elements to process
+ * @param {array} boundaryElements - Array to store the boundary elements
+ * @param {number} numNodes - Number of nodes per element
+ * @param {string} elementType - Type of element (triangle, quad)
+ */
+function processBoundaryElements(elements, boundaryElements, numNodes, elementType) {
   const edgeCount = {};
 
   for (let i = 0; i < elements.length; i++) {
@@ -321,4 +306,4 @@ function processBoundaryElements(
   }
 }
 
-export { importGmshQuadTri };
+export { importGmshQuadTri };

src/solvers/solidHeatTransferScript.js

@@ -8,14 +8,15 @@
 //                                            |_|   | |_   //
 //       Website: https://feascript.com/             \__|  //
 
-import { basisFunctions } from "../mesh/basisFunctionsScript.js";
+// Internal imports
 import { numericalIntegration } from "../methods/numericalIntegrationScript.js";
+import { basisFunctions } from "../mesh/basisFunctionsScript.js";
 import { meshGeneration } from "../mesh/meshGenerationScript.js";
 import { ThermalBoundaryConditions } from "./thermalBoundaryConditionsScript.js";
 import { basicLog, debugLog } from "../utilities/loggingScript.js";
 
 /**
- * Assemble the solid heat transfer matrix
+ * Function to assemble the solid heat transfer matrix
  * @param {object} meshConfig - Object containing computational mesh details
  * @param {object} boundaryConditions - Object containing boundary conditions for the finite element analysis
  * @returns {object} An object containing:

src/solvers/thermalBoundaryConditionsScript.js

@@ -29,7 +29,7 @@ export class ThermalBoundaryConditions {
   }
 
   /**
-   * Impose constant temperature boundary conditions (Dirichlet type)
+   * Function to impose constant temperature boundary conditions (Dirichlet type)
    * @param {array} residualVector - The residual vector to be modified
    * @param {array} jacobianMatrix - The Jacobian matrix to be modified
    */
@@ -124,7 +124,7 @@ export class ThermalBoundaryConditions {
   }
 
   /**
-   * Impose convection boundary conditions (Robin type)
+   * Function to impose convection boundary conditions (Robin type)
    * @param {array} residualVector - The residual vector to be modified
    * @param {array} jacobianMatrix - The Jacobian matrix to be modified
    * @param {array} gaussPoints - Array of Gauss points for numerical integration
@@ -177,7 +177,7 @@ export class ThermalBoundaryConditions {
                 nodeIndex = 2;
               }
             }
-            
+
             const globalNodeIndex = this.nop[elementIndex][nodeIndex] - 1;
             residualVector[globalNodeIndex] += -convectionCoeff * extTemp;
             jacobianMatrix[globalNodeIndex][globalNodeIndex] += convectionCoeff;

src/utilities/loggingScript.js

@@ -9,46 +9,49 @@
 //       Website: https://feascript.com/             \__|  //
 
 // Global logging level
-let currentLogLevel = 'basic';
+let currentLogLevel = "basic";
 
 /**
  * Function to set the logging system level
  * @param {string} level - Logging level (basic, debug)
  */
 export function logSystem(level) {
-  if (level !== 'basic' && level !== 'debug') {
-    console.log('%c[WARN] Invalid log level: ' + level + '. Using basic instead.', 'color: #FFC107; font-weight: bold;'); // Yellow for warnings
-    currentLogLevel = 'basic';
+  if (level !== "basic" && level !== "debug") {
+    console.log(
+      "%c[WARN] Invalid log level: " + level + ". Using basic instead.",
+      "color: #FFC107; font-weight: bold;"
+    ); // Yellow for warnings
+    currentLogLevel = "basic";
   } else {
     currentLogLevel = level;
     basicLog(`Log level set to: ${level}`);
   }
 }
 
 /**
- * Debug logging function - only logs if level is 'debug'
+ * Function to log debug messages - only logs if level is 'debug'
  * @param {string} message - Message to log
  */
 export function debugLog(message) {
-  if (currentLogLevel === 'debug') {
-    console.log('%c[DEBUG] ' + message, 'color: #2196F3; font-weight: bold;'); // Blue color for debug
+  if (currentLogLevel === "debug") {
+    console.log("%c[DEBUG] " + message, "color: #2196F3; font-weight: bold;"); // Blue color for debug
   }
 }
 
 /**
- * Basic logging function - always logs
+ * Function to log basic information - always logs
  * @param {string} message - Message to log
  */
 export function basicLog(message) {
-  console.log('%c[INFO] ' + message, 'color: #4CAF50; font-weight: bold;'); // Green color for basic info
+  console.log("%c[INFO] " + message, "color: #4CAF50; font-weight: bold;"); // Green color for basic info
 }
 
 /**
- * Error logging function
+ * Function to log error messages
  * @param {string} message - Message to log
  */
 export function errorLog(message) {
-  console.log('%c[ERROR] ' + message, 'color: #F44336; font-weight: bold;'); // Red color for errors
+  console.log("%c[ERROR] " + message, "color: #F44336; font-weight: bold;"); // Red color for errors
 }
 
 /**

src/visualization/plotSolutionScript.js

@@ -9,7 +9,7 @@
 //       Website: https://feascript.com/             \__|  //
 
 /**
- * Create plots of the solution vector
+ * Function to create plots of the solution vector
  * @param {*} solutionVector - The computed solution vector
  * @param {*} nodesCoordinates - Object containing x and y coordinates for the nodes
  * @param {string} solverConfig - Parameter specifying the type of solver
@@ -33,7 +33,7 @@ export function plotSolution(
     // Check if solutionVector is a nested array
     let yData;
     if (solutionVector.length > 0 && Array.isArray(solutionVector[0])) {
-      yData = solutionVector.map(arr => arr[0]);
+      yData = solutionVector.map((arr) => arr[0]);
     } else {
       yData = solutionVector;
     }
@@ -45,7 +45,7 @@ export function plotSolution(
       mode: "lines",
       type: "scatter",
       line: { color: "rgb(219, 64, 82)", width: 2 },
-      name: "Solution"
+      name: "Solution",
     };
 
     let maxWindowWidth = Math.min(window.innerWidth, 700);
@@ -60,7 +60,7 @@ export function plotSolution(
       height: plotHeight,
       xaxis: { title: "x" },
       yaxis: { title: "Solution" },
-      margin: { l: 70, r: 40, t: 50, b: 50 }
+      margin: { l: 70, r: 40, t: 50, b: 50 },
     };
 
     Plotly.newPlot(plotDivId, [lineData], layout, { responsive: true });
@@ -70,20 +70,11 @@ export function plotSolution(
     const numNodesY = new Set(nodesYCoordinates).size;
 
     // Reshape the nodesXCoordinates and nodesYCoordinates arrays to match the grid dimensions
-    let reshapedXCoordinates = math.reshape(Array.from(nodesXCoordinates), [
-      numNodesX,
-      numNodesY,
-    ]);
-    let reshapedYCoordinates = math.reshape(Array.from(nodesYCoordinates), [
-      numNodesX,
-      numNodesY,
-    ]);
+    let reshapedXCoordinates = math.reshape(Array.from(nodesXCoordinates), [numNodesX, numNodesY]);
+    let reshapedYCoordinates = math.reshape(Array.from(nodesYCoordinates), [numNodesX, numNodesY]);
 
     // Reshape the solution array to match the grid dimensions
-    let reshapedSolution = math.reshape(Array.from(solutionVector), [
-      numNodesX,
-      numNodesY,
-    ]);
+    let reshapedSolution = math.reshape(Array.from(solutionVector), [numNodesX, numNodesY]);
 
     // Transpose the reshapedSolution array to get column-wise data
     let transposedSolution = math.transpose(reshapedSolution);
@@ -148,9 +139,7 @@ export function plotSolution(
 
     // Set the layout for the contour plot
     let layout = {
-      title: `${plotType} plot${
-        showMesh ? " with mesh" : ""
-      } - ${solverConfig}`,
+      title: `${plotType} plot${showMesh ? " with mesh" : ""} - ${solverConfig}`,
       width: plotWidth,
       height: plotHeight,
       xaxis: { title: "x" },

src/workers/workerScript.js

@@ -8,11 +8,15 @@
 //                                            |_|   | |_   //
 //       Website: https://feascript.com/             \__|  //
 
-// 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
+// External imports
 import * as Comlink from "../vendor/comlink.mjs";
+
+// Internal imports
 import { basicLog } from "../utilities/loggingScript.js";
 
+/**
+ * Class to facilitate communication with web workers for FEAScript operations
+ */
 export class FEAScriptWorker {
   /**
    * Constructor to initialize the FEAScriptWorker class
@@ -27,18 +31,15 @@ export class FEAScriptWorker {
   }
 
   /**
-   * Initializes the web worker and wraps it using Comlink.
+   * Function to initialize the web worker and wrap it using Comlink.
    * @private
    * @throws Will throw an error if the worker fails to initialize.
    */
   async _initWorker() {
     try {
-      this.worker = new Worker(
-        new URL("./wrapperScript.js", import.meta.url),
-        {
-          type: "module",
-        }
-      );
+      this.worker = new Worker(new URL("./wrapperScript.js", import.meta.url), {
+        type: "module",
+      });
 
       this.worker.onerror = (event) => {
         console.error("FEAScriptWorker: Worker error:", event);
@@ -55,7 +56,7 @@ export class FEAScriptWorker {
   }
 
   /**
-   * Ensures that the worker is ready before performing any operations.
+   * Function to ensure that the worker is ready before performing any operations.
    * @private
    * @returns {Promise<void>} Resolves when the worker is ready.
    * @throws Will throw an error if the worker is not ready within the timeout period.
@@ -82,7 +83,7 @@ export class FEAScriptWorker {
   }
 
   /**
-   * Sets the solver configuration in the worker.
+   * Function to set the solver configuration in the worker.
    * @param {string} solverConfig - The solver configuration to set.
    * @returns {Promise<boolean>} Resolves when the configuration is set.
    */
@@ -111,9 +112,7 @@ export class FEAScriptWorker {
    */
   async addBoundaryCondition(boundaryKey, condition) {
     await this._ensureReady();
-    basicLog(
-      `FEAScriptWorker: Adding boundary condition for boundary: ${boundaryKey}`
-    );
+    basicLog(`FEAScriptWorker: Adding boundary condition for boundary: ${boundaryKey}`);
     return this.feaWorker.addBoundaryCondition(boundaryKey, condition);
   }
 
@@ -140,12 +139,7 @@ export class FEAScriptWorker {
     const result = await this.feaWorker.solve();
     const endTime = performance.now();
 
-    basicLog(
-      `FEAScriptWorker: Solution completed in ${(
-        (endTime - startTime) /
-        1000
-      ).toFixed(2)}s`
-    );
+    basicLog(`FEAScriptWorker: Solution completed in ${((endTime - startTime) / 1000).toFixed(2)}s`);
     return result;
   }
 

src/workers/wrapperScript.js

@@ -8,16 +8,20 @@
 //                                            |_|   | |_   //
 //       Website: https://feascript.com/             \__|  //
 
-// 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
+// External imports
+import { create, all } from "https://cdn.jsdelivr.net/npm/mathjs@latest/+esm";
 import * as Comlink from "../vendor/comlink.mjs";
+
+// Internal imports
 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 to wrap the FEAScriptModel for use in a web worker context
+ */
 class workerWrapper {
   /**
    * Constructor to initialize the workerWrapper class.
@@ -34,7 +38,7 @@ class workerWrapper {
   }
 
   /**
-   * Sets the solver configuration in the FEAScriptModel.
+   * Function to set the solver configuration in the FEAScriptModel.
    * @param {string} solverConfig - The solver configuration to set.
    * @returns {boolean} Returns true if the configuration is set successfully.
    * @throws Will throw an error if the configuration fails to set.
@@ -50,7 +54,7 @@ class workerWrapper {
   }
 
   /**
-   * Sets the mesh configuration in the FEAScriptModel.
+   * Function to set the mesh configuration in the FEAScriptModel.
    * @param {object} meshConfig - The mesh configuration to set.
    * @returns {boolean} Returns true if the configuration is set successfully.
    * @throws Will throw an error if the configuration fails to set.
@@ -66,7 +70,7 @@ class workerWrapper {
   }
 
   /**
-   * Adds a boundary condition to the FEAScriptModel.
+   * Function to add a boundary condition to the FEAScriptModel.
    * @param {string} boundaryKey - The key identifying the boundary.
    * @param {array} condition - The boundary condition to add.
    * @returns {boolean} Returns true if the boundary condition is added successfully.
@@ -83,7 +87,7 @@ class workerWrapper {
   }
 
   /**
-   * Sets the solver method in the FEAScriptModel.
+   * Function to set the solver method in the FEAScriptModel.
    * @param {string} solverMethod - The solver method to set.
    * @returns {boolean} Returns true if the solver method is set successfully.
    * @throws Will throw an error if the solver method fails to set.
@@ -99,7 +103,7 @@ class workerWrapper {
   }
 
   /**
-   * Solves the problem using the FEAScriptModel.
+   * Function to solve the problem using the FEAScriptModel.
    * @returns {object} Returns the solution result, including the solution vector, node coordinates, solver configuration, and mesh dimension.
    * @throws Will throw an error if the solve operation fails.
    */
@@ -120,7 +124,7 @@ class workerWrapper {
   }
 
   /**
-   * Retrieves model information from the FEAScriptModel.
+   * Function to retrieve model information from the FEAScriptModel.
    * @returns {object} Returns the model information, including solver configuration, mesh configuration, boundary conditions, and solver method.
    * @throws Will throw an error if the model information fails to retrieve.
    */
@@ -139,7 +143,7 @@ class workerWrapper {
   }
 
   /**
-   * Simple ping method to check if the worker is responsive.
+   * Function to perform a simple ping to check if the worker is responsive.
    * @returns {boolean} Returns true to indicate the worker is available.
    */
   ping() {
@@ -152,4 +156,4 @@ class workerWrapper {
   }
 }
 
-Comlink.expose(workerWrapper);
+Comlink.expose(workerWrapper);