Skip to main content

SimPhoNy wrapper for CatalyticFoam

Project description

# SimPhoNy-Catalytic

SimPhoNy-Catalytic is a Python package developed by Fraunhofer IWM that provides a convenient interface for running [catalyticFOAM simulations](https://github.com/multiscale-catalysis-polimi/catalyticFoam) using OpenFOAM.

The wrappers of this repository are the driver for running the catalyticFOAM solver, which was developed by Polimi and which is NOT included into the code here.

The SimPhoNy-Cataltic interface hosts the code and resources required to set up and run simulations of catalytic reactions in fluid flow systems.

The package is a plugin for [osp-core](https://github.com/simphony/simphony-osp) and hence is a semantic framework based on the [EMMO-ontology](https://github.com/emmo-repo).

## Authors

[Matthias Büschelberger](mailto:matthias.bueschelberger@iwm.fraunhofer.de) (Fraunhofer Institute for Mechanics of Materials IWM)

## Features

  • Simulate laminar or turbulent flow with catalytic reactions.

  • Define chemical species and their composition within the mixture.

  • Specify boundary conditions for velocity, pressure, and temperature.

  • Choose from a range of diffusivity and turbulence models.

  • Set up and control simulation parameters such as maximum simulation time, time step length, and more.

## Installation

### Simulation engine

Make sure you have OpenFOAM installed on your system. Refer to the OpenFOAM documentation for installation instructions.

More important, make sure that you have the catalyticFOAM-solver installed on your machine. For the installation procedure, please refer to the [README from polimi](https://github.com/multiscale-catalysis-polimi/catalyticFoam/blob/master/README.md).

### Python dependencies

First of all, you will need to install OSP-core, plams, AdaptiveDesignProcedure and pyZacros (all except osp-core are not on PyPI yet unfortunately):

`shell (env) user@computer:~/reaxpro-wrappers$ pip install osp-core https://github.com/SCM-NV/pyZacros/archive/refs/tags/v.1.2.zip https://github.com/mbracconi/adaptiveDesignProcedure/archive/refs/tags/v1.4.0.zip git+https://github.com/SCM-NV/PLAMS@7661960a9db53249a0b77935dacc8a7668c2489b `

Then, install the wrapper. Simply type:

`shell (env) user@computer:~/reaxpro-wrappers$ pip install simphony-catalytic `

… or if you are installing from source (cloning of the repository needed before):

`shell (env) user@computer:~/reaxpro-wrappers$ pip install . `

## Usage

For detailed examples and usage instructions, refer to the [documentation](https://reaxpro.pages.fraunhofer.de/docs/usecases.html#co-catalyticfoam-use-case-laminar-2d-flow-through-a-pipe-with-catalytic-wall) and example files in the examples directory of this repository.

## License

This project is licensed under the GPL-3 License. See the LICENSE file for more information.

## Disclaimer

Copyright (c) 2014-2023, Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V. acting on behalf of its Fraunhofer IWM.

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.

The catalyticFoam solver itself has been developed in the Multiscale Catalysis Group of the [Laboratory of Catalysis and Catalytic Processes of Politecnico di Milano](https://www.lccp.polimi.it/) and hence is not authored by Fraunhofer IWM.

Contact: [SimPhoNy](mailto:simphony@iwm.fraunhofer.de)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

simphony-catalytic-1.4.0.tar.gz (457.2 kB view details)

Uploaded Source

Built Distribution

simphony_catalytic-1.4.0-py3-none-any.whl (481.4 kB view details)

Uploaded Python 3

File details

Details for the file simphony-catalytic-1.4.0.tar.gz.

File metadata

  • Download URL: simphony-catalytic-1.4.0.tar.gz
  • Upload date:
  • Size: 457.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for simphony-catalytic-1.4.0.tar.gz
Algorithm Hash digest
SHA256 57f2a786c7c633e6f35527397c5002d5cfb7a88e70b85327bf691e1a197ea682
MD5 f6b4e10ce961ffcd8e28b5f079ae0d95
BLAKE2b-256 dd99bb4fc546833a9f73c055e125673849186fc70ebec38a31652a24e49b545f

See more details on using hashes here.

Provenance

File details

Details for the file simphony_catalytic-1.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for simphony_catalytic-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d16d8e2bfb1ba26859c75596783147192355a9be0f4094b3203a73a65910daed
MD5 33a7891be8e737c2436a301a7359e111
BLAKE2b-256 cdbd6addeed14af643b2f19130090081d04b83045a2838e0d365c6ac4fb471bd

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page