first commit

Author: lordvon

README.md

@@ -0,0 +1,2 @@
+# openfoam_python
+Modules for manipulating OpenFOAM runs and other utilities.

__init__.py

@@ -0,0 +1,33 @@
+#!/usr/bin/python
+
+"""
+These functions offer easy ways to automate changes in OpenFOAM settings by 
+modification of 'constant', 'system', '0' files and other files that define an 
+OpenFOAM case.
+"""
+
+import os
+import sys
+
+def read_file(file_name):
+  with open(file_name) as f:
+    content = f.readlines()
+  f.close()
+  return content
+
+def modify_empty_bc(file_path, patch_name, new_bc):
+  file_contents = read_file(file_path)
+  section_flag = False
+  with open(file_path, 'w') as f:
+    for line in file_contents:
+      if patch_name in line:
+        section_flag = True
+      if section_flag and "type" in line:
+        line = line.replace("patch", new_bc)
+      if section_flag and "physicalType" in line:
+        line = line.replace("patch", new_bc)
+      if "}" in line and section_flag == True:
+        section_flag = False
+      f.write(line)
+  f.close()
+  return

boundary_conditions.py

@@ -0,0 +1,27 @@
+#!/usr/bin/python
+
+import os
+import sys
+
+def leave_last_time(time_path):
+  """
+  This leaves the latest time in either processor or main case folders.
+  """
+  files = os.listdir(time_path)
+
+  num_files = [ \
+    float(x) for x in files if ('.' in x or x.isdigit()) \
+      and os.path.isdir(x) \
+      and (x!="0") ]
+  num_files = [ int(x) if x.is_integer() else x for x in num_files ]
+
+  max_time = 0
+  if len(num_files) > 1:
+    max_time = max(num_files)
+    num_files.remove(max_time)
+    num_file_names = ' '.join(str(x) for x in num_files)
+    os.system("rm -r "+num_file_names)
+
+  return 
+
+print leave_last_time("./")

clean_times.py

@@ -0,0 +1,45 @@
+#!/usr/bin/python
+
+import os
+import file_operations
+
+def set_end_time(new_end_time, case_path="./"):
+  controlDict_path = case_path+"/system/controlDict"
+  output_file = open(controlDict_path+"_temp", 'w')
+  with open(controlDict_path, 'r') as input_file:
+    for line in input_file:
+      if ("endTime" in line) and ("stopAt" not in line):
+        time_value = line.split()[1]
+        new_line = line.replace(time_value, str(new_end_time)+";")
+        output_file.write(new_line)
+      else:
+        output_file.write(line)
+  output_file.close()
+  os.system("mv "+controlDict_path+"_temp "+controlDict_path)
+  return
+
+def set_write_interval(new_write_interval, case_path="./"):
+  controlDict_path = case_path+"/system/controlDict"
+  output_file = open(controlDict_path+"_temp", 'w')
+  with open(controlDict_path, 'r') as input_file:
+    for line in input_file:
+      if ("writeInterval" in line):
+        time_value = line.split()[1]
+        new_line = line.replace(time_value, str(new_write_interval)+";")
+        output_file.write(new_line)
+      else:
+        output_file.write(line)
+  output_file.close()
+  os.system("mv "+controlDict_path+"_temp "+controlDict_path)
+  return
+
+def set_courant_number(controlDict_path="system/controlDict", maxCo=1):
+  file_operations.change_line(controlDict_path, ["maxCo"], \
+    [], "\tmaxCo\t\t"+str(maxCo)+";\n")
+  return
+
+def set_force_output_interval(controlDict_path="system/controlDict", \
+  outputInterval=50):
+  file_operations.change_line(controlDict_path, ["outputInterval"], \
+    [], "\t\toutputInterval\t\t"+str(outputInterval)+";\n")
+  return

controlDict.py

