├── INPParser.py
├── LICENSE
├── README.md
├── examples
    ├── ccx3.inp
    ├── ccx4.inp
    ├── gmsh3.geo
    ├── gmsh3.inp
    ├── gmsh4.geo
    └── gmsh4.inp
└── gmsh2ccx.py


/INPParser.py:
--------------------------------------------------------------------------------
  1 | # -*- coding: utf-8 -*-
  2 | 
  3 | """
  4 |     © Ihor Mirzov, May 2019
  5 |     Distributed under GNU General Public License v3.0
  6 | 
  7 |     Parses finite element mesh in the Abaqus, Gmsh or CalculiX .inp-file.
  8 |     Tested on 2D quadrilateral and triangular first order elements.
  9 |     Reads nodes coordinates, elements composition, node and element sets, surfaces.
 10 |     Calculates elements cendroid coordinates.
 11 |     Generates triangles or quadrangles list to use with matplotlib.
 12 |     'project_field_on_centroids' method interpolates node field to elements centroids.
 13 | """
 14 | 
 15 | import numpy as np
 16 | import matplotlib.tri as tri
 17 | 
 18 | # Mesh object, contains methods for .inp-file parsing
 19 | class Mesh:
 20 | 
 21 |     # All mesh nodes with coordinates
 22 |     """
 23 |         1: ( 0.0, -1742.5, 0.0),
 24 |         2: (74.8, -1663.7, 0.0),
 25 |         ...
 26 |     """
 27 |     nodes = {}
 28 | 
 29 |     # All mesh elements composition
 30 |     """
 31 |         1: (1, 2),
 32 |         2: (3, 4),
 33 |         ...
 34 |         11: (21, 22, 23),
 35 |         12: (24, 25, 26),
 36 |         ...
 37 |     """
 38 |     elements = {}
 39 |     
 40 |     # Element types
 41 |     """
 42 |         1: 'type1',
 43 |         2: 'type2',
 44 |         ...
 45 |     """
 46 |     types = {}
 47 | 
 48 |     # Coordinates of all elements centroids
 49 |     """
 50 |         1: ( 0.0, -1742.5, 0.0),
 51 |         2: (74.8, -1663.7, 0.0),
 52 |         ...
 53 |     """
 54 |     centroids = {}
 55 |     
 56 |     # Node sets
 57 |     """
 58 |         'nset1': [1, 2, 3, 4],
 59 |         'nset2': [5, 6, 7, 8],
 60 |         ...
 61 |     """
 62 |     nsets = {}
 63 | 
 64 |     # Element sets
 65 |     """
 66 |         'eset1': [1, 2, 3, 4],
 67 |         'eset2': [5, 6, 7, 8],
 68 |         ...
 69 |     """
 70 |     esets = {}
 71 | 
 72 |     # Surface names
 73 |     """
 74 |         'surf1', 'surf2', 'surf3', 
 75 |     """
 76 |     surfaces = ()
 77 | 
 78 |     # Additional mesh variables
 79 |     cx = []; cy = [] # centroid coordinates as numpy array
 80 |     nx = []; ny = [] # nodes coordinates as numpy array
 81 |     triangles = () # triangles list to use with matplotlib
 82 |     quadrangles = [] # quadrangles to use with matplotlib
 83 | 
 84 |     # Some parameters
 85 |     initialized = False
 86 | 
 87 | 
 88 |     # Parse nodes with coordinates
 89 |     # *NODE keyword
 90 |     def get_nodes(self, lines):
 91 |         for i in range(len(lines)):
 92 |             if lines[i].startswith('*NODE'):
 93 |                 while i+1<len(lines) and not lines[i+1].startswith('*'): # read the whole block and return
 94 |                     a = lines[i+1].split(',')
 95 |                     num = int(a[0].strip()) # node number
 96 |                     self.nodes[num] = () # tuple with node coordinates
 97 |                     for coord in a[1:]:
 98 |                         self.nodes[num] += (float(coord.strip()), ) # add coordinate to tuple
 99 |                     i += 1
