CouplingInputFile¶
- class persalys.CouplingInputFile(*args)¶
Input file metadata for coupling.
- Parameters:
- pathstr
Path to the template file.
See also
Notes
By default the configured path is the basename of the template path, minus the .in extension.
Methods
Accessor to the object's name.
Template path accessor.
Variables format accessor.
getName
()Accessor to the object's name.
getPath
()Template file path accessor.
Tokens accessor.
Variable names accessor.
hasName
()Test if the object is named.
setConfiguredPath
(configuredPath)Configured path accessor.
setName
(name)Accessor to the object's name.
setPath
(templatePath)Template file path accessor.
setVariables
(variableNames, tokens, formats)Variables accessor.
simulateInput
- __init__(*args)¶
- getClassName()¶
Accessor to the object’s name.
- Returns:
- class_namestr
The object class name (object.__class__.__name__).
- getConfiguredPath()¶
Template path accessor.
- Returns:
- configured_pathstr
Relative path of the input file after replacement of input values in the working directory. It must be relative as each evaluation is isolated in its own temporary directory.
- getFormats()¶
Variables format accessor.
- Returns:
- formats
openturns.Description
Input variables format
- formats
- getName()¶
Accessor to the object’s name.
- Returns:
- namestr
The name of the object.
- getPath()¶
Template file path accessor.
- Returns:
- pathstr
Path to the template input file, preferably absolute.
- getTokens()¶
Tokens accessor.
- Returns:
- tokens
openturns.Description
Tokens for each variable
- tokens
- getVariableNames()¶
Variable names accessor.
- Returns:
- variable_names
openturns.Description
Input variable names
- variable_names
- hasName()¶
Test if the object is named.
- Returns:
- hasNamebool
True if the name is not empty.
- setConfiguredPath(configuredPath)¶
Configured path accessor.
- Parameters:
- configured_pathstr
Relative path of the input file after replacement of input values in the working directory. It must be relative as each evaluation is isolated in its own temporary directory.
- setName(name)¶
Accessor to the object’s name.
- Parameters:
- namestr
The name of the object.
- setPath(templatePath)¶
Template file path accessor.
- Parameters:
- pathstr
Path to the template input file, preferably absolute.
- setVariables(variableNames, tokens, formats)¶
Variables accessor.
- Parameters:
- namessequence of str
Variable names
- tokenssequence of str
Tokens used for replacement in the template file.
- formatssequence of str
Variable numerical formats