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