## On this page

  

 

 # `FluxLinkage`

 Last update: 16.07.2025 

<a id="ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Results.ElectromagneticResults.FluxLinkage"></a>

#### *class* Ansys.ACT.Automation.Mechanical.Results.ElectromagneticResults.FluxLinkage

Bases: [`object`](https://docs.python.org/3/library/functions.html#object)

Defines a FluxLinkage.

<a id="overview"></a>

## Overview

### Methods

NameDescription[`Activate`](#FluxLinkage.Activate)Activate the current object.[`AddComment`](#FluxLinkage.AddComment)Creates a new child Comment.[`AddImage`](#FluxLinkage.AddImage)Creates a new child Image.[`CopyTo`](#FluxLinkage.CopyTo)Copies all visible properties from this object to another.[`CreateParameter`](#FluxLinkage.CreateParameter)Creates a new parameter for a Property.[`Delete`](#FluxLinkage.Delete)Run the Delete action.[`Duplicate`](#FluxLinkage.Duplicate)Creates a copy of the current DataModelObject.[`GetChildren`](#FluxLinkage.GetChildren)Gets the list of children, filtered by type.[`GetParameter`](#FluxLinkage.GetParameter)Gets the parameter corresponding to the given property.[`GroupAllSimilarChildren`](#FluxLinkage.GroupAllSimilarChildren)Run the GroupAllSimilarChildren action.[`GroupSimilarObjects`](#FluxLinkage.GroupSimilarObjects)Run the GroupSimilarObjects action.[`PropertyByAPIName`](#FluxLinkage.PropertyByAPIName)Get a property by its API name.[`PropertyByName`](#FluxLinkage.PropertyByName)Get a property by its unique name.[`RemoveParameter`](#FluxLinkage.RemoveParameter)Removes the parameter from the parameter set corresponding to the given property.### Properties

NameDescription[`Children`](#FluxLinkage.Children)Gets the list of children.[`Comments`](#FluxLinkage.Comments)Gets the list of associated comments.[`DataModelObjectCategory`](#FluxLinkage.DataModelObjectCategory)Gets the current DataModelObject’s category.[`Images`](#FluxLinkage.Images)Gets the list of associated images.[`InternalObject`](#FluxLinkage.InternalObject)Gets the internal object. For advanced usage only.[`Multiplier`](#FluxLinkage.Multiplier)Gets or sets the Multiplier.[`Properties`](#FluxLinkage.Properties)Gets the list of properties for this object.[`VisibleProperties`](#FluxLinkage.VisibleProperties)Gets the list of properties that are visible for this object.<a id="property-detail"></a>

## Property detail

<a id="FluxLinkage.Children"></a>

### *property* FluxLinkage.Children *: List\[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of children.

<a id="FluxLinkage.Comments"></a>

### *property* FluxLinkage.Comments *: Iterable\[[Ansys.ACT.Automation.Mechanical.Comment](../../Comment.md#ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Comment)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated comments.

<a id="FluxLinkage.DataModelObjectCategory"></a>

### *property* FluxLinkage.DataModelObjectCategory *: [Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory](../../../../../Mechanical/DataModel/Enums/DataModelObjectCategory.md#ansys.mechanical.stubs.v241.Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the current DataModelObject’s category.

<a id="FluxLinkage.Images"></a>

### *property* FluxLinkage.Images *: Iterable\[[Ansys.ACT.Automation.Mechanical.Image](../../Image.md#ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Image)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated images.

<a id="FluxLinkage.InternalObject"></a>

### *property* FluxLinkage.InternalObject *: Ansys.Common.Interop.DSObjectsAuto.IDSResultTableAuto | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the internal object. For advanced usage only.

<a id="FluxLinkage.Multiplier"></a>

### *property* FluxLinkage.Multiplier *: [float](https://docs.python.org/3/library/functions.html#float) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Multiplier.

<a id="FluxLinkage.Properties"></a>

### *property* FluxLinkage.Properties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of properties for this object.

<a id="FluxLinkage.VisibleProperties"></a>

### *property* FluxLinkage.VisibleProperties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of properties that are visible for this object.

<a id="method-detail"></a>

## Method detail

<a id="FluxLinkage.Activate"></a>

### FluxLinkage.Activate()

Activate the current object.

<a id="FluxLinkage.AddComment"></a>

### FluxLinkage.AddComment()

Creates a new child Comment.

<a id="FluxLinkage.AddImage"></a>

### FluxLinkage.AddImage(filePath: [str](https://docs.python.org/3/library/stdtypes.html#str))

```text
Creates a new child Image.
If a filePath is provided, the image will be loaded from that file,
if not, the image will be a screen capture of the Geometry window.

```

<a id="FluxLinkage.CopyTo"></a>

### FluxLinkage.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

<a id="FluxLinkage.CreateParameter"></a>

### FluxLinkage.CreateParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Creates a new parameter for a Property.

<a id="FluxLinkage.Delete"></a>

### FluxLinkage.Delete()

Run the Delete action.

<a id="FluxLinkage.Duplicate"></a>

### FluxLinkage.Duplicate()

Creates a copy of the current DataModelObject.

<a id="FluxLinkage.GetChildren"></a>

### FluxLinkage.GetChildren(recurses: [bool](https://docs.python.org/3/library/functions.html#bool), children: List\[ChildrenType\])

Gets the list of children, filtered by type.

<a id="FluxLinkage.GetParameter"></a>

### FluxLinkage.GetParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Gets the parameter corresponding to the given property.

<a id="FluxLinkage.GroupAllSimilarChildren"></a>

### FluxLinkage.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

<a id="FluxLinkage.GroupSimilarObjects"></a>

### FluxLinkage.GroupSimilarObjects()

Run the GroupSimilarObjects action.

<a id="FluxLinkage.PropertyByAPIName"></a>

### FluxLinkage.PropertyByAPIName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

```text
Get a property by its API name.
If multiple properties have the same API Name, only the first property with that name will be returned.

```

<a id="FluxLinkage.PropertyByName"></a>

### FluxLinkage.PropertyByName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

Get a property by its unique name.

<a id="FluxLinkage.RemoveParameter"></a>

### FluxLinkage.RemoveParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Removes the parameter from the parameter set corresponding to the given property.