10457636660

Committed 19 Aug 2024 04:59PM UTC coverage: 74.078% (-0.003%) from 74.081%

Build # 10457636660

Build Type

push

github

Committed by

web-flow

Commit Message

[bugfix] Add overloaded `Mdb.Model` method to copy existing model (backport #5708) (#5709)

[bugfix] Add overloaded `Mdb.Model` method to copy existing model (#5708)

(cherry picked from commit c744f24c5)

Co-authored-by: Hailin Wang <hailin.wang@connect.polyu.hk>

Run Details

8 of 13 new or added lines in 1 file covered. (61.54%)

1 existing line in 1 file now uncovered.

24928 of 33651 relevant lines covered (74.08%)

0.74 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

76.0

/src/abaqus/Mdb/Mdb.py

from __future__ import annotations

import copy

from typing_extensions import Literal, overload

from abqpy.decorators import abaqus_class_doc, abaqus_method_doc

from ..Job.JobMdb import JobMdb
from ..Model.Model import Model
from ..Part.AcisMdb import AcisMdb
from ..UtilityAndView.abaqusConstants import NOT_SET, ON, STANDARD_EXPLICIT, Boolean
from ..UtilityAndView.abaqusConstants import abaqusConstants as C


@abaqus_class_doc
class Mdb(AcisMdb, JobMdb):
    """The Mdb object is the high-level Abaqus model database. A model database stores models and analysis
    controls.

    .. note::
        This object can be accessed by::

            mdb
    """

    @overload
    @abaqus_method_doc
    def Model(
        self,
        name: str,
        description: str = "",
        stefanBoltzmann: float | None = None,
        absoluteZero: float | None = None,
        waveFormulation: Literal[C.SCATTERED, C.NOT_SET, C.TOTAL] = NOT_SET,
        modelType: Literal[C.STANDARD_EXPLICIT, C.ELECTROMAGNETIC] = STANDARD_EXPLICIT,
        universalGas: float | None = None,
        copyConstraints: Boolean = ON,
        copyConnectors: Boolean = ON,
        copyInteractions: Boolean = ON,
    ) -> Model:
        """This method creates a Model object.

        .. note::
            This function can be accessed by::

                mdb.Model

        Parameters
        ----------
        name
            A String specifying the repository key.
        description
            A String specifying the purpose and contents of the Model object. The default value is
            an empty string.
        stefanBoltzmann
            None or a Float specifying the Stefan-Boltzmann constant. The default value is None.
        absoluteZero
            None or a Float specifying the absolute zero constant. The default value is None.
        waveFormulation
            A SymbolicConstant specifying the type of incident wave formulation to be used in
            acoustic problems. Possible values are NOT_SET, SCATTERED, and TOTAL. The default value
            is NOT_SET.
        modelType
            A SymbolicConstant specifying the analysis model type. Possible values are
            STANDARD_EXPLICIT and ELECTROMAGNETIC. The default is STANDARD_EXPLICIT.
        universalGas
            None or a Float specifying the universal gas constant. The default value is None.
        copyConstraints
            A boolean specifying whether to copy the constraints created in the model to the model
            that instances this model. The default value is ON.
        copyConnectors
            A boolean specifying whether to copy the connectors created in the model to the model
            that instances this model. The default value is ON.
        copyInteractions
            A boolean specifying whether to copy the interactions created in the model to the model
            that instances this model. The default value is ON.

        Returns
        -------
        model: Model
            A Model object
        """

    @overload
    @abaqus_method_doc
    def Model(self, name: str, objectToCopy: Model) -> Model:
        """This method creates a Model object.

        .. note::
            This function can be accessed by::

                mdb.Model

        Parameters
        ----------
        name
            A String specifying the repository key.
        objectToCopy
            A Model object to copy.
        """

    @abaqus_method_doc
    def Model(self, name: str, *args, **kwargs) -> Model:
        """This method creates a Model object.

        .. note::
            This function can be accessed by::

                mdb.Model

        Parameters
        ----------
        name
            A String specifying the repository key.
        args, kwargs
            Positional and keyword arguments to be passed to the Model object.
        """
        if len(args) == 1 and isinstance(args[0], Model):
            self.models[name] = model = copy.deepcopy(args[0])
        elif "objectToCopy" in kwargs and isinstance(kwargs["objectToCopy"], Model):
            self.models[name] = model = copy.deepcopy(kwargs["objectToCopy"])
        else:
            self.models[name] = model = Model(name, *args, **kwargs)
        return model

1	from __future__ import annotations	1✔
2
3	import copy	1✔
4
5	from typing_extensions import Literal, overload	1✔
6
7	from abqpy.decorators import abaqus_class_doc, abaqus_method_doc	1✔
8
9	from ..Job.JobMdb import JobMdb	1✔
10	from ..Model.Model import Model	1✔
11	from ..Part.AcisMdb import AcisMdb	1✔
12	from ..UtilityAndView.abaqusConstants import NOT_SET, ON, STANDARD_EXPLICIT, Boolean	1✔
13	from ..UtilityAndView.abaqusConstants import abaqusConstants as C	1✔
14
15
16	@abaqus_class_doc	1✔
17	class Mdb(AcisMdb, JobMdb):	1✔
18	"""The Mdb object is the high-level Abaqus model database. A model database stores models and analysis
19	controls.
20
21	.. note::
22	This object can be accessed by::
23
24	mdb
25	"""
26
27	@overload	1✔
28	@abaqus_method_doc	1✔
29	def Model(	1✔
30	self,
31	name: str,
32	description: str = "",
33	stefanBoltzmann: float \| None = None,
34	absoluteZero: float \| None = None,
35	waveFormulation: Literal[C.SCATTERED, C.NOT_SET, C.TOTAL] = NOT_SET,
36	modelType: Literal[C.STANDARD_EXPLICIT, C.ELECTROMAGNETIC] = STANDARD_EXPLICIT,
37	universalGas: float \| None = None,
38	copyConstraints: Boolean = ON,
39	copyConnectors: Boolean = ON,
40	copyInteractions: Boolean = ON,
41	) -> Model:
42	"""This method creates a Model object.
43
44	.. note::
45	This function can be accessed by::
46
47	mdb.Model
48
49	Parameters
50	----------
51	name
52	A String specifying the repository key.
53	description
54	A String specifying the purpose and contents of the Model object. The default value is
55	an empty string.
56	stefanBoltzmann
57	None or a Float specifying the Stefan-Boltzmann constant. The default value is None.
58	absoluteZero
59	None or a Float specifying the absolute zero constant. The default value is None.
60	waveFormulation
61	A SymbolicConstant specifying the type of incident wave formulation to be used in
62	acoustic problems. Possible values are NOT_SET, SCATTERED, and TOTAL. The default value
63	is NOT_SET.
64	modelType
65	A SymbolicConstant specifying the analysis model type. Possible values are
66	STANDARD_EXPLICIT and ELECTROMAGNETIC. The default is STANDARD_EXPLICIT.
67	universalGas
68	None or a Float specifying the universal gas constant. The default value is None.
69	copyConstraints
70	A boolean specifying whether to copy the constraints created in the model to the model
71	that instances this model. The default value is ON.
72	copyConnectors
73	A boolean specifying whether to copy the connectors created in the model to the model
74	that instances this model. The default value is ON.
75	copyInteractions
76	A boolean specifying whether to copy the interactions created in the model to the model
77	that instances this model. The default value is ON.
78
79	Returns
80	-------
81	model: Model
82	A Model object
83	"""
84
85	@overload	1✔
86	@abaqus_method_doc	1✔
87	def Model(self, name: str, objectToCopy: Model) -> Model:	1✔
88	"""This method creates a Model object.
89
90	.. note::
91	This function can be accessed by::
92
93	mdb.Model
94
95	Parameters
96	----------
97	name
98	A String specifying the repository key.
99	objectToCopy
100	A Model object to copy.
101	"""
102
103	@abaqus_method_doc	1✔
104	def Model(self, name: str, args, *kwargs) -> Model:	1✔
105	"""This method creates a Model object.
106
107	.. note::
108	This function can be accessed by::
109
110	mdb.Model
111
112	Parameters
113	----------
114	name
115	A String specifying the repository key.
116	args, kwargs
117	Positional and keyword arguments to be passed to the Model object.
118	"""
NEW 119	if len(args) == 1 and isinstance(args[0], Model):	×
NEW 120	self.models[name] = model = copy.deepcopy(args[0])	×
NEW 121	elif "objectToCopy" in kwargs and isinstance(kwargs["objectToCopy"], Model):	×
NEW 122	self.models[name] = model = copy.deepcopy(kwargs["objectToCopy"])	×
123	else:
NEW 124	self.models[name] = model = Model(name, args, *kwargs)	×
UNCOV 125	return model	×

haiiliin / abqpy / 10457636660

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous