FEAScript-core/src/FEAScript.js at main · FEAScript/FEAScript-core · GitHub

History

351 lines (316 loc) · 14.5 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

/**

* ════════════════════════════════════════════════════════════════

* FEAScript Core Library

* Lightweight Finite Element Simulation in JavaScript

* Version: 0.3.0 (RC) | https://feascript.com

* ════════════════════════════════════════════════════════════════

// Internal imports

import { newtonRaphson } from "./methods/newtonRaphson.js";

import { solveLinearSystem } from "./methods/linearSystemSolver.js";

import { solveLinearSystemAsync } from "./methods/linearSystemSolver.js";

import { prepareMesh } from "./mesh/meshUtils.js";

import { assembleFrontPropagationMat } from "./models/frontPropagation.js";

import {

assembleGeneralFormPDEMat,

assembleGeneralFormPDEFront,

assembleGeneralFormPDENonlinearMat,

} from "./models/generalFormPDE.js";

import { assembleHeatConductionMat, assembleHeatConductionFront } from "./models/heatConduction.js";

import { assembleCreepingFlowMatrix } from "./models/creepingFlow.js";

import { assembleEulerBernoulliBeamMat } from "./models/eulerBernoulliBeam.js";

import { runFrontalSolver } from "./methods/frontalSolver.js";

import { basicLog, debugLog, warnLog, errorLog } from "./utilities/logging.js";

/**

* Class to implement finite element analysis in JavaScript

* @param {string} solverConfig - Parameter specifying the type of solver

* @param {object} meshConfig - Object containing computational mesh details

* @param {object} boundaryConditions - Object containing boundary conditions for the finite element analysis

* @returns {object} An object containifng the solution vector and mesh information

export class FEAScriptModel {

constructor() {

this.solverConfig = null;

this.meshConfig = {};

this.boundaryConditions = {};

this.solverMethod = "lusolve"; // Default solver method

this.coefficientFunctions = null; // Add storage for coefficient functions

warnLog(

"FEAScript is provided “as is” without any warranty. The authors are not responsible for any damages or losses that may result from using the software. See the license for more details: https://github.com/FEAScript/FEAScript-core/blob/main/LICENSE",

);

basicLog("FEAScriptModel instance created");

}

/**

* Method to set the model configuration

* @param {string} modelConfig - Parameter specifying the type of model

* @param {object} [options] - Optional additional configuration

setModelConfig(modelConfig, options = {}) {

this.solverConfig = modelConfig;

// Store coefficient functions if provided

if (options?.coefficientFunctions !== undefined) {

this.coefficientFunctions = options.coefficientFunctions;

debugLog("coefficientFunctions set");

}

// Flag to solve the PDE with the Newton-Raphson method instead of a direct linear solve

if (options?.nonlinear !== undefined) {

this.nonlinear = options.nonlinear;

debugLog(`nonlinear set to ${this.nonlinear}`);

}

// Only update if a value is provided

if (options?.maxIterations !== undefined) {

this.maxIterations = options.maxIterations;

debugLog(`maxIterations set to ${this.maxIterations}`);

}

if (options?.tolerance !== undefined) {

this.tolerance = options.tolerance;

debugLog(`tolerance set to ${this.tolerance}`);

}

debugLog(`solverConfig set to ${modelConfig}`);

}

setMeshConfig(meshConfig) {

this.meshConfig = meshConfig;

debugLog(`meshConfig set with dimensions: ${meshConfig.meshDimension}`);

}

addBoundaryCondition(boundaryKey, condition) {

// Normalize deprecated boundary condition type strings and emit deprecation warnings

const deprecatedBoundaryConditionTypes = {

constantTemp: "constantTemperature",

};

const originalType = condition[0];

if (Object.prototype.hasOwnProperty.call(deprecatedBoundaryConditionTypes, originalType)) {

const normalizedType = deprecatedBoundaryConditionTypes[originalType];

warnLog(

`Boundary condition type "${originalType}" is deprecated and will be removed in a future version. ` +

`Use "${normalizedType}" instead.`,

);

condition = [normalizedType, ...condition.slice(1)];

}

this.boundaryConditions[boundaryKey] = condition;

debugLog(`boundaryConditions added for boundary: ${boundaryKey}, type: ${condition[0]}`);

}

setSolverMethod(solverMethod) {

this.solverMethod = solverMethod;

debugLog(`solverMethod set to: ${solverMethod}`);

}

/**

* Method to solve the finite element problem synchronously

* @param {object} [options] - Additional parameters for the solver, such as `maxIterations` and `tolerance`

* @returns {object} An object containing the solution vector and mesh information

solve(options = {}) {

if (!this.solverConfig || !this.meshConfig || !this.boundaryConditions) {

errorLog("solverConfig, meshConfig and boundaryConditions must be set before solving");

}

/**

* For consistency across both linear and nonlinear formulations,

* we always refer to the assembled right-hand side vector as

* `residualVector` and the assembled system matrix as `jacobianMatrix`.

* In linear problems `jacobianMatrix` is equivalent to the

* classic stiffness/conductivity matrix and `residualVector`

* corresponds to the traditional load (RHS) vector.

let jacobianMatrix = [];

let residualVector = [];

let solutionVector = [];

let initialSolution = [];

// Prepare the mesh

basicLog("Preparing mesh...");

const meshData = prepareMesh(this.meshConfig);

basicLog("Mesh preparation completed");

// Extract node coordinates and nodal numbering from meshData

const nodesCoordinates = {

nodesXCoordinates: meshData.nodesXCoordinates,

nodesYCoordinates: meshData.nodesYCoordinates,

};

// Select and execute the appropriate solver based on solverConfig

basicLog("Beginning solving process...");

console.time("totalSolvingTime");

basicLog(`Using solver ${this.solverConfig}`);

if (this.solverConfig === "heatConductionScript") {

// Check if using frontal solver

if (this.solverMethod === "frontal") {

const frontalResult = runFrontalSolver(

assembleHeatConductionFront,

meshData,

this.boundaryConditions,

{ coefficientFunctions: this.coefficientFunctions },

);

solutionVector = frontalResult.solutionVector;

} else {

// Use regular linear solver methods

({ jacobianMatrix, residualVector } = assembleHeatConductionMat(

meshData,

this.boundaryConditions,

this.coefficientFunctions,

));

const linearSystemResult = solveLinearSystem(this.solverMethod, jacobianMatrix, residualVector, {

maxIterations: options.maxIterations ?? this.maxIterations,

tolerance: options.tolerance ?? this.tolerance,

});

solutionVector = linearSystemResult.solutionVector;

}

} else if (this.solverConfig === "frontPropagationScript") {

// Initialize eikonalActivationFlag

let eikonalActivationFlag = 0; // TODO: make activationFlag a generic variable (not only for eikonal)

const eikonalExteralIterations = 5; // Number of incremental steps for the eikonal equation

// Create context object with all necessary properties

const context = {

meshData: meshData,

boundaryConditions: this.boundaryConditions,

eikonalActivationFlag: eikonalActivationFlag,

solverMethod: this.solverMethod,

initialSolution,

// TODO: Consider using different maxIterations/tolerance for Newton-Raphson and linear solver

maxIterations: options.maxIterations ?? this.maxIterations,

tolerance: options.tolerance ?? this.tolerance,

};

while (eikonalActivationFlag <= 1) {

// Update the context object with current eikonalActivationFlag

context.eikonalActivationFlag = eikonalActivationFlag;

// Pass the previous solution as initial guess

if (solutionVector.length > 0) {

context.initialSolution = [...solutionVector];

}

// Solve the assembled non-linear system

const newtonRaphsonResult = newtonRaphson(assembleFrontPropagationMat, context);

// Extract results

jacobianMatrix = newtonRaphsonResult.jacobianMatrix;

residualVector = newtonRaphsonResult.residualVector;

solutionVector = newtonRaphsonResult.solutionVector;

// Increment eikonalActivationFlag for next iteration

eikonalActivationFlag += 1 / eikonalExteralIterations;

}

} else if (this.solverConfig === "generalFormPDEScript") {

// Check if using frontal solver

if (this.solverMethod === "frontal") {

errorLog(

"Frontal solver is not yet supported for generalFormPDEScript. Please use 'lusolve' or 'jacobi'.",

);

} else if (this.nonlinear) {

// Solve the nonlinear PDE with the Newton-Raphson method

const context = {

meshData,

boundaryConditions: this.boundaryConditions,

solverMethod: this.solverMethod,

maxIterations: options.maxIterations ?? this.maxIterations,

tolerance: options.tolerance ?? this.tolerance,

};

const newtonRaphsonResult = newtonRaphson(

(meshDataArg, boundaryConditionsArg, solutionVectorArg) =>

assembleGeneralFormPDENonlinearMat(

meshDataArg,

boundaryConditionsArg,

this.coefficientFunctions,

solutionVectorArg,

context,

);

jacobianMatrix = newtonRaphsonResult.jacobianMatrix;

residualVector = newtonRaphsonResult.residualVector;

solutionVector = newtonRaphsonResult.solutionVector;

} else {

// Use regular linear solver methods

({ jacobianMatrix, residualVector } = assembleGeneralFormPDEMat(

meshData,

this.boundaryConditions,

this.coefficientFunctions,

));

const linearSystemResult = solveLinearSystem(this.solverMethod, jacobianMatrix, residualVector, {

maxIterations: options.maxIterations ?? this.maxIterations,

tolerance: options.tolerance ?? this.tolerance,

});

solutionVector = linearSystemResult.solutionVector;

}

} else if (this.solverConfig === "creepingFlowScript") {

// Use regular linear solver methods for steady creeping flow

const creepingFlowResult = assembleCreepingFlowMatrix(meshData, this.boundaryConditions);

jacobianMatrix = creepingFlowResult.jacobianMatrix;

residualVector = creepingFlowResult.residualVector;

const linearSystemResult = solveLinearSystem(this.solverMethod, jacobianMatrix, residualVector, {

maxIterations: options.maxIterations ?? this.maxIterations,

tolerance: options.tolerance ?? this.tolerance,

});

solutionVector = linearSystemResult.solutionVector;

// Store creeping-flow-specific metadata for solution extraction

this._creepingFlowMetadata = {

totalNodesVelocity: creepingFlowResult.totalNodesVelocity,

totalNodesPressure: creepingFlowResult.totalNodesPressure,

pressureNodeIndices: creepingFlowResult.pressureNodeIndices,

};

} else if (this.solverConfig === "eulerBernoulliBeamScript") {

// Use regular linear solver methods for the 1D Euler-Bernoulli beam model

const beamResult = assembleEulerBernoulliBeamMat(

meshData,

this.boundaryConditions,

this.coefficientFunctions,

);

jacobianMatrix = beamResult.jacobianMatrix;

residualVector = beamResult.residualVector;

const linearSystemResult = solveLinearSystem(this.solverMethod, jacobianMatrix, residualVector, {

maxIterations: options.maxIterations ?? this.maxIterations,

tolerance: options.tolerance ?? this.tolerance,

});

solutionVector = linearSystemResult.solutionVector;

// Store beam-specific metadata for solution extraction (2 DOFs per node: deflection, rotation)

this._eulerBernoulliBeamMetadata = {

dofsPerNode: beamResult.dofsPerNode,

totalNodesX: meshData.totalNodesX,

};

}

console.timeEnd("totalSolvingTime");

basicLog("Solving process completed");

return { solutionVector, nodesCoordinates };

}

/**

* Method to solve the finite element problem asynchronously

* @param {object} computeEngine - The compute engine to use for the asynchronous solver (e.g., a worker or a WebGPU context)

* @param {object} [options] - Additional parameters for the solver, such as `maxIterations` and `tolerance`

* @returns {Promise<object>} A promise that resolves to an object containing the solution vector and the coordinates of the mesh nodes

async solveAsync(computeEngine, options = {}) {

if (!this.solverConfig || !this.meshConfig || !this.boundaryConditions) {

errorLog("Solver config, mesh config, and boundary conditions must be set before solving.");

}

let jacobianMatrix = [];

let residualVector = [];

let solutionVector = [];

basicLog("Preparing mesh...");

const meshData = prepareMesh(this.meshConfig);

basicLog("Mesh preparation completed");

const nodesCoordinates = {

nodesXCoordinates: meshData.nodesXCoordinates,

nodesYCoordinates: meshData.nodesYCoordinates,

};

basicLog("Beginning solving process...");

console.time("totalSolvingTime");

basicLog(`Using solver: ${this.solverConfig}`);

if (this.solverConfig === "heatConductionScript") {

({ jacobianMatrix, residualVector } = assembleHeatConductionMat(

meshData,

this.boundaryConditions,

this.coefficientFunctions,

));

if (this.solverMethod === "jacobi-gpu") {

const { solutionVector: x } = await solveLinearSystemAsync(

"jacobi-gpu",

jacobianMatrix,

residualVector,

{

computeEngine,

maxIterations: options.maxIterations ?? this.maxIterations,

tolerance: options.tolerance ?? this.tolerance,

);

solutionVector = x;

} else {

// Any other async solver

}

console.timeEnd("totalSolvingTime");

basicLog("Solving process completed");

return { solutionVector, nodesCoordinates };

}

FEAScript-core/src/FEAScript.js at main · FEAScript/FEAScript-core · GitHub

Uh oh!

Uh oh!

FEAScript-core/src/FEAScript.js at main · FEAScript/FEAScript-core · GitHub

Uh oh!

Uh oh!

Expand file tree

Breadcrumbs

FEAScript.js

Latest commit

History

Breadcrumbs

FEAScript.js

File metadata and controls