Skip to content

Commit 0475d66

Browse files
committed
Update examples for FEAScript: Add new example for Heat Conduction in a 2D Rhomboid Fin using Gmsh mesh and remove redundant README.md files from example directories.
Update copyright year to 2026 in all files.
1 parent a50a0dd commit 0475d66

38 files changed

Lines changed: 442 additions & 74 deletions

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2023-2025 FEAScript
3+
Copyright (c) 2023-2026 FEAScript
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

examples/frontPropagationScript/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ This directory contains Node.js examples demonstrating how to use the FEAScript
66

77
## Examples
88

9-
#### 1. Solidification Front Propagation in a 2D Domain (solidificationFront2D)
9+
#### 1. Solidification Front Propagation in a 2D Domain (`SolidificationFront2D.js`)
1010

11-
This example demonstrates solving an eikonal equation in a 2D domain to track the movement of a solidification interface. For detailed information on the model setup refer to the corresponding [tutorial](https://feascript.com/tutorials/solidification-front-2d.html) in the FEAScript website.
11+
This example demonstrates solving an eikonal equation in a 2D domain to track the movement of a solidification interface. For detailed information on the model setup, refer to the corresponding [tutorial](https://feascript.com/tutorials/solidification-front-2d.html) in the FEAScript website.
1212

1313
## Running the Examples
1414

examples/frontPropagationScript/solidificationFront2D/README.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

examples/frontPropagationScript/solidificationFront2D/solidificationFront2D.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
* FEAScript Core Library
44
* Lightweight Finite Element Simulation in JavaScript
55
* Version: 0.2.0 (RC) | https://feascript.com
6-
* MIT License © 2023–2025 FEAScript
6+
* MIT License © 2023–2026 FEAScript
77
* ════════════════════════════════════════════════════════════════
88
*/
99

examples/generalFormPDEScript/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ This directory contains Node.js examples demonstrating how to use the FEAScript
66

77
## Examples
88

9-
#### 1. Advection-Diffusion with Gaussian Source (advectionDiffusion1D)
9+
#### 1. Advection-Diffusion with Gaussian Source (`advectionDiffusion1D.js`)
1010

11-
This example demonstrates solving a one-dimensional advection-diffusion problem with a Gaussian source term. The problem models the transport of a substance under the effects of both diffusion and advection. For detailed information on the model setup refer to the corresponding [tutorial](https://feascript.com/tutorials/advection-diffusion-1d.html) in the FEAScript website.
11+
This example demonstrates solving a one-dimensional advection-diffusion problem with a Gaussian source term. The problem models the transport of a substance under the effects of both diffusion and advection. For detailed information on the model setup, refer to the corresponding [tutorial](https://feascript.com/tutorials/advection-diffusion-1d.html) in the FEAScript website.
1212

1313
## Running the Examples
1414

examples/generalFormPDEScript/advectionDiffusion1D/README.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

examples/generalFormPDEScript/advectionDiffusion1D/advectionDiffusion1D.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
* FEAScript Core Library
44
* Lightweight Finite Element Simulation in JavaScript
55
* Version: 0.2.0 (RC) | https://feascript.com
6-
* MIT License © 2023–2025 FEAScript
6+
* MIT License © 2023–2026 FEAScript
77
* ════════════════════════════════════════════════════════════════
88
*/
99

examples/heatConductionScript/README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,27 @@ This directory contains Node.js examples demonstrating how to use the FEAScript
66

77
## Examples
88

9-
#### 1. Heat Conduction Through a Wall (heatConduction1DWall)
9+
#### 1. Heat Conduction in a 1D Wall (`heatConduction1DWall.js`)
1010

11-
This example demonstrates a heat flow case through a building wall. For detailed information on the model setup refer to the corresponding [tutorial](https://feascript.com/tutorials/heat-conduction-1d-wall.html) in the FEAScript website.
11+
This example demonstrates a heat flow case through a building wall.
1212

13-
#### 2. Heat Conduction in a 2D Fin (heatConduction2DFin)
13+
For detailed information on the model setup, refer to the corresponding [tutorial](https://feascript.com/tutorials/heat-conduction-1d-wall.html) in the FEAScript website.
1414

15-
This example demonstrates a typical cooling fin scenario. For detailed information on the model setup refer to the corresponding [tutorial](https://feascript.com/tutorials/heat-conduction-2d-fin.html) in the FEAScript website. There are two Node.js implementations:
15+
#### 2. Heat Conduction in a 2D Fin (Standard Mesh) (`heatConduction2DFin.js`)
1616

17-
#### i. Standard Version (`heatConduction2DFin.js`)
17+
Basic implementation using an internally generated structured mesh.
1818

19-
Basic implementation using the FEAScriptModel class
19+
#### 3. Heat Conduction in a 2D Fin (Gmsh Mesh) (`heatConduction2DFinGmsh.js`)
2020

21-
#### ii. Gmsh Version (`heatConduction2DFinGmsh.js`)
21+
Implementation using an unstructured mesh generated by [Gmsh](https://gmsh.info/) (the mesh file, `rect_quad_unstruct.msh`, is also located in the current directory).
2222

23-
Implementation using an unstructured mesh generated by [Gmsh](https://gmsh.info/) (the mesh file, `rect_quad.msh`, is also located in the current directory).
23+
For detailed information on the model setup, refer to the corresponding [tutorial](https://feascript.com/tutorials/heat-conduction-2d-fin.html) in the FEAScript website.
24+
25+
#### 4. Heat Conduction in a 2D Rhomboid Fin (Gmsh Mesh) (`heatConduction2DRhomFinGmsh.js`)
26+
27+
Implementation using a Gmsh-generated mesh for a rhomboid domain (the mesh file, `rhom_quad.msh`, is also located in the current directory).
28+
29+
For detailed information on the model setup, refer to the corresponding [tutorial](https://feascript.com/tutorials/heat-conduction-2d-rhom-fin-gmsh.html) in the FEAScript website.
2430

2531
## Running the Examples
2632

@@ -36,10 +42,10 @@ echo '{"type":"module"}' > package.json
3642
npm install feascript mathjs
3743
```
3844

39-
#### 3. Run the example:
45+
#### 3. Run an example:
4046

4147
```bash
42-
node HeatConduction1DWall.js
48+
node heatConduction2DFin.js
4349
```
4450

45-
(for the "Heat Conduction Through a Wall" example)
51+
(or `node heatConduction2DFinGmsh.js` / `node heatConduction2DRhomFinGmsh.js`)

examples/heatConductionScript/heatConduction1DWall/README.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

examples/heatConductionScript/heatConduction1DWall/heatConduction1DWall.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
* FEAScript Core Library
44
* Lightweight Finite Element Simulation in JavaScript
55
* Version: 0.2.0 (RC) | https://feascript.com
6-
* MIT License © 2023–2025 FEAScript
6+
* MIT License © 2023–2026 FEAScript
77
* ════════════════════════════════════════════════════════════════
88
*/
99

0 commit comments

Comments
 (0)