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  * datatypes
  18  *
  19  */
  20
  21 /* general */
  22 typedef unsigned char u8;
  23
  24 /* virial */
  25 typedef struct s_virial {
  26         double xx;      /*                      | xx     xy     xz |    */
  27         double yy;      /*      V       =       | yx     yy     yz |    */
  28         double zz;      /*                      | zx     zy     zz |    */
  29         double xy;      /*                                              */
  30         double xz;      /*      with:   xy=yx, xz=zx, yz=zy             */
  31         double yz;      /*                                              */
  32 } t_virial;
  33
  34 /* the atom of the md simulation */
  35 typedef struct s_atom {
  36         t_3dvec r_0;            /* initial position */
  37         t_3dvec r;              /* position */
  38         t_3dvec v;              /* velocity */
  39         t_3dvec f;              /* force */
  40         t_virial virial;        /* virial */
  41         double e;               /* site energy */
  42         double ekin;            /* kinetic energy */
  43         int element;            /* number of element in pse */
  44         double mass;            /* atom mass */
  45         u8 brand;               /* brand id */
  46         int tag;                /* atom unique id (number of atom) */
  47         u8 attr;                /* attributes */
  48 } t_atom;
  49
  50 #define ATOM_ATTR_FP    0x01    /* fixed position (bulk material) */
  51 #define ATOM_ATTR_HB    0x02    /* coupled to heat bath (velocity scaling) */
  52
  53 #define ATOM_ATTR_1BP           0x10    /* single paricle potential */
  54 #define ATOM_ATTR_2BP           0x20    /* pair potential */
  55 #define ATOM_ATTR_3BP           0x40    /* 3 body potential */
  56
  57 /* cell lists */
  58 typedef struct s_linkcell {
  59         int nx,ny,nz;           /* amount of cells in x, y and z direction */
  60         int cells;              /* total amount of cells */
  61         double len;             /* prefered cell edge length */
  62         double x,y,z;           /* the actual cell lengthes */
  63         t_list *subcell;        /* pointer to the cell lists */
  64         int dnlc;               /* direct neighbour lists counter */
  65 } t_linkcell;
  66
  67 /* moldyn schedule structure */
  68 typedef struct s_moldyn_schedule {
  69         int count;
  70         int total_sched;
  71         int *runs;
  72         double *tau;
  73         int (*hook)(void *moldyn,void *hook_params);
  74         void *hook_params;
  75 } t_moldyn_schedule;
  76
  77 /* visualization structure */
  78 typedef struct s_visual {
  79         int fd;                 /* rasmol script file descriptor */
  80         char fb[128];           /* basename of the save files */
  81         t_3dvec dim;            /* dimensions of the simulation cell */
  82 } t_visual;
  83
  84 /* moldyn main structure */
  85 typedef struct s_moldyn {
  86         int argc;               /* number of arguments */
  87         char **args;            /* pointer to arguments */
  88
  89         int count;              /* total amount of atoms */
  90         double mass;            /* total system mass */
  91         t_atom *atom;           /* pointer to the atoms */
  92
  93         t_3dvec dim;            /* dimensions of the simulation volume */
  94         double volume;          /* volume of sim cell (dim.x*dim.y*dim.z) */
  95
  96         /* potential force function and parameter pointers */
  97         int (*func1b)(struct s_moldyn *moldyn,t_atom *ai);
  98         int (*func2b)(struct s_moldyn *moldyn,t_atom *ai,t_atom *aj,u8 bc);
  99         int (*func3b_j1)(struct s_moldyn *moldyn,t_atom *ai,t_atom *aj,u8 bc);
 100         int (*func3b_j2)(struct s_moldyn *moldyn,t_atom *ai,t_atom *aj,u8 bc);
 101         int (*func3b_j3)(struct s_moldyn *moldyn,t_atom *ai,t_atom *aj,u8 bc);
 102         int (*func3b_k1)(struct s_moldyn *moldyn,
 103                          t_atom *ai,t_atom *aj,t_atom *ak,u8 bck);
 104         int (*func3b_k2)(struct s_moldyn *moldyn,
 105                          t_atom *ai,t_atom *aj,t_atom *ak,u8 bck);
 106         void *pot_params;
 107         unsigned char run3bp;
 108
 109         double cutoff;          /* cutoff radius */
 110         double cutoff_square;   /* square of the cutoff radius */
 111         double nnd;             /* nearest neighbour distance (optional) */
 112
 113         t_linkcell lc;          /* linked cell list interface */
 114
 115         int avg_skip;           /* amount of steps without average calc */
 116
 117         double t_ref;           /* reference temperature */
 118         double t;               /* actual temperature */
 119         double t_sum;           /* sum over all t */
 120         double t_avg;           /* average value of t */
 121
 122         t_virial gvir;          /* global virial (absolute coordinates) */
 123         double gv;
 124         double gv_sum;
 125         double gv_avg;
 126
 127         double gp;              /* pressure computed from global virial */
 128         double gp_sum;          /* sum over all gp */
 129         double gp_avg;          /* average value of gp */
 130
 131         double virial;          /* actual virial */
 132         double virial_sum;      /* sum over all calculated virials */
 133         double virial_avg;      /* average of virial */
 134
 135         double p_ref;           /* reference pressure */
 136         double p;               /* actual pressure (computed by virial) */
 137         double p_sum;           /* sum over all p */
 138         double p_avg;           /* average value of p */
 139
 140         t_3dvec tp;             /* thermodynamic pressure dU/dV */
 141         double dv;              /* dV for thermodynamic pressure calc */
 142
 143         /* pressure and temperature control (velocity/volume scaling) */
 144         /* (t_tc in units of tau, p_tc in units of tau * isoth. compressib.) */
 145         unsigned char pt_scale; /* type of p and t scaling */
 146         double t_tc;            /* t berendsen control time constant */
 147         double p_tc;            /* p berendsen control time constant */
 148
 149         /* simulation schedule */
 150         t_moldyn_schedule schedule;
 151         int current;            /* current position in schedule */
 152
 153         /* integration function pointer */
 154         int (*integrate)(struct s_moldyn *moldyn);
 155         int time_steps;         /* amount of iterations */
 156         double tau;             /* delta t */
 157         double time;            /* absolute time */
 158         double tau_square;      /* delta t squared */
 159         int total_steps;        /* total steps */
 160
 161         /* energy */
 162         double energy;          /* potential energy */
 163         double ekin;            /* kinetic energy */
 164
 165         /* energy averages & fluctuations */
 166         double k_sum;           /* sum of kinetic energy */
 167         double v_sum;           /* sum of potential energy */
 168         double k_avg;           /* average of kinetic energy */
 169         double v_avg;           /* average of potential energy */
 170         double k2_sum;          /* sum of kinetic energy squared */
 171         double v2_sum;          /* sum of potential energy squared */
 172         double k2_avg;          /* average of kinetic energy squared */
 173         double v2_avg;          /* average of potential energy squared */
 174         double dk2_avg;         /* mean square kinetic energy fluctuations */
 175         double dv2_avg;         /* mean square potential energy fluctuations */
 176
 177         /* response functions */
 178         double c_v_nve;         /* constant volume heat capacity (nve) */
 179         double c_v_nvt;         /* constant volume heat capacity (nvt) */
 180
 181         char vlsdir[128];       /* visualization/log/save directory */
 182         t_visual vis;           /* visualization interface structure */
 183         u8 vlsprop;             /* log/vis/save properties */
 184         unsigned int ewrite;    /* how often to log energy */
 185         int efd;                /* fd for energy log */
 186         unsigned int mwrite;    /* how often to log momentum */
 187         int mfd;                /* fd for momentum log */
 188         unsigned int pwrite;    /* how often to log pressure */
 189         int pfd;                /* fd for pressure log */
 190         unsigned int twrite;    /* how often to log temperature */
 191         int tfd;                /* fd for temperature log */
 192         unsigned int vwrite;    /* how often to visualize atom information */
 193         unsigned int swrite;    /* how often to create a save file */
 194         int rfd;                /* report file descriptor */
 195         char rtitle[64];        /* report title */
 196         char rauthor[64];       /* report author */
 197         int epfd;               /* energy gnuplot script file descriptor */
 198         int ppfd;               /* pressure gnuplot script file descriptor */
 199         int tpfd;               /* temperature gnuplot script file descriptor */
 200
 201         u8 status;              /* general moldyn properties */
 202
 203         t_random random;        /* random interface */
 204
 205         double debug;           /* debugging stuff, ignore */
 206 } t_moldyn;
 207
 208 /*
 209  *
 210  *  defines
 211  *
 212  */
 213
 214 #define MOLDYN_STAT_PBX                 0x01    /* periodic boudaries in x */
 215 #define MOLDYN_STAT_PBY                 0x02    /* y */
 216 #define MOLDYN_STAT_PBZ                 0x04    /* and z direction */
 217
 218 #define MOLDYN_PSCALE                   0x08    /* size controlled by piston */
 219
 220 #define MOLDYN_1BP                      0x10    /* care about single */
 221 #define MOLDYN_2BP                      0x20    /* 2 body */
 222 #define MOLDYN_3BP                      0x40    /* and 3 body particle pots */
 223
 224 #define T_SCALE_BERENDSEN               0x01    /* berendsen t control */
 225 #define T_SCALE_DIRECT                  0x02    /* direct t control */
 226 #define P_SCALE_BERENDSEN               0x04    /* berendsen p control */
 227 #define P_SCALE_DIRECT                  0x08    /* direct p control */
 228
 229 /*
 230  * default values & units
 231  *
 232  * - length unit: 1 A (1 A = 1e-10 m)
 233  * - time unit: 1 fs (1 fs = 1e-15 s)
 234  * - mass unit: 1 amu (1 amu = 1.6605388628e-27 kg )
 235  *
 236  * fyi: in the following 1 N = (amu*A)/(fs*fs)
 237  *
 238  */
 239
 240 #define METER                           1e10                    /* A */
 241 #define SECOND                          1e15                    /* fs */
 242 #define AMU                             1.6605388628e-27        /* kg */
 243 #define KILOGRAM                        (1.0/AMU)               /* amu */
 244 #define NEWTON  (METER*KILOGRAM/(SECOND*SECOND))        /* A amu / fs^2 */
 245 #define PASCAL  (NEWTON/(METER*METER))                  /* N / A^2 */
 246 #define BAR     ((1.0e5*PASCAL))                        /* N / A^2 */
 247 #define K_BOLTZMANN     (1.380650524e-23*METER*NEWTON)  /* NA/K */
 248 #define K_B2            (K_BOLTZMANN*K_BOLTZMANN)       /* (NA)^2/K^2 */
 249 #define EV              (1.6021765314e-19*METER*NEWTON) /* NA */
 250 #define JOULE           (NEWTON*METER)                  /* NA */
 251
 252 #define MOLDYN_TEMP                     273.0
 253 #define MOLDYN_TAU                      1.0
 254 #define MOLDYN_CUTOFF                   10.0
 255 #define MOLDYN_RUNS                     1000000
 256
 257 #define MOLDYN_INTEGRATE_VERLET         0x00
 258 #define MOLDYN_INTEGRATE_DEFAULT        MOLDYN_INTEGRATE_VERLET
 259
 260 #define MOLDYN_POTENTIAL_HO             0x00
 261 #define MOLDYN_POTENTIAL_LJ             0x01
 262 #define MOLDYN_POTENTIAL_TM             0x02
 263
 264 #define LOG_TOTAL_ENERGY                0x01
 265 #define LOG_TOTAL_MOMENTUM              0x02
 266 #define LOG_PRESSURE                    0x04
 267 #define LOG_TEMPERATURE                 0x08
 268 #define SAVE_STEP                       0x10
 269 #define VISUAL_STEP                     0x20
 270 #define CREATE_REPORT                   0x40
 271
 272 #define TRUE                            1
 273 #define FALSE                           0
 274
 275 #define VERBOSE                         1
 276 #define QUIET                           0
 277
 278 #define SCALE_UP                        'u'
 279 #define SCALE_DOWN                      'd'
 280 #define SCALE_DIRECT                    'D'
 281
 282 /*
 283  * potential related phsical values / constants
 284  *
 285  */
 286
 287 #define ONE_THIRD               (1.0/3.0)
 288
 289 #define C                       0x06
 290 #define LC_C                    3.567                           /* A */
 291 #define M_C                     12.011                          /* amu */
 292
 293 #define SI                      0x0e
 294 #define LC_SI                   5.43105                         /* A */
 295 #define M_SI                    28.08553                        /* amu */
 296
 297 #define LC_3C_SIC               4.3596                          /* A */
 298
 299 #define LJ_SIGMA_SI             ((0.25*sqrt(3.0)*LC_SI)/1.122462)       /* A */
 300 //#define LJ_SIGMA_SI           (LC_SI/1.122462)                        /* A */
 301 //#define LJ_SIGMA_SI           (0.5*sqrt(2.0)*LC_SI/1.122462)          /* A */
 302 #define LJ_EPSILON_SI           (2.1678*EV)                             /* NA */
 303
 304 #define TM_R_SI                 2.7                             /* A */
 305 #define TM_S_SI                 3.0                             /* A */
 306 #define TM_A_SI                 (1830.8*EV)                     /* NA */
 307 #define TM_B_SI                 (471.18*EV)                     /* NA */
 308 #define TM_LAMBDA_SI            2.4799                          /* 1/A */
 309 #define TM_MU_SI                1.7322                          /* 1/A */
 310 #define TM_BETA_SI              1.1000e-6
 311 #define TM_N_SI                 0.78734
 312 #define TM_C_SI                 1.0039e5
 313 #define TM_D_SI                 16.217
 314 #define TM_H_SI                 -0.59825
 315
 316 #define TM_R_C                  1.8                             /* A */
 317 #define TM_S_C                  2.1                             /* A */
 318 #define TM_A_C                  (1393.6*EV)                     /* NA */
 319 #define TM_B_C                  (346.7*EV)                      /* NA */
 320 #define TM_LAMBDA_C             3.4879                          /* 1/A */
 321 #define TM_MU_C                 2.2119                          /* 1/A */
 322 #define TM_BETA_C               1.5724e-7
 323 #define TM_N_C                  0.72751
 324 #define TM_C_C                  3.8049e4
 325 #define TM_D_C                  4.384
 326 #define TM_H_C                  -0.57058
 327
 328 #define TM_CHI_SIC              0.9776
 329
 330 #define TM_LC_SIC               4.32                            /* A */
 331
 332 #define ALBE_R_SI               (2.82-0.14)
 333 #define ALBE_S_SI               (2.82+0.14)
 334 #define ALBE_A_SI               (3.24*EV/0.842)
 335 #define ALBE_B_SI               (-1.842*3.24*EV/0.842)
 336 #define ALBE_R0_SI              2.232
 337 #define ALBE_LAMBDA_SI          (1.4761*sqrt(2.0*1.842))
 338 #define ALBE_MU_SI              (1.4761*sqrt(2.0/1.842))
 339 #define ALBE_GAMMA_SI           0.114354
 340 #define ALBE_C_SI               2.00494
 341 #define ALBE_D_SI               0.81472
 342 #define ALBE_H_SI               0.259
 343
 344 #define ALBE_LC_SI              5.429
 345
 346 #define ALBE_R_C                (2.00-0.15)
 347 #define ALBE_S_C                (2.00+0.15)
 348 #define ALBE_A_C                (6.00*EV/1.167)
 349 #define ALBE_B_C                (-2.167*6.00*EV/1.167)
 350 #define ALBE_R0_C               1.4276
 351 #define ALBE_LAMBDA_C           (2.0099*sqrt(2.0*2.167))
 352 #define ALBE_MU_C               (2.0099*sqrt(2.0/2.167))
 353 #define ALBE_GAMMA_C            0.11233
 354 #define ALBE_C_C                181.910
 355 #define ALBE_D_C                6.28433
 356 #define ALBE_H_C                0.5556
 357
 358 #define ALBE_LC_C               3.566
 359
 360 #define ALBE_R_SIC              (2.40-0.20)
 361 #define ALBE_S_SIC              (2.40+0.20)
 362 #define ALBE_A_SIC              (4.36*EV/0.847)
 363 #define ALBE_B_SIC              (-1.847*4.36*EV/0.847)
 364 #define ALBE_R0_SIC             1.79
 365 #define ALBE_LAMBDA_SIC         (1.6991*sqrt(2.0*1.847))
 366 #define ALBE_MU_SIC             (1.6991*sqrt(2.0/1.847))
 367 #define ALBE_GAMMA_SIC          0.011877
 368 #define ALBE_C_SIC              273987
 369 #define ALBE_D_SIC              180.314
 370 #define ALBE_H_SIC              0.68
 371
 372 #define ALBE_LC_SIC             4.359
 373
 374
 375 /*
 376  * lattice types
 377  */
 378
 379 #define CUBIC                   0x01
 380 #define FCC                     0x02
 381 #define DIAMOND                 0x04
 382
 383 /*
 384  *
 385  * function prototypes
 386  *
 387  */
 388
 389 typedef int (*pf_func1b)(t_moldyn *,t_atom *);
 390 typedef int (*pf_func2b)(t_moldyn *,t_atom *,t_atom *,u8);
 391 typedef int (*pf_func3b)(t_moldyn *,t_atom *,t_atom *,t_atom *,u8);
 392
 393 int moldyn_init(t_moldyn *moldyn,int argc,char **argv);
 394 int moldyn_shutdown(t_moldyn *moldyn);
 395
 396 int set_int_alg(t_moldyn *moldyn,u8 algo);
 397 int set_cutoff(t_moldyn *moldyn,double cutoff);
 398 int set_temperature(t_moldyn *moldyn,double t_ref);
 399 int set_pressure(t_moldyn *moldyn,double p_ref);
 400 int set_pt_scale(t_moldyn *moldyn,u8 ptype,double ptc,u8 ttype,double ttc);
 401 int set_dim(t_moldyn *moldyn,double x,double y,double z,u8 visualize);
 402 int set_nn_dist(t_moldyn *moldyn,double dist);
 403 int set_pbc(t_moldyn *moldyn,u8 x,u8 y,u8 z);
 404 int set_potential1b(t_moldyn *moldyn,pf_func1b func);
 405 int set_potential2b(t_moldyn *moldyn,pf_func2b func);
 406 int set_potential3b_j1(t_moldyn *moldyn,pf_func2b func);
 407 int set_potential3b_j2(t_moldyn *moldyn,pf_func2b func);
 408 int set_potential3b_j3(t_moldyn *moldyn,pf_func2b func);
 409 int set_potential3b_k1(t_moldyn *moldyn,pf_func3b func);
 410 int set_potential3b_k2(t_moldyn *moldyn,pf_func3b func);
 411 int set_potential_params(t_moldyn *moldyn,void *params);
 412
 413 int set_avg_skip(t_moldyn *moldyn,int skip);
 414
 415 int moldyn_set_log_dir(t_moldyn *moldyn,char *dir);
 416 int moldyn_set_report(t_moldyn *moldyn,char *author,char *title);
 417 int moldyn_set_log(t_moldyn *moldyn,u8 type,int timer);
 418 int moldyn_log_shutdown(t_moldyn *moldyn);
 419
 420 int create_lattice(t_moldyn *moldyn,u8 type,double lc,int element,double mass,
 421                    u8 attr,u8 brand,int a,int b,int c,t_3dvec *origin);
 422 int add_atom(t_moldyn *moldyn,int element,double mass,u8 brand,u8 attr,
 423              t_3dvec *r,t_3dvec *v);
 424 int del_atom(t_moldyn *moldyn,int tag);
 425 int cubic_init(int a,int b,int c,double lc,t_atom *atom,t_3dvec *origin);
 426 int fcc_init(int a,int b,int c,double lc,t_atom *atom,t_3dvec *origin);
 427 int diamond_init(int a,int b,int c,double lc,t_atom *atom,t_3dvec *origin);
 428 int destroy_atoms(t_moldyn *moldyn);
 429
 430 int thermal_init(t_moldyn *moldyn,u8 equi_init);
 431 double total_mass_calc(t_moldyn *moldyn);
 432 double temperature_calc(t_moldyn *moldyn);
 433 double get_temperature(t_moldyn *moldyn);
 434 int scale_velocity(t_moldyn *moldyn,u8 equi_init);
 435 double virial_sum(t_moldyn *moldyn);
 436 double pressure_calc(t_moldyn *moldyn);
 437 int energy_fluctuation_calc(t_moldyn *moldyn);
 438 int get_heat_capacity(t_moldyn *moldyn);
 439 double thermodynamic_pressure_calc(t_moldyn *moldyn);
 440 double get_pressure(t_moldyn *moldyn);
 441 int scale_volume(t_moldyn *moldyn);
 442 int scale_dim(t_moldyn *moldyn,u8 dir,double scale,u8 x,u8 y,u8 z);
 443 int scale_atoms(t_moldyn *moldyn,u8 dir,double scale,u8 x,u8 y,u8 z);
 444
 445 double e_kin_calc(t_moldyn *moldyn);
 446 double get_total_energy(t_moldyn *moldyn);
 447 t_3dvec get_total_p(t_moldyn *moldyn);
 448
 449 double estimate_time_step(t_moldyn *moldyn,double nn_dist);
 450
 451 int link_cell_init(t_moldyn *moldyn,u8 vol);
 452 int link_cell_update(t_moldyn *moldyn);
 453 int link_cell_neighbour_index(t_moldyn *moldyn,int i,int j,int k,t_list *cell);
 454 int link_cell_shutdown(t_moldyn *moldyn);
 455
 456 typedef int (*set_hook)(void *,void *);
 457
 458 int moldyn_add_schedule(t_moldyn *moldyn,int runs,double tau);
 459 int moldyn_set_schedule_hook(t_moldyn *moldyn,set_hook hook,void *hook_params);
 460
 461 int moldyn_integrate(t_moldyn *moldyn);
 462 int velocity_verlet(t_moldyn *moldyn);
 463
 464 int potential_force_calc(t_moldyn *moldyn);
 465 int virial_calc(t_atom *a,t_3dvec *f,t_3dvec *d);
 466 //inline int virial_calc(t_atom *a,t_3dvec *f,t_3dvec *d)
 467 //      __attribute__((always_inline));
 468 int check_per_bound(t_moldyn *moldyn,t_3dvec *a);
 469 //inline int check_per_bound(t_moldyn *moldyn,t_3dvec *a)
 470 //      __attribute__((always_inline));
 471
 472 int moldyn_bc_check(t_moldyn *moldyn);
 473
 474 int get_line(int fd,char *line,int max);
 475
 476 int visual_init(t_visual *v,char *filebase);
 477 int visual_atoms(t_visual *v,double time,t_atom *atom,int n);
 478
 479 #endif
 480