@@ -0,0 +1,109 @@
+#!/usr/bin/python
+
+import os
+
+def safely_remove_file(path):
+  if os.path.isfile(path):
+    os.system("rm "+path)
+  return
+
+def safely_remove_dir(path):
+  if os.path.isdir(path):
+    os.system("rm -r "+path)
+  return
+
+def change_file_name(file_path, suffix):
+  # Simply adds a suffix to an existing file.
+  if os.path.isfile(file_path):
+    os.system("mv "+file_path+" "+file_path+suffix)
+  else:
+    print "Couldn\'t find "+file_path
+  return
+
+
+def get_highest_folder(path, prefix):
+  # Assumes that the folders in path are part of a series with an integer ID 
+  # as the suffix.
+  # Assumes integer ranks
+  highest = -1
+  folders = [x for x in os.listdir(path) if os.path.isdir(path+"/"+x)]
+  for folder in folders:
+    folder_id = int(folder.replace(prefix, ""))
+    if folder_id > highest:
+      highest = folder_id
+  return highest
+
+
+def get_time_folders(case_path="./"):
+  time_folders = [ x for x in os.listdir(case_path) \
+    if os.path.isdir(case_path+"/"+x) \
+    and (("." in x) or (x.isdigit())) \
+    and x != "0"]
+  return time_folders
+
+def leave_last_time(case_path="./"):
+  # if os.path.isdir(case_path+"/processor0"):
+    # os.system("reconstructPar -latestTime -case "+case_path)
+    # os.system("rm -r processor*")
+  time_folders = get_time_folders(case_path)
+  times = [ float(x) for x in time_folders ]
+  times = [ int(x) if x.is_integer() else x for x in times ]
+  times.sort()
+  time_folders = [ str(x) for x in times ]
+  # print "Here comes the annoying warning"
+  if len(time_folders) > 1:
+    time_folders_string = ' '.join(time_folders[0:-1])
+    os.system("rm -r "+time_folders_string)
+  # print "There goes the annoying warning"
+  return
+
+def clean_case(case_path="./"):
+  # This removes all non-standard FOLDERS.
+  current_folders = os.listdir(case_path)
+  standard_folders = ["0", "system", "constant", "openfoam_python"]
+  # First make sure this is a case!
+  for sf in standard_folders:
+    if sf not in current_folders:
+      print "This is not an OpenFOAM case directory! Be careful! Exiting."
+      return
+  # Then filter out folders that are not standard folders and remove.
+  folders = [ case_path+"/"+x for x in current_folders \
+    if os.path.isdir(case_path+"/"+x) and x not in standard_folders ]
+  if len(folders) > 0:
+    os.system("rm -r "+' '.join(folders))
+  # File removal
+  if os.path.isfile(case_path+"/geometry.dat"):
+    os.system("rm "+case_path+"/geometry.dat")
+  if os.path.isdir(case_path+"/constant/polyMesh"):
+    os.system("rm -r "+case_path+"/constant/polyMesh")
+  if os.path.isfile(case_path+"/main.msh"):
+    os.system("rm "+case_path+"/main.msh")
+  if os.path.isfile(case_path+"/forces.txt"):
+    os.system("rm "+case_path+"/forces.txt")
+  # We assume we have reconstructed already.
+  if os.path.isdir(case_path+"/processor0"):
+    os.system("rm -r "+case_path+"/processor*")
+  return
+
+def change_line(file_path, included_strings, excluded_strings, replacement):
+  """
+  Goes through file_path line-by-line and if all of included_strings are in 
+  the line and all of excluded_strings are not in the line, then the whole line 
+  is replaced by replacement.
+  Assumes file_path+'_temp' is not already a file.
+  """
+  if not os.path.isfile(file_path):
+    print file_path+" file not found!"
+    return
+  temp_path = file_path+"_temp"
+  temp_file = open(temp_path, 'w')
+  with open(file_path, 'r') as f:
+    for line in f:
+      if all([x in line for x in included_strings]) and \
+        all([x not in line for x in excluded_strings]):
+        temp_file.write(replacement)
+      else:
+        temp_file.write(line)
+  temp_file.close()
+  os.system("mv "+temp_path+" "+file_path)
+  return

file_operations.py

