forked from jaheyns/CfdOF
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathCfdTools.py
1365 lines (1167 loc) · 53 KB
/
CfdTools.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# ***************************************************************************
# * *
# * Copyright (c) 2015 - FreeCAD Developers *
# * Copyright (c) 2015 - Qingfeng Xia <qingfeng xia eng.ox.ac.uk> *
# * Copyright (c) 2017 Johan Heyns (CSIR) <[email protected]> *
# * Copyright (c) 2017 Oliver Oxtoby (CSIR) <[email protected]> *
# * Copyright (c) 2017 Alfred Bogaers (CSIR) <[email protected]> *
# * Copyright (c) 2019-2020 Oliver Oxtoby <[email protected]> *
# * *
# * This program is free software; you can redistribute it and/or modify *
# * it under the terms of the GNU Lesser General Public License (LGPL) *
# * as published by the Free Software Foundation; either version 2 of *
# * the License, or (at your option) any later version. *
# * for detail see the LICENCE text file. *
# * *
# * This program is distributed in the hope that it will be useful, *
# * but WITHOUT ANY WARRANTY; without even the implied warranty of *
# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
# * GNU Library General Public License for more details. *
# * *
# * You should have received a copy of the GNU Library General Public *
# * License along with this program; if not, write to the Free Software *
# * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 *
# * USA *
# * *
# ***************************************************************************
# Utility functions like mesh exporting, shared by any CFD solver
from __future__ import print_function
import FreeCAD
from FreeCAD import Units
import CfdConsoleProcess
import Part
import os
import os.path
import shutil
import tempfile
import numbers
import platform
import subprocess
import sys
import math
import BOPTools
from BOPTools import SplitFeatures
if FreeCAD.GuiUp:
import FreeCADGui
from PySide import QtGui
from PySide import QtCore
# Some standard install locations that are searched if an install directory is not specified
FOAM_DIR_DEFAULTS = {"Windows": ["C:\\Program Files (x86)\\ESI\\OpenFOAM\\v2006",
"~\\AppData\\Roaming\\ESI-OpenCFD\\OpenFOAM\\v2006",
"C:\\Program Files (x86)\\ESI\\OpenFOAM\\v1912",
"C:\\Program Files\\blueCFD-Core-2017\\OpenFOAM-5.x",
"C:\\Program Files\\blueCFD-Core-2016\\OpenFOAM-4.x"],
"Linux": ["/opt/openfoam4", "/opt/openfoam5", "/opt/openfoam6", "/opt/openfoam7", "/opt/openfoam-dev",
"~/OpenFOAM/OpenFOAM-7.x", "~/OpenFOAM/OpenFOAM-7.0",
"~/OpenFOAM/OpenFOAM-6.x", "~/OpenFOAM/OpenFOAM-6.0",
"~/OpenFOAM/OpenFOAM-5.x", "~/OpenFOAM/OpenFOAM-5.0",
"~/OpenFOAM/OpenFOAM-4.x", "~/OpenFOAM/OpenFOAM-4.0", "~/OpenFOAM/OpenFOAM-4.1",
"~/OpenFOAM/OpenFOAM-dev"]
}
PARAVIEW_PATH_DEFAULTS = {
"Windows": ["C:\\Program Files\\ParaView 5.5.2-Qt5-Windows-64bit\\bin\\paraview.exe",
"C:\\Program Files\\ParaView 5.5.2-Qt5-MPI-Windows-64bit\\bin\\paraview.exe"],
"Linux": []
}
def getDefaultOutputPath():
prefs = getPreferencesLocation()
output_path = FreeCAD.ParamGet(prefs).GetString("DefaultOutputPath", "")
if not output_path:
output_path = tempfile.gettempdir()
output_path = os.path.normpath(output_path)
return output_path
def getOutputPath(analysis):
if analysis and 'OutputPath' in analysis.PropertiesList:
output_path = analysis.OutputPath
else:
output_path = ""
if not output_path:
output_path = getDefaultOutputPath()
output_path = os.path.normpath(output_path)
return output_path
# Get functions
if FreeCAD.GuiUp:
def getResultObject():
sel = FreeCADGui.Selection.getSelection()
if len(sel) == 1:
if sel[0].isDerivedFrom("Fem::FemResultObject"):
return sel[0]
for i in getActiveAnalysis().Group:
if i.isDerivedFrom("Fem::FemResultObject"):
return i
return None
def getParentAnalysisObject(obj):
""" Return CfdAnalysis object to which this obj belongs in the tree """
return obj.getParentGroup()
def getPhysicsModel(analysis_object):
isPresent = False
for i in analysis_object.Group:
if "PhysicsModel" in i.Name:
physicsModel = i
isPresent = True
if not isPresent:
physicsModel = None
return physicsModel
def getMeshObject(analysis_object):
isPresent = False
meshObj = []
if analysis_object:
members = analysis_object.Group
else:
members = FreeCAD.activeDocument().Objects
from CfdMesh import _CfdMesh
for i in members:
if hasattr(i, "Proxy") and isinstance(i.Proxy, _CfdMesh):
if isPresent:
FreeCAD.Console.PrintError("Analysis contains more than one mesh object.")
else:
meshObj.append(i)
isPresent = True
if not isPresent:
meshObj = [None]
return meshObj[0]
def getPorousZoneObjects(analysis_object):
return [i for i in analysis_object.Group if i.Name.startswith('PorousZone')]
def getInitialisationZoneObjects(analysis_object):
return [i for i in analysis_object.Group if i.Name.startswith('InitialisationZone')]
def getZoneObjects(analysis_object):
return [i for i in analysis_object.Group if 'Zone' in i.Name]
def getInitialConditions(analysis_object):
from CfdInitialiseFlowField import _CfdInitialVariables
for i in analysis_object.Group:
if isinstance(i.Proxy, _CfdInitialVariables):
return i
return None
def getMaterials(analysis_object):
return [i for i in analysis_object.Group
if i.isDerivedFrom('App::MaterialObjectPython')]
def getSolver(analysis_object):
from CfdSolverFoam import _CfdSolverFoam
for i in analysis_object.Group:
if isinstance(i.Proxy, _CfdSolverFoam):
return i
def getSolverSettings(solver):
""" Convert properties into python dict, while key must begin with lower letter. """
dict = {}
f = lambda s: s[0].lower() + s[1:]
for prop in solver.PropertiesList:
dict[f(prop)] = solver.getPropertyByName(prop)
return dict
def getCfdBoundaryGroup(analysis_object):
group = []
from CfdFluidBoundary import _CfdFluidBoundary
for i in analysis_object.Group:
if isinstance(i.Proxy, _CfdFluidBoundary):
group.append(i)
return group
def is_planar(shape):
""" Return whether the shape is a planar face """
n = shape.normalAt(0.5, 0.5)
if len(shape.Vertexes) <= 3:
return True
for v in shape.Vertexes[1:]:
t = v.Point - shape.Vertexes[0].Point
c = t.dot(n)
if c / t.Length > 1e-8:
return False
return True
def getMesh(analysis_object):
from CfdMesh import _CfdMesh
for i in analysis_object.Group:
if hasattr(i, "Proxy") and isinstance(i.Proxy, _CfdMesh):
return i
return None
def getMeshRefinementObjs(mesh_obj):
from CfdMeshRefinement import _CfdMeshRefinement
ref_objs = []
for obj in mesh_obj.Group:
if hasattr(obj, "Proxy") and isinstance(obj.Proxy, _CfdMeshRefinement):
ref_objs = ref_objs + [obj]
return ref_objs
def getResult(analysis_object):
for i in analysis_object.Group:
if i.isDerivedFrom("Fem::FemResultObject"):
return i
return None
def get_module_path():
""" Returns the current Cfd module path.
Determines where this file is running from, so works regardless of whether
the module is installed in the app's module directory or the user's app data folder.
(The second overrides the first.)
"""
return os.path.dirname(__file__)
# Set functions
def setCompSolid(vobj):
""" To enable correct mesh refinement, boolean fragments are set to compSolid mode """
doc_name = str(vobj.Object.Document.Name)
doc = FreeCAD.getDocument(doc_name)
for obj in doc.Objects:
if hasattr(obj, 'Proxy') and isinstance(obj.Proxy, BOPTools.SplitFeatures.FeatureBooleanFragments):
FreeCAD.getDocument(doc_name).getObject(obj.Name).Mode = 'CompSolid'
def normalise(v):
import numpy
mag = numpy.sqrt(sum(vi**2 for vi in v))
import sys
if mag < sys.float_info.min:
mag += sys.float_info.min
return [vi/mag for vi in v]
def cfdError(msg):
""" Show message for an expected error """
QtGui.QApplication.restoreOverrideCursor()
if FreeCAD.GuiUp:
QtGui.QMessageBox.critical(None, "CfdOF Workbench", msg)
else:
FreeCAD.Console.PrintError(msg + "\n")
def cfdMessage(msg):
""" Print a message to console and refresh GUI """
FreeCAD.Console.PrintMessage(msg)
if FreeCAD.GuiUp:
FreeCAD.Gui.updateGui()
FreeCAD.Gui.updateGui()
def setQuantity(inputField, quantity):
""" Set the quantity (quantity object or unlocalised string) into the inputField correctly """
# Must set in the correctly localised value as the user would enter it.
# A bit painful because the python locale settings seem to be based on language,
# not input settings as the FreeCAD settings are. So can't use that; hence
# this rather roundabout way involving the UserString of Quantity
q = Units.Quantity(quantity)
# Avoid any truncation
if isinstance(q.Format, tuple): # Backward compat
q.Format = (12, 'e')
else:
q.Format = {'Precision': 12, 'NumberFormat': 'e', 'Denominator': q.Format['Denominator']}
inputField.setProperty("quantityString", q.UserString)
def getQuantity(inputField):
""" Get the quantity as an unlocalised string from an inputField """
q = inputField.property("quantity")
return str(q)
def indexOrDefault(list, findItem, defaultIndex):
""" Look for findItem in list, and return defaultIndex if not found """
try:
return list.index(findItem)
except ValueError:
return defaultIndex
def hide_parts_show_meshes():
if FreeCAD.GuiUp:
for acnstrmesh in getActiveAnalysis().Group:
if "Mesh" in acnstrmesh.TypeId:
aparttoshow = acnstrmesh.Name.replace("_Mesh", "")
for apart in FreeCAD.activeDocument().Objects:
if aparttoshow == apart.Name:
apart.ViewObject.Visibility = False
acnstrmesh.ViewObject.Visibility = True
def copyFilesRec(src, dst, symlinks=False, ignore=None):
""" Recursively copy files from src dir to dst dir """
if not os.path.exists(dst):
os.makedirs(dst)
for item in os.listdir(src):
s = os.path.join(src, item)
d = os.path.join(dst, item)
if not os.path.isdir(s):
shutil.copy2(s, d)
def getPatchType(bcType, bcSubType):
""" Get the boundary type based on selected BC condition """
if bcType == 'wall':
return 'wall'
elif bcType == 'empty':
return 'empty'
elif bcType == 'constraint':
if bcSubType == 'symmetry':
return 'symmetry'
elif bcSubType == 'cyclic':
return 'cyclic'
elif bcSubType == 'wedge':
return 'wedge'
elif bcSubType == 'twoDBoundingPlane':
return 'empty'
elif bcSubType == 'empty':
return 'empty'
else:
return 'patch'
else:
return 'patch'
def movePolyMesh(case):
""" Move polyMesh to polyMesh.org to ensure availability if cleanCase is ran from the terminal. """
meshOrg_dir = case + os.path.sep + "constant/polyMesh.org"
mesh_dir = case + os.path.sep + "constant/polyMesh"
if os.path.isdir(meshOrg_dir):
shutil.rmtree(meshOrg_dir)
shutil.copytree(mesh_dir, meshOrg_dir)
shutil.rmtree(mesh_dir)
def getPreferencesLocation():
# Set parameter location
return "User parameter:BaseApp/Preferences/Mod/CfdOF"
def setFoamDir(installation_path):
prefs = getPreferencesLocation()
# Set OpenFOAM install path in parameters
FreeCAD.ParamGet(prefs).SetString("InstallationPath", installation_path)
def getFoamDir():
prefs = getPreferencesLocation()
# Get OpenFOAM install path from parameters
installation_path = FreeCAD.ParamGet(prefs).GetString("InstallationPath", "")
# Ensure parameters exist for future editing
setFoamDir(installation_path)
# If not specified, try to detect from shell environment settings and defaults
if not installation_path:
installation_path = detectFoamDir()
return installation_path
def getFoamRuntime():
installation_path = getFoamDir()
if not installation_path:
raise IOError("OpenFOAM installation path not set and not detected")
runtime = None
if platform.system() == 'Windows':
if os.path.exists(os.path.join(installation_path, "msys64", "home", "ofuser", ".blueCFDCore")):
runtime = 'BlueCFD'
elif os.path.exists(os.path.join(installation_path, "..", "msys64", "home", "ofuser", ".blueCFDCore")):
runtime = 'BlueCFD2'
elif os.path.exists(os.path.join(installation_path, "msys64", "home", "ofuser")):
runtime = 'MinGW'
elif os.path.exists(os.path.join(installation_path, "Windows", "Scripts")):
runtime = 'WindowsDocker'
elif os.path.exists(os.path.join(getFoamDir(), "etc", "bashrc")):
runtime = 'BashWSL'
else:
if os.path.exists(os.path.join(getFoamDir(), "etc", "bashrc")):
runtime = 'Posix'
if not runtime:
raise IOError("The directory {} is not a recognised OpenFOAM installation".format(installation_path))
return runtime
def detectFoamDir():
""" Try to guess Foam install dir from WM_PROJECT_DIR or, failing that, various defaults """
foam_dir = None
if platform.system() == "Linux":
cmdline = ['bash', '-l', '-c', 'echo $WM_PROJECT_DIR']
foam_dir = subprocess.check_output(cmdline, stderr=subprocess.PIPE, universal_newlines=True)
if len(foam_dir) > 1: # If env var is not defined, `\n` returned
foam_dir = foam_dir.strip() # Python2: Strip EOL char
else:
foam_dir = None
if foam_dir and not os.path.exists(os.path.join(foam_dir, "etc", "bashrc")):
foam_dir = None
if not foam_dir:
for d in FOAM_DIR_DEFAULTS[platform.system()]:
foam_dir = os.path.expanduser(d)
if foam_dir and not os.path.exists(foam_dir):
foam_dir = None
else:
break
return foam_dir
def setParaviewPath(paraview_path):
prefs = getPreferencesLocation()
# Set Paraview install path in parameters
FreeCAD.ParamGet(prefs).SetString("ParaviewPath", paraview_path)
def getParaviewPath():
prefs = getPreferencesLocation()
# Get path from parameters
paraview_path = FreeCAD.ParamGet(prefs).GetString("ParaviewPath", "")
# Ensure parameters exist for future editing
setParaviewPath(paraview_path)
return paraview_path
def translatePath(p):
""" Transform path to the perspective of the Linux subsystem in which OpenFOAM is run (e.g. mingw) """
if platform.system() == 'Windows':
return fromWindowsPath(p)
else:
return p
def reverseTranslatePath(p):
""" Transform path from the perspective of the OpenFOAM subsystem to the host system """
if platform.system() == 'Windows':
return toWindowsPath(p)
else:
return p
def fromWindowsPath(p):
drive, tail = os.path.splitdrive(p)
pp = tail.replace('\\', '/')
if getFoamRuntime() == "MinGW" or getFoamRuntime() == "BlueCFD" or getFoamRuntime() == "BlueCFD2":
# Under mingw: c:\path -> /c/path
if os.path.isabs(p):
return "/" + (drive[:-1]).lower() + pp
else:
return pp
elif getFoamRuntime() == "WindowsDocker":
# Under docker: <userDir>/<path> -> /home/ofuser/workingDir/<path>
if os.path.isabs(p):
homepath = os.path.expanduser('~')
try:
if os.path.commonpath((os.path.normpath(p), homepath)) == homepath:
return '/home/ofuser/workingDir/' + os.path.relpath(p, homepath).replace('\\', '/')
else:
raise ValueError("The path {} is not inside the users's home directory.".format(p))
except ValueError:
cfdError(
"The path {} cannot be used in the Docker environment. "
"Only paths inside the user's home directory are accessible.".format(p))
raise
else:
return pp
elif getFoamRuntime() == "BashWSL":
# bash on windows: C:\Path -> /mnt/c/Path
if os.path.isabs(p):
return "/mnt/" + (drive[:-1]).lower() + pp
else:
return pp
else: # Nothing needed for posix
return p
def toWindowsPath(p):
pp = p.split('/')
if getFoamRuntime() == "MinGW":
# Under mingw: /c/path -> c:\path; /home/ofuser -> <instDir>/msys64/home/ofuser
if p.startswith('/home/ofuser'):
return getFoamDir() + '\\msys64\\home\\ofuser\\' + '\\'.join(pp[3:])
elif p.startswith('/'):
return pp[1].upper() + ':\\' + '\\'.join(pp[2:])
else:
return p.replace('/', '\\')
elif getFoamRuntime() == "WindowsDocker":
# Under docker: /home/ofuser/workingDir/<path> -> <userDir>/<path>
homepath = os.path.expanduser('~')
if p.startswith('/home/ofuser/workingDir/'):
return os.path.join(homepath, "\\".join(pp[4:]))
else:
return p.replace('/', '\\')
elif getFoamRuntime() == "BashWSL":
# bash on windows: /mnt/c/Path -> C:\Path
if p.startswith('/mnt/'):
return pp[2].toupper() + ':\\' + '\\'.join(pp[3:])
else:
return p.replace('/', '\\')
elif getFoamRuntime().startswith("BlueCFD"):
# Under blueCFD (mingw): /c/path -> c:\path; /home/ofuser/blueCFD -> <blueCFDDir>
if p.startswith('/home/ofuser/blueCFD'):
if getFoamRuntime() == "BlueCFD2":
foam_dir = getFoamDir() + '\\' + '..'
else:
foam_dir = getFoamDir()
return foam_dir + '\\' + '\\'.join(pp[4:])
elif p.startswith('/'):
return pp[1].upper() + ':\\' + '\\'.join(pp[2:])
else:
return p.replace('/', '\\')
else: # Nothing needed for posix
return p
def getShortWindowsPath(long_name):
"""
Gets the short path name of a given long path.
http://stackoverflow.com/a/23598461/200291
"""
import ctypes
from ctypes import wintypes
_GetShortPathNameW = ctypes.windll.kernel32.GetShortPathNameW
_GetShortPathNameW.argtypes = [wintypes.LPCWSTR, wintypes.LPWSTR, wintypes.DWORD]
_GetShortPathNameW.restype = wintypes.DWORD
output_buf_size = 0
while True:
output_buf = ctypes.create_unicode_buffer(output_buf_size)
needed = _GetShortPathNameW(os.path.normpath(long_name), output_buf, output_buf_size)
if output_buf_size >= needed:
return output_buf.value
else:
output_buf_size = needed
def getRunEnvironment():
""" Return native environment settings necessary for running on relevant platform """
if getFoamRuntime() == "MinGW":
return {"MSYSTEM": "MSYS",
"USERNAME": "ofuser",
"USER": "ofuser",
"HOME": "/home/ofuser"}
elif getFoamRuntime().startswith("BlueCFD"):
return {"MSYSTEM": "MINGW64",
"USERNAME": "ofuser",
"USER": "ofuser",
"HOME": "/home/ofuser"}
else:
return {}
def makeRunCommand(cmd, dir, source_env=True):
""" Generate native command to run the specified Linux command in the relevant environment,
including changing to the specified working directory if applicable
"""
installation_path = getFoamDir()
if installation_path is None:
raise IOError("OpenFOAM installation directory not found")
source = ""
if source_env:
env_setup_script = "{}/etc/bashrc".format(installation_path)
source = 'source "{}" && '.format(env_setup_script)
cd = ""
if dir:
cd = 'cd "{}" && '.format(translatePath(dir))
if getFoamRuntime() == "MinGW":
# .bashrc will exit unless shell is interactive, so we have to manually load the foam bashrc
foamVersion = os.path.split(installation_path)[-1].lstrip('v')
cmdline = ['{}\\msys64\\usr\\bin\\bash'.format(installation_path), '--login', '-O', 'expand_aliases', '-c',
'echo Sourcing OpenFOAM environment...; '
'source $HOME/OpenFOAM/OpenFOAM-v{}/etc/bashrc; '.format(foamVersion) +
'export PATH=$FOAM_LIBBIN/msmpi:$FOAM_LIBBIN:$WM_THIRD_PARTY_DIR/platforms/linux64MingwDPInt32/lib:$PATH; '
+ cd + cmd]
return cmdline
if getFoamRuntime() == "WindowsDocker":
foamVersion = os.path.split(installation_path)[-1].lstrip('v')
cmdline = ['powershell.exe',
'docker-machine.exe start default; '
'docker-machine.exe env --shell powershell default | Invoke-Expression; '
'docker start of_{}; '.format(foamVersion) +
'docker exec --privileged of_{} '.format(foamVersion) +
'bash -c "su -c \'' + # $ -> `$: escaping for powershell
(cd + cmd).replace('$', '`$').replace('"', '\\`"') + # Escape quotes for powershell and also cmdline to bash
'\' -l ofuser"']
return cmdline
elif getFoamRuntime() == "BashWSL":
cmdline = ['bash', '-c', source + cd + cmd]
return cmdline
elif getFoamRuntime().startswith("BlueCFD"):
# Set-up necessary for running a command - only needs doing once, but to be safe...
if getFoamRuntime() == "BlueCFD2":
inst_path = "{}\\..".format(installation_path)
else:
inst_path = "{}".format(installation_path)
short_bluecfd_path = getShortWindowsPath(inst_path)
with open('{}\\msys64\\home\\ofuser\\.blueCFDOrigin'.format(inst_path), "w") as f:
f.write(short_bluecfd_path)
f.close()
# Note: Prefixing bash call with the *short* path can prevent errors due to spaces in paths
# when running linux tools - specifically when building
cmdline = ['{}\\msys64\\usr\\bin\\bash'.format(short_bluecfd_path), '--login', '-O', 'expand_aliases', '-c',
cd + cmd]
return cmdline
else:
cmdline = ['bash', '-c', source + cd + cmd]
return cmdline
def runFoamCommand(cmdline, case=None):
""" Run a command in the OpenFOAM environment and wait until finished. Return output.
Also print output as we go.
cmdline - The command line to run as a string
e.g. transformPoints -scale "(0.001 0.001 0.001)"
case - Case directory or path
"""
proc = CfdSynchronousFoamProcess()
exit_code = proc.run(cmdline, case)
# Reproduce behaviour of failed subprocess run
if exit_code:
raise subprocess.CalledProcessError(exit_code, cmdline)
return proc.output
class CfdSynchronousFoamProcess:
def __init__(self):
self.process = CfdConsoleProcess.CfdConsoleProcess(stdoutHook=self.readOutput, stderrHook=self.readOutput)
self.output = ""
def run(self, cmdline, case=None):
print("Running ", cmdline)
self.process.start(makeRunCommand(cmdline, case), env_vars=getRunEnvironment())
if not self.process.waitForFinished():
raise Exception("Unable to run command " + cmdline)
return self.process.exitCode()
def readOutput(self, output):
self.output += output
def startFoamApplication(cmd, case, log_name='', finishedHook=None, stdoutHook=None, stderrHook=None):
""" Run command cmd in OpenFOAM environment, sending output to log file.
Returns a CfdConsoleProcess object after launching
cmd - List or string with the application being the first entry followed by the options.
e.g. ['transformPoints', '-scale', '"(0.001 0.001 0.001)"']
case - Case path
log_name - File name to pipe output to, if not None. If zero-length string, will generate automatically
as log.<application> where <application> is the first element in cmd.
"""
if isinstance(cmd, list) or isinstance(cmd, tuple):
cmds = cmd
elif isinstance(cmd, str):
cmds = cmd.split(' ') # Insensitive to incorrect split like space and quote
else:
raise Exception("Error: Application and options must be specified as a list or tuple.")
if log_name == '':
app = cmds[0].rsplit('/', 1)[-1]
logFile = "log.{}".format(app)
else:
logFile = log_name
cmdline = ' '.join(cmds) # Space to separate options
# Pipe to log file and terminal
if logFile:
cmdline += " 1> >(tee -a " + logFile + ") 2> >(tee -a " + logFile + " >&2)"
# Tee appends to the log file, so we must remove first. Can't do directly since
# paths may be specified using variables only available in foam runtime environment.
cmdline = "{{ rm {}; {}; }}".format(logFile, cmdline)
proc = CfdConsoleProcess.CfdConsoleProcess(finishedHook=finishedHook, stdoutHook=stdoutHook, stderrHook=stderrHook)
if logFile:
print("Running ", ' '.join(cmds), " -> ", logFile)
else:
print("Running ", ' '.join(cmds))
proc.start(makeRunCommand(cmdline, case), env_vars=getRunEnvironment())
if not proc.waitForStarted():
raise Exception("Unable to start command " + ' '.join(cmds))
return proc
def runFoamApplication(cmd, case, log_name=''):
""" Same as startFoamApplication, but waits until complete. Returns exit code. """
proc = startFoamApplication(cmd, case, log_name)
proc.waitForFinished()
return proc.exitCode()
def convertMesh(case, mesh_file, scale):
""" Convert gmsh created UNV mesh to FOAM. A scaling of 1e-3 is prescribed as the CAD is always in mm while FOAM
uses SI units (m). """
if mesh_file.find(".unv") > 0:
mesh_file = translatePath(mesh_file)
cmdline = ['ideasUnvToFoam', '"{}"'.format(mesh_file)]
runFoamApplication(cmdline, case)
# changeBoundaryType(case, 'defaultFaces', 'wall') # rename default boundary type to wall
# Set in the correct patch types
cmdline = ['changeDictionary']
runFoamApplication(cmdline, case)
else:
raise Exception("Error: Only supporting unv mesh files.")
if scale and isinstance(scale, numbers.Number):
cmdline = ['transformPoints', '-scale', '"({} {} {})"'.format(scale, scale, scale)]
runFoamApplication(cmdline, case)
else:
print("Error: mesh scaling ratio is must be a float or integer\n")
def checkCfdDependencies(term_print=True):
FC_MAJOR_VER_REQUIRED = 0
FC_MINOR_VER_REQUIRED = 17
FC_PATCH_VER_REQUIRED = 0
FC_COMMIT_REQUIRED = 14304
CF_MAJOR_VER_REQUIRED = 1
CF_MINOR_VER_REQUIRED = 6
HISA_MAJOR_VER_REQUIRED = 1
HISA_MINOR_VER_REQUIRED = 2
HISA_PATCH_VER_REQUIRED = 1
message = ""
FreeCAD.Console.PrintMessage("Checking CFD workbench dependencies...\n")
# Check FreeCAD version
if term_print:
print("Checking FreeCAD version")
ver = FreeCAD.Version()
major_ver = int(ver[0])
minor_vers = ver[1].split('.')
minor_ver = int(minor_vers[0])
if minor_vers[1:] and minor_vers[1]:
patch_ver = int(minor_vers[1])
else:
patch_ver = 0
gitver = ver[2].split()
if gitver:
gitver = gitver[0]
if gitver and gitver != 'Unknown':
gitver = int(gitver)
else:
# If we don't have the git version, assume it's OK.
gitver = FC_COMMIT_REQUIRED
if (major_ver < FC_MAJOR_VER_REQUIRED or
(major_ver == FC_MAJOR_VER_REQUIRED and
(minor_ver < FC_MINOR_VER_REQUIRED or
(minor_ver == FC_MINOR_VER_REQUIRED and
(patch_ver < FC_PATCH_VER_REQUIRED or
(patch_ver == FC_PATCH_VER_REQUIRED and
gitver < FC_COMMIT_REQUIRED)))))):
fc_msg = "FreeCAD version ({}.{}.{}) ({}) must be at least {}.{}.{} ({})".format(
int(ver[0]), minor_ver, patch_ver, gitver,
FC_MAJOR_VER_REQUIRED, FC_MINOR_VER_REQUIRED, FC_PATCH_VER_REQUIRED, FC_COMMIT_REQUIRED)
if term_print:
print(fc_msg)
message += fc_msg + '\n'
# check openfoam
if term_print:
print("Checking for OpenFOAM:")
try:
foam_dir = getFoamDir()
if term_print:
print("OpenFOAM directory: {}".format(foam_dir))
print("System: {}".format(platform.system()))
print("Runtime: {}".format(getFoamRuntime()))
except IOError as e:
ofmsg = "Could not find OpenFOAM installation: " + str(e)
if term_print:
print(ofmsg)
message += ofmsg + '\n'
else:
if not foam_dir:
ofmsg = "OpenFOAM installation path not set and OpenFOAM environment neither pre-loaded before " + \
"running FreeCAD nor detected in standard locations"
if term_print:
print(ofmsg)
message += ofmsg + '\n'
else:
try:
foam_ver = runFoamCommand("echo $WM_PROJECT_VERSION")
except Exception as e:
runmsg = "OpenFOAM installation found, but unable to run command: " + str(e)
message += runmsg + '\n'
if term_print:
print(runmsg)
raise
else:
foam_ver = foam_ver.rstrip().split()[-1]
if foam_ver != 'dev' and foam_ver != 'plus':
try:
# Isolate major version number
foam_ver = foam_ver.lstrip('v')
foam_ver = int(foam_ver.split('.')[0])
if foam_ver >= 1000: # Plus version
if foam_ver < 1706:
vermsg = "OpenFOAM version " + foam_ver + " is outdated:\n" + \
"Minimum version 1706 or 5.0 required"
message += vermsg + "\n"
if term_print:
print(vermsg)
else: # Foundation version
if foam_ver < 5:
vermsg = "OpenFOAM version " + foam_ver + " is outdated:\n" + \
"Minimum version 5.0 or 1706 required"
message += vermsg + "\n"
if term_print:
print(vermsg)
except ValueError:
vermsg = "Error parsing OpenFOAM version string " + foam_ver
message += vermsg + "\n"
if term_print:
print(vermsg)
# Check for cfMesh
try:
cfmesh_ver = runFoamCommand("cartesianMesh -version")
cfmesh_ver = cfmesh_ver.rstrip().split()[-1]
cfmesh_ver = cfmesh_ver.split('.')
if (not cfmesh_ver or len(cfmesh_ver) != 2 or
int(cfmesh_ver[0]) < CF_MAJOR_VER_REQUIRED or
(int(cfmesh_ver[0]) == CF_MAJOR_VER_REQUIRED and
int(cfmesh_ver[1]) < CF_MINOR_VER_REQUIRED)):
vermsg = "cfMesh-CfdOF version {}.{} required".format(CF_MAJOR_VER_REQUIRED,
CF_MINOR_VER_REQUIRED)
message += vermsg + "\n"
if term_print:
print(vermsg)
except subprocess.CalledProcessError:
cfmesh_msg = "cfMesh (CfdOF version) not found"
message += cfmesh_msg + '\n'
if term_print:
print(cfmesh_msg)
# Check for HiSA
try:
hisa_ver = runFoamCommand("hisa -version")
hisa_ver = hisa_ver.rstrip().split()[-1]
hisa_ver = hisa_ver.split('.')
if (not hisa_ver or len(hisa_ver) != 3 or
int(hisa_ver[0]) < HISA_MAJOR_VER_REQUIRED or
(int(hisa_ver[0]) == HISA_MAJOR_VER_REQUIRED and
(int(hisa_ver[1]) < HISA_MINOR_VER_REQUIRED or
(int(hisa_ver[1]) == HISA_MINOR_VER_REQUIRED and
int(hisa_ver[2]) < HISA_PATCH_VER_REQUIRED)))):
vermsg = "HiSA version {}.{}.{} required".format(HISA_MAJOR_VER_REQUIRED,
HISA_MINOR_VER_REQUIRED,
HISA_PATCH_VER_REQUIRED)
message += vermsg + "\n"
if term_print:
print(vermsg)
except subprocess.CalledProcessError:
hisa_msg = "HiSA not found"
message += hisa_msg + '\n'
if term_print:
print(hisa_msg)
# Check for paraview
if term_print:
print("Checking for paraview:")
paraview_cmd = getParaviewExecutable()
failed = False
if not paraview_cmd:
paraview_cmd = 'paraview'
# If not found, try to run from the OpenFOAM environment, in case a bundled version is
# available from there
try:
runFoamCommand("which paraview")
except subprocess.CalledProcessError:
failed = True
if failed or not os.path.exists(paraview_cmd):
pv_msg = "Paraview executable '" + paraview_cmd + "' not found."
message += pv_msg + '\n'
if term_print:
print(pv_msg)
if term_print:
print("Checking for Plot workbench:")
try:
from freecad.plot import Plot
except ImportError:
plot_msg = "Could not load Plot workbench\nPlease install it using Tools | Addon manager"
message += plot_msg + '\n'
if term_print:
print(plot_msg)
try:
import matplotlib
except ImportError:
matplot_msg = "Could not load matplotlib package (required by Plot workbench)"
message += matplot_msg + '\n'
if term_print:
print(matplot_msg)
if term_print:
print("Checking for gmsh:")
# check that gmsh version 2.13 or greater is installed
gmshversion = ""
if platform.system() == "Windows":
# Use forward slashes to avoid escaping problems
gmsh_exe = '/'.join([FreeCAD.getHomePath(), 'bin', 'gmsh.exe'])
else:
gmsh_exe = shutil.which("gmsh")
if gmsh_exe is None:
gmsh_msg = "gmsh not found"
message += gmsh_msg + '\n'
if term_print:
print(gmsh_msg)
else:
try:
# Needs to be runnable from OpenFOAM environment
gmshversion = runFoamCommand(gmsh_exe + " -version")
except (OSError, subprocess.CalledProcessError):
gmsh_msg = "gmsh could not be run from OpenFOAM environement"
message += gmsh_msg + '\n'
if term_print:
print(gmsh_msg)
if len(gmshversion) > 1:
# Only the last line contains gmsh version number
gmshversion = gmshversion.rstrip().split()
gmshversion = gmshversion[-1]
versionlist = gmshversion.split(".")
if int(versionlist[0]) < 2 or (int(versionlist[0]) == 2 and int(versionlist[1]) < 13):
gmsh_ver_msg = "gmsh version is older than minimum required (2.13)"
message += gmsh_ver_msg + '\n'
if term_print:
print(gmsh_ver_msg)
if term_print:
print("Completed CFD dependency check")
return message
def getParaviewExecutable():
# If path of paraview executable specified, use that
paraview_cmd = getParaviewPath()
if not paraview_cmd:
# If using blueCFD, use paraview supplied
if getFoamRuntime() == 'BlueCFD':
paraview_cmd = '{}\\AddOns\\ParaView\\bin\\paraview.exe'.format(getFoamDir())
elif getFoamRuntime() == 'BlueCFD2':
paraview_cmd = '{}\\..\\AddOns\\ParaView\\bin\\paraview.exe'.format(getFoamDir())
else:
# Go through the defaults and see if any are found
for d in PARAVIEW_PATH_DEFAULTS[platform.system()]:
paraview_cmd = os.path.expanduser(d)
if paraview_cmd and not os.path.exists(paraview_cmd):
paraview_cmd = None
else:
break
if not paraview_cmd:
# Otherwise, see if the command 'paraview' is in the path.
paraview_cmd = shutil.which("paraview")
return paraview_cmd
def startParaview(case_path, script_name, consoleMessageFn):
proc = QtCore.QProcess()
paraview_cmd = getParaviewExecutable()
arg = '--script={}'.format(script_name)
if not paraview_cmd:
# If not found, try to run from the OpenFOAM environment, in case a bundled version is available from there
paraview_cmd = "$(which paraview)" # 'which' required due to mingw weirdness(?) on Windows
try:
consoleMessageFn("Running " + paraview_cmd + " " + arg)
proc = startFoamApplication([paraview_cmd, arg], case_path, log_name=None)
consoleMessageFn("Paraview started")
except QtCore.QProcess.ProcessError:
consoleMessageFn("Error starting paraview")
else: