Merge pull request #11 from manjavacas/issue-10

Feature/issue-10: Added CF manipulation

Author: manjavacas

Makefile

@@ -1,14 +1,10 @@
-foo:
-	python3 run_melkit.py ./sample_files/sample1.inp
-run:
-	python3 run_melkit.py ./sample_files/sample3.inp
 gen: clean
-	./melgen-fusion-186_bdba ./sample_files/sample3.inp
+	./melgen-fusion-186_bdba ./sample_files/sample1.inp
 cor:
-	./melcor-fusion-186_bdba ./sample_files/sample3.inp
+	./melcor-fusion-186_bdba ./sample_files/sample1.inp
 test: clean
-	./melgen-fusion-186_bdba ./sample_files/sample3.inp
-	./melcor-fusion-186_bdba ./sample_files/sample3.inp
+	./melgen-fusion-186_bdba ./sample_files/sample1.inp
+	./melcor-fusion-186_bdba ./sample_files/sample1.inp
 clean:
 	rm -f *.DIA
 	rm -f *.MES

docs/source/code/aux_tools.py

@@ -22,4 +22,11 @@
 
 # Get connections for a given CV
 toolkit.get_fl_connections(cv)
-toolkit.get_connected_cvs(cv)
+toolkit.get_connected_cvs(cv)
+
+# Recursively, obtain related CFs
+for cf in toolkit.get_connected_cfs('FL001'):
+    print(cf)
+
+for cf in toolkit.get_connected_cfs('CF001'):
+    print(cf)

docs/source/code/read.py

@@ -14,4 +14,8 @@
 
 # Read and show FLs in file
 for fl in toolkit.get_fl_list():
-    print(fl)
+    print(fl)
+
+# Read and show CFs in file
+for cf in toolkit.get_cf_list():
+    print(cf)

melkit/inputs.py

@@ -32,6 +32,15 @@ def update_field(self, field_name: str, new_val: str) -> None:
 
     def __eq__(self, other):
         return self.get_id() == other.get_id()
+    
+    def __str__(self):
+        obj_str = []
+        for record, fields in self.records.items():
+            obj_str.append(f'{record}\t')
+            for value in fields.values():
+                obj_str.append(f'{value}\t')
+            obj_str.append('\n')
+        return ''.join(obj_str)
 
 
 class CV(Object):
@@ -55,11 +64,8 @@ class FL(Object):
     '''
     Flow Path class (FL package).
     '''
-    def __str__(self):
-        fl_str = []
-        for record, fields in self.records.items():
-            fl_str.append(f'{record}\t')
-            for value in fields.values():
-                fl_str.append(f'{value}\t')
-            fl_str.append('\n')
-        return ''.join(fl_str)
+
+class CF(Object):
+    '''
+    Control Function class (CF package).
+    '''

melkit/toolkit.py

@@ -5,12 +5,13 @@
 from pandas import DataFrame, read_csv
 
 from os import remove
-from re import search, match
+from re import search, match, findall
+from json import dumps
 
 from typing import List, Union
 
 from .exceptions import ParseException
-from .inputs import Object, CV, FL
+from .inputs import Object, CV, FL, CF
 from .constants import CV_KEYS
 
 
@@ -24,6 +25,7 @@ def __init__(self, filename: str):
 
         self._cv_list = self._read_cvs()
         self._fl_list = self._read_fls()
+        self._cf_list = self._read_cfs()
 
 #------------------------ OBJECT MANIPULATION TOOLS -----------------------#
 
@@ -40,6 +42,8 @@ def _read_object(self, id_regex: str) -> List[Object]:
                         objs.append(self.get_cv(id.group()[:-2]))
                     elif 'FL' in id_regex:
                         objs.append(self.get_fl(id.group()[:-2]))
+                    elif 'CF' in id_regex:
+                        objs.append(self.get_cf(id.group()[:-2]))
         return objs
 
     def _read_cvs(self) -> List[CV]:
