Navier-Stokes Propagator

Description

The repository contains source files for ReCoDE-NavierStokesPropagator.jl, a Julia package written to solve the chaotic Navier-Stokes equations. The project aims to exemplify the improvement of simulation code quality using good programming abstractions (Julia Structs) and defining sensible simulation constructs that reflect each core component of the simulation. Additionally, the repository adopts good programming practices by implementing detailed documentation with unit tests written for each simulation construct.

The algorithm used here is inspired from Diablo, written by John R. Taylor, with minor modifications to the mesh spacing.

Learning Outcomes

• Ability to distinguish and compartmentalise a multi-facet simulation algorithm into sensible simulation constructs via the implementation with Julia Structs
• Adopting good testing methodologies, through implementation of unit and integration tests
• Understanding the FFTW.jl and HDF5.jl libraries and their abstraction through the usage of utility modules in their respective source files

Task	Time
Reading	3 hours

Requirements

Theoretical

• Exploring Fourier series and its relation to the discrete Fourier transform
• Understanding of the finite difference method for approximating spatial derivatives and the use of implicit/explicit time-stepping schemes
• Familiarity with Julia. The Early Career Researcher Institute also provides an Introduction to Julia course.

Note : The theoretical understanding of the finite difference method, Fourier series and the time-stepping scheme are not a major necessity. An understanding of the mathematical structure for algorithimic implementation is sufficient to understand the ideas discussed in this tutorial.

System

• Install Julia on your system.
• Install VS Code on your system.
• Install Julia language extension on VS Code.

Getting Started

1. Clone the repository using git clone https://github.com/ImperialCollegeLondon/ReCoDE-NavierStokesPropagator.git and enter the repository directory via cd ReCoDE-NavierStokesPropagator.
2. Open the system terminal via VSCode and launch the Julia REPL via julia.
3. Launch Julia pkg mode via pressing ] in the Julia REPL.
4. In the pkg mode, activate the package environment via activate ..
5. Testing can be done by entering test in the REPL's pkg mode.

Project Structure

.
├── src
│   ├── NavierStokesPropagators.jl
│   ├── NavierStokesPropagatorsCore.jl
│   ├── sim
│   │   ├── DomainDescriptors.jl
│   │   ├── SimulationConditions.jl
│   │   └── States.jl
│   └── util
│       ├── InputOutputManagers.jl
│       ├── LinearSolvers.jl
│       └── Transformations.jl
├── test
│   ├── sim (mirrors src/sim)
│   ├── util (mirrors src/util)
│   ├── StateTransformations.jl
│   └── runtest.jl
├── docs
└── .github
    └── (.yml files for CI/CD)

License

This project is licensed under the BSD-3-Clause license.