Classes | |
| class DirSetting | |
Functions | |
| def get_binary (name) | |
| def get_custom_dir () | |
| def get_dir_setting () | |
| def get_write_comments (name) | |
Variables | |
| string custom_path = "ccxBinaryPath"), | |
| string default = "ccx", | |
| string param_path = _PARAM_PATH + "Ccx", | |
| string use_default = "UseStandardCcxLocation", | |
Function Documentation
◆ get_binary()
| def femsolver.settings.get_binary | ( | name | ) |
Find binary of solver *name* honoring user settings.
Return the specific path set by the user in FreeCADs settings/parameter
system if set or the default binary name if no specific path is set. If no
path was found because the solver *name* isn't supported ``None`` is
returned. This method does not check whether the binary actually exists
and is callable.
:param name: solver id as a ``str`` (see :mod:`femsolver.settings`)
Referenced by femsolver.settings.get_dir_setting().
◆ get_custom_dir()
| def femsolver.settings.get_custom_dir | ( | ) |
Get value for :term:`General/CustomDirectoryPath` parameter.
◆ get_dir_setting()
| def femsolver.settings.get_dir_setting | ( | ) |
Return directory setting set by the user.
Return one of the three possible values of the :class:`DirSetting` enum
depending on the setting set in FreeCAD parameter system. Result dependes
on the values of :term:`General/UseTempDirectory`,
:term:`General/UseBesideDirectory` and :term:`General/UseCustomDirectory`.
References femsolver.settings.get_binary(), and femsolver.settings.get_write_comments().
◆ get_write_comments()
| def femsolver.settings.get_write_comments | ( | name | ) |
Check whether "write_comments" is set for solver.
Returns ``True`` if the "write_comments" setting/parameter is set for the
solver with the id *name*. Returns ``False`` otherwise. If the solver isn't
supported ``None`` is returned.
:param name: solver id as a ``str`` (see :mod:`femsolver.settings`)
Referenced by femsolver.settings.get_dir_setting().
Variable Documentation
◆ custom_path
| femsolver.settings.custom_path = "ccxBinaryPath"), |
◆ default
| femsolver.settings.default = "ccx", |
◆ param_path
| femsolver.settings.param_path = _PARAM_PATH + "Ccx", |
◆ use_default
| femsolver.settings.use_default = "UseStandardCcxLocation", |
