feat: add parameter set to lib (#644)

Co-authored-by: Mohamed Koubaa <[email protected]>
Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: 4 people

doc/changelog/644.documentation.md

@@ -0,0 +1 @@
+add parameter set to lib

src/ansys/dyna/core/lib/card.py

@@ -29,6 +29,7 @@
 from ansys.dyna.core.lib.format_type import format_type
 from ansys.dyna.core.lib.io_utils import write_or_return
 from ansys.dyna.core.lib.kwd_line_formatter import load_dataline, read_line
+from ansys.dyna.core.lib.parameter_set import ParameterSet
 
 
 class Card(CardInterface):
@@ -54,22 +55,22 @@ def _convert_fields_to_long_format(self) -> typing.List[Field]:
             fields.append(new_field)
         return fields
 
-    def read(self, buf: typing.TextIO) -> bool:
+    def read(self, buf: typing.TextIO, parameter_set: ParameterSet = None) -> bool:
         if not self._is_active():
             return False
         line, to_exit = read_line(buf)
         if to_exit:
             return True
-        self._load(line)
+        self._load(line, parameter_set)
         return False
 
-    def _load(self, data_line: str) -> None:
+    def _load(self, data_line: str, parameter_set: ParameterSet) -> None:
         """loads the card data from a list of strings"""
         fields = self._fields
         if self.format == format_type.long:
             fields = self._convert_fields_to_long_format()
         format = [(field.offset, field.width, field.type) for field in fields]
-        values = load_dataline(format, data_line)
+        values = load_dataline(format, data_line, parameter_set)
         num_fields = len(fields)
         for field_index in range(num_fields):
             self._fields[field_index].value = values[field_index]

src/ansys/dyna/core/lib/card_interface.py

@@ -24,6 +24,7 @@
 import typing
 
 from ansys.dyna.core.lib.format_type import format_type
+from ansys.dyna.core.lib.parameter_set import ParameterSet
 
 # TODO - implement __repr__ on all cards
 
@@ -41,7 +42,7 @@ def __subclasshook__(cls, subclass):
         )
 
     @abc.abstractmethod
-    def read(self, buf: typing.TextIO) -> None:
+    def read(self, buf: typing.TextIO, parameter_set: typing.Optional[ParameterSet]) -> None:
         """Reads the card data from an input text buffer."""
         raise NotImplementedError
 

src/ansys/dyna/core/lib/card_set.py

@@ -34,6 +34,7 @@
 from ansys.dyna.core.lib.io_utils import write_or_return
 from ansys.dyna.core.lib.kwd_line_formatter import at_end_of_keyword
 from ansys.dyna.core.lib.option_card import OptionSpec
+from ansys.dyna.core.lib.parameter_set import ParameterSet
 
 
 class CardSet(CardInterface):
@@ -137,37 +138,37 @@ def _write(buf: typing.TextIO):
 
         return write_or_return(buf, _write)
 
-    def _read_item_cards(self, buf: typing.TextIO, index: int) -> bool:
+    def _read_item_cards(self, buf: typing.TextIO, index: int, parameter_set: ParameterSet) -> bool:
         item = self._items[index]
         for card in item._get_all_cards():
-            ret = card.read(buf)
+            ret = card.read(buf, parameter_set)
             if ret:
                 # according to the card, we are at the end of the keyword, so
                 # we can break out of the card reading loop.
                 return True
         return False
 
-    def _load_bounded_from_buffer(self, buf: typing.TextIO) -> None:
+    def _load_bounded_from_buffer(self, buf: typing.TextIO, parameter_set: ParameterSet) -> None:
         length = self._length_func()
         for index in range(length):
-            if self._read_item_cards(buf, index):
+            if self._read_item_cards(buf, index, parameter_set):
                 break
 
-    def _load_unbounded_from_buffer(self, buf: typing.TextIO) -> None:
+    def _load_unbounded_from_buffer(self, buf: typing.TextIO, parameter_set: ParameterSet) -> None:
         index = -1
         while True:
             self._add_item_simple()
             index += 1
-            self._read_item_cards(buf, index)
+            self._read_item_cards(buf, index, parameter_set)
             if at_end_of_keyword(buf):
                 # the buffer is at the end of the keyword, exit
                 return
 
-    def read(self, buf: typing.TextIO) -> bool:
+    def read(self, buf: typing.TextIO, parameter_set: ParameterSet = None) -> bool:
         self._initialize()
         if self.bounded:
-            self._load_bounded_from_buffer(buf)
+            self._load_bounded_from_buffer(buf, parameter_set)
             return False
         else:
-            self._load_unbounded_from_buffer(buf)
+            self._load_unbounded_from_buffer(buf, parameter_set)
             return True

