Skip to content

Commit 431495a

Browse files
nikoschamnikoscham
committed
Refactor header comments across multiple scripts to standardize documentation format and include versioning information for the FEAScript Library.
- Updated header comments in heatConduction2DFin.js, heatConduction2DFinGmsh.js, FEAScript.js, index.js, basisFunctionsScript.js, meshGenerationScript.js, meshUtilsScript.js, euclideanNormScript.js, frontalSolverScript.js, jacobiSolverScript.js, linearSystemSolverScript.js, newtonRaphsonScript.js, numericalIntegrationScript.js, frontPropagationScript.js, generalFormPDEScript.js, genericBoundaryConditionsScript.js, heatConductionScript.js, thermalBoundaryConditionsScript.js, gmshReaderScript.js, loggingScript.js, plotSolutionScript.js, webgpuWorkerScript.js, workerScript.js, and wrapperScript.js. - Removed webgpuComputeEngineScript.js and added webgpuJacobiSolverScript.js to implement GPU-accelerated Jacobi solver using Taichi.js/WebGPU.
1 parent 01afbbd commit 431495a

29 files changed

+207
-265
lines changed

‎CONTRIBUTING.md‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,13 @@ All files in the FEAScript-core codebase should follow this structure:
4141
Example:
4242

4343
```javascript
44-
// ______ ______ _____ _ _ //
45-
// | ____| ____| /\ / ____| (_) | | //
46-
// | |__ | |__ / \ | (___ ___ ____ _ ____ | |_ //
47-
// | __| | __| / /\ \ \___ \ / __| __| | _ \| __| //
48-
// | | | |____ / ____ \ ____) | (__| | | | |_) | | //
49-
// |_| |______/_/ \_\_____/ \___|_| |_| __/| | //
50-
// | | | | //
51-
// |_| | |_ //
52-
// Website: https://feascript.com/ \__| //
44+
/**
45+
* ════════════════════════════════════════════════════════════
46+
* FEAScript Library
47+
* Lightweight Finite Element Simulation in JavaScript
48+
* Version: {VERSION} | https://feascript.com
49+
* ════════════════════════════════════════════════════════════
50+
*/
5351

5452
// External imports
5553
import { mathLibrary } from "math-package";

‎examples/frontPropagationScript/solidificationFront2D/solidificationFront2D.js‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
// ______ ______ _____ _ _ //
2-
// | ____| ____| /\ / ____| (_) | | //
3-
// | |__ | |__ / \ | (___ ___ ____ _ ____ | |_ //
4-
// | __| | __| / /\ \ \___ \ / __| __| | _ \| __| //
5-
// | | | |____ / ____ \ ____) | (__| | | | |_) | | //
6-
// |_| |______/_/ \_\_____/ \___|_| |_| __/| | //
7-
// | | | | //
8-
// |_| | |_ //
9-
// Website: https://feascript.com/ \__| //
1+
/**
2+
* ════════════════════════════════════════════════════════════
3+
* FEAScript Library
4+
* Lightweight Finite Element Simulation in JavaScript
5+
* Version: 0.1.4 | https://feascript.com
6+
* ════════════════════════════════════════════════════════════
7+
*/
108

119
// Import Math.js
1210
import * as math from "mathjs";

‎examples/generalFormPDEScript/advectionDiffusion1D/advectionDiffusion1D.js‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
// ______ ______ _____ _ _ //
2-
// | ____| ____| /\ / ____| (_) | | //
3-
// | |__ | |__ / \ | (___ ___ ____ _ ____ | |_ //
4-
// | __| | __| / /\ \ \___ \ / __| __| | _ \| __| //
5-
// | | | |____ / ____ \ ____) | (__| | | | |_) | | //
6-
// |_| |______/_/ \_\_____/ \___|_| |_| __/| | //
7-
// | | | | //
8-
// |_| | |_ //
9-
// Website: https://feascript.com/ \__| //
1+
/**
2+
* ════════════════════════════════════════════════════════════
3+
* FEAScript Library
4+
* Lightweight Finite Element Simulation in JavaScript
5+
* Version: 0.1.4 | https://feascript.com
6+
* ════════════════════════════════════════════════════════════
7+
*/
108

119
// Import Math.js
1210
import * as math from "mathjs";

‎examples/heatConductionScript/heatConduction1DWall/heatConduction1DWall.js‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
// ______ ______ _____ _ _ //
2-
// | ____| ____| /\ / ____| (_) | | //
3-
// | |__ | |__ / \ | (___ ___ ____ _ ____ | |_ //
4-
// | __| | __| / /\ \ \___ \ / __| __| | _ \| __| //
5-
// | | | |____ / ____ \ ____) | (__| | | | |_) | | //
6-
// |_| |______/_/ \_\_____/ \___|_| |_| __/| | //
7-
// | | | | //
8-
// |_| | |_ //
9-
// Website: https://feascript.com/ \__| //
1+
/**
2+
* ════════════════════════════════════════════════════════════
3+
* FEAScript Library
4+
* Lightweight Finite Element Simulation in JavaScript
5+
* Version: 0.1.4 | https://feascript.com
6+
* ════════════════════════════════════════════════════════════
7+
*/
108

119
// Import Math.js
1210
import * as math from "mathjs";

‎examples/heatConductionScript/heatConduction2DFin/heatConduction2DFin.js‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
// ______ ______ _____ _ _ //
2-
// | ____| ____| /\ / ____| (_) | | //
3-
// | |__ | |__ / \ | (___ ___ ____ _ ____ | |_ //
4-
// | __| | __| / /\ \ \___ \ / __| __| | _ \| __| //
5-
// | | | |____ / ____ \ ____) | (__| | | | |_) | | //
6-
// |_| |______/_/ \_\_____/ \___|_| |_| __/| | //
7-
// | | | | //
8-
// |_| | |_ //
9-
// Website: https://feascript.com/ \__| //
1+
/**
2+
* ════════════════════════════════════════════════════════════
3+
* FEAScript Library
4+
* Lightweight Finite Element Simulation in JavaScript
5+
* Version: 0.1.4 | https://feascript.com
6+
* ════════════════════════════════════════════════════════════
7+
*/
108

119
// Import Math.js
1210
import * as math from "mathjs";

‎examples/heatConductionScript/heatConduction2DFin/heatConduction2DFinGmsh.js‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
// ______ ______ _____ _ _ //
2-
// | ____| ____| /\ / ____| (_) | | //
3-
// | |__ | |__ / \ | (___ ___ ____ _ ____ | |_ //
4-
// | __| | __| / /\ \ \___ \ / __| __| | _ \| __| //
5-
// | | | |____ / ____ \ ____) | (__| | | | |_) | | //
6-
// |_| |______/_/ \_\_____/ \___|_| |_| __/| | //
7-
// | | | | //
8-
// |_| | |_ //
9-
// Website: https://feascript.com/ \__| //
1+
/**
2+
* ════════════════════════════════════════════════════════════
3+
* FEAScript Library
4+
* Lightweight Finite Element Simulation in JavaScript
5+
* Version: 0.1.4 | https://feascript.com
6+
* ════════════════════════════════════════════════════════════
7+
*/
108

119
// Import required Node.js modules
1210
import fs from "fs";

‎src/FEAScript.js‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
// ______ ______ _____ _ _ //
2-
// | ____| ____| /\ / ____| (_) | | //
3-
// | |__ | |__ / \ | (___ ___ ____ _ ____ | |_ //
4-
// | __| | __| / /\ \ \___ \ / __| __| | _ \| __| //
5-
// | | | |____ / ____ \ ____) | (__| | | | |_) | | //
6-
// |_| |______/_/ \_\_____/ \___|_| |_| __/| | //
7-
// | | | | //
8-
// |_| | |_ //
9-
// Website: https://feascript.com/ \__| //
1+
/**
2+
* ════════════════════════════════════════════════════════════
3+
* FEAScript Library
4+
* Lightweight Finite Element Simulation in JavaScript
5+
* Version: 0.1.4 | https://feascript.com
6+
* ════════════════════════════════════════════════════════════
7+
*/
108

119
// Internal imports
1210
import { newtonRaphson } from "./methods/newtonRaphsonScript.js";

‎src/index.js‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
// ______ ______ _____ _ _ //
2-
// | ____| ____| /\ / ____| (_) | | //
3-
// | |__ | |__ / \ | (___ ___ ____ _ ____ | |_ //
4-
// | __| | __| / /\ \ \___ \ / __| __| | _ \| __| //
5-
// | | | |____ / ____ \ ____) | (__| | | | |_) | | //
6-
// |_| |______/_/ \_\_____/ \___|_| |_| __/| | //
7-
// | | | | //
8-
// |_| | |_ //
9-
// Website: https://feascript.com/ \__| //
1+
/**
2+
* ════════════════════════════════════════════════════════════
3+
* FEAScript Library
4+
* Lightweight Finite Element Simulation in JavaScript
5+
* Version: 0.1.4 | https://feascript.com
6+
* ════════════════════════════════════════════════════════════
7+
*/
108

119
export { FEAScriptModel } from "./FEAScript.js";
1210
export { importGmshQuadTri } from "./readers/gmshReaderScript.js";

‎src/mesh/basisFunctionsScript.js‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
// ______ ______ _____ _ _ //
2-
// | ____| ____| /\ / ____| (_) | | //
3-
// | |__ | |__ / \ | (___ ___ ____ _ ____ | |_ //
4-
// | __| | __| / /\ \ \___ \ / __| __| | _ \| __| //
5-
// | | | |____ / ____ \ ____) | (__| | | | |_) | | //
6-
// |_| |______/_/ \_\_____/ \___|_| |_| __/| | //
7-
// | | | | //
8-
// |_| | |_ //
9-
// Website: https://feascript.com/ \__| //
1+
/**
2+
* ════════════════════════════════════════════════════════════
3+
* FEAScript Library
4+
* Lightweight Finite Element Simulation in JavaScript
5+
* Version: 0.1.4 | https://feascript.com
6+
* ════════════════════════════════════════════════════════════
7+
*/
108

119
// Internal imports
1210
import { basicLog, debugLog, errorLog } from "../utilities/loggingScript.js";

‎src/mesh/meshGenerationScript.js‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
// ______ ______ _____ _ _ //
2-
// | ____| ____| /\ / ____| (_) | | //
3-
// | |__ | |__ / \ | (___ ___ ____ _ ____ | |_ //
4-
// | __| | __| / /\ \ \___ \ / __| __| | _ \| __| //
5-
// | | | |____ / ____ \ ____) | (__| | | | |_) | | //
6-
// |_| |______/_/ \_\_____/ \___|_| |_| __/| | //
7-
// | | | | //
8-
// |_| | |_ //
9-
// Website: https://feascript.com/ \__| //
1+
/**
2+
* ════════════════════════════════════════════════════════════
3+
* FEAScript Library
4+
* Lightweight Finite Element Simulation in JavaScript
5+
* Version: 0.1.4 | https://feascript.com
6+
* ════════════════════════════════════════════════════════════
7+
*/
108

119
// Internal imports
1210
import { basicLog, debugLog, errorLog } from "../utilities/loggingScript.js";

0 commit comments

Comments
 (0)