def __init__(self):
"""
Constructor.
@ In, None
@ Out, None
"""
CodeInterfaceBase.__init__(self)
self.melcorInterface = MelcorApp()
self.melgenInterface = MelgenApp()
class Melcor(CodeInterfaceBase):
"""
this class is used a part of a code dictionary to specialize Model.Code for MELCOR 2. Version
"""
def __init__(self):
"""
Constructor.
@ In, None
@ Out, None
"""
CodeInterfaceBase.__init__(self)
self.melcorInterface = MelcorApp()
self.melgenInterface = MelgenApp()
def findInps(self, inputFiles):
"""
Locates the input files for Melgen, Melcor
@ In, inputFiles, list, list of Files objects
@ Out, (melgIn,melcIn), tuple, tuple containing Melgin and Melcor input files
"""
foundMelcorInp = False
for index, inputFile in enumerate(inputFiles):
if inputFile.getExt() in self.getInputExtension():
foundMelcorInp = True
melgIn = inputFiles[index]
melcIn = inputFiles[index]
if not foundMelcorInp:
raise IOError(
"Unknown input extensions. Expected input file extensions are "
+ ",".join(self.getInputExtension()) +
" No input file has been found!")
return melgIn, melcIn
def generateCommand(self,
inputFiles,
executable,
clargs=None,
fargs=None,
preExec=None):
"""
Generate a command to run MELCOR (combined MELGEN AND MELCOR)
Collects all the clargs and the executable to produce the command-line call.
Returns tuple of commands and base file name for run.
Commands are a list of tuples, indicating parallel/serial and the execution command to use.
This method is used to retrieve the command (in tuple format) needed to launch the Code.
@ In, inputFiles, list, List of input files (length of the list depends on the number of inputs that have been added in the Step is running this code)
@ In, executable, string, executable name with absolute path (e.g. /home/path_to_executable/code.exe)
@ In, clargs, dict, optional, dictionary containing the command-line flags the user can specify in the input (e.g. under the node < Code >< clargstype =0 input0arg =0 i0extension =0 .inp0/ >< /Code >)
@ In, fargs, dict, optional, a dictionary containing the axuiliary input file variables the user can specify in the input (e.g. under the node < Code >< clargstype =0 input0arg =0 aux0extension =0 .aux0/ >< /Code >)
@ Out, returnCommand, tuple, tuple containing the generated command. returnCommand[0] is the command to run the code (string), returnCommand[1] is the name of the output root
"""
if preExec is None:
raise IOError('No preExec listed in input! Exiting...')
melcin, melgin = self.findInps(inputFiles)
#get the melgen part
melgCommand, melgOut = self.melcorInterface.generateCommand([melgin],
preExec,
clargs,
fargs)
#get the melcor part
melcCommand, melcOut = self.melgenInterface.generateCommand([melcin],
executable,
clargs,
fargs)
#combine them
returnCommand = melgCommand + melcCommand, melcOut
return returnCommand
def createNewInput(self, currentInputFiles, origInputFiles, samplerType,
**Kwargs):
"""
This generates a new input file depending on which sampler has been chosen
@ In, currentInputFiles, list, list of current input files (input files from last this method call)
@ In, oriInputFiles, list, list of the original input files
@ In, samplerType, string, Sampler type (e.g. MonteCarlo, Adaptive, etc. see manual Samplers section)
@ In, Kwargs, dictionary, kwarded dictionary of parameters. In this dictionary there is another dictionary called "SampledVars"
where RAVEN stores the variables that got sampled (e.g. Kwargs['SampledVars'] => {'var1':10,'var2':40})
@ Out, newInputFiles, list, list of newer input files, list of the new input files (modified and not)
"""
return self.melcorInterface.createNewInput(currentInputFiles,
origInputFiles, samplerType,
**Kwargs)
def finalizeCodeOutput(self, command, output, workingDir):
"""
This method is called by the RAVEN code at the end of each run (if the method is present, since it is optional).
In this method the MELCOR outputfile is parsed and a CSV is created
@ In, command, string, the command used to run the just ended job
@ In, output, string, the Output name root
@ In, workingDir, string, current working dir
@ Out, output, string, optional, present in case the root of the output file gets changed in this method.
"""
output = self.melcorInterface.finalizeCodeOutput(
command, output, workingDir)
return output
def checkForOutputFailure(self, output, workingDir):
"""
This method is called by the RAVEN code at the end of each run if the return code is == 0.
This method needs to be implemented by the codes that, if the run fails, return a return code that is 0
This can happen in those codes that record the failure of the job (e.g. not converged, etc.) as normal termination (returncode == 0)
This method can be used, for example, to parse the outputfile looking for a special keyword that testifies that a particular job got failed
(e.g. in MELCOR would be the expression "Normal termination")
@ In, output, string, the Output name root
@ In, workingDir, string, current working dir
@ Out, failure, bool, True if the job is failed, False otherwise
"""
failure = self.melcorInterface.checkForOutputFailure(
output, workingDir)
return failure