frontPropagationScript solver (#29)

* Added initial file for frontPropagationScript

* Refactor Heat Conduction example: add JavaScript implementation, update README instructions, and enhance .gitignore

* - Enhanced frontPropagationScript.js with a new function to assemble the front propagation matrix, including detailed JSDoc comments.
- Updated version number in package.json and src/index.js to 0.1.2.
- Added logging for FEAScript version in HeatConduction1DWall.js.
- Updated peer dependency for plotly.js to version 2.35.3.
- Removed unnecessary dependencies from package-lock.json and package.json.

* Reorganize README sections for clarity: update installation options and example usage

* Update README for improved clarity: reorganize installation options and example usage sections

* Remove HTML examples and add Node.js implementations for heat conduction simulations

* Add front propagation matrix assembly to FEAScriptModel

* Enhance front propagation matrix assembly and initiate Newton-Raphson method

* Update parameters names and improve convergence logic in Newton-Raphson method

* Add Euclidean norm function and update Newton-Raphson method to use it for error calculation

* Update README files to clarify Node.js environment suitability for heat conduction examples

* Integrate Newton-Raphson method into front propagation solver

* Refactor Newton-Raphson method to accept matrix assembly function and context, enhancing front propagation solver with eikonal viscous term parameterization

* Add a seperate linear system solver function (linearSystemScript.js). Refactor linearSystemScript.js and FEAScript.js to utilize it

* Include error logging for unknown linear solver

* Refactor Jacobi and Newton-Raphson methods to standardize solution vector naming

* Fix import path for logging utilities in Newton-Raphson script

* Add todo statements in frontPropagationScript.js

* Improve Readability and Maintainability of meshGenerationScript.js (#28)

* Redefining the mesh script as a Class

* Deleting meshGeneration class and replacing it to the Mesh1D and Mesh2D classes

* Replace meshGeneration class with the Mesh1D and Mesh2D classes

* Fix non-capitalized class names

* Rename variables for consistency

* Create a new file for generic boundary condutions (genericBoundaryConditionsScript.js). Possible need to consolidate with thermalBoundaryConditionsScript.js in the future

* Add residual and Jacobian terms for the eikonal equation

* Refactor Jacobian determinant calculation

* Update boundary condition handling to use 'constantValue' instead of 'constantTemp'

* Refactor Newton-Raphson implementation and improve debug logging in boundary conditions

* Enhance eikonal equation solver with initial solution handling and improve logging in boundary condition applications

* Refactor eikonal equation parameters and update Newton-Raphson convergence tolerance; add helper function for system size calculation

* - Reduce the number of incremental steps for the eikonal term activation in FEAScript.js from 10 to 5
- Reorganize the return statement in meshGenerationScript.js since it was causing an error in the case of linear elements
- Update logging messages in newtonRaphsonScript.js
- Increase the base viscous term in frontPropagationScript.js from 1e-3 to 1e-2 to prevent stability issues

---------

Co-authored-by: ferrari212 <felipe.ferrari.212@gmail.com>

Author: nikoscham

.gitignore

@@ -1,3 +1,9 @@
+# Dependencies
 /node_modules
 node_modules
-node_modules/
+node_modules/
+
+# Example dependencies
+examples/**/package.json
+examples/**/package-lock.json
+examples/**/node_modules/

README.md

@@ -2,15 +2,43 @@
 
 # FEAScript-core
 
-[FEAScript](https://feascript.com/) is a lightweight finite element simulation library built in JavaScript. It empowers users to create and execute browser-based simulations for physics and engineering applications. This is the core library of FEAScript.
+[FEAScript](https://feascript.com/) is a lightweight finite element simulation library built in JavaScript. It empowers users to create and execute simulations for physics and engineering applications in both browser-based and server-side environments. This is the core library of FEAScript.
 
 > 🚧 **FEAScript is currently under heavy development.** Functionality and interfaces may change rapidly as new features and enhancements are introduced. 🚧
 
 ## Installation
 
-FEAScript is entirely implemented in pure JavaScript and requires only a simple HTML page to operate. All simulations are executed locally in your browser, without the need for any cloud services. You can use FEAScript in your projects through one of the following methods:
+FEAScript is entirely implemented in pure JavaScript and can run in two environments:
 
-### Option 1: NPM Installation
+1. **In the browser** with a simple HTML page, where all simulations are executed locally without any installations or using any cloud services
+2. **Via Node.js** with plain JavaScript files, for server-side simulations
+
+### Option 1: In the Browser
+
+You can use FEAScript in browser environments in two ways:
+
+**Direct Import from CDN**:
+Add this to your HTML file:
+
+```html
+<script type="module">
+  import { FEAScriptModel } from "https://core.feascript.com/dist/feascript.esm.js";
+</script>
+```
+
+**Download and Use Locally**:
+1. Download the latest release from [GitHub Releases](https://github.com/FEAScript/FEAScript-core/releases)
+2. Include it in your HTML file:
+
+```html
+<script type="module">
+  import { FEAScriptModel } from "./path/to/dist/feascript.esm.js";
+</script>
+```
+
+For browser-based examples and use cases, visit [our website tutorials](https://feascript.com/#tutorials).
+
+### Option 2: Via Node.js
 
 ```bash
 # Install FEAScript and its peer dependencies
@@ -20,53 +48,36 @@ npm install feascript mathjs plotly.js
 Then import it in your JavaScript/TypeScript file:
 
 ```javascript
-// ES Modules
-import { FEAScriptModel, plotSolution } from "feascript";
-
-// CommonJS
-const { FEAScriptModel, plotSolution } = require("feascript");
+import { FEAScriptModel } from "feascript";
 ```
 
-**Important:** FEAScript is built as an ES module. If you're starting a new project, make sure to configure it to use ES modules by running:
+**Important:** FEAScript is built as an ES module. If you're starting a completely new project (outside this repository), make sure to configure it to use ES modules by (when running examples from within this repository, this step is not needed as the root package.json already has the proper configuration):
 
 ```bash
 # Create package.json with type=module for ES modules support
 echo '{"type":"module"}' > package.json
 ```
 
-If you already have a package.json file, manually add `"type": "module"` to enable ES modules in your project.
+Explore various Node.js examples and use cases [here](https://github.com/FEAScript/FEAScript-core/tree/main/examples).
 
-### Option 2: Direct Import from CDN
-
-Add this line to your HTML or JavaScript module:
+## Example Usage
 
+**Browser Import:**
 ```javascript
-import { FEAScriptModel, plotSolution } from "https://core.feascript.com/dist/feascript.esm.js";
+// Import FEAScript library in browser
+import { FEAScriptModel } from "https://core.feascript.com/dist/feascript.esm.js";
 ```
 
-### Option 3: Download and Use Locally
-
-1. Download the latest release from [GitHub Releases](https://github.com/FEAScript/FEAScript-core/releases)
-2. Include it in your project:
-
-```html
-<script type="module">
-  import { FEAScriptModel, plotSolution } from "./path/to/dist/feascript.esm.js";
-  // Your code here
-</script>
+**Node.js Import:**
+```javascript
+// Import FEAScript library in Node.js
+import { FEAScriptModel } from "feascript";
 ```
-
-### Example Usage
-
 ```javascript
-// Import FEAScript library
-import { FEAScriptModel, plotSolution } from "https://core.feascript.com/dist/feascript.esm.js";
-
 // Create and configure model
 const model = new FEAScriptModel();
 model.setSolverConfig("solverType"); // e.g., "solidHeatTransfer" for a stationary solid heat transfer case
 model.setMeshConfig({
-  // Define mesh configuration (assuming a rectangular domain for 2D)
   meshDimension: "1D" | "2D", // Mesh dimension
   elementOrder: "linear" | "quadratic", // Element order
   numElementsX: number, // Number of elements in x-direction
@@ -79,21 +90,10 @@ model.setMeshConfig({
 model.addBoundaryCondition("boundaryIndex", ["conditionType", /* parameters */]);
 
 // Solve
+model.setSolverMethod("linearSolver"); // lusolve (via mathjs) or jacobi
 const { solutionVector, nodesCoordinates } = model.solve();
-
-// Plot results
-plotSolution(
-  solutionVector,
-  nodesCoordinates,
-  model.solverConfig,
-  model.meshConfig.meshDimension,
-  "plotType", // e.g., "contour"
-  "targetDivId" // HTML div ID for plot
-);
 ```
 
-Explore various examples and use cases of FEAScript [here](https://github.com/FEAScript/FEAScript-core/tree/main/examples).
-
 ## Contribute
 
 We warmly welcome contributors to help expand and refine FEAScript. Please see the [CONTRIBUTING.md](./CONTRIBUTING.md) file for detailed guidance on how to contribute.

dist/feascript.cjs.js

@@ -0,0 +1,47 @@
+//   ______ ______           _____           _       _     //
+//  |  ____|  ____|   /\    / ____|         (_)     | |    //
+//  | |__  | |__     /  \  | (___   ___ ____ _ ____ | |_   //
+//  |  __| |  __|   / /\ \  \___ \ / __|  __| |  _ \| __|  //
+//  | |    | |____ / ____ \ ____) | (__| |  | | |_) | |    //
+//  |_|    |______/_/    \_\_____/ \___|_|  |_|  __/| |    //
+//                                            | |   | |    //
+//                                            |_|   | |_   //
+//       Website: https://feascript.com/             \__|  //
+
+// Import Math.js
+import * as math from "mathjs";
+global.math = math;
+
+// Import FEAScript library
+import { FEAScriptModel, logSystem, VERSION } from "feascript";
+
+console.log('FEAScript Version:', VERSION);
+
+// Create a new FEAScript model
+const model = new FEAScriptModel();
+
+// Set solver configuration
+model.setSolverConfig("solidHeatTransferScript");
+
+// Define mesh configuration
+model.setMeshConfig({
+  meshDimension: "1D",
+  elementOrder: "linear",
+  numElementsX: 10,
+  maxX: 0.15,
+});
+
+// Define boundary conditions
+model.addBoundaryCondition("0", ["convection", 1, 25]);
+model.addBoundaryCondition("1", ["constantTemp", 5]);
+
+// Set solver method (optional)
+model.setSolverMethod("lusolve");
+
+// Solve the problem and get the solution
+const { solutionVector, nodesCoordinates } = model.solve();
+
+// Print results to console
+console.log("Solution vector:", solutionVector);
+console.log("Node coordinates:", nodesCoordinates);
+console.log(`Number of nodes: ${nodesCoordinates.nodesXCoordinates.length}`);