EM Workbench: Difference between revisions

Latest revision as of 19:30, 20 November 2021

Other languages:

Introduction

The EM (ElectroMagnetic) Workbench provides the CAD front-end interface to some open source free solvers. At present it supports the 3D magnetoquasistatic impedance solver FastHenry (i.e. inductance and resistance extraction at "low" frequencies). Support for the 3D electrostatic capacitance solver FasterCap is ongoing.

Installation

The EM Workbench is an external workbench, that can be installed from the FreeCAD Addon Manager. This can be done via the Tools → Addon Manager menu.

The electromagnetic solvers FastHenry2 and FasterCap must be installed separately. Their binary codes as well as the sources are freely available from FastFieldSolvers.

Usage

FastHenry

FastHenry is a software for computing the frequency-dependant self and mutual inductances and resistances of a generic tridimensional conductive structure, in the magnetoquasistatic approximation. It can also generate Spice-compatible, multiple-frequency equivalent-circuit models.

Knowledge of FastHenry is a pre-condition for the proficient usage of the ElectroMagnetic Workbench for FastHenry. We suggest you to read the original FastHenry User's manual and play a bit with the sample files that are provided with the installation.

FasterCap

FasterCap is a powerful three- and two-dimensional capacitance extraction program.

Knowledge of FasterCap is a pre-condition for the proficient usage of the ElectroMagnetic Workbench for FasterCap. We suggest you to read the original FasterCap help file and play a bit with the sample files that are provided with the installation.

FastHenry Tools

These are tools used to interface with FastHenry:

FHNode: Creates a FastHenry Node object
FHSegment: Creates a FastHenry Segment object
FHPath: Creates a FastHenry Path object
FHPlane: Creates a FastHenry uniform conductive Plane object
FHPlaneHole: Creates a FastHenry uniform conductive plane Hole object
FHPlaneAddRemoveNodeHole: Add or Remove a Node or a Hole from/to a conductive plane
FHEquiv: Creates a FastHenry node Equivalence object
FHPort: Creates a FastHenry Port object
FHSolver: Creates a FastHenry Solver object
FHInputFIle: Creates a FastHenry Input File

FasterCap Tools

At present, FasterCap is supported via some Macros in the Export_mesh.py file available in the ElectroMagnetic Workbench GitHub source code.

API

The EM tools can be used in macros and from the Python console by using the EM API.

Tutorials

Some video tutorials are available for the EM Workbench beta versions:

Electromagnetics

FastHenry tools: FHNode, FHSegment, FHPath, FHPlane, FHPlaneHole, FHPlaneAddRemoveNodeHole, FHEquiv, FHPort, FHSolver, FHInputFile
FasterCap tools: see GitHub source code

User documentation

Getting started
Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate

Help: Tutorials, Video tutorials
Workbenches: Std Base, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test Framework, Web

Addons: Addon Manager, External workbenches, Scripting and macros

Hubs: User hub, Power users hub, Developer hub