100 |                 return
101 | 
102 |     # Parse node sets
103 |     # *NSET keyword
104 |     def get_nsets(self, lines):
105 |         for i in range(len(lines)):
106 |             if lines[i].startswith('*NSET'):
107 |                 name = lines[i].split('=')[1]
108 |                 self.nsets[name] = ()
109 |                 while i+1<len(lines) and not lines[i+1].startswith('*'):
110 |                     a = lines[i+1].split(',')
111 |                     for n in a:
112 |                         if len(n.strip()):
113 |                             self.nsets[name] += (int(n), )
114 |                     i += 1
115 | 
116 |     # Parse elements composition and calculate centroid
117 |     # *ELEMENT keyword
118 |     def get_elements(self, lines):
119 |         for i in range(len(lines)):
120 |             if lines[i].startswith('*ELEMENT'):
121 |                 # etype = lines[i].split('=')[1].split(',')[0] # element type
122 |                 etype = lines[i].upper().split('TYPE=')[1].split(',')[0] # element type
123 |                 while i+1<len(lines) and not lines[i+1].startswith('*'): # there will be no comments
124 |                     a = lines[i+1].split(', ')
125 |                     num = int(a[0]) # element number
126 |                     self.types[num] = etype # save element type
127 |                     self.elements[num] = () # tuple with element nodes
128 |                     # TODO element nodes could be splitted into few lines
129 |                     for n in a[1:]:
130 |                         self.elements[num] += (int(n), ) # add node to tuple
131 |                     x=0; y=0; z=0
132 |                     for n in a[1:]: # iterate over element's node numbers
133 |                         x += self.nodes[int(n)][0] # sum up x-coordinates of all nodes of the element
134 |                         y += self.nodes[int(n)][1] # sum up y-coordinates of all nodes of the element
135 |                         try: # 3D case
136 |                             z += self.nodes[int(n)][2] # sum up z-coordinates of all nodes of the element
137 |                         except:
138 |                             pass
139 |                     amount = len(a[1:]) # amount of nodes in element
140 |                     x /= amount; y /= amount; z /= amount
141 |                     self.centroids[num] = (x, y, z) # centroid coordinates 3D
142 |                     i += 1
143 | 
144 |     # Parse element sets
145 |     # *ELSET keyword
146 |     def get_esets(self, lines):
147 |         for i in range(len(lines)):
148 |             if lines[i].startswith('*ELSET'):
149 |                 name = lines[i].split('=')[1]
150 |                 self.esets[name] = ()
151 |                 while i+1<len(lines) and not lines[i+1].startswith('*'):
152 |                     a = lines[i+1].split(',')
153 |                     for e in a:
154 |                         try:
155 |                             self.esets[name] += (int(e.strip()), )
156 |                         except:
157 |                             pass
158 |                     i += 1
159 | 
160 |     # Parse surfaces
161 |     # *SURFACE keyword
162 |     def get_surfaces(self, lines):
163 |         for line in lines:
164 |             if line.startswith('*SURFACE'):
165 |                 name = line.upper().split('NAME=')[1].split(',')[0]
166 |                 self.surfaces += (name, )
167 | 
168 |     # Set additional variables
169 |     def set_additional_vars(self):
170 |         self.cx = np.array( [v[0] for k,v in sorted(self.centroids.items())] ) # centroids x-coords sorted by element number
171 |         self.cy = np.array( [v[1] for k,v in sorted(self.centroids.items())] ) # centroids y-coords sorted by element number
172 |         self.nx = np.array( [v[0] for k,v in sorted(self.nodes.items())] ) # list of x-coords sorted by node number
173 |         self.ny = np.array( [v[1] for k,v in sorted(self.nodes.items())] ) # list of y-coords sorted by node number
174 |         first_node_num = list(self.nodes.keys())[0]
175 |         for elem, nodes in sorted(self.elements.items()): # tuples of node numbers sorted by element number
176 |             if len(nodes)==3:
177 |                 # Triangles consist of nodes indexes (not
178 |                 # numbers), so we may subtract first_node_num
179 |                 self.triangles += ((
180 |                                     nodes[0] - first_node_num,
181 |                                     nodes[1] - first_node_num,
182 |                                     nodes[2] - first_node_num), )
183 |             if len(nodes)==4:
184 |                 quad = [] # one quadrangle - array of node coordinates couples
185 |                 for n in nodes:
186 |                     x = self.nodes[n][0]; y = self.nodes[n][1]
187 |                     coords = np.array([[x, y]]) # coords of one node of the quadrangle
188 |                     if len(quad):
189 |                         quad = np.append(quad, coords, axis=0)
190 |                     else:
191 |                         quad = coords
192 |                 if len(self.quadrangles):
193 |                     self.quadrangles = np.append(self.quadrangles, [quad], axis=0)
194 |                 else:
195 |                     self.quadrangles = [quad]
196 | 
197 |     # Initialization
198 |     def __init__(self, inp_file):
199 |         # Open and read all the .inp-file
200 |         lines = []
201 |         with open(inp_file, 'r') as f:
202 |             for i, line in enumerate(f):
203 |                 if not '**' in line: # skip comments
204 |                     lines.append(line.strip().upper())
205 |         self.get_nodes(lines) # parse nodes
206 |         self.get_nsets(lines) # parse node sets
207 |         self.get_elements(lines) # parse elements
208 |         self.get_esets(lines) # parse node sets
209 |         self.get_surfaces(lines) # parse surfaces
210 |         print('Total:')
211 |         print('\t{0} nodes'.format(len(self.nodes)))
212 |         print('\t{0} elements'.format(len(self.elements)))
213 |         print('\t{0} centroids'.format(len(self.centroids)))
214 |         print('\t{0} nsets'.format(len(self.nsets)))
215 |         print('\t{0} esets'.format(len(self.esets)))
216 |         self.set_additional_vars()
217 |         self.initialized = True
218 | 
219 | 
220 |     # Project field on mesh centroids
221 |     def project_field_on_centroids(self, fx, fy, field_values):
222 |         """
223 |             fx - column with x-coordinates of field points
224 |             fy - column with y-coordinates of field points
225 |             field_values - column with field values in points (fx, fy)
226 |             fx, fy, field_values should be the same length
227 |         """
228 |         triang = tri.Triangulation(fx, fy) # Delaunay triangulation from field points
229 |         interp = tri.LinearTriInterpolator(triang, field_values) # interpolation object
230 |         res = interp(self.cx, self.cy) # perform linear interpolation on centroids
231 |         res = [x if type(x)==np.float64 else np.float64(0) for x in res] # zero values outside field triangles
232 |         res = res / max(res) * max(field_values) # diminish interpolation error
233 |         return res
234 | 
235 |     # Convert Calculix element type to VTK
236 |     @staticmethod
237 |     def convert_elem_type(frd_elem_type):
238 |         """
239 |             Keep in mind that CalculiX expands shell elements
240 |             In vtk elements nodes are numbered starting from 0, not 1
241 | 
242 |             For frd see http://www.dhondt.de/cgx_2.15.pdf pages 117-123 (chapter 10)
243 |             For vtk see https://vtk.org/wp-content/uploads/2015/04/file-formats.pdf pages 9-10
244 | 
245 |              _________________________________________________________________
246 |             |                               |                                 |
247 |             | №№      CalculiX type         |   №№        VTK type            |
248 |             |_______________________________|_________________________________|
249 |             |    |          |               |      |                          |
250 |             |  1 | C3D8     |  8 node brick | = 12 | VTK_HEXAHEDRON           |
251 |             |    | F3D8     |               |      |                          |
252 |             |    | C3D8R    |               |      |                          |
253 |             |    | C3D8I    |               |      |                          |
254 |             |____|__________|_______________|______|__________________________|
255 |             |    |          |               |      |                          |
256 |             |  2 | C3D6     |  6 node wedge | = 13 | VTK_WEDGE                |
257 |             |    | F3D6     |               |      |                          |
258 |             |____|__________|_______________|______|__________________________|
259 |             |    |          |               |      |                          |
260 |             |  3 | C3D4     |  4 node tet   | = 10 | VTK_TETRA                |
261 |             |    | F3D4     |               |      |                          |
262 |             |____|__________|_______________|______|__________________________|
263 |             |    |          |               |      |                          |
264 |             |  4 | C3D20    | 20 node brick | = 25 | VTK_QUADRATIC_HEXAHEDRON |
265 |             |    | C3D20R   |               |      |                          |
266 |             |____|__________|_______________|______|__________________________|
267 |             |    |          |               |      |                          |
268 |             |  5 | C3D15    | 15 node wedge | ~ 13 | VTK_WEDGE                |
269 |             |____|__________|_______________|______|__________________________|
270 |             |    |          |               |      |                          |
271 |             |  6 | C3D10    | 10 node tet   | = 24 | VTK_QUADRATIC_TETRA      |
272 |             |    | C3D10T   |               |      |                          |
273 |             |____|__________|_______________|______|__________________________|
274 |             |    |          |               |      |                          |
275 |             |  7 | S3       |  3 node shell | =  5 | VTK_TRIANGLE             |
276 |             |    | M3D3     |               |      |                          |
277 |             |    | CPS3     |               |      |                          |
278 |             |    | CPE3     |               |      |                          |
279 |             |    | CAX3     |               |      |                          |
280 |             |____|__________|_______________|______|__________________________|
281 |             |    |          |               |      |                          |
282 |             |  8 | S6       |  6 node shell | = 22 | VTK_QUADRATIC_TRIANGLE   |
283 |             |    | M3D6     |               |      |                          |
284 |             |    | CPS6     |               |      |                          |
285 |             |    | CPE6     |               |      |                          |
286 |             |    | CAX6     |               |      |                          |
287 |             |____|__________|_______________|______|__________________________|
288 |             |    |          |               |      |                          |
289 |             |  9 | S4       |  4 node shell | =  9 | VTK_QUAD                 |
290 |             |    | S4R      |               |      |                          |
291 |             |    | M3D4     |               |      |                          |
292 |             |    | M3D4R    |               |      |                          |
293 |             |    | CPS4     |               |      |                          |
294 |             |    | CPS4R    |               |      |                          |
295 |             |    | CPE4     |               |      |                          |
296 |             |    | CPE4R    |               |      |                          |
297 |             |    | CAX4     |               |      |                          |
298 |             |    | CAX4R    |               |      |                          |
299 |             |____|__________|_______________|______|__________________________|
300 |             |    |          |               |      |                          |
301 |             | 10 | S8       |  8 node shell | = 23 | VTK_QUADRATIC_QUAD       |
302 |             |    | S8R      |               |      |                          |
303 |             |    | M3D8     |               |      |                          |
304 |             |    | M3D8R    |               |      |                          |
305 |             |    | CPS8     |               |      |                          |
306 |             |    | CPS8R    |               |      |                          |
307 |             |    | CPE8     |               |      |                          |
308 |             |    | CPE8R    |               |      |                          |
309 |             |    | CAX8     |               |      |                          |
310 |             |    | CAX8R    |               |      |                          |
311 |             |____|__________|_______________|______|__________________________|
312 |             |    |          |               |      |                          |
313 |             | 11 | B21      |  2 node beam  | =  3 | VTK_LINE                 |
314 |             |    | B31      |               |      |                          |
315 |             |    | B31R     |               |      |                          |
316 |             |    | T2D2     |               |      |                          |
317 |             |    | T3D2     |               |      |                          |
318 |             |    | GAPUNI   |               |      |                          |
319 |             |    | DASHPOTA |               |      |                          |
320 |             |    | SPRING2  |               |      |                          |
321 |             |    | SPRINGA  |               |      |                          |
322 |             |____|__________|_______________|______|__________________________|
323 |             |    |          |               |      |                          |
324 |             | 12 | B32      |  3 node beam  | = 21 | VTK_QUADRATIC_EDGE       |
325 |             |    | B32R     |               |      |                          |
326 |             |    | T3D3     |               |      |                          |
327 |             |    | D        |               |      |                          |
328 |             |____|__________|_______________|______|__________________________|
329 |             |    |          |               |      |                          |
330 |             | ?? | SPRING1  |  1 node       | =  1 | VTK_VERTEX               |
331 |             |    | DCOUP3D  |               |      |                          |
332 |             |    | MASS     |               |      |                          |
333 |             |____|__________|_______________|______|__________________________|
334 |         """
335 |         # frd_elem_type : vtk_elem_type
336 |         frd2vtk_num = {
337 |              1: 12,
338 |              2: 13,
339 |              3: 10,
340 |              4: 25,
341 |              5: 13,
342 |              6: 24,
343 |              7:  5,
344 |              8: 22,
345 |              9:  9,
346 |             10: 23,
347 |             11:  3,
348 |             12: 21,
349 |         }
350 |         frd2vtk_txt = {
351 |                 'C3D8':12,
352 |                 'F3D8':12,
353 |                'C3D8R':12,
354 |                'C3D8I':12,
355 |                 'C3D6':13,
356 |                 'F3D6':13,
357 |                 'C3D4':10,
358 |                 'F3D4':10,
359 |                'C3D20':25,
360 |               'C3D20R':25,
361 |                'C3D15':13,
362 |                'C3D10':24,
363 |               'C3D10T':24,
364 |                   'S3':5,
365 |                 'M3D3':5,
366 |                 'CPS3':5,
367 |                 'CPE3':5,
368 |                 'CAX3':5,
369 |                   'S6':22,
370 |                 'M3D6':22,
371 |                 'CPS6':22,
372 |                 'CPE6':22,
373 |                 'CAX6':22,
374 |                   'S4':9,
375 |                  'S4R':9,
376 |                 'M3D4':9,
377 |                'M3D4R':9,
378 |                 'CPS4':9,
379 |                'CPS4R':9,
380 |                 'CPE4':9,
381 |                'CPE4R':9,
382 |                 'CAX4':9,
383 |                'CAX4R':9,
384 |                   'S8':23,
385 |                  'S8R':23,
386 |                 'M3D8':23,
387 |                'M3D8R':23,
388 |                 'CPS8':23,
389 |                'CPS8R':23,
390 |                 'CPE8':23,
391 |                'CPE8R':23,
392 |                 'CAX8':23,
393 |                'CAX8R':23,
394 |                  'B21':3,
395 |                  'B31':3,
396 |                 'B31R':3,
397 |                 'T2D2':3,
398 |                 'T3D2':3,
399 |               'GAPUNI':3,
400 |             'DASHPOTA':3,
401 |              'SPRING2':3,
402 |              'SPRINGA':3,
403 |                  'B32':21,
404 |                 'B32R':21,
405 |                 'T3D3':21,
406 |                    'D':21,
407 |              'SPRING1':1,
408 |              'DCOUP3D':1,
409 |                 'MASS':1,
410 |         }
411 |         if frd_elem_type in frd2vtk_num:
412 |             return frd2vtk_num[frd_elem_type]
413 |         else:
414 |             if frd_elem_type in frd2vtk_txt:
415 |                 return frd2vtk_txt[frd_elem_type]
416 |             else:
417 |                 return 0
418 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     <one line to give the program's name and a brief idea of what it does.>
635 |     Copyright (C) <year>  <name of author>
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <https://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     <program>  Copyright (C) <year>  <name of author>
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <https://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <https://www.gnu.org/licenses/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | © Ihor Mirzov, May 2019  
  2 | Distributed under GNU General Public License v3.0
  3 | 
  4 | <br/><br/>
  5 | 
  6 | 
  7 | 
  8 | # Gmsh to CalculiX converter (.inp to .inp)
  9 | 
 10 | The problem is that for 2D cases during exporting mesh in the .inp-format Gmsh does not generate *SURFACE keyword and does not list element edges belonging to the 'Physical Curve'. It makes impossible later to apply boundary conditions on 2D element's edges in CalculiX.
 11 | 
 12 | Moreover, for each geometrical line Gmsh creates and exports beam (T3D2) elements which in 2D case is absolutely unacceptable, because leads to unwanted entities in the Calculix model.
 13 | 
 14 | <br/><br/>
 15 | 
 16 | 
 17 | 
 18 | # gmsh3.geo, gmsh4.geo
 19 | 
 20 | Gmsh example files. You'll need 'gmsh' command to be available in your OS. Generate 2D square and mesh it with CPS3 or CPS4 elements with command:
 21 | 
 22 |     gmsh gmsh3.geo -2 -o gmsh3.inp -v 0 -save_all
 23 | 
 24 | for triangular mesh or:
 25 | 
 26 |     gmsh gmsh4.geo -2 -o gmsh4.inp -v 0 -save_all
 27 | 
 28 | for quadrilateral mesh.
 29 | 
 30 | <br/><br/>
 31 | 
 32 | 
 33 | 
 34 | # gmsh2ccx.py
 35 | 
 36 | Convert Gmsh .inp-file to CalculiX .inp-file. Works with 2D first order triangles and quadrangles. Tested in Gmsh 4.2.2 and Calculix 2.15.
 37 | 
 38 | The script from Gmsh element sets corresponding to the 'Physical Curve' generates *SURFACE and *NSET (optionally) blocks. For the *SURFACE corectly accounts for element's edge numbers.
 39 | 
 40 | Run with command:
 41 | 
 42 |     python3 gmsh2ccx.py -g gmsh3.inp -c ccx3.inp -e S3 -ns 1
 43 | 
 44 | or
 45 | 
 46 |     python3 gmsh2ccx.py -g gmsh4.inp -c ccx4.inp -e S4 -ns 1
 47 | 
 48 | where:
 49 | 
 50 | - gmsh3.inp/gmsh4.inp are input file names to process (obtained from Gmsh)
 51 | 
 52 | - ccx3.inp/ccx3.inp are output file names (for CalculiX)
 53 | 
 54 | - S3/S4 are CalculiX element types: S3 for 2D triangular mesh, S4 for 2D quadrilateral mesh
 55 | 
 56 | - ns is a flag showing whether to output node sets (1) or not (0) 
 57 | 
 58 | The script needs INPParser.py library.
 59 | 
 60 | <br/><br/>
 61 | 
 62 | 
 63 | 
 64 | # INPParser.py
 65 | 
 66 | Parses finite element mesh in the Abaqus, Gmsh or CalculiX .inp-file.
 67 | 
 68 | Tested on C3D8, 2D quadrilateral and triangular first order elements.
 69 | 
 70 | Reads nodes coordinates, elements composition, node and element sets, surfaces.
 71 | 
 72 | Calculates elements cendroid coordinates.
 73 | 
 74 | Generates triangles or quadrangles list to use with matplotlib.
 75 | 
 76 | 'project_field_on_centroids' method interpolates node field to elements centroids.
 77 | 
 78 | <br/><br/>
 79 | 
 80 | 
 81 | 
 82 | # Your help
 83 | 
 84 | Please, you may:
 85 | 
 86 | - Star this project.
 87 | - Simply use this software and ask questions.
 88 | - Share your models and screenshots.
 89 | - Report problems by [posting issues](https://github.com/calculix/gmsh2ccx/issues).
 90 | - Do something from the [TODO-list](#TODO).
 91 | 
 92 | <br/><br/>
 93 | 
 94 | 
 95 | 
 96 | # TODO
 97 | 
 98 | - dimensionality parameter in INPParser.py
 99 | - automatically distinguish mesh dimensions (2D/3D)
100 | - automatically distinguish elements type (S3/S4/S6/S8)
101 | - check elements normals
102 | - second order elements S6, S8
103 | - make pypi package
104 | 


--------------------------------------------------------------------------------
/examples/ccx3.inp:
--------------------------------------------------------------------------------
 1 | *NODE, NSET=ALL
 2 | 	1, 0.0, 0.0, 0.0
 3 | 	2, 10.0, 0.0, 0.0
 4 | 	3, 10.0, 10.0, 0.0
 5 | 	4, 0.0, 10.0, 0.0
 6 | 	5, 4.9999999999924, 0.0, 0.0
 7 | 	6, 10.0, 4.9999999999924, 0.0
 8 | 	7, 5.0, 10.0, 0.0
 9 | 	8, 0.0, 5.0, 0.0
10 | 	9, 7.0624999999982, 2.9374999999986, 0.0
11 | 	10, 6.250000000001, 6.249999999999, 0.0
12 | 	11, 3.5208333333321, 3.5624999999995, 0.0
13 | 	12, 2.8125000000008, 7.1874999999992, 0.0
14 | *ELEMENT, type=S3, ELSET=ALL
15 | 	13, 8, 1, 11
16 | 	14, 6, 3, 10
17 | 	15, 3, 7, 10
18 | 	16, 1, 5, 11
19 | 	17, 7, 4, 12
20 | 	18, 4, 8, 12
21 | 	19, 5, 2, 9
22 | 	20, 2, 6, 9
23 | 	21, 8, 11, 12
24 | 	22, 9, 6, 10
25 | 	23, 9, 10, 11
26 | 	24, 10, 7, 12
27 | 	25, 11, 10, 12
28 | 	26, 5, 9, 11
29 | *NSET, NSET=RIGHT
30 | 	2,
31 | 	6,
32 | 	6,
33 | 	3,
34 | *ELSET, ELSET=RIGHT_S3
35 | 	20,
36 | 	14,
37 | *SURFACE, name=RIGHT, type=ELEMENT
38 | 	RIGHT_S3, S3
39 | *NSET, NSET=LEFT
40 | 	4,
41 | 	8,
42 | 	8,
43 | 	1,
44 | *ELSET, ELSET=LEFT_S3
45 | 	18,
46 | 	13,
47 | *SURFACE, name=LEFT, type=ELEMENT
48 | 	LEFT_S3, S3
49 | 


--------------------------------------------------------------------------------
/examples/ccx4.inp:
--------------------------------------------------------------------------------
 1 | *NODE, NSET=ALL
 2 | 	1, 0.0, 0.0, 0.0
 3 | 	2, 10.0, 0.0, 0.0
 4 | 	3, 10.0, 10.0, 0.0
 5 | 	4, 0.0, 10.0, 0.0
 6 | 	5, 4.9999999999924, 0.0, 0.0
 7 | 	6, 10.0, 4.9999999999924, 0.0
 8 | 	7, 5.0, 10.0, 0.0
 9 | 	8, 0.0, 5.0, 0.0
10 | 	9, 4.9999999999988, 4.9999999999988, 0.0
11 | *ELEMENT, type=S4, ELSET=ALL
12 | 	13, 4, 8, 9, 7
13 | 	14, 1, 5, 9, 8
14 | 	15, 2, 6, 9, 5
15 | 	16, 3, 7, 9, 6
16 | *NSET, NSET=RIGHT
17 | 	2,
18 | 	6,
19 | 	6,
20 | 	3,
21 | *ELSET, ELSET=RIGHT_S3
22 | 	15,
23 | *ELSET, ELSET=RIGHT_S6
24 | 	16,
25 | *SURFACE, name=RIGHT, type=ELEMENT
26 | 	RIGHT_S3, S3
27 | 	RIGHT_S6, S6
28 | *NSET, NSET=LEFT
29 | 	4,
30 | 	8,
31 | 	8,
32 | 	1,
33 | *ELSET, ELSET=LEFT_S3
34 | 	13,
35 | *ELSET, ELSET=LEFT_S6
36 | 	14,
37 | *SURFACE, name=LEFT, type=ELEMENT
38 | 	LEFT_S3, S3
39 | 	LEFT_S6, S6
40 | 


--------------------------------------------------------------------------------
/examples/gmsh3.geo:
--------------------------------------------------------------------------------
 1 | size = 5; // element's size
 2 | Mesh.CharacteristicLengthMin = size;
 3 | Mesh.CharacteristicLengthMax = size;
 4 | Mesh.Algorithm = 6; // Frontal-Delaunay
 5 | // Mesh.RecombinationAlgorithm = 2; // simple full-quad
 6 | // Mesh.RecombineAll = 1;
 7 | 
 8 | Point(1) = {0, 0, 0, size}; // left bottom
 9 | Point(2) = {10, 0, 0, size}; // right bottom
10 | Point(3) = {10, 10, 0, size}; // right top
11 | Point(4) = {0, 10, 0, size}; // left top
12 | 
13 | Line(1) = {1, 2}; // bottom
14 | Line(2) = {2, 3}; // right
15 | Line(3) = {3, 4}; // top
16 | Line(4) = {4, 1}; // left
17 | 
18 | Curve Loop(1) = {1:4};
19 | Plane Surface(1) = {1};
20 | Physical Curve("RIGHT") = {2};
21 | Physical Curve("LEFT") = {4};
22 | 


--------------------------------------------------------------------------------
/examples/gmsh3.inp:
--------------------------------------------------------------------------------
 1 | *Heading
 2 |  gmsh3.inp
 3 | *NODE
 4 | 1, 0, 0, 0
 5 | 2, 10, 0, 0
 6 | 3, 10, 10, 0
 7 | 4, 0, 10, 0
 8 | 5, 4.9999999999924, 0, 0
 9 | 6, 10, 4.9999999999924, 0
10 | 7, 5, 10, 0
11 | 8, 0, 5, 0
12 | 9, 7.0624999999982, 2.9374999999986, 0
13 | 10, 6.250000000001, 6.249999999999, 0
14 | 11, 3.5208333333321, 3.5624999999995, 0
15 | 12, 2.8125000000008, 7.1874999999992, 0
16 | ******* E L E M E N T S *************
17 | *ELEMENT, type=T3D2, ELSET=Line1
18 | 5, 1, 5
19 | 6, 5, 2
20 | *ELEMENT, type=T3D2, ELSET=Line2
21 | 7, 2, 6
22 | 8, 6, 3
23 | *ELEMENT, type=T3D2, ELSET=Line3
24 | 9, 3, 7
25 | 10, 7, 4
26 | *ELEMENT, type=T3D2, ELSET=Line4
27 | 11, 4, 8
28 | 12, 8, 1
29 | *ELEMENT, type=CPS3, ELSET=Surface1
30 | 13, 8, 1, 11
31 | 14, 6, 3, 10
32 | 15, 3, 7, 10
33 | 16, 1, 5, 11
34 | 17, 7, 4, 12
35 | 18, 4, 8, 12
36 | 19, 5, 2, 9
37 | 20, 2, 6, 9
38 | 21, 8, 11, 12
39 | 22, 9, 6, 10
40 | 23, 9, 10, 11
41 | 24, 10, 7, 12
42 | 25, 11, 10, 12
43 | 26, 5, 9, 11
44 | *ELSET,ELSET=RIGHT
45 | 7, 8, 
46 | *ELSET,ELSET=LEFT
47 | 11, 12, 
48 | 


--------------------------------------------------------------------------------
/examples/gmsh4.geo:
--------------------------------------------------------------------------------
 1 | size = 10; // element's size
 2 | Mesh.CharacteristicLengthMin = size;
 3 | Mesh.CharacteristicLengthMax = size;
 4 | Mesh.Algorithm = 6; // Frontal-Delaunay
 5 | Mesh.RecombinationAlgorithm = 2; // simple full-quad
 6 | Mesh.RecombineAll = 1;
 7 | 
 8 | Point(1) = {0, 0, 0, size}; // left bottom
 9 | Point(2) = {10, 0, 0, size}; // right bottom
10 | Point(3) = {10, 10, 0, size}; // right top
11 | Point(4) = {0, 10, 0, size}; // left top
12 | 
13 | Line(1) = {1, 2}; // bottom
14 | Line(2) = {2, 3}; // right
15 | Line(3) = {3, 4}; // top
16 | Line(4) = {4, 1}; // left
17 | 
18 | Curve Loop(1) = {1:4};
19 | Plane Surface(1) = {1};
20 | Physical Curve("RIGHT") = {2};
21 | Physical Curve("LEFT") = {4};
22 | 


--------------------------------------------------------------------------------
/examples/gmsh4.inp:
--------------------------------------------------------------------------------
 1 | *Heading
 2 |  gmsh4.inp
 3 | *NODE
 4 | 1, 0, 0, 0
 5 | 2, 10, 0, 0
 6 | 3, 10, 10, 0
 7 | 4, 0, 10, 0
 8 | 5, 4.9999999999924, 0, 0
 9 | 6, 10, 4.9999999999924, 0
10 | 7, 5, 10, 0
11 | 8, 0, 5, 0
12 | 9, 4.9999999999988, 4.9999999999988, 0
13 | ******* E L E M E N T S *************
14 | *ELEMENT, type=T3D2, ELSET=Line1
15 | 5, 1, 5
16 | 6, 5, 2
17 | *ELEMENT, type=T3D2, ELSET=Line2
18 | 7, 2, 6
19 | 8, 6, 3
20 | *ELEMENT, type=T3D2, ELSET=Line3
21 | 9, 3, 7
22 | 10, 7, 4
23 | *ELEMENT, type=T3D2, ELSET=Line4
24 | 11, 4, 8
25 | 12, 8, 1
26 | *ELEMENT, type=CPS4, ELSET=Surface1
27 | 13, 4, 8, 9, 7
28 | 14, 1, 5, 9, 8
29 | 15, 2, 6, 9, 5
30 | 16, 3, 7, 9, 6
31 | *ELSET,ELSET=RIGHT
32 | 7, 8, 
33 | *ELSET,ELSET=LEFT
34 | 11, 12, 
35 | 


--------------------------------------------------------------------------------
/gmsh2ccx.py:
--------------------------------------------------------------------------------
  1 | # -*- coding: utf-8 -*-
  2 | 
  3 | """
  4 |     © Ihor Mirzov, May 2019.  
  5 |     Distributed under GNU General Public License v3.0
  6 | 
  7 |     Convert Gmsh .inp-file to CalculiX .inp-file.
  8 |     Run with command:
  9 |         python3 gmsh2ccx.py -g gmsh3.inp -c ccx3.inp -e S3 -ns 1
 10 |         python3 gmsh2ccx.py -g gmsh4.inp -c ccx4.inp -e S4 -ns 1
 11 | """
 12 | 
 13 | 
 14 | import sys, argparse
 15 | from INPParser import Mesh
 16 | 
 17 | 
 18 | # Converts element types from gmsh to ccx
 19 | def rename_element(gmsh_elem_type):
 20 |     dic =\
 21 |         {
 22 |             'C1D2':'B31', # 2 node beam
 23 |             'T3D2':'B31', # 2 node beam
 24 |             'C1D3':'B32', # 3 node beam
 25 |             'T3D3':'B32', # 3 node beam
 26 |             'C2D3':'S3', # 3 node shell
 27 |             'CPS3':'S3', # 3 node shell
 28 |             'C2D4':'S4', # 4 node shell
 29 |             'CPS4':'S4', # 4 node shell
 30 |         }
 31 |     try:
 32 |         ccx_elem_type = dic[gmsh_elem_type]
 33 |     except:
 34 |         ccx_elem_type = gmsh_elem_type
 35 |         print('Error converting element type', gmsh_elem_type)
 36 |     return ccx_elem_type
 37 | 
 38 | 
 39 | # Element's edge number
 40 | def edge_number(etype, elem_nodes, n1, n2):
 41 |     # See Calculix 2.15 documentation, chapter "7.114 *SURFACE"
 42 | 
 43 |     # Triangular and quadrilateral shell elements
 44 |     if etype in ('S3', 'S4'):
 45 |         """
 46 |             tri (S3):
 47 |                 Edge 3: 1-2
 48 |                 Edge 4: 2-3
 49 |                 Edge 5: 3-1
 50 |             quad (S4):
 51 |                 Edge 3: 1-2
 52 |                 Edge 4: 2-3
 53 |                 Edge 5: 3-4
 54 |                 Edge 6: 4-1
 55 |         """
 56 |         for edge in range(len(elem_nodes)-1):
 57 |             if elem_nodes[edge]==n1 and elem_nodes[edge+1]==n2:
 58 |                 return edge+3
 59 |         return len(elem_nodes)+2
 60 | 
 61 |     # Triangular and quadrilateral plane stress, plane strain and axisymmetric elements
 62 |     if etype in ('CPS3', 'CPS4', 'CPE3', 'CPE4'):
 63 |         """
 64 |             tri (S3):
 65 |                 Edge 1: 1-2
 66 |                 Edge 2: 2-3
 67 |                 Edge 3: 3-1
 68 |             quad (S4):
 69 |                 Edge 1: 1-2
 70 |                 Edge 2: 2-3
 71 |                 Edge 3: 3-4
 72 |                 Edge 4: 4-1
 73 |         """
 74 |         for edge in range(len(elem_nodes)-1):
 75 |             if elem_nodes[edge]==n1 and elem_nodes[edge+1]==n2:
 76 |                 return edge+1
 77 |         return len(elem_nodes)
 78 | 
 79 | 
 80 | if __name__ == '__main__':
 81 | 
 82 |     # Command line parameters
 83 |     parser = argparse.ArgumentParser()
 84 |     parser.add_argument("--gmsh", "-g",
 85 |                         help="Gmsh .inp file name",
 86 |                         type=str, default='gmsh3.inp')
 87 |     parser.add_argument("--ccx", "-c",
 88 |                         help="Calculix .inp file name",
 89 |                         type=str, default='ccx3.inp')
 90 |     parser.add_argument("--etype", "-e",
 91 |                         help="Element type: S3 or S4",
 92 |                         type=str, default='S3')
 93 |     parser.add_argument("--nodesets", "-ns",
 94 |                         help="Specify whether to output node sets: 0 or 1",
 95 |                         type=int, default=0)
 96 |     args = parser.parse_args()
 97 | 
 98 |     # Parse mesh, define nodes, elements and centroids
 99 |     mesh = Mesh(args.gmsh)
100 | 
101 |     # Process lines of gmsh-file and write ccx-file
102 |     with open(args.ccx, 'w') as ccx:
103 | 
104 |         # Nodes block
105 |         if len(mesh.nodes):
106 |             ccx.write('*NODE, NSET=ALL\n') # append name of the node set
107 |             for k,v in mesh.nodes.items():
108 |                 coords = str(v)[1:-1]
109 |                 # if not '0.0, 0.0, 0.0' in coords:
110 |                 ccx.write('\t{0}, {1}\n'.format(k, coords)) # v without braces
111 | 
112 |         # Elements block
113 |         if len(mesh.elements):
114 |             ccx.write('*ELEMENT, type=' + args.etype + ', ELSET=ALL\n')
115 |             for elem, nodes in mesh.elements.items():
116 |                 gmsh_elem_type = mesh.types[elem]
117 |                 ccx_elem_type = rename_element(gmsh_elem_type)
118 |                 if args.etype == ccx_elem_type: # save only needed elements
119 |                     ccx.write('\t{0}, {1}\n'.format(elem, str(nodes)[1:-1])) # v without braces
120 | 
121 |         # Process node and element sets and define element edges
122 |         for setname in mesh.esets.keys(): # ['LEFT', 'RIGHT']
123 |             # Write node set
124 |             if args.nodesets:
125 |                 ccx.write('*NSET, NSET={0}\n'.format(setname))
126 |                 for e in mesh.esets[setname]:
127 |                     for n in mesh.elements[e]:
128 |                         ccx.write('\t{0},\n'.format(n))
129 | 
130 |             # Elements of type 'args.etype', grouped by edge numbers
131 |             E = {} # {'edge1':(elements1), 'edge2':(elements2), }
132 |             for edge in range(6): # there is no 2D element with edge number > 6
133 |                 E[edge+1] = () # in the ccx inp.-file edge number should start from 1
134 |             for sbe in mesh.esets[setname]: # beam elements composing free surface
135 |                 n1 = mesh.elements[sbe][0] # node 1 of surface beam element
136 |                 n2 = mesh.elements[sbe][1] # node 2 of surface beam element
137 | 
138 |                 # Find 'args.etype' element by the nodes n1, n2
139 |                 for elem, nodes in mesh.elements.items():
140 |                     gmsh_elem_type = mesh.types[elem]
141 |                     ccx_elem_type = rename_element(gmsh_elem_type)
142 |                     if (args.etype == ccx_elem_type) and (n1 in nodes) and (n2 in nodes): # we've got element
143 |                         if nodes.index(n1) > nodes.index(n2):
144 |                             n1, n2 = n2, n1 # n1 should have smaller index in element's nodes
145 |                         edge = edge_number(ccx_elem_type, nodes, n1, n2)
146 |                         E[edge] += (elem, )
147 |                         break
148 | 
149 |             # Write element sets grouped by edges
150 |             for edge, elems in E.items():
151 |                 if len(elems):
152 |                     ccx.write('*ELSET, ELSET={0}_S{1}\n'.format(setname, edge))
153 |                     for e in elems:
154 |                         ccx.write('\t{0},\n'.format(e))
155 | 
156 |             # Write surface elements
157 |             ccx.write('*SURFACE, name={0}, type=ELEMENT\n'.format(setname))
158 |             for edge, elems in E.items():
159 |                 if len(elems):
160 |                     ccx.write('\t{0}_S{1}, S{1}\n'.format(setname, edge))
161 | 
162 |         print('Conversion OK')
163 | 
164 |     if os.path.isdir('__pycache__'):
165 |         shutil.rmtree('__pycache__') # works in Linux as in Windows
166 | 


--------------------------------------------------------------------------------