CELMA

NOTE: This repo is needs some refactorings to work out of the box. I'm currently not actively maintaining this repo, but could implement some of the fixes upon request. Feel free to do so by opening a new issue Refer to releases for more stable code

Repository for the CELMA code.

• Repository structure
• Install
• Usage
• Contribute
• Issues

Repository structure

• celma/
  • The code for solving the CELMA model.
• celmaWBoussinesq/
  • The code for solving the CELMA model using the Boussinesq approximation.
• common/
  • Common files for extra implementations (not yet included in BOUT++) written in c++ and pre- and post-proccesing functions written in python3.
• derivations/
  • Derivations of the numerics used in the code, namely:
    • Boundary polynomials
    • Own operators
    • Collisionalities
    • Analytic dispersion relations
  • Mostly written using jupyter-notebooks.
• MES/
  • Method of exact solutions used to verify own operators.
• tests/
  • Test used to check that the implemntations are working.

Install

An install script can be found in install/boutPPInstall.sh. This will install the master branch of BOUT-dev in $HOME, whereas the dependencies will be installed in local.

NOTE : The makefiles in this repository assumes that BOUT++ is located in the $HOME directory.

Usage

The models can be simulated in the way described in the BOUT++ user-manual. For more advanced jobs, such as parameter scans using supercomputers, one can use the PBS<name>.py-scripts located in celma and celmaWBoussinesq.

Contribute

Contributions are more than welcome through pull requests.

Issues

Bugs, issues and questions are being handled at the issue-tracker.

License