src/ansys/dyna/core/lib/cards.py

@@ -20,7 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-"""Base class for cards and I/O"""
+"""Base class for cards and I/O."""
 
 import typing
 
@@ -29,6 +29,7 @@
 from ansys.dyna.core.lib.format_type import format_type
 from ansys.dyna.core.lib.kwd_line_formatter import read_line
 from ansys.dyna.core.lib.option_card import OptionCardSet, OptionsAPI
+from ansys.dyna.core.lib.parameter_set import ParameterSet
 
 
 class Cards:
@@ -141,14 +142,12 @@ def _try_read_options_with_no_title(self, buf: typing.TextIO) -> None:
         if not any_options_read:
             buf.seek(pos)
 
-    def _read_data(self, buf: typing.TextIO) -> None:
+    def _read_data(self, buf: typing.TextIO, parameters: ParameterSet) -> None:
         for card in self._get_pre_option_cards():
-            card.read(buf)
-
+            card.read(buf, parameters)
         for card in self._get_non_option_cards():
-            card.read(buf)
-
+            card.read(buf, parameters)
         for card in self._get_post_option_cards():
-            card.read(buf)
+            card.read(buf, parameters)
 
         self._try_read_options_with_no_title(buf)

src/ansys/dyna/core/lib/deck.py

@@ -30,6 +30,7 @@
 from ansys.dyna.core.lib.format_type import format_type
 from ansys.dyna.core.lib.io_utils import write_or_return
 from ansys.dyna.core.lib.keyword_base import KeywordBase
+from ansys.dyna.core.lib.parameter_set import ParameterSet
 
 
 class Deck:
@@ -38,6 +39,7 @@ class Deck:
     def __init__(self, title: str = None, **kwargs):
         """Initialize the deck."""
         self._keywords: typing.List = kwargs.get("keywords", [])
+        self._parameter_set = ParameterSet()
         self.comment_header: str = None
         self.title: str = title
         self.format: format_type = kwargs.get("format", format_type.default)
@@ -56,6 +58,10 @@ def clear(self):
         self.title = None
         self.format = format_type.default
 
+    @property
+    def parameters(self) -> ParameterSet:
+        return self._parameter_set
+
     @property
     def format(self) -> format_type:
         """Format type of the deck."""

src/ansys/dyna/core/lib/deck_loader.py

@@ -142,9 +142,9 @@ def handle_keyword(block: typing.List[str], deck: "ansys.dyna.core.deck.Deck") -
                 format = deck.format
             keyword_object.format = format
             try:
-                keyword_object.loads(keyword_data)
+                keyword_object.loads(keyword_data, deck.parameters)
                 deck.append(keyword_object)
-            except Exception:
+            except:
                 result.add_unprocessed_keyword(keyword)
                 deck.append(keyword_data)
 

src/ansys/dyna/core/lib/duplicate_card.py

@@ -31,6 +31,7 @@
 from ansys.dyna.core.lib.format_type import format_type
 from ansys.dyna.core.lib.io_utils import write_or_return
 from ansys.dyna.core.lib.kwd_line_formatter import buffer_to_lines
+from ansys.dyna.core.lib.parameter_set import ParameterSet
 
 CHECK_TYPE = True
 
@@ -138,7 +139,9 @@ def _get_read_options(self):
         options = {"names": names, "colspecs": colspecs, "dtype": dtype, "comment": "$"}
         return options
 
-    def _read_buffer_as_dataframe(self, buffer: typing.TextIO, fields: typing.Iterable[Field]) -> pd.DataFrame:
+    def _read_buffer_as_dataframe(
+        self, buffer: typing.TextIO, fields: typing.Iterable[Field], parameter_set: ParameterSet
+    ) -> pd.DataFrame:
         read_options = self._get_read_options()
         df = pd.read_fwf(buffer, **read_options)
         return df
@@ -149,32 +152,32 @@ def _get_fields(self) -> typing.List[Field]:
             fields = self._convert_fields_to_long_format()
         return fields
 
-    def _load_bounded_from_buffer(self, buf: typing.TextIO) -> None:
+    def _load_bounded_from_buffer(self, buf: typing.TextIO, parameter_set: ParameterSet) -> None:
         read_options = self._get_read_options()
         read_options["nrows"] = self._num_rows()
         df = pd.read_fwf(buf, **read_options)
         self._table = df
         self._initialized = True
 
-    def _load_unbounded_from_buffer(self, buf: typing.TextIO) -> None:
+    def _load_unbounded_from_buffer(self, buf: typing.TextIO, parameter_set: ParameterSet) -> None:
         data_lines = buffer_to_lines(buf)
-        self._load_lines(data_lines)
+        self._load_lines(data_lines, parameter_set)
 
-    def read(self, buf: typing.TextIO) -> None:
+    def read(self, buf: typing.TextIO, parameter_set: ParameterSet = None) -> None:
         if self.bounded:
             self._initialized = True
-            self._load_bounded_from_buffer(buf)
+            self._load_bounded_from_buffer(buf, parameter_set)
         else:
             self._initialize_data(0)
             self._initialized = True
-            self._load_unbounded_from_buffer(buf)
+            self._load_unbounded_from_buffer(buf, parameter_set)
 
-    def _load_lines(self, data_lines: typing.List[str]) -> None:
+    def _load_lines(self, data_lines: typing.List[str], parameter_set: ParameterSet) -> None:
         fields = self._get_fields()
         buffer = io.StringIO()
         [(buffer.write(line), buffer.write("\n")) for line in data_lines]
         buffer.seek(0)
-        self._table = self._read_buffer_as_dataframe(buffer, fields)
+        self._table = self._read_buffer_as_dataframe(buffer, fields, parameter_set)
         self._initialized = True
 
     def write(

src/ansys/dyna/core/lib/duplicate_card_group.py

@@ -32,6 +32,7 @@
 from ansys.dyna.core.lib.format_type import format_type
 from ansys.dyna.core.lib.io_utils import write_or_return
 from ansys.dyna.core.lib.kwd_line_formatter import buffer_to_lines
+from ansys.dyna.core.lib.parameter_set import ParameterSet
 
 
 def _to_duplicate_card(card: Card, length_func: typing.Callable) -> DuplicateCard:
@@ -99,25 +100,25 @@ def format(self, value: format_type) -> None:
         for card in self._cards:
             card.format = value
 
-    def _load_unbounded_from_buffer(self, buf: typing.TextIO) -> None:
+    def _load_unbounded_from_buffer(self, buf: typing.TextIO, parameter_set: ParameterSet) -> None:
         data_lines = buffer_to_lines(buf)
-        self._load_lines(data_lines)
+        self._load_lines(data_lines, parameter_set)
 
-    def _load_bounded_from_buffer(self, buf: typing.TextIO) -> None:
+    def _load_bounded_from_buffer(self, buf: typing.TextIO, parameter_set: ParameterSet) -> None:
         data_lines = buffer_to_lines(buf, self._num_rows())
-        self._load_lines(data_lines)
+        self._load_lines(data_lines, parameter_set)
 
-    def read(self, buf: typing.TextIO) -> None:
+    def read(self, buf: typing.TextIO, parameter_set: ParameterSet = None) -> None:
         if self.bounded:
-            self._load_bounded_from_buffer(buf)
+            self._load_bounded_from_buffer(buf, parameter_set)
         else:
-            self._load_unbounded_from_buffer(buf)
+            self._load_unbounded_from_buffer(buf, parameter_set)
 
-    def _load_lines(self, data_lines: typing.List[str]) -> None:
+    def _load_lines(self, data_lines: typing.List[str], parameter_set: ParameterSet) -> None:
         """Load the card data from a list of strings."""
         card_lines = self._divide_data_lines(data_lines)
         for index, lines in enumerate(card_lines):
-            self._cards[index]._load_lines(lines)
+            self._cards[index]._load_lines(lines, parameter_set)
         self.table = pd.concat([card.table for card in self._cards], axis=1)
 
     def write(

src/ansys/dyna/core/lib/keyword_base.py

@@ -28,6 +28,7 @@
 from ansys.dyna.core.lib.cards import Cards
 from ansys.dyna.core.lib.format_type import format_type
 from ansys.dyna.core.lib.option_card import OptionsAPI
+from ansys.dyna.core.lib.parameter_set import ParameterSet
 
 
 class KeywordBase(Cards):
@@ -269,20 +270,20 @@ def _process_title(self, title_line: str) -> None:
             return title_line[:-1]
         return title_line
 
-    def read(self, buf: typing.TextIO) -> None:
+    def read(self, buf: typing.TextIO, parameters: ParameterSet = None) -> None:
         title_line = buf.readline()
         title_line = self._process_title(title_line)
         self.before_read(buf)
         if title_line != self.get_title():
             self._activate_options(title_line.strip("*"))
         # TODO: self.user_comment should come from somewhere.
         # maybe after the keyword but before any $#
-        self._read_data(buf)
+        self._read_data(buf, parameters)
 
-    def loads(self, value: str) -> None:
+    def loads(self, value: str, parameters: ParameterSet = None) -> None:
         """Load the keyword from string."""
         # TODO - add a method to load from a buffer.
         s = io.StringIO()
         s.write(value)
         s.seek(0)
-        self.read(s)
+        self.read(s, parameters)