Modify FEAScript to use class-based structure and remove JSON configuration files. Update README for clarity on usage and configuration.

Author: nikoscham

CONTRIBUTING.md

@@ -1,22 +1,29 @@
 ## Contributing to FEAScript
 
-Thank you for your interest in contributing! FEAScript is in early development with continuous addition of new features and improvements. To ensure a smooth and collaborative development process, please review and follow the guidelines.
+Thank you for your interest in contributing! FEAScript is in early development, with continuous additions of new features and improvements. To ensure a smooth and collaborative development process, please review and follow the guidelines below.
 
 ## Contribution Guidelines
 
-<!--1. Search the <a href="https://github.com/FEAScript/FEAScript/wiki/Roadmap" target="_blank">project roadmap</a> to see areas where help is needed.-->
+1. **Respect the existing coding style:** Observe the code near your intended changes and aim to preserve that style in your modifications.
 
-1. Respect the existing FEAScript coding style. Observe the code near your intended change and attempt to preserve that style with your modifications.
+2. **Recommended tools:**  
+   We recommend using [Visual Studio Code](https://code.visualstudio.com/) with the [Prettier plugin](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for automatic code formatting. Additionally, use a **110-character line width** to maintain consistent formatting.
 
-2. We recommend using <a href="https://code.visualstudio.com/" target="_blank">Visual Studio Code</a> with the <a href="https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode" target="_blank">Prettier</a> plugin for automatic code formatting. Additionally, we use a 110-character line width to maintain consistent formatting.
+3. **Naming conventions:**  
+   Use [camelCase](https://en.wikipedia.org/wiki/Camel_case) formatting for variable names throughout the code.
 
-3. Ensure that you use <a href="https://en.wikipedia.org/wiki/Camel_case" target="_blank">camelCase</a> formatting for variable names throughout the code.
+4. **Testing changes locally:**  
+   Before submitting a pull request, test your modifications by running the FEAScript library from a local directory. For example, you can load the library in your HTML file as follows:
 
-4. Before applying for a pull request, you can test your modifications by running the FEAScript library from a local server. For security reasons, it is recommended to use a <a href="https://docs.python.org/3/library/http.server.html" target="_blank">Python HTTP Server</a> by executing the following <a href="https://github.com/FEAScript/FEAScript-website/blob/main/corsHttpServer.py" target="_blank">script</a>. Start the Python server by running `python3 corsHttpServer.py` in your local repository folder. The server address will be http://127.0.0.1:8000/.
+   ```javascript
+   import { FEAScriptModel, plotSolution, printVersion } from "../../FEAScript/src/index.js";
+   ```
 
-   Alternatively, you can disable CORS in your browser for local testing. To disable CORS in Firefox:
+   For security reasons, it is still recommended to use a local server to handle CORS policies correctly. You can use a <a href="https://docs.python.org/3/library/http.server.html" target="_blank">Python HTTP Server</a> by executing the following <a href="https://github.com/FEAScript/FEAScript-website/blob/main/corsHttpServer.py" target="_blank">script</a> to start a local server:
 
-   1. Open Firefox and type `about:config` in the address bar, then press Enter.
-   2. Accept the risk and continue to the advanced settings.
-   3. In the search bar, type `security.fileuri.strict_origin_policy`.
-   4. Double-click on the `security.fileuri.strict_origin_policy` preference to set it to `false`.
+   ```bash
+   python3 corsHttpServer.py
+   ```
+
+   The server will be available at:  
+   `http://127.0.0.1:8000/`

README.md

@@ -9,7 +9,7 @@
 
 ## How to Use
 
-FEAScript is built entirely in pure JavaScript, requiring only an HTML page to run. Simulation inputs are provided as <a href="https://www.w3schools.com/js/js_json_intro.asp" target="_blank">JSON</a> files, which can be stored locally or hosted online using platforms like <a href="https://pages.github.com/" target="_blank">GitHub Pages</a> or <a href="https://www.jsonkeeper.com/" target="_blank">JSON Keeper</a>. FEAScript operates entirely within your browser, with no reliance on cloud services. You can explore various examples demonstrating how to use FEAScript to solve a range of problems <a href="https://github.com/FEAScript/FEAScript/tree/main/examples" target="_blank">here</a>.
+FEAScript is built entirely in pure JavaScript, requiring only an HTML page to run. Simulation inputs are provided directly through JavaScript objects. FEAScript operates entirely within your browser, with no reliance on cloud services. You can explore various examples demonstrating how to use FEAScript to solve a range of problems <a href="https://github.com/FEAScript/FEAScript/tree/main/examples" target="_blank">here</a>.
 
 ## Contribute
 

examples/solidHeatTransferScript/exampleSolidHeatTransfer01/FEAScriptExampleSolidHeatTransfer01.html

@@ -1,4 +1,15 @@
 <!DOCTYPE html>
+
+<!--   ______ ______           _____           _       _     -->
+<!--  |  ____|  ____|   /\    / ____|         (_)     | |    -->
+<!--  | |__  | |__     /  \  | (___   ___ ____ _ ____ | |_   -->
+<!--  |  __| |  __|   / /\ \  \___ \ / __|  __| |  _ \| __|  -->
+<!--  | |    | |____ / ____ \ ____) | (__| |  | | |_) | |    -->
+<!--  |_|    |______/_/    \_\_____/ \___|_|  |_|  __/| |    -->
+<!--                                            | |   | |    -->
+<!--                                            |_|   | |_   -->
+<!--       Website: https://feascript.com/             \__|  -->
+
 <html lang="en">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
@@ -19,10 +30,9 @@ <h1>Heat Conduction in a Two-Dimensional Fin Example</h1>
     <div id="solutionPlot"></div>
 
     <p>
-      The mesh configuration and boundary conditions can be adjusted by editing the respective JSON files
-      (`meshConfig.json` and `boundaryConditionsConfig.json`). The solver configuration is set explicitly to
-      `solidHeatTransferScript` in this example. Please refresh the page to update the results. Detailed
-      instructions for this example can be found in the corresponding
+      The mesh configuration and boundary conditions are defined directly within the JavaScript code in this
+      example. Please refresh the page to update the results. Detailed instructions for this example can be
+      found in the corresponding
       <a
         href="https://github.com/FEAScript/FEAScript-website/blob/main/tutorialSolidHeatTransfer01/tutorialSolidHeatTransfer01.html"
         target="_blank"
@@ -31,70 +41,54 @@ <h1>Heat Conduction in a Two-Dimensional Fin Example</h1>
       <a href="https://feascript.com/" target="_blank">FEAScript website</a>.
     </p>
 
-    <p>
-      This example requires Cross-Origin Resource Sharing (CORS) to run if the JSON files are stored locally.
-      To enable CORS on Firefox, you can follow these steps:
-    </p>
-    <ol>
-      <li>Open Firefox and type <code>about:config</code> in the address bar, then press Enter.</li>
-      <li>Accept the risk and continue to the advanced settings.</li>
-      <li>
-        In the search bar, type
-        <code>security.fileuri.strict_origin_policy</code>.
-      </li>
-      <li>
-        Double-click on the
-        <code>security.fileuri.strict_origin_policy</code> preference to set it to <code>false</code>.
-      </li>
-    </ol>
-
     <p>
       FEAScript is distributed under the terms of the
       <a href="https://opensource.org/license/mit" target="_blank">MIT license</a>. © 2024 FEAScript.
     </p>
 
-    <!-- JSON fetching -->
-    <script>
-      let meshConfig, boundaryConditionsConfig;
-      const solverConfig = "solidHeatTransferScript"; // Set solverConfig explicitly
-
-      // Function to fetch and parse JSON files
-      function fetchJSON(url) {
-        return fetch(url).then((response) => response.json());
-      }
-
-      // Fetch JSON files asynchronously from the provided URLs
-      Promise.all([fetchJSON("meshConfig.json"), fetchJSON("boundaryConditionsConfig.json")]).then(
-        ([meshConfigData, boundaryConditionsConfigData]) => {
-          meshConfig = meshConfigData;
-          boundaryConditionsConfig = boundaryConditionsConfigData;
-        }
-      );
-    </script>
-
     <!-- FEAScript module and visualization -->
     <script type="module">
       import {
-        FEAScript,
+        FEAScriptModel,
         plotSolution,
         printVersion,
       } from "https://feascript.github.io/FEAScript/src/index.js";
 
       window.addEventListener("DOMContentLoaded", () => {
         // Print FEAScript version in the console
         printVersion();
-        // Calculate solution and render plot once JSON data is loaded
-        let { solutionVector, nodesCoordinates } = FEAScript(
-          solverConfig,
-          meshConfig,
-          boundaryConditionsConfig
-        );
+
+        // Create a new FEAScript model
+        const model = new FEAScriptModel();
+
+        // Set solver configuration
+        model.setSolverConfig("solidHeatTransferScript");
+
+        // Define mesh configuration
+        model.setMeshConfig({
+          meshDimension: "2D",
+          elementOrder: "quadratic",
+          numElementsX: 8,
+          numElementsY: 4,
+          maxX: 4,
+          maxY: 2,
+        });
+
+        // Define boundary conditions
+        model.addBoundaryCondition("0", ["constantTemp", 200]);
+        model.addBoundaryCondition("1", ["symmetry"]);
+        model.addBoundaryCondition("2", ["convection", 1, 20]);
+        model.addBoundaryCondition("3", ["constantTemp", 200]);
+
+        // Solve the problem and get the solution
+        const { solutionVector, nodesCoordinates } = model.solve();
+
         // Plot the solution as a 2D contour plot
         plotSolution(
           solutionVector,
           nodesCoordinates,
-          solverConfig,
-          meshConfig.meshDimension,
+          model.solverConfig,
+          model.meshConfig.meshDimension,
           "contour",
           "solutionPlot"
         );

examples/solidHeatTransferScript/exampleSolidHeatTransfer01/README.md

@@ -1,34 +1,9 @@
-<img src="https://feascript.github.io/FEAScript-website/images/FEAScriptLogo.png" width="80">
+<img src="https://feascript.github.io/FEAScript-website/images/FEAScriptLogo.png" width="80" alt="FEAScript Logo">
 
 ## Heat Conduction in a Two-Dimensional Fin
 
-This example demonstrates how to solve a stationary heat transfer problem within a 2D rectangular domain using the FEAScript library. The problem is a typical cooling fin scenario.
+This example demonstrates solving a steady-state heat transfer problem in a 2D rectangular domain using the **FEAScript** library. The problem represents a typical cooling fin scenario, where the objective is to model heat conduction and understand temperature distribution under specific boundary conditions.
 
-### Files
+### Instructions
 
-- `meshConfig.json`: Defines the computational mesh parameters.
-- `boundaryConditionsConfig.json`: Specifies the boundary conditions for the problem.
-- `FEAScriptExampleSolidHeatTransfer01.html`: The main HTML file that sets up and runs the example.
-
-### CORS Configuration
-
-<p>
-  This example requires Cross-Origin Resource Sharing (CORS) to run if the JSON files are stored locally. To
-  enable CORS on Firefox, you can follow these steps:
-</p>
-<ol>
-  <li>
-    Open Firefox and type <code>about:config</code> in the address bar, then
-    press Enter.
-  </li>
-  <li>Accept the risk and continue to the advanced settings.</li>
-  <li>
-    In the search bar, type
-    <code>security.fileuri.strict_origin_policy</code>.
-  </li>
-  <li>
-    Double-click on the
-    <code>security.fileuri.strict_origin_policy</code> preference to set it
-    to <code>false</code>.
-  </li>
-</ol>
+The **mesh configuration** and **boundary conditions** are defined directly in the JavaScript section of the HTML file. For a step-by-step guide and additional details, refer to the corresponding [tutorial](https://github.com/FEAScript/FEAScript-website/blob/main/tutorialSolidHeatTransfer01/tutorialSolidHeatTransfer01.html).

examples/solidHeatTransferScript/exampleSolidHeatTransfer01/boundaryConditionsConfig.json

@@ -17,35 +17,55 @@ import { assembleSolidHeatTransferMat } from "./solvers/solidHeatTransferScript.
  * @param {object} boundaryConditions - Object containing boundary conditions for the finite element analysis
  * @returns {object} An object containing the solution vector and additional mesh information
  */
-export function FEAScript(solverConfig, meshConfig, boundaryConditions) {
-  let jacobianMatrix = []; // Jacobian matrix
-  let residualVector = []; // Galerkin residuals
-  let solutionVector = []; // Solution vector
-  let nodesCoordinates = {}; // Object to store x and y coordinates of nodes
-
-  // Assembly matrices
-  console.time("assemblyMatrices");
-  if (solverConfig === "solidHeatTransferScript") {
-    console.log("FEAScript solver:", solverConfig);
-    ({ jacobianMatrix, residualVector, nodesCoordinates } = assembleSolidHeatTransferMat(
-      meshConfig,
-      boundaryConditions
-    ));
+export class FEAScriptModel {
+  constructor() {
+    this.solverConfig = null;
+    this.meshConfig = {};
+    this.boundaryConditions = {};
+  }
+
+  setSolverConfig(solverConfig) {
+    this.solverConfig = solverConfig;
+  }
+
+  setMeshConfig(meshConfig) {
+    this.meshConfig = meshConfig;
+  }
+
+  addBoundaryCondition(boundaryKey, condition) {
+    this.boundaryConditions[boundaryKey] = condition;
+  }
+
+  solve() {
+    if (!this.solverConfig || !this.meshConfig || !this.boundaryConditions) {
+      throw new Error("Solver config, mesh config, and boundary conditions must be set before solving.");
+    }
+
+    let jacobianMatrix = []; // Jacobian matrix
+    let residualVector = []; // Galerkin residuals
+    let solutionVector = []; // Solution vector
+    let nodesCoordinates = {}; // Object to store x and y coordinates of nodes
+
+    // Assembly matrices
+    console.time("assemblyMatrices");
+    if (this.solverConfig === "solidHeatTransferScript") {
+      console.log("FEAScript solver:", this.solverConfig);
+      ({ jacobianMatrix, residualVector, nodesCoordinates } = assembleSolidHeatTransferMat(
+        this.meshConfig,
+        this.boundaryConditions
+      ));
+    }
+    console.timeEnd("assemblyMatrices");
+
+    // System solving
+    console.time("systemSolving");
+    solutionVector = math.lusolve(jacobianMatrix, residualVector); // Solve the system of linear equations using LU decomposition
+    console.timeEnd("systemSolving");
+
+    // Return the solution matrix and nodes coordinates
+    return {
+      solutionVector,
+      nodesCoordinates,
+    };
   }
-  console.timeEnd("assemblyMatrices");
-
-  // System solving
-  console.time("systemSolving");
-  solutionVector = math.lusolve(jacobianMatrix, residualVector); // Solve the system of linear equations using LU decomposition
-  console.timeEnd("systemSolving");
-
-  // Debugging statements
-  //console.log(x);
-  //console.log("nodesCoordinates:", nodesCoordinates);
-
-  // Return the solution matrix and nodes coordinates
-  return {
-    solutionVector,
-    nodesCoordinates,
-  };
 }

examples/solidHeatTransferScript/exampleSolidHeatTransfer01/meshConfig.json

@@ -8,6 +8,6 @@
 //                                            |_|   | |_   //
 //       Website: https://feascript.com/             \__|  //
 
-export { FEAScript } from "./FEAScript.js";
+export { FEAScriptModel } from "./FEAScript.js";
 export { plotSolution } from "./visualization/plotSolutionScript.js";
 export { printVersion } from "./utilities/helperFunctionsScript.js";

src/FEAScript.js

@@ -13,13 +13,13 @@
  */
 export async function printVersion() {
   // Fetch the latest release information
-  const releaseResponse = await fetch("https://api.github.com/repos/FEAScript/FEAScript/releases/latest");
-  const releaseData = await releaseResponse.json();
-  console.log(`FEAScript version: ${releaseData.tag_name} - ${releaseData.name}`);
+  //const releaseResponse = await fetch("https://api.github.com/repos/FEAScript/FEAScript/releases/latest");
+  //const releaseData = await releaseResponse.json();
+  //console.log(`FEAScript version: ${releaseData.tag_name} - ${releaseData.name}`);
 
   // Fetch the latest commit date
-  //const commitResponse = await fetch('https://api.github.com/repos/FEAScript/FEAScript/commits/main');
-  //const commitData = await commitResponse.json();
-  //const latestCommitDate = new Date(commitData.commit.committer.date).toLocaleString();
-  //console.log(`Latest FEAScript update: ${latestCommitDate}`);
+  const commitResponse = await fetch("https://api.github.com/repos/FEAScript/FEAScript/commits/main");
+  const commitData = await commitResponse.json();
+  const latestCommitDate = new Date(commitData.commit.committer.date).toLocaleString();
+  console.log(`Latest FEAScript update: ${latestCommitDate}`);
 }