Refactor logging system: replace loglevel with custom logging functions and update related imports

Author: nikoscham

NOTICE.md

@@ -8,9 +8,4 @@ FEAScript makes use of the following third-party software:
 2. **plotly.js**
    - 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
+   - License: https://github.com/plotly/plotly.js/blob/master/LICENSE

src/FEAScript.js

@@ -9,6 +9,7 @@
 //       Website: https://feascript.com/             \__|  //
 
 import { assembleSolidHeatTransferMat } from "./solvers/solidHeatTransferScript.js";
+import { basicLog, debugLog } from "./utilities/utilitiesScript.js";
 
 /**
  * FEAScript: An open-source finite element simulation library developed in JavaScript
@@ -23,27 +24,27 @@ export class FEAScriptModel {
     this.meshConfig = {};
     this.boundaryConditions = {};
     this.solverMethod = "lusolve"; // Default solver method
-    console.log("FEAScriptModel instance created");
+    basicLog("FEAScriptModel instance created");
   }
 
   setSolverConfig(solverConfig) {
     this.solverConfig = solverConfig;
-    console.log(`Solver config set to: ${solverConfig}`);
+    debugLog(`Solver config set to: ${solverConfig}`);
   }
 
   setMeshConfig(meshConfig) {
     this.meshConfig = meshConfig;
-    console.log(`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) {
     this.boundaryConditions[boundaryKey] = condition;
-    console.log(`Boundary condition added for key: ${boundaryKey}, type: ${condition[0]}`);
+    debugLog(`Boundary condition added for boundary: ${boundaryKey}, type: ${condition[0]}`);
   }
 
   setSolverMethod(solverMethod) {
     this.solverMethod = solverMethod;
-    console.log(`Solver method set to: ${solverMethod}`);
+    debugLog(`Solver method set to: ${solverMethod}`);
   }
 
   solve() {
@@ -53,37 +54,33 @@ export class FEAScriptModel {
       throw new Error(error);
     }
 
-    let jacobianMatrix = []; // Jacobian matrix
-    let residualVector = []; // Galerkin residuals
-    let solutionVector = []; // Solution vector
-    let nodesCoordinates = {}; // Object to store x and y coordinates of nodes
+    let jacobianMatrix = [];
+    let residualVector = [];
+    let solutionVector = [];
+    let nodesCoordinates = {};
 
     // Assembly matrices
-    console.log("Beginning matrix assembly...");
+    basicLog("Beginning matrix assembly...");
     console.time("assemblyMatrices");
     if (this.solverConfig === "solidHeatTransferScript") {
-      console.log(`Using solver: ${this.solverConfig}`);
+      basicLog(`Using solver: ${this.solverConfig}`);
       ({ jacobianMatrix, residualVector, nodesCoordinates } = assembleSolidHeatTransferMat(
         this.meshConfig,
         this.boundaryConditions
       ));
     }
     console.timeEnd("assemblyMatrices");
-    console.log("Matrix assembly completed");
+    basicLog("Matrix assembly completed");
 
     // System solving
-    console.log(`Solving system using ${this.solverMethod}...`);
+    basicLog(`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
+      solutionVector = math.lusolve(jacobianMatrix, residualVector);
     }
     console.timeEnd("systemSolving");
-    console.log("System solved successfully");
+    basicLog("System solved successfully");
 
-    // Return the solution matrix and nodes coordinates
-    return {
-      solutionVector,
-      nodesCoordinates,
-    };
+    return { solutionVector, nodesCoordinates };
   }
 }

src/index.js

@@ -10,4 +10,4 @@
 
 export { FEAScriptModel } from "./FEAScript.js";
 export { plotSolution } from "./visualization/plotSolutionScript.js";
-export { printVersion, setLogLevel } from "./utilities/utilitiesScript.js";
+export { printVersion, logSystem } from "./utilities/utilitiesScript.js";

src/solvers/solidHeatTransferScript.js

@@ -12,6 +12,7 @@ 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 { basicLog, debugLog } from "../utilities/utilitiesScript.js";
 
 /**
  * Assemble the solid heat transfer matrix
@@ -23,7 +24,7 @@ import { ThermalBoundaryConditions } from "../methods/thermalBoundaryConditionsS
  *  - nodesCoordinates: Object containing x and y coordinates of nodes
  */
 export function assembleSolidHeatTransferMat(meshConfig, boundaryConditions) {
-  console.log("Starting solid heat transfer matrix assembly");
+  basicLog("Starting solid heat transfer matrix assembly");
 
   // Extract mesh details from the configuration object
   const {
@@ -35,11 +36,7 @@ export function assembleSolidHeatTransferMat(meshConfig, boundaryConditions) {
     elementOrder, // The order of elements
   } = meshConfig;
 
-  console.log(
-    `Mesh configuration: ${meshDimension}, Elements: ${numElementsX}x${numElementsY || 1}, Size: ${maxX}x${
-      maxY || 0
-    }, Order: ${elementOrder}`
-  );
+  debugLog(`Mesh configuration: ${meshDimension}, Elements: ${numElementsX}x${numElementsY || 1}, Size: ${maxX}x${maxY || 0}, Order: ${elementOrder}`);
 
   // Extract boundary conditions from the configuration object
   let convectionHeatTranfCoeff = [];
@@ -49,14 +46,11 @@ export function assembleSolidHeatTransferMat(meshConfig, boundaryConditions) {
     if (boundaryCondition[0] === "convection") {
       convectionHeatTranfCoeff[key] = boundaryCondition[1];
       convectionExtTemp[key] = boundaryCondition[2];
-      console.log(
-        `Convection boundary condition on boundary ${key}: h=${boundaryCondition[1]}, T=${boundaryCondition[2]}`
-      );
     }
   });
 
   // Create a new instance of the meshGeneration class
-  console.log("Generating mesh...");
+  debugLog("Generating mesh...");
   const meshGenerationData = new meshGeneration({
     numElementsX,
     numElementsY,
@@ -68,7 +62,6 @@ export function assembleSolidHeatTransferMat(meshConfig, boundaryConditions) {
 
   // Generate the mesh
   const nodesCoordinatesAndNumbering = meshGenerationData.generateMesh();
-  console.log("Mesh generated successfully");
 
   // Extract nodes coordinates and nodal numbering (NOP) from the mesh data
   let nodesXCoordinates = nodesCoordinatesAndNumbering.nodesXCoordinates;
@@ -81,9 +74,6 @@ 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
-  console.log(`Total elements: ${totalElements}, Total nodes: ${totalNodes}`);
-
-  // Initialize variables for matrix assembly
   let localNodalNumbers = []; // Local nodal numbering
   let gaussPoints = []; // Gauss points
   let gaussWeights = []; // Gauss weights
@@ -112,14 +102,12 @@ export function assembleSolidHeatTransferMat(meshConfig, boundaryConditions) {
   }
 
   // Initialize the basisFunctions class
-  console.log("Initializing basis functions...");
   const basisFunctionsData = new basisFunctions({
     meshDimension,
     elementOrder,
   });
 
   // Initialize the numericalIntegration class
-  console.log("Setting up numerical integration...");
   const numIntegrationData = new numericalIntegration({
     meshDimension,
     elementOrder,
@@ -133,8 +121,6 @@ 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;
 
-  console.log(`Beginning matrix assembly for ${totalElements} elements...`);
-
   // Matrix assembly
   for (let elementIndex = 0; elementIndex < totalElements; elementIndex++) {
     for (let localNodeIndex = 0; localNodeIndex < numNodes; localNodeIndex++) {
@@ -256,7 +242,7 @@ export function assembleSolidHeatTransferMat(meshConfig, boundaryConditions) {
   }
 
   // Create an instance of ThermalBoundaryConditions
-  console.log("Applying thermal boundary conditions...");
+  debugLog("Applying thermal boundary conditions...");
   const thermalBoundaryConditions = new ThermalBoundaryConditions(
     boundaryConditions,
     boundaryElements,
@@ -277,13 +263,13 @@ export function assembleSolidHeatTransferMat(meshConfig, boundaryConditions) {
     convectionHeatTranfCoeff,
     convectionExtTemp
   );
-  console.log("Convection boundary conditions applied");
+  debugLog("Convection boundary conditions applied");
 
   // Impose ConstantTemp boundary conditions
   thermalBoundaryConditions.imposeConstantTempBoundaryConditions(residualVector, jacobianMatrix);
-  console.log("Constant temperature boundary conditions applied");
+  debugLog("Constant temperature boundary conditions applied");
 
-  console.log("Solid heat transfer matrix assembly completed");
+  basicLog("Solid heat transfer matrix assembly completed");
 
   return {
     jacobianMatrix,

src/utilities/utilitiesScript.js

@@ -8,34 +8,62 @@
 //                                            |_|   | |_   //
 //       Website: https://feascript.com/             \__|  //
 
+// Global logging level
+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';
+  } else {
+    currentLogLevel = level;
+    basicLog(`Log level set to: ${level}`);
+  }
+}
+
+/**
+ * Debug logging function - 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
+  }
+}
+
+/**
+ * Basic logging function - 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
+}
+
+/**
+ * Error logging function
+ * @param {string} message - Message to log
+ */
+export function errorLog(message) {
+  console.log('%c[ERROR] ' + message, 'color: #F44336; font-weight: bold;'); // Red color for errors
+}
+
 /**
  * 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...");
-  console.log("Fetching latest FEAScript version information...");
+  basicLog("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}`);
-    console.log(`Latest FEAScript update: ${latestCommitDate}`);
+    basicLog(`Latest FEAScript update: ${latestCommitDate}`);
     return latestCommitDate;
   } catch (error) {
-    // log.error("Failed to fetch version information:", error);
-    console.error("Failed to fetch version information:", error);
+    errorLog("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) {
-  // Logging is temporarily disabled
-  // loggers.setAllLogLevels(level);
-  // log.info(`Log level set to: ${level}`);
-  console.log(`Log level set to: ${level} (logging temporarily disabled)`);
-}