DELPHIN 6 Scripting-Tutorial

<InitialConditions>
	<InitialCondition name="Initial moisture content" type="MoistureContent">
		<IBK:Parameter name="Value" unit="m3/m3">0.01</IBK:Parameter>
	</InitialCondition>
</InitialConditions>

<InitialConditions>
	<InitialCondition name="Initial moisture content" type="MoistureContent">
		<IBK:Parameter name="Value" unit="m3/m3">$\{INITIAL_MOISTURE_CONTENT}</IBK:Parameter>
	</InitialCondition>
</InitialConditions>

#!/usr/bin/env python3
# -*- coding: utf-8 -*-

import os, sys
import subprocess

# import IBK utility classes
from IBK import *

# global constants
VARIANTS_SUBDIR = "variants"
DELPHIN_EXECUTABLE = "DelphinSolver"

# get absolute file path to DELPHIN solver (assumed to be inside this directory)
DELPHIN_EXECUTABLE = os.path.join(os.getcwd(), DELPHIN_EXECUTABLE)
if not os.path.exists(DELPHIN_EXECUTABLE):
	print("Missing DELPHIN Solver executable '{}'".format(DELPHIN_EXECUTABLE))
	exit(1)

def read_file(fname):
	try:
		fobj = open(fname, 'r')
		content = fobj.read()
		fobj.close()
		del fobj # release file handle
		return content
	except IOError as e:
		print(str(e))
		raise RuntimeError("Error reading/opening file '{}'".format(fname))

def write_file(fname, contents):
	try:
		fobj = open(fname, 'w')
		fobj.write(contents)
		fobj.close()
		del fobj # release file handle
	except IOError as e:
		print(str(e))
		raise RuntimeError("Error opening file '{}' for writing".format(fname))

# *** main ***

# 1. read template project file
TEMPLATE = read_file('template.d6p')

# 2. create directory for project variants
if not os.path.exists(VARIANTS_SUBDIR):
	os.mkdir(VARIANTS_SUBDIR)

# 3. loop over range of moisture contents - 0.01...0.21 and create project variations
jobs = []
for i in range(20):
	moisture_content = 0.01 + i*0.01

	# replace placeholder text
	variant = TEMPLATE.replace('$\{INITIAL_MOISTURE_CONTENT}','{}'.format(moisture_content))

	# create variant file name, file name pattern = var_xx.d6p  where xx is a zero-leading number
	d6pfile = VARIANTS_SUBDIR + "/var_{:02d}.d6p".format(i)

	# write the file, unless it exists already
	if not os.path.exists(d6pfile):
		write_file(d6pfile, variant)

	# add to list of jobs, unless project was already simulated, use command line arguments -x for windows,
	# and -p=2 for 2 CPUs per job
	if not os.path.exists(d6pfile[:-4] + "/var/restart.bin"):
		jobs.append([DELPHIN_EXECUTABLE, '-x', '--verbosity-level=0', '-p=2', d6pfile])

# 4. run all the jobs, one after another
for job in jobs:
	try:
		print(job[-1])
		solverProcess = subprocess.Popen(job)
		solverProcess.wait()
	except OSError as e:
		print(str(e))

# 4. run all the jobs in parallel
jobRunner = JobRunner(4) # 4 jobs at the same time
jobRunner.run(jobs)

# 5. read all result files and collect results

# create manager for geometry files - actually not used here, but needed by Delphin6OutputFile()
geoManager = Delphin6GeoFileManager()

resultData = []
for i in range(20):
	moisture_content = 0.01 + i*0.01
	d6pfile = VARIANTS_SUBDIR + "/var_{:02d}.d6p".format(i)

	# NOTE: instead of recreating filename and variant here, one could also store this information
	#       in a list and use it here

	# path to result d6o file
	resultFile = d6pfile[:-4] + "/results/Moisture_content_integral.d6o"

	# read file
	d6o = Delphin6OutputFile()
	if not d6o.read(resultFile, geoManager):
		print("Error reading result file '{}'".format(resultFile))
		continue

	# get value for time index #2
	value = d6o.valuesAtIndex(2)

	# store in vector
	resultData.append( (moisture_content, value[0]) )

