Trisurf Monte Carlo simulator
view | history | commit | commitdiff
Samo Penic
2010-12-28 dac2e5020dc34c236b741ff5c4591244e73f56f2
commit | author | age
d7639a 1 #ifndef _GENERAL_H
SP 2 #define _GENERAL_H
3
4 #include<stdarg.h>
7958e9 5 #include<stdio.h>
d7639a 6
SP 7 /* @brief This is a header file, defining general constants and structures.
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
113 /** @brief Data structure of all data connected to a vertex
114  *
a10dd5 115  *  ts_vertex_data holds the data for one single point (bead, vertex). To understand how to use it
d7639a 116  *  here is a detailed description of the fields in the data structure. */
737714 117 struct ts_vertex_data {
a10dd5 118         ts_uint idx; /**< Represents index of the vertex point. Should become obsolete, since it is also present in ts_vertex structure. */        
SP 119         ts_double x; /**< The x coordinate of vertex. */
d7639a 120         ts_double y; /**< The y coordinate of vertex. */
SP 121         ts_double z; /**< The z coordinate of vertex. */
122         ts_uint neigh_no; /**< The number of neighbours. */
a10dd5 123         struct ts_vertex **neigh; /**< The pointer that holds neigh_no pointers to this structure. */
SP 124         ts_double *bond_length; /**< Obsolete! The bond lenght is moved to ts_bond */
125         ts_double *bond_length_dual; /**< Obsolete! Bond length in dual lattice is moved to ts_bond! */
d7639a 126         ts_double curvature;
SP 127         ts_double energy;
128         ts_double energy_h;
129         ts_uint tristar_no;
a10dd5 130         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 131         ts_uint bond_no;
132         struct ts_bond **bond; /**< Array of pointers of lenght bond_no that stores information on bonds. */
133         struct ts_cell *cell; /**< Which cell do we belong to? */
d7639a 134         ts_double xk;
SP 135         ts_double c;
136         ts_uint id;
137 };
737714 138 typedef struct ts_vertex_data ts_vertex_data;
SP 139
140 struct ts_vertex {
141         ts_uint idx;
142         ts_vertex_data *data;
143 };
d7639a 144 typedef struct ts_vertex ts_vertex;
SP 145
73f967 146 typedef struct {
SP 147     ts_uint n;
a10dd5 148     ts_vertex **vtx;
73f967 149
SP 150 } ts_vertex_list;
151
152
a10dd5 153 /** ts_bond_data is a structure that describes a bond */
d7639a 154 typedef struct {
SP 155     ts_vertex *vtx1;
156     ts_vertex *vtx2;
157     ts_double bond_length;
158     ts_double bond_length_dual;
a10dd5 159 } ts_bond_data;
d7639a 160
a10dd5 161 struct ts_bond {
SP 162     ts_uint idx;
163     ts_bond_data *data;
164 };
165 typedef struct ts_bond ts_bond;
166
167 struct ts_bond_list {
168     ts_uint n;
169     ts_bond **bond;
170 };
171 typedef struct ts_bond_list ts_bond_list;
172
173 /** ts_triangle_data is a structure that describes a triangle */
174 struct ts_triangle_data {
d7639a 175     ts_uint idx;
SP 176     ts_vertex *vertex[3];
177     ts_uint neigh_no;
178     struct ts_triangle **neigh;
179     ts_double xnorm;
180     ts_double ynorm;
181     ts_double znorm;
182     
183 };
a10dd5 184 typedef struct ts_triangle_data ts_triangle_data;
SP 185
186 struct ts_triangle {
187     ts_uint idx;
188     ts_triangle_data *data;
189 };
d7639a 190 typedef struct ts_triangle ts_triangle;
a10dd5 191
SP 192 struct ts_triangle_list{
193     ts_uint n;
194     ts_triangle **tria;
195 };
a2a676 196 typedef struct ts_triangle_list ts_triangle_list;
d7639a 197
bb77ca 198 typedef struct ts_cell_data {
d7639a 199     ts_vertex **vertex;
SP 200     ts_uint nvertex;
bb77ca 201 } ts_cell_data;
d7639a 202
bb77ca 203 typedef struct ts_cell {
SP 204     ts_uint idx;
205     ts_cell_data *data;
206 } ts_cell; 
207
208 typedef struct ts_cell_list{
209     ts_uint ncmax[3];
210     ts_uint cellno;
211     ts_cell **cell;
d7639a 212     ts_double dcell;
SP 213     ts_double shift;
214     ts_double max_occupancy;
bb77ca 215 } ts_cell_list;
SP 216
217
218 typedef struct {
219     ts_vertex_list *vlist;
220     ts_bond_list *blist;
221     ts_triangle_list *tlist;
222     ts_cell_list *clist;
223     ts_uint nshell;
d7639a 224     ts_double bending_rigidity;
SP 225     ts_double dmax;
226     ts_double stepsize;
227     ts_double cm[3];
228 } ts_vesicle;
229
230
231 /* GLOBAL VARIABLES */
232
233 int quiet;
234
235
236 /* FUNCTIONS */
237
238 /** Non-fatal error function handler:
239  *      @param text is a description of an error
240  *      @returns doesn't return anything
241 */
242 void err(char *text);
243
244 /** Fatal error function handler:
245  *      @param text is a description of an error
246  *      @param errcode is a (non-zero) error code
247  *      @returns terminates the execution of program with errcode set
248 */
249 void fatal(char *text, ts_int errcode);
250
7958e9 251 ts_uint ts_fprintf(FILE *fd, char *fmt, ...);
d7639a 252
737714 253 #define VTX(n) &(vlist->vtx[n])
SP 254 #define VTX_DATA(n) vlist->vtx[n].data
73f967 255
d7639a 256 #endif