LabelEdge Object

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

Parametric Simulation Samples

LabelEdge Object

Summary

Set of common physical data of an edge, which are applicable to all kind of problems.

Details

The LabelEdge object represents very general physical data applicable to an edge label. When you need to change physical parameters for the edge label, you get the LabelEdge object using the Content property of the Label object, modify the LabelEdge object using its properties and then put it back in the Label object assigning your LabelEdge to the Content property of your Label object. Please see the example for Label object

The exact type of the LabelEdge object you get by the Label.Content property depends upon the problem type as show in the table:

Kind of Analysis	LabelEdge Type
Electrostatic problem	LabelEdgeES
DC magnetics problem	LabelEdgeMS
Current flow problem	LabelEdgeCF
Heat transfer problem	LabelEdgeHT
Time-harmonic (AC) magnetics	LabelEdgeHE
Stress analysis problem	LabelEdgeSA

The generic LabelEdge object provides only those properties that are common for all specific types of LabelEdges. These are:

Type property as qfEdge	Read-only	Returns the qfEdge value showing that the data are applicable to an edge label.
ProblemType property as QfProblemTypes	Read-only	Returns the problem type.
ConditionType property as QfBoundaryConditionType	Read-only	Returns one of the QfBoundaryConditionType constants indicating the type of boundary condition (Dirichlet, Neumann, and other).
Dirichlet property as Double	Read and write	Sets the given potential value on the edge as double.
DirichletLinear property as LinFunc	Read and write	Sets the given potential value on the edge as a linear function of coordinates. Note: the parameters of the linear function depend upon the chosen length unit. When you are dealing with the LabelEdge object and it derivatives, you always set coordinate dependent values as if the length unit is meter, no matter what unit is really chosen.
Neumann property as Double	Read and write	Sets the normal component of the potential gradient.
Floating property as Boolean	Read and write	If TRUE defines the edge as "floating", i.e. having a constant but a priori unknown potential.
Empty property as Boolean	Read-only	Is True when the data are not given for this object.
SetEmpty method	Method	Makes the LabelEdge empty.

Each LabelEdge's subtype inherits all the methods and properties of the basic LabelObject type listed above.

Generally an edge cannot have more than one boundary condition defined. Alternative types returned by the ConditonType property are:

qfDirichlet - the edge has a prescribed value of the potential;
qfNeumann - the value of the normal component of the potential gradient is defined;
qfFloating - the edge has a constant, but unknown potential.

If you set the boundary condition type for an edge several times, only the last setting is remembered.

The following example iterates through edge labels in the document and sets the same linear function as a Dirichlet condition to all Dirichlet edges, and zero (homogeneous) Neumann conditions to all Neumann edges:

Dim lb As QuickField.Label
    For Each lb In prb.DataDoc.Labels(qfEdge)
    Dim edgeData As EdgeEdge
    Set edgeData = lb.Content
    With edgeData
        If .ConditionType = qfDirichlet Then
            Dim lf as LinFunc
            lf.a = 0
            lf.b = 50
            lf.c = 30
            .DirichletLinear = lf
        ElseIf .ConditionType = qfNeumann Then
            .Neumann = 0
        End If
    End With
    lb.Content = edgeData
Next

ActiveField™ Help

LabelEdge Object

Summary

Details