EM FHEquiv: Difference between revisions
(Initial creation - work in progress) |
(Initial creation - work in progress) |
||
Line 18: | Line 18: | ||
==How to use== |
==How to use== |
||
The |
The FHEquiv object is based on the two existing FHNodes that it will short-circuit. |
||
# Press the {{Button|[[Image:EM_FHSegment.svg|16px]] [[EM_FHSegment|EM FHSegment]]}} button, or press {{KEY|E}} then {{KEY|S}} keys. |
|||
# Click a first point on the 3D view, or type a [[Draft_Coordinates|coordinate]] and press the {{Button|[[Image:Draft_AddPoint.svg|16px]] [[Draft_AddPoint|add point]]}} button. |
|||
# Click a second point on the 3D view, or type a [[Draft_Coordinates|coordinate]] and press the {{Button|[[Image:Draft_AddPoint.svg|16px]] [[Draft_AddPoint|add point]]}} button. |
|||
Alternatively, you can also: |
|||
# Select two [[EM_FHNode|FHNode]] objects |
# Select two [[EM_FHNode|FHNode]] objects |
||
# Press the {{Button|[[Image: |
# Press the {{Button|[[Image:EM_FHEquiv.svg|16px]] [[EM_FHEquiv|EM FHEquiv]]}} button, or press {{KEY|E}} then {{KEY|E}} keys. |
||
Or: |
|||
# Select one or multiple [[Draft_Line|Draft Line]] object(s) |
|||
# Press the {{Button|[[Image:EM_FHSegment.svg|16px]] [[EM_FHSegment|EM FHSegment]]}} button, or press {{KEY|E}} then {{KEY|S}} keys. As many FHSegment objects will be created as the Draft Line objects. |
|||
===Remarks:=== |
===Remarks:=== |
||
* If you need to short-circuit multiple nodes, just create multiple FHEquiv nodes. You don't need a full mesh of FHEquiv nodes, as of course if node1 is shorted with node2, and node2 is shorted with node3, also node1 will result shorted with node3. |
|||
* If you create a FHSegment object based on a Draft Line object, you can NOT freely move the FHSegment or the end point FHNodes. The FHSegment will always be constrained to the base object. To change the position of the FHSegment, or of its end point, apply the change to the underlying Draft Line object (the base object is hidden by default, you can show it again by selecting the object in the tree and pressing {{KEY|Space}}. |
|||
* If the FHSegment object has no base object {{incode|baseobj}}, its position is controlled by the starting and ending FHNodes. You cannot change a FHSegment position by changing its Placement. |
|||
==Options== |
|||
* To enter coordinates manually, simply enter the numbers, then press {{KEY|Enter}} between each X, Y and Z component. You can press the {{Button|[[Image:Draft_AddPoint.svg|16px]] [[Draft_AddPoint|add point]]}} button when you have the desired values to insert the point. |
|||
* Press {{KEY|Esc}} or the {{Button|Close}} button to abort the current command. |
|||
==Properties== |
==Properties== |
||
* {{PropertyData| |
* {{PropertyData|Node1}}: the first [[EM_FHNode|FHNode]] to short-circuit |
||
* {{PropertyData| |
* {{PropertyData|Node2}}: the second[[EM_FHNode|FHNode]] to short-circuit |
||
* {{PropertyData|NodeEnd}}: the ending [[EM_FHNode|FHNode]] |
|||
* {{PropertyData|Width}}: the FHSegment width ('w' segment parameter in FastHenry) |
|||
* {{PropertyData|Height}}: the FHSegment height ('h' segment parameter in FastHenry) |
|||
* {{PropertyData|Sigma}}: the FHSegment conductivity ('sigma' segment parameter in FastHenry) |
|||
* {{PropertyData|ww}}: the FHSegment cross-section direction along the width ('wx', 'wy', 'wz' segment parameter in FastHenry) |
|||
* {{PropertyData|nhinc}}: the Number of filaments in the height direction ('nhinc' segment parameter in FastHenry) |
|||
* {{PropertyData|nwinc}}: the Number of filaments in the width direction ('nwinc' segment parameter in FastHenry) |
|||
* {{PropertyData|rh}}: the ratio of adjacent filaments in the height direction ('rh' segment parameter in FastHenry) |
|||
* {{PropertyData|rw}}: the ratio of adjacent filaments in the width direction ('rw' segment parameter in FastHenry) |
|||
==Scripting== |
==Scripting== |
||
Line 63: | Line 36: | ||
{{Emphasis|See also:}} [[FreeCAD Scripting Basics]]. |
{{Emphasis|See also:}} [[FreeCAD Scripting Basics]]. |
||
The |
The FHEquivobject can be used in [[macros]] and from the [[Python]] console by using the following function: |
||
{{Code|code= |
{{Code|code= |
||
equiv = makeFHEquiv(node1=None,node2=None,name='FHEquiv') |
|||
}} |
}} |
||
Revision as of 17:51, 9 January 2019
EM FHEquiv |
Menu location |
---|
EM → FHEquiv |
Workbenches |
EM |
Default shortcut |
E E |
Introduced in version |
0.17 (Add-on) |
See also |
EM FHNode, EM FHSegment, EM FHPath, EM FHPlane, EM FHPort, |
Description
The FHEquiv tool short-circuits two FHNode objects.
FastHenry FHEquiv
How to use
The FHEquiv object is based on the two existing FHNodes that it will short-circuit.
- Select two FHNode objects
- Press the EM FHEquiv button, or press E then E keys.
Remarks:
- If you need to short-circuit multiple nodes, just create multiple FHEquiv nodes. You don't need a full mesh of FHEquiv nodes, as of course if node1 is shorted with node2, and node2 is shorted with node3, also node1 will result shorted with node3.
Properties
Scripting
See also: FreeCAD Scripting Basics.
The FHEquivobject can be used in macros and from the Python console by using the following function:
equiv = makeFHEquiv(node1=None,node2=None,name='FHEquiv')
- Creates a
FHSegment
object. baseobj
is the Draft Line object that can be used as base for the FHSegment. IfnodeStart
andnodeEnd
are specified, they have priority over thebaseobj
, andbaseobj
is ignored.nodeStart
is the segment starting node FHNode object.nodeEnd
is the segment ending node FHNode object.width
is the segment width. Defaults toEMFHSEGMENT_DEF_SEGWIDTH
.height
is the segment height. Defaults toEMFHSEGMENT_DEF_SEGHEIGHT
.name
is the name of the object
Example:
import FreeCAD, EM
fhnode1 = EM.makeFHNode(X=1.0,Y=0,Z=0)
fhnode2 = EM.makeFHNode(X=0,Y=1.0,Z=0)
fhsegment = EM.makeFHSegment(nodeStart=fhnode1, nodeEnd=fhnode2)