Format the examples in five numbered steps (model, mesh, boundary conditions, solve, results).

Author: nikoscham

examples/creepingFlowScript/lidDrivenCavity2DCreepingFlow/lidDrivenCavity2DCreepingFlow.js

@@ -12,13 +12,11 @@ import { FEAScriptModel, printVersion } from "feascript";
 
 console.log("FEAScript Version:", printVersion);
 
-// Create a new FEAScript model
+// 1. Create the model and select the physics
 const model = new FEAScriptModel();
-
-// Select physics/PDE
 model.setModelConfig("creepingFlowScript");
 
-// Define mesh configuration
+// 2. Define the mesh
 model.setMeshConfig({
   meshDimension: "2D",
   elementOrder: "quadratic",
@@ -28,19 +26,17 @@ model.setMeshConfig({
   maxY: 2,
 });
 
-// Define boundary conditions
-model.addBoundaryCondition("0", ["constantVelocity", 0, 0]); // Bottom boundary
-model.addBoundaryCondition("1", ["constantVelocity", 0, 0]); // Left boundary
-model.addBoundaryCondition("2", ["constantVelocity", 1, 0]); // Top boundary
-model.addBoundaryCondition("3", ["constantVelocity", 0, 0]); // Right boundary
+// 3. Apply the boundary conditions
+model.addBoundaryCondition("0", ["constantVelocity", 0, 0]); // Bottom
+model.addBoundaryCondition("1", ["constantVelocity", 0, 0]); // Left
+model.addBoundaryCondition("2", ["constantVelocity", 1, 0]); // Top
+model.addBoundaryCondition("3", ["constantVelocity", 0, 0]); // Right
 
-// Set solver method (optional)
+// 4. Solve
 model.setSolverMethod("lusolve");
-
-// Solve the problem
 const { solutionVector, nodesCoordinates } = model.solve();
 
-// Print results
+// 5. Print the results
 console.log(`Number of nodes in mesh: ${nodesCoordinates.nodesXCoordinates.length}`);
 console.log("Node coordinates:", nodesCoordinates);
 console.log("Solution vector:", solutionVector);

examples/eulerBernoulliBeamScript/clampedSpringSupportedBeam1D/clampedSpringSupportedBeam1D.js

@@ -12,40 +12,36 @@ import { FEAScriptModel, printVersion } from "feascript";
 
 console.log("FEAScript Version:", printVersion);
 
-// Create a new FEAScript model
+// 1. Create the model and select the physics
 const model = new FEAScriptModel();
-
-// Select physics/PDE
 model.setModelConfig("eulerBernoulliBeamScript", {
   coefficientFunctions: {
     EI: (x) => 2.0e6, // Bending stiffness
     q: (x) => (x <= 5 ? -1000 : 0),
   },
 });
 
-// Define mesh configuration
+// 2. Define the mesh
 model.setMeshConfig({
   meshDimension: "1D",
   elementOrder: "linear",
   numElementsX: 2,
   maxX: 10,
 });
 
-// Define boundary conditions
+// 3. Apply the boundary conditions
 model.addBoundaryCondition("1", [["fixed"]]); // Clamped support
 model.addBoundaryCondition("2", [["pinned"], ["moment", 1250]]); // Roller + applied moment
 model.addBoundaryCondition("3", [
   ["spring", 200],
   ["force", -2500],
 ]); // Spring support + point load
 
-// Set solver method
+// 4. Solve
 model.setSolverMethod("lusolve");
-
-// Solve the problem
 const { solutionVector } = model.solve();
 
-// Print results
+// 5. Print the results
 const flatSolution = solutionVector.map((entry) => (Array.isArray(entry) ? entry[0] : entry));
 
 const nodeXCoordinates = [0, 5, 10];

examples/frontPropagationScript/solidificationFront2D/solidificationFront2D.js

@@ -12,13 +12,11 @@ import { FEAScriptModel, printVersion } from "feascript";
 
 console.log("FEAScript Version:", printVersion);
 
-// Create a new FEAScript model
+// 1. Create the model and select the physics
 const model = new FEAScriptModel();
-
-// Select physics/PDE
 model.setModelConfig("frontPropagationScript");
 
-// Define mesh configuration
+// 2. Define the mesh
 model.setMeshConfig({
   meshDimension: "2D",
   elementOrder: "quadratic",
@@ -28,19 +26,17 @@ model.setMeshConfig({
   maxY: 2,
 });
 
-// Define boundary conditions
-model.addBoundaryCondition("0", ["constantValue", 0]); // Bottom boundary
-model.addBoundaryCondition("1", ["constantValue", 0]); // Left boundary
-model.addBoundaryCondition("2", ["zeroGradient"]); // Top boundary
-model.addBoundaryCondition("3", ["constantValue", 0]); // Right boundary
+// 3. Apply the boundary conditions
+model.addBoundaryCondition("0", ["constantValue", 0]); // Bottom
+model.addBoundaryCondition("1", ["constantValue", 0]); // Left
+model.addBoundaryCondition("2", ["zeroGradient"]); // Top
+model.addBoundaryCondition("3", ["constantValue", 0]); // Right
 
-// Set solver method (optional)
+// 4. Solve
 model.setSolverMethod("lusolve");
-
-// Solve the problem
 const { solutionVector, nodesCoordinates } = model.solve();
 
-// Print results
+// 5. Print the results
 console.log(`Number of nodes in mesh: ${nodesCoordinates.nodesXCoordinates.length}`);
 console.log("Node coordinates:", nodesCoordinates);
 console.log("Solution vector:", solutionVector);

examples/generalFormPDEScript/advectionDiffusion1D/advectionDiffusion1D.js

@@ -12,10 +12,8 @@ import { FEAScriptModel, printVersion } from "feascript";
 
 console.log("FEAScript Version:", printVersion);
 
-// Create a new FEAScript model
+// 1. Create the model and select the physics
 const model = new FEAScriptModel();
-
-// Select physics/PDE
 model.setModelConfig("generalFormPDEScript", {
   coefficientFunctions: {
     // Equation d²u/dx² - 10 du/dx = 10 * exp(-200 * (x - 0.5)²)
@@ -26,25 +24,23 @@ model.setModelConfig("generalFormPDEScript", {
   },
 });
 
-// Define mesh configuration
+// 2. Define the mesh
 model.setMeshConfig({
   meshDimension: "1D",
   elementOrder: "quadratic",
   numElementsX: 20,
   maxX: 1.0,
 });
 
-// Define boundary conditions
-model.addBoundaryCondition("0", ["constantValue", 1]); // Left boundary
-model.addBoundaryCondition("1", ["zeroGradient"]); // Right boundary
+// 3. Apply the boundary conditions
+model.addBoundaryCondition("0", ["constantValue", 1]); // Left
+model.addBoundaryCondition("1", ["zeroGradient"]); // Right
 
-// Set solver method
+// 4. Solve
 model.setSolverMethod("lusolve");
-
-// Solve the problem
 const { solutionVector, nodesCoordinates } = model.solve();
 
-// Print results
+// 5. Print the results
 console.log(`Number of nodes in mesh: ${nodesCoordinates.nodesXCoordinates.length}`);
 console.log("Node coordinates:", nodesCoordinates);
 console.log("Solution vector:", solutionVector);

examples/generalFormPDEScript/nonlinearReactionDiffusion1D/nonlinearReactionDiffusion1D.js

@@ -12,13 +12,11 @@ import { FEAScriptModel, printVersion } from "feascript";
 
 console.log("FEAScript Version:", printVersion);
 
-// Create a new FEAScript model
-const model = new FEAScriptModel();
-
 // Reaction rate coefficient for the nonlinear source term
 const Da = 1;
 
-// Select physics/PDE
+// 1. Create the model and select the physics
+const model = new FEAScriptModel();
 model.setModelConfig("generalFormPDEScript", {
   nonlinear: true, // Solve with the Newton-Raphson method
   coefficientFunctions: {
@@ -31,28 +29,26 @@ model.setModelConfig("generalFormPDEScript", {
   },
 });
 
-// Define mesh configuration
+// 2. Define the mesh
 model.setMeshConfig({
   meshDimension: "1D",
   elementOrder: "linear",
   numElementsX: 20,
   maxX: 10.0,
 });
 
-// Define boundary conditions
-model.addBoundaryCondition("0", ["constantValue", 1]); // Left boundary
-model.addBoundaryCondition("1", ["zeroGradient"]); // Right boundary
+// 3. Apply the boundary conditions
+model.addBoundaryCondition("0", ["constantValue", 1]); // Left
+model.addBoundaryCondition("1", ["zeroGradient"]); // Right
 
-// Set solver method
+// 4. Solve
 model.setSolverMethod("lusolve");
-
-// Solve the problem
 const { solutionVector, nodesCoordinates } = model.solve({
   maxIterations: 100,
   tolerance: 1e-5,
 });
 
-// Print results
+// 5. Print the results
 console.log(`Number of nodes in mesh: ${nodesCoordinates.nodesXCoordinates.length}`);
 console.log("Node coordinates:", nodesCoordinates);
 console.log("Solution vector:", solutionVector);

examples/heatConductionScript/heatConduction1DWall/heatConduction1DVaryingK.js

@@ -24,10 +24,8 @@ import { FEAScriptModel, printVersion } from "feascript";
 
 console.log("FEAScript Version:", printVersion);
 
-// Create a new FEAScript model
+// 1. Create the model and select the physics
 const model = new FEAScriptModel();
-
-// Select physics/PDE
 model.setModelConfig("heatConductionScript", {
   coefficientFunctions: {
     // Bi-material: high-conductivity concrete | low-conductivity insulation
@@ -36,22 +34,22 @@ model.setModelConfig("heatConductionScript", {
   },
 });
 
-// Define mesh configuration
+// 2. Define the mesh
 model.setMeshConfig({
   meshDimension: "1D",
   elementOrder: "linear",
   numElementsX: 20,
   maxX: 0.15,
 });
 
-// Define boundary conditions
-model.addBoundaryCondition("0", ["convection", 25, 5]); // Left boundary: convection
-model.addBoundaryCondition("1", ["constantTemperature", 20]); // Right boundary: fixed temperature
+// 3. Apply the boundary conditions
+model.addBoundaryCondition("0", ["convection", 25, 5]); // Left: convection
+model.addBoundaryCondition("1", ["constantTemperature", 20]); // Right: fixed temperature
 
-// Solve the problem
+// 4. Solve
 const { solutionVector, nodesCoordinates } = model.solve();
 
-// Print results
+// 5. Print the results
 console.log(`Number of nodes: ${nodesCoordinates.nodesXCoordinates.length}`);
 console.log("Node coordinates (x):", nodesCoordinates.nodesXCoordinates);
 console.log("Temperature solution:", solutionVector);

examples/heatConductionScript/heatConduction1DWall/heatConduction1DWall.js

@@ -12,31 +12,27 @@ import { FEAScriptModel, printVersion } from "feascript";
 
 console.log("FEAScript Version:", printVersion);
 
-// Create a new FEAScript model
+// 1. Create the model and select the physics
 const model = new FEAScriptModel();
-
-// Select physics/PDE
 model.setModelConfig("heatConductionScript");
 
-// Define mesh configuration
+// 2. Define the mesh
 model.setMeshConfig({
   meshDimension: "1D",
   elementOrder: "linear",
   numElementsX: 10,
   maxX: 0.15,
 });
 
-// Define boundary conditions
-model.addBoundaryCondition("0", ["convection", 1, 25]); // Left boundary
-model.addBoundaryCondition("1", ["constantTemperature", 5]); // Right boundary
+// 3. Apply the boundary conditions
+model.addBoundaryCondition("0", ["convection", 1, 25]); // Left
+model.addBoundaryCondition("1", ["constantTemperature", 5]); // Right
 
-// Set solver method (optional)
+// 4. Solve
 model.setSolverMethod("jacobi");
-
-// Solve the problem
 const { solutionVector, nodesCoordinates } = model.solve();
 
-// Print results
+// 5. Print the results
 console.log(`Number of nodes: ${nodesCoordinates.nodesXCoordinates.length}`);
 console.log("Node coordinates:", nodesCoordinates);
 console.log("Solution vector:", solutionVector);

examples/heatConductionScript/heatConduction2DFin/heatConduction2DFin.js

@@ -12,13 +12,11 @@ import { FEAScriptModel, printVersion } from "feascript";
 
 console.log("FEAScript Version:", printVersion);
 
-// Create a new FEAScript model
+// 1. Create the model and select the physics
 const model = new FEAScriptModel();
-
-// Select physics/PDE
 model.setModelConfig("heatConductionScript");
 
-// Define mesh configuration
+// 2. Define the mesh
 model.setMeshConfig({
   meshDimension: "2D",
   elementOrder: "quadratic",
@@ -28,19 +26,17 @@ model.setMeshConfig({
   maxY: 2,
 });
 
-// Define boundary conditions
-model.addBoundaryCondition("0", ["constantTemperature", 200]); // Bottom boundary
-model.addBoundaryCondition("1", ["symmetry"]); // Left boundary
-model.addBoundaryCondition("2", ["convection", 1, 20]); // Top boundary
-model.addBoundaryCondition("3", ["constantTemperature", 200]); // Right boundary
+// 3. Apply the boundary conditions
+model.addBoundaryCondition("0", ["constantTemperature", 200]); // Bottom
+model.addBoundaryCondition("1", ["symmetry"]); // Left
+model.addBoundaryCondition("2", ["convection", 1, 20]); // Top
+model.addBoundaryCondition("3", ["constantTemperature", 200]); // Right
 
-// Set solver method (optional)
+// 4. Solve
 model.setSolverMethod("frontal");
-
-// Solve the problem
 const { solutionVector, nodesCoordinates } = model.solve();
 
-// Print results
+// 5. Print the results
 console.log(`Number of nodes in mesh: ${nodesCoordinates.nodesXCoordinates.length}`);
 console.log("Node coordinates:", nodesCoordinates);
 console.log("Solution vector:", solutionVector);

examples/heatConductionScript/heatConduction2DFin/heatConduction2DFinGmsh.js

@@ -25,36 +25,24 @@ const meshFilePath = path.join(__dirname, "rect_quad.msh");
 const meshContent = fs.readFileSync(meshFilePath, "utf8");
 
 async function main() {
-  // Create a new FEAScript model
+  // 1. Create the model and select the physics
   const model = new FEAScriptModel();
-
-  // Select physics/PDE
   model.setModelConfig("heatConductionScript");
 
-  // Create a mock File object for Node.js environment
-  const mockFile = {
-    text: async () => meshContent,
-    name: "rect_quad.msh",
-  };
-
-  // Parse the mesh data
-  const result = await importGmshMesh(mockFile);
-
-  // Define mesh configuration with the parsed result
-  model.setMeshConfig({
-    parsedMesh: result,
-  });
+  // 2. Load the Gmsh mesh (in Node.js, any object with an async text() method replaces a File)
+  const mesh = await importGmshMesh({ text: async () => meshContent });
+  model.setMeshConfig({ parsedMesh: mesh });
 
-  // Define boundary conditions
-  model.addBoundaryCondition("0", ["constantTemperature", 200]); // Bottom boundary
-  model.addBoundaryCondition("1", ["symmetry"]); // Left boundary
-  model.addBoundaryCondition("2", ["convection", 1, 20]); // Top boundary
-  model.addBoundaryCondition("3", ["constantTemperature", 200]); // Right boundary
+  // 3. Apply the boundary conditions (key = Gmsh physical group tag - 1)
+  model.addBoundaryCondition("0", ["constantTemperature", 200]); // Bottom
+  model.addBoundaryCondition("1", ["symmetry"]); // Left
+  model.addBoundaryCondition("2", ["convection", 1, 20]); // Top
+  model.addBoundaryCondition("3", ["constantTemperature", 200]); // Right
 
-  // Solve the problem
+  // 4. Solve
   const { solutionVector, nodesCoordinates } = model.solve();
 
-  // Print results
+  // 5. Print the results
   console.log(`Number of nodes in mesh: ${nodesCoordinates.nodesXCoordinates.length}`);
   console.log("Node coordinates:", nodesCoordinates);
   console.log("Solution vector:", solutionVector);