@@ -53,6 +57,12 @@ def _read_fls(self) -> List[FL]:
         Looks for FLs in the input file and returns them as a list of FL objects.
         '''
         return self._read_object(r'\bFL\d{3}00\b')
+    
+    def _read_cfs(self) -> List[CF]:
+        '''
+        Looks for CFs in the input file and returns them as a list of CF objects.
+        '''
+        return self._read_object(r'\bCF\d{3,8}00\b')
 
     def get_cv(self, cv_id: str) -> CV:
         '''
@@ -183,6 +193,64 @@ def get_fl(self, fl_id: str) -> FL:
 
         return FL(fl_data)
 
+    def get_cf(self, cf_id: str) -> CF:
+        '''
+        Searches for a CF in the input file and returns it as a CF object.
+        '''
+        cf_data = {}
+        
+        arg_c = 0   # arg counter
+
+        with open(self._filename, 'r') as file:
+            for line in file:
+                if line.startswith(cf_id):
+                    record = line.split()
+                    record_id = record[0]
+                    record_data = {}
+
+                    termination = record_id[-2:]
+
+                    try:
+                        if termination == '00':
+                            record_data['CFNAME'] = record[1]
+                            record_data['CFTYPE'] = record[2]
+                            record_data['NCFARG'] = record[3]
+                            record_data['CFSCAL'] = record[4]
+                            record_data['CFADCN'] = record[5] if len(record) > 5 else 0.0
+                        elif termination == '01':
+                            if record[1] in ['.TRUE.', '.FALSE.']:
+                                record_data['LCFVAL'] = record[1]
+                            else:
+                                record_data['CFVALR'] = record[1] 
+                        elif termination == '02':
+                            record_data['ICFLIM'] = record[1]
+                            if int(record[1]) in [1, 2, 3]:
+                                record_data['CFLIML'] = record[2]
+                            if int(record[1]) in [2, 3]:
+                                record_data['CFLIMU'] = record[3]
+                        elif match(r'0[3-4]', termination):
+                            record_data['FIELDS'] = record[1] # Fixable
+                        elif termination == '05':
+                            record_data['CLASS'] = record[1]
+                        elif termination == '06':
+                            record_data['MSGFIL'] = record[1]
+                            if int(record[1]) in [1, 2]:
+                                record_data['SWTMSG'] = record[2]
+                        elif match(r'[10-99]', termination):
+                            record_data['ARSCAL_' + str(arg_c)] = record[1]
+                            record_data['ARADCN_' + str(arg_c)] = record[2]
+                            record_data['CHARG_' + str(arg_c)] = record[3]
+                            arg_c += 1
+                        else:
+                            raise ParseException(
+                                cf_id, f'Unknown record: {record_id}')
+                    except:
+                        raise ParseException(
+                            cf_id, f'Invalid number of attributes for record {record_id}')
+                    cf_data[record_id] = record_data
+
+        return CF(cf_data)
+
     def get_cv_list(self) -> List[CV]:
         '''
         Return the list of CVs in parsed file.
@@ -194,6 +262,12 @@ def get_fl_list(self) -> List[FL]:
         Return the list of CVs in parsed file.
         '''
         return self._fl_list
