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