src.poem.PoemTemplateInterface¶

Created on April 1, 2024 @author: wangc

This module is the POEM Template interface, which use the user provided input XML file to construct the corresponding RAVEN workflows i.e. RAVEN input XML file.

Attributes¶

`logger`
`fh`
`formatter`

Classes¶

PoemTemplateInterface

POEM Template Interface

Module Contents¶

src.poem.PoemTemplateInterface.logger[source]¶

src.poem.PoemTemplateInterface.fh[source]¶

src.poem.PoemTemplateInterface.formatter[source]¶

class src.poem.PoemTemplateInterface.PoemTemplateInterface(filename)[source]¶

Bases: object

POEM Template Interface

uniformDistNode[source]¶

samplerVarNode[source]¶

externalModelNode[source]¶

lhExternalModelNode[source]¶

lhModelNode[source]¶

reductionNode[source]¶

basisNode[source]¶

validAnalysis = ['sensitivity', 'sparse_grid_construction', 'sparse_grid_rom', 'lhs', 'mc', 'train_rom',...[source]¶

analysisRequired[source]¶

analysisOptions[source]¶

_inputFile[source]¶

_filenameRoot[source]¶

_inputVarList = [][source]¶

_outputVarList = [][source]¶

_externalModelList = [][source]¶

_externalModelInputDict[source]¶

_externalModelOutputDict[source]¶

_distList = [][source]¶

_samplerList = [][source]¶

_ensembleModelList = [][source]¶

_dsList = [][source]¶

_printList = [][source]¶

_variableGroupsList = [][source]¶

_inputDict[source]¶

_pivot = 'time'[source]¶

_limit = 1000[source]¶

_initSamples = 20[source]¶

_templateFile = None[source]¶

_analysisType = None[source]¶

_ravenNodeDict[source]¶

_statsPrefix = ['skewness', 'variationCoefficient', 'mean', 'kurtosis', 'median', 'max', 'min', 'var', 'sigma'][source]¶

_statsVectorPrefix = ['nsen', 'sen', 'pearson', 'cov', 'vsen', 'spearman'][source]¶

_polynomialOrder = '2'[source]¶

_sparseGridData = None[source]¶

_data = None[source]¶

_expTargets = None[source]¶

_expCov = None[source]¶

_dynamic = False[source]¶

_initInputs = None[source]¶

_globalSettings[source]¶

_restartTol = 0.01[source]¶

_miscDict[source]¶

getTemplateFile()[source]¶

getOutput()[source]¶: get the processed outputs from this class: PoemTemplateInterface @ In, None @ Out, (outputDict, miscDict), tuple, first dictionary contains the whole element that need to be appended in

the templated input, while the second dictionary contains only the values that need to be replaced.

readInput()[source]¶: Read the POEM input files, and construct corresponding ET elements @ In, None @ Out, None

readGlobalSettings(xmlNode)[source]¶: Read the RunInfo XML node from the input root @ In, xmlNode, xml.etree.ElementTree.Element, the input root xml @ Out, None

checkInput()[source]¶: Check the consistency of user provided inputs @ In, None @ Out, None

static buildPointSet(name, inputs, outputs)[source]¶: Build single PointSet XML node @ In, name, str, the name for the PointSet @ In, inputs, str, string that contains the list of input variables @ In, outputs, str, string that contains the list of output variables @ out, pointSet, xml.etree.ElementTree.Element, the constructed PointSet XML node

static buildHistorySet(name, inputs, outputs, pivot='time')[source]¶: Build single HistorySet XML node @ In, name, str, the name for the PointSet @ In, inputs, str, string that contains the list of input variables @ In, outputs, str, string that contains the list of output variables @ out, historySet, xml.etree.ElementTree.Element, the constructed HistorySet XML node

static buildPrint(name, source)[source]¶: Build single OutStream Print XML node @ In, name, str, the name for the PointSet @ In, source, str, string that contains name of Data Object @ out, printObj, xml.etree.ElementTree.Element, the constructed print XML node

buildSamplerVariable(inputs, distNode, limit=20, grid=False, init=None)[source]¶: build the sampler variable block

buildSparseGridSampler(name='SparseGrid')[source]¶

static buildMonteCarloSampler(name, limit)[source]¶

static buildVariableGroup(name, varList)[source]¶: Build variable group node @ In, name, str, the name for the variable group @ In, varList, list, list of variables @ out, group, xml.etree.ElementTree.Element, the constructed variable group XML node

buildStatsGroup(name, inputs, outputs)[source]¶: Build basic statistic variable group node @ In, name, str, the name for the variable group @ In, inputs, list, list of input variables @ In, outputs, list, list of output variables @ out, group, xml.etree.ElementTree.Element, the constructed variable group XML node

static findRequiredNode(xmlNode, nodeTag)[source]¶: Find the required xml node @ In, xmlNode, xml.etree.ElementTree.Element, xml element node @ In, nodeTag, str, node tag that is used to find the node @ Out, subnode, xml.etree.ElementTree.Element, xml element node