incompact3d

Current CPU version of our solver for the Navier-Stokes equations

https://github.com/xcompact3d/incompact3d

Science Score: 64.0%

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

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    16 of 43 committers (37.2%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.9%) to scientific vocabulary

Keywords

cfd computational-fluid-dynamics direct-numerical-simulation large-eddy-simulation navier-stokes

Keywords from Contributors

fast-fourier-transform finite-difference-method pencil-decomposition
Last synced: 6 months ago · JSON representation ·

Repository

Current CPU version of our solver for the Navier-Stokes equations

Basic Info
Statistics
  • Stars: 193
  • Watchers: 13
  • Forks: 138
  • Open Issues: 11
  • Releases: 0
Topics
cfd computational-fluid-dynamics direct-numerical-simulation large-eddy-simulation navier-stokes
Created almost 8 years ago · Last pushed 6 months ago
Metadata Files
Readme License Citation

README.md

DOI

The Xcompact3d code

Xcompact3d is a Fortran-based framework of high-order finite-difference flow solvers dedicated to the study of turbulent flows using high fidelity modelling such as Direct and Large Eddy Simulations (DNS/LES), for which the largest turbulent scales are simulated. Xcompact3d can combine the versatility of industrial codes with the accuracy of spectral codes by using the Immersed Boundary Method (IBM) to simulate complex geometries, while retaining high order accuracy. Its user-friendliness, simplicity, versatility, accuracy, scalability, portability and efficiency makes it an attractive tool for the Computational Fluid Dynamics community.

Xcompact3d is currently able to solve the incompressible and low-Mach number variable density Navier-Stokes equations up to a sixth-order accuracy using compact finite-difference schemes with a spectral-like accuracy on a monobloc Cartesian mesh.
It was initially designed in France in the mid-90's for serial processors and later ported to HPC systems. It can now be used efficiently on hundreds of thousands CPU cores to investigate turbulence and heat transfer problems thanks to the open-source library 2DECOMP&FFT, which is a Fortran-based 2D pencil/1D slabs decomposition framework to support building large-scale parallel applications on distributed memory systems using MPI. The library has a distributed Fast Fourier Transform module as well as I/O capabilities.

Fractional time stepping is used for the time advancement, solving a Poisson equation to enforce the incompressible condition. The Poisson equation is fully solved in spectral space via the use of relevant 3D Fast Fourier transforms (FFTs), allowing the use of any kind of boundary conditions for the velocity field. Using the concept of the modified wavenumber (to allow for operations in the spectral space to have the same accuracy as if they were performed in the physical space), the divergence free condition is ensured up to machine accuracy. The pressure field is staggered from the velocity field by half a mesh point to avoid spurious oscillations created by the implicit finite-difference schemes. The modelling of a fixed or moving solid body inside the computational domain is performed with a customised Immersed Boundary Method. It is based on a direct forcing term in the Navier-Stokes equations to ensure a no-slip boundary condition at the wall of the solid body while imposing non-zero velocities inside the solid body to avoid discontinuities on the velocity field. This customised IBM, fully compatible with the 2D domain decomposition and with a possible mesh refinement at the wall, is based on a 1D expansion of the velocity field from fluid regions into solid regions using Lagrange polynomials or spline reconstructions. In order to reach high Reynolds numbers in a context of LES, it is possible to customise the coefficients of the second derivative schemes (used for the viscous term) to add extra numerical dissipation in the simulation as a substitute of the missing dissipation from the small turbulent scales that are not resolved.

Documentation

Readthedocs

Owner

  • Name: Xcompact3d
  • Login: xcompact3d
  • Kind: organization
  • Location: London

High-order finite-difference suite of flow solvers on a Cartesian mesh

Citation (CITATION.cff)

We kindly request that you cite Xcompact3d/Incompact3d in your
publications and presentations. The following citations are suggested:

1-Laizet S. & Lamballais E., 2009, High-order compact schemes for
incompressible flows: a simple and efficient method with the quasi-spectral
accuracy, J. Comp. Phys.,  vol 228 (15), pp 5989-6015

2-Laizet S. & Li N., 2011, Incompact3d: a powerful tool to tackle turbulence
problems with up to 0(10^5) computational cores, Int. J. of Numerical
Methods in Fluids, vol 67 (11), pp 1735-1757

3-Bartholomew P., Deskos G., Frantz R.A.S., Schuch F.N., Lamballais E. &
Laizet S., 2020, Xcompact3D: An open-source framework for solving turbulence
problems on a Cartesian mesh, SoftwareX, vol12, pp 100550

GitHub Events