# 6. create a tsv-file with initial moisture content vs. final content

tsv = "Moisture content [m3/m3]\tFinal moisture mass [kg/m]\n"
for val in resultData:
	tsv = tsv + "{}\t{}\n".format(val[0], val[1])

write_file("results.tsv", tsv)
print("Wrote 'results.tsv'.")

BaseProject/
├── CaSili30_Brick600_1D.d6p
├── DE-01-TRY-2010__Bremerhaven__Jahr_00000K0_00007m.c6b
├── DE-04-TRY-2010__Potsdam__Jahr_00000K0_00081m.c6b
├── DE-15-TRY-2010__Garmisch_Partenkirchen__Jahr_00000K0_00719m.c6b
├── materials
│   ├── Calcium silicate.m6
│   ├── Clinker.m6
│   ├── Glue mortar.m6
│   ├── Historical Brick.m6
│   ├── Lime cement plaster.m6
│   └── template.m6
└── template.d6p

D6MARLZ! 006.001

[IDENTIFICATION]
  NAME                     = EN: Calcium silicate

...

[TRANSPORT_BASE_PARAMETERS]
  LAMBDA                   = $\{LAMBDA} W/mK
  AW                       = 1.24 kg/m2s05
  MEW                      = 5 -
  DLEFF                    = 1.3e-05 m2/s

...

<?xml version="1.0" encoding="UTF-8" ?>
<DelphinProject ... fileVersion="6.1">

...

	<!--Model data, solver settings, general parameters-->
	<Init>
		<SimulationParameter>
			<BalanceEquationModule>BEHeatMoisture</BalanceEquationModule>
			<Interval>
				<IBK:Parameter name="Duration" unit="a">1</IBK:Parameter>
			</Interval>
			<ClimateDataFilePath>$\{Project Directory}/$\{LOCATION}</ClimateDataFilePath>
			<StartYear>2000</StartYear>
			<TimeZone>1</TimeZone>
		</SimulationParameter>
		<SolverParameter>
			<LESSolver>GMRES</LESSolver>
		</SolverParameter>
	</Init>

	<!--~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~-->

	<!--List of all materials used in this construction-->
	<Materials>
		<MaterialReference name="Lime cement plaster" color="#ff80ff80">$\{Project Directory}/materials/Lime cement plaster.m6</MaterialReference>
		<MaterialReference name="Historical Brick" color="#ffff8040">$\{Project Directory}/materials/Historical Brick.m6</MaterialReference>
		<MaterialReference name="Clinker" color="#ffff8080">$\{Project Directory}/materials/Clinker.m6</MaterialReference>
		<MaterialReference name="Glue mortar" color="#ff8080c0">$\{Project Directory}/materials/Glue mortar.m6</MaterialReference>
		<MaterialReference name="Calcium silicate" color="#ff80ffff">${Project Directory}/materials/$\{INSULATION_MATERIAL}</MaterialReference>
	</Materials>

	<!--~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~-->

	<!--Discretization data (grid and sketches)-->
	<Discretization>
		<XSteps unit="m">0.01 $\{INSULATION_LAYER_WIDTH} 0.004 0.012 0.24 0.01 0.24 0.012 0.12 </XSteps>
	</Discretization>

	<!--~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~-->

...

#!/usr/bin/env python3
# -*- coding: utf-8 -*-

import os, sys
import subprocess
from distutils.dir_util import copy_tree

from IBK import *

BASE_SUBDIR = "BaseProject"
VARIANTS_SUBDIR = "variations"

DELPHIN_EXECUTABLE = "DelphinSolver"
DISCTOOL_EXECUTABLE = "CmdDiscretise"

# get absolute file paths tools (assumed to be inside this directory)
DELPHIN_EXECUTABLE = os.path.join(os.getcwd(), DELPHIN_EXECUTABLE)
if not os.path.exists(DELPHIN_EXECUTABLE):
	print("Missing DELPHIN Solver executable '{}'".format(DELPHIN_EXECUTABLE))
	exit(1)

