Trisurf Monte Carlo simulator
view | history | commit | commitdiff
Samo Penic
2013-11-27 0652ee2715994b48a9bbfd1132bf0b65ad206289
commit | author | age
d7639a 1 #ifndef _GENERAL_H
SP 2 #define _GENERAL_H
3
4 #include<stdarg.h>
7958e9 5 #include<stdio.h>
439a4e 6 #include<pthread.h>
d7639a 7 /* @brief This is a header file, defining general constants and structures.
SP 8   * @file header.h
9   * @author Samo Penic
10   * @date 5.3.2001
11   *
12   * Header file for general inclusion in all the code, defining data structures
13   * and general constans. All datatypes used in the code is also defined here.
14   *
15   */
16
17 /* Defines */
18 /** @brief Return value of type bz_bool that indiceates successful function finish 
19   *
20   * Function usualy return some value, which are the result of certain operation. Functions that don't
21   * return any parameters can return value, that indicates if the function call finished successfully.
22   * In case of successful function run, the functions should return TS_SUCCESS to the caller. This define
23   * is set here to get uniformity among all the functions used in program.
24   *
25   * Example of usage:
26   *        ts_boot somefunction(ts_int param1, ....){
27   *            ...
28   *            return TS_SUCCESS;
29   *        }
30   */
31 #define TS_SUCCESS 0
32
33 /** @brief Return value of type bz_bool that indicates unsuccessful function finish 
34   *
35   * Function usualy return some value, which are the result of certain operation. Functions that don't
36   * return any parameters can return value, that indicates if the function call finished successfully.
37   * In case of unsuccessful function run, the functions should return TS_FAIL to the caller. This define
38   * is set here to get uniformity among all the functions used in program.
39   *
40   * Example of usage:
41   *
42   *        ts_boot somefunction(ts_int param1, ....){
43   *            ...
44   *            return TS_FAIL;
45   *        }
46   */
47 #define TS_FAIL 1
48
49 /* CONSTANTS */
50
51 /* DATA TYPES */
52 /** @brief Sets the default datatype for ts_double
53  *
54  * Requred for some functions to work, like "pow" from math.h. If ts_double is defined as
55  * float program must run with "powf". Where type dependant function is used it checks this
56  * define directive to decide which version to compile in. Available options
57  *
58  *    TS_DOUBLE_FLOAT
59  *    TS_DOUBLE_DOUBLE
60  *    TS_DOUBLE_LONGDOUBLE
61 */
62 #define TS_DOUBLE_DOUBLE
63
64 /** For the purpose of greater flexibility all data types used in the program
65  *  shouldn't use standard C types, but should use types defined here.
66  *    ts_int (uses int)
67  */
68 typedef int ts_int;
69 /** For the purpose of greater flexibility all data types used in the program
70  *  shouldn't use standard C types, but should use types defined here.
71  *    ts_uint (uses unsigned int)
72  */
73 typedef unsigned int ts_uint;
74 /** For the purpose of greater flexibility all data types used in the program
75  *  shouldn't use standard C types, but should use types defined here.
76  *    ts_long (uses long)
77  */
78 typedef long ts_long;
79 /** For the purpose of greater flexibility all data types used in the program
80  *  shouldn't use standard C types, but should use types defined here.
81  *    ts_ulong (uses unsigned long)
82  */
83 typedef unsigned long ts_ulong;
84 /** For the purpose of greater flexibility all data types used in the program
85  *  shouldn't use standard C types, but should use types defined here.
86  *    ts_float (uses float)
87  */
88 typedef float ts_float;
89 /** For the purpose of greater flexibility all data types used in the program
90  *  shouldn't use standard C types, but should use types defined here.
91  *    ts_double (uses double)
92  */
93 typedef double ts_double;
94 /** For the purpose of greater flexibility all data types used in the program
95  *  shouldn't use standard C types, but should use types defined here.
96  *    ts_char (uses char)
97  */
98 typedef char ts_char;
99 /** For the purpose of greater flexibility all data types used in the program
100  *  shouldn't use standard C types, but should use types defined here.
101  *    ts_uchar (uses unsigned char)
102  */
103 typedef unsigned char ts_uchar;
104 /** For the purpose of greater flexibility all data types used in the program
105  *  shouldn't use standard C types, but should use types defined here.
106  *    ts_bool (uses char)
107  */
108 typedef char ts_bool;
109
110
111 /* STRUCTURES */
112
523bf1 113
SP 114 /** @brief Data structure for keeping the coordinates in selected coordinate
115  * system
116  */
117 #define TS_COORD_CARTESIAN 0
118 #define TS_COORD_SPHERICAL 1
119 #define TS_COORD_CYLINDRICAL 2
120
121 typedef struct {
122     ts_double e1;
123     ts_double e2;
124     ts_double e3;
125     ts_uint coord_type;
126 } ts_coord;
127
128
129
d7639a 130 /** @brief Data structure of all data connected to a vertex
SP 131  *
8f6a69 132  *  ts_vertex holds the data for one single point (bead, vertex). To understand how to use it
d7639a 133  *  here is a detailed description of the fields in the data structure. */
8f6a69 134 struct ts_vertex {
SP 135         ts_uint idx;
a10dd5 136         ts_double x; /**< The x coordinate of vertex. */
d7639a 137         ts_double y; /**< The y coordinate of vertex. */
SP 138         ts_double z; /**< The z coordinate of vertex. */
139         ts_uint neigh_no; /**< The number of neighbours. */
a10dd5 140         struct ts_vertex **neigh; /**< The pointer that holds neigh_no pointers to this structure. */
SP 141         ts_double *bond_length; /**< Obsolete! The bond lenght is moved to ts_bond */
142         ts_double *bond_length_dual; /**< Obsolete! Bond length in dual lattice is moved to ts_bond! */
d7639a 143         ts_double curvature;
SP 144         ts_double energy;
145         ts_double energy_h;
146         ts_uint tristar_no;
a10dd5 147         struct ts_triangle **tristar; /**< The list of triangles this vertex belongs to. This is an array of pointers to ts_triangle structure of tristar_no length */
SP 148         ts_uint bond_no;
149         struct ts_bond **bond; /**< Array of pointers of lenght bond_no that stores information on bonds. */
150         struct ts_cell *cell; /**< Which cell do we belong to? */
d7639a 151         ts_double xk;
SP 152         ts_double c;
153         ts_uint id;
523bf1 154         ts_double projArea;
SP 155         ts_double relR;
156         ts_double solAngle;
c85b51 157     ts_uint *locked;
737714 158 };
d7639a 159 typedef struct ts_vertex ts_vertex;
SP 160
73f967 161 typedef struct {
SP 162     ts_uint n;
a10dd5 163     ts_vertex **vtx;
73f967 164
SP 165 } ts_vertex_list;
166
e016c4 167 struct ts_bond {
SP 168     ts_uint idx;
d7639a 169     ts_vertex *vtx1;
SP 170     ts_vertex *vtx2;
171     ts_double bond_length;
172     ts_double bond_length_dual;
a63f17 173     ts_bool tainted;
a10dd5 174 };
SP 175 typedef struct ts_bond ts_bond;
176
177 struct ts_bond_list {
178     ts_uint n;
179     ts_bond **bond;
180 };
181 typedef struct ts_bond_list ts_bond_list;
182
41a035 183 struct ts_triangle {
SP 184     ts_uint idx;
d7639a 185     ts_vertex *vertex[3];
SP 186     ts_uint neigh_no;
187     struct ts_triangle **neigh;
188     ts_double xnorm;
189     ts_double ynorm;
190     ts_double znorm;
523bf1 191     ts_double area; // firstly needed for sh.c
c9d07c 192     ts_double volume; // firstly needed for sh.c
a10dd5 193 };
d7639a 194 typedef struct ts_triangle ts_triangle;
a10dd5 195
SP 196 struct ts_triangle_list{
197     ts_uint n;
198     ts_triangle **tria;
199 };
a2a676 200 typedef struct ts_triangle_list ts_triangle_list;
d7639a 201
SP 202
bb77ca 203 typedef struct ts_cell {
SP 204     ts_uint idx;
34d3de 205     ts_vertex **vertex;
SP 206     ts_uint nvertex;
bb77ca 207 } ts_cell; 
SP 208
209 typedef struct ts_cell_list{
210     ts_uint ncmax[3];
211     ts_uint cellno;
212     ts_cell **cell;
d7639a 213     ts_double dcell;
SP 214     ts_double shift;
215     ts_double max_occupancy;
bb77ca 216 } ts_cell_list;
SP 217
218
219 typedef struct {
523bf1 220     ts_uint l;
SP 221     ts_double **ulm;
262607 222     ts_double **sumUlm2;
SP 223     ts_uint N;
621830 224     ts_double **co;
eb8605 225     ts_double ***Ylmi;
523bf1 226 } ts_spharm;
SP 227
228
439a4e 229 typedef struct {
SP 230     pthread_mutex_t vtx_taint;
231     pthread_mutex_t vtx_untaint;
232     pthread_mutex_t cell_modify;
233 } ts_mutex;
523bf1 234
SP 235 typedef struct {
bb77ca 236     ts_vertex_list *vlist;
SP 237     ts_bond_list *blist;
238     ts_triangle_list *tlist;
239     ts_cell_list *clist;
240     ts_uint nshell;
d7639a 241     ts_double bending_rigidity;
SP 242     ts_double dmax;
243     ts_double stepsize;
244     ts_double cm[3];
523bf1 245     ts_double volume;
SP 246     ts_spharm *sphHarmonics;
50f10f 247     ts_uint threads;
439a4e 248     ts_mutex *mutex;
d7639a 249 } ts_vesicle;
SP 250
251
523bf1 252
SP 253
d7639a 254 /* GLOBAL VARIABLES */
SP 255
256 int quiet;
257
258
259 /* FUNCTIONS */
260
261 /** Non-fatal error function handler:
262  *      @param text is a description of an error
263  *      @returns doesn't return anything
264 */
265 void err(char *text);
266
267 /** Fatal error function handler:
268  *      @param text is a description of an error
269  *      @param errcode is a (non-zero) error code
270  *      @returns terminates the execution of program with errcode set
271 */
272 void fatal(char *text, ts_int errcode);
273
7958e9 274 ts_uint ts_fprintf(FILE *fd, char *fmt, ...);
d7639a 275
737714 276 #define VTX(n) &(vlist->vtx[n])
SP 277 #define VTX_DATA(n) vlist->vtx[n].data
73f967 278
d7639a 279 #endif