Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Sedimentation Tutorial Langevin vs. LB #4570

Merged
merged 4 commits into from
Oct 1, 2022
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/sphinx/integration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -440,6 +440,7 @@ Best explained in an example::
As explained before the temperature is set as thermal energy :math:`k_\mathrm{B} T`.

The Langevin thermostat is based on an extension of Newton's equation of motion to
account for drag and collisions with a fluid:

.. math:: m_i \dot{v}_i(t) = f_i(\{x_j\},v_i,t) - \gamma v_i(t) + \sqrt{2\gamma k_B T} \eta_i(t).

Expand Down
3 changes: 2 additions & 1 deletion doc/tutorials/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ physical systems.
Simulations including hydrodynamic interactions using the Lattice-Boltzmann method.
Guide
[Part 1](lattice_boltzmann/lattice_boltzmann_theory.ipynb) |
[Part 2](lattice_boltzmann/lattice_boltzmann_poiseuille_flow.ipynb)
[Part 2](lattice_boltzmann/lattice_boltzmann_poiseuille_flow.ipynb) |
[Part 3](lattice_boltzmann/lattice_boltzmann_sedimentation.ipynb)
* **Polymers**
Modelling polymers with hydrodynamic interactions.
[Guide](polymers/polymers.ipynb)
Expand Down
5 changes: 4 additions & 1 deletion doc/tutorials/lattice_boltzmann/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
configure_tutorial_target(
TARGET tutorial_lb DEPENDS lattice_boltzmann_theory.ipynb
lattice_boltzmann_poiseuille_flow.ipynb figures/latticeboltzmann-grid.png
lattice_boltzmann_poiseuille_flow.ipynb lattice_boltzmann_sedimentation.ipynb
figures/latticeboltzmann-grid.png
figures/latticeboltzmann-momentumexchange.png)

nb_export(TARGET tutorial_lb SUFFIX "1" FILE "lattice_boltzmann_theory.ipynb"
HTML_RUN)
nb_export(TARGET tutorial_lb SUFFIX "2" FILE
"lattice_boltzmann_poiseuille_flow.ipynb" HTML_RUN)
nb_export(TARGET tutorial_lb SUFFIX "3" FILE
"lattice_boltzmann_sedimentation.ipynb" HTML_RUN)
16 changes: 16 additions & 0 deletions doc/tutorials/lattice_boltzmann/NotesForTutor.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,19 @@ In the course of this tutorial, students should learn to:

* Set up an LB fluid with LB boundaries
* Retrieve data from the LB grid

# Part 3: Sedimentation

## Physics learning goals

After the tutorial, students should be able to:

* Describe hydrodynamic effects on particle diffusion

## ESPResSo learning goals

In the course of this tutorial, students should learn to:

* Set up external forces on particles (e.g. gravity, constant electric field)
* Set up particle observables and LB profile observables
* Register observables in accumulators
Loading