Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Warning

Fluidsimfoam is still in quite early development. Before version 0.1.0, the API is still a bit unstable!

Unreleased

0.0.7 - 2023-06-27

Warning

This release contains major improvements in terms of usability for real projects! And also two important incompatible changes:

• The template files now have to be organized as in a standard OpenFOAM case (in system, constant and 0 subdirectories).

• New fluidsimfoam.invoke subpackage. The Invoke tasks are now defined in fluidsimfoam.invoke.tasks.

• Plot methods sim.output.fields.plot_... using pyvista in fluidsimfoam.output.fields.Fields (contribution by @Pooriadf).

• multi-region-snappy solver (advanced solver using snappyHexMesh and chtMultiRegionFoam).

• Few grammar/parser/formatter fixes and improvements (!86, !87, !89)

• Much better Invoke related code. New fluidsimfoam.invoke.context.Context for OpenFOAM. New tasks for decomposePar, snappyHexMesh, etc… (see fluidsimfoam.invoke.tasks).

• fluidsimfoam.foam_input_files.parse_header() and fluidsimfoam.foam_input_files.read_header().

• First support for binary OpenFOAM files (!97)

0.0.6 - 2023-06-09

Small release before OpenFOAM users conference where Fluidsimfoam will be presented.

• Improve phill solver + few blockMesh improvements

• Few bug fixes and code improvements

0.0.5 - 2023-06-05

• params.resources to copy files and directories in the simulation directories. These files can be saved in the solver packages.

• Support for setFieldsDict files

• Command fluidsimfoam-initiate-solver

• dam solver to reproduce the Breaking of a dam tutorial

• fluidsim_core==0.7.3

• fluidsimfoam.output.get_mean_values_from_path() and fluidsimfoam.output.get_dataframe_from_paths()

• Merge request !54: parallel simulations

  • fluidsimfoam.foam_input_files.decompose_par.DecomposeParDictHelper

  • Improve run task to call decomposePar and mpirun

0.0.4 - 2023-05-22

• Helper to define fvOptions files: fluidsimfoam.foam_input_files.fv_options.FvOptionsHelper

• cbox, phill and cavity solvers

• fluidsimfoam.foam_input_files.blockmesh.BlockMeshDictRectilinear

• Merge request !44:

  • fluidsimfoam.output.log.Log

  • Improve run task (save OpenFOAM log and minimal logging) (fluidsimfoam.tasks.run())

  • fluidsimfoam.make.MakeInvoke.exec_async()

  • fluidsimfoam.solvers.base.SimulFoam.stop_time_loop()

  • Poetry extra for Qt (poetry install -E qt or pip install "fluidsimfoam[qt]")

  • Fix parameters (fluidsimfoam.params)

  • fluidsimfoam.foam_input_files.fields.VolTensorField and fixes in AST and fields.

• Poetry extra for Jupyter (poetry install -E jupyter, poetry install --all-extras or pip install "fluidsimfoam[jupyter]")

• Various bug fixes, API improvements and optimizations…

• CONTRIBUTING.md

• OpenFOAM simulations on ReadTheDocs servers allowing tutorials using OpenFOAM

0.0.3 - 2023-05-09

• Improve formatting input files

• Utilities to define solvers and input files

  • fluidsimfoam.foam_input_files.FileHelper

  • fluidsimfoam.foam_input_files.fields.VolScalarField and fluidsimfoam.foam_input_files.fields.VolVectorField and fluidsimfoam.foam_input_files.fields.read_field_file()

  • fluidsimfoam.foam_input_files.fv_schemes.FvSchemesHelper

  • fluidsimfoam.foam_input_files.constant_files.ConstantFileHelper

  • fluidsimfoam.foam_input_files.ast.FoamInputFile.init_from_py_objects()

0.0.2 - 2023-04-26

• Unstable API to define solvers

• Can setup, run and reload simulations

• Parser for OpenFOAM input files (fluidsimfoam.foam_input_files)

• Utility to create blockMeshDict files (fluidsimfoam.foam_input_files.blockmesh)