Merge branch 'main' into release/0.3

Author: wenhuiuy

.github/dependabot.yml

@@ -4,9 +4,9 @@ updates:
     directory: "/" # Location of package manifests
     insecure-external-code-execution: allow
     schedule:
-      interval: "daily"
+      interval: "weekly"
 
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
-      interval: "daily"
+      interval: "weekly"

README.rst

@@ -77,9 +77,9 @@ Usage
 =====
 Here is a basic preprocessing example:
 
-Get the input file from "pydyna\\src\\ansys\\dyna\\core\\pre\\examples\\explicit\\ball_plate\\ball_plate.k"
+Get the input file from (``<repository-root-folder>/src/ansys/dyna/core/pre/examples/explicit/ball_plate/ball_plate.k``)
 
-The follow example can be obtained from "pydyna\\examples\\Explicit\\ball_plate.py"
+The follow example can be obtained from (``<repository-root-folder>/examples/Explicit/ball_plate.py``)
 
 .. code:: python
 
@@ -164,7 +164,7 @@ The follow example can be obtained from "pydyna\\examples\\Explicit\\ball_plate.
     
 Here is a basic solving example:
 
-The follow example can be obtained from "pydyna\\examples\\solver\\ball_plate_solver.py"
+The follow example can be obtained from (``<repository-root-folder>/examples/solver/ball_plate_solver.py``)
 
 .. code:: python
 

docker/pre/README.rst

@@ -20,18 +20,22 @@ Prerequisites
 
 * Ensure that Docker is installed on your machine. If you do not have Docker installed,
   see the `Docker website <https://www.docker.com>`_ for more information.
+  
+* If you are building the image on Windows, ensure that the Windows Subsystem for Linux (WSL)
+  is installed. For installation information, see Microsoft's
+  `Install Linux on Windows with WSL <https://learn.microsoft.com/en-us/windows/wsl/install>`_.
 
 * Download the latest Linux release artifacts for the Linux Docker container:
-  `linux-binaries.zip <https://github.com/ansys/pydyna/releases/download/v0.3.1/linux-binaries.zip>`_.
+  `linux-binaries.zip <https://github.com/ansys/pydyna/releases/download/v0.3.4/linux-binaries.zip>`_.
 
-* Move these ZIP files to the current location (``<repository-root-folder>/docker``).
+* Move this ZIP file to the current location (``<repository-root-folder>/docker/pre``).
 
 Starting the docker container
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 There are two ways to start docker container.
 
-1.bulid image and run container
+1.build image and run container
 
 
 Build the Docker image
@@ -74,7 +78,11 @@ Perform these steps to run the image as a container:
 
       docker run -d -p 50051:50051 ghcr.io/ansys/ls-pre 
 
-#. Check that the image is running successfully.
+#. Check that the image is running successfully by running this command.
+
+   .. code:: bash
+
+       docker ps
 
    Your output should look similar to this:
 

docker/solver/README.rst

@@ -25,17 +25,22 @@ Prerequisites
   `Install Linux on Windows with WSL <https://learn.microsoft.com/en-us/windows/wsl/install>`_.
 
 * Download the latest Linux release artifacts for the Linux Docker container:
-  `mppdyna_docker_centos7.zip <https://github.com/ansys/pydyna/releases/tag/v0.3.1/mppdyna_docker_centos7.zip>`_.
+  `mppdyna_docker_centos7.zip <https://github.com/ansys/pydyna/releases/download/v0.3.4/mppdyna_docker_centos7.zip>`_.
 
-* Move these ZIP files to a a local directory ``local_image_build_dir``. 
+* Move this ZIP file to the current location (``<repository-root-folder>/docker/solver``) and unzip the mppdyna_docker_centos7.zip file.
 
+   The files in this folder should look similar to this:
+
+   .. code:: bash
+
+       >>> Dockerfile README.rst do_build docker-compose.yml docker_dir mpi mppdyna_docker_centos7.zip
 
 Build the Docker image
 ----------------------
 
 Once all prerequisites are met, perform these steps to build the Docker image:
 
-#. In your terminal, go to the ``local_image_build_dir`` directory.
+#. In your terminal, go to the ``pydyna/docker/solver`` directory.
 #. Run this Docker command:
 
    .. code:: bash
@@ -71,9 +76,15 @@ Perform these steps to run the image as a container:
 
    .. code:: bash
 
-      docker compose up
+      docker compose up -d
+
+#. Check that the image is running successfully by running this command.
+
+   .. code:: bash
 
-#. Check that the image is running successfully.   
+       docker ps
+	   
+   Your output should look similar to this:  
 
    .. code:: bash
 

pyproject.toml

@@ -27,12 +27,12 @@ classifiers = [
 
 dependencies = [
     "ansys-dpf-core>=0.7.2",
-    "ansys-api-dyna==0.2.0",
+    "ansys-api-dyna==0.3.1",
 ]
 
 [project.optional-dependencies]
 tests = [
-    "pyvista==0.40.1",
+    "pyvista==0.41.1",
     "matplotlib==3.7.2",
     "numpy==1.25.2",
     "pytest==7.4.0",
@@ -49,24 +49,24 @@ doc = [
     "matplotlib==3.7.2",
     "imageio==2.31.1",
     "imageio-ffmpeg==0.4.8",
-    "pyvista==0.40.1",
+    "pyvista==0.41.1",
     "numpydoc==1.5.0",
-    "Sphinx==7.1.1",
+    "Sphinx==7.1.2",
     "sphinx-autobuild==2021.3.14",
     "sphinxcontrib-websupport==1.2.4",
     "pytest-sphinx==0.5.0",
     "sphinx-notfound-page==0.8.3",
     "sphinx-copybutton==0.5.2",
     "sphinx-gallery==0.13.0",
     "sphinx-autodoc-typehints==1.24.0",
-    "ansys-sphinx-theme==0.10.0",
+    "ansys-sphinx-theme==0.10.2",
     "pypandoc==1.11",
     "nbsphinx==0.9.2",
     "ipywidgets==8.1.0",
     "joblib==1.3.1",
     "scikit-learn==1.3.0",
     "ipython==8.14.0",
-    "jupyterlab==4.0.3",
+    "jupyterlab==4.0.4",
     "sphinx-jinja==2.0.2",
     "sphinx-autoapi==2.1.1",
 ]

src/ansys/dyna/core/pre/dynabase.py

@@ -113,21 +113,22 @@ class Curve:
 
     """
 
-    def __init__(self, sfo=1, x=[], y=[], func=None):
+    def __init__(self, sfo=1, x=[], y=[], func=None, title=""):
         self.sfo = sfo
         self.abscissa = x
         self.ordinate = y
         self.func = func
+        self.title = title
 
     def create(self, stub=None):
         """Create a curve."""
         if stub is None:
             stub = DynaBase.get_stub()
         if self.func != None:
-            ret = stub.CreateDefineCurveFunction(DefineCurveFunctionRequest(function=self.func))
+            ret = stub.CreateDefineCurveFunction(DefineCurveFunctionRequest(function=self.func, title=self.title))
         else:
             ret = stub.CreateDefineCurve(
-                DefineCurveRequest(sfo=self.sfo, abscissa=self.abscissa, ordinate=self.ordinate)
+                DefineCurveRequest(sfo=self.sfo, abscissa=self.abscissa, ordinate=self.ordinate, title=self.title)
             )
         self.id = ret.id
         logging.info(f"Curve {self.id} defined...")
@@ -148,6 +149,32 @@ def create(self, stub):
         return self.id
 
 
+class Table2D:
+    """Define a table,a curve ID is specified for each value defined in the table."""
+
+    def __init__(self, title=""):
+        self.title = title
+        self.valuecurvelist = []
+
+    def append(self, value=0, curve=None):
+        self.valuecurvelist.append((value, curve))
+
+    def create(self, stub=None):
+        """Create Table2D."""
+        if stub is None:
+            stub = DynaBase.get_stub()
+        vls = []
+        cvs = []
+        for obj in self.valuecurvelist:
+            vls.append(obj[0])
+            cid = obj[1].create(stub)
+            cvs.append(cid)
+        ret = stub.CreateDefineTable2D(DefineTable2DRequest(title=self.title, values=vls, cids=cvs))
+        self.id = ret.id
+        logging.info(f"Table2D {self.id} defined...")
+        return self.id
+
+
 class Point:
     """Defines a point."""
 
@@ -885,6 +912,33 @@ def create(self, stub):
         return self.id
 
 
+class NodeSetBox(BaseSet):
+    """include the nodes inside boxes.
+
+    Parameters
+        ----------
+        boxes : list
+            A list of BOX.
+    """
+
+    def __init__(self, boxes=[]):
+        self.boxes = boxes
+        self.type = "NODESETBOX"
+
+    def create(self, stub):
+        """Create a node set."""
+        if len(self.boxes) <= 0:
+            return 0
+        boxids = []
+        for box in self.boxes:
+            boxid = box.create(stub)
+            boxids.append(boxid)
+        ret = stub.CreateNodeSet(NodeSetRequest(option="GENERAL", sid=0, genoption="BOX", entities=boxids))
+        self.id = ret.id
+        self.type = "NODESETBOX"
+        return self.id
+
+
 class PartSet(BaseSet):
     """Defines a set of parts with optional attributes."""
 
@@ -1529,6 +1583,7 @@ def __init__(self, analysis_type=AnalysisType.IMPLICIT, initial_timestep_size=0)
         self.defined_dynamic = False
         self.defined_eigenvalue = False
         self.defined_solution = False
+        self.defined_mass_matrix = False
         self.imflag = analysis_type.value
         self.dt0 = initial_timestep_size
         self.stub = DynaBase.get_stub()
@@ -1640,6 +1695,10 @@ def set_solution(
         self.maxref = stiffness_reformation_limit
         self.abstol = absolute_convergence_tolerance
 
+    def set_consistent_mass_matrix(self):
+        """Use the consistent mass matrix in implicit dynamics and eigenvalue solutions."""
+        self.defined_mass_matrix = True
+
     def create(self):
         """Create an implicit analysis."""
         if self.defined == False:
@@ -1662,6 +1721,8 @@ def create(self):
                     nsolver=self.nsolver, ilimit=self.ilimit, maxref=self.maxref, abstol=self.abstol
                 )
             )
+        if self.defined_mass_matrix:
+            self.stub.CreateControlImplicitConsistentMass(ControlImplicitConsistentMassRequest(iflag=1))
 
 
 class ThermalAnalysisType(Enum):

src/ansys/dyna/core/pre/dynaem.py

@@ -669,6 +669,15 @@ def create(self):
         logging.info("EM Contact Created...")
 
 
+class EMRandlesLayer(Enum):
+    DEFAULT = 0
+    CURRENT_COLLECTOR_POSITIVE = 1
+    POSITIVE_ELECTRODE = 2
+    SEPARATOR = 3
+    NEGATIVE_ELECTRODE = 4
+    CURRENT_COLLECTOR_NEGATIVE = 5
+
+
 class Isopotential:
     """Defines an isopotential.
 
@@ -682,25 +691,29 @@ class Isopotential:
 
     isopotlist = []
 
-    def __init__(self, set=None):
+    def __init__(self, set=None, layer=EMRandlesLayer.DEFAULT):
         self.stub = DynaBase.get_stub()
         self.set = set
         self.id = 0
+        self.rdltype = layer.value
 
     def create(self):
         """Create an isopotential."""
-        isoinfo = [self.set.type, self.set.nodes]
+        if self.set.type == "NODESETBOX":
+            isoinfo = [self.set.type, self.set.boxes]
+        else:
+            isoinfo = [self.set.type, self.set.nodes]
         if isoinfo in Isopotential.isopotlist:
             pass
         id, settype = 0, 1
         if self.set is not None:
             id = self.set.create(self.stub)
             type = self.set.type
-            if type == "NODESET":
+            if type == "NODESET" or type == "NODESETBOX":
                 settype = 2
             elif type == "SEGMENTSET":
                 settype = 1
-        ret = self.stub.CreateEMIsopotential(EMIsopotentialRequest(settype=settype, setid=id))
+        ret = self.stub.CreateEMIsopotential(EMIsopotentialRequest(settype=settype, setid=id, rdltype=self.rdltype))
         self.id = ret.id
         logging.info(f"EM Isopotential {self.id} Created...")
         return self.id
@@ -732,3 +745,68 @@ def create(self):
         self.id = ret.id
         logging.info(f"EM Isopotential Rogo {self.id} Created...")
         return self.id
+
+
+class RandlesCellType(Enum):
+    USER_DEFINED_EQUIVALENT_CIRCUIT_MODEL = -1
+    RANDLES_CELL_0_ORDER = 0
+    RANDLES_CELL_1_ORDER = 1
+    RANDLES_CELL_2_ORDER = 2
+    RANDLES_CELL_3_ORDER = 3
+
+
+class RandlesCell:
+    """Define parameters for a Randles Cell."""
+
+    def __init__(self, set=None):
+        self.stub = DynaBase.get_stub()
+        self.define_batmac = False
+
+    def set_batmac_model(
+        self,
+        cell_type=RandlesCellType.RANDLES_CELL_1_ORDER,
+        cell_parts=None,
+        area=2,
+        cell_capacity=0,
+        soc_conversion_factor=0,
+        charge_init_state=0,
+        circuit_parameter=None,
+        constant_temperature=0,
+        temperature_from_thermal_solver=False,
+        add_heating_to_thermal_solver=False,
+    ):
+        """define the distributed Randles circuit parameters for a Randles cell when using the batmac model."""
+        self.define_batmac = True
+        self.rdltype = cell_type.value
+        self.rdlarea = area
+        self.psid = cell_parts
+        self.q = cell_capacity
+        self.cq = soc_conversion_factor
+        self.socinit = charge_init_state
+        self.prm = circuit_parameter
+        self.temp = constant_temperature
+        self.frther = temperature_from_thermal_solver
+        self.r0toth = add_heating_to_thermal_solver
+
+    def create(self):
+        """Set parameter for Randles Cell."""
+        if self.define_batmac:
+            sid = 0
+            if self.psid is not None:
+                sid = self.psid.create(self.stub)
+            ret = self.stub.CreateEMRandlesBatmac(
+                EMRandlesBatmacRequest(
+                    rdltype=self.rdltype,
+                    rdlarea=self.rdlarea,
+                    psid=sid,
+                    q=self.q,
+                    cq=self.cq,
+                    socinit=self.socinit,
+                    chargedirparam=self.prm,
+                    temp=self.temp,
+                    frther=self.frther,
+                    r0toth=self.r0toth,
+                )
+            )
+            self.id = ret.rdlid
+            logging.info(f"EM Randles Batmac {self.id} Created...")