QuickField Problem Builder

ProblemBuilder 1.4.0 reads a .qfp JSON Lines script and creates a QuickField problem file (.pbm). It is the root builder and orchestrator for complete QuickField problems.

ProblemBuilder sets the problem type, class, units, timing parameters, and references to the geometry and data files. It can then run Model Builder and Data Builder through their run(filename) entry points.

ProblemBuilder does not read .qfs or .qfd files directly, does not create .mod or data files itself, and does not change the process working directory.

The source code, precompiled executable, and full PDF documentation are available in the download section.

Program launch options

Problem Builder can be started with or without command-line parameters:

problem_builder.exe [/h] [filepath]

• /h – displays a list of supported script commands.
• filepath – loads the specified .qfp script.

If problem_builder.exe is launched without parameters, it opens a graphical user interface where the user can choose a script file manually.

QFP script format and version

A Problem Builder script (.qfp) is a plain-text UTF-8 JSON Lines file: every non-empty line contains one JSON object representing one command.

{"version":"1.2"}

Supported QFP versions are 1.0 and 1.2. The current recommended version is 1.2.

Command reference

{"analysis":"code"}

{"problemClass":"plane-parallel"}
{"problemClass":"axisymmetric"}

{"units":"mm"}
{"coordinates":"cartesian"}

{"modelFile":"example.mod"}
{"dataFile":"example.dms"}

{"modelBuilder":"example.qfs"}
{"dataBuilder":"example.qfd"}

{"save":"example.pbm"}
{"save":{"file":"example.pbm","solve":{}}}

Complete QFP templates

DC Magnetics, axisymmetric

{"version":"1.2"}
{"analysis":"ms"}
{"problemClass":"axisymmetric"}
{"units":"mm"}
{"coordinates":"cartesian"}
{"modelFile":"example.mod"}
{"dataFile":"example.dms"}
{"modelBuilder":"example.qfs"}
{"dataBuilder":"example.qfd"}
{"save":"example.pbm"}

Transient Magnetics, axisymmetric

{"version":"1.2"}
{"analysis":"tem"}
{"problemClass":"axisymmetric"}
{"units":"mm"}
{"coordinates":"cartesian"}
{"timeFinal":0.001}
{"autoTimeStep":false}
{"timeStep":0.000001}
{"timeOutputFirst":0}
{"timeOutputStep":0.000002}
{"modelFile":"example.mod"}
{"dataFile":"example.dms"}
{"modelBuilder":"example.qfs"}
{"dataBuilder":"example.qfd"}
{"save":"example.pbm"}

Current source-package layout

The current source package has a flat layout. Keep these Python files together in one directory:

problem_builder.py
model_builder.py
data_builder.py
qf_data_builder_common.py
qf_data_builder_*.py

ProblemBuilder imports model_builder and data_builder directly from the same directory. Separate model_builder/ or data_builder/ source subdirectories are not required.

ProblemBuilder creates and saves the .pbm file, writes the file references, and then calls the queued Model Builder and Data Builder scripts.
It does not close QuickField problem windows; the problem remains open for inspection or solving.

Check or create a QFP script

The checker below validates JSON syntax, recognized commands, required file references, common extensions, and the rule that save must be last. It does not run QuickField or the builder programs.

The software is provided "as is" and the author disclaims all warranties with regard to this software, including all implied warranties of merchantability and fitness. In no event shall the author be liable for any special, direct, indirect, or consequential damages, or any damages whatsoever resulting from loss of use, data, or profits, whether in an action of contract, negligence, or other tortious action, arising out of or in connection with the use or performance of this software.

• Accept terms above and download:
  Source code and precompiled executable
• Full documentation (PDF)