]> hackdaworld.org Git - physik/posic.git/blob - moldyn.h
fixed create_lattice routine
[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  * 
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         int countn;             /* amount of neighbours */
52 } t_linkcell;
53
54 #include "visual/visual.h"
55
56 /* moldyn schedule structure */
57 typedef struct s_moldyn_schedule {
58         int content_count;
59         int *runs;
60         double *tau;
61         int (*hook)(void *moldyn,void *hook);
62         void *hook_params;
63 } t_moldyn_schedule;
64
65 /* moldyn main structure */
66 typedef struct s_moldyn {
67         int count;              /* total amount of atoms */
68         t_atom *atom;           /* pointer to the atoms */
69
70         t_3dvec dim;            /* dimensions of the simulation volume */
71
72         /* potential force function and parameter pointers */
73         int (*func1b)(struct s_moldyn *moldyn,t_atom *ai);
74         void *pot1b_params;
75         int (*func2b)(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
85         t_linkcell lc;          /* linked cell method */
86
87         double t;               /* temperature */
88
89         /* simulation schedule */
90         t_moldyn_schedule schedule;
91         int current;            /* current position in schedule */
92
93         /* integration function pointer */
94         int (*integrate)(struct s_moldyn *moldyn);
95         int time_steps;         /* amount of iterations */
96         double tau;             /* delta t */
97         double time;            /* absolute time */
98         double tau_square;      /* delta t squared */
99         double elapsed;         /* total elapsed time */
100
101         double energy;          /* potential energy */
102         double ekin;            /* kinetic energy */
103
104         t_visual vis;           /* visualization/log/save interface structure */
105         u8 lvstat;              /* log & vis properties */
106         unsigned int ewrite;    /* how often to log energy */
107         int efd;                /* fd for energy log */
108         unsigned int mwrite;    /* how often to log momentum */
109         int mfd;                /* fd for momentum log */
110         unsigned int vwrite;    /* how often to visualize atom information */
111         char vfb[64];           /* visualization file name base */
112         //void *visual;         /* pointer (hack!) */
113         unsigned int swrite;    /* how often to create a save file */
114         char sfb[64];           /* visualization file name base */
115
116         u8 status;              /* general moldyn properties */
117
118         t_random random;        /* random interface */
119 } t_moldyn;
120
121 #define MOLDYN_STAT_PBX                 0x08    /* periodic boudaries in x */
122 #define MOLDYN_STAT_PBY                 0x10    /* y */
123 #define MOLDYN_STAT_PBZ                 0x20    /* and z direction */
124
125 #define MOLDYN_1BP                      0x00
126 #define MOLDYN_2BP                      0x01
127 #define MOLDYN_3BP                      0x02
128
129
130 /*
131  *
132  * potential parameter structures
133  *
134  */
135
136 /*
137  * harmonic oscillator potential parameter structure
138  */
139
140 typedef struct s_ho_params {
141         double spring_constant;
142         double equilibrium_distance;
143 } t_ho_params;
144
145 /*
146  * lennard jones potential parameter structure
147  */
148
149 typedef struct s_lj_params {
150         double sigma6;
151         double sigma12;
152         double epsilon4;
153 } t_lj_params;
154
155 /*
156  * tersoff 
157  */
158
159 /* tersoff exchange structure to exchange 2bp and 3bp calculated values */
160 typedef struct s_tersoff_exchange {
161         double f_c,df_c;
162         double f_a,df_a;
163
164         t_3dvec dist_ij;
165         double d_ij;
166         double d_ij2;
167
168         double chi;
169
170         double *B;
171         double *mu;
172
173         double *beta;
174         double *n;
175         double *c;
176         double *d;
177         double *h;
178
179         double c2;
180         double d2;
181         double c2d2;
182         double betan;
183
184         u8 run3bp;
185 } t_tersoff_exchange;
186
187 /* tersoff multi (2!) potential parameters */
188 typedef struct s_tersoff_mult_params {
189         double S[2];            /* tersoff cutoff radii */
190         double R[2];            /* tersoff cutoff radii */
191         double Smixed;          /* mixed S radius */
192         double Rmixed;          /* mixed R radius */
193         double A[2];            /* factor of tersoff attractive part */
194         double B[2];            /* factor of tersoff repulsive part */
195         double Amixed;          /* mixed A factor */
196         double Bmixed;          /* mixed B factor */
197         double lambda[2];       /* tersoff lambda */
198         double lambda_m;        /* mixed lambda */
199         double mu[2];           /* tersoff mu */
200         double mu_m;            /* mixed mu */
201
202         double chi;
203
204         double beta[2];
205         double n[2];
206         double c[2];
207         double d[2];
208         double h[2];
209
210         t_tersoff_exchange exchange;    /* exchange between 2bp and 3bp calc */
211 } t_tersoff_mult_params;
212
213
214
215 /*
216  *
217  *  defines
218  *
219  */
220
221 /* default values */
222
223 #define MOLDYN_TEMP                     273.0
224 #define MOLDYN_TAU                      1.0e-15
225 #define MOLDYN_CUTOFF                   1.0e-9
226 #define MOLDYN_RUNS                     1000000
227
228 #define MOLDYN_CRITICAL_EST_TEMP        5.0
229
230 #define MOLDYN_INTEGRATE_VERLET         0x00
231 #define MOLDYN_INTEGRATE_DEFAULT        MOLDYN_INTEGRATE_VERLET
232
233 #define MOLDYN_POTENTIAL_HO             0x00
234 #define MOLDYN_POTENTIAL_LJ             0x01
235 #define MOLDYN_POTENTIAL_TM             0x02
236
237 #define LOG_TOTAL_ENERGY                0x01
238 #define LOG_TOTAL_MOMENTUM              0x02
239 #define SAVE_STEP                       0x04
240 #define VISUAL_STEP                     0x08
241
242 #define TRUE                            1
243 #define FALSE                           0
244
245 /*
246  *
247  * phsical values / constants
248  *
249  */
250
251 #define K_BOLTZMANN             1.3807e-27                      /* Nm/K */
252 #define AMU                     1.660540e-27                    /* kg */
253
254 #define FCC                     0x01
255 #define DIAMOND                 0x02
256
257 #define C                       0x06
258 #define M_C                     (12.011*AMU)
259
260 #define SI                      0x0e
261 #define LC_SI                   0.543105e-9                             /* m */
262 #define M_SI                    (28.085*AMU)                            /* kg */
263 #define LJ_SIGMA_SI             ((0.25*sqrt(3.0)*LC_SI)/1.122462)       /* m */
264 #define LJ_EPSILON_SI           (2.1678*1.60e-19)                       /* Nm */
265
266
267 /*
268  *
269  * function prototypes
270  *
271  */
272
273 typedef int (*pf_func1b)(t_moldyn *,t_atom *ai);
274 typedef int (*pf_func2b)(t_moldyn *,t_atom *,t_atom *,u8 bc);
275 typedef int (*pf_func3b)(t_moldyn *,t_atom *,t_atom *,t_atom *,u8 bc);
276
277 int moldyn_init(t_moldyn *moldyn,int argc,char **argv);
278 int moldyn_shutdown(t_moldyn *moldyn);
279
280 int set_int_alg(t_moldyn *moldyn,u8 algo);
281 int set_cutoff(t_moldyn *moldyn,double cutoff);
282 int set_temperature(t_moldyn *moldyn,double t);
283 int set_dim(t_moldyn *moldyn,double x,double y,double z,u8 visualize);
284 int set_pbc(t_moldyn *moldyn,u8 x,u8 y,u8 z);
285 int set_potential1b(t_moldyn *moldyn,pf_func1b func,void *params);
286 int set_potential2b(t_moldyn *moldyn,pf_func2b func,void *params);
287 int set_potential3b(t_moldyn *moldyn,pf_func3b func,void *params);
288
289 int moldyn_set_log(t_moldyn *moldyn,u8 type,char *fb,int timer);
290 int moldyn_log_shutdown(t_moldyn *moldyn);
291
292 int create_lattice(t_moldyn *moldyn,u8 type,double lc,int element,double mass,
293                    u8 attr,u8 bnum,int a,int b,int c);
294 int add_atom(t_moldyn *moldyn,int element,double mass,u8 bnum,u8 attr,
295              t_3dvec *r,t_3dvec *v);
296 int destroy_atoms(t_moldyn *moldyn);
297
298 int thermal_init(t_moldyn *moldyn);
299 int scale_velocity(t_moldyn *moldyn);
300
301 double get_e_kin(t_moldyn *moldyn);
302 double get_e_pot(t_moldyn *moldyn);
303 double get_total_energy(t_moldyn *moldyn);
304 t_3dvec get_total_p(t_moldyn *moldyn);
305
306 double estimate_time_step(t_moldyn *moldyn,double nn_dist);
307
308 int link_cell_init(t_moldyn *moldyn);
309 int link_cell_update(t_moldyn *moldyn);
310 int link_cell_neighbour_index(t_moldyn *moldyn,int i,int j,int k,t_list *cell);
311 int link_cell_shutdown(t_moldyn *moldyn);
312
313 int moldyn_add_schedule(t_moldyn *moldyn,int runs,double tau);
314 int moldyn_set_schedule_hook(t_moldyn *moldyn,void *hook,void *hook_params);
315
316 int moldyn_integrate(t_moldyn *moldyn);
317 int velocity_verlet(t_moldyn *moldyn);
318
319 int potential_force_calc(t_moldyn *moldyn);
320 int check_per_bound(t_moldyn *moldyn,t_3dvec *a);
321 int harmonic_oscillator(t_moldyn *moldyn,t_atom *ai,t_atom *aj,u8 bc);
322 int lennard_jones(t_moldyn *moldyn,t_atom *ai,t_atom *aj,u8 bc);
323 int tersoff_mult_1bp(t_moldyn *moldyn,t_atom *ai);
324 int tersoff_mult_2bp(t_moldyn *moldyn,t_atom *ai,t_atom *aj,u8 bc);
325 int tersoff_mult_3bp(t_moldyn *moldyn,t_atom *ai,t_atom *aj,t_atom *ak,u8 bc);
326
327 #endif