Skip to content

mw6136/FIEFS

Repository files navigation

FIEFS - Flow Instability Eulerian Flow Solver

A Python simulation code with finite volume compressible inviscid fluid solver

FIEFS-transformed

Implemented problems

  • Karman Vortex Generation

Karman_fluid

  • Kelvin-Helmholtz Instability

kh_crop

Future problems

  • Rayleigh-Taylor Instability
  • Rayleigh-Benard Convection
  • Richtmeyer-Meshkov Instability

How to run

In order to run, activate the conda environment contained in workflow/environment.yaml. From there, the following command can be run from the main directory

python FIEFS.py -p problem_name

Where problem_name is the name of the problem being run, corresponding to the name of the input file and problem generator file. For example, to run the Kelvin-Helmholtz instability problem, execute the command python FIEFS.py -p kh.

To generate a new input file (which uses the Kelvin-Helmholtz instability as the default), run the inputGUI.py script, which will launch a GUI where the user can input whatever parameters they would like to change. The final tab (the RUN tab) displays which commands to enter to run the input file that was just created.

The outputs from the simulation for plotting can be found in outputs/plots.

Documentation for specifics about each of the functions present in the code can be found in misc/class_documentation.pdf

Implementing new problems

In order to implement new problems, it is as simple as adding a problem generator file in src/pgen with the corresponding problem name, and adding an input file to the inputs directory. There are template/sample files available in those directories to assist in implementing a new problem.

Next, in order for FIEFS to recognize the problem when set on the command line, in FIEFS.py, the new problem generator file needs to be imported, and a new conditional statement needs to be added underneath:

if problem_name == "kh":
        problem_generator = kh.ProblemGenerator

for the new file to be recognized and the correct problem generator to be used. From there, running the original run command with the new problem name should successfully execute the new problem.

Solver information (and citation)

The solver implemented in FIEFS is a MUSCL-Hancock scheme as described in [1]. Specifically, it is a 2-dimensional finite volume solver for the inviscid Euler equations, with a minmod slope limiter and and HLLC Riemann solver (also explained extensively in [1]). This work was adapted from the work of Boerchers et al in [2].

[1] Toro, E. F. (2011). Riemann solvers and Numerical Methods for fluid dynamics: A practical introduction. Springer.

[2] Boerchers, J., Rzepka, S., and Fush, T. (2022). PSYCHo-I - Python Simulations Yielding Hydrodynamic Instabilities. Github repository: https://github.com/johnboerchers/psycho-i.

About

Software Engineering Project for APC524

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages