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"
23 typedef unsigned char u8;
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 */
36 #define ATOM_ATTR_FP 0x01 /* fixed position (bulk material) */
37 #define ATOM_ATTR_HB 0x02 /* coupled to heat bath (velocity scaling) */
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 */
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 int countn; /* amount of neighbours */
54 #include "visual/visual.h"
56 /* moldyn schedule structure */
57 typedef struct s_moldyn_schedule {
61 int (*hook)(void *moldyn,void *hook);
65 /* moldyn main structure */
66 typedef struct s_moldyn {
67 int count; /* total amount of atoms */
68 t_atom *atom; /* pointer to the atoms */
70 t_3dvec dim; /* dimensions of the simulation volume */
72 /* potential force function and parameter pointers */
73 int (*func1b)(struct s_moldyn *moldyn,t_atom *ai);
75 int (*func2b)(struct s_moldyn *moldyn,t_atom *ai,t_atom *aj,u8 bc);
76 void (*func2b_post)(struct s_moldyn *moldyn,t_atom *ai,t_atom *aj,
79 int (*func3b)(struct s_moldyn *moldyn,t_atom *ai,t_atom *aj,t_atom *ak,
82 //int (*potential_force_function)(struct s_moldyn *moldyn);
84 double cutoff; /* cutoff radius */
85 double cutoff_square; /* square of the cutoff radius */
86 double nnd; /* nearest neighbour distance (optional) */
88 t_linkcell lc; /* linked cell list interface */
90 double t_ref; /* reference temperature */
91 double t; /* actual temperature */
93 double p_ref; /* reference pressure */
94 double p; /* actual pressure */
96 /* pressure and temperature control (velocity/volume scaling) */
97 unsigned char pt_scale; /* type of p and t scaling */
98 double t_tc; /* t berendsen control time constant */
99 double p_tc; /* p berendsen control time constant */
101 /* simulation schedule */
102 t_moldyn_schedule schedule;
103 int current; /* current position in schedule */
105 /* integration function pointer */
106 int (*integrate)(struct s_moldyn *moldyn);
107 int time_steps; /* amount of iterations */
108 double tau; /* delta t */
109 double time; /* absolute time */
110 double tau_square; /* delta t squared */
111 double elapsed; /* total elapsed time */
113 double energy; /* potential energy */
114 double ekin; /* kinetic energy */
116 t_visual vis; /* visualization/log/save interface structure */
117 u8 lvstat; /* log & vis properties */
118 unsigned int ewrite; /* how often to log energy */
119 int efd; /* fd for energy log */
120 unsigned int mwrite; /* how often to log momentum */
121 int mfd; /* fd for momentum log */
122 unsigned int vwrite; /* how often to visualize atom information */
123 char vfb[64]; /* visualization file name base */
124 //void *visual; /* pointer (hack!) */
125 unsigned int swrite; /* how often to create a save file */
126 char sfb[64]; /* visualization file name base */
128 u8 status; /* general moldyn properties */
130 t_random random; /* random interface */
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 */
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 */
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 */
149 * potential parameter structures
154 * harmonic oscillator potential parameter structure
157 typedef struct s_ho_params {
158 double spring_constant;
159 double equilibrium_distance;
163 * lennard jones potential parameter structure
166 typedef struct s_lj_params {
176 /* tersoff exchange structure to exchange 2bp and 3bp calculated values */
177 typedef struct s_tersoff_exchange {
204 } t_tersoff_exchange;
206 /* tersoff multi (2!) potential parameters */
207 typedef struct s_tersoff_mult_params {
208 double S[2]; /* tersoff cutoff radii */
209 double R[2]; /* tersoff cutoff radii */
210 double Smixed; /* mixed S radius */
211 double Rmixed; /* mixed R radius */
212 double A[2]; /* factor of tersoff attractive part */
213 double B[2]; /* factor of tersoff repulsive part */
214 double Amixed; /* mixed A factor */
215 double Bmixed; /* mixed B factor */
216 double lambda[2]; /* tersoff lambda */
217 double lambda_m; /* mixed lambda */
218 double mu[2]; /* tersoff mu */
219 double mu_m; /* mixed mu */
229 t_tersoff_exchange exchange; /* exchange between 2bp and 3bp calc */
230 } t_tersoff_mult_params;
242 #define MOLDYN_TEMP 273.0
243 #define MOLDYN_TAU 1.0e-15
244 #define MOLDYN_CUTOFF 1.0e-9
245 #define MOLDYN_RUNS 1000000
247 #define MOLDYN_CRITICAL_EST_TEMP 5.0
249 #define MOLDYN_INTEGRATE_VERLET 0x00
250 #define MOLDYN_INTEGRATE_DEFAULT MOLDYN_INTEGRATE_VERLET
252 #define MOLDYN_POTENTIAL_HO 0x00
253 #define MOLDYN_POTENTIAL_LJ 0x01
254 #define MOLDYN_POTENTIAL_TM 0x02
256 #define LOG_TOTAL_ENERGY 0x01
257 #define LOG_TOTAL_MOMENTUM 0x02
258 #define SAVE_STEP 0x04
259 #define VISUAL_STEP 0x08
266 * phsical values / constants
270 #define K_BOLTZMANN 1.3807e-27 /* Nm/K */
271 #define AMU 1.660540e-27 /* kg */
272 #define EV 1.60217733e-19 /* Nm */
278 #define M_C (12.011*AMU)
281 #define LC_SI 0.543105e-9 /* m */
282 #define M_SI (28.085*AMU) /* kg */
283 #define LJ_SIGMA_SI ((0.25*sqrt(3.0)*LC_SI)/1.122462) /* m */
284 #define LJ_EPSILON_SI (2.1678*1.60e-19) /* Nm */
286 #define TM_R_SI 2.7e-10 /* m */
287 #define TM_S_SI 3.0e-10 /* m */
288 #define TM_A_SI (1830.8*EV) /* Nm */
289 #define TM_B_SI (471.18*EV) /* Nm */
290 #define TM_LAMBDA_SI 2.4799e10 /* 1/m */
291 #define TM_MU_SI 1.7322e10 /* 1/m */
292 #define TM_BETA_SI 1.1000e-6
293 #define TM_N_SI 0.78734
294 #define TM_C_SI 1.0039e5
295 #define TM_D_SI 16.217
296 #define TM_H_SI (-0.59825)
298 #define TM_R_C 1.8e-10 /* m */
299 #define TM_S_C 2.1e-10 /* m */
300 #define TM_A_C (1393.6*EV) /* Nm */
301 #define TM_B_C (346.7*EV) /* Nm */
302 #define TM_LAMBDA_C 3.4879e10 /* 1/m */
303 #define TM_MU_C 2.2119e10 /* 1/m */
304 #define TM_BETA_C 1.5724e-7
305 #define TM_N_C 0.72751
306 #define TM_C_C 3.8049e4
308 #define TM_H_C (-0.57058)
310 #define TM_CHI_SIC 0.9776
315 * function prototypes
319 typedef int (*pf_func1b)(t_moldyn *,t_atom *ai);
320 typedef int (*pf_func2b)(t_moldyn *,t_atom *,t_atom *,u8 bc);
321 typedef int (*pf_func2b_post)(t_moldyn *,t_atom *,t_atom *,u8 bc);
322 typedef int (*pf_func3b)(t_moldyn *,t_atom *,t_atom *,t_atom *,u8 bc);
324 int moldyn_init(t_moldyn *moldyn,int argc,char **argv);
325 int moldyn_shutdown(t_moldyn *moldyn);
327 int set_int_alg(t_moldyn *moldyn,u8 algo);
328 int set_cutoff(t_moldyn *moldyn,double cutoff);
329 int set_temperature(t_moldyn *moldyn,double t_ref);
330 int set_pt_scale(t_moldyn *moldyn,u8 ptype,double ptc,u8 ttype,double ttc);
331 int set_dim(t_moldyn *moldyn,double x,double y,double z,u8 visualize);
332 int set_nn_dist(t_moldyn *moldyn,double dist);
333 int set_pbc(t_moldyn *moldyn,u8 x,u8 y,u8 z);
334 int set_potential1b(t_moldyn *moldyn,pf_func1b func,void *params);
335 int set_potential2b(t_moldyn *moldyn,pf_func2b func,void *params);
336 int set_potential2b_post(t_moldyn *moldyn,pf_func2b_post func,void *params);
337 int set_potential3b(t_moldyn *moldyn,pf_func3b func,void *params);
339 int moldyn_set_log(t_moldyn *moldyn,u8 type,char *fb,int timer);
340 int moldyn_log_shutdown(t_moldyn *moldyn);
342 int create_lattice(t_moldyn *moldyn,u8 type,double lc,int element,double mass,
343 u8 attr,u8 bnum,int a,int b,int c);
344 int add_atom(t_moldyn *moldyn,int element,double mass,u8 bnum,u8 attr,
345 t_3dvec *r,t_3dvec *v);
346 int destroy_atoms(t_moldyn *moldyn);
348 int thermal_init(t_moldyn *moldyn,u8 equi_init);
349 int scale_velocity(t_moldyn *moldyn,u8 equi_init);
351 double get_e_kin(t_moldyn *moldyn);
352 double get_e_pot(t_moldyn *moldyn);
353 double get_total_energy(t_moldyn *moldyn);
354 t_3dvec get_total_p(t_moldyn *moldyn);
356 double estimate_time_step(t_moldyn *moldyn,double nn_dist);
358 int link_cell_init(t_moldyn *moldyn);
359 int link_cell_update(t_moldyn *moldyn);
360 int link_cell_neighbour_index(t_moldyn *moldyn,int i,int j,int k,t_list *cell);
361 int link_cell_shutdown(t_moldyn *moldyn);
363 int moldyn_add_schedule(t_moldyn *moldyn,int runs,double tau);
364 int moldyn_set_schedule_hook(t_moldyn *moldyn,void *hook,void *hook_params);
366 int moldyn_integrate(t_moldyn *moldyn);
367 int velocity_verlet(t_moldyn *moldyn);
369 int potential_force_calc(t_moldyn *moldyn);
370 int check_per_bound(t_moldyn *moldyn,t_3dvec *a);
371 int harmonic_oscillator(t_moldyn *moldyn,t_atom *ai,t_atom *aj,u8 bc);
372 int lennard_jones(t_moldyn *moldyn,t_atom *ai,t_atom *aj,u8 bc);
373 int tersoff_mult_complete_params(t_tersoff_mult_params *p);
374 int tersoff_mult_1bp(t_moldyn *moldyn,t_atom *ai);
375 int tersoff_mult_2bp(t_moldyn *moldyn,t_atom *ai,t_atom *aj,u8 bc);
376 int tersoff_mult_post_2bp(t_moldyn *moldyn,t_atom *ai,t_atom *aj,u8 bc);
377 int tersoff_mult_3bp(t_moldyn *moldyn,t_atom *ai,t_atom *aj,t_atom *ak,u8 bc);