/nanoconfinement-md

This code allows users to simulate ions confined between material surfaces that are nanometers apart, and extract the associated ionic structure.

Primary LanguageJupyter NotebookApache License 2.0Apache-2.0

nanoconfinement-md

What does this code do

  • The code enables simulations of ions confined between nanoparticles (NPs) or other material surfaces
    • Length of confinement is of the order of nanometers
  • Materials represent nanoparticles (NPs) or biomacromolecules
    • NP surfaces are treated as planar walls due to the large size difference between ions and NPs
  • Users can extract the ionic structure (density profile) for a wide variety of ionic and environmental parameters
  • Unpolarized surfaces are assumed and standard molecular dynamics is used to propagrate the dynamics of ions

THE FOLLOWING INSTRUCTIONS ARE FOR BIGRED200 INSTALL and GENERATE ONE DATA SAMPLE:

  • Locate into the project directory: cd nanoconfinement-md

  • Load the necessary modules: module load gsl/2.7 && module load boost/1.78.0

  • You should provide the following make command to make the project. This will create the executable and install the executable (md_simulation_confined_ions) into bin directory (That is nanoconfinement-md/bin)
    make cluster-install

  • Then go into the bin directory: cd bin

  • Next run the simulation using LAMMPS-- this will first use C++ to create LAMMPS scripts:
    time srun -A rxxxxx -n 1 -d 1 ./md_simulation_confined_ions -Z 4.2 -p 1 -n -1 -c 0.1 -d 0.2 -a 0.2 -i -0.01 -S 10000000 -B 0.05 -m 1000000 -J true -j true

  • Note: The parameters are defined as:
    -A is the RT project number for running job on bigred200
    -Z: confinement length
    -p/-n: positive/negative valency
    -c: salt concentration
    -d/-a: positive/negative valency
    -i: surface charge density
    -S: simulation steps(not used when only generating LAMMPS input scripts)
    -B: binwidth
    -m: MD movie frequency(not used when only generating LAMMPS input scripts)
    -J: LAMMPS(true LAMMPS; false MD)
    -j: LAMMPS Preprocessing/Postprocessing (true Preprocessing; false Postprocessing)\

  • Time to do LAMMPS preprocessing takes around 10 seconds. real 0m9.302s

  • Next submit the script nanoconfinement-lammps.pbs to run LAMMPS simulation: sbatch nanoconfinement-lammps.pbs

  • When simulation finishes, the result ion density files will be stored in bin/data directory. Total average density values can be found in n_density_profile.lmp.dat and p_density_profile.lmp.dat; Average density values per N steps can be found in n_density_profile.lmp.for.errorbars.dat and p_density_profile.lmp.for.errorbars.dat

THE FOLLOWING INSTRUCTIONS ARE FOR LOCAL INSTALL AND TEST:

Necessary Modules

  • Load the necessary modules: module load gsl && module load openmpi/3.0.1 && module load boost/1_67_0
  • Also make sure to export OMP_NUM_THREADS environment variable with maximum threads available in your CPU: export OMP_NUM_THREADS=16

Install instructions

  • Copy or git clone nanoconfinement-md project in to a directory.

  • Go to nanoconfinement-md directory and (cd nanoconfinement-md)

  • You should provide the following make command to make the project. This will create the executable and Install the executable (md_simulation_confined_ions) into bin directory (That is nanoconfinement-md/bin)

    • make local-install

  • Now, you have two options to run the simulation. You can run the simulation through the in-house code or the LAMMPS. The difference between these two options is the method that we use to calculate the electrostatics energy and force. In in-house code, we calculate the electrostatics energy and force with "charged sheet method". In LAMMPS, the electrostatics energy and force are calculated with Ewald-Summation method.

Run the simulation through the in-house code:

  • go to the bin directory: cd bin

  • Now you are ready to run the executable with aprun command using the following method:

    • time mpirun -np 2 -N 16 ./md_simulation_confined_ions -Z 3 -p 1 -n -1 -c 0.5 -d 0.714 -a 0.714 -i 0.0 -S 1000000

  • For rapid testing, use a small S and different d, a pairs for different ion size combinations:

    • time mpirun -np 2 -N 16 ./md_simulation_confined_ions -Z 3 -p 1 -n -1 -c 0.5 -d 0.474 -a 0.627 -i 0.0 -S 10000

  • In command, you can change many parameters to generate the simulations. Some of these parameters are: -Z length of confinement (nm), -p valency of positive ions, -n valency of negative ions, -c salt concentration (M), -d diameter of positive ion (nm), -a diameter of negative ion (nm), -i charge density on the surface (C.m-2), -S simulation time (steps). The diameter of positive ion can be the same as negative ion (symmetric) or different (asymmetric). You can see some of these examples in nanoconfinement-md/examples. If you want to change more parameters in simulation, please read NanoconfinementMd.cpp file.

Run the simulation through the LAMMPS:

  • In nanoconfinement-md directory, the command to execute the LAMMPS is:

    • make local-run-lammps Z=3 p=1 n=-1 c=0.5 d=0.714 a=0.714 i=0.0 S=1000000 MPIRUNCMD=mpirun LAMMPSEXE=lmp
    • Or use: make local-run-lammps Z=3 p=1 n=-1 c=0.5 d=0.714 a=0.714 i=0.0 S=1000000 MPIRUNCMD=mpirun LAMMPSEXE=lmp_g++

  • For faster simulations, do

    • make local-run-lammps Z=3 p=1 n=-1 c=0.5 d=0.474 a=0.627 i=0.0 S=10000 MPIRUNCMD=mpirun LAMMPSEXE=lmp_g++

  • This make command creates the input data file (ip.lammps.xyz) through the inhouse code. Then it runs the simulation with LAMMPS. In LAMMPS, you can define charge on the surfaces. For uncharged surfaces: i=0.0. For charged surfaces, you can choose i between zero to -0.01 C/m2. The simulation does not work with charge density more than zero or less than -0.01 C/m-2.

  • All outputs from the simulation will be stored in the bin folder when the simulation is completed. Check and compare files inside the bin/outfiles and bin/data directories. In bin/data directory, you can compare the averaged density profiles of cation and anion (with error bars).

    • If you ran the simulation with in-house code, the energy values are stored in outfiles/energy.out (1st column: step number, 3rd: kinetic energy, 4th: potential energy (evdwl+ coul)).
    • If you ran the simulation with LAMMPS code, the energy values are stored in outfiles/thermo.dat (1st column: step number, 6th: kinetic_energy per particle, 8th: epair eneragy (evdwl+ coul) per particle). If you wish to compare the results of energy profiles from inhouse code (energy.dat) and LAMMPS (thermo.dat), in thermo.dat you should multiply the energy values by total number of atoms (the total number of atoms is printed in 2nd line in ip.lammps.xyz).

  • If you want to clean everything and create a new build, do:

    • make clean

  • Once the simulation has finished, data and outflies folders will contain the simulation results. You may check final density profile form data folder against the example desity profile provided in nanoconfinement-md/examples folder.

For further details please refer to the documentation

NanoHUB app page: