FEST-3D

FEST-3D: Finite-volume Explicit STructured 3-Dimensional solver - Published in JOSS (2020)

https://github.com/fest3d/fest-3d

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 10 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org, zenodo.org
  • Committers with academic emails
    2 of 8 committers (25.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software
Last synced: 6 months ago · JSON representation

Repository

The source code for Finite volume Explicit STructured 3Dimensional (FEST-3D) solver.

Basic Info
Statistics
  • Stars: 37
  • Watchers: 5
  • Forks: 16
  • Open Issues: 7
  • Releases: 2
Created almost 7 years ago · Last pushed almost 3 years ago
Metadata Files
Readme Contributing License Code of conduct

README.md

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:

  • Fortran and C++11 compiler
  • MPI library
  • CMAKE and MAKE
  • Python3-numpy for integrated test

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:

  • Dr. Santanu Ghosh
    Assistant Professor
    Department of Aerospace Engineering
    Indian Institute of Technology Madras

Code contributors:

  • Jatinder Pal Singh Sandhu
    Ph.D. Student (Current)
    Department of Aerospace Engineering
    Indian Institute of Technology Madras

  • Anant Girdhar
    B.Tech Student (2015)
    Department of Aerospace Engineering
    Indian Institute of Technology Madras

  • Rakesh Ramakrishnan
    Dual Degree Student (2016)
    Department of Aerospace Engineering
    Indian Institute of Technology Madras

  • R D Teja
    B.Tech Student (2016)
    Department of Aerospace Engineering
    Indian Institute of Technology Madras

Owner

  • Name: FEST3D
  • Login: FEST3D
  • Kind: user
  • Location: India
  • Company: Department of Aerospace Engineering, IIT Madras

I solve Navier-Stokes equation.

JOSS Publication

FEST-3D: Finite-volume Explicit STructured 3-Dimensional solver
Published
February 10, 2020
Volume 5, Issue 46, Page 1555
Authors
Jatinder Pal Singh Sandhu ORCID
Department of Aerospace engineering, IIT Madras, Chennai
Anant Girdhar
Department of Aerospace engineering, IIT Madras, Chennai
Rakesh Ramakrishnan
Department of Aerospace engineering, IIT Madras, Chennai
R. D. Teja
Department of Aerospace engineering, IIT Madras, Chennai
Santanu Ghosh
Department of Aerospace engineering, IIT Madras, Chennai
Editor
Lorena A Barba ORCID
Tags
CFD Turbulence/Transition modeling Structured grid RANS modeling Higher-order method FORTRAN 90

GitHub Events

Total
  • Watch event: 3
Last Year
  • Watch event: 3

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 252
  • Total Committers: 8
  • Avg Commits per committer: 31.5
  • Development Distribution Score (DDS): 0.345
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Jatinder Pal Singh Sandhu j****0@g****m 165
AnantG a****r@g****m 70
Rakesh Ramakrishnan r****2@g****m 10
Santanu78 s****1@a****n 3
The Gitter Badger b****r@g****m 1
RDharmaTeja r****a@g****m 1
Lorena A. Barba l****a@g****u 1
FEST3D 3****D 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 12
  • Total pull requests: 17
  • Average time to close issues: about 1 month
  • Average time to close pull requests: about 3 hours
  • Total issue authors: 4
  • Total pull request authors: 4
  • Average comments per issue: 0.92
  • Average comments per pull request: 0.12
  • Merged pull requests: 17
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • rouson (4)
  • jayten (4)
  • FEST3D (3)
  • college301654-art (1)
Pull Request Authors
  • jayten (14)
  • gitter-badger (1)
  • FEST3D (1)
  • labarba (1)
Top Labels
Issue Labels
enhancement (4) bug (4)
Pull Request Labels
bug (9)