Total
  • Create event: 17
  • Release event: 1
  • Issues event: 19
  • Watch event: 44
  • Delete event: 14
  • Issue comment event: 35
  • Push event: 55
  • Pull request review comment event: 137
  • Pull request review event: 141
  • Pull request event: 37
  • Fork event: 11
Last Year
  • Create event: 17
  • Release event: 1
  • Issues event: 19
  • Watch event: 44
  • Delete event: 14
  • Issue comment event: 35
  • Push event: 55
  • Pull request review comment event: 137
  • Pull request review event: 141
  • Pull request event: 37
  • Fork event: 11

Committers

Last synced: over 1 year ago

All Time
  • Total Commits: 1,333
  • Total Committers: 43
  • Avg Commits per committer: 31.0
  • Development Distribution Score (DDS): 0.806
Past Year
  • Commits: 217
  • Committers: 16
  • Avg Commits per committer: 13.563
  • Development Distribution Score (DDS): 0.641
Top Committers
Name Email Commits
Paul Bartholomew p****8@i****k 258
Paul Bartholomew p****w@e****k 157
cflag c****l@u****r 137
slaizet 4****t 130
slaizet_laptop s****t@i****k 83
Stefano Rolfo s****o@s****k 60
Paul Bartholomew p****0@g****m 60
Arahamz a****o@i****k 54
Ricardo Frantz r****z@i****m 52
fnsch f****h@a****r 50
sylvain s****t@w****n 45
Stefano Rolfo 3****2 43
nbeb n****s@g****m 33
gdeskos g****v@g****m 21
CFLAG m****k 20
Kay Schäfer k****r@k****u 18
Ricardo Frantz r****z@a****r 15
fschuch f****h@e****r 11
Thibault Lestang t****g@i****k 10
nasos a****7@i****k 9
Christian Jane Ippel c****l@g****m 9
gd_laptop g****4@i****k 8
amole a****e@p****n 8
Thibault Lestang t****g@p****m 5
Matthew Falcone m****e@g****m 4
Paul p****l@s****e 4
Paul Bartholomew p****h@f****k 3
airwarriorg91 g****a@g****m 3
fangjian19 f****9@g****m 3
vcz18385 3****5 2
and 13 more...

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 48
  • Total pull requests: 84
  • Average time to close issues: 3 months
  • Average time to close pull requests: about 1 month
  • Total issue authors: 21
  • Total pull request authors: 17
  • Average comments per issue: 2.73
  • Average comments per pull request: 0.5
  • Merged pull requests: 68
  • Bot issues: 0
  • Bot pull requests: 3
Past Year
  • Issues: 7
  • Pull requests: 14
  • Average time to close issues: 29 days
  • Average time to close pull requests: 6 days
  • Issue authors: 4
  • Pull request authors: 6
  • Average comments per issue: 0.57
  • Average comments per pull request: 0.43
  • Merged pull requests: 9
  • Bot issues: 0
  • Bot pull requests: 1
Top Authors
Issue Authors
  • mathrack (15)
  • airwarriorg91 (9)
  • pbartholomew08 (8)
  • slaizet (4)
  • ningli-amd (4)
  • mattfalcone1997 (3)
  • yeechin (3)
  • StevenChow9527 (1)
  • Jamie-Z (1)
  • Prathamesh-Banda (1)
  • dineshkumarreddyg36 (1)
  • fvide (1)
  • mchba (1)
  • rvicentecruz (1)
  • Beliavsky (1)
Pull Request Authors
  • pbartholomew08 (36)
  • mathrack (31)
  • rfj82982 (14)
  • slaizet (6)
  • cjaneippel (4)
  • airwarriorg91 (4)
  • tlestang (3)
  • fangjian19 (3)
  • github-actions[bot] (3)
  • Pasha0313 (2)
  • admole (2)
  • CFD-Xing (2)
  • rvicentecruz (1)
  • nasos94 (1)
  • joconnor22 (1)
Top Labels
Issue Labels
bug (21) enhancement (12) good first issue (2)
Pull Request Labels
bug (4) enhancement (2)

Dependencies

.github/workflows/Build.yml actions
  • actions/cache v3 composite
  • actions/checkout v3 composite
.github/workflows/generate_reference_test_data.yml actions
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • peter-evans/create-pull-request v4 composite
docs/requirements.txt pypi
  • nbconvert >=5.6
  • nbsphinx >=0.7
  • pygments >=2.6
  • sphinx >=3.2
  • sphinx-autobuild *
  • sphinx-copybutton >=0.3
  • sphinx-rtd-theme >=0.5