Repository navigation
Expand file tree
/
Copy pathDevsimDoc.cc
More file actions
1943 lines (1537 loc) · 56.8 KB
/
Copy pathDevsimDoc.cc
File metadata and controls
1943 lines (1537 loc) · 56.8 KB
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
static const char add_circuit_node_doc[] =
R"( devsim.add_circuit_node (name, value, variable_update)
Adds a circuit node for use in circuit or multi-device simulation
Parameters
----------
name : str
Name of the circuit node being created
value : Float, optional
initial value (default 0.0)
variable_update : {'default', 'log_damp', 'positive'}
update type for circuit variable
)";
static const char circuit_alter_doc[] =
R"( devsim.circuit_alter (name, param, value)
Alter the value of a circuit element parameter
Parameters
----------
name : str
Name of the circuit node being created
param : str, optional
parameter being modified (default 'value')
value : Float
value for the parameter
)";
static const char circuit_element_doc[] =
R"( devsim.circuit_element (name, value, n1, n2, acreal, acimag)
Adds a circuit element external to the devices
Parameters
----------
name : str
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.
value : Float, optional
value for the default parameter of the circuit element (default 0.0)
n1 : str
circuit node
n2 : str
circuit node
acreal : Float, optional
real part of AC source for voltage (default 0.0)
acimag : Float, optional
imag part of AC source for voltage (default 0.0)
)";
static const char circuit_node_alias_doc[] =
R"( devsim.circuit_node_alias (node, alias)
Create an alias for a circuit node
Parameters
----------
node : str
circuit node being aliased
alias : str
alias for the circuit node
)";
static const char delete_circuit_doc[] =
R"( devsim.delete_circuit ()
Deletes any present circuit and its solutions.
)";
static const char get_circuit_equation_number_doc[] =
R"( devsim.get_circuit_equation_number (node)
Returns the row number correspond to circuit node in a region. Values are only valid when during the course of a solve.
Parameters
----------
node : str
circuit node
)";
static const char get_circuit_node_list_doc[] =
R"( devsim.get_circuit_node_list ()
Gets the list of the nodes in the circuit.
)";
static const char get_circuit_node_value_doc[] =
R"( devsim.get_circuit_node_value (solution, node)
Gets the value of a circuit node for a given solution type.
Parameters
----------
solution : str, optional
name of the solution. 'dcop' is the name for the DC solution (default 'dcop')
node : str
circuit node of interest
)";
static const char get_circuit_solution_list_doc[] =
R"( devsim.get_circuit_solution_list ()
Gets the list of available circuit solutions.
)";
static const char set_circuit_node_value_doc[] =
R"( devsim.set_circuit_node_value (solution, node, value)
Sets the value of a circuit node for a given solution type.
Parameters
----------
solution : str, optional
name of the solution. 'dcop' is the name for the DC solution (default 'dcop')
node : str
circuit node of interest
value : Float, optional
new value (default 0.0)
)";
static const char contact_equation_doc[] =
R"( 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)
Create a contact equation on a device
Parameters
----------
device : str
The selected device
contact : str
Contact on which to apply this command
name : str
Name of the contact equation being created
circuit_node : str, optional
Name of the circuit we integrate the flux into
edge_charge_model : str, optional
Name of the edge model used to determine the charge at this contact
edge_current_model : str, optional
Name of the edge model used to determine the current flowing out of this contact
edge_model : str, optional
Name of the edge model being integrated at each edge at this contact
edge_volume_model : str, optional
Name of the edge model being integrated over the volume of each edge on the contact
element_charge_model : str, optional
Name of the element edge model used to determine the charge at this contact
element_current_model : str, optional
Name of the element edge model used to determine the current flowing out of this contact
element_model : str, optional
Name of the element edge model being integrated at each edge at this contact
volume_node0_model : str, optional
Name of the element model being integrated over the volume of node 0 of each edge on the contact
volume_node1_model : str, optional
Name of the element model being integrated over the volume of node 1 of each edge on the contact
node_charge_model : str, optional
Name of the node model used to determine the charge at this contact
node_current_model : str, optional
Name of the node model used to determine the current flowing out of this contact
node_model : str, optional
Name of the node model being integrated at each node at this contact
)";
static const char custom_equation_doc[] =
R"( devsim.custom_equation (name, procedure)
Custom equation assembly. See :ref:`models__customequation` for a description of how the function should be structured.
Parameters
----------
name : str
Name of the custom equation being created
procedure : str
The procedure to be called
)";
static const char delete_contact_equation_doc[] =
R"( devsim.delete_contact_equation (device, contact, name)
This command deletes an equation from a contact.
Parameters
----------
device : str
The selected device
contact : str
Contact on which to apply this command
name : str
Name of the contact equation being deleted
)";
static const char delete_equation_doc[] =
R"( devsim.delete_equation (device, region, name)
This command deletes an equation from a region.
Parameters
----------
device : str
The selected device
region : str
The selected region
name : str
Name of the equation being deleted
)";
static const char delete_interface_equation_doc[] =
R"( devsim.delete_interface_equation (device, interface, name)
This command deletes an equation from an interface.
Parameters
----------
device : str
The selected device
interface : str
Interface on which to apply this command
name : str
Name of the interface equation being deleted
)";
static const char equation_doc[] =
R"( 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)
Specify an equation to solve on a device
Parameters
----------
device : str
The selected device
region : str
The selected region
name : str
Name of the equation being created
variable_name : str
Name of the node solution being solved
node_model : str, optional
Name of the node model being integrated at each node in the device volume
edge_model : str, optional
Name of the edge model being integrated over each edge in the device volume
edge_volume_model : str, optional
Name of the edge model being integrated over the volume of each edge in the device volume
time_node_model : str, optional
Name of the time dependent node_model being integrated at each node in the device volume
element_model : str, optional
Name of the element model being integrated over each edge in the device volume
volume_node0_model : str, optional
Name of the element model being integrated over the volume of node 0 of each edge on the contact
volume_node1_model : str, optional
Name of the element model being integrated over the volume of node 1 of each edge on the contact
variable_update : {'default', 'log_damp', 'positive'}
update type for circuit variable
Notes
-----
The integration variables can be changed in 2D for cylindrical coordinate systems by setting the appropriate parameters as described in :ref:`sec__cylindrical`.
In order to set the node volumes for integration of the ``edge_volume_model``, it is possible to do something like this:
..
devsim.edge_model(device="device", region="region", name="EdgeNodeVolume", equation="0.5*SurfaceArea*EdgeLength")
devsim.set_parameter(name="edge_node0_volume_model", value="EdgeNodeVolume")
devsim.set_parameter(name="edge_node1_volume_model", value="EdgeNodeVolume")
)";
static const char get_contact_equation_command_doc[] =
R"( devsim.get_contact_equation_command (device, contact, name)
This command gets the options used when creating this contact equation.
Parameters
----------
device : str
The selected device
contact : str
Contact on which to apply this command
name : str
Name of the contact equation being command options returned
)";
static const char get_contact_equation_list_doc[] =
R"( devsim.get_contact_equation_list (device, contact)
This command gets a list of equations on the specified contact.
Parameters
----------
device : str
The selected device
contact : str
Contact on which to apply this command
)";
static const char get_equation_command_doc[] =
R"( devsim.get_equation_command (device, region, name)
This command gets the options used when creating this equation.
Parameters
----------
device : str
The selected device
region : str
The selected region
name : str
Name of the equation being command options returned
)";
static const char get_equation_list_doc[] =
R"( devsim.get_equation_list (device, region)
This command gets a list of equations on the specified region.
Parameters
----------
device : str
The selected device
region : str
The selected region
)";
static const char get_equation_numbers_doc[] =
R"( devsim.get_equation_numbers (device, region, equation, variable)
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.
Parameters
----------
device : str
The selected device
region : str
The selected region
equation : str, optional
Name of the equation
variable : str, optional
Name of the variable
)";
static const char get_interface_equation_command_doc[] =
R"( devsim.get_interface_equation_command (device, interface, name)
This command gets the options used when creating this interface equation.
Parameters
----------
device : str
The selected device
interface : str
Interface on which to apply this command
name : str
Name of the interface equation being command options returned
)";
static const char get_interface_equation_list_doc[] =
R"( devsim.get_interface_equation_list (device, interface)
This command gets a list of equations on the specified interface.
Parameters
----------
device : str
The selected device
interface : str
Interface on which to apply this command
)";
static const char interface_equation_doc[] =
R"( devsim.interface_equation (device, interface, name, name0, name1, interface_model, type)
Command to specify an equation at an interface
Parameters
----------
device : str
The selected device
interface : str
Interface on which to apply this command
name : str
Name of the interface equation being created
name0 : str, optional
Name of the equation coupling in region 0 being created (default 'name')
name1 : str, optional
Name of the equation coupling in region 1 being created (default 'name')
interface_model : str
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
type : {'continuous', 'fluxterm', 'hybrid'} required
Specifies the type of boundary condition
)";
static const char get_contact_list_doc[] =
R"( devsim.get_contact_list (device)
Gets a list of contacts on a device.
Parameters
----------
device : str
The selected device
)";
static const char get_device_list_doc[] =
R"( devsim.get_device_list ()
Gets a list of devices on the simulation.
)";
static const char get_element_node_list_doc[] =
R"( devsim.get_element_node_list (device, region, contact, interface, reorder)
Gets a list of nodes for each element on a device, region, contact, or interface.
Parameters
----------
device : str
The selected device
region : str
The selected region
contact : str, optional
If specified, gets the element nodes for the contact on the specified region
interface : str, optional
If specified, gets the element nodes for the interface on the specified region
reorder : bool, optional
If specified, reorders the element nodes in a manner compatible in meshing software (default False)
)";
static const char get_interface_list_doc[] =
R"( devsim.get_interface_list (device)
Gets a list of interfaces on a device.
Parameters
----------
device : str
The selected device
)";
static const char get_region_list_doc[] =
R"( devsim.get_region_list (device, contact, interface)
Gets a list of regions on a device, contact, or interface.
Parameters
----------
device : str
The selected device
contact : str, optional
If specified, gets the name of the region belonging to this contact on the device
interface : str, optional
If specified, gets the name of the regions belonging to this interface on the device
)";
static const char reset_devsim_doc[] =
R"( devsim.reset_devsim ()
Resets all data for clean restart.
)";
static const char get_dimension_doc[] =
R"( devsim.get_dimension (device)
Get the dimension of the device
Parameters
----------
device : str, optional
The selected device
)";
static const char get_material_doc[] =
R"( devsim.get_material (device, region, contact)
Returns the material for the specified region
Parameters
----------
device : str, optional
The selected device
region : str, optional
The selected region
contact : str, optional
Contact on which to apply this command
)";
static const char get_parameter_doc[] =
R"( devsim.get_parameter (device, region, name)
Get a parameter on a region, device, or globally.
Parameters
----------
device : str, optional
The selected device
region : str, optional
The selected region
name : str
Name of the parameter name being retrieved
Notes
-----
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.
)";
static const char get_parameter_list_doc[] =
R"( devsim.get_parameter_list (device, region)
Get list of parameter names on region, device, or globally
Parameters
----------
device : str, optional
The selected device
region : str, optional
The selected region
Notes
-----
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.
)";
static const char set_material_doc[] =
R"( devsim.set_material (device, region, contact, material)
Sets the new material for a region
Parameters
----------
device : str, optional
The selected device
region : str, optional
The selected region
contact : str, optional
Contact on which to apply this command
material : str
New material name
)";
static const char set_parameter_doc[] =
R"( devsim.set_parameter (device, region, name, value)
Set a parameter on region, device, or globally
Parameters
----------
device : str, optional
The selected device
region : str, optional
The selected region
name : str
Name of the parameter name being retrieved
value : any
value to set for the parameter
Notes
-----
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.
)";
static const char add_1d_contact_doc[] =
R"( devsim.add_1d_contact (material, mesh, name, tag)
Add a contact to a 1D mesh
Parameters
----------
material : str
material for the contact being created
mesh : str
Mesh to add the contact to
name : str
Name for the contact being created
tag : str
Text label for the position to add the contact
)";
static const char add_1d_interface_doc[] =
R"( devsim.add_1d_interface (mesh, tag, name)
Add an interface to a 1D mesh
Parameters
----------
mesh : str
Mesh to add the interface to
tag : str
Text label for the position to add the interface
name : str
Name for the interface being created
)";
static const char add_1d_mesh_line_doc[] =
R"( devsim.add_1d_mesh_line (mesh, tag, pos, ns, ps)
Add a mesh line to a 1D mesh
Parameters
----------
mesh : str
Mesh to add the line to
tag : str, optional
Text label for the position
pos : str
Position for the mesh point
ns : Float, optional
Spacing from this point in the negative direction (default ps value)
ps : Float
Spacing from this point in the positive direction
)";
static const char add_1d_region_doc[] =
R"( devsim.add_1d_region (mesh, tag1, tag2, region, material)
Add a region to a 1D mesh
Parameters
----------
mesh : str
Mesh to add the line to
tag1 : str
Text label for the position bounding the region being added
tag2 : str
Text label for the position bounding the region being added
region : str
Name for the region being created
material : str
Material for the region being created
)";
static const char add_2d_contact_doc[] =
R"( devsim.add_2d_contact (name, material, mesh, region, xl, xh, yl, yh, bloat)
Add an interface to a 2D mesh
Parameters
----------
name : str
Name for the contact being created
material : str
material for the contact being created
mesh : str
Mesh to add the contact to
region : str
Name of the region included in the contact
xl : Float, optional
x position for corner of bounding box (default -MAXDOUBLE)
xh : Float, optional
x position for corner of bounding box (default +MAXDOUBLE)
yl : Float, optional
y position for corner of bounding box (default -MAXDOUBLE)
yh : Float, optional
y position for corner of bounding box (default +MAXDOUBLE)
bloat : Float, optional
Extend bounding box by this amount when search for mesh to include in region (default 1e-10)
)";
static const char add_2d_interface_doc[] =
R"( devsim.add_2d_interface (mesh, name, region0, region1, xl, xh, yl, yh, bloat)
Add an interface to a 2D mesh
Parameters
----------
mesh : str
Mesh to add the interface to
name : str
Name for the interface being created
region0 : str
Name of the region included in the interface
region1 : str
Name of the region included in the interface
xl : Float, optional
x position for corner of bounding box (default -MAXDOUBLE)
xh : Float, optional
x position for corner of bounding box (default +MAXDOUBLE)
yl : Float, optional
y position for corner of bounding box (default -MAXDOUBLE)
yh : Float, optional
y position for corner of bounding box (default +MAXDOUBLE)
bloat : Float, optional
Extend bounding box by this amount when search for mesh to include in region (default 1e-10)
)";
static const char add_2d_mesh_line_doc[] =
R"( devsim.add_2d_mesh_line (mesh, pos, ns, ps)
Add a mesh line to a 2D mesh
Parameters
----------
mesh : str
Mesh to add the line to
pos : str
Position for the mesh point
ns : Float
Spacing from this point in the negative direction
ps : Float
Spacing from this point in the positive direction
)";
static const char add_2d_region_doc[] =
R"( devsim.add_2d_region (mesh, region, material, xl, xh, yl, yh, bloat)
Add a region to a 2D mesh
Parameters
----------
mesh : str
Mesh to add the region to
region : str
Name for the region being created
material : str
Material for the region being created
xl : Float, optional
x position for corner of bounding box (default -MAXDOUBLE)
xh : Float, optional
x position for corner of bounding box (default +MAXDOUBLE)
yl : Float, optional
y position for corner of bounding box (default -MAXDOUBLE)
yh : Float, optional
y position for corner of bounding box (default +MAXDOUBLE)
bloat : Float, optional
Extend bounding box by this amount when search for mesh to include in region (default 1e-10)
)";
static const char add_gmsh_contact_doc[] =
R"( devsim.add_gmsh_contact (gmsh_name, material, mesh, name, region)
Create a mesh to import a Gmsh mesh
Parameters
----------
gmsh_name : str
physical group name in the Gmsh file
material : str
material for the contact being created
mesh : str
name of the mesh being generated
name : str
name of the contact begin created
region : str
region that the contact is attached to
)";
static const char add_gmsh_interface_doc[] =
R"( devsim.add_gmsh_interface (gmsh_name, mesh, name, region0, region1)
Create an interface for an imported Gmsh mesh
Parameters
----------
gmsh_name : str
physical group name in the Gmsh file
mesh : str
name of the mesh being generated
name : str
name of the interface begin created
region0 : str
first region that the interface is attached to
region1 : str
second region that the interface is attached to
)";
static const char add_gmsh_region_doc[] =
R"( devsim.add_gmsh_region (gmsh_name, mesh, region, material)
Create a region for an imported Gmsh mesh
Parameters
----------
gmsh_name : str
physical group name in the Gmsh file
mesh : str
name of the mesh being generated
region : str
name of the region begin created
material : str
material for the region being created
)";
static const char create_1d_mesh_doc[] =
R"( devsim.create_1d_mesh (mesh)
Create a mesh to create a 1D device
Parameters
----------
mesh : str
name of the 1D mesh being created
)";
static const char create_2d_mesh_doc[] =
R"( devsim.create_2d_mesh (mesh)
Create a mesh to create a 2D device
Parameters
----------
mesh : str
name of the 2D mesh being created
)";
static const char create_contact_from_interface_doc[] =
R"( devsim.create_contact_from_interface (device, region, interface, material, name)
Creates a contact on a device from an existing interface
Parameters
----------
device : str
The selected device
region : str
The selected region
interface : str
Interface on which to apply this command
material : str
material for the contact being created
name : str
name of the contact begin created
)";
static const char create_device_doc[] =
R"( devsim.create_device (mesh, device)
Create a device from a mesh
Parameters
----------
mesh : str
name of the mesh being used to create a device
device : str
name of the device being created
)";
static const char create_gmsh_mesh_doc[] =
R"( devsim.create_gmsh_mesh (mesh, file, coordinates, elements, physical_names)
Create a mesh to import a Gmsh mesh
Parameters
----------
mesh : str
name of the mesh being generated
file : str, optional
name of the Gmsh mesh file being read into DEVSIM
coordinates : list, optional
List of coordinate positions on mesh.
elements : list, optional
List of elements on the mesh.
physical_names : list, optional
List of names for each contact, interface, and region on mesh.
Notes
-----
This file will import a Gmsh format mesh from a file. Alternatively, the mesh structure may be passed in as as arguments:
``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.
``physical_names`` is a list of contact, interface, and region names. It is referenced by index by the ``elements`` list.
``elements`` is a list of elements. Each element adds
* Element Type (float)
- 0 node
- 1 edge
- 2 triangle
- 3 tetrahedron
* Physical Index
- This indexes into the ``physical_names`` list.
* Nodes
- Each node of the element indexes into the coordinates list.
)";
static const char create_interface_from_nodes_doc[] =
R"( devsim.create_interface_from_nodes (device, name, region0, region1, nodes0, nodes1)
Creates an interface from lists of nodes
Parameters
----------
device : str
The selected device
name : str
name of the interface begin created
region0 : str
first region that the interface is attached to
region1 : str
second region that the interface is attached to
nodes0 : str
list of nodes for the interface in the first region
nodes1 : str
list of nodes for the interface in the second region
)";
static const char delete_device_doc[] =
R"( devsim.delete_device (device)
Delete a device and its parameters
Parameters
----------
device : str
name of the device being deleted
)";
static const char delete_mesh_doc[] =
R"( devsim.delete_mesh (mesh)
Delete a mesh so devices can no longer be instantiated from it.
Parameters
----------
mesh : str
Mesh to delete
)";
static const char finalize_mesh_doc[] =
R"( devsim.finalize_mesh (mesh)
Finalize a mesh so no additional mesh specifications can be added and devices can be created.
Parameters
----------
mesh : str
Mesh to finalize
)";
static const char get_mesh_list_doc[] =
R"( devsim.get_mesh_list ()
Get list of meshes
)";
static const char load_devices_doc[] =
R"( devsim.load_devices (file)
Load devices from a DEVSIM file
Parameters
----------
file : str
name of the file to load the meshes from
)";
static const char write_devices_doc[] =
R"( devsim.write_devices (file, device, type, include_test)
Write a device to a file for visualization or restart
Parameters
----------
file : str
name of the file to write the meshes to
device : str, optional
name of the device to write
type : {'devsim', 'devsim_data', 'tecplot', 'vtk'}
format to use
include_test : str
Callback function which tests whether a model should be written to the tecplot or vtk format
)";
static const char contact_edge_model_doc[] =
R"( devsim.contact_edge_model (device, contact, name, equation, display_type)
Create an edge model evaluated at a contact
Parameters
----------
device : str
The selected device
contact : str
Contact on which to apply this command
name : str
Name of the contact edge model being created
equation : str
Equation used to describe the contact edge model being created
display_type : {'vector', 'nodisplay', 'scalar'}
Option for output display in graphical viewer
)";
static const char contact_node_model_doc[] =
R"( devsim.contact_node_model (device, contact, name, equation, display_type)
Create an node model evaluated at a contact
Parameters
----------
device : str
The selected device