Neko Plugins

This repository contains plugins for Neko, a high-order spectral element solver for incompressible flows.

Repository Structure

This repository uses git submodules for some of its components.

• FST/ - Free-Stream Turbulence (FST) plugin (git submodule)
• neko_functions/ - Neko utility functions
• scripts/ - Helper scripts
• tripping/ - Trip wire plugin

Git Submodule Setup

The FST plugin is managed as a git submodule pointing to the free-stream-turbulence repository.

Initial Clone

When cloning this repository for the first time, use:

git clone --recurse-submodules git@github.com:vbaconnet/neko-plugins.git

This will automatically initialize and update all submodules.

If You Already Cloned Without Submodules

If you cloned without --recurse-submodules, initialize and update submodules with:

git submodule init
git submodule update --remote

Updating Submodules

To update all submodules to their latest versions:

git submodule update --remote --recursive

Updating FST Submodule Only

To update only the FST submodule to the latest master branch:

cd FST
git pull origin master
cd ..
git add FST
git commit -m "Update FST submodule to latest version"

Or more simply:

git submodule update --remote FST

FST Plugin

The Free-Stream Turbulence (FST) plugin has been moved to a separate repository:

• Repository: https://github.com/vbaconnet/free-stream-turbulence
• Documentation: See the FST README for usage and configuration details

The FST submodule is configured to track the master branch of the free-stream-turbulence repository.