search

AMReX-Fluids / incflo

Incompressible Navier-Stokes solver in complex geometries
https://amrex-fluids.github.io/incflo
BSD 3-Clause "New" or "Revised" License
46 stars 28 forks source link

readme

Directory overview

Directory Description
test_2d Directory for building 2D EB executable
test_3d Directory for building 3D EB executable
test_no_eb_2d Directory for building 2D non-EB executable
test_no_eb_3d Directory for building 3D non-EB executable
src Source files

Using incflo

To build and run incflo, you will need to first clone the AMReX and AMReX-Hydro repositories.

We suggest using the main branch of both repositories.

Check out AMReX

Clone AMReX from the official Git repository

> git clone git@github.com:AMReX-Codes/amrex.git

Clone AMReX-Hydro from the official Git repository

> git clone git@github.com:AMReX-Fluids/AMReX-Hydro.git

Build and run an example incflo problem

Clone and build incflo

> git clone git@github.com:AMReX-Fluids/incflo.git
> cd incflo/test_3d
> make -j4
> mpirun -np 4 incflo3d.gnu.MPI.ex benchmark.channel_cylinder-x

Note that, depending on where you have put the amrex and AMReX-Hydro repos in your local working space, you may need to set AMREX_HOME and AMREX_HYDRO_HOME either as environment variables or in incflo/test*/GNUMakefile.

Contributing

We welcome contributions in the form of pull-requests from anyone. For more details on how to contribute to incflo, please see CONTRIBUTING.md.