Important inpRW Attributes¶
Since inpRW is a large project, here is a summary of the key attributes with which a user might wish to interact.
keywords¶
keywords is the inpKeywordSequence that contains the parsed keyword blocks.
This is the most important attribute of inpRW, as all of the information from the input file is stored here.
kwg¶
Short for keyword group. kwg is a csid that uses the keyword names in the input file as keys.
The value for a given key is a set containing all keyword blocks with that name. For example, inp.kwg['STEP'] will
contain all the *STEP keyword blocks. Since a set is naturally unsorted, use sortKWs()
if you need the keywords in their original order.
steps¶
steps is a csid with the step names as the key, and the corresponding step keyword block as
the value. If the NAME parameter[2] is not specified for a keyword block, an integer
corresponding to the steps index in kwg[‘STEP’] is used as the key.
step_paths¶
step_paths is a list that contains the path to each *STEP keyword block in their proper order.
nd¶
nd is a TotalMesh instance, which behaves similarly to a dictionary. It directly references
every node in the input file. The keys to nd are node labels, and the values are Node instances.
ed¶
ed is a TotalMesh instance, which behaves similarly to a dictionary. It directly references
every element in the input file. The keys to ed are element labels, and the values are Element instances.
inpName¶
inpName is a string that corresponds to the name of the input file (including the extension,
but not the full path to the file).
inputFolder¶
inputFolder is a string that represents the path to the input file. The value will be parsed
from the inpName parameter[1] of inpRW when instancing inpRW if
inpName includes the full path. If inpName does not contain the path, inputFolder will be a blank string.
inputFolder will be prepended to inpName when reading files with inpRW.
outputFolder¶
outputFolder is a string that represents the path to which new input files will
be written. The value will be parsed from the inpName parameter[1] of inpRW when instancing
inpRW if inpName includes the full path. If inpName does not contain the path, outputFolder
will be a blank string. outputFolder can of course be manually set prior to writing out new input files.
outputFolder will be prepended to inpName when writing new files.
jobSuffix¶
jobSuffix is a string that will be appended to inpName (without the file extension)
when writing out an input file or any reference to a new input file. If the jobSuffix parameter [1]
is not specified when instancing inpRW, it will default to ‘_NEW.inp’. If using Keyword Edit with
3DEXPERIENCE, jobSuffix should be set to ‘_NEW.inp’.
includeFileNames¶
includeFileNames is a list which contains the names of all input files read in by
the parent input file. This will cover *INCLUDE, *MANIFEST, and any keyword that reads its data from another
input file.
includeBlockPaths¶
includeBlockPaths is a list that contains the path to each block in keywords
that reads from a secondary input file.