From 6c63685d6ae4534f898e449f0972f0b28137cc67 Mon Sep 17 00:00:00 2001 From: TravisMitchell Date: Fri, 2 Feb 2024 14:07:13 +1000 Subject: [PATCH] + shorten and move location of models description --- README.md | 46 +++++++++++++++++++++++----------------------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 72975d96..a01eb0dc 100644 --- a/README.md +++ b/README.md @@ -31,29 +31,6 @@ make d2q9 CLB/d2q9/main example/flow/2d/karman.xml ``` -## Models -For users looking to apply existing LBM methods, the default/actively supported models for common applications are below. Note that extensions to these models exist using the [TCLB's overlay](https://github.com/CFD-GO/TCLB_overlay) framework, these are listed below for the relevant models. - -**Two-Dimensional** -- d2q9: multiple-relaxation time LBM for single-phase flow. -- d2q9_les: multiple-relaxation time LBM with Smagorinski LES turbulence model. -- d2q9q9_cm_cht: thermal LBM with Boussinesq approx for coupling and cumulant or cascaded collision relaxation kernels. -- d2q9_pf_velocity: multiphase LBM based on the phase field model and incompressible LBM. - -**Three-Dimensional** -- d3q27_cumulant: cumulant LBM with options for: - * Interpolated bounceback for improved geometry. - * Smagorinski LES turbulence model. -- d3q27q27_cm_cht: thermal LBM with Boussinesq approx for coupling and cumulant or cascaded collision relaxation kernels. -- d3q27_pf_velocity: multiphase LBM based on the phase field model and incompressible LBM. - * Options for various contact angle implementations (surface energy or geometric) - * [Thermocapillary flow extension](https://github.com/TravisMitchell/thermocapillary) - -**Particle (DEM) Coupled** -- d3q27_PSM: Applies the partially saturated model for coupling particles in single phase flow. - * Options for Two-Relaxation-Time kernel - * Option for Non-Equilibiurm Bounce-Back and Superposition for the DEM-LBM coupling. - ## More information ### Documentation @@ -129,6 +106,29 @@ The DEM codes that TCLB can be integrated with are: Refer to the documentation for instructions on compilation and coupling. +## Models +For users looking to apply existing LBM methods, common/supported models are below. Note extensions to these models exist using the [TCLB's overlay](https://github.com/CFD-GO/TCLB_overlay) framework and TCLB optional compile flags. + +**Two-Dimensional** +- d2q9: MRT LBM for single-phase flow. +- d2q9_les: MRT LBM with Smagorinski LES turbulence model. +- d2q9q9_cm_cht: thermal LBM with Boussinesq approx for coupling and cumulant or cascaded relaxation kernels. +- d2q9_pf_velocity: multiphase LBM based on the phase field model and incompressible LBM. + +**Three-Dimensional** +- d3q27_cumulant: cumulant LBM with options for: + * Interpolated bounceback. + * Smagorinski LES turbulence model. +- d3q27q27_cm_cht: thermal LBM with Boussinesq approx for coupling and cumulant or cascaded collision relaxation kernels. +- d3q27_pf_velocity: multiphase LBM based on the phase field model and incompressible LBM. + * Options for various contact angle implementations (surface energy or geometric) + * [Thermocapillary flow extension](https://github.com/TravisMitchell/thermocapillary) + +**Particle (DEM) Coupled** +- d3q27_PSM: Applies the partially saturated model for coupling particles in single phase flow. + * Options for Two-Relaxation-Time kernel + * Option for Non-Equilibiurm Bounce-Back and Superposition for the DEM-LBM coupling. + ## About ### Authors