This repository has been archived by the owner on Mar 4, 2023. It is now read-only.
/
FluidExchange.py
91 lines (75 loc) · 2.93 KB
/
FluidExchange.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
from abaqusConstants import *
from .Interaction import Interaction
class FluidExchange(Interaction):
"""The FluidExchange object is used to define fluid exchange between two fluid cavities or
between a fluid cavity and its environment.
The FluidExchange object is derived from the Interaction object.
Notes
-----
This object can be accessed by:
.. code-block:: python
import interaction
mdb.models[name].interactions[name]
The corresponding analysis keywords are:
- FLUID EXCHANGE
"""
def __init__(
self,
name: str,
createStepName: str,
firstCavity: str,
interactionProperty: str,
definition: SymbolicConstant = TO_ENVIRONMENT,
secondCavity: str = "",
exchangeArea: float = 1,
):
"""This method creates an FluidExchange object.
Notes
-----
This function can be accessed by:
.. code-block:: python
mdb.models[name].FluidExchange
Parameters
----------
name
A String specifying the repository key.
createStepName
A String specifying the name of the step in which the FluidExchange object is created.
firstCavity
A String specifying the first FluidCavity object associated with this interaction. This
will be the only cavity specified if *definition*=TO_ENVIRONMENT.
interactionProperty
A String specifying the FluidExchangeProperty object associated with this interaction.
definition
A SymbolicConstant specifying the type of fluid exchange to be defined. Possible values
are TO_ENVIRONMENT and BETWEEN_CAVITIES. The default value is TO_ENVIRONMENT.
secondCavity
A String specifying the second FluidCavity object associated with this interaction. This
argument is applicable only when *definition*=BETWEEN_CAVITIES.
exchangeArea
A Float specifying the effective exchange area. The default value is 1.0.
Returns
-------
A FluidExchange object.
"""
super().__init__()
pass
def setValues(
self,
definition: SymbolicConstant = TO_ENVIRONMENT,
secondCavity: str = "",
exchangeArea: float = 1,
):
"""This method modifies the FluidExchange object.
Parameters
----------
definition
A SymbolicConstant specifying the type of fluid exchange to be defined. Possible values
are TO_ENVIRONMENT and BETWEEN_CAVITIES. The default value is TO_ENVIRONMENT.
secondCavity
A String specifying the second FluidCavity object associated with this interaction. This
argument is applicable only when *definition*=BETWEEN_CAVITIES.
exchangeArea
A Float specifying the effective exchange area. The default value is 1.0.
"""
pass