pywfm.IWFMModel.get_element_info#

IWFMModel.get_element_info()#

Return element configuration information for all elements in an IWFM model

Returns:: DataFrame containing subregion IDs, node order, and node IDs for each element ID
Return type:: pd.DataFrame

See also

IWFMModel.get_n_elements: Return the number of elements in an IWFM model
IWFMModel.get_element_ids: Return an array of element IDs in an IWFM model
IWFMModel.get_element_config: Return an array of node IDs for an IWFM element
IWFMModel.get_subregions_by_element: Return an array of IWFM elements contained in each subregion

Example

>>> from pywfm import IWFMModel
>>> pp_file = '../Preprocessor/PreProcessor_MAIN.IN'
>>> sim_file = 'Simulation_MAIN.IN'
>>> model = IWFMModel(pp_file, sim_file)
>>> model.get_element_info()
       IE   SR  NodeNum  NodeID
   0    1    1    Node1       1
   1    1    1    Node2       2
   2    1    1    Node3      23
   3    1    1    Node4      22
   4    2    1    Node1       2
 ...  ...  ...      ...     ...
1595  399    2    Node4     439
1596  400    2    Node1     419
1597  400    2    Node2     420
1598  400    2    Node3     441
1599  400    2    Node4     440
>>> model.kill()
>>> model.close_log_file()