devsim 2.12.0__cp315-abi3t-win_amd64.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- devsim/__init__.py +33 -0
- devsim/__init__.pyi +2155 -0
- devsim/devsim_py3.pyd +0 -0
- devsim/python_packages/Klaassen.py +336 -0
- devsim/python_packages/__init__.py +0 -0
- devsim/python_packages/fermi_physics.py +31 -0
- devsim/python_packages/model_create.py +261 -0
- devsim/python_packages/mos_physics.py +170 -0
- devsim/python_packages/pythonmesh.py +131 -0
- devsim/python_packages/ramp.py +101 -0
- devsim/python_packages/simple_dd.py +75 -0
- devsim/python_packages/simple_physics.py +463 -0
- devsim/umfpack/umfpack_lgpl.dll +0 -0
- devsim/umfpack/umfpack_loader.py +538 -0
- devsim/umfpack/umfshim.py +115 -0
- devsim-2.12.0.data/data/devsim_data/BUILD.md +135 -0
- devsim-2.12.0.data/data/devsim_data/CHANGES.md +935 -0
- devsim-2.12.0.data/data/devsim_data/CITATION.cff +33 -0
- devsim-2.12.0.data/data/devsim_data/CITATION.md +23 -0
- devsim-2.12.0.data/data/devsim_data/CODE_OF_CONDUCT.md +74 -0
- devsim-2.12.0.data/data/devsim_data/CONTRIBUTING.md +43 -0
- devsim-2.12.0.data/data/devsim_data/HOWTO.md +25 -0
- devsim-2.12.0.data/data/devsim_data/INSTALL.md +84 -0
- devsim-2.12.0.data/data/devsim_data/LICENSE +202 -0
- devsim-2.12.0.data/data/devsim_data/NOTICE +241 -0
- devsim-2.12.0.data/data/devsim_data/README.md +99 -0
- devsim-2.12.0.data/data/devsim_data/TEST.md +13 -0
- devsim-2.12.0.data/data/devsim_data/VERSION +3 -0
- devsim-2.12.0.data/data/devsim_data/doc/devsim.pdf +0 -0
- devsim-2.12.0.data/data/devsim_data/doc/symdiff.pdf +0 -0
- devsim-2.12.0.data/data/devsim_data/examples/bioapp1/Ve0.jpg +0 -0
- devsim-2.12.0.data/data/devsim_data/examples/bioapp1/Ve0_3d.jpg +0 -0
- devsim-2.12.0.data/data/devsim_data/examples/bioapp1/Ve7.jpg +0 -0
- devsim-2.12.0.data/data/devsim_data/examples/bioapp1/Ve7_3d.jpg +0 -0
- devsim-2.12.0.data/data/devsim_data/examples/bioapp1/bioapp1_2d.py +85 -0
- devsim-2.12.0.data/data/devsim_data/examples/bioapp1/bioapp1_3d.py +85 -0
- devsim-2.12.0.data/data/devsim_data/examples/bioapp1/bioapp1_common.py +399 -0
- devsim-2.12.0.data/data/devsim_data/examples/bioapp1/disk_2d.geo +62 -0
- devsim-2.12.0.data/data/devsim_data/examples/bioapp1/disk_2d.msh +65606 -0
- devsim-2.12.0.data/data/devsim_data/examples/bioapp1/disk_3d.geo +183 -0
- devsim-2.12.0.data/data/devsim_data/examples/bioapp1/disk_3d.msh +25808 -0
- devsim-2.12.0.data/data/devsim_data/examples/capacitance/cap.lay +1587 -0
- devsim-2.12.0.data/data/devsim_data/examples/capacitance/cap1d.py +155 -0
- devsim-2.12.0.data/data/devsim_data/examples/capacitance/cap2d.py +200 -0
- devsim-2.12.0.data/data/devsim_data/examples/diode/3dblock.geo +48 -0
- devsim-2.12.0.data/data/devsim_data/examples/diode/diode_1d.py +94 -0
- devsim-2.12.0.data/data/devsim_data/examples/diode/diode_1d_custom.py +159 -0
- devsim-2.12.0.data/data/devsim_data/examples/diode/diode_2d.py +68 -0
- devsim-2.12.0.data/data/devsim_data/examples/diode/diode_common.py +253 -0
- devsim-2.12.0.data/data/devsim_data/examples/diode/diode_current.lay +3271 -0
- devsim-2.12.0.data/data/devsim_data/examples/diode/diode_density.lay +3271 -0
- devsim-2.12.0.data/data/devsim_data/examples/diode/diode_potential.lay +3272 -0
- devsim-2.12.0.data/data/devsim_data/examples/diode/gmsh_diode2d.msh +1477 -0
- devsim-2.12.0.data/data/devsim_data/examples/diode/gmsh_diode2d.py +55 -0
- devsim-2.12.0.data/data/devsim_data/examples/diode/gmsh_diode3d.msh +8557 -0
- devsim-2.12.0.data/data/devsim_data/examples/diode/gmsh_diode3d.py +74 -0
- devsim-2.12.0.data/data/devsim_data/examples/diode/gmsh_diode3d_equil.py +43 -0
- devsim-2.12.0.data/data/devsim_data/examples/diode/gmsh_diode3d_float128.py +85 -0
- devsim-2.12.0.data/data/devsim_data/examples/diode/laux2d.py +43 -0
- devsim-2.12.0.data/data/devsim_data/examples/diode/laux3d.py +54 -0
- devsim-2.12.0.data/data/devsim_data/examples/diode/laux_common.py +503 -0
- devsim-2.12.0.data/data/devsim_data/examples/diode/pythonmesh3d.py +61 -0
- devsim-2.12.0.data/data/devsim_data/examples/diode/ssac_diode.py +57 -0
- devsim-2.12.0.data/data/devsim_data/examples/diode/tran_diode.py +63 -0
- devsim-2.12.0.data/data/devsim_data/examples/mobility/gmsh_mos2d.geo +160 -0
- devsim-2.12.0.data/data/devsim_data/examples/mobility/gmsh_mos2d.msh +8599 -0
- devsim-2.12.0.data/data/devsim_data/examples/mobility/gmsh_mos2d.py +96 -0
- devsim-2.12.0.data/data/devsim_data/examples/mobility/gmsh_mos2d_create.py +174 -0
- devsim-2.12.0.data/data/devsim_data/examples/mobility/gmsh_mos2d_kla.py +162 -0
- devsim-2.12.0.data/data/devsim_data/examples/mobility/logElectrons.lay +1327 -0
- devsim-2.12.0.data/data/devsim_data/examples/mobility/pythonmesh2d.py +100 -0
- devsim-2.12.0.data/data/devsim_data/examples/mobility/test.lay +3385 -0
- devsim-2.12.0.data/data/devsim_data/examples/mobility/times.txt +34 -0
- devsim-2.12.0.data/data/devsim_data/examples/plotting/visualization.ipynb +160 -0
- devsim-2.12.0.data/data/devsim_data/examples/vectorpotential/twowire.geo +34 -0
- devsim-2.12.0.data/data/devsim_data/examples/vectorpotential/twowire.lay +1469 -0
- devsim-2.12.0.data/data/devsim_data/examples/vectorpotential/twowire.msh +13596 -0
- devsim-2.12.0.data/data/devsim_data/examples/vectorpotential/twowire.py +177 -0
- devsim-2.12.0.data/data/devsim_data/pyproject.toml +33 -0
- devsim-2.12.0.data/data/devsim_data/setup.py +64 -0
- devsim-2.12.0.data/data/devsim_data/testing/3dtetmesh.msh +281 -0
- devsim-2.12.0.data/data/devsim_data/testing/CMakeLists.txt +174 -0
- devsim-2.12.0.data/data/devsim_data/testing/Fermi1.py +59 -0
- devsim-2.12.0.data/data/devsim_data/testing/Fermi1_float128.py +18 -0
- devsim-2.12.0.data/data/devsim_data/testing/GaussFermi.py +38 -0
- devsim-2.12.0.data/data/devsim_data/testing/GaussFermi_float128.py +18 -0
- devsim-2.12.0.data/data/devsim_data/testing/cap2.py +439 -0
- devsim-2.12.0.data/data/devsim_data/testing/cap_mesh.py +33 -0
- devsim-2.12.0.data/data/devsim_data/testing/circ1.py +79 -0
- devsim-2.12.0.data/data/devsim_data/testing/circ2.py +79 -0
- devsim-2.12.0.data/data/devsim_data/testing/circ3.py +18 -0
- devsim-2.12.0.data/data/devsim_data/testing/circ4.py +105 -0
- devsim-2.12.0.data/data/devsim_data/testing/dio2_element_2d.py +136 -0
- devsim-2.12.0.data/data/devsim_data/testing/dio2_element_physics.py +302 -0
- devsim-2.12.0.data/data/devsim_data/testing/equation1.py +68 -0
- devsim-2.12.0.data/data/devsim_data/testing/erf1.py +52 -0
- devsim-2.12.0.data/data/devsim_data/testing/erf2.py +34 -0
- devsim-2.12.0.data/data/devsim_data/testing/fpetest1.py +21 -0
- devsim-2.12.0.data/data/devsim_data/testing/fpetest2.py +25 -0
- devsim-2.12.0.data/data/devsim_data/testing/gmsh_mos3d.geo +272 -0
- devsim-2.12.0.data/data/devsim_data/testing/info.py +15 -0
- devsim-2.12.0.data/data/devsim_data/testing/kahan.py +24 -0
- devsim-2.12.0.data/data/devsim_data/testing/kahan_float128.py +18 -0
- devsim-2.12.0.data/data/devsim_data/testing/laux1.py +232 -0
- devsim-2.12.0.data/data/devsim_data/testing/mctest.mc +30 -0
- devsim-2.12.0.data/data/devsim_data/testing/mctest_user.mc +33 -0
- devsim-2.12.0.data/data/devsim_data/testing/mesh1.msh +52 -0
- devsim-2.12.0.data/data/devsim_data/testing/mesh1.py +121 -0
- devsim-2.12.0.data/data/devsim_data/testing/mesh2.msh +70 -0
- devsim-2.12.0.data/data/devsim_data/testing/mesh2.py +210 -0
- devsim-2.12.0.data/data/devsim_data/testing/mesh2d.py +105 -0
- devsim-2.12.0.data/data/devsim_data/testing/mesh3.py +8 -0
- devsim-2.12.0.data/data/devsim_data/testing/mesh4.py +8 -0
- devsim-2.12.0.data/data/devsim_data/testing/mos_2d.py +111 -0
- devsim-2.12.0.data/data/devsim_data/testing/mos_2d_create.py +207 -0
- devsim-2.12.0.data/data/devsim_data/testing/mos_2d_restart.py +69 -0
- devsim-2.12.0.data/data/devsim_data/testing/mos_2d_restart2.py +24 -0
- devsim-2.12.0.data/data/devsim_data/testing/noise_res.py +51 -0
- devsim-2.12.0.data/data/devsim_data/testing/noise_res_2d.py +101 -0
- devsim-2.12.0.data/data/devsim_data/testing/other_blas.py +28 -0
- devsim-2.12.0.data/data/devsim_data/testing/ptest1.py +53 -0
- devsim-2.12.0.data/data/devsim_data/testing/ptest2.py +110 -0
- devsim-2.12.0.data/data/devsim_data/testing/pythonmesh1d.py +202 -0
- devsim-2.12.0.data/data/devsim_data/testing/res1.py +65 -0
- devsim-2.12.0.data/data/devsim_data/testing/res2.py +65 -0
- devsim-2.12.0.data/data/devsim_data/testing/res3.py +59 -0
- devsim-2.12.0.data/data/devsim_data/testing/rundifftest.py +62 -0
- devsim-2.12.0.data/data/devsim_data/testing/ssac_cap.py +145 -0
- devsim-2.12.0.data/data/devsim_data/testing/ssac_cap_2d_edge.py +199 -0
- devsim-2.12.0.data/data/devsim_data/testing/ssac_cap_2d_element.py +214 -0
- devsim-2.12.0.data/data/devsim_data/testing/ssac_cap_3d_edge.py +148 -0
- devsim-2.12.0.data/data/devsim_data/testing/ssac_cap_3d_element.py +167 -0
- devsim-2.12.0.data/data/devsim_data/testing/ssac_circ.py +18 -0
- devsim-2.12.0.data/data/devsim_data/testing/ssac_res.py +30 -0
- devsim-2.12.0.data/data/devsim_data/testing/symdiff1.py +54 -0
- devsim-2.12.0.data/data/devsim_data/testing/test_common.py +435 -0
- devsim-2.12.0.data/data/devsim_data/testing/testfunc.py +65 -0
- devsim-2.12.0.data/data/devsim_data/testing/testfunc_extended.py +8 -0
- devsim-2.12.0.data/data/devsim_data/testing/transient_circ.py +67 -0
- devsim-2.12.0.data/data/devsim_data/testing/transient_circ2.py +67 -0
- devsim-2.12.0.data/data/devsim_data/testing/transient_circ3.py +125 -0
- devsim-2.12.0.data/data/devsim_data/testing/transient_rc.py +157 -0
- devsim-2.12.0.data/data/devsim_data/testing/trimesh1.msh +47 -0
- devsim-2.12.0.data/data/devsim_data/testing/trimesh1.py +114 -0
- devsim-2.12.0.data/data/devsim_data/testing/trimesh2.py +114 -0
- devsim-2.12.0.data/data/devsim_data/testing/utf8_2.py +126 -0
- devsim-2.12.0.dist-info/METADATA +122 -0
- devsim-2.12.0.dist-info/RECORD +152 -0
- devsim-2.12.0.dist-info/WHEEL +5 -0
- devsim-2.12.0.dist-info/licenses/LICENSE +202 -0
- devsim-2.12.0.dist-info/licenses/NOTICE +241 -0
- devsim-2.12.0.dist-info/top_level.txt +1 -0
devsim/__init__.pyi
ADDED
|
@@ -0,0 +1,2155 @@
|
|
|
1
|
+
|
|
2
|
+
def add_circuit_node (**kwargs):
|
|
3
|
+
'''
|
|
4
|
+
devsim.add_circuit_node (name, value, variable_update)
|
|
5
|
+
|
|
6
|
+
Adds a circuit node for use in circuit or multi-device simulation
|
|
7
|
+
|
|
8
|
+
Parameters
|
|
9
|
+
----------
|
|
10
|
+
name : str
|
|
11
|
+
Name of the circuit node being created
|
|
12
|
+
value : Float, optional
|
|
13
|
+
initial value (default 0.0)
|
|
14
|
+
variable_update : {'default', 'log_damp', 'positive'}
|
|
15
|
+
update type for circuit variable
|
|
16
|
+
'''
|
|
17
|
+
pass
|
|
18
|
+
|
|
19
|
+
def circuit_alter (**kwargs):
|
|
20
|
+
'''
|
|
21
|
+
devsim.circuit_alter (name, param, value)
|
|
22
|
+
|
|
23
|
+
Alter the value of a circuit element parameter
|
|
24
|
+
|
|
25
|
+
Parameters
|
|
26
|
+
----------
|
|
27
|
+
name : str
|
|
28
|
+
Name of the circuit node being created
|
|
29
|
+
param : str, optional
|
|
30
|
+
parameter being modified (default 'value')
|
|
31
|
+
value : Float
|
|
32
|
+
value for the parameter
|
|
33
|
+
'''
|
|
34
|
+
pass
|
|
35
|
+
|
|
36
|
+
def circuit_element (**kwargs):
|
|
37
|
+
'''
|
|
38
|
+
devsim.circuit_element (name, value, n1, n2, acreal, acimag)
|
|
39
|
+
|
|
40
|
+
Adds a circuit element external to the devices
|
|
41
|
+
|
|
42
|
+
Parameters
|
|
43
|
+
----------
|
|
44
|
+
name : str
|
|
45
|
+
Name of the circuit element being created. A prefix of 'V' is for voltage source, 'I' for current source, 'R' for resistor, 'L' for inductor, and 'C' for capacitor.
|
|
46
|
+
value : Float, optional
|
|
47
|
+
value for the default parameter of the circuit element (default 0.0)
|
|
48
|
+
n1 : str
|
|
49
|
+
circuit node
|
|
50
|
+
n2 : str
|
|
51
|
+
circuit node
|
|
52
|
+
acreal : Float, optional
|
|
53
|
+
real part of AC source for voltage (default 0.0)
|
|
54
|
+
acimag : Float, optional
|
|
55
|
+
imag part of AC source for voltage (default 0.0)
|
|
56
|
+
'''
|
|
57
|
+
pass
|
|
58
|
+
|
|
59
|
+
def circuit_node_alias (**kwargs):
|
|
60
|
+
'''
|
|
61
|
+
devsim.circuit_node_alias (node, alias)
|
|
62
|
+
|
|
63
|
+
Create an alias for a circuit node
|
|
64
|
+
|
|
65
|
+
Parameters
|
|
66
|
+
----------
|
|
67
|
+
node : str
|
|
68
|
+
circuit node being aliased
|
|
69
|
+
alias : str
|
|
70
|
+
alias for the circuit node
|
|
71
|
+
'''
|
|
72
|
+
pass
|
|
73
|
+
|
|
74
|
+
def delete_circuit (**kwargs):
|
|
75
|
+
'''
|
|
76
|
+
devsim.delete_circuit ()
|
|
77
|
+
|
|
78
|
+
Deletes any present circuit and its solutions.
|
|
79
|
+
'''
|
|
80
|
+
pass
|
|
81
|
+
|
|
82
|
+
def get_circuit_equation_number (**kwargs):
|
|
83
|
+
'''
|
|
84
|
+
devsim.get_circuit_equation_number (node)
|
|
85
|
+
|
|
86
|
+
Returns the row number correspond to circuit node in a region. Values are only valid when during the course of a solve.
|
|
87
|
+
|
|
88
|
+
Parameters
|
|
89
|
+
----------
|
|
90
|
+
node : str
|
|
91
|
+
circuit node
|
|
92
|
+
'''
|
|
93
|
+
pass
|
|
94
|
+
|
|
95
|
+
def get_circuit_node_list (**kwargs):
|
|
96
|
+
'''
|
|
97
|
+
devsim.get_circuit_node_list ()
|
|
98
|
+
|
|
99
|
+
Gets the list of the nodes in the circuit.
|
|
100
|
+
'''
|
|
101
|
+
pass
|
|
102
|
+
|
|
103
|
+
def get_circuit_node_value (**kwargs):
|
|
104
|
+
'''
|
|
105
|
+
devsim.get_circuit_node_value (solution, node)
|
|
106
|
+
|
|
107
|
+
Gets the value of a circuit node for a given solution type.
|
|
108
|
+
|
|
109
|
+
Parameters
|
|
110
|
+
----------
|
|
111
|
+
solution : str, optional
|
|
112
|
+
name of the solution. 'dcop' is the name for the DC solution (default 'dcop')
|
|
113
|
+
node : str
|
|
114
|
+
circuit node of interest
|
|
115
|
+
'''
|
|
116
|
+
pass
|
|
117
|
+
|
|
118
|
+
def get_circuit_solution_list (**kwargs):
|
|
119
|
+
'''
|
|
120
|
+
devsim.get_circuit_solution_list ()
|
|
121
|
+
|
|
122
|
+
Gets the list of available circuit solutions.
|
|
123
|
+
'''
|
|
124
|
+
pass
|
|
125
|
+
|
|
126
|
+
def set_circuit_node_value (**kwargs):
|
|
127
|
+
'''
|
|
128
|
+
devsim.set_circuit_node_value (solution, node, value)
|
|
129
|
+
|
|
130
|
+
Sets the value of a circuit node for a given solution type.
|
|
131
|
+
|
|
132
|
+
Parameters
|
|
133
|
+
----------
|
|
134
|
+
solution : str, optional
|
|
135
|
+
name of the solution. 'dcop' is the name for the DC solution (default 'dcop')
|
|
136
|
+
node : str
|
|
137
|
+
circuit node of interest
|
|
138
|
+
value : Float, optional
|
|
139
|
+
new value (default 0.0)
|
|
140
|
+
'''
|
|
141
|
+
pass
|
|
142
|
+
|
|
143
|
+
def contact_equation (**kwargs):
|
|
144
|
+
'''
|
|
145
|
+
devsim.contact_equation (device, contact, name, circuit_node, edge_charge_model, edge_current_model, edge_model, edge_volume_model, element_charge_model, element_current_model, element_model, volume_node0_model, volume_node1_model, node_charge_model, node_current_model, node_model)
|
|
146
|
+
|
|
147
|
+
Create a contact equation on a device
|
|
148
|
+
|
|
149
|
+
Parameters
|
|
150
|
+
----------
|
|
151
|
+
device : str
|
|
152
|
+
The selected device
|
|
153
|
+
contact : str
|
|
154
|
+
Contact on which to apply this command
|
|
155
|
+
name : str
|
|
156
|
+
Name of the contact equation being created
|
|
157
|
+
circuit_node : str, optional
|
|
158
|
+
Name of the circuit we integrate the flux into
|
|
159
|
+
edge_charge_model : str, optional
|
|
160
|
+
Name of the edge model used to determine the charge at this contact
|
|
161
|
+
edge_current_model : str, optional
|
|
162
|
+
Name of the edge model used to determine the current flowing out of this contact
|
|
163
|
+
edge_model : str, optional
|
|
164
|
+
Name of the edge model being integrated at each edge at this contact
|
|
165
|
+
edge_volume_model : str, optional
|
|
166
|
+
Name of the edge model being integrated over the volume of each edge on the contact
|
|
167
|
+
element_charge_model : str, optional
|
|
168
|
+
Name of the element edge model used to determine the charge at this contact
|
|
169
|
+
element_current_model : str, optional
|
|
170
|
+
Name of the element edge model used to determine the current flowing out of this contact
|
|
171
|
+
element_model : str, optional
|
|
172
|
+
Name of the element edge model being integrated at each edge at this contact
|
|
173
|
+
volume_node0_model : str, optional
|
|
174
|
+
Name of the element model being integrated over the volume of node 0 of each edge on the contact
|
|
175
|
+
volume_node1_model : str, optional
|
|
176
|
+
Name of the element model being integrated over the volume of node 1 of each edge on the contact
|
|
177
|
+
node_charge_model : str, optional
|
|
178
|
+
Name of the node model used to determine the charge at this contact
|
|
179
|
+
node_current_model : str, optional
|
|
180
|
+
Name of the node model used to determine the current flowing out of this contact
|
|
181
|
+
node_model : str, optional
|
|
182
|
+
Name of the node model being integrated at each node at this contact
|
|
183
|
+
'''
|
|
184
|
+
pass
|
|
185
|
+
|
|
186
|
+
def custom_equation (**kwargs):
|
|
187
|
+
'''
|
|
188
|
+
devsim.custom_equation (name, procedure)
|
|
189
|
+
|
|
190
|
+
Custom equation assembly. See :ref:`models__customequation` for a description of how the function should be structured.
|
|
191
|
+
|
|
192
|
+
Parameters
|
|
193
|
+
----------
|
|
194
|
+
name : str
|
|
195
|
+
Name of the custom equation being created
|
|
196
|
+
procedure : str
|
|
197
|
+
The procedure to be called
|
|
198
|
+
'''
|
|
199
|
+
pass
|
|
200
|
+
|
|
201
|
+
def delete_contact_equation (**kwargs):
|
|
202
|
+
'''
|
|
203
|
+
devsim.delete_contact_equation (device, contact, name)
|
|
204
|
+
|
|
205
|
+
This command deletes an equation from a contact.
|
|
206
|
+
|
|
207
|
+
Parameters
|
|
208
|
+
----------
|
|
209
|
+
device : str
|
|
210
|
+
The selected device
|
|
211
|
+
contact : str
|
|
212
|
+
Contact on which to apply this command
|
|
213
|
+
name : str
|
|
214
|
+
Name of the contact equation being deleted
|
|
215
|
+
'''
|
|
216
|
+
pass
|
|
217
|
+
|
|
218
|
+
def delete_equation (**kwargs):
|
|
219
|
+
'''
|
|
220
|
+
devsim.delete_equation (device, region, name)
|
|
221
|
+
|
|
222
|
+
This command deletes an equation from a region.
|
|
223
|
+
|
|
224
|
+
Parameters
|
|
225
|
+
----------
|
|
226
|
+
device : str
|
|
227
|
+
The selected device
|
|
228
|
+
region : str
|
|
229
|
+
The selected region
|
|
230
|
+
name : str
|
|
231
|
+
Name of the equation being deleted
|
|
232
|
+
'''
|
|
233
|
+
pass
|
|
234
|
+
|
|
235
|
+
def delete_interface_equation (**kwargs):
|
|
236
|
+
'''
|
|
237
|
+
devsim.delete_interface_equation (device, interface, name)
|
|
238
|
+
|
|
239
|
+
This command deletes an equation from an interface.
|
|
240
|
+
|
|
241
|
+
Parameters
|
|
242
|
+
----------
|
|
243
|
+
device : str
|
|
244
|
+
The selected device
|
|
245
|
+
interface : str
|
|
246
|
+
Interface on which to apply this command
|
|
247
|
+
name : str
|
|
248
|
+
Name of the interface equation being deleted
|
|
249
|
+
'''
|
|
250
|
+
pass
|
|
251
|
+
|
|
252
|
+
def equation (**kwargs):
|
|
253
|
+
'''
|
|
254
|
+
devsim.equation (device, region, name, variable_name, node_model, edge_model, edge_volume_model, time_node_model, element_model, volume_node0_model, volume_node1_model, variable_update)
|
|
255
|
+
|
|
256
|
+
Specify an equation to solve on a device
|
|
257
|
+
|
|
258
|
+
Parameters
|
|
259
|
+
----------
|
|
260
|
+
device : str
|
|
261
|
+
The selected device
|
|
262
|
+
region : str
|
|
263
|
+
The selected region
|
|
264
|
+
name : str
|
|
265
|
+
Name of the equation being created
|
|
266
|
+
variable_name : str
|
|
267
|
+
Name of the node solution being solved
|
|
268
|
+
node_model : str, optional
|
|
269
|
+
Name of the node model being integrated at each node in the device volume
|
|
270
|
+
edge_model : str, optional
|
|
271
|
+
Name of the edge model being integrated over each edge in the device volume
|
|
272
|
+
edge_volume_model : str, optional
|
|
273
|
+
Name of the edge model being integrated over the volume of each edge in the device volume
|
|
274
|
+
time_node_model : str, optional
|
|
275
|
+
Name of the time dependent node_model being integrated at each node in the device volume
|
|
276
|
+
element_model : str, optional
|
|
277
|
+
Name of the element model being integrated over each edge in the device volume
|
|
278
|
+
volume_node0_model : str, optional
|
|
279
|
+
Name of the element model being integrated over the volume of node 0 of each edge on the contact
|
|
280
|
+
volume_node1_model : str, optional
|
|
281
|
+
Name of the element model being integrated over the volume of node 1 of each edge on the contact
|
|
282
|
+
variable_update : {'default', 'log_damp', 'positive'}
|
|
283
|
+
update type for circuit variable
|
|
284
|
+
|
|
285
|
+
Notes
|
|
286
|
+
-----
|
|
287
|
+
|
|
288
|
+
The integration variables can be changed in 2D for cylindrical coordinate systems by setting the appropriate parameters as described in :ref:`sec__cylindrical`.
|
|
289
|
+
|
|
290
|
+
In order to set the node volumes for integration of the ``edge_volume_model``, it is possible to do something like this:
|
|
291
|
+
|
|
292
|
+
..
|
|
293
|
+
|
|
294
|
+
devsim.edge_model(device="device", region="region", name="EdgeNodeVolume", equation="0.5*SurfaceArea*EdgeLength")
|
|
295
|
+
devsim.set_parameter(name="edge_node0_volume_model", value="EdgeNodeVolume")
|
|
296
|
+
devsim.set_parameter(name="edge_node1_volume_model", value="EdgeNodeVolume")
|
|
297
|
+
|
|
298
|
+
'''
|
|
299
|
+
pass
|
|
300
|
+
|
|
301
|
+
def get_contact_equation_command (**kwargs):
|
|
302
|
+
'''
|
|
303
|
+
devsim.get_contact_equation_command (device, contact, name)
|
|
304
|
+
|
|
305
|
+
This command gets the options used when creating this contact equation.
|
|
306
|
+
|
|
307
|
+
Parameters
|
|
308
|
+
----------
|
|
309
|
+
device : str
|
|
310
|
+
The selected device
|
|
311
|
+
contact : str
|
|
312
|
+
Contact on which to apply this command
|
|
313
|
+
name : str
|
|
314
|
+
Name of the contact equation being command options returned
|
|
315
|
+
'''
|
|
316
|
+
pass
|
|
317
|
+
|
|
318
|
+
def get_contact_equation_list (**kwargs):
|
|
319
|
+
'''
|
|
320
|
+
devsim.get_contact_equation_list (device, contact)
|
|
321
|
+
|
|
322
|
+
This command gets a list of equations on the specified contact.
|
|
323
|
+
|
|
324
|
+
Parameters
|
|
325
|
+
----------
|
|
326
|
+
device : str
|
|
327
|
+
The selected device
|
|
328
|
+
contact : str
|
|
329
|
+
Contact on which to apply this command
|
|
330
|
+
'''
|
|
331
|
+
pass
|
|
332
|
+
|
|
333
|
+
def get_equation_command (**kwargs):
|
|
334
|
+
'''
|
|
335
|
+
devsim.get_equation_command (device, region, name)
|
|
336
|
+
|
|
337
|
+
This command gets the options used when creating this equation.
|
|
338
|
+
|
|
339
|
+
Parameters
|
|
340
|
+
----------
|
|
341
|
+
device : str
|
|
342
|
+
The selected device
|
|
343
|
+
region : str
|
|
344
|
+
The selected region
|
|
345
|
+
name : str
|
|
346
|
+
Name of the equation being command options returned
|
|
347
|
+
'''
|
|
348
|
+
pass
|
|
349
|
+
|
|
350
|
+
def get_equation_list (**kwargs):
|
|
351
|
+
'''
|
|
352
|
+
devsim.get_equation_list (device, region)
|
|
353
|
+
|
|
354
|
+
This command gets a list of equations on the specified region.
|
|
355
|
+
|
|
356
|
+
Parameters
|
|
357
|
+
----------
|
|
358
|
+
device : str
|
|
359
|
+
The selected device
|
|
360
|
+
region : str
|
|
361
|
+
The selected region
|
|
362
|
+
'''
|
|
363
|
+
pass
|
|
364
|
+
|
|
365
|
+
def get_equation_numbers (**kwargs):
|
|
366
|
+
'''
|
|
367
|
+
devsim.get_equation_numbers (device, region, equation, variable)
|
|
368
|
+
|
|
369
|
+
Returns a list of the equation numbers corresponding to each node in a region. Values are only valid when during the course of a solve.
|
|
370
|
+
|
|
371
|
+
Parameters
|
|
372
|
+
----------
|
|
373
|
+
device : str
|
|
374
|
+
The selected device
|
|
375
|
+
region : str
|
|
376
|
+
The selected region
|
|
377
|
+
equation : str, optional
|
|
378
|
+
Name of the equation
|
|
379
|
+
variable : str, optional
|
|
380
|
+
Name of the variable
|
|
381
|
+
'''
|
|
382
|
+
pass
|
|
383
|
+
|
|
384
|
+
def get_interface_equation_command (**kwargs):
|
|
385
|
+
'''
|
|
386
|
+
devsim.get_interface_equation_command (device, interface, name)
|
|
387
|
+
|
|
388
|
+
This command gets the options used when creating this interface equation.
|
|
389
|
+
|
|
390
|
+
Parameters
|
|
391
|
+
----------
|
|
392
|
+
device : str
|
|
393
|
+
The selected device
|
|
394
|
+
interface : str
|
|
395
|
+
Interface on which to apply this command
|
|
396
|
+
name : str
|
|
397
|
+
Name of the interface equation being command options returned
|
|
398
|
+
'''
|
|
399
|
+
pass
|
|
400
|
+
|
|
401
|
+
def get_interface_equation_list (**kwargs):
|
|
402
|
+
'''
|
|
403
|
+
devsim.get_interface_equation_list (device, interface)
|
|
404
|
+
|
|
405
|
+
This command gets a list of equations on the specified interface.
|
|
406
|
+
|
|
407
|
+
Parameters
|
|
408
|
+
----------
|
|
409
|
+
device : str
|
|
410
|
+
The selected device
|
|
411
|
+
interface : str
|
|
412
|
+
Interface on which to apply this command
|
|
413
|
+
'''
|
|
414
|
+
pass
|
|
415
|
+
|
|
416
|
+
def interface_equation (**kwargs):
|
|
417
|
+
'''
|
|
418
|
+
devsim.interface_equation (device, interface, name, name0, name1, interface_model, type)
|
|
419
|
+
|
|
420
|
+
Command to specify an equation at an interface
|
|
421
|
+
|
|
422
|
+
Parameters
|
|
423
|
+
----------
|
|
424
|
+
device : str
|
|
425
|
+
The selected device
|
|
426
|
+
interface : str
|
|
427
|
+
Interface on which to apply this command
|
|
428
|
+
name : str
|
|
429
|
+
Name of the interface equation being created
|
|
430
|
+
name0 : str, optional
|
|
431
|
+
Name of the equation coupling in region 0 being created (default 'name')
|
|
432
|
+
name1 : str, optional
|
|
433
|
+
Name of the equation coupling in region 1 being created (default 'name')
|
|
434
|
+
interface_model : str
|
|
435
|
+
When specified, the bulk equations on both sides of the interface are integrated together. This model is then used to specify how nodal quantities on both sides of the interface are balanced
|
|
436
|
+
type : {'continuous', 'fluxterm', 'hybrid'} required
|
|
437
|
+
Specifies the type of boundary condition
|
|
438
|
+
'''
|
|
439
|
+
pass
|
|
440
|
+
|
|
441
|
+
def get_contact_list (**kwargs):
|
|
442
|
+
'''
|
|
443
|
+
devsim.get_contact_list (device)
|
|
444
|
+
|
|
445
|
+
Gets a list of contacts on a device.
|
|
446
|
+
|
|
447
|
+
Parameters
|
|
448
|
+
----------
|
|
449
|
+
device : str
|
|
450
|
+
The selected device
|
|
451
|
+
'''
|
|
452
|
+
pass
|
|
453
|
+
|
|
454
|
+
def get_device_list (**kwargs):
|
|
455
|
+
'''
|
|
456
|
+
devsim.get_device_list ()
|
|
457
|
+
|
|
458
|
+
Gets a list of devices on the simulation.
|
|
459
|
+
'''
|
|
460
|
+
pass
|
|
461
|
+
|
|
462
|
+
def get_element_node_list (**kwargs):
|
|
463
|
+
'''
|
|
464
|
+
devsim.get_element_node_list (device, region, contact, interface, reorder)
|
|
465
|
+
|
|
466
|
+
Gets a list of nodes for each element on a device, region, contact, or interface.
|
|
467
|
+
|
|
468
|
+
Parameters
|
|
469
|
+
----------
|
|
470
|
+
device : str
|
|
471
|
+
The selected device
|
|
472
|
+
region : str
|
|
473
|
+
The selected region
|
|
474
|
+
contact : str, optional
|
|
475
|
+
If specified, gets the element nodes for the contact on the specified region
|
|
476
|
+
interface : str, optional
|
|
477
|
+
If specified, gets the element nodes for the interface on the specified region
|
|
478
|
+
reorder : bool, optional
|
|
479
|
+
If specified, reorders the element nodes in a manner compatible in meshing software (default False)
|
|
480
|
+
'''
|
|
481
|
+
pass
|
|
482
|
+
|
|
483
|
+
def get_interface_list (**kwargs):
|
|
484
|
+
'''
|
|
485
|
+
devsim.get_interface_list (device)
|
|
486
|
+
|
|
487
|
+
Gets a list of interfaces on a device.
|
|
488
|
+
|
|
489
|
+
Parameters
|
|
490
|
+
----------
|
|
491
|
+
device : str
|
|
492
|
+
The selected device
|
|
493
|
+
'''
|
|
494
|
+
pass
|
|
495
|
+
|
|
496
|
+
def get_region_list (**kwargs):
|
|
497
|
+
'''
|
|
498
|
+
devsim.get_region_list (device, contact, interface)
|
|
499
|
+
|
|
500
|
+
Gets a list of regions on a device, contact, or interface.
|
|
501
|
+
|
|
502
|
+
Parameters
|
|
503
|
+
----------
|
|
504
|
+
device : str
|
|
505
|
+
The selected device
|
|
506
|
+
contact : str, optional
|
|
507
|
+
If specified, gets the name of the region belonging to this contact on the device
|
|
508
|
+
interface : str, optional
|
|
509
|
+
If specified, gets the name of the regions belonging to this interface on the device
|
|
510
|
+
'''
|
|
511
|
+
pass
|
|
512
|
+
|
|
513
|
+
def reset_devsim (**kwargs):
|
|
514
|
+
'''
|
|
515
|
+
devsim.reset_devsim ()
|
|
516
|
+
|
|
517
|
+
Resets all data for clean restart.
|
|
518
|
+
'''
|
|
519
|
+
pass
|
|
520
|
+
|
|
521
|
+
def get_dimension (**kwargs):
|
|
522
|
+
'''
|
|
523
|
+
devsim.get_dimension (device)
|
|
524
|
+
|
|
525
|
+
Get the dimension of the device
|
|
526
|
+
|
|
527
|
+
Parameters
|
|
528
|
+
----------
|
|
529
|
+
device : str, optional
|
|
530
|
+
The selected device
|
|
531
|
+
'''
|
|
532
|
+
pass
|
|
533
|
+
|
|
534
|
+
def get_material (**kwargs):
|
|
535
|
+
'''
|
|
536
|
+
devsim.get_material (device, region, contact)
|
|
537
|
+
|
|
538
|
+
Returns the material for the specified region
|
|
539
|
+
|
|
540
|
+
Parameters
|
|
541
|
+
----------
|
|
542
|
+
device : str, optional
|
|
543
|
+
The selected device
|
|
544
|
+
region : str, optional
|
|
545
|
+
The selected region
|
|
546
|
+
contact : str, optional
|
|
547
|
+
Contact on which to apply this command
|
|
548
|
+
'''
|
|
549
|
+
pass
|
|
550
|
+
|
|
551
|
+
def get_parameter (**kwargs):
|
|
552
|
+
'''
|
|
553
|
+
devsim.get_parameter (device, region, name)
|
|
554
|
+
|
|
555
|
+
Get a parameter on a region, device, or globally.
|
|
556
|
+
|
|
557
|
+
Parameters
|
|
558
|
+
----------
|
|
559
|
+
device : str, optional
|
|
560
|
+
The selected device
|
|
561
|
+
region : str, optional
|
|
562
|
+
The selected region
|
|
563
|
+
name : str
|
|
564
|
+
Name of the parameter name being retrieved
|
|
565
|
+
|
|
566
|
+
Notes
|
|
567
|
+
-----
|
|
568
|
+
|
|
569
|
+
Note that the ``device`` and ``region`` options are optional. If the region is not specified, the parameter is retrieved for the entire device. If the device is not specified, the parameter is retrieved for all devices. If the parameter is not found on the region, it is retrieved on the device. If it is not found on the device, it is retrieved over all devices.
|
|
570
|
+
'''
|
|
571
|
+
pass
|
|
572
|
+
|
|
573
|
+
def get_parameter_list (**kwargs):
|
|
574
|
+
'''
|
|
575
|
+
devsim.get_parameter_list (device, region)
|
|
576
|
+
|
|
577
|
+
Get list of parameter names on region, device, or globally
|
|
578
|
+
|
|
579
|
+
Parameters
|
|
580
|
+
----------
|
|
581
|
+
device : str, optional
|
|
582
|
+
The selected device
|
|
583
|
+
region : str, optional
|
|
584
|
+
The selected region
|
|
585
|
+
|
|
586
|
+
Notes
|
|
587
|
+
-----
|
|
588
|
+
|
|
589
|
+
Note that the ``device`` and ``region`` options are optional. If the region is not specified, the parameter is retrieved for the entire device. If the device is not specified, the parameter is retrieved for all devices. Unlike the :meth:`devsim.getParameter`, parameter names on the the device are not retrieved if they do not exist on the region. Similarly, the parameter names over all devices are not retrieved if they do not exist on the device.
|
|
590
|
+
'''
|
|
591
|
+
pass
|
|
592
|
+
|
|
593
|
+
def set_material (**kwargs):
|
|
594
|
+
'''
|
|
595
|
+
devsim.set_material (device, region, contact, material)
|
|
596
|
+
|
|
597
|
+
Sets the new material for a region
|
|
598
|
+
|
|
599
|
+
Parameters
|
|
600
|
+
----------
|
|
601
|
+
device : str, optional
|
|
602
|
+
The selected device
|
|
603
|
+
region : str, optional
|
|
604
|
+
The selected region
|
|
605
|
+
contact : str, optional
|
|
606
|
+
Contact on which to apply this command
|
|
607
|
+
material : str
|
|
608
|
+
New material name
|
|
609
|
+
'''
|
|
610
|
+
pass
|
|
611
|
+
|
|
612
|
+
def set_parameter (**kwargs):
|
|
613
|
+
'''
|
|
614
|
+
devsim.set_parameter (device, region, name, value)
|
|
615
|
+
|
|
616
|
+
Set a parameter on region, device, or globally
|
|
617
|
+
|
|
618
|
+
Parameters
|
|
619
|
+
----------
|
|
620
|
+
device : str, optional
|
|
621
|
+
The selected device
|
|
622
|
+
region : str, optional
|
|
623
|
+
The selected region
|
|
624
|
+
name : str
|
|
625
|
+
Name of the parameter name being retrieved
|
|
626
|
+
value : any
|
|
627
|
+
value to set for the parameter
|
|
628
|
+
|
|
629
|
+
Notes
|
|
630
|
+
-----
|
|
631
|
+
|
|
632
|
+
Note that the device and region options are optional. If the region is not specified, the parameter is set for the entire device. If the device is not specified, the parameter is set for all devices.
|
|
633
|
+
'''
|
|
634
|
+
pass
|
|
635
|
+
|
|
636
|
+
def add_1d_contact (**kwargs):
|
|
637
|
+
'''
|
|
638
|
+
devsim.add_1d_contact (material, mesh, name, tag)
|
|
639
|
+
|
|
640
|
+
Add a contact to a 1D mesh
|
|
641
|
+
|
|
642
|
+
Parameters
|
|
643
|
+
----------
|
|
644
|
+
material : str
|
|
645
|
+
material for the contact being created
|
|
646
|
+
mesh : str
|
|
647
|
+
Mesh to add the contact to
|
|
648
|
+
name : str
|
|
649
|
+
Name for the contact being created
|
|
650
|
+
tag : str
|
|
651
|
+
Text label for the position to add the contact
|
|
652
|
+
'''
|
|
653
|
+
pass
|
|
654
|
+
|
|
655
|
+
def add_1d_interface (**kwargs):
|
|
656
|
+
'''
|
|
657
|
+
devsim.add_1d_interface (mesh, tag, name)
|
|
658
|
+
|
|
659
|
+
Add an interface to a 1D mesh
|
|
660
|
+
|
|
661
|
+
Parameters
|
|
662
|
+
----------
|
|
663
|
+
mesh : str
|
|
664
|
+
Mesh to add the interface to
|
|
665
|
+
tag : str
|
|
666
|
+
Text label for the position to add the interface
|
|
667
|
+
name : str
|
|
668
|
+
Name for the interface being created
|
|
669
|
+
'''
|
|
670
|
+
pass
|
|
671
|
+
|
|
672
|
+
def add_1d_mesh_line (**kwargs):
|
|
673
|
+
'''
|
|
674
|
+
devsim.add_1d_mesh_line (mesh, tag, pos, ns, ps)
|
|
675
|
+
|
|
676
|
+
Add a mesh line to a 1D mesh
|
|
677
|
+
|
|
678
|
+
Parameters
|
|
679
|
+
----------
|
|
680
|
+
mesh : str
|
|
681
|
+
Mesh to add the line to
|
|
682
|
+
tag : str, optional
|
|
683
|
+
Text label for the position
|
|
684
|
+
pos : str
|
|
685
|
+
Position for the mesh point
|
|
686
|
+
ns : Float, optional
|
|
687
|
+
Spacing from this point in the negative direction (default ps value)
|
|
688
|
+
ps : Float
|
|
689
|
+
Spacing from this point in the positive direction
|
|
690
|
+
'''
|
|
691
|
+
pass
|
|
692
|
+
|
|
693
|
+
def add_1d_region (**kwargs):
|
|
694
|
+
'''
|
|
695
|
+
devsim.add_1d_region (mesh, tag1, tag2, region, material)
|
|
696
|
+
|
|
697
|
+
Add a region to a 1D mesh
|
|
698
|
+
|
|
699
|
+
Parameters
|
|
700
|
+
----------
|
|
701
|
+
mesh : str
|
|
702
|
+
Mesh to add the line to
|
|
703
|
+
tag1 : str
|
|
704
|
+
Text label for the position bounding the region being added
|
|
705
|
+
tag2 : str
|
|
706
|
+
Text label for the position bounding the region being added
|
|
707
|
+
region : str
|
|
708
|
+
Name for the region being created
|
|
709
|
+
material : str
|
|
710
|
+
Material for the region being created
|
|
711
|
+
'''
|
|
712
|
+
pass
|
|
713
|
+
|
|
714
|
+
def add_2d_contact (**kwargs):
|
|
715
|
+
'''
|
|
716
|
+
devsim.add_2d_contact (name, material, mesh, region, xl, xh, yl, yh, bloat)
|
|
717
|
+
|
|
718
|
+
Add an interface to a 2D mesh
|
|
719
|
+
|
|
720
|
+
Parameters
|
|
721
|
+
----------
|
|
722
|
+
name : str
|
|
723
|
+
Name for the contact being created
|
|
724
|
+
material : str
|
|
725
|
+
material for the contact being created
|
|
726
|
+
mesh : str
|
|
727
|
+
Mesh to add the contact to
|
|
728
|
+
region : str
|
|
729
|
+
Name of the region included in the contact
|
|
730
|
+
xl : Float, optional
|
|
731
|
+
x position for corner of bounding box (default -MAXDOUBLE)
|
|
732
|
+
xh : Float, optional
|
|
733
|
+
x position for corner of bounding box (default +MAXDOUBLE)
|
|
734
|
+
yl : Float, optional
|
|
735
|
+
y position for corner of bounding box (default -MAXDOUBLE)
|
|
736
|
+
yh : Float, optional
|
|
737
|
+
y position for corner of bounding box (default +MAXDOUBLE)
|
|
738
|
+
bloat : Float, optional
|
|
739
|
+
Extend bounding box by this amount when search for mesh to include in region (default 1e-10)
|
|
740
|
+
'''
|
|
741
|
+
pass
|
|
742
|
+
|
|
743
|
+
def add_2d_interface (**kwargs):
|
|
744
|
+
'''
|
|
745
|
+
devsim.add_2d_interface (mesh, name, region0, region1, xl, xh, yl, yh, bloat)
|
|
746
|
+
|
|
747
|
+
Add an interface to a 2D mesh
|
|
748
|
+
|
|
749
|
+
Parameters
|
|
750
|
+
----------
|
|
751
|
+
mesh : str
|
|
752
|
+
Mesh to add the interface to
|
|
753
|
+
name : str
|
|
754
|
+
Name for the interface being created
|
|
755
|
+
region0 : str
|
|
756
|
+
Name of the region included in the interface
|
|
757
|
+
region1 : str
|
|
758
|
+
Name of the region included in the interface
|
|
759
|
+
xl : Float, optional
|
|
760
|
+
x position for corner of bounding box (default -MAXDOUBLE)
|
|
761
|
+
xh : Float, optional
|
|
762
|
+
x position for corner of bounding box (default +MAXDOUBLE)
|
|
763
|
+
yl : Float, optional
|
|
764
|
+
y position for corner of bounding box (default -MAXDOUBLE)
|
|
765
|
+
yh : Float, optional
|
|
766
|
+
y position for corner of bounding box (default +MAXDOUBLE)
|
|
767
|
+
bloat : Float, optional
|
|
768
|
+
Extend bounding box by this amount when search for mesh to include in region (default 1e-10)
|
|
769
|
+
'''
|
|
770
|
+
pass
|
|
771
|
+
|
|
772
|
+
def add_2d_mesh_line (**kwargs):
|
|
773
|
+
'''
|
|
774
|
+
devsim.add_2d_mesh_line (mesh, pos, ns, ps)
|
|
775
|
+
|
|
776
|
+
Add a mesh line to a 2D mesh
|
|
777
|
+
|
|
778
|
+
Parameters
|
|
779
|
+
----------
|
|
780
|
+
mesh : str
|
|
781
|
+
Mesh to add the line to
|
|
782
|
+
pos : str
|
|
783
|
+
Position for the mesh point
|
|
784
|
+
ns : Float
|
|
785
|
+
Spacing from this point in the negative direction
|
|
786
|
+
ps : Float
|
|
787
|
+
Spacing from this point in the positive direction
|
|
788
|
+
'''
|
|
789
|
+
pass
|
|
790
|
+
|
|
791
|
+
def add_2d_region (**kwargs):
|
|
792
|
+
'''
|
|
793
|
+
devsim.add_2d_region (mesh, region, material, xl, xh, yl, yh, bloat)
|
|
794
|
+
|
|
795
|
+
Add a region to a 2D mesh
|
|
796
|
+
|
|
797
|
+
Parameters
|
|
798
|
+
----------
|
|
799
|
+
mesh : str
|
|
800
|
+
Mesh to add the region to
|
|
801
|
+
region : str
|
|
802
|
+
Name for the region being created
|
|
803
|
+
material : str
|
|
804
|
+
Material for the region being created
|
|
805
|
+
xl : Float, optional
|
|
806
|
+
x position for corner of bounding box (default -MAXDOUBLE)
|
|
807
|
+
xh : Float, optional
|
|
808
|
+
x position for corner of bounding box (default +MAXDOUBLE)
|
|
809
|
+
yl : Float, optional
|
|
810
|
+
y position for corner of bounding box (default -MAXDOUBLE)
|
|
811
|
+
yh : Float, optional
|
|
812
|
+
y position for corner of bounding box (default +MAXDOUBLE)
|
|
813
|
+
bloat : Float, optional
|
|
814
|
+
Extend bounding box by this amount when search for mesh to include in region (default 1e-10)
|
|
815
|
+
'''
|
|
816
|
+
pass
|
|
817
|
+
|
|
818
|
+
def add_gmsh_contact (**kwargs):
|
|
819
|
+
'''
|
|
820
|
+
devsim.add_gmsh_contact (gmsh_name, material, mesh, name, region)
|
|
821
|
+
|
|
822
|
+
Create a mesh to import a Gmsh mesh
|
|
823
|
+
|
|
824
|
+
Parameters
|
|
825
|
+
----------
|
|
826
|
+
gmsh_name : str
|
|
827
|
+
physical group name in the Gmsh file
|
|
828
|
+
material : str
|
|
829
|
+
material for the contact being created
|
|
830
|
+
mesh : str
|
|
831
|
+
name of the mesh being generated
|
|
832
|
+
name : str
|
|
833
|
+
name of the contact begin created
|
|
834
|
+
region : str
|
|
835
|
+
region that the contact is attached to
|
|
836
|
+
'''
|
|
837
|
+
pass
|
|
838
|
+
|
|
839
|
+
def add_gmsh_interface (**kwargs):
|
|
840
|
+
'''
|
|
841
|
+
devsim.add_gmsh_interface (gmsh_name, mesh, name, region0, region1)
|
|
842
|
+
|
|
843
|
+
Create an interface for an imported Gmsh mesh
|
|
844
|
+
|
|
845
|
+
Parameters
|
|
846
|
+
----------
|
|
847
|
+
gmsh_name : str
|
|
848
|
+
physical group name in the Gmsh file
|
|
849
|
+
mesh : str
|
|
850
|
+
name of the mesh being generated
|
|
851
|
+
name : str
|
|
852
|
+
name of the interface begin created
|
|
853
|
+
region0 : str
|
|
854
|
+
first region that the interface is attached to
|
|
855
|
+
region1 : str
|
|
856
|
+
second region that the interface is attached to
|
|
857
|
+
'''
|
|
858
|
+
pass
|
|
859
|
+
|
|
860
|
+
def add_gmsh_region (**kwargs):
|
|
861
|
+
'''
|
|
862
|
+
devsim.add_gmsh_region (gmsh_name, mesh, region, material)
|
|
863
|
+
|
|
864
|
+
Create a region for an imported Gmsh mesh
|
|
865
|
+
|
|
866
|
+
Parameters
|
|
867
|
+
----------
|
|
868
|
+
gmsh_name : str
|
|
869
|
+
physical group name in the Gmsh file
|
|
870
|
+
mesh : str
|
|
871
|
+
name of the mesh being generated
|
|
872
|
+
region : str
|
|
873
|
+
name of the region begin created
|
|
874
|
+
material : str
|
|
875
|
+
material for the region being created
|
|
876
|
+
'''
|
|
877
|
+
pass
|
|
878
|
+
|
|
879
|
+
def create_1d_mesh (**kwargs):
|
|
880
|
+
'''
|
|
881
|
+
devsim.create_1d_mesh (mesh)
|
|
882
|
+
|
|
883
|
+
Create a mesh to create a 1D device
|
|
884
|
+
|
|
885
|
+
Parameters
|
|
886
|
+
----------
|
|
887
|
+
mesh : str
|
|
888
|
+
name of the 1D mesh being created
|
|
889
|
+
'''
|
|
890
|
+
pass
|
|
891
|
+
|
|
892
|
+
def create_2d_mesh (**kwargs):
|
|
893
|
+
'''
|
|
894
|
+
devsim.create_2d_mesh (mesh)
|
|
895
|
+
|
|
896
|
+
Create a mesh to create a 2D device
|
|
897
|
+
|
|
898
|
+
Parameters
|
|
899
|
+
----------
|
|
900
|
+
mesh : str
|
|
901
|
+
name of the 2D mesh being created
|
|
902
|
+
'''
|
|
903
|
+
pass
|
|
904
|
+
|
|
905
|
+
def create_contact_from_interface (**kwargs):
|
|
906
|
+
'''
|
|
907
|
+
devsim.create_contact_from_interface (device, region, interface, material, name)
|
|
908
|
+
|
|
909
|
+
Creates a contact on a device from an existing interface
|
|
910
|
+
|
|
911
|
+
Parameters
|
|
912
|
+
----------
|
|
913
|
+
device : str
|
|
914
|
+
The selected device
|
|
915
|
+
region : str
|
|
916
|
+
The selected region
|
|
917
|
+
interface : str
|
|
918
|
+
Interface on which to apply this command
|
|
919
|
+
material : str
|
|
920
|
+
material for the contact being created
|
|
921
|
+
name : str
|
|
922
|
+
name of the contact begin created
|
|
923
|
+
'''
|
|
924
|
+
pass
|
|
925
|
+
|
|
926
|
+
def create_device (**kwargs):
|
|
927
|
+
'''
|
|
928
|
+
devsim.create_device (mesh, device)
|
|
929
|
+
|
|
930
|
+
Create a device from a mesh
|
|
931
|
+
|
|
932
|
+
Parameters
|
|
933
|
+
----------
|
|
934
|
+
mesh : str
|
|
935
|
+
name of the mesh being used to create a device
|
|
936
|
+
device : str
|
|
937
|
+
name of the device being created
|
|
938
|
+
'''
|
|
939
|
+
pass
|
|
940
|
+
|
|
941
|
+
def create_gmsh_mesh (**kwargs):
|
|
942
|
+
'''
|
|
943
|
+
devsim.create_gmsh_mesh (mesh, file, coordinates, elements, physical_names)
|
|
944
|
+
|
|
945
|
+
Create a mesh to import a Gmsh mesh
|
|
946
|
+
|
|
947
|
+
Parameters
|
|
948
|
+
----------
|
|
949
|
+
mesh : str
|
|
950
|
+
name of the mesh being generated
|
|
951
|
+
file : str, optional
|
|
952
|
+
name of the Gmsh mesh file being read into DEVSIM
|
|
953
|
+
coordinates : list, optional
|
|
954
|
+
List of coordinate positions on mesh.
|
|
955
|
+
elements : list, optional
|
|
956
|
+
List of elements on the mesh.
|
|
957
|
+
physical_names : list, optional
|
|
958
|
+
List of names for each contact, interface, and region on mesh.
|
|
959
|
+
|
|
960
|
+
Notes
|
|
961
|
+
-----
|
|
962
|
+
|
|
963
|
+
This file will import a Gmsh format mesh from a file. Alternatively, the mesh structure may be passed in as as arguments:
|
|
964
|
+
|
|
965
|
+
``coordinates`` is a float list of positions in the mesh. Each coordinate adds an x, y, and z position so that the coordinate list length is 3 times the number of coordinates.
|
|
966
|
+
|
|
967
|
+
``physical_names`` is a list of contact, interface, and region names. It is referenced by index by the ``elements`` list.
|
|
968
|
+
|
|
969
|
+
``elements`` is a list of elements. Each element adds
|
|
970
|
+
|
|
971
|
+
* Element Type (float)
|
|
972
|
+
|
|
973
|
+
- 0 node
|
|
974
|
+
- 1 edge
|
|
975
|
+
- 2 triangle
|
|
976
|
+
- 3 tetrahedron
|
|
977
|
+
|
|
978
|
+
* Physical Index
|
|
979
|
+
|
|
980
|
+
- This indexes into the ``physical_names`` list.
|
|
981
|
+
|
|
982
|
+
* Nodes
|
|
983
|
+
|
|
984
|
+
- Each node of the element indexes into the coordinates list.
|
|
985
|
+
|
|
986
|
+
'''
|
|
987
|
+
pass
|
|
988
|
+
|
|
989
|
+
def create_interface_from_nodes (**kwargs):
|
|
990
|
+
'''
|
|
991
|
+
devsim.create_interface_from_nodes (device, name, region0, region1, nodes0, nodes1)
|
|
992
|
+
|
|
993
|
+
Creates an interface from lists of nodes
|
|
994
|
+
|
|
995
|
+
Parameters
|
|
996
|
+
----------
|
|
997
|
+
device : str
|
|
998
|
+
The selected device
|
|
999
|
+
name : str
|
|
1000
|
+
name of the interface begin created
|
|
1001
|
+
region0 : str
|
|
1002
|
+
first region that the interface is attached to
|
|
1003
|
+
region1 : str
|
|
1004
|
+
second region that the interface is attached to
|
|
1005
|
+
nodes0 : str
|
|
1006
|
+
list of nodes for the interface in the first region
|
|
1007
|
+
nodes1 : str
|
|
1008
|
+
list of nodes for the interface in the second region
|
|
1009
|
+
'''
|
|
1010
|
+
pass
|
|
1011
|
+
|
|
1012
|
+
def delete_device (**kwargs):
|
|
1013
|
+
'''
|
|
1014
|
+
devsim.delete_device (device)
|
|
1015
|
+
|
|
1016
|
+
Delete a device and its parameters
|
|
1017
|
+
|
|
1018
|
+
Parameters
|
|
1019
|
+
----------
|
|
1020
|
+
device : str
|
|
1021
|
+
name of the device being deleted
|
|
1022
|
+
'''
|
|
1023
|
+
pass
|
|
1024
|
+
|
|
1025
|
+
def delete_mesh (**kwargs):
|
|
1026
|
+
'''
|
|
1027
|
+
devsim.delete_mesh (mesh)
|
|
1028
|
+
|
|
1029
|
+
Delete a mesh so devices can no longer be instantiated from it.
|
|
1030
|
+
|
|
1031
|
+
Parameters
|
|
1032
|
+
----------
|
|
1033
|
+
mesh : str
|
|
1034
|
+
Mesh to delete
|
|
1035
|
+
'''
|
|
1036
|
+
pass
|
|
1037
|
+
|
|
1038
|
+
def finalize_mesh (**kwargs):
|
|
1039
|
+
'''
|
|
1040
|
+
devsim.finalize_mesh (mesh)
|
|
1041
|
+
|
|
1042
|
+
Finalize a mesh so no additional mesh specifications can be added and devices can be created.
|
|
1043
|
+
|
|
1044
|
+
Parameters
|
|
1045
|
+
----------
|
|
1046
|
+
mesh : str
|
|
1047
|
+
Mesh to finalize
|
|
1048
|
+
'''
|
|
1049
|
+
pass
|
|
1050
|
+
|
|
1051
|
+
def get_mesh_list (**kwargs):
|
|
1052
|
+
'''
|
|
1053
|
+
devsim.get_mesh_list ()
|
|
1054
|
+
|
|
1055
|
+
Get list of meshes
|
|
1056
|
+
'''
|
|
1057
|
+
pass
|
|
1058
|
+
|
|
1059
|
+
def load_devices (**kwargs):
|
|
1060
|
+
'''
|
|
1061
|
+
devsim.load_devices (file)
|
|
1062
|
+
|
|
1063
|
+
Load devices from a DEVSIM file
|
|
1064
|
+
|
|
1065
|
+
Parameters
|
|
1066
|
+
----------
|
|
1067
|
+
file : str
|
|
1068
|
+
name of the file to load the meshes from
|
|
1069
|
+
'''
|
|
1070
|
+
pass
|
|
1071
|
+
|
|
1072
|
+
def write_devices (**kwargs):
|
|
1073
|
+
'''
|
|
1074
|
+
devsim.write_devices (file, device, type, include_test)
|
|
1075
|
+
|
|
1076
|
+
Write a device to a file for visualization or restart
|
|
1077
|
+
|
|
1078
|
+
Parameters
|
|
1079
|
+
----------
|
|
1080
|
+
file : str
|
|
1081
|
+
name of the file to write the meshes to
|
|
1082
|
+
device : str, optional
|
|
1083
|
+
name of the device to write
|
|
1084
|
+
type : {'devsim', 'devsim_data', 'tecplot', 'vtk'}
|
|
1085
|
+
format to use
|
|
1086
|
+
include_test : str
|
|
1087
|
+
Callback function which tests whether a model should be written to the tecplot or vtk format
|
|
1088
|
+
'''
|
|
1089
|
+
pass
|
|
1090
|
+
|
|
1091
|
+
def contact_edge_model (**kwargs):
|
|
1092
|
+
'''
|
|
1093
|
+
devsim.contact_edge_model (device, contact, name, equation, display_type)
|
|
1094
|
+
|
|
1095
|
+
Create an edge model evaluated at a contact
|
|
1096
|
+
|
|
1097
|
+
Parameters
|
|
1098
|
+
----------
|
|
1099
|
+
device : str
|
|
1100
|
+
The selected device
|
|
1101
|
+
contact : str
|
|
1102
|
+
Contact on which to apply this command
|
|
1103
|
+
name : str
|
|
1104
|
+
Name of the contact edge model being created
|
|
1105
|
+
equation : str
|
|
1106
|
+
Equation used to describe the contact edge model being created
|
|
1107
|
+
display_type : {'vector', 'nodisplay', 'scalar'}
|
|
1108
|
+
Option for output display in graphical viewer
|
|
1109
|
+
'''
|
|
1110
|
+
pass
|
|
1111
|
+
|
|
1112
|
+
def contact_node_model (**kwargs):
|
|
1113
|
+
'''
|
|
1114
|
+
devsim.contact_node_model (device, contact, name, equation, display_type)
|
|
1115
|
+
|
|
1116
|
+
Create an node model evaluated at a contact
|
|
1117
|
+
|
|
1118
|
+
Parameters
|
|
1119
|
+
----------
|
|
1120
|
+
device : str
|
|
1121
|
+
The selected device
|
|
1122
|
+
contact : str
|
|
1123
|
+
Contact on which to apply this command
|
|
1124
|
+
name : str
|
|
1125
|
+
Name of the contact node model being created
|
|
1126
|
+
equation : str
|
|
1127
|
+
Equation used to describe the contact node model being created
|
|
1128
|
+
display_type : {'scalar', 'nodisplay'}
|
|
1129
|
+
Option for output display in graphical viewer
|
|
1130
|
+
'''
|
|
1131
|
+
pass
|
|
1132
|
+
|
|
1133
|
+
def cylindrical_edge_couple (**kwargs):
|
|
1134
|
+
'''
|
|
1135
|
+
devsim.cylindrical_edge_couple (device, region)
|
|
1136
|
+
|
|
1137
|
+
This command creates the ``EdgeCouple`` model for 2D cylindrical simulation
|
|
1138
|
+
|
|
1139
|
+
Parameters
|
|
1140
|
+
----------
|
|
1141
|
+
device : str
|
|
1142
|
+
The selected device
|
|
1143
|
+
region : str
|
|
1144
|
+
The selected region
|
|
1145
|
+
|
|
1146
|
+
Notes
|
|
1147
|
+
-----
|
|
1148
|
+
|
|
1149
|
+
This model is only available in 2D. The created variables are
|
|
1150
|
+
|
|
1151
|
+
- ``ElementCylindricalEdgeCouple`` (Element Edge Model)
|
|
1152
|
+
- ``CylindricalEdgeCouple`` (Edge Model)
|
|
1153
|
+
|
|
1154
|
+
The :meth:`devsim.set_parameter` must be used to set
|
|
1155
|
+
|
|
1156
|
+
- ``raxis_variable``, the variable (``x`` or ``y``) which is the radial axis variable in the cylindrical coordinate system
|
|
1157
|
+
- ``raxis_zero``, the location of the z axis for the radial axis variable
|
|
1158
|
+
'''
|
|
1159
|
+
pass
|
|
1160
|
+
|
|
1161
|
+
def cylindrical_node_volume (**kwargs):
|
|
1162
|
+
'''
|
|
1163
|
+
devsim.cylindrical_node_volume (device, region)
|
|
1164
|
+
|
|
1165
|
+
This command creates the ``NodeVolume`` model for 2D cylindrical simulation
|
|
1166
|
+
|
|
1167
|
+
Parameters
|
|
1168
|
+
----------
|
|
1169
|
+
device : str
|
|
1170
|
+
The selected device
|
|
1171
|
+
region : str
|
|
1172
|
+
The selected region
|
|
1173
|
+
|
|
1174
|
+
Notes
|
|
1175
|
+
-----
|
|
1176
|
+
|
|
1177
|
+
This model is only available in 2D. The created variables are
|
|
1178
|
+
|
|
1179
|
+
- ``ElementCylindricalNodeVolume@en0`` (Element Edge Model)
|
|
1180
|
+
- ``ElementCylindricalNodeVolume@en1`` (Element Edge Model)
|
|
1181
|
+
- ``CylindricalEdgeNodeVolume@n0`` (Edge Model)
|
|
1182
|
+
- ``CylindricalEdgeNodeVolume@n1`` (Edge Model)
|
|
1183
|
+
- ``CylindricalNodeVolume`` (Node Model)
|
|
1184
|
+
|
|
1185
|
+
The ``ElementCylindricalNodeVolume@en0`` and ``ElementCylindricalNodeVolume@en1`` represent the node volume at each end of the element edge.
|
|
1186
|
+
|
|
1187
|
+
The :meth:`devsim.set_parameter` must be used to set
|
|
1188
|
+
|
|
1189
|
+
- ``raxis_variable``, the variable (``x`` or ``y``) which is the radial axis variable in the cylindrical coordinate system
|
|
1190
|
+
- ``raxis_zero``, the location of the z axis for the radial axis variable
|
|
1191
|
+
|
|
1192
|
+
'''
|
|
1193
|
+
pass
|
|
1194
|
+
|
|
1195
|
+
def cylindrical_surface_area (**kwargs):
|
|
1196
|
+
'''
|
|
1197
|
+
devsim.cylindrical_surface_area (device, region)
|
|
1198
|
+
|
|
1199
|
+
This command creates the ``SurfaceArea`` model for 2D cylindrical simulation
|
|
1200
|
+
|
|
1201
|
+
Parameters
|
|
1202
|
+
----------
|
|
1203
|
+
device : str
|
|
1204
|
+
The selected device
|
|
1205
|
+
region : str
|
|
1206
|
+
The selected region
|
|
1207
|
+
|
|
1208
|
+
Notes
|
|
1209
|
+
-----
|
|
1210
|
+
|
|
1211
|
+
This model is only available in 2D. The created variables are
|
|
1212
|
+
|
|
1213
|
+
- ``CylindricalSurfaceArea`` (Node Model)
|
|
1214
|
+
|
|
1215
|
+
and is the cylindrical surface area along each contact and interface node in the device region.
|
|
1216
|
+
|
|
1217
|
+
The :meth:`devsim.set_parameter` must be used to set
|
|
1218
|
+
|
|
1219
|
+
- ``raxis_variable``, the variable (``x`` or ``y``) which is the radial axis variable in the cylindrical coordinate system
|
|
1220
|
+
- ``raxis_zero``, the location of the z axis for the radial axis variable
|
|
1221
|
+
|
|
1222
|
+
'''
|
|
1223
|
+
pass
|
|
1224
|
+
|
|
1225
|
+
def debug_triangle_models (**kwargs):
|
|
1226
|
+
'''
|
|
1227
|
+
devsim.debug_triangle_models (device, region)
|
|
1228
|
+
|
|
1229
|
+
Debugging command used in the development of DEVSIM and used in regressions.
|
|
1230
|
+
|
|
1231
|
+
Parameters
|
|
1232
|
+
----------
|
|
1233
|
+
device : str
|
|
1234
|
+
The selected device
|
|
1235
|
+
region : str
|
|
1236
|
+
The selected region
|
|
1237
|
+
'''
|
|
1238
|
+
pass
|
|
1239
|
+
|
|
1240
|
+
def delete_edge_model (**kwargs):
|
|
1241
|
+
'''
|
|
1242
|
+
devsim.delete_edge_model (device, region, name)
|
|
1243
|
+
|
|
1244
|
+
Deletes an edge model from a region
|
|
1245
|
+
|
|
1246
|
+
Parameters
|
|
1247
|
+
----------
|
|
1248
|
+
device : str
|
|
1249
|
+
The selected device
|
|
1250
|
+
region : str
|
|
1251
|
+
The selected region
|
|
1252
|
+
name : str
|
|
1253
|
+
Name of the edge model being deleted
|
|
1254
|
+
'''
|
|
1255
|
+
pass
|
|
1256
|
+
|
|
1257
|
+
def delete_element_model (**kwargs):
|
|
1258
|
+
'''
|
|
1259
|
+
devsim.delete_element_model (device, region, name)
|
|
1260
|
+
|
|
1261
|
+
Deletes a element model from a region
|
|
1262
|
+
|
|
1263
|
+
Parameters
|
|
1264
|
+
----------
|
|
1265
|
+
device : str
|
|
1266
|
+
The selected device
|
|
1267
|
+
region : str
|
|
1268
|
+
The selected region
|
|
1269
|
+
name : str
|
|
1270
|
+
Name of the node model being deleted
|
|
1271
|
+
'''
|
|
1272
|
+
pass
|
|
1273
|
+
|
|
1274
|
+
def delete_interface_model (**kwargs):
|
|
1275
|
+
'''
|
|
1276
|
+
devsim.delete_interface_model (device, interface, name)
|
|
1277
|
+
|
|
1278
|
+
Deletes an interface model from an interface
|
|
1279
|
+
|
|
1280
|
+
Parameters
|
|
1281
|
+
----------
|
|
1282
|
+
device : str
|
|
1283
|
+
The selected device
|
|
1284
|
+
interface : str
|
|
1285
|
+
Interface on which to apply this command
|
|
1286
|
+
name : str
|
|
1287
|
+
Name of the interface model being deleted
|
|
1288
|
+
'''
|
|
1289
|
+
pass
|
|
1290
|
+
|
|
1291
|
+
def delete_node_model (**kwargs):
|
|
1292
|
+
'''
|
|
1293
|
+
devsim.delete_node_model (device, region, name)
|
|
1294
|
+
|
|
1295
|
+
Deletes a node model from a region
|
|
1296
|
+
|
|
1297
|
+
Parameters
|
|
1298
|
+
----------
|
|
1299
|
+
device : str
|
|
1300
|
+
The selected device
|
|
1301
|
+
region : str
|
|
1302
|
+
The selected region
|
|
1303
|
+
name : str
|
|
1304
|
+
Name of the node model being deleted
|
|
1305
|
+
'''
|
|
1306
|
+
pass
|
|
1307
|
+
|
|
1308
|
+
def edge_average_model (**kwargs):
|
|
1309
|
+
'''
|
|
1310
|
+
devsim.edge_average_model (device, region, node_model, edge_model, derivative, average_type)
|
|
1311
|
+
|
|
1312
|
+
Creates an edge model based on the node model values
|
|
1313
|
+
|
|
1314
|
+
Parameters
|
|
1315
|
+
----------
|
|
1316
|
+
device : str
|
|
1317
|
+
The selected device
|
|
1318
|
+
region : str
|
|
1319
|
+
The selected region
|
|
1320
|
+
node_model : str
|
|
1321
|
+
The node model from which we are creating the edge model. If ``derivative`` is specified, the edge model is created from ``nodeModel:derivativeModel``
|
|
1322
|
+
edge_model : str
|
|
1323
|
+
The edge model name being created. If ``derivative`` is specified, the edge models created are ``edgeModel:derivativeModel@n0`` ``edgeModel:derivativeModel@n1``, which are the derivatives with respect to the derivative model on each side of the edge
|
|
1324
|
+
derivative : str, optional
|
|
1325
|
+
The node model of the variable for which the derivative is being taken. The node model ``nodeModel:derivativeModel`` is used to create the resulting edge models.
|
|
1326
|
+
average_type : {'arithmetic', 'geometric', 'gradient', 'negative_gradient'}
|
|
1327
|
+
The node models on both sides of the edge are averaged together to create one of the following types of averages.
|
|
1328
|
+
|
|
1329
|
+
Notes
|
|
1330
|
+
-----
|
|
1331
|
+
|
|
1332
|
+
For a node model, creates 2 edge models referring to the node model value at both ends of the edge. For example, to calculate electric field:
|
|
1333
|
+
|
|
1334
|
+
..
|
|
1335
|
+
|
|
1336
|
+
devsim.edge_average_model(device=device, region=region, node_model="Potential", edge_model="ElecticField", average_type="negative_gradient")
|
|
1337
|
+
|
|
1338
|
+
and the derivatives ``ElectricField:Potential@n0`` and ``ElectricField:Potential@n1`` are then created from
|
|
1339
|
+
|
|
1340
|
+
..
|
|
1341
|
+
|
|
1342
|
+
devsim.edge_average_model(device=device, region=region, node_model="Potential", edge_model="ElecticField", average_type="negative_gradient", derivative="Potential")
|
|
1343
|
+
'''
|
|
1344
|
+
pass
|
|
1345
|
+
|
|
1346
|
+
def edge_from_node_model (**kwargs):
|
|
1347
|
+
'''
|
|
1348
|
+
devsim.edge_from_node_model (device, region, node_model)
|
|
1349
|
+
|
|
1350
|
+
For a node model, creates an 2 edge models referring to the node model value at both ends of the edge.
|
|
1351
|
+
|
|
1352
|
+
Parameters
|
|
1353
|
+
----------
|
|
1354
|
+
device : str
|
|
1355
|
+
The selected device
|
|
1356
|
+
region : str
|
|
1357
|
+
The selected region
|
|
1358
|
+
node_model : str
|
|
1359
|
+
The node model from which we are creating the edge model
|
|
1360
|
+
|
|
1361
|
+
Notes
|
|
1362
|
+
-----
|
|
1363
|
+
|
|
1364
|
+
For example, to calculate electric field:
|
|
1365
|
+
|
|
1366
|
+
..
|
|
1367
|
+
|
|
1368
|
+
devsim.edge_from_node_model(device=device, region=region, node_model="Potential")
|
|
1369
|
+
|
|
1370
|
+
'''
|
|
1371
|
+
pass
|
|
1372
|
+
|
|
1373
|
+
def edge_model (**kwargs):
|
|
1374
|
+
'''
|
|
1375
|
+
devsim.edge_model (device, region, name, equation, display_type)
|
|
1376
|
+
|
|
1377
|
+
Creates an edge model based on an equation
|
|
1378
|
+
|
|
1379
|
+
Parameters
|
|
1380
|
+
----------
|
|
1381
|
+
device : str
|
|
1382
|
+
The selected device
|
|
1383
|
+
region : str
|
|
1384
|
+
The selected region
|
|
1385
|
+
name : str
|
|
1386
|
+
Name of the edge model being created
|
|
1387
|
+
equation : str
|
|
1388
|
+
Equation used to describe the edge model being created
|
|
1389
|
+
display_type : {'scalar', 'nodisplay', 'vector'}
|
|
1390
|
+
Option for output display in graphical viewer
|
|
1391
|
+
|
|
1392
|
+
Notes
|
|
1393
|
+
-----
|
|
1394
|
+
|
|
1395
|
+
The ``vector`` option uses an averaging scheme for the edge values projected in the direction of each edge. For a given model, ``model``, the generated components in the visualization files is:
|
|
1396
|
+
|
|
1397
|
+
- ``model_x_onNode``
|
|
1398
|
+
- ``model_y_onNode``
|
|
1399
|
+
- ``model_z_onNode`` (3D)
|
|
1400
|
+
|
|
1401
|
+
This averaging scheme does not produce accurate results, and it is recommended to use the :meth:`devsim.element_from_edge_model` to create components better suited for visualization. See :ref:`ch__visualization` for more information about creating data files for external visualization programs.
|
|
1402
|
+
'''
|
|
1403
|
+
pass
|
|
1404
|
+
|
|
1405
|
+
def edge_solution (**kwargs):
|
|
1406
|
+
'''
|
|
1407
|
+
devsim.edge_solution (device, region, name)
|
|
1408
|
+
|
|
1409
|
+
Create node model whose values are set.
|
|
1410
|
+
|
|
1411
|
+
Parameters
|
|
1412
|
+
----------
|
|
1413
|
+
device : str
|
|
1414
|
+
The selected device
|
|
1415
|
+
region : str
|
|
1416
|
+
The selected region
|
|
1417
|
+
name : str
|
|
1418
|
+
Name of the solution being created
|
|
1419
|
+
'''
|
|
1420
|
+
pass
|
|
1421
|
+
|
|
1422
|
+
def element_from_edge_model (**kwargs):
|
|
1423
|
+
'''
|
|
1424
|
+
devsim.element_from_edge_model (device, region, edge_model, derivative)
|
|
1425
|
+
|
|
1426
|
+
Creates element edge models from an edge model
|
|
1427
|
+
|
|
1428
|
+
Parameters
|
|
1429
|
+
----------
|
|
1430
|
+
device : str
|
|
1431
|
+
The selected device
|
|
1432
|
+
region : str
|
|
1433
|
+
The selected region
|
|
1434
|
+
edge_model : str
|
|
1435
|
+
The edge model from which we are creating the element model
|
|
1436
|
+
derivative : str, optional
|
|
1437
|
+
The variable we are taking with respect to edge_model
|
|
1438
|
+
|
|
1439
|
+
Notes
|
|
1440
|
+
-----
|
|
1441
|
+
|
|
1442
|
+
For an edge model ``emodel``, creates an element models referring to the directional components on each edge of the element:
|
|
1443
|
+
|
|
1444
|
+
- ``emodel_x``
|
|
1445
|
+
- ``emodel_y``
|
|
1446
|
+
|
|
1447
|
+
If the ``derivative`` ``variable`` option is specified, the ``emodel@n0`` and ``emodel@n1`` are used to create:
|
|
1448
|
+
|
|
1449
|
+
- ``emodel_x:variable@en0``
|
|
1450
|
+
- ``emodel_y:variable@en0``
|
|
1451
|
+
- ``emodel_x:variable@en1``
|
|
1452
|
+
- ``emodel_y:variable@en1``
|
|
1453
|
+
- ``emodel_x:variable@en2``
|
|
1454
|
+
- ``emodel_y:variable@en2``
|
|
1455
|
+
|
|
1456
|
+
in 2D for each node on a triangular element. and
|
|
1457
|
+
|
|
1458
|
+
- ``emodel_x:variable@en0``
|
|
1459
|
+
- ``emodel_y:variable@en0``
|
|
1460
|
+
- ``emodel_z:variable@en0``
|
|
1461
|
+
- ``emodel_x:variable@en1``
|
|
1462
|
+
- ``emodel_y:variable@en1``
|
|
1463
|
+
- ``emodel_z:variable@en1``
|
|
1464
|
+
- ``emodel_x:variable@en2``
|
|
1465
|
+
- ``emodel_y:variable@en2``
|
|
1466
|
+
- ``emodel_z:variable@en2``
|
|
1467
|
+
- ``emodel_x:variable@en3``
|
|
1468
|
+
- ``emodel_y:variable@en3``
|
|
1469
|
+
- ``emodel_z:variable@en3``
|
|
1470
|
+
|
|
1471
|
+
in 3D for each node on a tetrahedral element.
|
|
1472
|
+
|
|
1473
|
+
The suffix ``en0`` refers to the first node on the edge of the element and ``en1`` refers to the second node. ``en2`` and ``en3`` specifies the derivatives with respect the variable at the nodes opposite the edges on the element being considered.
|
|
1474
|
+
'''
|
|
1475
|
+
pass
|
|
1476
|
+
|
|
1477
|
+
def element_from_node_model (**kwargs):
|
|
1478
|
+
'''
|
|
1479
|
+
devsim.element_from_node_model (device, region, node_model)
|
|
1480
|
+
|
|
1481
|
+
Creates element edge models from a node model
|
|
1482
|
+
|
|
1483
|
+
Parameters
|
|
1484
|
+
----------
|
|
1485
|
+
device : str
|
|
1486
|
+
The selected device
|
|
1487
|
+
region : str
|
|
1488
|
+
The selected region
|
|
1489
|
+
node_model : str
|
|
1490
|
+
The node model from which we are creating the edge model
|
|
1491
|
+
|
|
1492
|
+
Notes
|
|
1493
|
+
-----
|
|
1494
|
+
|
|
1495
|
+
This command creates an element edge model from a node model so that each corner of the element is represented. A node model, ``nmodel``, would be be accessible as
|
|
1496
|
+
|
|
1497
|
+
- ``nmodel@en0``
|
|
1498
|
+
- ``nmodel@en1``
|
|
1499
|
+
- ``nmodel@en2``
|
|
1500
|
+
- ``nmodel@en3`` (3D)
|
|
1501
|
+
|
|
1502
|
+
where ``en0``, and ``en1`` refers to the nodes on the element's edge. In 2D, ``en2`` refers to the node on the triangle node opposite the edge. In 3D, ``en2`` and ``en3`` refers to the nodes on the nodes off the element edge on the tetrahedral element.
|
|
1503
|
+
'''
|
|
1504
|
+
pass
|
|
1505
|
+
|
|
1506
|
+
def element_model (**kwargs):
|
|
1507
|
+
'''
|
|
1508
|
+
devsim.element_model (device, region, name, equation, display_type)
|
|
1509
|
+
|
|
1510
|
+
Create a model evaluated on element edges.
|
|
1511
|
+
|
|
1512
|
+
Parameters
|
|
1513
|
+
----------
|
|
1514
|
+
device : str
|
|
1515
|
+
The selected device
|
|
1516
|
+
region : str
|
|
1517
|
+
The selected region
|
|
1518
|
+
name : str
|
|
1519
|
+
Name of the element edge model being created
|
|
1520
|
+
equation : str
|
|
1521
|
+
Equation used to describe the element edge model being created
|
|
1522
|
+
display_type : {'scalar', 'nodisplay'}
|
|
1523
|
+
Option for output display in graphical viewer
|
|
1524
|
+
'''
|
|
1525
|
+
pass
|
|
1526
|
+
|
|
1527
|
+
def element_pair_from_edge_model (**kwargs):
|
|
1528
|
+
'''
|
|
1529
|
+
devsim.element_pair_from_edge_model (device, region, edge_model, derivative)
|
|
1530
|
+
|
|
1531
|
+
Creates element edge models from an edge model
|
|
1532
|
+
|
|
1533
|
+
Parameters
|
|
1534
|
+
----------
|
|
1535
|
+
device : str
|
|
1536
|
+
The selected device
|
|
1537
|
+
region : str
|
|
1538
|
+
The selected region
|
|
1539
|
+
edge_model : str
|
|
1540
|
+
The edge model from which we are creating the element model
|
|
1541
|
+
derivative : str, optional
|
|
1542
|
+
The variable we are taking with respect to edge_model
|
|
1543
|
+
|
|
1544
|
+
Notes
|
|
1545
|
+
-----
|
|
1546
|
+
|
|
1547
|
+
For an edge model ``emodel``, creates an element models referring to the directional components on each edge of the element:
|
|
1548
|
+
|
|
1549
|
+
- ``emodel_node0_x``
|
|
1550
|
+
- ``emodel_node0_y``
|
|
1551
|
+
- ``emodel_node1_x``
|
|
1552
|
+
- ``emodel_node1_y``
|
|
1553
|
+
|
|
1554
|
+
If the ``derivative`` ``variable`` option is specified, the ``emodel@n0`` and ``emodel@n1`` are used to create:
|
|
1555
|
+
|
|
1556
|
+
- ``emodel_node0_x:variable@en0``
|
|
1557
|
+
- ``emodel_node0_y:variable@en0``
|
|
1558
|
+
- ``emodel_node0_x:variable@en1``
|
|
1559
|
+
- ``emodel_node0_y:variable@en1``
|
|
1560
|
+
- ``emodel_node0_x:variable@en2``
|
|
1561
|
+
- ``emodel_node0_y:variable@en2``
|
|
1562
|
+
- ``emodel_node1_x:variable@en0``
|
|
1563
|
+
- ``emodel_node1_y:variable@en0``
|
|
1564
|
+
- ``emodel_node1_x:variable@en1``
|
|
1565
|
+
- ``emodel_node1_y:variable@en1``
|
|
1566
|
+
- ``emodel_node1_x:variable@en2``
|
|
1567
|
+
- ``emodel_node1_y:variable@en2``
|
|
1568
|
+
|
|
1569
|
+
in 2D for each node on a triangular element. and
|
|
1570
|
+
|
|
1571
|
+
- ``emodel_node0_x:variable@en0``
|
|
1572
|
+
- ``emodel_node0_y:variable@en0``
|
|
1573
|
+
- ``emodel_node0_z:variable@en0``
|
|
1574
|
+
- ``emodel_node0_x:variable@en1``
|
|
1575
|
+
- ``emodel_node0_y:variable@en1``
|
|
1576
|
+
- ``emodel_node0_z:variable@en1``
|
|
1577
|
+
- ``emodel_node0_x:variable@en2``
|
|
1578
|
+
- ``emodel_node0_y:variable@en2``
|
|
1579
|
+
- ``emodel_node0_z:variable@en2``
|
|
1580
|
+
- ``emodel_node0_x:variable@en3``
|
|
1581
|
+
- ``emodel_node0_y:variable@en3``
|
|
1582
|
+
- ``emodel_node0_z:variable@en3``
|
|
1583
|
+
- ``emodel_node1_x:variable@en0``
|
|
1584
|
+
- ``emodel_node1_y:variable@en0``
|
|
1585
|
+
- ``emodel_node1_z:variable@en0``
|
|
1586
|
+
- ``emodel_node1_x:variable@en1``
|
|
1587
|
+
- ``emodel_node1_y:variable@en1``
|
|
1588
|
+
- ``emodel_node1_z:variable@en1``
|
|
1589
|
+
- ``emodel_node1_x:variable@en2``
|
|
1590
|
+
- ``emodel_node1_y:variable@en2``
|
|
1591
|
+
- ``emodel_node1_z:variable@en2``
|
|
1592
|
+
- ``emodel_node1_x:variable@en3``
|
|
1593
|
+
- ``emodel_node1_y:variable@en3``
|
|
1594
|
+
- ``emodel_node1_z:variable@en3``
|
|
1595
|
+
|
|
1596
|
+
in 3D for each node on a tetrahedral element.
|
|
1597
|
+
|
|
1598
|
+
The label ``node0`` and ``node1`` refer to the node on the edge for which the element field average was performed. For example, ``node0`` signifies that all edges connected to ``node0`` where used to calculate the element field.
|
|
1599
|
+
|
|
1600
|
+
The suffix ``en0`` refers to the first node on the edge of the element and ``en1`` refers to the second node. ``en2`` and ``en3`` specifies the derivatives with respect the variable at the nodes opposite the edges on the element being considered.
|
|
1601
|
+
'''
|
|
1602
|
+
pass
|
|
1603
|
+
|
|
1604
|
+
def element_solution (**kwargs):
|
|
1605
|
+
'''
|
|
1606
|
+
devsim.element_solution (device, region, name)
|
|
1607
|
+
|
|
1608
|
+
Create node model whose values are set.
|
|
1609
|
+
|
|
1610
|
+
Parameters
|
|
1611
|
+
----------
|
|
1612
|
+
device : str
|
|
1613
|
+
The selected device
|
|
1614
|
+
region : str
|
|
1615
|
+
The selected region
|
|
1616
|
+
name : str
|
|
1617
|
+
Name of the solution being created
|
|
1618
|
+
'''
|
|
1619
|
+
pass
|
|
1620
|
+
|
|
1621
|
+
def get_edge_model_list (**kwargs):
|
|
1622
|
+
'''
|
|
1623
|
+
devsim.get_edge_model_list (device, region)
|
|
1624
|
+
|
|
1625
|
+
Returns a list of the edge models on the device region
|
|
1626
|
+
|
|
1627
|
+
Parameters
|
|
1628
|
+
----------
|
|
1629
|
+
device : str
|
|
1630
|
+
The selected device
|
|
1631
|
+
region : str
|
|
1632
|
+
The selected region
|
|
1633
|
+
'''
|
|
1634
|
+
pass
|
|
1635
|
+
|
|
1636
|
+
def get_edge_model_values (**kwargs):
|
|
1637
|
+
'''
|
|
1638
|
+
devsim.get_edge_model_values (device, region, name)
|
|
1639
|
+
|
|
1640
|
+
Get the edge model values calculated at each edge.
|
|
1641
|
+
|
|
1642
|
+
Parameters
|
|
1643
|
+
----------
|
|
1644
|
+
device : str
|
|
1645
|
+
The selected device
|
|
1646
|
+
region : str
|
|
1647
|
+
The selected region
|
|
1648
|
+
name : str
|
|
1649
|
+
Name of the edge model values being returned as a list
|
|
1650
|
+
'''
|
|
1651
|
+
pass
|
|
1652
|
+
|
|
1653
|
+
def get_element_model_list (**kwargs):
|
|
1654
|
+
'''
|
|
1655
|
+
devsim.get_element_model_list (device, region)
|
|
1656
|
+
|
|
1657
|
+
Returns a list of the element edge models on the device region
|
|
1658
|
+
|
|
1659
|
+
Parameters
|
|
1660
|
+
----------
|
|
1661
|
+
device : str
|
|
1662
|
+
The selected device
|
|
1663
|
+
region : str
|
|
1664
|
+
The selected region
|
|
1665
|
+
'''
|
|
1666
|
+
pass
|
|
1667
|
+
|
|
1668
|
+
def get_element_model_values (**kwargs):
|
|
1669
|
+
'''
|
|
1670
|
+
devsim.get_element_model_values (device, region, name)
|
|
1671
|
+
|
|
1672
|
+
Get element model values at each element edge
|
|
1673
|
+
|
|
1674
|
+
Parameters
|
|
1675
|
+
----------
|
|
1676
|
+
device : str
|
|
1677
|
+
The selected device
|
|
1678
|
+
region : str
|
|
1679
|
+
The selected region
|
|
1680
|
+
name : str
|
|
1681
|
+
Name of the element edge model values being returned as a list
|
|
1682
|
+
'''
|
|
1683
|
+
pass
|
|
1684
|
+
|
|
1685
|
+
def get_interface_model_list (**kwargs):
|
|
1686
|
+
'''
|
|
1687
|
+
devsim.get_interface_model_list (device, interface)
|
|
1688
|
+
|
|
1689
|
+
Returns a list of the interface models on the interface
|
|
1690
|
+
|
|
1691
|
+
Parameters
|
|
1692
|
+
----------
|
|
1693
|
+
device : str
|
|
1694
|
+
The selected device
|
|
1695
|
+
interface : str
|
|
1696
|
+
Interface on which to apply this command
|
|
1697
|
+
'''
|
|
1698
|
+
pass
|
|
1699
|
+
|
|
1700
|
+
def get_interface_model_values (**kwargs):
|
|
1701
|
+
'''
|
|
1702
|
+
devsim.get_interface_model_values (device, interface, name)
|
|
1703
|
+
|
|
1704
|
+
Gets interface model values evaluated at each interface node.
|
|
1705
|
+
|
|
1706
|
+
Parameters
|
|
1707
|
+
----------
|
|
1708
|
+
device : str
|
|
1709
|
+
The selected device
|
|
1710
|
+
interface : str
|
|
1711
|
+
Interface on which to apply this command
|
|
1712
|
+
name : str
|
|
1713
|
+
Name of the interface model values being returned as a list
|
|
1714
|
+
'''
|
|
1715
|
+
pass
|
|
1716
|
+
|
|
1717
|
+
def get_node_model_list (**kwargs):
|
|
1718
|
+
'''
|
|
1719
|
+
devsim.get_node_model_list (device, region)
|
|
1720
|
+
|
|
1721
|
+
Returns a list of the node models on the device region
|
|
1722
|
+
|
|
1723
|
+
Parameters
|
|
1724
|
+
----------
|
|
1725
|
+
device : str
|
|
1726
|
+
The selected device
|
|
1727
|
+
region : str
|
|
1728
|
+
The selected region
|
|
1729
|
+
'''
|
|
1730
|
+
pass
|
|
1731
|
+
|
|
1732
|
+
def get_node_model_values (**kwargs):
|
|
1733
|
+
'''
|
|
1734
|
+
devsim.get_node_model_values (device, region, name)
|
|
1735
|
+
|
|
1736
|
+
Get node model values evaluated at each node in a region.
|
|
1737
|
+
|
|
1738
|
+
Parameters
|
|
1739
|
+
----------
|
|
1740
|
+
device : str
|
|
1741
|
+
The selected device
|
|
1742
|
+
region : str
|
|
1743
|
+
The selected region
|
|
1744
|
+
name : str
|
|
1745
|
+
Name of the node model values being returned as a list
|
|
1746
|
+
'''
|
|
1747
|
+
pass
|
|
1748
|
+
|
|
1749
|
+
def interface_model (**kwargs):
|
|
1750
|
+
'''
|
|
1751
|
+
devsim.interface_model (device, interface, equation)
|
|
1752
|
+
|
|
1753
|
+
Create an interface model from an equation.
|
|
1754
|
+
|
|
1755
|
+
Parameters
|
|
1756
|
+
----------
|
|
1757
|
+
device : str
|
|
1758
|
+
The selected device
|
|
1759
|
+
interface : str
|
|
1760
|
+
Interface on which to apply this command
|
|
1761
|
+
equation : str
|
|
1762
|
+
Equation used to describe the interface node model being created
|
|
1763
|
+
'''
|
|
1764
|
+
pass
|
|
1765
|
+
|
|
1766
|
+
def interface_normal_model (**kwargs):
|
|
1767
|
+
'''
|
|
1768
|
+
devsim.interface_normal_model (device, region, interface)
|
|
1769
|
+
|
|
1770
|
+
Creates edge models whose components are based on direction and distance to an interface
|
|
1771
|
+
|
|
1772
|
+
Parameters
|
|
1773
|
+
----------
|
|
1774
|
+
device : str
|
|
1775
|
+
The selected device
|
|
1776
|
+
region : str
|
|
1777
|
+
The selected region
|
|
1778
|
+
interface : str
|
|
1779
|
+
Interface on which to apply this command
|
|
1780
|
+
|
|
1781
|
+
Notes
|
|
1782
|
+
-----
|
|
1783
|
+
|
|
1784
|
+
This model creates the following edge models:
|
|
1785
|
+
|
|
1786
|
+
- ``iname_distance``
|
|
1787
|
+
- ``iname_normal_x`` (2D and 3D)
|
|
1788
|
+
- ``iname_normal_y`` (2D and 3D)
|
|
1789
|
+
- ``iname_normal_z`` (3D only)
|
|
1790
|
+
|
|
1791
|
+
where ``iname`` is the name of the interface. The normals are of the closest node on the interface. The sign is toward the interface.
|
|
1792
|
+
'''
|
|
1793
|
+
pass
|
|
1794
|
+
|
|
1795
|
+
def node_model (**kwargs):
|
|
1796
|
+
'''
|
|
1797
|
+
devsim.node_model (device, region, name, equation, display_type)
|
|
1798
|
+
|
|
1799
|
+
Create a node model from an equation.
|
|
1800
|
+
|
|
1801
|
+
Parameters
|
|
1802
|
+
----------
|
|
1803
|
+
device : str
|
|
1804
|
+
The selected device
|
|
1805
|
+
region : str
|
|
1806
|
+
The selected region
|
|
1807
|
+
name : str
|
|
1808
|
+
Name of the node model being created
|
|
1809
|
+
equation : str
|
|
1810
|
+
Equation used to describe the node model being created
|
|
1811
|
+
display_type : {'scalar', 'nodisplay'}
|
|
1812
|
+
Option for output display in graphical viewer
|
|
1813
|
+
'''
|
|
1814
|
+
pass
|
|
1815
|
+
|
|
1816
|
+
def node_solution (**kwargs):
|
|
1817
|
+
'''
|
|
1818
|
+
devsim.node_solution (device, region, name)
|
|
1819
|
+
|
|
1820
|
+
Create node model whose values are set.
|
|
1821
|
+
|
|
1822
|
+
Parameters
|
|
1823
|
+
----------
|
|
1824
|
+
device : str
|
|
1825
|
+
The selected device
|
|
1826
|
+
region : str
|
|
1827
|
+
The selected region
|
|
1828
|
+
name : str
|
|
1829
|
+
Name of the solution being created
|
|
1830
|
+
'''
|
|
1831
|
+
pass
|
|
1832
|
+
|
|
1833
|
+
def print_edge_values (**kwargs):
|
|
1834
|
+
'''
|
|
1835
|
+
devsim.print_edge_values (device, region, name)
|
|
1836
|
+
|
|
1837
|
+
Print edge values for debugging.
|
|
1838
|
+
|
|
1839
|
+
Parameters
|
|
1840
|
+
----------
|
|
1841
|
+
device : str
|
|
1842
|
+
The selected device
|
|
1843
|
+
region : str
|
|
1844
|
+
The selected region
|
|
1845
|
+
name : str
|
|
1846
|
+
Name of the edge model values being printed to the screen
|
|
1847
|
+
'''
|
|
1848
|
+
pass
|
|
1849
|
+
|
|
1850
|
+
def print_element_values (**kwargs):
|
|
1851
|
+
'''
|
|
1852
|
+
devsim.print_element_values (device, region, name)
|
|
1853
|
+
|
|
1854
|
+
Print element values for debugging.
|
|
1855
|
+
|
|
1856
|
+
Parameters
|
|
1857
|
+
----------
|
|
1858
|
+
device : str
|
|
1859
|
+
The selected device
|
|
1860
|
+
region : str
|
|
1861
|
+
The selected region
|
|
1862
|
+
name : str
|
|
1863
|
+
Name of the element edge model values being printed to the screen
|
|
1864
|
+
'''
|
|
1865
|
+
pass
|
|
1866
|
+
|
|
1867
|
+
def print_node_values (**kwargs):
|
|
1868
|
+
'''
|
|
1869
|
+
devsim.print_node_values (device, region, name)
|
|
1870
|
+
|
|
1871
|
+
Print node values for debugging.
|
|
1872
|
+
|
|
1873
|
+
Parameters
|
|
1874
|
+
----------
|
|
1875
|
+
device : str
|
|
1876
|
+
The selected device
|
|
1877
|
+
region : str
|
|
1878
|
+
The selected region
|
|
1879
|
+
name : str
|
|
1880
|
+
Name of the node model values being printed to the screen
|
|
1881
|
+
'''
|
|
1882
|
+
pass
|
|
1883
|
+
|
|
1884
|
+
def register_function (**kwargs):
|
|
1885
|
+
'''
|
|
1886
|
+
devsim.register_function (name, nargs, procedure)
|
|
1887
|
+
|
|
1888
|
+
This command is used to register a new Python procedure for evaluation by SYMDIFF.
|
|
1889
|
+
|
|
1890
|
+
Parameters
|
|
1891
|
+
----------
|
|
1892
|
+
name : str
|
|
1893
|
+
Name of the function
|
|
1894
|
+
nargs : str
|
|
1895
|
+
Number of arguments to the function
|
|
1896
|
+
procedure : str
|
|
1897
|
+
The procedure to be called
|
|
1898
|
+
'''
|
|
1899
|
+
pass
|
|
1900
|
+
|
|
1901
|
+
def set_edge_values (**kwargs):
|
|
1902
|
+
'''
|
|
1903
|
+
devsim.set_edge_values (device, region, name, init_from, values)
|
|
1904
|
+
|
|
1905
|
+
Set edge model values from another edge model, or a list of values.
|
|
1906
|
+
|
|
1907
|
+
Parameters
|
|
1908
|
+
----------
|
|
1909
|
+
device : str
|
|
1910
|
+
The selected device
|
|
1911
|
+
region : str
|
|
1912
|
+
The selected region
|
|
1913
|
+
name : str
|
|
1914
|
+
Name of the edge model being initialized
|
|
1915
|
+
init_from : str, optional
|
|
1916
|
+
Node model we are using to initialize the edge solution
|
|
1917
|
+
values : list, optional
|
|
1918
|
+
List of values for each edge in the region.
|
|
1919
|
+
'''
|
|
1920
|
+
pass
|
|
1921
|
+
|
|
1922
|
+
def set_element_values (**kwargs):
|
|
1923
|
+
'''
|
|
1924
|
+
devsim.set_element_values (device, region, name, init_from, values)
|
|
1925
|
+
|
|
1926
|
+
Set element model values from another element model, or a list of values.
|
|
1927
|
+
|
|
1928
|
+
Parameters
|
|
1929
|
+
----------
|
|
1930
|
+
device : str
|
|
1931
|
+
The selected device
|
|
1932
|
+
region : str
|
|
1933
|
+
The selected region
|
|
1934
|
+
name : str
|
|
1935
|
+
Name of the element model being initialized
|
|
1936
|
+
init_from : str, optional
|
|
1937
|
+
Node model we are using to initialize the element solution
|
|
1938
|
+
values : list, optional
|
|
1939
|
+
List of values for each element in the region.
|
|
1940
|
+
'''
|
|
1941
|
+
pass
|
|
1942
|
+
|
|
1943
|
+
def set_node_value (**kwargs):
|
|
1944
|
+
'''
|
|
1945
|
+
devsim.set_node_value (device, region, name, index, value)
|
|
1946
|
+
|
|
1947
|
+
A uniform value is used if index is not specified. Note that equation based node models will lose this value if their equation is recalculated.
|
|
1948
|
+
|
|
1949
|
+
Parameters
|
|
1950
|
+
----------
|
|
1951
|
+
device : str
|
|
1952
|
+
The selected device
|
|
1953
|
+
region : str
|
|
1954
|
+
The selected region
|
|
1955
|
+
name : str
|
|
1956
|
+
Name of the node model being whose value is being set
|
|
1957
|
+
index : int
|
|
1958
|
+
Index of node being set
|
|
1959
|
+
value : Float
|
|
1960
|
+
Value of node being set
|
|
1961
|
+
'''
|
|
1962
|
+
pass
|
|
1963
|
+
|
|
1964
|
+
def set_node_values (**kwargs):
|
|
1965
|
+
'''
|
|
1966
|
+
devsim.set_node_values (device, region, name, init_from, values)
|
|
1967
|
+
|
|
1968
|
+
Set node model values from another node model, or a list of values.
|
|
1969
|
+
|
|
1970
|
+
Parameters
|
|
1971
|
+
----------
|
|
1972
|
+
device : str
|
|
1973
|
+
The selected device
|
|
1974
|
+
region : str
|
|
1975
|
+
The selected region
|
|
1976
|
+
name : str
|
|
1977
|
+
Name of the node model being initialized
|
|
1978
|
+
init_from : str, optional
|
|
1979
|
+
Node model we are using to initialize the node solution
|
|
1980
|
+
values : list, optional
|
|
1981
|
+
List of values for each node in the region.
|
|
1982
|
+
'''
|
|
1983
|
+
pass
|
|
1984
|
+
|
|
1985
|
+
def symdiff (**kwargs):
|
|
1986
|
+
'''
|
|
1987
|
+
devsim.symdiff (expr)
|
|
1988
|
+
|
|
1989
|
+
This command returns an expression. All strings are treated as independent variables. It is primarily used for defining new functions to the parser.
|
|
1990
|
+
|
|
1991
|
+
Parameters
|
|
1992
|
+
----------
|
|
1993
|
+
expr : str
|
|
1994
|
+
Expression to send to SYMDIFF
|
|
1995
|
+
'''
|
|
1996
|
+
pass
|
|
1997
|
+
|
|
1998
|
+
def vector_element_model (**kwargs):
|
|
1999
|
+
'''
|
|
2000
|
+
devsim.vector_element_model (device, region, element_model)
|
|
2001
|
+
|
|
2002
|
+
Create vector components from an element edge model
|
|
2003
|
+
|
|
2004
|
+
Parameters
|
|
2005
|
+
----------
|
|
2006
|
+
device : str
|
|
2007
|
+
The selected device
|
|
2008
|
+
region : str
|
|
2009
|
+
The selected region
|
|
2010
|
+
element_model : str
|
|
2011
|
+
The element model for which we are calculating the vector components
|
|
2012
|
+
|
|
2013
|
+
Notes
|
|
2014
|
+
-----
|
|
2015
|
+
|
|
2016
|
+
This command creates element edge models from an element model which represent the vector components on the element edge. An element model, ``emodel``, would then have
|
|
2017
|
+
|
|
2018
|
+
- ``emodel_x``
|
|
2019
|
+
- ``emodel_y``
|
|
2020
|
+
- ``emodel_z`` (3D only)
|
|
2021
|
+
|
|
2022
|
+
The primary use of these components are for visualization.
|
|
2023
|
+
'''
|
|
2024
|
+
pass
|
|
2025
|
+
|
|
2026
|
+
def vector_gradient (**kwargs):
|
|
2027
|
+
'''
|
|
2028
|
+
devsim.vector_gradient (device, region, node_model, calc_type)
|
|
2029
|
+
|
|
2030
|
+
Creates the vector gradient for noise analysis
|
|
2031
|
+
|
|
2032
|
+
Parameters
|
|
2033
|
+
----------
|
|
2034
|
+
device : str
|
|
2035
|
+
The selected device
|
|
2036
|
+
region : str
|
|
2037
|
+
The selected region
|
|
2038
|
+
node_model : str
|
|
2039
|
+
The node model from which we are creating the edge model
|
|
2040
|
+
calc_type : {'default', 'avoidzero'}
|
|
2041
|
+
The node model from which we are creating the edge model
|
|
2042
|
+
|
|
2043
|
+
Notes
|
|
2044
|
+
-----
|
|
2045
|
+
|
|
2046
|
+
Used for noise analysis. The ``avoidzero`` option is important for noise analysis, since a node model value of zero is not physical for some contact and interface boundary conditions. For a given node model, ``model``, a node model is created in each direction:
|
|
2047
|
+
|
|
2048
|
+
- ``model_gradx`` (1D)
|
|
2049
|
+
- ``model_grady`` (2D and 3D)
|
|
2050
|
+
- ``model_gradz`` (3D)
|
|
2051
|
+
|
|
2052
|
+
It is important not to use these models for simulation, since DEVSIM, does not have a way of evaluating the derivatives of these models. The models can be used for integrating the impedance field, and other postprocessing. The :meth:`devsim.element_from_edge_model` command can be used to create gradients for use in a simulation.
|
|
2053
|
+
'''
|
|
2054
|
+
pass
|
|
2055
|
+
|
|
2056
|
+
def get_contact_charge (**kwargs):
|
|
2057
|
+
'''
|
|
2058
|
+
devsim.get_contact_charge (device, contact, equation)
|
|
2059
|
+
|
|
2060
|
+
Get charge at the contact
|
|
2061
|
+
|
|
2062
|
+
Parameters
|
|
2063
|
+
----------
|
|
2064
|
+
device : str
|
|
2065
|
+
The selected device
|
|
2066
|
+
contact : str
|
|
2067
|
+
Contact on which to apply this command
|
|
2068
|
+
equation : str
|
|
2069
|
+
Name of the contact equation from which we are retrieving the charge
|
|
2070
|
+
'''
|
|
2071
|
+
pass
|
|
2072
|
+
|
|
2073
|
+
def get_contact_current (**kwargs):
|
|
2074
|
+
'''
|
|
2075
|
+
devsim.get_contact_current (device, contact, equation)
|
|
2076
|
+
|
|
2077
|
+
Get current at the contact
|
|
2078
|
+
|
|
2079
|
+
Parameters
|
|
2080
|
+
----------
|
|
2081
|
+
device : str
|
|
2082
|
+
The selected device
|
|
2083
|
+
contact : str
|
|
2084
|
+
Contact on which to apply this command
|
|
2085
|
+
equation : str
|
|
2086
|
+
Name of the contact equation from which we are retrieving the current
|
|
2087
|
+
'''
|
|
2088
|
+
pass
|
|
2089
|
+
|
|
2090
|
+
def get_matrix_and_rhs (**kwargs):
|
|
2091
|
+
'''
|
|
2092
|
+
devsim.get_matrix_and_rhs (format)
|
|
2093
|
+
|
|
2094
|
+
Returns matrices and rhs vectors.
|
|
2095
|
+
|
|
2096
|
+
Parameters
|
|
2097
|
+
----------
|
|
2098
|
+
format : {'csc', 'csr'} required
|
|
2099
|
+
Option for returned matrix format.
|
|
2100
|
+
'''
|
|
2101
|
+
pass
|
|
2102
|
+
|
|
2103
|
+
def set_initial_condition (**kwargs):
|
|
2104
|
+
'''
|
|
2105
|
+
devsim.set_initial_condition (static_rhs, dynamic_rhs)
|
|
2106
|
+
|
|
2107
|
+
Sets the initial condition for subsequent transient solver steps.
|
|
2108
|
+
|
|
2109
|
+
Parameters
|
|
2110
|
+
----------
|
|
2111
|
+
static_rhs : list, optional
|
|
2112
|
+
List of double values for non time-displacement terms in right hand side.
|
|
2113
|
+
dynamic_rhs : list, optional
|
|
2114
|
+
List of double values for time-displacement terms in right hand side.
|
|
2115
|
+
'''
|
|
2116
|
+
pass
|
|
2117
|
+
|
|
2118
|
+
def solve (**kwargs):
|
|
2119
|
+
'''
|
|
2120
|
+
devsim.solve (type, solver_type, absolute_error, relative_error, maximum_error, charge_error, gamma, tdelta, maximum_iterations, maximum_divergence, frequency, output_node, info, symbolic_iteration_limit)
|
|
2121
|
+
|
|
2122
|
+
Call the solver. A small-signal AC source is set with the circuit voltage source.
|
|
2123
|
+
|
|
2124
|
+
Parameters
|
|
2125
|
+
----------
|
|
2126
|
+
type : {'dc', 'ac', 'noise', 'transient_dc', 'transient_bdf1', 'transient_bdf2', 'transient_tr'} required
|
|
2127
|
+
type of solve being performed
|
|
2128
|
+
solver_type : {'direct', 'iterative'} required
|
|
2129
|
+
Linear solver type
|
|
2130
|
+
absolute_error : Float, optional
|
|
2131
|
+
Required update norm in the solve (default 0.0)
|
|
2132
|
+
relative_error : Float, optional
|
|
2133
|
+
Required relative update in the solve (default 0.0)
|
|
2134
|
+
maximum_error : Float, optional
|
|
2135
|
+
Maximum absolute error before solve stops (default MAXDOUBLE)
|
|
2136
|
+
charge_error : Float, optional
|
|
2137
|
+
Relative error between projected and solved charge during transient simulation (default 0.0)
|
|
2138
|
+
gamma : Float, optional
|
|
2139
|
+
Scaling factor for transient time step (default 1.0)
|
|
2140
|
+
tdelta : Float, optional
|
|
2141
|
+
time step (default 0.0)
|
|
2142
|
+
maximum_iterations : int, optional
|
|
2143
|
+
Maximum number of iterations in the DC solve (default 20)
|
|
2144
|
+
maximum_divergence : int, optional
|
|
2145
|
+
Maximum number of diverging iterations during solve (default 20)
|
|
2146
|
+
frequency : Float, optional
|
|
2147
|
+
Frequency for small-signal AC simulation (default 0.0)
|
|
2148
|
+
output_node : str, optional
|
|
2149
|
+
Output circuit node for noise simulation
|
|
2150
|
+
info : bool, optional
|
|
2151
|
+
Solve command return convergence information (default False)
|
|
2152
|
+
symbolic_iteration_limit : int, optional
|
|
2153
|
+
Reuse symbolic matrix factorization after this number of iterations (default 1)
|
|
2154
|
+
'''
|
|
2155
|
+
pass
|