search

FEST3D / FEST-3D

The source code for Finite volume Explicit STructured 3Dimensional (FEST-3D) solver.
https://fest3d.github.io/index.html
GNU General Public License v3.0
34 stars 16 forks source link

readme

FEST-3D: Finite-volume Explicit STructured 3-Dimensional

FEST-3D

DOI Build Status License: GPL v3 Join the chat at https://gitter.im/FEST-3D/community DOI

AIM

FEST3D (Finite-volume Explicit STructured 3-Dimensional) is computational fluid dynamic code written in Fortran 90 for solving Navier-Stokes equations on a structured grid using state of the art finite-volume numerical methods. It is a modular, multiblock finite-volume code developed to solve compressible flow problems encountered in the field of aerodynamics.

Documentation

Full Documentation for the FEST-3D solver is generated with FORD documentation generator. Documentation is available at website .

Installation

An install.sh bash script has been provided for ubuntu, CentOS and MacOS platforms. This script will take care of dependencies, build executable, run unit and integrated test and set FEST3D enviornment variable. You can run install.sh using the following command:

$ . install.sh

You might be prompted for password to install dependencies. This scirpt will add a following line at the end of either .bashrc or .bash_profile file

export FEST3D="<edit-path-to-FEST-3D-folder>/bin/FEST"

For manual installation instruction check out Documentation guide.

Dependencies

FEST-3D has the following dependencies:

So, all the dependencies can be installed using following commands on ubuntu:

$sudo apt-get update
$sudo apt-get install build-essential
$sudo apt-get install cmake
$sudo apt-get install gfortran
$sudo apt-get install mpich
$sudo apt-get install python3-numpy

The CMAKE implementation in FEST-3D is adapted from the template developed by Seth Morton available at GitHub.

Building

To build the FEST-3D code, we first generate a new "build" directory/folder in the root directory of the FEST-3D code. Inside the build directory, we execute Cmake with specific FORTRAN compiler.
Following list of comnands will build the executalbe

$mkdir build && cd build
$cmake ..
$make -j 4

These commands will create a binary file named FEST3D in the bin folder; located in the root directory of the FEST-3D code.

Check

Make sure the FEST3D enviornment variable is set properly by using following command:

echo $FEST3D

If output is string of zero length then execute following and additionaly add it to .bashrc or .bash_profile for permanent effect.

export FEST3D="<edit-path-to-FEST-3D-folder>/bin/FEST"

Tutorials

For tutorials check out description of test cases. A step by step instruction for Lid-Driven cavity test case is given here.

Citation

DOI

User are requested to cite the following JOSS article for any research publications made using the FEST-3D solver.

Jatinder Pal Singh Sandhu, Anant Girdhar, Rakesh Ramakrishnan, R. Teja, Santanu Ghosh, FEST-3D: Finite-volume Explicit STructured 3-Dimensional solver, Journal of Open Source Software, 5(46), 1555, https://doi.org/10.21105/joss.01555.

Reference

Details about the algorithms used in the FEST-3D code can be found in the publication by Jatinder Pal Singh Sandhu et al. (Singh Sandhu, J. P., Girdhar, A., Ramakrishnan, R., Teja, R. D., & Ghosh, S., A convergence study of solutions using two two-equation RANS turbulence models on a finite volume solver for structured grids, AIAA 2018-3859).

FEST-3D Team

Advisors:

Code contributors: