support em_randles_short,control_thermal,add parameter for hourglass

Author: zhangzhanqun

pyproject.toml

@@ -27,7 +27,7 @@ classifiers = [
 
 dependencies = [
     "ansys-dpf-core>=0.7.2",
-    "ansys-api-dyna==0.3.1",
+    "ansys-api-dyna==0.3.2",
 ]
 
 [project.optional-dependencies]

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

@@ -1271,9 +1271,18 @@ def __init__(self, pid):
         self.des_nsid = 0
         self.des_rsf = 1
 
-    def set_hourglass(self, type=HourglassType.STANDARD_LSDYNA_VISCOUS):
-        """Set the hourglass type, which identifies the bulk viscosity."""
+    def set_hourglass(self, type=HourglassType.STANDARD_LSDYNA_VISCOUS, coefficient=0.1):
+        """Set the hourglass type, which identifies the bulk viscosity.
+
+        Parameters
+        ----------
+        type : enum
+            Default hourglass control type.
+        coefficient : float, optional
+            Default hourglass coefficient. The default is ``0.``.
+        """
         self.hourglasstype = type.value
+        self.coefficient = coefficient
 
     def set_shear_factor(self, factor):
         """Set the shear correction factor, which scales the transverse shear stress."""
@@ -1344,7 +1353,9 @@ def set_property(self):
         )
         self.secid = sec.id
         if self.hourglasstype > 0:
-            ret = self.stub.CreateHourglass(HourglassRequest(ihq=self.hourglasstype, qm=1, q1=0, q2=0, qb=0, qw=0))
+            ret = self.stub.CreateHourglass(
+                HourglassRequest(ihq=self.hourglasstype, qm=self.coefficient, q1=0, q2=0, qb=0, qw=0)
+            )
             self.hgid = ret.id
         else:
             self.hgid = 0
@@ -1423,16 +1434,27 @@ def __init__(self, pid):
         self.type = "SOLID"
         self.hourglasstype = -1
 
-    def set_hourglass(self, type=HourglassType.STANDARD_LSDYNA_VISCOUS):
-        """Set the hourglass type, which identifies the bulk viscosity."""
+    def set_hourglass(self, type=HourglassType.STANDARD_LSDYNA_VISCOUS, coefficient=0.1):
+        """Set the hourglass type, which identifies the bulk viscosity.
+
+        Parameters
+        ----------
+        type : enum
+            Default hourglass control type.
+        coefficient : float, optional
+            Default hourglass coefficient. The default is ``0.``.
+        """
         self.hourglasstype = type.value
+        self.coefficient = coefficient
 
     def set_property(self):
         """Set the properties for the solid part."""
         ret = self.stub.CreateSectionSolid(SectionSolidRequest(elform=self.formulation))
         self.secid = ret.id
         if self.hourglasstype > 0:
-            ret = self.stub.CreateHourglass(HourglassRequest(ihq=self.hourglasstype, qm=1, q1=0, q2=0, qb=0, qw=0))
+            ret = self.stub.CreateHourglass(
+                HourglassRequest(ihq=self.hourglasstype, qm=self.coefficient, q1=0, q2=0, qb=0, qw=0)
+            )
             self.hgid = ret.id
         else:
             self.hgid = 0
@@ -1741,6 +1763,7 @@ class ThermalAnalysis:
     def __init__(self):
         self.defined_solver = False
         self.defined_timestep = False
+        self.defined_nonlinear = False
         self.stub = DynaBase.get_stub()
 
     def set_timestep(self, timestep_control=ThermalAnalysisTimestep.FIXED, initial_timestep=0):
@@ -1768,6 +1791,20 @@ def set_solver(self, analysis_type=ThermalAnalysisType.STEADY_STATE):
         self.defined_solver = True
         self.atype = analysis_type.value
 
+    def set_nonlinear(self, convergence_tol=1e-4, divergence=0.5):
+        """Set parameters for a nonlinear thermal or coupled structural/thermal analysis.
+
+        Parameters
+        ----------
+        convergence_tol : float
+            Convergence tolerance for temperature.
+        divergence : float
+            Divergence control parameter.
+        """
+        self.defined_nonlinear = True
+        self.tol = convergence_tol
+        self.dcp = divergence
+
     def create(self):
         """Create a thermal analysis."""
         if self.defined_timestep:
@@ -1776,6 +1813,8 @@ def create(self):
             self.stub.CreateControlThermalSolver(ControlThermalSolverRequest(atype=self.atype))
         if self.defined_timestep or self.defined_solver:
             self.stub.CreateControlSolution(ControlSolutionRequest(soln=2))
+        if self.defined_nonlinear:
+            self.stub.CreateControlThermalNonlinear(ControlThermalNonlinearRequest(tol=self.tol, dcp=self.dcp))
 
 
 class ContactCategory(Enum):

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

@@ -761,6 +761,7 @@ class RandlesCell:
     def __init__(self, set=None):
         self.stub = DynaBase.get_stub()
         self.define_batmac = False
+        self.define_randles_short = False
 
     def set_batmac_model(
         self,
@@ -770,6 +771,7 @@ def set_batmac_model(
         cell_capacity=0,
         soc_conversion_factor=0,
         charge_init_state=0,
+        equilibrium_voltage=None,
         circuit_parameter=None,
         constant_temperature=0,
         temperature_from_thermal_solver=False,
@@ -783,17 +785,32 @@ def set_batmac_model(
         self.q = cell_capacity
         self.cq = soc_conversion_factor
         self.socinit = charge_init_state
+        self.soctou = equilibrium_voltage
         self.prm = circuit_parameter
         self.temp = constant_temperature
         self.frther = temperature_from_thermal_solver
         self.r0toth = add_heating_to_thermal_solver
 
+    def set_randles_short(self, resistances_func=None):
+        """Define conditions to turn on a Randles short (replace one or several Randles circuits by resistances),
+        and to define the value of the short resistance.
+
+        Parameters
+        ----------
+        resistances_func : Function
+            Define the local resistance function of local parameters for the local Randles circuit.
+
+        """
+        self.define_randles_short = True
+        self.randles_short_function = resistances_func
+
     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)
+            soctou = self.soctou.create(self.stub)
             ret = self.stub.CreateEMRandlesBatmac(
                 EMRandlesBatmacRequest(
                     rdltype=self.rdltype,
@@ -802,6 +819,7 @@ def create(self):
                     q=self.q,
                     cq=self.cq,
                     socinit=self.socinit,
+                    soctou=soctou,
                     chargedirparam=self.prm,
                     temp=self.temp,
                     frther=self.frther,
@@ -810,3 +828,9 @@ def create(self):
             )
             self.id = ret.rdlid
             logging.info(f"EM Randles Batmac {self.id} Created...")
+        if self.define_randles_short:
+            fid = 0
+            if self.randles_short_function is not None:
+                fid = self.randles_short_function.create(self.stub)
+            ret = self.stub.CreateEMRandlesShort(EMRandlesShortRequest(function=fid))
+            logging.info(f"EM Randles Short Created...")