Skip to content

Commit db50262

Browse files
committed
remove Script suffix references. Rename importGmshQuadTri function to importGmshMesh
1 parent 246da2f commit db50262

36 files changed

Lines changed: 98 additions & 98 deletions

CONTRIBUTING.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,12 @@ Thank you for your interest in contributing! FEAScript is in early development,
1919
## Variable & File Naming
2020

2121
- Use [camelCase](https://en.wikipedia.org/wiki/Camel_case) formatting for variable names throughout the code
22-
- 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:
23-
- Visually distinguish internal FEAScript modules from third‑party or external library files
24-
- Keep historical and stylistic consistency across the codebase
22+
- JavaScript source file names use camelCase (e.g., `logging.js`, `meshGeneration.js`, `newtonRaphson.js`)
2523

2624
### Exceptions
2725

2826
- Public entry file: `index.js` (standard entry point convention)
29-
- Core model file: `FEAScript.js` (matches the library name; appending "Script" would be redundant)
27+
- Core model file: `FEAScript.js` (matches the library name)
3028

3129
## File Structure
3230

@@ -54,7 +52,7 @@ Example:
5452
import { mathLibrary } from "math-package";
5553

5654
// Internal imports
57-
import { relatedFunction } from "../utilities/helperScript.js";
55+
import { relatedFunction } from "../utilities/helper.js";
5856

5957
/**
6058
* Class to handle specific functionality

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/heatConductionScript/heatConduction2DFin/heatConduction2DFinGmsh.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import * as math from "mathjs";
1717
global.math = math;
1818

1919
// Import FEAScript library
20-
import { FEAScriptModel, importGmshQuadTri, printVersion } from "feascript";
20+
import { FEAScriptModel, importGmshMesh, printVersion } from "feascript";
2121

2222
console.log("FEAScript Version:", printVersion);
2323

@@ -42,7 +42,7 @@ async function main() {
4242
};
4343

4444
// Parse the mesh data
45-
const result = await importGmshQuadTri(mockFile);
45+
const result = await importGmshMesh(mockFile);
4646

4747
// Define mesh configuration with the parsed result
4848
model.setMeshConfig({

examples/heatConductionScript/heatConduction2DFin/heatConduction2DRhomFinGmsh.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import * as math from "mathjs";
1717
global.math = math;
1818

1919
// Import FEAScript library
20-
import { FEAScriptModel, importGmshQuadTri, printVersion } from "feascript";
20+
import { FEAScriptModel, importGmshMesh, printVersion } from "feascript";
2121

2222
console.log("FEAScript Version:", printVersion);
2323

@@ -42,7 +42,7 @@ async function main() {
4242
};
4343

4444
// Parse the mesh data
45-
const result = await importGmshQuadTri(mockFile);
45+
const result = await importGmshMesh(mockFile);
4646

4747
// Define mesh configuration with the parsed result
4848
model.setMeshConfig({

src/FEAScript.js

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@
88
*/
99

1010
// Internal imports
11-
import { newtonRaphson } from "./methods/newtonRaphsonScript.js";
12-
import { solveLinearSystem } from "./methods/linearSystemSolverScript.js";
13-
import { solveLinearSystemAsync } from "./methods/linearSystemSolverScript.js";
14-
import { prepareMesh } from "./mesh/meshUtilsScript.js";
15-
import { assembleFrontPropagationMat } from "./models/frontPropagationScript.js";
16-
import { assembleGeneralFormPDEMat, assembleGeneralFormPDEFront } from "./models/generalFormPDEScript.js";
17-
import { assembleHeatConductionMat, assembleHeatConductionFront } from "./models/heatConductionScript.js";
18-
import { assembleCreepingFlowMatrix } from "./models/creepingFlowScript.js";
19-
import { runFrontalSolver } from "./methods/frontalSolverScript.js";
20-
import { basicLog, debugLog, warnLog, errorLog } from "./utilities/loggingScript.js";
11+
import { newtonRaphson } from "./methods/newtonRaphson.js";
12+
import { solveLinearSystem } from "./methods/linearSystemSolver.js";
13+
import { solveLinearSystemAsync } from "./methods/linearSystemSolver.js";
14+
import { prepareMesh } from "./mesh/meshUtils.js";
15+
import { assembleFrontPropagationMat } from "./models/frontPropagation.js";
16+
import { assembleGeneralFormPDEMat, assembleGeneralFormPDEFront } from "./models/generalFormPDE.js";
17+
import { assembleHeatConductionMat, assembleHeatConductionFront } from "./models/heatConduction.js";
18+
import { assembleCreepingFlowMatrix } from "./models/creepingFlow.js";
19+
import { runFrontalSolver } from "./methods/frontalSolver.js";
20+
import { basicLog, debugLog, warnLog, errorLog } from "./utilities/logging.js";
2121

2222
/**
2323
* Class to implement finite element analysis in JavaScript

0 commit comments

Comments
 (0)