ActiveField™ - QuickField API Help

QuickField Student Edition free download     Contacts

ActiveField Technology
What's New
Objects Overview
Hierarchy Chart
How to Start: Application Object
How to work with Problems
How to work with Model
How to work with Data
How to Analyze Results

Objects

Properties

Methods

FieldQuantity Object

Properties

Methods

Summary

Descriptor of the field quantity applicable to the current problem result

Details

Every FieldQuantity object describes a physical quantity that QuickField can compute analyzing the problem results.

In ActiveField, you access individual FieldQuantity objects as members of related FieldQuantities collections containing all physical quantities accessible in particular context. To access these collections you use your problemís Result property that, in its turn, provides several properties of FieldQuantities type.

FieldQuantity object does not represent a fixed value. You could rather see it as a set of parameters QuickField uses to compute either the value of a local quantity at the specified point or the value of an integral quantity calculated by integration over the specified contour. To access the quantity values calculated for a FieldQuantity object, invoke its Calculate method with appropriate arguments.

FieldQuantity properties and methods can be separated into the following groups:

Identification

Name

Read-only property. The name of this physical quantity.

Notation

Read-only property. Short mnemonic used to denote this physical quantity.

Unit

Read-only property. The name of the measurement unit used with this physical quantity.

Calculation of Values

Exists

Read-only property. True, if the quantity can be calculated at the specified point or by integration over the specified contour.

Calculate

Method. Returns the QuickField.Quantity object encapsulating the value calculated at the specified point or by integration over the specified contour.

Classification

Flags

Read-only property. Packed integer value of all flags in QfQuantityFlags enum.

IsCoordinate

Read-only property. True, if the quantity values depend only on coordinates.

IsPhysical

Read-only property. True, if the quantity values depend on field values.

IsIntrinsic

Read-only property. True, if the quantity is predefined in QuickField (is not user-defined).

IsScalar

Read-only property. True, if the quantity values are scalar.

IsVector

Read-only property. True, if the quantity values are two-dimensional vectors.

IsTensor

Read-only property. True, if the quantity values are tensors of the second rank.

IsComplex

Read-only property. True, if the quantity values are complex

IsComplexVector

Read-only property. True, if the quantity values are complex vectors.

IsQuadro

Read-only property. True, if the quantity values are time-dependent scalars varying with double frequency relative to time. The time average can be any value.

IsQuadroVector

Read-only property. True, if the quantity values are time-dependent vectors varying with double frequency relative to time. The time average can be any value.

IsTimeDependent

Read-only property. True, if the quantity values vary with time.

IsLocal

Read-only property. True, if the quantity values are calculated at field points.

IsLocalCoord

Read-only property. True, if calculation of the quantity values requires local coordinate system.

IsGlobal

Read-only property. True, if the quantity is applicable to the whole problem.

IsIntegral

Read-only property. True, if the quantity values are calculated by integration over line, surface or volume.

IsLineIntegral

Read-only property. True, if the quantity values are calculated by integration over a line

IsSurfaceIntegral

Read-only property. True, if the quantity values are calculated by integration over a surface

Example:

This Visual Basic code prints the values of all local physical quantities available at the point (x=20, y=10) together with their identification properties (Name, Notation and Unit).

Dim QF As QuickField.Application
Dim res As QuickField.Result
Dim probePoint As QuickField.Point
Dim enm As QuickField.FieldQuantities
Dim q As QuickField.FieldQuantity

Set probePoint = QF.PointXY(20, 10)
Set enm = res.LocalFieldQuantities(probePoint)
For i = 1 To enm.Count
    Set q = enm(i)
    Debug.Print q.Name & " " & q.Notation _
        & " = " & q.Calculate(at:=probePoint).Abs _
        & " (" & q.Unit & ")"
Next

The sample prints the following lines:

Potential A = 5.57752323150635 (Wb/m)
Flux Density B = 142.473262940178 (T)
Flux Density Bx = -22.7742176055908 (T)
Flux Density By = -140.641265869141 (T)
Energy Density w = 1615313646.44266 (J/m3)
Strength H = 22675323.2586651 (A/m)
Strength Hx = -3624629.25 (A/m)
Strength Hy = -22383752 (A/m)
Current Density jtotal = 12583421081.543 (A/m2)
Current Density jsource = 29000000000 (A/m2)
Current Density jeddy = -16416578918.457 (A/m2)
Joule Heat Q = 5460085728117.93 (W/m3)
Conductivity g = 29000000 (S)
Permeability mr = 5.00000017567458 ()