Add logging functionality using

loglevel (https://github.com/pimterry/loglevel?tab=MIT-1-ov-file#readme)

Author: nikoscham

NOTICE.md

@@ -9,3 +9,8 @@ FEAScript makes use of the following third-party software:
    - License: MIT License
    - Source: https://github.com/plotly/plotly.js/tree/master
    - License: https://github.com/plotly/plotly.js/blob/master/LICENSE
+
+2. **loglevel**
+   - License: MIT License
+   - Source: https://github.com/pimterry/loglevel
+   - License: https://github.com/pimterry/loglevel/blob/main/LICENSE-MIT

src/FEAScript.js

@@ -9,6 +9,9 @@
 //       Website: https://feascript.com/             \__|  //
 
 import { assembleSolidHeatTransferMat } from "./solvers/solidHeatTransferScript.js";
+import loggers from "./utilities/loggerScript.js";
+
+const log = loggers.main;
 
 /**
  * FEAScript: An open-source finite element simulation library developed in JavaScript
@@ -23,27 +26,34 @@ export class FEAScriptModel {
     this.meshConfig = {};
     this.boundaryConditions = {};
     this.solverMethod = "lusolve"; // Default solver method
+    log.info("FEAScriptModel instance created");
   }
 
   setSolverConfig(solverConfig) {
     this.solverConfig = solverConfig;
+    log.debug(`Solver config set to: ${solverConfig}`);
   }
 
   setMeshConfig(meshConfig) {
     this.meshConfig = meshConfig;
+    log.debug(`Mesh config set with dimensions: ${meshConfig.meshDimension}, elements: ${meshConfig.numElementsX}x${meshConfig.numElementsY || 1}`);
   }
 
   addBoundaryCondition(boundaryKey, condition) {
     this.boundaryConditions[boundaryKey] = condition;
+    log.debug(`Boundary condition added for key: ${boundaryKey}, type: ${condition[0]}`);
   }
 
   setSolverMethod(solverMethod) {
     this.solverMethod = solverMethod;
+    log.debug(`Solver method set to: ${solverMethod}`);
   }
 
   solve() {
     if (!this.solverConfig || !this.meshConfig || !this.boundaryConditions) {
-      throw new Error("Solver config, mesh config, and boundary conditions must be set before solving.");
+      const error = "Solver config, mesh config, and boundary conditions must be set before solving.";
+      log.error(error);
+      throw new Error(error);
     }
 
     let jacobianMatrix = []; // Jacobian matrix
@@ -52,22 +62,26 @@ export class FEAScriptModel {
     let nodesCoordinates = {}; // Object to store x and y coordinates of nodes
 
     // Assembly matrices
+    log.info("Beginning matrix assembly...");
     console.time("assemblyMatrices");
     if (this.solverConfig === "solidHeatTransferScript") {
-      console.log("FEAScript solver:", this.solverConfig);
+      log.info(`Using solver: ${this.solverConfig}`);
       ({ jacobianMatrix, residualVector, nodesCoordinates } = assembleSolidHeatTransferMat(
         this.meshConfig,
         this.boundaryConditions
       ));
     }
     console.timeEnd("assemblyMatrices");
+    log.info("Matrix assembly completed");
 
     // System solving
+    log.info(`Solving system using ${this.solverMethod}...`);
     console.time("systemSolving");
     if (this.solverMethod === "lusolve") {
       solutionVector = math.lusolve(jacobianMatrix, residualVector); // Solve the system of linear equations using LU decomposition
     }
     console.timeEnd("systemSolving");
+    log.info("System solved successfully");
 
     // Return the solution matrix and nodes coordinates
     return {

src/index.js

@@ -10,4 +10,5 @@
 
 export { FEAScriptModel } from "./FEAScript.js";
 export { plotSolution } from "./visualization/plotSolutionScript.js";
-export { printVersion } from "./utilities/helperFunctionsScript.js";
+export { printVersion, setLogLevel } from "./utilities/utilitiesScript.js";
+export { default as loggers } from "./utilities/loggerScript.js";

src/solvers/solidHeatTransferScript.js

@@ -12,6 +12,9 @@ import { basisFunctions } from "../mesh/basisFunctionsScript.js";
 import { numericalIntegration } from "../methods/numericalIntegrationScript.js";
 import { meshGeneration } from "../mesh/meshGenerationScript.js";
 import { ThermalBoundaryConditions } from "../methods/thermalBoundaryConditionsScript.js";
+import loggers from "../utilities/loggerScript.js";
+
+const log = loggers.solver;
 
 /**
  * Assemble the solid heat transfer matrix
@@ -23,6 +26,8 @@ import { ThermalBoundaryConditions } from "../methods/thermalBoundaryConditionsS
  *  - nodesCoordinates: Object containing x and y coordinates of nodes
  */
 export function assembleSolidHeatTransferMat(meshConfig, boundaryConditions) {
+  log.info("Starting solid heat transfer matrix assembly");
+  
   // Extract mesh details from the configuration object
   const {
     meshDimension, // The dimension of the mesh
@@ -33,6 +38,8 @@ export function assembleSolidHeatTransferMat(meshConfig, boundaryConditions) {
     elementOrder, // The order of elements
   } = meshConfig;
 
+  log.debug(`Mesh configuration: ${meshDimension}, Elements: ${numElementsX}x${numElementsY || 1}, Size: ${maxX}x${maxY || 0}, Order: ${elementOrder}`);
+
   // Extract boundary conditions from the configuration object
   let convectionHeatTranfCoeff = [];
   let convectionExtTemp = [];
@@ -41,10 +48,12 @@ export function assembleSolidHeatTransferMat(meshConfig, boundaryConditions) {
     if (boundaryCondition[0] === "convection") {
       convectionHeatTranfCoeff[key] = boundaryCondition[1];
       convectionExtTemp[key] = boundaryCondition[2];
+      log.debug(`Convection boundary condition on boundary ${key}: h=${boundaryCondition[1]}, T=${boundaryCondition[2]}`);
     }
   });
 
   // Create a new instance of the meshGeneration class
+  log.debug("Generating mesh...");
   const meshGenerationData = new meshGeneration({
     numElementsX,
     numElementsY,
@@ -56,6 +65,7 @@ export function assembleSolidHeatTransferMat(meshConfig, boundaryConditions) {
 
   // Generate the mesh
   const nodesCoordinatesAndNumbering = meshGenerationData.generateMesh();
+  log.debug("Mesh generated successfully");
 
   // Extract nodes coordinates and nodal numbering (NOP) from the mesh data
   let nodesXCoordinates = nodesCoordinatesAndNumbering.nodesXCoordinates;
@@ -68,6 +78,9 @@ export function assembleSolidHeatTransferMat(meshConfig, boundaryConditions) {
   // Initialize variables for matrix assembly
   const totalElements = numElementsX * (meshDimension === "2D" ? numElementsY : 1); // Total number of elements
   const totalNodes = totalNodesX * (meshDimension === "2D" ? totalNodesY : 1); // Total number of nodes
+  log.debug(`Total elements: ${totalElements}, Total nodes: ${totalNodes}`);
+  
+  // Initialize variables for matrix assembly
   let localNodalNumbers = []; // Local nodal numbering
   let gaussPoints = []; // Gauss points
   let gaussWeights = []; // Gauss weights
@@ -96,12 +109,14 @@ export function assembleSolidHeatTransferMat(meshConfig, boundaryConditions) {
   }
 
   // Initialize the basisFunctions class
+  log.debug("Initializing basis functions...");
   const basisFunctionsData = new basisFunctions({
     meshDimension,
     elementOrder,
   });
 
   // Initialize the numericalIntegration class
+  log.debug("Setting up numerical integration...");
   const numIntegrationData = new numericalIntegration({
     meshDimension,
     elementOrder,
@@ -114,6 +129,8 @@ export function assembleSolidHeatTransferMat(meshConfig, boundaryConditions) {
 
   // Determine the number of nodes in the reference element based on the first element in the nop array
   const numNodes = nop[0].length;
+  
+  log.info(`Beginning matrix assembly for ${totalElements} elements...`);
 
   // Matrix assembly
   for (let elementIndex = 0; elementIndex < totalElements; elementIndex++) {
@@ -236,6 +253,7 @@ export function assembleSolidHeatTransferMat(meshConfig, boundaryConditions) {
   }
 
   // Create an instance of ThermalBoundaryConditions
+  log.debug("Applying thermal boundary conditions...");
   const thermalBoundaryConditions = new ThermalBoundaryConditions(
     boundaryConditions,
     boundaryElements,
@@ -256,9 +274,13 @@ export function assembleSolidHeatTransferMat(meshConfig, boundaryConditions) {
     convectionHeatTranfCoeff,
     convectionExtTemp
   );
+  log.debug("Convection boundary conditions applied");
 
   // Impose ConstantTemp boundary conditions
   thermalBoundaryConditions.imposeConstantTempBoundaryConditions(residualVector, jacobianMatrix);
+  log.debug("Constant temperature boundary conditions applied");
+  
+  log.info("Solid heat transfer matrix assembly completed");
 
   return {
     jacobianMatrix,

src/utilities/helperFunctionsScript.js

@@ -0,0 +1,30 @@
+//   ______ ______           _____           _       _     //
+//  |  ____|  ____|   /\    / ____|         (_)     | |    //
+//  | |__  | |__     /  \  | (___   ___ ____ _ ____ | |_   //
+//  |  __| |  __|   / /\ \  \___ \ / __|  __| |  _ \| __|  //
+//  | |    | |____ / ____ \ ____) | (__| |  | | |_) | |    //
+//  |_|    |______/_/    \_\_____/ \___|_|  |_|  __/| |    //
+//                                            | |   | |    //
+//                                            |_|   | |_   //
+//       Website: https://feascript.com/             \__|  //
+
+import log from '../third-party/loglevel.min.js';
+
+// Configure default log level (can be overridden)
+log.setDefaultLevel(log.levels.INFO);
+
+// Create namespace-specific loggers for different parts of the app
+const loggers = {
+  main: log.getLogger('FEAScript'),
+  solver: log.getLogger('Solver'),
+  mesh: log.getLogger('Mesh'),
+  visualization: log.getLogger('Viz')
+};
+
+// Helper method to set all loggers to a specific level
+export function setAllLogLevels(level) {
+  Object.values(loggers).forEach(logger => logger.setLevel(level));
+}
+
+// Export the configured loggers
+export default loggers;

src/utilities/loggerScript.js

@@ -0,0 +1,40 @@
+//   ______ ______           _____           _       _     //
+//  |  ____|  ____|   /\    / ____|         (_)     | |    //
+//  | |__  | |__     /  \  | (___   ___ ____ _ ____ | |_   //
+//  |  __| |  __|   / /\ \  \___ \ / __|  __| |  _ \| __|  //
+//  | |    | |____ / ____ \ ____) | (__| |  | | |_) | |    //
+//  |_|    |______/_/    \_\_____/ \___|_|  |_|  __/| |    //
+//                                            | |   | |    //
+//                                            |_|   | |_   //
+//       Website: https://feascript.com/             \__|  //
+
+import loggers from './loggerScript.js';
+
+const log = loggers.main;
+
+/**
+ * Function to handle version information and fetch the latest update date and release from GitHub
+ */
+export async function printVersion() {
+  log.info("Fetching latest FEAScript version information...");
+  try {
+    // 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();
+    log.info(`Latest FEAScript update: ${latestCommitDate}`);
+    return latestCommitDate;
+  } catch (error) {
+    log.error("Failed to fetch version information:", error);
+    return "Version information unavailable";
+  }
+}
+
+/**
+ * Set the logging level for all loggers
+ * @param {string} level - The log level to set (trace, debug, info, warn, error)
+ */
+export function setLogLevel(level) {
+  loggers.setAllLogLevels(level);
+  log.info(`Log level set to: ${level}`);
+}