/
openfoam.py
590 lines (514 loc) · 28.4 KB
/
openfoam.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
##
# Copyright 2009-2024 Ghent University
#
# This file is part of EasyBuild,
# originally created by the HPC team of Ghent University (http://ugent.be/hpc/en),
# with support of Ghent University (http://ugent.be/hpc),
# the Flemish Supercomputer Centre (VSC) (https://www.vscentrum.be),
# Flemish Research Foundation (FWO) (http://www.fwo.be/en)
# and the Department of Economy, Science and Innovation (EWI) (http://www.ewi-vlaanderen.be/en).
#
# https://github.com/easybuilders/easybuild
#
# EasyBuild is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation v2.
#
# EasyBuild 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with EasyBuild. If not, see <http://www.gnu.org/licenses/>.
##
"""
EasyBuild support for building and installing OpenFOAM, implemented as an easyblock
@author: Stijn De Weirdt (Ghent University)
@author: Dries Verdegem (Ghent University)
@author: Kenneth Hoste (Ghent University)
@author: Pieter De Baets (Ghent University)
@author: Jens Timmerman (Ghent University)
@author: Xavier Besseron (University of Luxembourg)
@author: Ward Poelmans (Ghent University)
@author: Balazs Hajgato (Free University Brussels (VUB))
"""
import glob
import os
import re
import shutil
import stat
import tempfile
from easybuild.tools import LooseVersion
import easybuild.tools.environment as env
import easybuild.tools.toolchain as toolchain
from easybuild.easyblocks.generic.cmakemake import setup_cmake_env
from easybuild.framework.easyblock import EasyBlock
from easybuild.tools.build_log import EasyBuildError
from easybuild.tools.filetools import adjust_permissions, apply_regex_substitutions, mkdir
from easybuild.tools.modules import get_software_root, get_software_version
from easybuild.tools.run import run_cmd, run_cmd_qa
from easybuild.tools.systemtools import get_shared_lib_ext, get_cpu_architecture, AARCH64, POWER
class EB_OpenFOAM(EasyBlock):
"""Support for building and installing OpenFOAM."""
def __init__(self, *args, **kwargs):
"""Specify that OpenFOAM should be built in install dir."""
super(EB_OpenFOAM, self).__init__(*args, **kwargs)
self.build_in_installdir = True
self.openfoamdir = None
self.thrdpartydir = None
# version may start with 'v' for some variants of OpenFOAM
# we need to strip this off to avoid problems when comparing LooseVersion instances in Python 3
clean_version = self.version.strip('v+')
# take into account versions like '4.x',
# assume it's equivalent to a very recent minor version (.99)
if '.x' in clean_version:
clean_version = clean_version.replace('.x', '.99')
self.looseversion = LooseVersion(clean_version)
self.is_extend = 'extend' in self.name.lower()
self.is_dot_com = self.looseversion >= LooseVersion('1606')
self.is_dot_org = self.looseversion <= LooseVersion('100')
if self.is_extend:
if self.looseversion >= LooseVersion('3.0'):
self.openfoamdir = 'foam-extend-%s' % self.version
else:
self.openfoamdir = 'OpenFOAM-%s-ext' % self.version
else:
self.openfoamdir = '-'.join([self.name, '-'.join(self.version.split('-')[:2])])
self.log.debug("openfoamdir: %s" % self.openfoamdir)
# Set build type to requested value
if self.toolchain.options['debug']:
self.build_type = 'Debug'
else:
self.build_type = 'Opt'
# determine values for wm_compiler and wm_mplib
comp_fam = self.toolchain.comp_family()
if comp_fam == toolchain.GCC: # @UndefinedVariable
self.wm_compiler = 'Gcc'
elif comp_fam == toolchain.INTELCOMP: # @UndefinedVariable
self.wm_compiler = 'Icc'
else:
raise EasyBuildError("Unknown compiler family, don't know how to set WM_COMPILER")
# set to an MPI unknown by OpenFOAM, since we're handling the MPI settings ourselves (via mpicc, etc.)
# Note: this name must contain 'MPI' so the MPI version of the
# Pstream library is built (cf src/Pstream/Allwmake)
self.wm_mplib = "EASYBUILDMPI"
def extract_step(self):
"""Extract sources as expected by the OpenFOAM(-Extend) build scripts."""
super(EB_OpenFOAM, self).extract_step()
# make sure that the expected subdir is really there after extracting
# if not, the build scripts (e.g., the etc/bashrc being sourced) will likely fail
openfoam_installdir = os.path.join(self.installdir, self.openfoamdir)
if not os.path.exists(openfoam_installdir):
self.log.warning("Creating expected directory %s, and moving everything there" % openfoam_installdir)
try:
contents_installdir = os.listdir(self.installdir)
source = os.path.join(self.installdir, contents_installdir[0])
# it's one directory but has a wrong name
if len(contents_installdir) == 1 and os.path.isdir(source):
target = os.path.join(self.installdir, self.openfoamdir)
self.log.debug("Renaming %s to %s", source, target)
os.rename(source, target)
else:
mkdir(openfoam_installdir)
for fil in contents_installdir:
if fil != self.openfoamdir:
source = os.path.join(self.installdir, fil)
target = os.path.join(openfoam_installdir, fil)
self.log.debug("Moving %s to %s", source, target)
shutil.move(source, target)
os.chdir(openfoam_installdir)
except OSError as err:
raise EasyBuildError("Failed to move all files to %s: %s", openfoam_installdir, err)
def patch_step(self, beginpath=None):
"""Adjust start directory and start path for patching to correct directory."""
self.cfg['start_dir'] = os.path.join(self.installdir, self.openfoamdir)
super(EB_OpenFOAM, self).patch_step(beginpath=self.cfg['start_dir'])
def configure_step(self):
"""Configure OpenFOAM build by setting appropriate environment variables."""
# compiler & compiler flags
comp_fam = self.toolchain.comp_family()
extra_flags = ''
if comp_fam == toolchain.GCC: # @UndefinedVariable
if get_software_version('GCC') >= LooseVersion('4.8'):
# make sure non-gold version of ld is used, since OpenFOAM requires it
# see http://www.openfoam.org/mantisbt/view.php?id=685
extra_flags = '-fuse-ld=bfd'
# older versions of OpenFOAM-Extend require -fpermissive
if self.is_extend and self.looseversion < LooseVersion('2.0'):
extra_flags += ' -fpermissive'
if self.looseversion < LooseVersion('3.0'):
extra_flags += ' -fno-delete-null-pointer-checks'
elif comp_fam == toolchain.INTELCOMP: # @UndefinedVariable
# make sure -no-prec-div is used with Intel compilers
extra_flags = '-no-prec-div'
for env_var in ['CFLAGS', 'CXXFLAGS']:
env.setvar(env_var, "%s %s" % (os.environ.get(env_var, ''), extra_flags))
# patch out hardcoding of WM_* environment variables
# for example, replace 'export WM_COMPILER=Gcc' with ': ${WM_COMPILER:=Gcc}; export WM_COMPILER'
for script in [os.path.join(self.builddir, self.openfoamdir, x) for x in ['etc/bashrc', 'etc/cshrc']]:
self.log.debug("Patching out hardcoded $WM_* env vars in %s", script)
# disable any third party stuff, we use EB controlled builds
regex_subs = [(r"^(setenv|export) WM_THIRD_PARTY_USE_.*[ =].*$", r"# \g<0>")]
# this does not work for OpenFOAM Extend lower than 2.0
if not self.is_extend or self.looseversion >= LooseVersion('2.0'):
key = "WM_PROJECT_VERSION"
regex_subs += [(r"^(setenv|export) %s=.*$" % key, r"export %s=%s #\g<0>" % (key, self.version))]
WM_env_var = ['WM_COMPILER', 'WM_COMPILE_OPTION', 'WM_MPLIB', 'WM_THIRD_PARTY_DIR']
# OpenFOAM >= 3.0.0 can use 64 bit integers
if not self.is_extend and self.looseversion >= LooseVersion('3.0'):
WM_env_var.append('WM_LABEL_SIZE')
for env_var in WM_env_var:
regex_subs.append((r"^(setenv|export) (?P<var>%s)[ =](?P<val>.*)$" % env_var,
r": ${\g<var>:=\g<val>}; export \g<var>"))
apply_regex_substitutions(script, regex_subs)
# inject compiler variables into wmake/rules files
ldirs = glob.glob(os.path.join(self.builddir, self.openfoamdir, 'wmake', 'rules', 'linux*'))
if self.looseversion >= LooseVersion('1906'):
ldirs += glob.glob(os.path.join(self.builddir, self.openfoamdir, 'wmake', 'rules', 'General', '*'))
langs = ['c', 'c++']
# NOTE: we do not want to change the Debug rules files becuse
# that would change the cOPT/c++OPT values from their empty setting.
suffixes = ['', 'Opt']
wmake_rules_files = [os.path.join(ldir, lang + suff) for ldir in ldirs for lang in langs for suff in suffixes]
wmake_rules_files += [os.path.join(ldir, "general") for ldir in ldirs]
mpicc = os.environ['MPICC']
mpicxx = os.environ['MPICXX']
cc_seq = os.environ.get('CC_SEQ', os.environ['CC'])
cxx_seq = os.environ.get('CXX_SEQ', os.environ['CXX'])
if self.toolchain.mpi_family() == toolchain.OPENMPI:
# no -cc/-cxx flags supported in OpenMPI compiler wrappers
c_comp_cmd = 'OMPI_CC="%s" %s' % (cc_seq, mpicc)
cxx_comp_cmd = 'OMPI_CXX="%s" %s' % (cxx_seq, mpicxx)
else:
# -cc/-cxx should work for all MPICH-based MPIs (including Intel MPI)
c_comp_cmd = '%s -cc="%s"' % (mpicc, cc_seq)
cxx_comp_cmd = '%s -cxx="%s"' % (mpicxx, cxx_seq)
comp_vars = {
# specify MPI compiler wrappers and compiler commands + sequential compiler that should be used by them
'cc': c_comp_cmd,
'CC': cxx_comp_cmd,
'cOPT': os.environ['CFLAGS'],
'c++OPT': os.environ['CXXFLAGS'],
}
for wmake_rules_file in wmake_rules_files:
# the cOpt and c++Opt files don't exist in the General directories (which are included for recent versions)
if not os.path.isfile(wmake_rules_file):
continue
fullpath = os.path.join(self.builddir, self.openfoamdir, wmake_rules_file)
self.log.debug("Patching compiler variables in %s", fullpath)
regex_subs = []
for comp_var, newval in comp_vars.items():
regex_subs.append((r"^(%s\s*(=|:=)\s*).*$" % re.escape(comp_var), r"\1%s" % newval))
# replace /lib/cpp by cpp, but keep the arguments
regex_subs.append((r"^(CPP\s*(=|:=)\s*)/lib/cpp(.*)$", r"\1cpp\2"))
apply_regex_substitutions(fullpath, regex_subs)
# enable verbose build for debug purposes
# starting with openfoam-extend 3.2, PS1 also needs to be set
env.setvar("FOAM_VERBOSE", '1')
# installation directory
env.setvar("FOAM_INST_DIR", self.installdir)
# third party directory
self.thrdpartydir = "ThirdParty-%s" % self.version
# only if third party stuff is actually installed
if os.path.exists(self.thrdpartydir):
os.symlink(os.path.join("..", self.thrdpartydir), self.thrdpartydir)
env.setvar("WM_THIRD_PARTY_DIR", os.path.join(self.installdir, self.thrdpartydir))
env.setvar("WM_COMPILER", self.wm_compiler)
env.setvar("WM_MPLIB", self.wm_mplib)
# Set Compile options according to build type
env.setvar("WM_COMPILE_OPTION", self.build_type)
# parallel build spec
env.setvar("WM_NCOMPPROCS", str(self.cfg['parallel']))
# OpenFOAM >= 3.0.0 can use 64 bit integers
if not self.is_extend and self.looseversion >= LooseVersion('3.0'):
if self.toolchain.options['i8']:
env.setvar("WM_LABEL_SIZE", '64')
else:
env.setvar("WM_LABEL_SIZE", '32')
# make sure lib/include dirs for dependencies are found
openfoam_extend_v3 = self.is_extend and self.looseversion >= LooseVersion('3.0')
if self.looseversion < LooseVersion("2") or openfoam_extend_v3:
self.log.debug("List of deps: %s" % self.cfg.dependencies())
for dep in self.cfg.dependencies():
dep_name = dep['name'].upper(),
dep_root = get_software_root(dep['name'])
env.setvar("%s_SYSTEM" % dep_name, "1")
dep_vars = {
"%s_DIR": "%s",
"%s_BIN_DIR": "%s/bin",
"%s_LIB_DIR": "%s/lib",
"%s_INCLUDE_DIR": "%s/include",
}
for var, val in dep_vars.items():
env.setvar(var % dep_name, val % dep_root)
else:
for depend in ['SCOTCH', 'METIS', 'CGAL', 'Paraview']:
dependloc = get_software_root(depend)
if dependloc:
if depend == 'CGAL' and get_software_root('Boost'):
env.setvar("CGAL_ROOT", dependloc)
env.setvar("BOOST_ROOT", get_software_root('Boost'))
else:
env.setvar("%s_ROOT" % depend.upper(), dependloc)
def build_step(self):
"""Build OpenFOAM using make after sourcing script to set environment."""
# Some parts of OpenFOAM uses CMake to build
# make sure the basic environment is correct
setup_cmake_env(self.toolchain)
precmd = "source %s" % os.path.join(self.builddir, self.openfoamdir, "etc", "bashrc")
if not self.is_extend and self.looseversion >= LooseVersion('4.0'):
if self.looseversion >= LooseVersion('2006'):
cleancmd = "cd $WM_PROJECT_DIR && wclean -platform -all && cd -"
else:
cleancmd = "cd $WM_PROJECT_DIR && wcleanPlatform -all && cd -"
else:
cleancmd = "wcleanAll"
# make directly in install directory
cmd_tmpl = "%(precmd)s && %(cleancmd)s && %(prebuildopts)s %(makecmd)s" % {
'precmd': precmd,
'cleancmd': cleancmd,
'prebuildopts': self.cfg['prebuildopts'],
'makecmd': os.path.join(self.builddir, self.openfoamdir, '%s'),
}
if self.is_extend and self.looseversion >= LooseVersion('3.0'):
qa = {
"Proceed without compiling ParaView [Y/n]": 'Y',
"Proceed without compiling cudaSolvers? [Y/n]": 'Y',
}
noqa = [
".* -o .*",
"checking .*",
"warning.*",
"configure: creating.*",
"%s .*" % os.environ['CC'],
"wmake .*",
"Making dependency list for source file.*",
r"\s*\^\s*", # warning indicator
"Cleaning .*",
]
run_cmd_qa(cmd_tmpl % 'Allwmake.firstInstall', qa, no_qa=noqa, log_all=True, simple=True, maxhits=500)
else:
cmd = 'Allwmake'
if self.looseversion > LooseVersion('1606'):
# use Allwmake -log option if possible since this can be useful during builds, but also afterwards
cmd += ' -log'
run_cmd(cmd_tmpl % cmd, log_all=True, simple=True, log_output=True)
def det_psubdir(self):
"""Determine the platform-specific installation directory for OpenFOAM."""
# OpenFOAM >= 3.0.0 can use 64 bit integers
# same goes for OpenFOAM-Extend >= 4.1
if self.is_extend:
set_int_size = self.looseversion >= LooseVersion('4.1')
else:
set_int_size = self.looseversion >= LooseVersion('3.0')
if set_int_size:
if self.toolchain.options['i8']:
int_size = 'Int64'
else:
int_size = 'Int32'
else:
int_size = ''
archpart = '64'
arch = get_cpu_architecture()
if arch == AARCH64:
# Variants have different abbreviations for ARM64...
if self.is_dot_org:
archpart = 'Arm64'
else:
archpart = 'ARM64'
elif arch == POWER:
archpart = 'PPC64le'
psubdir = "linux%s%sDP%s%s" % (archpart, self.wm_compiler, int_size, self.build_type)
return psubdir
def install_step(self):
"""Building was performed in install dir, so just fix permissions."""
# fix permissions of OpenFOAM dir
fullpath = os.path.join(self.installdir, self.openfoamdir)
adjust_permissions(fullpath, stat.S_IROTH, add=True, recursive=True, ignore_errors=True)
adjust_permissions(fullpath, stat.S_IXOTH, add=True, recursive=True, onlydirs=True, ignore_errors=True)
# fix permissions of ThirdParty dir and subdirs (also for 2.x)
# if the thirdparty tarball is installed
fullpath = os.path.join(self.installdir, self.thrdpartydir)
if os.path.exists(fullpath):
adjust_permissions(fullpath, stat.S_IROTH, add=True, recursive=True, ignore_errors=True)
adjust_permissions(fullpath, stat.S_IXOTH, add=True, recursive=True, onlydirs=True, ignore_errors=True)
# create symlinks in the lib directory to all libraries in the mpi subdirectory
# to make sure they take precedence over the libraries in the dummy subdirectory
shlib_ext = get_shared_lib_ext()
psubdir = self.det_psubdir()
openfoam_extend_v3 = self.is_extend and self.looseversion >= LooseVersion('3.0')
if openfoam_extend_v3 or self.looseversion < LooseVersion("2"):
libdir = os.path.join(self.installdir, self.openfoamdir, "lib", psubdir)
else:
libdir = os.path.join(self.installdir, self.openfoamdir, "platforms", psubdir, "lib")
# OpenFOAM v2012 puts mpi into eb-mpi
if self.looseversion >= LooseVersion("2012"):
mpilibssubdir = "eb-mpi"
else:
mpilibssubdir = "mpi"
mpilibsdir = os.path.join(libdir, mpilibssubdir)
if os.path.exists(mpilibsdir):
for lib in glob.glob(os.path.join(mpilibsdir, "*.%s" % shlib_ext)):
libname = os.path.basename(lib)
dst = os.path.join(libdir, libname)
os.symlink(os.path.join(mpilibssubdir, libname), dst)
def sanity_check_step(self):
"""Custom sanity check for OpenFOAM"""
shlib_ext = get_shared_lib_ext()
psubdir = self.det_psubdir()
openfoam_extend_v3 = self.is_extend and self.looseversion >= LooseVersion('3.0')
if openfoam_extend_v3 or self.looseversion < LooseVersion("2"):
toolsdir = os.path.join(self.openfoamdir, "applications", "bin", psubdir)
libsdir = os.path.join(self.openfoamdir, "lib", psubdir)
dirs = [toolsdir, libsdir]
else:
toolsdir = os.path.join(self.openfoamdir, "platforms", psubdir, "bin")
libsdir = os.path.join(self.openfoamdir, "platforms", psubdir, "lib")
dirs = [toolsdir, libsdir]
# some randomly selected binaries
# if one of these is missing, it's very likely something went wrong
tools = ["boundaryFoam", "engineFoam", "buoyantSimpleFoam", "buoyantBoussinesqSimpleFoam", "sonicFoam"]
tools += ["surfaceAdd", "surfaceFind", "surfaceSmooth"]
tools += ["blockMesh", "checkMesh", "deformedGeom", "engineSwirl", "modifyMesh", "refineMesh"]
# surfaceSmooth is replaced by surfaceLambdaMuSmooth is OpenFOAM v2.3.0
if not self.is_extend and self.looseversion >= LooseVersion("2.3.0"):
tools.remove("surfaceSmooth")
tools.append("surfaceLambdaMuSmooth")
# sonicFoam and buoyantBoussineqSimpleFoam deprecated in version 7+
if self.is_dot_org and self.looseversion >= LooseVersion('7'):
tools.remove("buoyantBoussinesqSimpleFoam")
tools.remove("sonicFoam")
# engineFoam replaced by reactingFoam and buoyantSimpleFoam replaced by buoyantFoam in version 10
if self.is_dot_org and LooseVersion("10") <= self.looseversion:
tools.remove("buoyantSimpleFoam")
tools.remove("engineFoam")
# both removed in version 11
if self.looseversion < LooseVersion("11"):
tools.append("buoyantFoam")
tools.append("reactingFoam")
bins = [os.path.join(self.openfoamdir, "bin", x) for x in ["paraFoam"]] + \
[os.path.join(toolsdir, x) for x in tools]
# test setting up the OpenFOAM environment in bash shell
load_openfoam_env = "source $FOAM_BASH"
custom_commands = [load_openfoam_env]
# check for the Pstream and scotchDecomp libraries, there must be a dummy one and an mpi one
if self.is_extend:
libs = [os.path.join(libsdir, "libscotchDecomp.%s" % shlib_ext),
os.path.join(libsdir, "libmetisDecomp.%s" % shlib_ext)]
if self.looseversion < LooseVersion('3.2'):
# Pstream should have both a dummy and a mpi one
libs.extend([os.path.join(libsdir, x, "libPstream.%s" % shlib_ext) for x in ["dummy", "mpi"]])
libs.extend([os.path.join(libsdir, "mpi", "libparMetisDecomp.%s" % shlib_ext)])
else:
libs.extend([os.path.join(libsdir, "libparMetisDecomp.%s" % shlib_ext)])
else:
# OpenFOAM v2012 puts mpi into eb-mpi
if self.is_dot_com and self.looseversion >= LooseVersion("2012"):
mpilibssubdir = "eb-mpi"
else:
mpilibssubdir = "mpi"
# there must be a dummy one and an mpi one for both
libs = [os.path.join(libsdir, x, "libPstream.%s" % shlib_ext) for x in ["dummy", mpilibssubdir]] + \
[os.path.join(libsdir, x, "libptscotchDecomp.%s" % shlib_ext) for x in ["dummy", mpilibssubdir]] +\
[os.path.join(libsdir, "libscotchDecomp.%s" % shlib_ext)] + \
[os.path.join(libsdir, "dummy", "libscotchDecomp.%s" % shlib_ext)]
if not self.is_extend and self.looseversion >= LooseVersion("2.4.0"):
# also check for foamMonitor for OpenFOAM versions other than OpenFOAM-Extend
bins.append(os.path.join(self.openfoamdir, 'bin', 'foamMonitor'))
# test foamMonitor; wrap `foamMonitor -h` to generate exit code 1 if any dependency is missing
# the command `foamMonitor -h` does not return correct exit codes on its own in all versions
test_foammonitor = "! foamMonitor -h 2>&1 | grep 'not installed'"
custom_commands.append(' && '.join([load_openfoam_env, test_foammonitor]))
custom_paths = {
'files': [os.path.join(self.openfoamdir, 'etc', x) for x in ["bashrc", "cshrc"]] + bins + libs,
'dirs': dirs,
}
# run motorBike tutorial case to ensure the installation is functional (if it's available);
# only for recent (>= v6.0) versions of openfoam.org variant
if self.is_dot_org and self.looseversion >= LooseVersion('6'):
openfoamdir_path = os.path.join(self.installdir, self.openfoamdir)
if self.looseversion <= LooseVersion('10'):
motorbike_path = os.path.join(
openfoamdir_path, 'tutorials', 'incompressible', 'simpleFoam', 'motorBike'
)
else:
motorbike_path = os.path.join(openfoamdir_path, 'tutorials', 'incompressibleFluid',
'motorBike', 'motorBike')
if os.path.exists(motorbike_path):
test_dir = tempfile.mkdtemp()
if self.looseversion >= LooseVersion('9'):
geom_target_dir = 'geometry'
else:
geom_target_dir = 'triSurface'
else:
raise EasyBuildError("motorBike tutorial not found at %s", motorbike_path)
if self.looseversion <= LooseVersion('10'):
cmds = [
"cp -a %s %s" % (motorbike_path, test_dir),
# Make sure the tmpdir for tests ir writeable if read-only-installdir is used
"chmod -R +w %s" % test_dir,
"cd %s" % os.path.join(test_dir, os.path.basename(motorbike_path)),
"source $FOAM_BASH",
". $WM_PROJECT_DIR/bin/tools/RunFunctions",
"cp $FOAM_TUTORIALS/resources/geometry/motorBike.obj.gz constant/%s/" % geom_target_dir,
"runApplication surfaceFeatures",
"runApplication blockMesh",
"runApplication decomposePar -copyZero",
"runParallel snappyHexMesh -overwrite",
"runParallel patchSummary",
"runParallel potentialFoam",
"runParallel simpleFoam",
"runApplication reconstructParMesh -constant",
"runApplication reconstructPar -latestTime",
"cd %s" % self.builddir,
"rm -r %s" % test_dir,
]
# v11 and above run the motorBike example differently
else:
cmds = [
"cp -a %s %s" % (motorbike_path, test_dir),
# Make sure the tmpdir for tests ir writeable if read-only-installdir is used
"chmod -R +w %s" % os.path.join(test_dir, os.path.basename(motorbike_path)),
"cd %s" % os.path.join(test_dir, os.path.basename(motorbike_path)),
"source $FOAM_BASH",
". $WM_PROJECT_DIR/bin/tools/RunFunctions",
"cp $FOAM_TUTORIALS/resources/geometry/motorBike.obj.gz constant/%s/" % geom_target_dir,
"runApplication blockMesh",
"runApplication decomposePar -copyZero",
"find . -type f -iname '*level*' -exec rm {} \\;",
"runParallel renumberMesh -overwrite",
"runParallel potentialFoam -initialiseUBCs",
"runParallel simpleFoam",
"cd %s" % self.builddir,
"rm -r %s" % test_dir,
]
# all commands need to be run in a single shell command,
# because sourcing $FOAM_BASH sets up environment
custom_commands.append(' && '.join(cmds))
super(EB_OpenFOAM, self).sanity_check_step(custom_paths=custom_paths, custom_commands=custom_commands)
def make_module_extra(self, altroot=None, altversion=None):
"""Define extra environment variables required by OpenFOAM"""
txt = super(EB_OpenFOAM, self).make_module_extra()
env_vars = [
# Set WM_COMPILE_OPTION in the module file
# $FOAM_BASH will then pick it up correctly.
('WM_COMPILE_OPTION', self.build_type),
('WM_PROJECT_VERSION', self.version),
('FOAM_INST_DIR', self.installdir),
('WM_COMPILER', self.wm_compiler),
('WM_MPLIB', self.wm_mplib),
('FOAM_BASH', os.path.join(self.installdir, self.openfoamdir, 'etc', 'bashrc')),
('FOAM_CSH', os.path.join(self.installdir, self.openfoamdir, 'etc', 'cshrc')),
]
# OpenFOAM >= 3.0.0 can use 64 bit integers
if not self.is_extend and self.looseversion >= LooseVersion('3.0'):
if self.toolchain.options['i8']:
env_vars += [('WM_LABEL_SIZE', '64')]
else:
env_vars += [('WM_LABEL_SIZE', '32')]
for (env_var, val) in env_vars:
# check whether value is defined for compatibility with --module-only
if val:
txt += self.module_generator.set_environment(env_var, val)
return txt