Skip to content

Commit d15b25f

Browse files
nikoschamnikoscham
authored
Feature/frontal solver (#40)
* Update README.md to include npm version badge * Refactor solver imports * chore: bump version to 0.1.3 and update description in package.json - Updated version from 0.1.2 to 0.1.3 - Modified description for clarity - Added contributor Felipe Ferrari to package.json - Changed homepage URL to https://feascript.com/ - Updated version constant in src/index.js to 0.1.3 * Feature/frontal solver (#33) * Refactor solver imports * chore: bump version to 0.1.3 and update description in package.json - Updated version from 0.1.2 to 0.1.3 - Modified description for clarity - Added contributor Felipe Ferrari to package.json - Changed homepage URL to https://feascript.com/ - Updated version constant in src/index.js to 0.1.3 * Enhance README and examples; add frontal solver implementation - Updated README.md to include new sections on JavaScript API and Visual Editor, improving clarity on usage methods. - Reorganized content for better navigation and added links to examples and tutorials. - Modified example scripts to improve console output order for clarity. - Introduced a new frontal solver script for 2D problems, implementing necessary mathematical functions and logic. - Created a temporary HTML file to load the frontal solver script for testing purposes. * Reorganize README structure; move "Ways to Use FEAScript" section for better clarity * Refactor README and add support section; update usage instructions for Scribbler * Refactor frontPropagationScript and solidHeatTransferScript to utilize new mesh utility functions; streamline mesh preparation and isoparametric mapping processes * Add validation for geometry parameters in Mesh2D class; ensure required parameters are provided when not using a parsed mesh * Update logging messages in mesh generation and utility scripts; change debug logs to error logs for unimplemented element type mapping and clarify function descriptions in documentation comments. * Rename meshUtils.js to meshUtilsScript.js and update imports in solver scripts * Refactor FEAScript and solver scripts to utilize prepared mesh data; remove helper function for system size calculation * Refactor frontPropagationScript and solidHeatTransferScript to improve comment clarity; standardize residualVector and jacobianMatrix descriptions and replace meshData.elementOrder with elementOrder * Refactor frontalSolverScript and update temporaryFrontalTest to use module imports; rename feaData to FEAData for consistency in frontPropagationScript and solidHeatTransferScript * Refactor frontalSolverScript to utilize external assembly for heat transfer elements; update temporaryFrontalTest title and description for clarity. * Update README.md to clarify JavaScript API section title and improve consistency in naming * Update README.md to remove commented-out Liberapay badge for cleaner presentation * Refactor FEAScript and related scripts to improve clarity and modularity; add plotting capabilities to temporaryFrontalTest and enhance logging messages. * Update README.md to improve structure and consistency in the JavaScript API section * Update README.md for improved clarity and consistency in language and structure * Update README.md for formatting consistency; remove unused nodesCoordinates in newtonRaphsonScript.js and frontPropagationScript.js * Add frontal solver integration and enhance solid heat transfer assembly - Introduced frontal solver method in FEAScriptModel for improved solving capabilities. - Added runFrontalSolver function to frontalSolverScript.js for result handling. - Enhanced solidHeatTransferScript.js to support convection boundary conditions. - Removed temporaryFrontalTest.html as it is no longer needed. * Refactor LU solver implementation to use sparse matrix for improved performance * Build new npm package
1 parent 4d88687 commit d15b25f

23 files changed

+1387
-580
lines changed

‎CONTRIBUTING.md‎

Lines changed: 77 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,87 @@ Thank you for your interest in contributing! FEAScript is in early development,
44

55
## Contribution Guidelines
66

7-
1. **Respect the existing coding style:** Observe the code near your intended changes and aim to preserve that style in your modifications.
8-
9-
2. **Recommended tools:**
7+
1. **Development Tools:**
108
We recommend using [Visual Studio Code](https://code.visualstudio.com/) with the [Prettier plugin](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for automatic code formatting. Additionally, use a **110-character line width** to maintain consistent formatting.
119

12-
3. **Naming conventions:**
10+
2. **Coding Style:**
11+
Observe the code near your intended changes and aim to preserve that style in your modifications.
12+
13+
3. **Variable Naming:**
1314
Use [camelCase](https://en.wikipedia.org/wiki/Camel_case) formatting for variable names throughout the code.
1415

15-
4. **Testing changes locally:**
16+
4. **File Naming:**
17+
All JavaScript source files in FEAScript end with the suffix `Script` before the `.js` extension (e.g., `loggingScript.js`, `meshGenerationScript.js`, `newtonRaphsonScript.js`). This is an explicit, project‑level stylistic choice to:
18+
19+
- Visually distinguish internal FEAScript modules from third‑party or external library files.
20+
- Keep historical and stylistic consistency across the codebase.
21+
22+
Exceptions:
23+
24+
- Public entry file: `index.js` (standard entry point convention).
25+
- Core model file: `FEAScript.js` (matches the library name; appending "Script" would be redundant).
26+
27+
5. **File Structure:**
28+
All files in the FEAScript-core codebase should follow this structure:
29+
30+
1. **Banner**: All files start with the FEAScript ASCII art banner.
31+
2. **Imports**:
32+
- External imports (from npm packages) first, alphabetically ordered.
33+
- Internal imports next, grouped by module/folder.
34+
3. **Classes/Functions**: Implementation with proper JSDoc comments.
35+
36+
Example:
37+
38+
```javascript
39+
// ______ ______ _____ _ _ //
40+
// | ____| ____| /\ / ____| (_) | | //
41+
// | |__ | |__ / \ | (___ ___ ____ _ ____ | |_ //
42+
// | __| | __| / /\ \ \___ \ / __| __| | _ \| __| //
43+
// | | | |____ / ____ \ ____) | (__| | | | |_) | | //
44+
// |_| |______/_/ \_\_____/ \___|_| |_| __/| | //
45+
// | | | | //
46+
// |_| | |_ //
47+
// Website: https://feascript.com/ \__| //
48+
49+
// External imports
50+
import { mathLibrary } from "math-package";
51+
52+
// Internal imports
53+
import { relatedFunction } from "../utilities/helperScript.js";
54+
55+
/**
56+
* Class to handle specific functionality
57+
*/
58+
export class MyClass {
59+
/**
60+
* Constructor to initialize the class
61+
* @param {object} options - Configuration options
62+
*/
63+
constructor(options) {
64+
// Implementation
65+
}
66+
67+
/**
68+
* Function to perform a specific action
69+
* @param {number} input - Input value
70+
* @returns {number} Processed result
71+
*/
72+
doSomething(input) {
73+
// Implementation
74+
return input * DEFAULT_VALUE;
75+
}
76+
}
77+
```
78+
79+
6. **Branching & Workflow:**
80+
To contribute a new feature or fix:
81+
82+
- Do not commit directly to `main` or `dev`.
83+
- Instead, start your work in a feature branch based on the `dev` branch.
84+
85+
**If you are not a member of the repository (e.g., an external contributor), you must first [fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo).** Make your changes in your fork, then submit a Pull Request from your fork's feature branch into the `dev` branch.
86+
87+
7. **Local Testing:**
1688
Before submitting a pull request, test your modifications by running the FEAScript library from a local directory. For example, you can load the library in your HTML file as follows:
1789

1890
```javascript
@@ -26,76 +98,3 @@ Thank you for your interest in contributing! FEAScript is in early development,
2698
```
2799

28100
where the server will be available at `http://127.0.0.1:8000/`. Static file server npm packages like [serve](https://github.com/vercel/serve#readme) and [Vite](https://vite.dev/) can also be used.
29-
30-
## Branching & Workflow
31-
32-
To contribute a new feature or fix:
33-
34-
- Do not commit directly to `main` or `dev`.
35-
- Instead, start your work in a feature branch based on the `dev` branch.
36-
37-
**If you are not a member of the repository (e.g., an external contributor), you must first [fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo).** Make your changes in your fork, then submit a Pull Request from your fork's feature branch into the`dev` branch.
38-
39-
## File Structure Guidelines
40-
41-
All files in the FEAScript-core codebase should follow this structure:
42-
43-
1. **Banner**: All files start with the FEAScript ASCII art banner.
44-
2. **Imports**:
45-
- External imports (from npm packages) first, alphabetically ordered.
46-
- Internal imports next, grouped by module/folder.
47-
3. **Classes/Functions**: Implementation with proper JSDoc comments.
48-
49-
Example:
50-
51-
```javascript
52-
// ______ ______ _____ _ _ //
53-
// | ____| ____| /\ / ____| (_) | | //
54-
// | |__ | |__ / \ | (___ ___ ____ _ ____ | |_ //
55-
// | __| | __| / /\ \ \___ \ / __| __| | _ \| __| //
56-
// | | | |____ / ____ \ ____) | (__| | | | |_) | | //
57-
// |_| |______/_/ \_\_____/ \___|_| |_| __/| | //
58-
// | | | | //
59-
// |_| | |_ //
60-
// Website: https://feascript.com/ \__| //
61-
62-
// External imports
63-
import { mathLibrary } from "math-package";
64-
65-
// Internal imports
66-
import { relatedFunction } from "../utilities/helperScript.js";
67-
68-
/**
69-
* Class to handle specific functionality
70-
*/
71-
export class MyClass {
72-
/**
73-
* Constructor to initialize the class
74-
* @param {object} options - Configuration options
75-
*/
76-
constructor(options) {
77-
// Implementation
78-
}
79-
80-
/**
81-
* Function to perform a specific action
82-
* @param {number} input - Input value
83-
* @returns {number} Processed result
84-
*/
85-
doSomething(input) {
86-
// Implementation
87-
return input * DEFAULT_VALUE;
88-
}
89-
}
90-
```
91-
92-
## File Naming Convention
93-
94-
All JavaScript source files in FEAScript end with the suffix `Script` before the `.js` extension (e.g., `loggingScript.js`, `meshGenerationScript.js`, `newtonRaphsonScript.js`). This is an explicit, project‑level stylistic choice to:
95-
96-
- Visually distinguish internal FEAScript modules from third‑party or external library files.
97-
- Keep historical and stylistic consistency across the codebase.
98-
99-
Exceptions:
100-
- Public entry file: `index.js` (standard entry point convention).
101-
- Core model file: `FEAScript.js` (matches the library name; appending "Script" would be redundant).

‎README.md‎

Lines changed: 99 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -2,52 +2,71 @@
22

33
# FEAScript-core
44

5-
[![npm version](https://img.shields.io/npm/v/feascript)](https://www.npmjs.com/package/feascript) <img src="https://img.shields.io/liberapay/receives/FEAScript.svg?logo=liberapay">
5+
[![npm version](https://img.shields.io/npm/v/feascript)](https://www.npmjs.com/package/feascript)
66

7-
[FEAScript](https://feascript.com/) is a lightweight finite element simulation library built in JavaScript. It empowers users to create and execute simulations for physics and engineering applications in both browser-based and server-side environments. This is the core library of FEAScript.
7+
<!-- [![liberapay](https://img.shields.io/liberapay/receives/FEAScript.svg?logo=liberapay)](https://liberapay.com/FEAScript/) -->
88

9-
> 🚧 **FEAScript is currently under heavy development.** Functionality and interfaces may change rapidly as new features and enhancements are introduced. 🚧
9+
[FEAScript](https://feascript.com/) is a lightweight finite element simulation library built in JavaScript. It empowers users to create and execute simulations for physics and engineering applications in both browser-based and server-side environments. This is the core library of the FEAScript project.
10+
11+
> 🚧 **FEAScript is currently under heavy development.** Its functionality and interfaces may change rapidly as new features and enhancements are introduced.
1012
1113
## Contents
1214

13-
- [Installation](#installation)
14-
- [Example Usage](#example-usage)
15-
- [FEAScript Platform](#feascript-platform)
16-
- [Contribute](#contribute)
15+
- [Ways to Use FEAScript](#ways-to-use-feascript)
16+
- [JavaScript API (FEAScript Core)](#javascript-api-feascript-core)
17+
- [Use FEAScript in the Browser](#use-feascript-in-the-browser)
18+
- [Use FEAScript with Node.js](#use-feascript-with-nodejs)
19+
- [Use FEAScript with Scribbler](#use-feascript-with-scribbler)
20+
- [Visual Editor (FEAScript Platform)](#visual-editor-feascript-platform)
21+
- [Quick Example](#quick-example)
22+
- [Support FEAScript](#support-feascript)
23+
- [Contributing](#contributing)
1724
- [License](#license)
1825

19-
## Installation
26+
## Ways to Use FEAScript
27+
28+
FEAScript offers two main approaches to creating simulations:
29+
30+
1. **[JavaScript API (FEAScript Core)](#javascript-api-feascript-core)** – For developers comfortable with coding, providing full programmatic control in browsers, Node.js, or interactive notebooks.
31+
2. **[Visual Editor (FEAScript Platform)](#visual-editor-feascript-platform)** – For users who prefer a no-code approach, offering a block-based visual interface built with [Blockly](https://developers.google.com/blockly).
32+
33+
Each approach is explained in detail below.
2034

21-
FEAScript is entirely implemented in pure JavaScript and can run in two environments:
35+
### JavaScript API (FEAScript Core)
2236

23-
1. **In the browser** with a simple HTML page, where all simulations are executed locally without any installations or using any cloud services.
24-
2. **Via Node.js** with plain JavaScript files, for server-side simulations.
37+
The JavaScript API is the core programmatic interface for FEAScript. Written entirely in pure JavaScript, it runs in three environments:
2538

26-
### Option 1: In the Browser
39+
1. **[In the browser](#use-feascript-in-the-browser)** – Use FEAScript in a simple HTML page, running simulations locally without additional installations or cloud services.
40+
2. **[With Node.js](#use-feascript-with-nodejs)** – Use FEAScript in server-side JavaScript applications or CLI tools.
41+
3. **[With Scribbler](#use-feascript-with-scribbler)** – Use FEAScript in the [Scribbler](https://scribbler.live/) interactive JavaScript notebook environment.
42+
43+
#### Use FEAScript in the Browser
2744

2845
You can use FEAScript in browser environments in two ways:
2946

30-
**Direct Import from the Web (ES Module):**
47+
- **Import from Hosted ESM Build:**
3148

32-
```html
33-
<script type="module">
34-
import { FEAScriptModel } from "https://core.feascript.com/dist/feascript.esm.js";
35-
</script>
36-
```
49+
```html
50+
<script type="module">
51+
import { FEAScriptModel } from "https://core.feascript.com/dist/feascript.esm.js";
52+
</script>
53+
```
3754

38-
**Download and Use Locally:**
55+
- **Download and Use Locally:**
3956

40-
```html
41-
<script type="module">
42-
import { FEAScriptModel } from "./path/to/dist/feascript.esm.js";
43-
</script>
44-
```
57+
You can download the latest stable release from [GitHub Releases](https://github.com/FEAScript/FEAScript-core/releases).
4558

46-
You can download the latest stable release from [GitHub Releases](https://github.com/FEAScript/FEAScript-core/releases). Explore various browser-based examples and use cases in our [website](https://feascript.com/#tutorials).
59+
```html
60+
<script type="module">
61+
import { FEAScriptModel } from "./path/to/dist/feascript.esm.js";
62+
</script>
63+
```
4764

48-
### Option 2: Via Node.js
65+
👉 Explore browser-based tutorials on our [website](https://feascript.com/#tutorials).
4966

50-
Install FEAScript and its peer dependencies from npm:
67+
#### Use FEAScript with Node.js
68+
69+
Install FEAScript and its peer dependencies from npm as follows:
5170

5271
```bash
5372
npm install feascript mathjs plotly.js
@@ -66,11 +85,31 @@ import { FEAScriptModel } from "feascript";
6685
echo '{"type":"module"}' > package.json
6786
```
6887

69-
When running examples from within this repository, this step is not needed as the root package.json already has the proper configuration. Explore various Node.js examples and use cases [here](https://github.com/FEAScript/FEAScript-core/tree/main/examples).
88+
When running examples from within this repository, this step isn’t needed as the root package.json already has the proper configuration.
89+
90+
👉 Explore Node.js use cases on the [examples directory](https://github.com/FEAScript/FEAScript-core/tree/main/examples).
7091

71-
## Example Usage
92+
#### Use FEAScript with Scribbler
7293

73-
This is an indicative example of FEAScript, shown for execution in the browser. Adapt paths, solver types, and boundary conditions as needed for your specific problem:
94+
FEAScript also works well in interactive JavaScript notebook environments where you can write code, visualize results inline, and share your work with others. [Scribbler](https://scribbler.live/) is one such platform that comes with preloaded scientific libraries, making it an excellent choice for FEAScript simulations.
95+
96+
👉 Explore FEAScript notebook examples on the [Scribbler Hub](https://hub.scribbler.live/portfolio/#!nikoscham/FEAScript-Scribbler-examples).
97+
98+
### Visual Editor (FEAScript Platform)
99+
100+
For users who prefer a visual approach to creating simulations, we offer the [FEAScript Platform](https://platform.feascript.com/) - a browser-based visual editor built on the [Blockly](https://developers.google.com/blockly) library. This no-code interface allows you to:
101+
102+
- Build and run finite element simulations directly in your browser by connecting visual blocks together
103+
- Create complex simulations without writing any JavaScript code
104+
- Save and load projects in XML format for easy sharing and reuse
105+
106+
While FEAScript's JavaScript API offers full programmatic control for advanced customization, the FEAScript Platform provides an accessible entry point for users without coding experience.
107+
108+
👉 Explore FEAScript Platform examples on our [website](https://feascript.com/#tutorials).
109+
110+
## Quick Example
111+
112+
Here is a minimal browser-based example using the JavaScript API. Adapt paths, solver types, and boundary conditions as needed for your specific problem:
74113

75114
```html
76115
<body>
@@ -79,41 +118,51 @@ This is an indicative example of FEAScript, shown for execution in the browser.
79118
// Import FEAScript library
80119
import { FEAScriptModel } from "https://core.feascript.com/dist/feascript.esm.js";
81120
82-
window.addEventListener("DOMContentLoaded", async () => {
83-
// Create and configure model
121+
window.addEventListener("DOMContentLoaded", () => {
122+
// Create a new FEAScript model
84123
const model = new FEAScriptModel();
85-
model.setSolverConfig("solverType"); // e.g., "solidHeatTransfer" for a stationary solid heat transfer case
124+
125+
// Set the solver type for your problem
126+
model.setSolverConfig("solverType"); // Example: "solidHeatTransferScript"
127+
128+
// Configure the mesh
86129
model.setMeshConfig({
87-
meshDimension: "1D" | "2D", // Mesh dimension
88-
elementOrder: "linear" | "quadratic", // Element order
89-
numElementsX: number, // Number of elements in x-direction
90-
numElementsY: number, // Number of elements in y-direction (for 2D)
91-
maxX: number, // Domain length in x-direction
92-
maxY: number, // Domain length in y-direction (for 2D)
130+
meshDimension: "1D", // Choose either "1D" or "2D"
131+
elementOrder: "linear", // Choose either "linear" or "quadratic"
132+
numElementsX: 10, // Number of elements in x-direction
133+
numElementsY: 6, // Number of elements in y-direction (for 2D only)
134+
maxX: 1.0, // Domain length in x-direction
135+
maxY: 0.5, // Domain length in y-direction (for 2D only)
93136
});
94137
95-
// Apply boundary conditions
96-
model.addBoundaryCondition("boundaryIndex", ["conditionType" /* parameters */]);
138+
// Add boundary conditions with appropriate parameters
139+
model.addBoundaryCondition("boundaryIndex", ["conditionType" /* parameters */]); // Example boundary condition
97140
98-
// Solve
141+
// Solve the problem
99142
const { solutionVector, nodesCoordinates } = model.solve();
100143
});
101144
</script>
102-
<!-- ...continue of body region... -->
145+
<!-- ...rest of body region... -->
103146
</body>
104147
```
105148

106-
## FEAScript Platform
149+
**Note:** The code above uses placeholder values that you should replace with appropriate options, e.g.:
107150

108-
For users who prefer a visual approach to creating simulations, we offer the [FEAScript platform](https://platform.feascript.com/) - a browser-based visual editor built on the [Blockly](https://developers.google.com/blockly) library. This no-code interface allows you to:
151+
- "solverType" should be replaced with an actual solver type such as "solidHeatTransferScript" for heat conduction problems
152+
- "conditionType" should be replaced with an actual boundary condition type such as "constantTemp"
153+
- "boundaryIndex" should be replaced with a string identifying the boundary
109154

110-
- Build and run finite element simulations directly in your browser by connecting visual blocks
111-
- Create complex simulations without writing any JavaScript code
112-
- Save and load projects in XML format for easy sharing and reuse
155+
## Support FEAScript
156+
157+
> 💖 **If you find FEAScript useful, please consider supporting its development through a donation:**
158+
159+
<a href="https://liberapay.com/FEAScript/donate">
160+
<img alt="Donate using Liberapay" src="https://liberapay.com/assets/widgets/donate.svg">
161+
</a>
113162

114-
While FEAScript's JavaScript API offers full programmatic control for advanced customization, the FEAScript platform provides an accessible entry point for users without coding experience.
163+
Your support helps ensure the continued development and maintenance of this project.
115164

116-
## Contribute
165+
## Contributing
117166

118167
We warmly welcome contributors to help expand and refine FEAScript. Please see the [CONTRIBUTING.md](./CONTRIBUTING.md) file for detailed guidance on how to contribute.
119168

‎dist/feascript.cjs.js‎

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/feascript.cjs.js.map‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/feascript.esm.js‎

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/feascript.esm.js.map‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/feascript.umd.js‎

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/feascript.umd.js.map‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎examples/frontPropagationScript/SolidificationFront2D/SolidificationFront2D.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,6 @@ model.setSolverMethod("lusolve");
4646
const { solutionVector, nodesCoordinates } = model.solve();
4747

4848
// Print results to console
49-
console.log("Solution vector:", solutionVector);
50-
console.log("Node coordinates:", nodesCoordinates);
5149
console.log(`Number of nodes in mesh: ${nodesCoordinates.nodesXCoordinates.length}`);
50+
console.log("Node coordinates:", nodesCoordinates);
51+
console.log("Solution vector:", solutionVector);

0 commit comments

Comments
 (0)