2 * moldyn.h - molecular dynamics library header file
4 * author: Frank Zirkelbach <frank.zirkelbach@physik.uni-augsburg.de>
11 #include "math/math.h"
12 #include "random/random.h"
13 #include "list/list.h"
22 typedef unsigned char u8;
25 typedef struct s_virial {
26 double xx; /* | xx xy xz | */
27 double yy; /* V = | yx yy yz | */
28 double zz; /* | zx zy zz | */
30 double xz; /* with: xy=yx, xz=zx, yz=zy */
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 */
50 #define ATOM_ATTR_FP 0x01 /* fixed position (bulk material) */
51 #define ATOM_ATTR_HB 0x02 /* coupled to heat bath (velocity scaling) */
52 #define ATOM_ATTR_VA 0x04 /* visualize this atom */ // TODO
53 #define ATOM_ATTR_VB 0x08 /* visualize the bond of this atom */
55 #define ATOM_ATTR_1BP 0x10 /* single paricle potential */
56 #define ATOM_ATTR_2BP 0x20 /* pair potential */
57 #define ATOM_ATTR_3BP 0x40 /* 3 body potential */
59 #define DEFAULT_ATOM_ATTR 0x74 // 1,2,3 body interaction + visualize
61 /* special list structure for low mem approach */
62 typedef struct s_lowmem_list {
68 typedef struct s_linkcell {
69 int nx,ny,nz; /* amount of cells in x, y and z direction */
70 int cells; /* total amount of cells */
71 double len; /* prefered cell edge length */
72 double x,y,z; /* the actual cell lengthes */
74 int **subcell; /* pointer to the cell lists */
76 t_lowmem_list *subcell; /* low mem approach list */
78 t_list *subcell; /* pointer to the cell lists */
80 int dnlc; /* direct neighbour lists counter */
83 #define MAX_ATOMS_PER_LIST 20
85 /* moldyn schedule structure */
86 typedef struct s_moldyn_schedule {
91 int (*hook)(void *moldyn,void *hook_params);
95 /* visualization structure */
96 typedef struct s_visual {
97 int fd; /* rasmol script file descriptor */
98 char fb[128]; /* basename of the save files */
99 t_3dvec dim; /* dimensions of the simulation cell */
102 /* moldyn main structure */
103 typedef struct s_moldyn {
104 int argc; /* number of arguments */
105 char **args; /* pointer to arguments */
107 int count; /* total amount of atoms */
108 double mass; /* total system mass */
109 t_atom *atom; /* pointer to the atoms */
111 t_3dvec dim; /* dimensions of the simulation volume */
112 double volume; /* volume of sim cell (dim.x*dim.y*dim.z) */
114 /* potential force function and parameter pointers */
115 int (*func1b)(struct s_moldyn *moldyn,t_atom *ai);
116 int (*func2b)(struct s_moldyn *moldyn,t_atom *ai,t_atom *aj,u8 bc);
117 int (*func3b_j1)(struct s_moldyn *moldyn,t_atom *ai,t_atom *aj,u8 bc);
118 int (*func3b_j2)(struct s_moldyn *moldyn,t_atom *ai,t_atom *aj,u8 bc);
119 int (*func3b_j3)(struct s_moldyn *moldyn,t_atom *ai,t_atom *aj,u8 bc);
121 void *(*func3b_k1)(void *ptr);
123 int (*func3b_k1)(struct s_moldyn *moldyn,
124 t_atom *ai,t_atom *aj,t_atom *ak,u8 bck);
126 int (*func3b_k2)(struct s_moldyn *moldyn,
127 t_atom *ai,t_atom *aj,t_atom *ak,u8 bck);
129 unsigned char run3bp;
131 double cutoff; /* cutoff radius */
132 double cutoff_square; /* square of the cutoff radius */
133 double nnd; /* nearest neighbour distance (optional) */
135 t_linkcell lc; /* linked cell list interface */
137 int avg_skip; /* amount of steps without average calc */
139 double t_ref; /* reference temperature */
140 double t; /* actual temperature */
141 double t_sum; /* sum over all t */
142 double t_avg; /* average value of t */
144 t_virial gvir; /* global virial (absolute coordinates) */
149 double gp; /* pressure computed from global virial */
150 double gp_sum; /* sum over all gp */
151 double gp_avg; /* average value of gp */
153 t_virial vir; /* actual virial */
155 double virial_sum; /* sum over all calculated virials */
156 double virial_avg; /* average of virial */
158 double p_ref; /* reference pressure */
159 double p; /* actual pressure (computed by virial) */
160 double px,py,pz; /* components of pressure */
161 double p_sum; /* sum over all p */
162 double p_avg; /* average value of p */
164 double tp; /* thermodynamic pressure dU/dV */
165 double tp_sum; /* sum over dU/dV pressure */
166 double tp_avg; /* average value of dU/dV pressure */
167 int tp_cnt; /* how often to do thermodynamic p calc */
169 /* pressure and temperature control (velocity/volume scaling) */
170 /* (t_tc in units of tau, p_tc in units of tau * isoth. compressib.) */
171 unsigned char pt_scale; /* type of p and t scaling */
172 double t_tc; /* t berendsen control time constant */
173 double p_tc; /* p berendsen control time constant */
175 /* simulation schedule */
176 t_moldyn_schedule schedule;
177 int current; /* current position in schedule */
179 /* integration function pointer */
180 int (*integrate)(struct s_moldyn *moldyn);
181 int time_steps; /* amount of iterations */
182 double tau; /* delta t */
183 double time; /* absolute time */
184 double tau_square; /* delta t squared */
185 int total_steps; /* total steps */
188 double energy; /* potential energy */
189 double ekin; /* kinetic energy */
191 /* energy averages & fluctuations */
192 double k_sum; /* sum of kinetic energy */
193 double v_sum; /* sum of potential energy */
194 double k_avg; /* average of kinetic energy */
195 double v_avg; /* average of potential energy */
196 double k2_sum; /* sum of kinetic energy squared */
197 double v2_sum; /* sum of potential energy squared */
198 double k2_avg; /* average of kinetic energy squared */
199 double v2_avg; /* average of potential energy squared */
200 double dk2_avg; /* mean square kinetic energy fluctuations */
201 double dv2_avg; /* mean square potential energy fluctuations */
203 /* response functions */
204 double c_v_nve; /* constant volume heat capacity (nve) */
205 double c_v_nvt; /* constant volume heat capacity (nvt) */
207 char vlsdir[128]; /* visualization/log/save directory */
208 t_visual vis; /* visualization interface structure */
209 u8 vlsprop; /* log/vis/save properties */
210 unsigned int ewrite; /* how often to log energy */
211 int efd; /* fd for energy log */
212 unsigned int mwrite; /* how often to log momentum */
213 int mfd; /* fd for momentum log */
214 unsigned int pwrite; /* how often to log pressure */
215 int pfd; /* fd for pressure log */
216 unsigned int twrite; /* how often to log temperature */
217 int tfd; /* fd for temperature log */
218 unsigned int vwrite; /* how often to log volume */
219 int vfd; /* fd for volume log */
220 unsigned int awrite; /* how often to visualize atom information */
221 unsigned int swrite; /* how often to create a save file */
222 int rfd; /* report file descriptor */
223 char rtitle[64]; /* report title */
224 char rauthor[64]; /* report author */
225 int epfd; /* energy gnuplot script file descriptor */
226 int ppfd; /* pressure gnuplot script file descriptor */
227 int tpfd; /* temperature gnuplot script file descriptor */
229 u8 status; /* general moldyn properties */
231 t_random random; /* random interface */
233 double debug; /* debugging stuff, ignore */
235 /* potential 2 body check function */
236 int (*check_2b_bond)(struct s_moldyn *moldyn,
237 t_atom *itom,t_atom *jtom,u8 bc);
240 typedef struct s_pcc {
247 typedef struct s_ba {
253 typedef struct s_vb {
263 #define MOLDYN_STAT_PBX 0x01 /* periodic boudaries in x */
264 #define MOLDYN_STAT_PBY 0x02 /* y */
265 #define MOLDYN_STAT_PBZ 0x04 /* and z direction */
267 #define MOLDYN_PSCALE 0x08 /* size controlled by piston */
269 #define MOLDYN_1BP 0x10 /* care about single */
270 #define MOLDYN_2BP 0x20 /* 2 body */
271 #define MOLDYN_3BP 0x40 /* and 3 body particle pots */
273 #define T_SCALE_NONE 0x00
274 #define T_SCALE_BERENDSEN 0x01 /* berendsen t control */
275 #define T_SCALE_DIRECT 0x02 /* direct t control */
276 #define T_SCALE_MASK 0x03
278 #define P_SCALE_NONE 0x00
279 #define P_SCALE_BERENDSEN 0x04 /* berendsen p control */
280 #define P_SCALE_DIRECT 0x08 /* direct p control */
281 #define P_SCALE_MASK 0x0c
284 * default values & units
286 * - length unit: 1 A (1 A = 1e-10 m)
287 * - time unit: 1 fs (1 fs = 1e-15 s)
288 * - mass unit: 1 amu (1 amu = 1.6605388628e-27 kg )
290 * fyi: in the following 1 N = (amu*A)/(fs*fs)
294 #define METER 1e10 /* A */
295 #define SECOND 1e15 /* fs */
296 #define AMU 1.6605388628e-27 /* kg */
297 #define KILOGRAM (1.0/AMU) /* amu */
298 #define NEWTON (METER*KILOGRAM/(SECOND*SECOND)) /* A amu / fs^2 */
299 #define PASCAL (NEWTON/(METER*METER)) /* N / A^2 */
300 #define GPA (1e9*PASCAL) /* N / A^2 */
301 #define BAR ((1.0e5*PASCAL)) /* N / A^2 */
302 #define K_BOLTZMANN (1.380650524e-23*METER*NEWTON) /* NA/K */
303 #define K_B2 (K_BOLTZMANN*K_BOLTZMANN) /* (NA)^2/K^2 */
304 #define EV (1.6021765314e-19*METER*NEWTON) /* NA */
305 #define JOULE (NEWTON*METER) /* NA */
307 #define MOLDYN_TEMP 273.0
308 #define MOLDYN_TAU 1.0
309 #define MOLDYN_CUTOFF 10.0
310 #define MOLDYN_RUNS 1000000
312 #define MOLDYN_INTEGRATE_VERLET 0x00
313 #define MOLDYN_INTEGRATE_DEFAULT MOLDYN_INTEGRATE_VERLET
315 #define MOLDYN_POTENTIAL_HO 0x00
316 #define MOLDYN_POTENTIAL_LJ 0x01
317 #define MOLDYN_POTENTIAL_TM 0x02
318 #define MOLDYN_POTENTIAL_AM 0x03
320 #define LOG_TOTAL_ENERGY 0x01
321 #define LOG_TOTAL_MOMENTUM 0x02
322 #define LOG_PRESSURE 0x04
323 #define LOG_TEMPERATURE 0x08
324 #define LOG_VOLUME 0x10
325 #define SAVE_STEP 0x20
326 #define VISUAL_STEP 0x40
327 #define CREATE_REPORT 0x80
336 #define SCALE_DOWN 'd'
337 #define SCALE_DIRECT 'D'
343 #define ONE_THIRD (1.0/3.0)
346 * element specific defines
350 #define LC_C 3.567 /* A */
351 #define M_C 12.011 /* amu */
354 #define LC_SI 5.43105 /* A */
355 #define M_SI 28.08553 /* amu */
357 #define LC_3C_SIC 4.3596 /* A */
366 #define ZINCBLENDE 0x08
377 * function prototypes
381 int moldyn_init(t_moldyn *moldyn,int argc,char **argv);
382 int moldyn_shutdown(t_moldyn *moldyn);
384 int set_int_alg(t_moldyn *moldyn,u8 algo);
385 int set_cutoff(t_moldyn *moldyn,double cutoff);
386 int set_temperature(t_moldyn *moldyn,double t_ref);
387 int set_pressure(t_moldyn *moldyn,double p_ref);
388 int set_p_scale(t_moldyn *moldyn,u8 ptype,double ptc);
389 int set_t_scale(t_moldyn *moldyn,u8 ttype,double ttc);
390 int set_pt_scale(t_moldyn *moldyn,u8 ptype,double ptc,u8 ttype,double ttc);
391 int set_dim(t_moldyn *moldyn,double x,double y,double z,u8 visualize);
392 int set_nn_dist(t_moldyn *moldyn,double dist);
393 int set_pbc(t_moldyn *moldyn,u8 x,u8 y,u8 z);
394 int set_potential(t_moldyn *moldyn,u8 type);
396 int set_avg_skip(t_moldyn *moldyn,int skip);
398 int moldyn_set_log_dir(t_moldyn *moldyn,char *dir);
399 int moldyn_set_report(t_moldyn *moldyn,char *author,char *title);
400 int moldyn_set_log(t_moldyn *moldyn,u8 type,int timer);
401 int moldyn_log_shutdown(t_moldyn *moldyn);
403 int create_lattice(t_moldyn *moldyn,u8 type,double lc,int element,double mass,
404 u8 attr,u8 brand,int a,int b,int c,t_3dvec *origin);
405 int add_atom(t_moldyn *moldyn,int element,double mass,u8 brand,u8 attr,
406 t_3dvec *r,t_3dvec *v);
407 int del_atom(t_moldyn *moldyn,int tag);
408 int cubic_init(int a,int b,int c,double lc,t_atom *atom,t_3dvec *origin);
409 int fcc_init(int a,int b,int c,double lc,t_atom *atom,t_3dvec *origin);
410 int diamond_init(int a,int b,int c,double lc,t_atom *atom,t_3dvec *origin);
411 int destroy_atoms(t_moldyn *moldyn);
413 int thermal_init(t_moldyn *moldyn,u8 equi_init);
414 double total_mass_calc(t_moldyn *moldyn);
415 double temperature_calc(t_moldyn *moldyn);
416 double get_temperature(t_moldyn *moldyn);
417 int scale_velocity(t_moldyn *moldyn,u8 equi_init);
418 double virial_sum(t_moldyn *moldyn);
419 double pressure_calc(t_moldyn *moldyn);
420 int average_reset(t_moldyn *moldyn);
421 int average_and_fluctuation_calc(t_moldyn *moldyn);
422 int get_heat_capacity(t_moldyn *moldyn);
423 double thermodynamic_pressure_calc(t_moldyn *moldyn);
424 double get_pressure(t_moldyn *moldyn);
425 int scale_volume(t_moldyn *moldyn);
426 int scale_dim(t_moldyn *moldyn,u8 dir,double scale,u8 x,u8 y,u8 z);
427 int scale_atoms(t_moldyn *moldyn,u8 dir,double scale,u8 x,u8 y,u8 z);
429 double e_kin_calc(t_moldyn *moldyn);
430 double get_total_energy(t_moldyn *moldyn);
431 t_3dvec get_total_p(t_moldyn *moldyn);
433 double estimate_time_step(t_moldyn *moldyn,double nn_dist);
435 int link_cell_init(t_moldyn *moldyn,u8 vol);
436 int link_cell_update(t_moldyn *moldyn);
438 int link_cell_neighbour_index(t_moldyn *moldyn,int i,int j,int k,int **cell);
440 int link_cell_neighbour_index(t_moldyn *moldyn,int i,int j,int k,int *cell);
442 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);
446 typedef int (*set_hook)(void *,void *);
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);
451 int moldyn_integrate(t_moldyn *moldyn);
452 int velocity_verlet(t_moldyn *moldyn);
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));
462 int moldyn_bc_check(t_moldyn *moldyn);
464 int moldyn_read_save_file(t_moldyn *moldyn,char *file);
465 int moldyn_free_save_file(t_moldyn *moldyn);
466 int moldyn_load(t_moldyn *moldyn);
467 int process_2b_bonds(t_moldyn *moldyn,void *data,
468 int (*process)(t_moldyn *moldyn,t_atom *itom,t_atom *jtom,
470 int process_neighbours(t_moldyn *moldyn,void *data,t_atom *atom,
471 int (*process)(t_moldyn *moldyn,t_atom *atom,t_atom *natom,
474 int get_line(int fd,char *line,int max);
476 int pair_correlation_init(t_moldyn *moldyn,double dr);
477 int calculate_diffusion_coefficient(t_moldyn *moldyn,double *dc);
478 int calculate_pair_correlation_process(t_moldyn *moldyn,t_atom *itom,
479 t_atom *jtom,void *data,u8 bc);
480 int calculate_pair_correlation(t_moldyn *moldyn,double dr,void *ptr);
481 int bond_analyze_process(t_moldyn *moldyn,t_atom *itom,t_atom *jtom,
483 int bond_analyze(t_moldyn *moldyn,double *quality);
485 int visual_init(t_moldyn *moldyn,char *filebase);
486 int visual_bonds_process(t_moldyn *moldyn,t_atom *itom,t_atom *jtom,
489 void *visual_atoms(void *ptr);
491 int visual_atoms(t_moldyn *moldyn);
494 int fpu_set_rtd(void);