| 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 | * | |
| 8f6a69 | 115 | * ts_vertex 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. */ |
| 8f6a69 | 117 | struct ts_vertex { |
| SP | 118 | ts_uint idx; |
| a10dd5 | 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; | |
| 737714 | 137 | }; |
| d7639a | 138 | typedef struct ts_vertex ts_vertex; |
| SP | 139 | |
| 73f967 | 140 | typedef struct { |
| SP | 141 | ts_uint n; |
| a10dd5 | 142 | ts_vertex **vtx; |
| 73f967 | 143 | |
| SP | 144 | } ts_vertex_list; |
| 145 | ||
| e016c4 | 146 | struct ts_bond { |
| SP | 147 | ts_uint idx; |
| d7639a | 148 | ts_vertex *vtx1; |
| SP | 149 | ts_vertex *vtx2; |
| 150 | ts_double bond_length; | |
| 151 | ts_double bond_length_dual; | |
| a10dd5 | 152 | }; |
| SP | 153 | typedef struct ts_bond ts_bond; |
| 154 | ||
| 155 | struct ts_bond_list { | |
| 156 | ts_uint n; | |
| 157 | ts_bond **bond; | |
| 158 | }; | |
| 159 | typedef struct ts_bond_list ts_bond_list; | |
| 160 | ||
| 41a035 | 161 | struct ts_triangle { |
| SP | 162 | ts_uint idx; |
| d7639a | 163 | ts_vertex *vertex[3]; |
| SP | 164 | ts_uint neigh_no; |
| 165 | struct ts_triangle **neigh; | |
| 166 | ts_double xnorm; | |
| 167 | ts_double ynorm; | |
| 168 | ts_double znorm; | |
| a10dd5 | 169 | }; |
| d7639a | 170 | typedef struct ts_triangle ts_triangle; |
| a10dd5 | 171 | |
| SP | 172 | struct ts_triangle_list{ |
| 173 | ts_uint n; | |
| 174 | ts_triangle **tria; | |
| 175 | }; | |
| a2a676 | 176 | typedef struct ts_triangle_list ts_triangle_list; |
| d7639a | 177 | |
| SP | 178 | |
| bb77ca | 179 | typedef struct ts_cell { |
| SP | 180 | ts_uint idx; |
| 34d3de | 181 | ts_vertex **vertex; |
| SP | 182 | ts_uint nvertex; |
| bb77ca | 183 | } ts_cell; |
| SP | 184 | |
| 185 | typedef struct ts_cell_list{ | |
| 186 | ts_uint ncmax[3]; | |
| 187 | ts_uint cellno; | |
| 188 | ts_cell **cell; | |
| d7639a | 189 | ts_double dcell; |
| SP | 190 | ts_double shift; |
| 191 | ts_double max_occupancy; | |
| bb77ca | 192 | } ts_cell_list; |
| SP | 193 | |
| 194 | ||
| 195 | typedef struct { | |
| 196 | ts_vertex_list *vlist; | |
| 197 | ts_bond_list *blist; | |
| 198 | ts_triangle_list *tlist; | |
| 199 | ts_cell_list *clist; | |
| 200 | ts_uint nshell; | |
| d7639a | 201 | ts_double bending_rigidity; |
| SP | 202 | ts_double dmax; |
| 203 | ts_double stepsize; | |
| 204 | ts_double cm[3]; | |
| 205 | } ts_vesicle; | |
| 206 | ||
| 207 | ||
| 208 | /* GLOBAL VARIABLES */ | |
| 209 | ||
| 210 | int quiet; | |
| 211 | ||
| 212 | ||
| 213 | /* FUNCTIONS */ | |
| 214 | ||
| 215 | /** Non-fatal error function handler: | |
| 216 | * @param text is a description of an error | |
| 217 | * @returns doesn't return anything | |
| 218 | */ | |
| 219 | void err(char *text); | |
| 220 | ||
| 221 | /** Fatal error function handler: | |
| 222 | * @param text is a description of an error | |
| 223 | * @param errcode is a (non-zero) error code | |
| 224 | * @returns terminates the execution of program with errcode set | |
| 225 | */ | |
| 226 | void fatal(char *text, ts_int errcode); | |
| 227 | ||
| 7958e9 | 228 | ts_uint ts_fprintf(FILE *fd, char *fmt, ...); |
| d7639a | 229 | |
| 737714 | 230 | #define VTX(n) &(vlist->vtx[n]) |
| SP | 231 | #define VTX_DATA(n) vlist->vtx[n].data |
| 73f967 | 232 | |
| d7639a | 233 | #endif |
