npm package: @simzero/jsfluids
Description: A high-level JS module for real-time CFD inference
Author: Carlos Pena-Monferrer
Latest version: 0.3.5

# jsfluids - A high-level JS module for real-time CFD inference

`jsfluids` is a high-level JavaScript module for inferring/solving fluid dynamics in real-time based on pre-constructed models. The module is also used as the interface with virtual worlds although can be used directly in a backend. The pre-constructed models used in this project are based on reduced-order models or machine-learning techniques, both of which are developed using open-source frameworks. For ML-based models we rely on ONNX Runtime for solving the new fields and use `jsfluids` for handling inputs and results by porting the VTK C++ library.

You can use this module locally, and we've also made it available to you on our playground at https://play.simzero.com. On the playground, you can directly play with the library and share your work. The playground is integrated into Babylon.js as the real-time 3D engine and include other tools such as ONNX and JSCAD for parametric advanced CAD modelling.

The first examples for building the pre-constructed models are available at the [openfoam-ml-rom](https://github.com/simzero/openfoam-ml-rom) repository. These examples serve as a starting point for utilizing the pre-constructed models and demonstrate the process of building them. By exploring the repository, you'll gain insights into the implementation details, configurations, and usage instructions. Feel free to refer to the repository for more information and to get started with building the pre-constructed models in your own projects. Each example in the repository has an HTML file using `jsfluids` and Babylon.js for visualization and interaction.

## Installation

You can install this module via npm:

```
npm install @simzero/jsfluids
```

Or, you can load it as a script tag in your HTML file:

```
<script src="https://unpkg.com/@simzero/jsfluids/dist/browser.js"></script>
```

This module will soon be available as an ES6 module.

## Usage

To use this module, you can require it in your Node.js code or access it via the global object in your browser code:

```
import jsfluids from 'jsfluids'
```

In any case you need to call the following before using the module:

```
(async() => {
  await jsfluids.ready;
})();
```

Once you have access to the module, you can call its functions as needed:

```
    const model = jsfluids.ML;

    model.loadMesh(meshURL).then(() => {
      ort.InferenceSession.create(onnxURL).then((onnx) => {
        // jsfluids functions
        ...
        onnx.run(feeds).then((results) => {
          // jsfluids functions
          ...
        });
      });
    });
```
or

```
    const model = jsfluids.ITHACAFV;

    model.loadMesh(meshURL).then(() => {
      model.loadModel(romURL).then(() => {
         // jsfluids functions
         ...
      });
    });
```

## Documentation

For detailed information, usage instructions, and API reference, please refer to the project documentation.

- [Documentation](https://simzero.github.io/jsfluids/latest)


## Building

To build the project, run the following command:

```console
make all
```

This command will build the project using the default configuration.

If you want to specify the number of cores to be used during the build, you can use the `CORES` environment variable. For example:

```console
CORES=30 make all
```

This command will utilize 30 cores during the build process, which can help accelerate the build speed on multi-core systems.

Additionally, if you want to bundle ITHACA-FV, you can set the WITH_ITHACAFV environment variable to true. For example:

```console
CORES=30 WITH_ITHACAFV=true make all
```

This command will utilize 30 cores during the build and enable the ITHACAFV feature.

Make sure to adjust the command and environment variable values based on your specific project setup and requirements.


## Supported Packages for Pre-Constructed Models

The module supports ML and ROM modelds from:

- [DeepCFD](https://github.com/mdribeiro/DeepCFD)
- [ITHACA-FV](https://github.com/mathLab/ITHACA-FV) (laminar and turbulent steady-state supported as of today)

## Third-party packages

The following main open-source packages were used in this module:

- [Emscripten](https://emscripten.org)
- [ONNX Runtime](https://onnxruntime.ai)
- [VTK](https://vtk.org)


## Disclaimer

This offering is not approved or endorsed by OpenCFD Limited, producer and distributor of the OpenFOAM software via www.openfoam.com, and owner of the OPENFOAM® and OpenCFD® trade marks. This offering is not approved or endorsed by any software packages mentioned above or their respective owners, and should not be considered as such.

## Release Candidate

This version of the module is a release candidate and is not yet considered stable. Please use with caution and report any issues you encounter.

## License

The jsfluids repository is licensed under the MIT License. The MIT License is a permissive open-source software license that allows users to freely use, modify, and distribute the licensed software for any purpose, without requiring payment or attribution to the original authors. The license also includes a warranty disclaimer, limiting the liability of the authors for any damages resulting from the use of the software.

A JS module is built from this source code and deployed to the public npm registry as jsfluids. The module is licensed under MIT but it's also bundled with `@simzero/rom.js` for using `ITHACA-FV` models. `rom.js` is licensed under LGPL as a derivative work of [ITHACA-FV](https://github.com/ITHACA-FV/ITHACA-FV) developed and maintained at the University of Urbino Carlo Bo by Dr. Giovanni Stabile and at SISSA mathLab in collaboration with Prof. Gianluigi Rozza's group. In jsfluids, the `ITHACAFV` class is a separate and independent chunk that is dynamically loaded only when calling the class `jsfluids.ITHACAFV`. This LGPL module is subject to the terms of the GNU Lesser General Public License (LGPL), which is also a permissive open-source software license, but with some additional restrictions on the distribution of derivative works. Users who use the LGPL module in conjunction with the MIT-licensed module must comply with the LGPL's requirements for attribution, source code distribution, and compatibility with other software.