moldyn.h

   1 /*
   2  * moldyn.h - molecular dynamics library header file
   3  *
   4  * author: Frank Zirkelbach <frank.zirkelbach@physik.uni-augsburg.de>
   5  *
   6  */
   7
   8 #ifndef MOLDYN_H
   9 #define MOLDYN_H
  10
  11 #include "math/math.h"
  12 #include "random/random.h"
  13 #include "list/list.h"
  14
  15
  16 /*
  17  *
  18  * datatypes
  19  *
  20  */
  21
  22 /* general */
  23 typedef unsigned char u8;
  24
  25 /* the atom of the md simulation */
  26 typedef struct s_atom {
  27         t_3dvec r;              /* position */
  28         t_3dvec v;              /* velocity */
  29         t_3dvec f;              /* force */
  30         t_3dvec virial;         /* virial (v_xx, v_yy, v_zz) */
  31         double e;               /* site energy */
  32         int element;            /* number of element in pse */
  33         double mass;            /* atom mass */
  34         u8 brand;               /* brand id */
  35         int tag;                /* atom unique id (number of atom) */
  36         u8 attr;                /* attributes */
  37 } t_atom;
  38
  39 #define ATOM_ATTR_FP    0x01    /* fixed position (bulk material) */
  40 #define ATOM_ATTR_HB    0x02    /* coupled to heat bath (velocity scaling) */
  41
  42 #define ATOM_ATTR_1BP           0x10    /* single paricle potential */
  43 #define ATOM_ATTR_2BP           0x20    /* pair potential */
  44 #define ATOM_ATTR_3BP           0x40    /* 3 body potential */
  45
  46 /* cell lists */
  47 typedef struct s_linkcell {
  48         int nx,ny,nz;           /* amount of cells in x, y and z direction */
  49         int cells;              /* total amount of cells */
  50         double len;             /* prefered cell edge length */
  51         double x,y,z;           /* the actual cell lengthes */
  52         t_list *subcell;        /* pointer to the cell lists */
  53         int dnlc;               /* direct neighbour lists counter */
  54 } t_linkcell;
  55
  56 #include "visual/visual.h"
  57
  58 /* moldyn schedule structure */
  59 typedef struct s_moldyn_schedule {
  60         int content_count;
  61         int *runs;
  62         double *tau;
  63         int (*hook)(void *moldyn,void *hook);
  64         void *hook_params;
  65 } t_moldyn_schedule;
  66
  67 /* moldyn main structure */
  68 typedef struct s_moldyn {
  69         int count;              /* total amount of atoms */
  70         t_atom *atom;           /* pointer to the atoms */
  71
  72         t_3dvec dim;            /* dimensions of the simulation volume */
  73         double volume;          /* volume of sim cell (dim.x*dim.y*dim.z) */
  74
  75         /* potential force function and parameter pointers */
  76         int (*func1b)(struct s_moldyn *moldyn,t_atom *ai);
  77         void *pot1b_params;
  78         int (*func2b)(struct s_moldyn *moldyn,t_atom *ai,t_atom *aj,u8 bc);
  79         int (*func2b_post)(struct s_moldyn *moldyn,t_atom *ai,t_atom *aj,u8 bc);
  80         void *pot2b_params;
  81         int (*func3b)(struct s_moldyn *moldyn,t_atom *ai,t_atom *aj,t_atom *ak,
  82                       u8 bck);
  83         void *pot3b_params;
  84         //int (*potential_force_function)(struct s_moldyn *moldyn);
  85
  86         double cutoff;          /* cutoff radius */
  87         double cutoff_square;   /* square of the cutoff radius */
  88         double nnd;             /* nearest neighbour distance (optional) */
  89
  90         t_linkcell lc;          /* linked cell list interface */
  91
  92         double t_ref;           /* reference temperature */
  93         double t;               /* actual temperature */
  94
  95         double p_ref;           /* reference pressure */
  96         double p;               /* actual pressure */
  97
  98         /* pressure and temperature control (velocity/volume scaling) */
  99         /* (t_tc in units of tau, p_tc in units of tau * isoth. compressib.) */
 100         unsigned char pt_scale; /* type of p and t scaling */
 101         double t_tc;            /* t berendsen control time constant */
 102         double p_tc;            /* p berendsen control time constant */
 103
 104         /* simulation schedule */
 105         t_moldyn_schedule schedule;
 106         int current;            /* current position in schedule */
 107
 108         /* integration function pointer */
 109         int (*integrate)(struct s_moldyn *moldyn);
 110         int time_steps;         /* amount of iterations */
 111         double tau;             /* delta t */
 112         double time;            /* absolute time */
 113         double tau_square;      /* delta t squared */
 114         double elapsed;         /* total elapsed time */
 115
 116         double energy;          /* potential energy */
 117         double ekin;            /* kinetic energy */
 118
 119         char vlsdir[128];       /* visualization/log/save directory */
 120         t_visual vis;           /* visualization interface structure */
 121         u8 vlsprop;             /* log/vis/save properties */
 122         unsigned int ewrite;    /* how often to log energy */
 123         int efd;                /* fd for energy log */
 124         unsigned int mwrite;    /* how often to log momentum */
 125         int mfd;                /* fd for momentum log */
 126         unsigned int vwrite;    /* how often to visualize atom information */
 127         unsigned int swrite;    /* how often to create a save file */
 128
 129         u8 status;              /* general moldyn properties */
 130
 131         t_random random;        /* random interface */
 132
 133         int debug;              /* debugging stuff, ignore */
 134 } t_moldyn;
 135
 136 #define MOLDYN_STAT_PBX                 0x01    /* periodic boudaries in x */
 137 #define MOLDYN_STAT_PBY                 0x02    /* y */
 138 #define MOLDYN_STAT_PBZ                 0x04    /* and z direction */
 139
 140 #define MOLDYN_PSCALE                   0x08    /* size controlled by piston */
 141
 142 #define MOLDYN_1BP                      0x10    /* care about single */
 143 #define MOLDYN_2BP                      0x20    /* 2 body */
 144 #define MOLDYN_3BP                      0x40    /* and 3 body particle pots */
 145
 146 #define T_SCALE_BERENDSEN               0x01    /* berendsen t control */
 147 #define T_SCALE_DIRECT                  0x02    /* direct t control */
 148 #define P_SCALE_BERENDSEN               0x04    /* berendsen p control */
 149 #define P_SCALE_DIRECT                  0x08    /* direct p control */
 150
 151
 152 /*
 153  *
 154  * potential parameter structures
 155  *
 156  */
 157
 158 /*
 159  * harmonic oscillator potential parameter structure
 160  */
 161
 162 typedef struct s_ho_params {
 163         double spring_constant;
 164         double equilibrium_distance;
 165 } t_ho_params;
 166
 167 /*
 168  * lennard jones potential parameter structure
 169  */
 170
 171 typedef struct s_lj_params {
 172         double sigma6;
 173         double sigma12;
 174         double epsilon4;
 175 } t_lj_params;
 176
 177 /*
 178  * tersoff
 179  */
 180
 181 /* tersoff exchange structure to exchange 2bp and 3bp calculated values */
 182 typedef struct s_tersoff_exchange {
 183         double f_c,df_c;
 184         double f_a,df_a;
 185
 186         t_3dvec dist_ij;
 187         double d_ij;
 188
 189         double chi;
 190
 191         double *beta_i;
 192         double *beta_j;
 193         double *n_i;
 194         double *n_j;
 195         double *c_i;
 196         double *c_j;
 197         double *d_i;
 198         double *d_j;
 199         double *h_i;
 200         double *h_j;
 201
 202         double ci2;
 203         double cj2;
 204         double di2;
 205         double dj2;
 206         double ci2di2;
 207         double cj2dj2;
 208         double betaini;
 209         double betajnj;
 210
 211         u8 run3bp;
 212         u8 run2bp_post;
 213         u8 d_ij_between_rs;
 214
 215         double zeta_ij;
 216         double zeta_ji;
 217         t_3dvec dzeta_ij;
 218         t_3dvec dzeta_ji;
 219 } t_tersoff_exchange;
 220
 221 /* tersoff multi (2!) potential parameters */
 222 typedef struct s_tersoff_mult_params {
 223         double S[2];            /* tersoff cutoff radii */
 224         double R[2];            /* tersoff cutoff radii */
 225         double Smixed;          /* mixed S radius */
 226         double Rmixed;          /* mixed R radius */
 227         double A[2];            /* factor of tersoff attractive part */
 228         double B[2];            /* factor of tersoff repulsive part */
 229         double Amixed;          /* mixed A factor */
 230         double Bmixed;          /* mixed B factor */
 231         double lambda[2];       /* tersoff lambda */
 232         double lambda_m;        /* mixed lambda */
 233         double mu[2];           /* tersoff mu */
 234         double mu_m;            /* mixed mu */
 235
 236         double chi;
 237
 238         double beta[2];
 239         double n[2];
 240         double c[2];
 241         double d[2];
 242         double h[2];
 243
 244         t_tersoff_exchange exchange;    /* exchange between 2bp and 3bp calc */
 245 } t_tersoff_mult_params;
 246
 247
 248
 249 /*
 250  *
 251  *  defines
 252  *
 253  */
 254
 255 #define ONE_THIRD       (1.0/3.0)
 256
 257 /*
 258  * default values
 259  *
 260  * - length unit: 1 A (1 A = 1e-10 m)
 261  * - time unit: 1 fs (1 fs = 1e-15 s)
 262  * - mass unit: 1 amu (1 amu = 1.6605388628e-27 kg )
 263  *
 264  * fyi: in the following 1 N = (amu*A)/(fs*fs)
 265  *
 266  */
 267
 268 #define METER                           1e10                    /* A */
 269 #define SECOND                          1e15                    /* fs */
 270 #define AMU                             1.6605388628e-27        /* kg */
 271 #define KILOGRAM                        (1.0/AMU)               /* amu */
 272 #define NEWTON  (METER*KILOGRAM/(SECOND*SECOND))        /* A amu / fs^2 */
 273 #define PASCAL  (NEWTON/(METER*METER))                  /* N / A^2 */
 274 #define ATM     (1.0133e5*PASCAL)                       /* N / A^2 */
 275
 276 #define MOLDYN_TEMP                     273.0
 277 #define MOLDYN_TAU                      1.0
 278 #define MOLDYN_CUTOFF                   10.0
 279 #define MOLDYN_RUNS                     1000000
 280
 281 #define MOLDYN_INTEGRATE_VERLET         0x00
 282 #define MOLDYN_INTEGRATE_DEFAULT        MOLDYN_INTEGRATE_VERLET
 283
 284 #define MOLDYN_POTENTIAL_HO             0x00
 285 #define MOLDYN_POTENTIAL_LJ             0x01
 286 #define MOLDYN_POTENTIAL_TM             0x02
 287
 288 #define LOG_TOTAL_ENERGY                0x01
 289 #define LOG_TOTAL_MOMENTUM              0x02
 290 #define SAVE_STEP                       0x04
 291 #define VISUAL_STEP                     0x08
 292
 293 #define TRUE                            1
 294 #define FALSE                           0
 295
 296 /*
 297  *
 298  * phsical values / constants
 299  *
 300  *
 301  */
 302
 303 #define K_BOLTZMANN             (1.380650524e-23*METER*NEWTON)  /* NA/K */
 304 #define EV                      (1.6021765314e-19*METER*NEWTON) /* NA */
 305
 306 #define C                       0x06
 307 #define M_C                     12.011                          /* amu */
 308
 309 #define SI                      0x0e
 310 #define LC_SI                   (0.543105e-9*METER)             /* A */
 311 #define M_SI                    28.08553                        /* amu */
 312 #define LJ_SIGMA_SI             ((0.25*sqrt(3.0)*LC_SI)/1.122462)       /* A */
 313 #define LJ_EPSILON_SI           (2.1678*EV)                             /* NA */
 314
 315 #define TM_R_SI                 (2.7e-10*METER)                 /* A */
 316 #define TM_S_SI                 (3.0e-10*METER)                 /* A */
 317 #define TM_A_SI                 (1830.8*EV)                     /* NA */
 318 #define TM_B_SI                 (471.18*EV)                     /* NA */
 319 #define TM_LAMBDA_SI            (2.4799e10/METER)               /* 1/A */
 320 #define TM_MU_SI                (1.7322e10/METER)               /* 1/A */
 321 #define TM_BETA_SI              1.1000e-6
 322 #define TM_N_SI                 0.78734
 323 #define TM_C_SI                 1.0039e5
 324 #define TM_D_SI                 16.217
 325 #define TM_H_SI                 -0.59825
 326
 327 #define TM_R_C                  (1.8e-10*METER)                 /* A */
 328 #define TM_S_C                  (2.1e-10*METER)                 /* A */
 329 #define TM_A_C                  (1393.6*EV)                     /* NA */
 330 #define TM_B_C                  (346.7*EV)                      /* NA */
 331 #define TM_LAMBDA_C             (3.4879e10/METER)               /* 1/A */
 332 #define TM_MU_C                 (2.2119e10/METER)               /* 1/A */
 333 #define TM_BETA_C               1.5724e-7
 334 #define TM_N_C                  0.72751
 335 #define TM_C_C                  3.8049e4
 336 #define TM_D_C                  4.384
 337 #define TM_H_C                  -0.57058
 338
 339 #define TM_CHI_SIC              0.9776
 340
 341 /*
 342  * lattice constants
 343  */
 344
 345 #define FCC                     0x01
 346 #define DIAMOND                 0x02
 347
 348
 349 /*
 350  *
 351  * function prototypes
 352  *
 353  */
 354
 355 typedef int (*pf_func1b)(t_moldyn *,t_atom *ai);
 356 typedef int (*pf_func2b)(t_moldyn *,t_atom *,t_atom *,u8 bc);
 357 typedef int (*pf_func2b_post)(t_moldyn *,t_atom *,t_atom *,u8 bc);
 358 typedef int (*pf_func3b)(t_moldyn *,t_atom *,t_atom *,t_atom *,u8 bc);
 359
 360 int moldyn_init(t_moldyn *moldyn,int argc,char **argv);
 361 int moldyn_shutdown(t_moldyn *moldyn);
 362
 363 int set_int_alg(t_moldyn *moldyn,u8 algo);
 364 int set_cutoff(t_moldyn *moldyn,double cutoff);
 365 int set_temperature(t_moldyn *moldyn,double t_ref);
 366 int set_pressure(t_moldyn *moldyn,double p_ref);
 367 int set_pt_scale(t_moldyn *moldyn,u8 ptype,double ptc,u8 ttype,double ttc);
 368 int set_dim(t_moldyn *moldyn,double x,double y,double z,u8 visualize);
 369 int set_nn_dist(t_moldyn *moldyn,double dist);
 370 int set_pbc(t_moldyn *moldyn,u8 x,u8 y,u8 z);
 371 int set_potential1b(t_moldyn *moldyn,pf_func1b func,void *params);
 372 int set_potential2b(t_moldyn *moldyn,pf_func2b func,void *params);
 373 int set_potential2b_post(t_moldyn *moldyn,pf_func2b_post func,void *params);
 374 int set_potential3b(t_moldyn *moldyn,pf_func3b func,void *params);
 375
 376 int moldyn_set_log_dir(t_moldyn *moldyn,char *dir);
 377 int moldyn_set_log(t_moldyn *moldyn,u8 type,int timer);
 378 int moldyn_log_shutdown(t_moldyn *moldyn);
 379
 380 int create_lattice(t_moldyn *moldyn,u8 type,double lc,int element,double mass,
 381                    u8 attr,u8 brand,int a,int b,int c);
 382 int fcc_init(int a,int b,int c,double lc,t_atom *atom,t_3dvec *origin);
 383 int diamond_init(int a,int b,int c,double lc,t_atom *atom,t_3dvec *origin);
 384 int add_atom(t_moldyn *moldyn,int element,double mass,u8 brand,u8 attr,
 385              t_3dvec *r,t_3dvec *v);
 386 int destroy_atoms(t_moldyn *moldyn);
 387
 388 int thermal_init(t_moldyn *moldyn,u8 equi_init);
 389 int scale_velocity(t_moldyn *moldyn,u8 equi_init);
 390 int scale_volume(t_moldyn *moldyn);
 391
 392 double get_e_kin(t_moldyn *moldyn);
 393 double get_e_pot(t_moldyn *moldyn);
 394 double get_total_energy(t_moldyn *moldyn);
 395 t_3dvec get_total_p(t_moldyn *moldyn);
 396
 397 double estimate_time_step(t_moldyn *moldyn,double nn_dist);
 398
 399 int link_cell_init(t_moldyn *moldyn);
 400 int link_cell_update(t_moldyn *moldyn);
 401 int link_cell_neighbour_index(t_moldyn *moldyn,int i,int j,int k,t_list *cell);
 402 int link_cell_shutdown(t_moldyn *moldyn);
 403
 404 int moldyn_add_schedule(t_moldyn *moldyn,int runs,double tau);
 405 int moldyn_set_schedule_hook(t_moldyn *moldyn,void *hook,void *hook_params);
 406
 407 int moldyn_integrate(t_moldyn *moldyn);
 408 int velocity_verlet(t_moldyn *moldyn);
 409
 410 int potential_force_calc(t_moldyn *moldyn);
 411 inline int check_per_bound(t_moldyn *moldyn,t_3dvec *a)
 412         __attribute__((always_inline));
 413 int check_per_bound(t_moldyn *moldyn,t_3dvec *a);
 414 int harmonic_oscillator(t_moldyn *moldyn,t_atom *ai,t_atom *aj,u8 bc);
 415 int lennard_jones(t_moldyn *moldyn,t_atom *ai,t_atom *aj,u8 bc);
 416 int tersoff_mult_complete_params(t_tersoff_mult_params *p);
 417 int tersoff_mult_1bp(t_moldyn *moldyn,t_atom *ai);
 418 int tersoff_mult_2bp(t_moldyn *moldyn,t_atom *ai,t_atom *aj,u8 bc);
 419 int tersoff_mult_post_2bp(t_moldyn *moldyn,t_atom *ai,t_atom *aj,u8 bc);
 420 int tersoff_mult_3bp(t_moldyn *moldyn,t_atom *ai,t_atom *aj,t_atom *ak,u8 bc);
 421
 422 int moldyn_bc_check(t_moldyn *moldyn);
 423
 424 #endif