Change setSolverConfig to setModelConfig for webWorkers

Author: nikoscham

src/workers/workerScript.js

@@ -30,9 +30,9 @@ export class FEAScriptWorker {
   }
 
   /**
-   * Function to initialize the web worker and wrap 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.
+   * @throws Will throw an error if the worker fails to initialize
    */
   async _initWorker() {
     try {
@@ -55,10 +55,10 @@ export class FEAScriptWorker {
   }
 
   /**
-   * Function to ensure 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.
+   * @returns {Promise<void>} Resolves when the worker is ready
+   * @throws Will throw an error if the worker is not ready within the timeout period
    */
   async _ensureReady() {
     if (this.isReady) return Promise.resolve();
@@ -82,20 +82,20 @@ export class FEAScriptWorker {
   }
 
   /**
-   * 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.
+   * Function to set the model configuration in the worker
+   * @param {string} modelConfig - The model configuration to set
+   * @returns {Promise<boolean>} Resolves when the configuration is set
    */
-  async setSolverConfig(solverConfig) {
+  async setModelConfig(modelConfig) {
     await this._ensureReady();
-    basicLog(`FEAScriptWorker: Setting solver config to: ${solverConfig}`);
-    return this.feaWorker.setSolverConfig(solverConfig);
+    basicLog(`FEAScriptWorker: Setting model config to: ${modelConfig}`);
+    return this.feaWorker.setModelConfig(modelConfig);
   }
 
   /**
-   * Sets the mesh configuration in the worker.
-   * @param {object} meshConfig - The mesh configuration to set.
-   * @returns {Promise<boolean>} Resolves when the configuration is set.
+   * Function to set the mesh configuration in the worker
+   * @param {object} meshConfig - The mesh configuration to set
+   * @returns {Promise<boolean>} Resolves when the configuration is set
    */
   async setMeshConfig(meshConfig) {
     await this._ensureReady();
@@ -104,10 +104,10 @@ export class FEAScriptWorker {
   }
 
   /**
-   * Adds a boundary condition to the worker.
-   * @param {string} boundaryKey - The key identifying the boundary.
-   * @param {array} condition - The boundary condition to add.
-   * @returns {Promise<boolean>} Resolves when the boundary condition is added.
+   * Function to add a boundary condition to the worker
+   * @param {string} boundaryKey - The key identifying the boundary
+   * @param {array} condition - The boundary condition to add
+   * @returns {Promise<boolean>} Resolves when the boundary condition is added
    */
   async addBoundaryCondition(boundaryKey, condition) {
     await this._ensureReady();
@@ -116,9 +116,9 @@ export class FEAScriptWorker {
   }
 
   /**
-   * Sets the solver method in the worker.
-   * @param {string} solverMethod - The solver method to set.
-   * @returns {Promise<boolean>} Resolves when the solver method is set.
+   * Function to set the solver method in the worker
+   * @param {string} solverMethod - The solver method to set
+   * @returns {Promise<boolean>} Resolves when the solver method is set
    */
   async setSolverMethod(solverMethod) {
     await this._ensureReady();
@@ -127,8 +127,8 @@ export class FEAScriptWorker {
   }
 
   /**
-   * Requests the worker to solve the problem.
-   * @returns {Promise<object>} Resolves with the solution result.
+   * Function to request the worker to solve the problem
+   * @returns {Promise<object>} Resolves with the solution result
    */
   async solve() {
     await this._ensureReady();
@@ -143,25 +143,25 @@ export class FEAScriptWorker {
   }
 
   /**
-   * Retrieves model information from the worker.
-   * @returns {Promise<object>} Resolves with the model information.
+   * Function to retrieve model information from the worker
+   * @returns {Promise<object>} Resolves with the model information
    */
   async getModelInfo() {
     await this._ensureReady();
     return this.feaWorker.getModelInfo();
   }
 
   /**
-   * Sends a ping request to the worker to check its availability.
-   * @returns {Promise<boolean>} Resolves if the worker responds.
+   * Function to send a ping request to the worker to check its availability
+   * @returns {Promise<boolean>} Resolves if the worker responds
    */
   async ping() {
     await this._ensureReady();
     return this.feaWorker.ping();
   }
 
   /**
-   * Terminates the worker and cleans up resources.
+   * Function to terminate the worker and clean up resources
    */
   terminate() {
     if (this.worker) {

src/workers/wrapperScript.js

@@ -37,26 +37,26 @@ class workerWrapper {
   }
 
   /**
-   * 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.
+   * Function to set the model configuration in the FEAScriptModel
+   * @param {string} modelConfig - The model configuration to set
+   * @returns {boolean} Returns true if the configuration is set successfully
+   * @throws Will throw an error if the configuration fails to set
    */
-  setSolverConfig(solverConfig) {
+  setModelConfig(modelConfig) {
     try {
-      this.model.setSolverConfig(solverConfig);
+      this.model.setModelConfig(modelConfig);
       return true;
     } catch (error) {
-      console.error("FEA Worker: Error in setSolverConfig", error);
+      console.error("FEA Worker: Error in setModelConfig", error);
       throw error;
     }
   }
 
   /**
-   * 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.
+   * 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
    */
   setMeshConfig(meshConfig) {
     try {
@@ -69,11 +69,11 @@ class workerWrapper {
   }
 
   /**
-   * 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.
-   * @throws Will throw an error if the boundary condition fails to add.
+   * 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
+   * @throws Will throw an error if the boundary condition fails to add
    */
   addBoundaryCondition(boundaryKey, condition) {
     try {
@@ -86,10 +86,10 @@ class workerWrapper {
   }
 
   /**
-   * 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.
+   * 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
    */
   setSolverMethod(solverMethod) {
     try {
@@ -102,9 +102,9 @@ class workerWrapper {
   }
 
   /**
-   * 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.
+   * 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
    */
   solve() {
     try {
@@ -123,9 +123,9 @@ class workerWrapper {
   }
 
   /**
-   * 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.
+   * 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
    */
   getModelInfo() {
     try {
@@ -142,8 +142,8 @@ class workerWrapper {
   }
 
   /**
-   * Function to perform a simple ping to check if the worker is responsive.
-   * @returns {boolean} Returns true to indicate the worker is available.
+   * Function to perform a simple ping to check if the worker is responsive
+   * @returns {boolean} Returns true to indicate the worker is available
    */
   ping() {
     try {