Sovereign 8s.is mirror of standardgalactic/QuinckeMultipolarRigidMultiblob
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2025-12-17 16:40:53 +01:00
dipole_numerical.py Add files via upload 2025-12-17 16:40:53 +01:00
input Add files via upload 2025-12-17 16:40:53 +01:00
input_file.clones Add files via upload 2025-12-17 16:40:53 +01:00
Lub_Solver_trap.py Add files via upload 2025-12-17 16:40:53 +01:00
main_rollers_c.py Add files via upload 2025-12-17 16:40:53 +01:00
multi_bodies_functions.py Add files via upload 2025-12-17 16:40:53 +01:00
readme.txt Add files via upload 2025-12-17 16:40:53 +01:00

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Additional modules for Quincke rollers with multipolar electrohydrodynamics
in the presence of a conductivity gradient
===========================================================================

This repository contains **auxiliary Python modules and modified subroutines**
used in the simulations reported in

    *Self-oscillating synchronematic colloids*

The files provided here are **not a standalone simulation package**.
They are intended to be used **in combination with** the open-source
`RigidMultiblobsWall` code developed by the Stochastic Hydrodynamics Tools
project.

---------------------------------------------------------------------------
Dependency
---------------------------------------------------------------------------

This code extends the functionality of:

    RigidMultiblobsWall
    https://github.com/stochasticHydroTools/RigidMultiblobsWall

`RigidMultiblobsWall` is a C / Python framework for Brownian and Stokesian
dynamics of rigid multiblob particles near boundaries. All hydrodynamic
solvers, lubrication corrections, and time-integration schemes are provided
by that package.

**You must install and run RigidMultiblobsWall first.**
This repository only supplies *additional physics modules and minor solver
modifications* required for the present work.

---------------------------------------------------------------------------
Purpose of this repository
---------------------------------------------------------------------------

The files in this repository implement additional physics needed to model
Quincke rollers in the presence of conductivity gradients, including:

- Time evolution of **charge, dipole, and quadrupole moments**
- Electrostatic and electrohydrodynamic interactions between rollers
- Coupling between multipolar electrostatics and rigid-body dynamics
- Modifications to the lubrication solver to evolve internal degrees of freedom

These extensions were introduced to reproduce the simulations presented in
the main text and supplementary material of the associated publication.

---------------------------------------------------------------------------
Provided files
---------------------------------------------------------------------------

Key files included in this repository:

- `dipole_numerical.py`  
  Implements the evolution equations for charge, dipole, and quadrupole
  moments of a Quincke roller, including Maxwell–Wagner relaxation and
  conductivity-gradient effects.

- `multi_bodies_functions.py`  
  Extends the force and torque calculations in `RigidMultiblobsWall` to include
  multipolar electrostatic interactions, quadrupolar torques, and frictional
  forces.

- `Lub_Solver_trap.py`  
  Modified version of the lubrication solver step to consistently evolve
  internal multipolar degrees of freedom alongside rigid-body motion.

- `main_rollers_c.py`  
  Example driver script illustrating how these modules are combined with
  `RigidMultiblobsWall` to run a full simulation.

- `input` / `*.clones` files  
  Example input files required to reproduce a representative simulation
  from the paper.

---------------------------------------------------------------------------
Required modification to RigidMultiblobsWall
---------------------------------------------------------------------------

To use this repository, **one file in RigidMultiblobsWall must be replaced**.

In the folder:

    RigidMultiblobsWall/Lubrication/

replace the function `Update_Bodies_Trap` in:

    Lub_Solver.py

with the version provided in:

    Lub_Solver_trap.py

This modification enables the coupled evolution of rigid-body motion and
multipolar electrostatic degrees of freedom.

---------------------------------------------------------------------------
Python environment
---------------------------------------------------------------------------

The following Python packages were used and tested:

    gsd==3.3.0
    llvmlite==0.43.0
    numba==0.60.0
    numpy==1.26.4
    pip==22.0.2
    pyamg==5.1.0
    scikit-sparse==0.4.13
    scipy==1.13.1
    setuptools==59.6.0

It is recommended to install these dependencies in a dedicated virtual
environment.

---------------------------------------------------------------------------
Citation and attribution
---------------------------------------------------------------------------

If you use this code, please cite both:

1. The associated paper:
   *Self-oscillating synchronematic colloids*

2. The RigidMultiblobsWall package:
   https://github.com/stochasticHydroTools/RigidMultiblobsWall

This repository builds directly on that software and would not function
without it.

---------------------------------------------------------------------------
Notes
---------------------------------------------------------------------------

- This repository is provided for **reproducibility and transparency**.
- The code reflects the research implementation used in the paper and is
  not optimized as a general-purpose library.
- Users are encouraged to consult the original `RigidMultiblobsWall`
  documentation for details on installation, compilation, and solver options.