Keyfile
The keyfile object contains and manages the contents of the entire LS-DYNA solver deck. Methods for this object are used to extract subsets of interest for iteration, to replace values in the keyword deck, and to write subsequent iterations of the original file.
Attributes
| Attribute | Type | Description |
|---|---|---|
| self.title | String | Keyword deck title (from *TITLE keyword) |
| self.string | String | Ascii contents of the keyword file |
| self.format | String | Keyword file type, "short" (comma separated), "fixed" (standard PrePost format), or "Long" (double length PrePost format) |
| self.path | String | File path to .k file |
| self.length | int | Number of ascii characters in the keyword file |
| self.keywordcount | int | Number of keywords in the file |
| self.keywordlocations | list[int] | List of the starting index of each keyword in the file |
Methods
init
Initialize a new keyword file object from a file input
class KeywordFile:
def __init__(self, path, format):
f=KeywordFile("/path/to.k","fixed")
inputs
| Attribute | Type | Description |
|---|---|---|
| path | String | Path to keyword file |
| format | String | Keyword file type, "short" (comma separated), "fixed" (standard PrePost format), or "Long" (double length PrePost format) |
returns
KeywordFile object
info
prints debugging information about the keyword file
def info(self)
f=KeywordFile("/path/to.k","fixed")
f.info()
>>Keyword file
>>Title: LS-DYNA Keyword Input
>>File length: 1000
>>Number of keywords: 4
>>Keyword locations: [10,52,100,516]
inputs
None.
returns
Prints the keyword file name (*TITLE keyword), file length (# characters), number of individual keywords, and the location of the starting character of each keyword.
get_keywords
Retrieve all keywords of a specified type
def get_keywords(self, keyword_title):
f=KeywordFile("/path/to.k","short")
elastic_mat_mods=f.get_keywords("MAT_ELASTIC")
inputs
| Attribute | Type | Description |
|---|---|---|
| keyword_title | String | keyword to search for, optional to include the "*" keyword delimeter |
returns
Returns Keyword object (one matching keyword found) or list of Keyword objects (multiple matching keywords found)
get_nodes
Create a Nodes object with all nodes in the keyword file
def get_nodes(self):
f=KeywordFile("/path/to.k","short")
f_nodes=f.get_nodes()
inputs
None.
returns
Returns a Nodes object (special keyword type) with the node numbers and coordinates stored in numpy array format.
get_elements
Create a Elements object with all elements of a specified type in the keyword file
def get_elements(self,eltype:str):
f=KeywordFile("/path/to.k","short")
f_solids=f.get_elements("SOLID")
f_quadraticsolids=f.get_elements("SOLID_T4TOT10")
inputs
| Attribute | Type | Description |
|---|---|---|
| eltype | String | element keyword name to find, without "ELEMENT_" (e.g., "SOLID" for "ELEMENT_SOLID" keyword) |
| returns |
Returns a Elements object with the keyword file element connectivity table as a numpy array (self.array)
get_set
Create a Set object with all sets of a specified type in the keyword file
def get_elements(self,eltype:str):
f=KeywordFile("/path/to.k","short")
f_nodes=f.get_elements()
inputs
| Attribute | Type | Description |
|---|---|---|
| eltype | String | element keyword name to find, without "SET_" (e.g., "NODE_LIST" for "SET_NODE_LIST" keyword) |
| returns |
Returns a Set object (or list of set objects) with all sets of the specified type.
replace_keyword
Replace an existing keyword in the solver deck with a new one.
def replace_keyword(self, keyword_to_replace):
f=KeywordFile("/path/to.k","short")
elastic_mat_mods=f.get_keywords("MAT_ELASTIC")
new_mat_mod=elastic_mat_mods[0].edit_card(0,0,1)
f.replace_keyword(new_mat_mod)
inputs
| Attribute | Type | Description |
|---|---|---|
| keyword_to_replace | Keyword object | Updated keyword containing the replacement context information |
returns
Updates the KeywordFile object string and keywordlocation information.
replace_card
Replace an existing card in the solver deck with a new one.
def replace_keyword(self, card_to_replace):
f=KeywordFile("/path/to.k","short")
elastic_mat_mods=f.get_keywords("MAT_ELASTIC")
new_mat_card_one=elastic_mat_mods[0].get_card
new_mat_card_one.edit(0,0,1)
f.replace_card(new_mat_card_one)
inputs
| Attribute | Type | Description |
|---|---|---|
| card_to_replace | Card object | Updated Card containing the replacement context information |
returns
Updates the KeywordFile object string and keywordlocation information.
write_keyfile
Writes a new keyword file output to the specified directory.
def write_keyfile(self, path):
f=KeywordFile("/path/to.k","short")
elastic_mat_mods=f.get_keywords("MAT_ELASTIC")
new_mat_mod=elastic_mat_mods[0].edit_card(0,0,1)
f.replace_keyword(new_mat_mod)
f.write_keyfile("/path/to_new.k")
inputs
| Attribute | Type | Description |
|---|---|---|
| path | String | File path to preferred output location |
returns
New .k file in specified directory.