Mattdon/new melcor interface #2017

mandd · 2022-11-17T22:29:54Z

Pull Request Description

What issue does this change request address? (Use "#" before the issue to link it, i.e., #42.)

Closes #2125

What are the significant changes in functionality due to this change request?

For Change Control Board: Change Request Review

The following review must be completed by an authorized member of the Change Control Board.

1. Review all computer code.
2. If any changes occur to the input syntax, there must be an accompanying change to the user manual and xsd schema. If the input syntax change deprecates existing input files, a conversion script needs to be added (see Conversion Scripts).
3. Make sure the Python code and commenting standards are respected (camelBack, etc.) - See on the wiki for details.
4. Automated Tests should pass, including run_tests, pylint, manual building and xsd tests. If there are changes to Simulation.py or JobHandler.py the qsub tests must pass.
5. If significant functionality is added, there must be tests added to check this. Tests should cover all possible options. Multiple short tests are preferred over one large test. If new development on the internal JobHandler parallel system is performed, a cluster test must be added setting, in XML block, the node <internalParallel> to True.
6. If the change modifies or adds a requirement or a requirement based test case, the Change Control Board's Chair or designee also needs to approve the change. The requirements and the requirements test shall be in sync.
7. The merge request must reference an issue. If the issue is closed, the issue close checklist shall be done.
8. If an analytic test is changed/added is the the analytic documentation updated/added?
9. If any test used as a basis for documentation examples (currently found in raven/tests/framework/user_guide and raven/docs/workshop) have been changed, the associated documentation must be reviewed and assured the text matches the example.

This reverts commit 49913b9.

…to mattdon/New_MELCOR_Interface

…nterface

moosebuild · 2023-02-22T15:44:21Z

Job Mingw Test on 3eb7f67 : invalidated by @joshua-cogliati-inl

restarted civet

moosebuild · 2023-05-26T19:42:16Z

Job Precheck on d8c1ae7 : invalidated by @aalfonsi

wangcj05 · 2023-05-26T19:59:41Z

Job Precheck on d8c1ae7 : invalidated by @aalfonsi

@mandd @aalfonsi FYI, pre-check failed due to hpcgithub issue. This may be resolved until next Tuesday.

moosebuild · 2023-05-27T20:24:37Z

Job Precheck on d8c1ae7 : invalidated by @aalfonsi

ravenframework/Models/PostProcessors/SubdomainBasicStatistics.py

mandd · 2023-06-02T22:05:28Z

@wangcj05 : this PR is good to be reviewed

moosebuild · 2023-06-03T20:33:48Z

Job Mingw Test on 851e8df : invalidated by @mandd

moosebuild · 2023-06-03T20:33:53Z

Job Test qsubs sawtooth on 851e8df : invalidated by @mandd

wangcj05 · 2023-06-05T14:54:18Z

@mandd Could you create an issue for this PR? In addition, could you update the description for this PR? I will review it this week.

wangcj05

@mandd I have a couple of comments for you to consider.

wangcj05 · 2023-06-07T16:19:25Z

ravenframework/CodeInterfaceClasses/MELCOR/melcorCombinedInterface.py

-  @author: Matteo Donorio (University of Rome La Sapienza),
-           Fabio Gianneti (University of Rome La Sapienza),
-           Andrea Alfonsi (INL)
+  @author: Matteo D'Onorio (Sapienza University of Rome)


Do you want to add your name and Andrea name here?

wangcj05 · 2023-06-07T16:23:08Z

ravenframework/CodeInterfaceClasses/MELCOR/melcorCombinedInterface.py

+    self.VarList = [var.strip() for var in varNode.text.split("$,")]
+    self.MelcorPlotFile = [var.strip() for var in plotNode.text.split(",")][0]


please use camelBack style for variables.

wangcj05 · 2023-06-07T16:23:54Z

ravenframework/CodeInterfaceClasses/MELCOR/melcorCombinedInterface.py

+
+    return self.VarList, self.MelcorPlotFile, self.melcorOutFile
+
+  def findInps(self,currentInputFiles):
    """
      Locates the input files for Melgen, Melcor
      @ In, inputFiles, list, list of Files objects


please change 'inputFiles' to 'currentInputFiles'

wangcj05 · 2023-06-07T16:26:23Z

ravenframework/CodeInterfaceClasses/MELCOR/melcorCombinedInterface.py

+    for index, inputFile in enumerate(currentInputFiles):
      if inputFile.getExt() in self.getInputExtension():
        foundMelcorInp = True
-        melgIn = inputFiles[index]
-        melcIn = inputFiles[index]
+        melgIn = currentInputFiles[index]
+        melcIn = currentInputFiles[index]


It is not clear to me about the 'for loop' here. For example, if there are multiple files provided in raven input, how can this for loop check which files to pick? I guess only one file is accepted for melgIn and melcIn.

I am not sure here TBH

I suggest to add a check inside the if statement, for example:

if foundMelcorInp: raise IOError(f"Multiple Melcor input files are founded {inputFile} and {melgIn}, please check your inputs, only one of input is accepted")

wangcj05 · 2023-06-07T16:28:32Z

ravenframework/CodeInterfaceClasses/MELCOR/melcorCombinedInterface.py

+        break
+    if not found:
+      raise IOError('None of the input files has one of the following extensions: ' + ' '.join(self.getInputExtension()))
+    melcOut = 'OUTPUT_MELCOR'


I suggest move this to init method using self.melcOut.

could you address this issue also?

could you address this?

wangcj05 · 2023-06-07T16:54:15Z

ravenframework/Models/PostProcessors/SubdomainBasicStatistics.py

+      unset = ', '.join(list(set(dims) - set(inputVars)))
+      self.raiseAnError(RuntimeError, ("Subdomain grid must be defined on the input space only (inputs)."
+                                       f"The following variables '{unset}' are not part "
+                                       f"of the input space of DataObject {inputs[-1].name}!"))


I think inputs[-1].name will not give you the right name of DataObject, it will only return 'DataSet, PointSet or HistorySet', not the actually name provided by the user. I think we need to add a method in DataObject to retrieve the name in the future.

self.name is set to the attribute ``name'' (in the XML) in the base type class. It will return the name of the data object. (Tried)

wangcj05 · 2023-06-07T16:55:15Z

ravenframework/contrib/melcorTools/melcorTools.py

+    @ In, fileDirectory, string, the file directory. This is the directory of the MELCOR plot file
+    @ In, variableSearch, list, list of variables to be collected


please update these docstring to reflect the provided input arguments.

wangcj05 · 2023-06-07T16:55:54Z

ravenframework/contrib/melcorTools/melcorTools.py

+    This method is called to collect the variables to be used in the postprocess
+    @ In, fileDirectory, string, the file directory. This is the directory of the MELCOR plot file
+    @ In, variableSearch, list, list of variables to be collected
+    @ Out, Data, tuple (numpy.ndarray,numpy.ndarray,numpy.ndarray), this contains the extracted data for each declare variable


please update this docstring to explain each element in the tuple.

I have added a short description based on my understanding of the code

wangcj05 · 2023-06-07T16:57:30Z

ravenframework/contrib/melcorTools/melcorTools.py

+  HdrList = []
+  BlkLenBef = []
+  BlkLenAft = []
+  DataPos=[]
+  cntr = 0
+  Var_dict = {}


@mandd Do we want to force this file to use RAVEN code standards? To me, I'm ok with the code style of this file since it is a contrib file.

I agree since it is in contrib

wangcj05 · 2023-06-07T17:07:04Z

ravenframework/CodeInterfaceClasses/MELCOR/melcorCombinedInterface.py

+    found = False
+
+    for index, inputFile in enumerate(inputFiles):
+      if inputFile.getExt() in self.getInputExtension():


I do not see a function to add the input extension for this interface. I think you need to update the self.inputExtensions using setInputExtension method or using addDefaultExtension method.

It seems this issue has not been addressed yet.

wangcj05

@mandd It seems a couple of comments have not been addressed yet.

wangcj05 · 2023-06-26T16:15:32Z

ravenframework/CodeInterfaceClasses/MELCOR/melcorCombinedInterface.py

+    for index, inputFile in enumerate(currentInputFiles):
      if inputFile.getExt() in self.getInputExtension():
        foundMelcorInp = True
-        melgIn = inputFiles[index]
-        melcIn = inputFiles[index]
+        melgIn = currentInputFiles[index]
+        melcIn = currentInputFiles[index]


I suggest to add a check inside the if statement, for example:

if foundMelcorInp: raise IOError(f"Multiple Melcor input files are founded {inputFile} and {melgIn}, please check your inputs, only one of input is accepted")

wangcj05 · 2023-06-26T16:16:28Z

ravenframework/CodeInterfaceClasses/MELCOR/melcorCombinedInterface.py

+    found = False
+
+    for index, inputFile in enumerate(inputFiles):
+      if inputFile.getExt() in self.getInputExtension():


It seems this issue has not been addressed yet.

wangcj05 · 2023-06-26T16:16:49Z

ravenframework/CodeInterfaceClasses/MELCOR/melcorCombinedInterface.py

+        break
+    if not found:
+      raise IOError('None of the input files has one of the following extensions: ' + ' '.join(self.getInputExtension()))
+    melcOut = 'OUTPUT_MELCOR'


could you address this issue also?

mandd · 2023-09-22T21:41:20Z

This PR is good to go I think

wangcj05

@mandd I have a couple of comments for you to consider, manual for the user manual documentations regarding the Melcor code interface changes. Please let me know if you have any questions.

wangcj05 · 2023-09-25T16:09:28Z

tests/framework/CodeInterfaceTests/test_melcor_interface.xml

-          <revision author="alfoa" date="2017-04-27">Adding this test description.</revision>
-          <revision author="alfoa" date="2020-10-31">Added csv xml node in the Code block for showing how to use it.</revision>


These two lines should not be removed.

wangcj05 · 2023-09-25T16:14:54Z

tests/framework/CodeInterfaceTests/test_melcor_interface.xml

+      <variables>
+         CVH-P_1$, CVH-TLIQ_2$, CFVALU_2
+      </variables>
+	  <CodePlotFile>MELPTF.PTF</CodePlotFile>
+	  <MelcorOutput>MELMES_v2-0</MelcorOutput>


The user manual is not updated to reflect these changes. Could you update it? In addition, why there is a '$' and the end of some defined variables?

wangcj05 · 2023-09-25T16:16:24Z

ravenframework/CodeInterfaceClasses/MELCOR/melcorCombinedInterface.py

+    melNode = xmlNode.find('MelcorOutput')
+    varNode = xmlNode.find('variables')
+    plotNode = xmlNode.find('CodePlotFile')


These nodes need to be documented in the user manual

wangcj05 · 2023-09-25T16:17:04Z

ravenframework/CodeInterfaceClasses/MELCOR/melcorCombinedInterface.py

+    if melNode is None:
+      raise IOError("Please enter MELCOR message file name")
+
+    self.varList = [var.strip() for var in varNode.text.split("$,")]


This split using '$,' need also be documented in the user manual.

wangcj05 · 2023-09-25T16:18:11Z

ravenframework/CodeInterfaceClasses/MELCOR/melcorCombinedInterface.py

+        break
+    if not found:
+      raise IOError('None of the input files has one of the following extensions: ' + ' '.join(self.getInputExtension()))
+    melcOut = 'OUTPUT_MELCOR'


could you address this?

wangcj05 · 2023-09-25T16:21:22Z

ravenframework/CodeInterfaceClasses/MELCOR/melcorCombinedInterface.py

+    self.melcorPlotFile = [var.strip() for var in plotNode.text.split(",")][0]
+    self.melcorOutFile = [var.strip() for var in melNode.text.split(",")][0]


Please also document the output files types and explain the use of these files. For example, self.melcorPlotFile is used to retrieve outputs, and self.melcorOutFile is used to detect failures.

mattdon and others added 25 commits October 18, 2022 19:31

Update melcorCombinedInterface.py

12d25ce

Delete MELCORdata.py

e74717b

Delete melcorInterface.py

0fa7df7

Delete melgenInterface.py

33bc4ce

Update melcorCombinedInterface.py

e0ead47

Update melcorCombinedInterface.py

9e98ecb

Merge branch 'idaholab:devel' into New_MELCOR_Interface

446f280

Update test_melcor_interface.xml

9f398e0

merge

49913b9

merge

6deb3ab

Merge branch 'devel' into mattdon/New_MELCOR_Interface

216cb92

Revert "merge"

081f5f6

This reverts commit 49913b9.

first cleaning of PR

5b1c43a

Merge branch 'devel' into mattdon/New_MELCOR_Interface

99e71a0

edits

8bcc76f

Merge branch 'devel' into mattdon/New_MELCOR_Interface

2c71868

Merge remote-tracking branch 'origin/mattdon/New_MELCOR_Interface' in…

508d1a0

…to mattdon/New_MELCOR_Interface

edit test files

d0b5a91

edit combinedInterface file

a569931

added test files

4954399

missing test file

ad60e3a

fix for diego

9fdb226

small edits

5f2c16c

Merge remote-tracking branch 'origin/devel' into mattdon/New_MELCOR_I…

879acc3

…nterface

added edits from rome

3eb7f67

edit file

ab83307

wangcj05 added the RAVENv3.0 label May 19, 2023

mandd added 2 commits May 26, 2023 13:14

final files

b065ddb

removed last file

d8c1ae7

Merge branch 'devel' into mattdon/New_MELCOR_Interface

3108b58

removed whitespaces

e1ec0f5

aalfonsi reviewed May 27, 2023

View reviewed changes

ravenframework/Models/PostProcessors/SubdomainBasicStatistics.py Outdated Show resolved Hide resolved

aalfonsi and others added 5 commits May 27, 2023 14:31

Update ravenframework/Models/PostProcessors/SubdomainBasicStatistics.py

65d3231

fixed dictionary format

e81ace2

fixed dictionary format

303b225

updated test

d52231b

final edits

851e8df

mandd requested a review from wangcj05 June 2, 2023 22:04

wangcj05 requested changes Jun 7, 2023

View reviewed changes

wangcj05 mentioned this pull request Jun 7, 2023

[WIP] New melcor interface #1997

Closed

9 tasks

addressing comments

a5c4085

wangcj05 requested changes Jun 26, 2023

View reviewed changes

addressing comments

d0d345c

wangcj05 requested changes Sep 25, 2023

View reviewed changes

wangcj05 removed the RAVENv3.0 label Apr 16, 2024

		self.VarList = [var.strip() for var in varNode.text.split("$,")]
		self.MelcorPlotFile = [var.strip() for var in plotNode.text.split(",")][0]

		@ In, fileDirectory, string, the file directory. This is the directory of the MELCOR plot file
		@ In, variableSearch, list, list of variables to be collected

		<revision author="alfoa" date="2017-04-27">Adding this test description.</revision>
		<revision author="alfoa" date="2020-10-31">Added csv xml node in the Code block for showing how to use it.</revision>

		self.melcorPlotFile = [var.strip() for var in plotNode.text.split(",")][0]
		self.melcorOutFile = [var.strip() for var in melNode.text.split(",")][0]

Mattdon/new melcor interface #2017

Are you sure you want to change the base?

Mattdon/new melcor interface #2017

Conversation

mandd commented Nov 17, 2022 • edited Loading

Pull Request Description

What issue does this change request address? (Use "#" before the issue to link it, i.e., #42.)

What are the significant changes in functionality due to this change request?

For Change Control Board: Change Request Review

moosebuild commented Feb 22, 2023

moosebuild commented May 26, 2023

wangcj05 commented May 26, 2023

moosebuild commented May 27, 2023

mandd commented Jun 2, 2023

moosebuild commented Jun 3, 2023

moosebuild commented Jun 3, 2023

wangcj05 commented Jun 5, 2023

wangcj05 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wangcj05 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mandd commented Sep 22, 2023

wangcj05 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mandd commented Nov 17, 2022 •

edited

Loading