DISCTOOL_EXECUTABLE = os.path.join(os.getcwd(), DISCTOOL_EXECUTABLE)
if not os.path.exists(DISCTOOL_EXECUTABLE):
	print("Missing CmdDiscretize executable '{}'".format(DISCTOOL_EXECUTABLE))
	exit(1)

# list of climate locations to use; store as tuples (file, description)
CLIMATE_FILES = [
    ("DE-01-TRY-2010__Bremerhaven__Jahr_00000K0_00007m.c6b", "Bremerhaven"),
    ("DE-04-TRY-2010__Potsdam__Jahr_00000K0_00081m.c6b", "Potsdam"),
    ("DE-15-TRY-2010__Garmisch_Partenkirchen__Jahr_00000K0_00719m.c6b", "Garmisch")
]

# list of insulation layer thicknesses to use
LAYER_WIDTHS = [ 0.04, 0.05, 0.06, 0.08, 0.10 ]

# insulation properties
LAMBDA = [ 0.04, 0.044, 0.048, 0.053]

def read_file(fname):
	try:
		fobj = open(fname, 'r')
		content = fobj.read()
		fobj.close()
		del fobj # release file handle
		return content
	except IOError as e:
		print(str(e))
		raise RuntimeError("Error reading/opening file '{}'".format(fname))

def write_file(fname, contents):
	try:
		fobj = open(fname, 'w')
		fobj.write(contents)
		fobj.close()
		del fobj # release file handle
	except IOError as e:
		print(str(e))
		raise RuntimeError("Error opening file '{}' for writing".format(fname))

# *** main ***

# 1. read template files
PROJECT_TEMPLATE = read_file(BASE_SUBDIR + '/template.d6p')
MATERIAL_TEMPLATE = read_file(BASE_SUBDIR + '/materials/template.m6')

# 2. create directory for project variants
if not os.path.exists(VARIANTS_SUBDIR):
	os.mkdir(VARIANTS_SUBDIR)

# 3. copy base project directory to variations directory
copy_tree(BASE_SUBDIR, VARIANTS_SUBDIR)

# 4. create material variants
mat_files = []
for lmd in LAMBDA:
	m6file = "casi_{:.3f}.m6".format(lmd) # file name format casi_0.xxx.m6
	mat_files.append(m6file)
	variant = MATERIAL_TEMPLATE.replace('$\{LAMBDA}','{}'.format(lmd))
	# write the file inside the 'materials' subdirectory
	write_file(VARIANTS_SUBDIR + "/materials/" + m6file, variant)

# 3. create project variants
jobs = []
for cli in CLIMATE_FILES:
	for lmdIdx in range(len(LAMBDA)):
		lmd = LAMBDA[lmdIdx]
		m6file = mat_files[lmdIdx]

		for w in LAYER_WIDTHS:

			# replace placeholder texts for climate data file and layer width
			variant = PROJECT_TEMPLATE.replace('$\{LOCATION}','{}'.format(cli[0]))
			variant = variant.replace('$\{INSULATION_MATERIAL}','{}'.format(m6file))
			variant = variant.replace('$\{INSULATION_LAYER_WIDTH}','{}'.format(w))

			# create variant file name, file name pattern = <location>_<width>_<lambda>.d6p
			d6pfile = VARIANTS_SUBDIR + "/{}_{:.2f}_{:.3f}.d6p".format(cli[1], w, lmd)

			# write the file
			write_file(d6pfile, variant)

			# run cmd line discretization tool
			# > CmdDiscretize -m=auto -l=1.7 -o=<d6pfile> d6pfile
			solverProcess = subprocess.Popen([DISCTOOL_EXECUTABLE, '-m=auto', '-l=1.7', '-o="' + d6pfile+'"', d6pfile])
			solverProcess.wait()

			# add to list of jobs, unless project was already simulated, use command line arguments -x for windows,
			# and -p=2 for 2 CPUs per job
			if not os.path.exists(d6pfile[:-4] + "/var/restart.bin"):
				jobs.append([DELPHIN_EXECUTABLE, '-x', '--verbosity-level=0', '-p=2', d6pfile])

# 6. run all the jobs in parallel
jobRunner = JobRunner(4) # 4 jobs at the same time
jobRunner.run(jobs)