QuickField offers a number of "objects" representing several aspects of problem defining and solving process. In general, objects allow you to do programmatically the same operations usually performed using the graphic user interface. Almost every entity you work with through QuickField GUI has its analog among the QuickField objects. Some objects are organized in collections. Collection is itself a special object that provides a way to iterate through its member, add and remove from it and perform other operation on the whole set of its member.
Below you find the full list of QuickField objects and collection, organized by categories:
Application object manages the whole QuickField application.
Documents collection contains IDocument objects. More precisely, each Documents collection contains documents of the same type that are objects derived from generic IDocument type.
Windows collection contains all the opened Window objects (or its derivate).
The Problem object, derived from the IDocument, represents the QuickField problem document.
The Links collection of the Link objects represents links to the coupled problems.
The SolvingState object enables control of the asynchronous solving process.
The DataDoc object, derived from the IDocument, represents the QuickField document contained material properties, field sources and boundary condition.
It is organized into three Labels collection; each of them contains Label objects.
Each Label object belongs to one of the following types: LabelBlock, LabelEdge or LabelVertex that represent very common properties of the data.
Dealing with physical properties for the problem, you manipulate with particular derivative objects:
Class of Problem |
Block Labels |
Edge Labels |
Vertex Labels |
Electrostatic |
|||
DC Conduction |
|||
AC Conduction |
|||
DC Magnetics |
|||
AS Magnetics |
|||
Heat Transfer |
|||
Stress Analysis |
The Spline object represents the curve function, which describes some field dependent parameters like B-H magnetization curve.
The Model object represents the geometric model document derived from the IDocument.
All the geometric objects in the model are members of the Shapes collection. There is only one Shapes collection in each Model document.
Dealing with geometric objects you often need to define some subset of geometric objects - the ShapeRange collection. There can be as many ShapeRange objects as you wish.
The Shape and ShapeRange are collections of the Shape objects. The Shape object represents the most common properties of elementary geometric object. More specific properties are offered by the Shape's derivative: the Block, Edge and Vertex objects.
The model geometry is presented on the screen by the ModelWindow object that inherits methods and properties from the generic Window object.
The Model object maintains a Grid object, the setting of which affects creation of new Shape objects.
The Result object represents the most general methods and properties of the problem solution.
The local field values are represented by the FieldPoint object. The derived FieldPointES, FieldPointHE and FieldPointSA objects work out the electrostatic, time-harmonic magnetic and stress analysis problems in detail
The Quantity object represents an integral field parameter.
The FieldWindow object, derived from the generic Window, represents the field picture window.
The FieldPicture object is used to control the filed presentation in the FieldWindow.
The Contour object represents the contour in a FieldWindow used as a path for XY-Plots, Tables and integral calculation.
The TableWindow object derived from the generic Window represents the table window.
The Columns collection contains TableColumn objects representing the columns in a table.
The Rows collection contains TableRow objects representing the rows in a table.
The XYPlotWindow object, derived from the generic Window, represents the XY-plot window.
The PlotPicture object is used to control the plot presentation in the XYPlotWindow.
There are a few basic objects used for various needs. Some of them are implemented as a regular objects, the others are user defined types (UDT) also known as structure in C/C++ and record in Pascal.
Objects
The Point object represents the point or vector in 2D space.
The ComplexValue object is a complex number with real and imaginary parts.
The ComplexVector object represents a complex vector.
The OscillatedValue object is a physical value such as magnetic field energy that has a non-zero average value and a double frequency oscillating component.
The OscillatedVector object is a vector quantity like Lorentz force that has non-zero average part and a double frequency oscillating component.
The DMatrix object represents a diagonal 2*2 matrix.
The HMatrix object represents a symmetric 2*2 matrix
User Defined Types (Structures or Records)
The Vector3D structure contains three components of a 3D vector: X, Y, and Z as Double.
The LinFunc structure contains three parameters of a linear function of two variables: a, b and c as double.
The Elast structure contains the elasticity constants of an anisotropic media.
The Spring structure describes properties of elastic support: initialDispl and elastMod as Double.