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