@@ Line 1: / Line 1: @@
+<languages/>
-[[Image:EMWorkbench.svg|64px]]
+<translate>
+<!--T:35-->
-== Introduction ==
+[[File:EMWorkbench.svg|thumb|128px|EM Workbench icon]]
+</translate>
-The ElectroMagnetic (EM) Workbench provides the CAD front-end interface to some open source free solvers. At present it supports the 3D magnetoquasistatic impedance solver [https://www.fastfieldsolvers.com/software.htm#fasthenry2 FastHenry] (i.e. inductance and resistance extraction at "low" frequencies). Support for the 3D electrostatic capacitance solver [https://www.fastfieldsolvers.com/software.htm#fastercap FasterCap] is ongoing.
+{{TOCright}}
+<translate>
+== Introduction == <!--T:1-->
-The EM Workbench is a [[External_workbenches|FreeCAD addon]], that can be installed on demand. It is not part of the standard FreeCAD install.
+<!--T:2-->
-{{TOCright}}
+The EM (ElectroMagnetic) Workbench provides the CAD front-end interface to some open source free solvers. At present it supports the 3D magnetoquasistatic impedance solver [https://www.fastfieldsolvers.com/software.htm#fasthenry2 FastHenry] (i.e. inductance and resistance extraction at "low" frequencies). Support for the 3D electrostatic capacitance solver [https://www.fastfieldsolvers.com/software.htm#fastercap FasterCap] is ongoing.
+<!--T:4-->
 [[Image:Screenshot_EM_window.png|600px]]
-== Installation ==
+== Installation == <!--T:5-->
+<!--T:3-->
-At present, the EM Workbench must be manually installed. See the instructions in the README at the [https://github.com/ediloren/EM-Workbench-for-FreeCAD EM Workbench GihHub page].
+The [[EM_Workbench|EM Workbench]] is an [[External_workbenches|external workbench]], that can be installed from the FreeCAD [[Image:AddonManager.svg|24px]] [[Std_AddonMgr|Addon Manager]]. This can be done via the {{MenuCommand|Tools → Addon Manager}} menu.
+<!--T:7-->
 The electromagnetic solvers FastHenry2 and FasterCap must be installed separately. Their binary codes as well as the sources are freely available from [https://www.fastfieldsolvers.com FastFieldSolvers].
-== Usage ==
+== Usage == <!--T:8-->
-=== FastHenry ===
+=== FastHenry === <!--T:9-->
+<!--T:10-->
 FastHenry is a software for computing the frequency-dependant self and mutual inductances and resistances of a generic tridimensional conductive structure, in the magnetoquasistatic approximation. It can also generate Spice-compatible, multiple-frequency equivalent-circuit models.
+<!--T:11-->
 Knowledge of FastHenry is a pre-condition for the proficient usage of the ElectroMagnetic Workbench for FastHenry. We suggest you to read the original [https://www.fastfieldsolvers.com/documentation.htm FastHenry User's manual] and play a bit with the sample files that are provided with the installation.
+=== FasterCap === <!--T:12-->
-== FastHenry Tools ==
+<!--T:13-->
+FasterCap is a powerful three- and two-dimensional capacitance extraction program.
+<!--T:14-->
+Knowledge of FasterCap is a pre-condition for the proficient usage of the ElectroMagnetic Workbench for FasterCap. We suggest you to read the original [https://www.fastfieldsolvers.com/documentation.htm FasterCap help file] and play a bit with the sample files that are provided with the installation.
+== FastHenry Tools == <!--T:15-->
+<!--T:16-->
 These are tools used to interface with FastHenry:
+<!--T:17-->
-* [[Image:node_icon.svg|32px]] [[EM_FHNode|FHNode]]: Creates a FastHenry Node object
-* [[Image:segment_icon.svg|32px]] [[EM_FHSegment|FHSegment]]: Creates a FastHenry Segment object
+* [[Image:EM_FHNode.svg|32px]] [[EM_FHNode|FHNode]]: Creates a FastHenry Node object
-* [[Image:path_icon.svg|32px]] [[EM_FHPath|FHPath]]: Creates a FastHenry Path object
+* [[Image:EM_FHSegment.svg|32px]] [[EM_FHSegment|FHSegment]]: Creates a FastHenry Segment object
-* [[Image:uniform_plane_icon.svg|32px]] [[EM_FHPlane|FHPlane]]: Creates a FastHenry uniform conductive Plane object
+* [[Image:EM_FHPath.svg|32px]] [[EM_FHPath|FHPath]]: Creates a FastHenry Path object
-* [[Image:planehole_icon.svg|32px]] [[EM_FHPlaneHole|FHPlaneHole]]: Creates a FastHenry uniform conductive plane Hole object
+* [[Image:EM_FHPlane.svg|32px]] [[EM_FHPlane|FHPlane]]: Creates a FastHenry uniform conductive Plane object
-* [[Image:plane_addremovenodehole_icon.svg|32px]] [[EM_FHAddRemoveNodeHole|FHAddRemoveNodeHole]]: Add or Remove a Node or a Hole from/to a conductive plane
+* [[Image:EM_FHPlaneHole.svg|32px]] [[EM_FHPlaneHole|FHPlaneHole]]: Creates a FastHenry uniform conductive plane Hole object
+* [[Image:EM_FHPlaneAddRemoveNodeHole.svg|32px]] [[EM_FHPlaneAddRemoveNodeHole|FHPlaneAddRemoveNodeHole]]: Add or Remove a Node or a Hole from/to a conductive plane
+* [[Image:EM_FHEquiv.svg|32px]] [[EM_FHEquiv|FHEquiv]]: Creates a FastHenry node Equivalence object
+* [[Image:EM_FHPort.svg|32px]] [[EM_FHPort|FHPort]]: Creates a FastHenry Port object
+* [[Image:EM_FHSolver.svg|32px]] [[EM_FHSolver|FHSolver]]: Creates a FastHenry Solver object
+* [[Image:EM_FHInputFile.svg|32px]] [[EM_FHInputFile|FHInputFIle]]: Creates a FastHenry Input File
+== FasterCap Tools == <!--T:18-->
-== API ==
+<!--T:19-->
-The EM tools can be used in [[macros]] and from the [[Python]] console by using the EM API.
+At present, FasterCap is supported via some Macros in the {{FileName|Export_mesh.py}} file available in the [https://github.com/ediloren/EM-Workbench-for-FreeCAD ElectroMagnetic Workbench GitHub source code].
-== Tutorials ==
+== API == <!--T:20-->
+<!--T:21-->
-Some beta video tutorials are available:
+The EM tools can be used in [[Macros|macros]] and from the [[Python|Python]] console by using the EM API.
+== Tutorials == <!--T:22-->
+<!--T:23-->
+Some video tutorials are available for the EM Workbench beta versions:
+<!--T:24-->
 * [https://www.youtube.com/watch?v=h6Pp-_ovLZM FreeCAD ElectroMagnetic Workbench tutorial - Getting started]
 * [https://www.youtube.com/watch?v=5pSzPizw4e8 FreeCAD ElectroMagnetic WorkBench tutorial: create a conductive plane, part 1]
@@ Line 50: / Line 83: @@
 * [https://www.youtube.com/watch?v=slsLdLoF2OI FreeCAD ElectroMagnetic WorkBench tutorial: using the path object, part 2]
-[[Category:User Documentation]]
+</translate>
-[[Category:Addons]]
+{{EM Tools navi{{#translation:}}}}
-[[Category:External Workbenches]]
+{{Userdocnavi{{#translation:}}}}
+[[Category:External Workbenches{{#translation:}}]]