+    
+    def get_cf_list(self) -> List[CF]:
+        '''
+        Return the list of CFs in parsed file.
+        '''
+        return self._cf_list
 
     def remove_object(self, obj_id: str, src_file: str = None, new_file: str = None) -> None:
         '''
@@ -376,6 +450,37 @@ def get_connected_cvs(self, cv_id: str) -> List[CV]:
                 cv_connected.append(self.id_search(
                     self._cv_list, 'CV' + fl.get_field('KCVFM')))
         return cv_connected
+    
+
+    def get_connected_cfs(self, obj_id: str) -> List[CF]:
+        '''
+        Get those CFs directly or indirectly connected to a given Object.
+        - If the Object is an FL, the CF associated with the CFnnnTk record is returned and, recursively, all CFs on which this CF depends are added.
+        - If the object is a CF, that CF and its dependencies are returned.
+        '''
+        cf_connected = []
+
+        # Get a CF specified in the FL Tk record
+        if obj_id.startswith('FL'):
+            fl = self.get_fl(obj_id)
+            for key in fl.records.keys():
+                if match(obj_id + r'T[0-9]$', key) and fl.records[key]['NTFLAG'] == '2':
+                    cf_id = 'CF' + fl.records[key]['NFUN']
+                    cf_connected.append(self.get_cf(cf_id))
+                    # Recursion for interdependent CFs
+                    cf_connected += self.get_connected_cfs(cf_id)
+        # Get those CFs related to a given CF
+        elif obj_id.startswith('CF'):
+            cf = self.get_cf(obj_id)
+            cf_values = findall(r'\bCFVALU\.\d+\b', dumps(cf.records))
+            for value in cf_values: 
+                dot_pos = value.find('.')
+                cf_id = 'CF' + value[dot_pos + 1:]
+                cf_connected.append(self.get_cf(cf_id))
+                cf_connected += self.get_connected_cfs(cf_id)
+
+        return cf_connected
+
 
     def create_submodel(self, cv_id: str, new_file: str = None) -> Union[List[CV], List[FL]]:
         '''

sample_files/sample2.inp

@@ -18,7 +18,8 @@ NCG555    AR    8
 CF10000   QP  EQUALS  1  0.0  35.64601176           
 CF10010   1.0  0.0  TIME
 CF10100   RJ  MULTIPLY  1  0.3                      
-CF10110   1.0  0.0  CFVALU.100                      
+CF10110   1.0  0.0  CFVALU.100
+*                     
 CF10200   QT  EQUALS  1  1.0                        
 CF10210   1.0  0.0  CFVALU.103
 CF10300   Q-LLC  EQUALS  1  0.0  11747.14318        
@@ -196,18 +197,22 @@ FL200S0   0.001341   7.5    0.038
 FL200T0   2  200           
 CF20000   VEL-ArSS  EQUALS  1  0.0  0.1735                      
 CF20010   1.0  0.0  TIME
+
 FL20100   SGS-FL201   903   904   6.2  6.2
 FL20101   0.43709  10.0   1.0    0.746    0.746              
 FL20102	  3     0    0     0                                
 FL20103   0.0   0.0                                                           
 FL201S0   0.43709   10.0    0.746                               
-FL201T0   2   201                                   
+FL201T0   2   201 
+
 CF20100   VEL-FL201  DIVIDE  2  1.0                             
 CF20110   0.0  1573.524  TIME                                   
 CF20115   1.0  0.0  CFVALU.202
+
 CF20200   NUM-201  ADD  2  1.0
 CF20210   1.0  0.0  CFVALU.102
 CF20215   -1.0  0.0  CFVALU.100
+
 FL20200   SGS-FL202   904   905   6.7    6.7
 FL20201   0.43709  5.0   1.0    0.746    0.746              
 FL20202	  3     0    0     0                                
@@ -330,9 +335,11 @@ CF16415   3600.0  0.0  FL-MFLOW.5.207
 CF16500   ArPu-H2O-ppm DIVIDE 2 1.0E6                               
 CF16510   1.0  0.0  CFVALU.168                                                                                                           
 CF16515   3600.0  0.0  FL-MFLOW.3.207
+
 CF16600  Denom-163 MULTIPLY 2 1.0
 CF16610  1.0  0.0  CFVALU.153
 CF16615  1.0  0.0  CFVALU.300
+
 CF16700  Denom-164 MULTIPLY 2 1.0
 CF16710  1.0  0.0  CFVALU.154
 CF16715  1.0  0.0  CFVALU.300