@@ -0,0 +1,91 @@
+#!/usr/bin/python
+
+import os
+import sys
+import math
+import numpy
+
+def line2dict(line):
+  tokens_unprocessed = line.split()
+  tokens = [x.replace(")","").replace("(","") \
+    for x in tokens_unprocessed]
+  floats = [float(x) for x in tokens]
+  data_dict = {}
+  data_dict['time'] = floats[0]
+  force_dict = {}
+  force_dict['pressure'] = floats[1:4]
+  force_dict['viscous'] = floats[4:7]
+  force_dict['porous'] = floats[7:10]
+  moment_dict = {}
+  moment_dict['pressure'] = floats[10:13]
+  moment_dict['viscous'] = floats[13:16]
+  moment_dict['porous'] = floats[16:19]
+  data_dict['force'] = force_dict
+  data_dict['moment'] = moment_dict
+  return data_dict
+
+def get_forces_dict(forces_file):
+  # Returns a list of lists: [time, drag, lift, moment]
+  time = []
+  drag = []
+  lift = []
+  moment = []
+  with open(forces_file,"r") as datafile:
+    for line in datafile:
+      if line[0] == "#":
+        continue
+      data_dict = line2dict(line)
+      time += [data_dict['time']]
+      drag += [data_dict['force']['pressure'][0] + \
+        data_dict['force']['viscous'][0]]
+      lift += [data_dict['force']['pressure'][1] + \
+        data_dict['force']['viscous'][1]]
+      moment += [data_dict['moment']['pressure'][2] + \
+        data_dict['moment']['viscous'][2]]
+  datafile.close()
+  return [time, drag, lift, moment]
+
+def get_line_from_file(file_path, line_number):
+  with open(file_path, "r") as temp_file:
+    lines = temp_file.readlines()
+  temp_file.close()
+  return lines[line_number]
+  
+def get_overall_chord():
+  # Searches file for the chord.
+  return float(get_line_from_file("geometry.dat", 0))
+
+def get_cell_depth():
+  # Searches file for the cell_depth.
+  return float(get_line_from_file("geometry.dat", 1))
+
+def get_V():
+  # Searches file for the velocity.
+  # We assume we are in the case directory.
+  velocity = 0
+  with open("0/include/initialConditions","r") as ufile:
+    for line in ufile:
+      if "flowVelocity" in line:
+        vector = line[line.find("(")+1:line.find(")")]
+        velocity = float(vector.split()[0])
+  ufile.close()
+  return velocity
+
+def trailing_average(time, data, trailing_time):
+  end_time = time[-1]
+  start_time = end_time - trailing_time
+  diff = numpy.abs( [x-start_time for x in time] )
+  start_index = diff.argmin()
+  subdata = data[start_index:len(data)]
+  return sum(subdata) / len(subdata)
+
+def get_latest_force_time(patch):
+  # Assumes in main case directory
+  # Assumes all folders are floating-point named
+  # Gets folder with highest floating-point value
+  folders = [ float(x) for x in os.listdir("postProcessing/"+patch) ]
+  folders.sort()
+  folder = folders[-1]
+  if folder.is_integer():
+    folder = int(folder)
+  return folder

force_read.py

@@ -0,0 +1,33 @@
+#!/usr/bin/python
+
+import os
+import file_operations
+
+def second_order_spatial(fvSchemes_path="system/fvSchemes"):
+  """
+  Assumed format: each setting is on its own line.
+  """
+  file_operations.change_line(fvSchemes_path, ['div', 'phi', 'U'], ['//'], \
+    "\tdiv(phi,U)\t\tGauss linearUpwind grad(U);\n")
+  file_operations.change_line(fvSchemes_path, ['div', 'phi', 'k'], ['//'], \
+    "\tdiv(phi,k)\t\tGauss limitedLinear 1;\n")
+  file_operations.change_line(fvSchemes_path, ['div', 'phi', 'omega'], \
+    ['//'], "\tdiv(phi,omega)\tGauss limitedLinear 1;\n")
+  file_operations.change_line(fvSchemes_path, ['div', 'phi', 'nut'], \
+    ['//'], "\tdiv(phi,nut)\tGauss limitedLinear 1;\n")
+  return
+
+def first_order_spatial(fvSchemes_path="system/fvSchemes"):
+  """
+  Assumed format: each setting is on its own line.
+  """
+  file_operations.change_line(fvSchemes_path, ['div', 'phi', 'U'], ['//'], \
+    "\tdiv(phi,U)\t\tGauss upwind;\n")
+  file_operations.change_line(fvSchemes_path, ['div', 'phi', 'k'], ['//'], \
+    "\tdiv(phi,k)\t\tGauss upwind;\n")
+  file_operations.change_line(fvSchemes_path, ['div', 'phi', 'omega'], \
+    ['//'], "\tdiv(phi,omega)\tGauss upwind;\n")
+  file_operations.change_line(fvSchemes_path, ['div', 'phi', 'nut'], \
+    ['//'], "\tdiv(phi,nut)\tGauss upwind;\n")
+  return
+

fvSchemes.py

@@ -0,0 +1,12 @@
+#!/usr/bin/python
+
+import os
+import file_operations
+
+def set_piso_correctors(nCorrectors, fvSolution_path="system/fvSolution"):
+  """
+  Assumed format: each setting is on its own line.
+  """
+  file_operations.change_line(fvSolution_path, ['nCorrectors', ';'], ['//'], \
+    "\tnCorrectors\t\t"+str(nCorrectors)+";\n")
+  return