EM FHSolver

From FreeCAD Documentation
Jump to: navigation, search
Other languages:
English • ‎italiano

EM FHSolver.svg EM FHSolver

Menu location
EM → FHSolver
Workbenches
EM (add-on)
Default shortcut
E X
Introduced in version
0.17
See also
EM FHInputFile, EM FHNode, EM FHSegment, EM FHPath, EM FHPlane, EM FHEquiv, EM FHPort


Description

The FHSolver tool inserts a FHSolver object.

EM FHSolver Example.png

FHSolver object


Usage

To insert a FHSolver object in the Document:

  1. Press the EM FHSolver.svg EM FHSolver button, or press E then X keys.

Remarks

  • The FHSolver object represents the FastHenry directives that are needed in the common sections of the FastHenry input file for defining the simulation parameters, as for instance the list of frequency points at which the simulation should be run, the default units of measurement, etc. plus the output file name and folder for creating the FastHenry input file.
  • You should have only one FHSolver object per Document. If more than one FHSolver object is present, only the first one will be considered.

Properties

  • DataUnits: the FastHenry '.units'. Each unit in FreeCad will be one unit of the corresponding unit of measurement in FastHenry. Remark: this means that you can have for example a 3D drawing in FreeCAD with units set as meters, and specify a different unit of measurement for FastHenry, e.g. millimeters. So the value '1.0m' in FreeCAD will actually be '1.0mm' for the FastHenry simulation.
  • DataSigma: the default Segment conductivity ('sigma' segment parameter in FastHenry '.default' statement)
  • Datanhinc: the default number of filaments in the height direction ('nhinc' segment parameter in FastHenry '.default' statement)
  • Datanwinc: the default number of filaments in the width direction ('nwinc' segment parameter in FastHenry '.default' statement)
  • Datarh: the default ratio of adjacent filaments in the height direction ('rh' segment parameter in FastHenry '.default' statement)
  • Datarw: the default ratio of adjacent filaments in the height direction ('rw' segment parameter in FastHenry '.default' statement)
  • Datafmin: the lowest simulation frequency ('fmin' segment parameter in FastHenry '.freq' statement)
  • Datafmax: the highest simulation frequency ('fmax' segment parameter in FastHenry '.freq' statement)
  • Datandec: the number of desired frequency points per decade ('ndec' segment parameter in FastHenry '.freq' statement)
  • DataFolder: the folder path for exporting the file in FastHenry input file format
  • DataFilename: the simulation filename when exporting to FastHenry input file format

Scripting

See also: FreeCAD Scripting Basics.

The FHSolver object can be used in macros and from the Python console by using the following function:

node = makeFHSolver(units=None, sigma=None, nhinc=None, nwinc=None, rh=None, rw=None, fmin=None, fmax=None, ndec=None, folder=None, filename=None, name='FHSolver')
  • Creates a FHSolver object.
  • units is the FastHenry unit of measurement. Each unit in FreeCad will be one unit of the corresponding unit of measurement in FastHenry. Allowed values are: "km", "m", "cm", "mm", "um", "in", "mils". Defaults to EMFHSOLVER_DEFUNITS
  • sigma is the float default conductivity. Defaults to EMFHSOLVER_DEF_SEGSIGMA.
  • nhinc is the integer default nhinc parameter in FastHenry, for defining the segment height discretization into filaments. Defaults to EMFHSOLVER_DEFNHINC.
  • nwinc is the integer default nwinc parameter in FastHenry, for defining the segment width discretization into filaments. Defaults to EMFHSOLVER_DEFNWINC.
  • rh is the integer default rh parameter in FastHenry, for defining the segment height discretization ratio. Defaults to EMFHSOLVER_DEFRH.
  • rw is the integer default rw parameter in FastHenry, for defining the segment height discretization ratio. Defaults to EMFHSOLVER_DEFRW.
  • fmin is the float minimum simulation frequency
  • fmax is the float maximum simulation frequency
  • ndec is the float value defining how many frequency points per decade will be simulated.
  • folder is the folder into which the FastHenry file will be saved. Defaults to the user's home path (e.g. in Windows "C:\Documents and Settings\username\My Documents", in Linux "/home/username").
  • filename is the name of the file that will be exported. Defaults to EMFHSOLVER_DEF_FILENAME.
  • name is the name of the object

Example:

import FreeCAD, EM

fhsolver = EM.makeFHSolver()