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         t_atom *atom;           /* pointer to the atoms */
  81
  82         t_3dvec dim;            /* dimensions of the simulation volume */
  83         double volume;          /* volume of sim cell (dim.x*dim.y*dim.z) */
  84
  85         /* potential force function and parameter pointers */
  86         int (*func1b)(struct s_moldyn *moldyn,t_atom *ai);
  87         int (*func2b)(struct s_moldyn *moldyn,t_atom *ai,t_atom *aj,u8 bc);
  88         int (*func2b_post)(struct s_moldyn *moldyn,t_atom *ai,t_atom *aj,u8 bc);
  89         int (*func3b)(struct s_moldyn *moldyn,t_atom *ai,t_atom *aj,t_atom *ak,
  90                       u8 bck);
  91         void *pot_params;
  92         //int (*potential_force_function)(struct s_moldyn *moldyn);
  93
  94         double cutoff;          /* cutoff radius */
  95         double cutoff_square;   /* square of the cutoff radius */
  96         double nnd;             /* nearest neighbour distance (optional) */
  97
  98         t_linkcell lc;          /* linked cell list interface */
  99
 100         double t_ref;           /* reference temperature */
 101         double t;               /* actual temperature */
 102
 103         double p_ref;           /* reference pressure */
 104         double p;               /* actual pressure (computed by virial) */
 105         t_3dvec tp;             /* thermodynamic pressure dU/dV */
 106         double dv;              /* dV for thermodynamic pressure calc */
 107
 108         /* pressure and temperature control (velocity/volume scaling) */
 109         /* (t_tc in units of tau, p_tc in units of tau * isoth. compressib.) */
 110         unsigned char pt_scale; /* type of p and t scaling */
 111         double t_tc;            /* t berendsen control time constant */
 112         double p_tc;            /* p berendsen control time constant */
 113
 114         /* simulation schedule */
 115         t_moldyn_schedule schedule;
 116         int current;            /* current position in schedule */
 117
 118         /* integration function pointer */
 119         int (*integrate)(struct s_moldyn *moldyn);
 120         int time_steps;         /* amount of iterations */
 121         double tau;             /* delta t */
 122         double time;            /* absolute time */
 123         double tau_square;      /* delta t squared */
 124         double elapsed;         /* total elapsed time */
 125
 126         double energy;          /* potential energy */
 127         double ekin;            /* kinetic energy */
 128
 129         char vlsdir[128];       /* visualization/log/save directory */
 130         t_visual vis;           /* visualization interface structure */
 131         u8 vlsprop;             /* log/vis/save properties */
 132         unsigned int ewrite;    /* how often to log energy */
 133         int efd;                /* fd for energy log */
 134         unsigned int mwrite;    /* how often to log momentum */
 135         int mfd;                /* fd for momentum log */
 136         unsigned int vwrite;    /* how often to visualize atom information */
 137         unsigned int swrite;    /* how often to create a save file */
 138         int rfd;                /* report file descriptor */
 139         char rtitle[64];        /* report title */
 140         char rauthor[64];       /* report author */
 141         int pfd;                /* gnuplot script file descriptor */
 142
 143         u8 status;              /* general moldyn properties */
 144
 145         t_random random;        /* random interface */
 146
 147         double debug;           /* debugging stuff, ignore */
 148 } t_moldyn;
 149
 150 /*
 151  *
 152  *  defines
 153  *
 154  */
 155
 156 #define MOLDYN_STAT_PBX                 0x01    /* periodic boudaries in x */
 157 #define MOLDYN_STAT_PBY                 0x02    /* y */
 158 #define MOLDYN_STAT_PBZ                 0x04    /* and z direction */
 159
 160 #define MOLDYN_PSCALE                   0x08    /* size controlled by piston */
 161
 162 #define MOLDYN_1BP                      0x10    /* care about single */
 163 #define MOLDYN_2BP                      0x20    /* 2 body */
 164 #define MOLDYN_3BP                      0x40    /* and 3 body particle pots */
 165
 166 #define T_SCALE_BERENDSEN               0x01    /* berendsen t control */
 167 #define T_SCALE_DIRECT                  0x02    /* direct t control */
 168 #define P_SCALE_BERENDSEN               0x04    /* berendsen p control */
 169 #define P_SCALE_DIRECT                  0x08    /* direct p control */
 170
 171 /*
 172  * default values
 173  *
 174  * - length unit: 1 A (1 A = 1e-10 m)
 175  * - time unit: 1 fs (1 fs = 1e-15 s)
 176  * - mass unit: 1 amu (1 amu = 1.6605388628e-27 kg )
 177  *
 178  * fyi: in the following 1 N = (amu*A)/(fs*fs)
 179  *
 180  */
 181
 182 #define METER                           1e10                    /* A */
 183 #define SECOND                          1e15                    /* fs */
 184 #define AMU                             1.6605388628e-27        /* kg */
 185 #define KILOGRAM                        (1.0/AMU)               /* amu */
 186 #define NEWTON  (METER*KILOGRAM/(SECOND*SECOND))        /* A amu / fs^2 */
 187 #define PASCAL  (NEWTON/(METER*METER))                  /* N / A^2 */
 188 #define ATM     ((1.0133e5*PASCAL))                     /* N / A^2 */
 189
 190 #define MOLDYN_TEMP                     273.0
 191 #define MOLDYN_TAU                      1.0
 192 #define MOLDYN_CUTOFF                   10.0
 193 #define MOLDYN_RUNS                     1000000
 194
 195 #define MOLDYN_INTEGRATE_VERLET         0x00
 196 #define MOLDYN_INTEGRATE_DEFAULT        MOLDYN_INTEGRATE_VERLET
 197
 198 #define MOLDYN_POTENTIAL_HO             0x00
 199 #define MOLDYN_POTENTIAL_LJ             0x01
 200 #define MOLDYN_POTENTIAL_TM             0x02
 201
 202 #define LOG_TOTAL_ENERGY                0x01
 203 #define LOG_TOTAL_MOMENTUM              0x02
 204 #define SAVE_STEP                       0x04
 205 #define VISUAL_STEP                     0x08
 206 #define CREATE_REPORT                   0x10
 207
 208 #define TRUE                            1
 209 #define FALSE                           0
 210
 211 #define VERBOSE                         1
 212 #define QUIET                           0
 213
 214 /*
 215  *
 216  * phsical values / constants
 217  *
 218  *
 219  */
 220
 221 #define ONE_THIRD               (1.0/3.0)
 222
 223 #define K_BOLTZMANN             (1.380650524e-23*METER*NEWTON)  /* NA/K */
 224 #define EV                      (1.6021765314e-19*METER*NEWTON) /* NA */
 225
 226 #define C                       0x06
 227 #define M_C                     12.011                          /* amu */
 228
 229 #define SI                      0x0e
 230 #define LC_SI                   (0.543105e-9*METER)             /* A */
 231 #define M_SI                    28.08553                        /* amu */
 232
 233 //#define LJ_SIGMA_SI           ((0.25*sqrt(3.0)*LC_SI)/1.122462)       /* A */
 234 //#define LJ_SIGMA_SI           (LC_SI/1.122462)                        /* A */
 235 #define LJ_SIGMA_SI             (0.5*sqrt(2.0)*LC_SI/1.122462)                  /* A */
 236 #define LJ_EPSILON_SI           (2.1678*EV)                             /* NA */
 237
 238 #define TM_R_SI                 (2.7e-10*METER)                 /* A */
 239 #define TM_S_SI                 (3.0e-10*METER)                 /* A */
 240 #define TM_A_SI                 (1830.8*EV)                     /* NA */
 241 #define TM_B_SI                 (471.18*EV)                     /* NA */
 242 #define TM_LAMBDA_SI            (2.4799e10/METER)               /* 1/A */
 243 #define TM_MU_SI                (1.7322e10/METER)               /* 1/A */
 244 #define TM_BETA_SI              1.1000e-6
 245 #define TM_N_SI                 0.78734
 246 #define TM_C_SI                 1.0039e5
 247 #define TM_D_SI                 16.217
 248 #define TM_H_SI                 -0.59825
 249
 250 #define TM_R_C                  (1.8e-10*METER)                 /* A */
 251 #define TM_S_C                  (2.1e-10*METER)                 /* A */
 252 #define TM_A_C                  (1393.6*EV)                     /* NA */
 253 #define TM_B_C                  (346.7*EV)                      /* NA */
 254 #define TM_LAMBDA_C             (3.4879e10/METER)               /* 1/A */
 255 #define TM_MU_C                 (2.2119e10/METER)               /* 1/A */
 256 #define TM_BETA_C               1.5724e-7
 257 #define TM_N_C                  0.72751
 258 #define TM_C_C                  3.8049e4
 259 #define TM_D_C                  4.384
 260 #define TM_H_C                  -0.57058
 261
 262 #define TM_CHI_SIC              0.9776
 263
 264 /*
 265  * lattice constants
 266  */
 267
 268 #define CUBIC                   0x01
 269 #define FCC                     0x02
 270 #define DIAMOND                 0x04
 271
 272
 273 /*
 274  *
 275  * function prototypes
 276  *
 277  */
 278
 279 typedef int (*pf_func1b)(t_moldyn *,t_atom *ai);
 280 typedef int (*pf_func2b)(t_moldyn *,t_atom *,t_atom *,u8 bc);
 281 typedef int (*pf_func2b_post)(t_moldyn *,t_atom *,t_atom *,u8 bc);
 282 typedef int (*pf_func3b)(t_moldyn *,t_atom *,t_atom *,t_atom *,u8 bc);
 283
 284 int moldyn_init(t_moldyn *moldyn,int argc,char **argv);
 285 int moldyn_shutdown(t_moldyn *moldyn);
 286
 287 int set_int_alg(t_moldyn *moldyn,u8 algo);
 288 int set_cutoff(t_moldyn *moldyn,double cutoff);
 289 int set_temperature(t_moldyn *moldyn,double t_ref);
 290 int set_pressure(t_moldyn *moldyn,double p_ref);
 291 int set_pt_scale(t_moldyn *moldyn,u8 ptype,double ptc,u8 ttype,double ttc);
 292 int set_dim(t_moldyn *moldyn,double x,double y,double z,u8 visualize);
 293 int set_nn_dist(t_moldyn *moldyn,double dist);
 294 int set_pbc(t_moldyn *moldyn,u8 x,u8 y,u8 z);
 295 int set_potential1b(t_moldyn *moldyn,pf_func1b func,void *params);
 296 int set_potential2b(t_moldyn *moldyn,pf_func2b func,void *params);
 297 int set_potential2b_post(t_moldyn *moldyn,pf_func2b_post func,void *params);
 298 int set_potential3b(t_moldyn *moldyn,pf_func3b func,void *params);
 299
 300 int moldyn_set_log_dir(t_moldyn *moldyn,char *dir);
 301 int moldyn_set_report(t_moldyn *moldyn,char *author,char *title);
 302 int moldyn_set_log(t_moldyn *moldyn,u8 type,int timer);
 303 int moldyn_log_shutdown(t_moldyn *moldyn);
 304
 305 int create_lattice(t_moldyn *moldyn,u8 type,double lc,int element,double mass,
 306                    u8 attr,u8 brand,int a,int b,int c);
 307 int cubic_init(int a,int b,int c,double lc,t_atom *atom,t_3dvec *origin);
 308 int fcc_init(int a,int b,int c,double lc,t_atom *atom,t_3dvec *origin);
 309 int diamond_init(int a,int b,int c,double lc,t_atom *atom,t_3dvec *origin);
 310 int add_atom(t_moldyn *moldyn,int element,double mass,u8 brand,u8 attr,
 311              t_3dvec *r,t_3dvec *v);
 312 int destroy_atoms(t_moldyn *moldyn);
 313
 314 int thermal_init(t_moldyn *moldyn,u8 equi_init);
 315 double temperature_calc(t_moldyn *moldyn);
 316 double get_temperature(t_moldyn *moldyn);
 317 int scale_velocity(t_moldyn *moldyn,u8 equi_init);
 318 double pressure_calc(t_moldyn *moldyn);
 319 double thermodynamic_pressure_calc(t_moldyn *moldyn);
 320 double get_pressure(t_moldyn *moldyn);
 321 int scale_volume(t_moldyn *moldyn);
 322 int scale_dim(t_moldyn *moldyn,double scale,u8 x,u8 y,u8 z);
 323 int scale_atoms(t_moldyn *moldyn,double scale,u8 x,u8 y,u8 z);
 324
 325 double get_e_kin(t_moldyn *moldyn);
 326 double update_e_kin(t_moldyn *moldyn);
 327 double get_total_energy(t_moldyn *moldyn);
 328 t_3dvec get_total_p(t_moldyn *moldyn);
 329
 330 double estimate_time_step(t_moldyn *moldyn,double nn_dist);
 331
 332 int link_cell_init(t_moldyn *moldyn,u8 vol);
 333 int link_cell_update(t_moldyn *moldyn);
 334 int link_cell_neighbour_index(t_moldyn *moldyn,int i,int j,int k,t_list *cell);
 335 int link_cell_shutdown(t_moldyn *moldyn);
 336
 337 typedef int (*set_hook)(void *,void *);
 338
 339 int moldyn_add_schedule(t_moldyn *moldyn,int runs,double tau);
 340 int moldyn_set_schedule_hook(t_moldyn *moldyn,set_hook hook,void *hook_params);
 341
 342 int moldyn_integrate(t_moldyn *moldyn);
 343 int velocity_verlet(t_moldyn *moldyn);
 344
 345 int potential_force_calc(t_moldyn *moldyn);
 346 int virial_calc(t_atom *a,t_3dvec *f,t_3dvec *d);
 347 //inline int virial_calc(t_atom *a,t_3dvec *f,t_3dvec *d)
 348 //      __attribute__((always_inline));
 349 int check_per_bound(t_moldyn *moldyn,t_3dvec *a);
 350 //inline int check_per_bound(t_moldyn *moldyn,t_3dvec *a)
 351 //      __attribute__((always_inline));
 352
 353 int moldyn_bc_check(t_moldyn *moldyn);
 354
 355 #endif