> For the complete documentation index, see [llms.txt](https://www.opal-rt.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.opal-rt.com/docs/hypersim/library-blocks-reference/network-lines-and-cables/cable-data.md).

# Cable Data

## Description

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-597bd2d457b023e664dda2935a89e985c3c05527%2Fimage%20(429).png?alt=media" alt="" width="138"><figcaption></figcaption></figure>

The **Cable Data** block, located in the **Network Lines and Cables** library, produces transmission cable models for time-domain studies.

**Available cable models:**

* **FD:** Frequency dependent cable model (not implemented in HYPERSIM)
* **CP:** Constant-parameter cable model
* **Exact-PI:** Exact frequency domain representation of a cable at a given frequency (not implemented in HYPERSIM)
* **Scan:** Cable model parameters are calculated at given frequencies. No model is generated
* **Wideband:** Wideband cable model

FD and Exact-PI are not implemented in HYPERSIM for cables. A CP model can be used, but it is less precise for cable simulations. The cable model used in HYPERSIM is the **wideband model**, which is considered the most accurate approach. Therefore, it is strongly recommended to use the Cable Data module to produce a wideband cable model.

## Mask parameters

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-03efd530101898747efc41f66a8cc35f0925c5f4%2Fimage%20(431).png?alt=media" alt="" width="563"><figcaption></figcaption></figure>

<table><thead><tr><th width="280">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>Open an existing cable case data file or use previously saved (click OK now) data for this device</strong></td><td>Provide an existing cable data file to modify an existing case, or use previously saved data for this device.<br>To open the previously saved version, click OK; in this case, the data is saved within the device and not in a file.</td></tr><tr><td><strong>Open an existing EMTP-V3 data file</strong></td><td>Provide an existing EMTP-V3 (AUX) data file to modify an old case.<br>This device attempts to translate the existing file to create a line case data compatible with EMTPWorks/HYPERSIM. Verify the translation by opening the resulting cable case data file with the first option on this page.<br>The provided <em>myfile</em>.data will be converted to <em>myfile</em>.lin and can be opened using the first option on this page.</td></tr><tr><td><strong>Run an existing cable case data file without opening its data</strong></td><td>Submits an existing case file directly to the Cable Data Calculation function. It can also be used to run old EMTP-V3 cases without translating them.</td></tr><tr><td><strong>Create a new line case</strong></td><td>Creates a new case from scratch.</td></tr></tbody></table>

### Cable data calculation function

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-be4aaff522d0b6f527c127269b082620491c1d30%2Fcable-data.png?alt=media" alt=""><figcaption></figcaption></figure>

{% tabs %}
{% tab title="Conductor data" %}

<table><thead><tr><th width="180" valign="top">Parameter</th><th>Description</th></tr></thead><tbody><tr><td valign="top"><strong>Overview</strong></td><td>Specify the geometrical and electrical characteristics of the cable system: geometry, conductor properties, and insulation properties. Data required for a pipe-type cable differs from single-core coaxial cable. Although many fields are similar, they are presented separately for readability.</td></tr><tr><td valign="top"><strong>Cable type</strong></td><td><p>Select the cable type:</p><ul><li><strong>Single core:</strong> To generate coaxial cables.</li><li><strong>Pipe type:</strong> To generate models where a metallic pipe encloses the coaxial cables.</li></ul></td></tr><tr><td valign="top"><strong>Number of cables</strong></td><td>Indicates the number of cables in the system.<br></td></tr><tr><td valign="top"><strong>Cross-bond the Sheaths</strong></td><td>To model a cross-bonded cable accurately, each major section must be modeled in detail. Each minor section must be modeled, and sheath bonding and grounding connections must be made explicitly using HYPERSIM node names.<br>Detailed modeling of short cable segments (order of 400 m) requires a very small time step (a fraction of the travel time of the fastest propagation mode). Multiple major sections must be connected to represent the entire cable.<br>For example, a 12 km cable with 400 m minor sections would require a total of 30 6-phase cable models. This detailed approach is necessary when assessing sheath currents and voltages.<br>This is analogous to modeling a transposed overhead line by representing each transposition section explicitly and connecting sending/receiving node names accordingly.<br>As an approximation, the Cable Data device offers a cross-bonding option. If selected, the impedance and admittance matrices are averaged to reflect cross-bonding. Sheath grounding is controlled using the KPH parameter in the Conductor data table. Setting KPH = 0 for the sheaths assumes continuous grounding (zero potential throughout the cable length).<br>In this case, the sheaths can be eliminated and a three-conductor approximation of a cross-bonded cable is obtained. This approximation compares favorably with detailed modeling for switching transient studies due to its speed and accuracy.</td></tr><tr><td valign="top"><strong>Single core</strong></td><td>Given in increasing order for the entire cable system.<br><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-bcfa92c1cd1876e5e62ed58258b418f2f41c9439%2Fimage%20(432).png?alt=media" alt=""><br><strong>Number of conductors:</strong> Number of concentric tubular conductors in this cable (e.g., core, sheath, armor).<br><strong>Vertical Distance:</strong> Depth measured from the center of this cable to the earth’s surface (positive value).<br><strong>Horizontal Distance:</strong> Distance from the center of this cable to an arbitrary point of reference.<br><strong>Outer Insulation Radius:</strong> Outside radius of the insulation layer surrounding the cable. Use 0 if none.</td></tr><tr><td valign="top"><strong>Conductor insulator data</strong></td><td>Describes each tubular conductor and its surrounding insulation from inside out (core first, then sheath, etc.).<br><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-0fc2e151c4e433a8777252884b82aa571592b394%2Fimage%20(433).png?alt=media" alt="" data-size="original"><br>For each conductor:<br><strong>Cable number:</strong> Given in increasing order for the entire cable system.<br><strong>Conductor number:</strong> The term “conductor” designates both conductor and insulator data entries.<br><strong>Inside Radius Rin:</strong> Inside radius of the conductor.<br><strong>Outside Radius Rout:</strong> Outside radius of the conductor.<br><strong>Resistivity Rho:</strong> Outside radius of the conductor.<br><strong>Relative Permeability MUE:</strong> Relative permeability of the conductor.<br><strong>Insulator Relative Permeability MUE-IN:</strong> Relative permeability of the surrounding insulation.<br><strong>Insulator Relative Permittivity EPS-IN:</strong> Relative permittivity of the surrounding insulation.<br><strong>Insulator Loss Factor LFCT-IN:</strong> Loss factor of the surrounding insulation.<br><strong>KPH:</strong> Phase-number of the conductor. Conductors of all cables must be numbered starting from 1 with no gaps (e.g., 1, 2, 3 is valid; 1, 3, 4 is not).<br>Conductors with KPH = 0 are grounded. Conductors with identical phase numbers are bundled into a single equivalent conductor. The order of conductors in the Model Data File follows the KPH sequence.</td></tr><tr><td valign="top"><strong>Pipe-Type cables</strong></td><td>In addition to single-core data, pipe-type systems require geometrical and electrical properties of the pipe. Individual cables are the same as in single-core; conductor and insulator data definitions are identical.<br><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-da793dd26af570f98dce71045446d0ab2e84e09d%2Fimage%20(434).png?alt=media" alt="" data-size="original"><br><strong>Cable number:</strong> Given in increasing order for the entire cable system.<br><strong>Number of conductors:</strong> Number of concentric tubular conductors in this cable (e.g., core, sheath, armor).<br><strong>Pipe-Type — Distance from center of pipe:</strong> Distance from the cable center to the pipe center.<br><strong>Position Angle:</strong> Angle from the line joining the cable and pipe centers to an arbitrary reference axis.<br><strong>Outer Insulation radius:</strong> Outside radius of the insulation layer surrounding the cable.</td></tr><tr><td valign="top"><strong>Geometrical pipe data —</strong></td><td><strong>Inside radius of pipe (Rin):</strong> Inside radius of the pipe.<br><strong>Outside radius of the pipe (Rout):</strong> Outside radius of the pipe.<br><strong>Outside radius of tubular insulator (Rext):</strong> Outside radius of the tubular insulator surrounding the pipe.<br><strong>Vertical distance (depth):</strong> Vertical distance of the pipe’s center from the earth’s surface.<br><strong>Phase-number of the pipe:</strong> Variable KPH (zero if grounded).</td></tr><tr><td valign="top"><strong>Electrical data of the pipe</strong></td><td>The electrical data fields for the pipe are self-explanatory.</td></tr></tbody></table>
{% endtab %}

{% tab title="Model" %}

<table><thead><tr><th width="180">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>Select model</strong></td><td>The Cable-Model module can produce various cable models for time-domain studies. Only the CP and Wideband models are implemented in HYPERSIM. The documentation below focuses on these models.</td></tr><tr><td><strong>FD</strong></td><td>Frequency dependent cable model (not implemented in HYPERSIM).</td></tr><tr><td><strong>CP</strong></td><td>Constant-parameter cable model. Assumes R, L, and C are constant and calculated at a user-supplied model frequency. L and C are distributed (“ideal cable”), and R is lumped at three places (both ends and the middle). Shunt conductance G is assumed to be zero.<br>Accounting for frequency dependence (as in the Wideband model) is important for accurate transient simulation. The CP model is computationally faster and generally used as an alternative for secondary lines or cables. The only matrix that can be calculated for this model is the Real <strong>Ti</strong>, evaluated at the entered “Model frequency.”<br>After entering all required data, invoke the Model Data Calculation Function from “Save and run this case” to generate the model data file. Use the model with CP line models (CP m-phase components) by selecting the model data file (“pun file”) through the “Load data file” option in the device data. The number of phases of the selected CP line must match the number of phases of the model generated in the pun file. The file format is described in the CP m-phase device documentation.</td></tr><tr><td><strong>Exact-PI</strong></td><td>Exact frequency domain representation at a given frequency (not implemented in HYPERSIM).</td></tr><tr><td><strong>Scan (No model)</strong></td><td>Computes cable parameters in phase, modal, or sequence quantities at specified frequencies. Results are shown in the output file. No model is generated.</td></tr><tr><td><strong>Wideband</strong></td><td>Models phase line parameters as complex, distributed, and frequency dependent. Specify the Frequency range for which the propagation function and characteristic impedance are synthesized.</td></tr><tr><td><strong>Frequency range</strong></td><td>Frequency band for fitting the line characteristic admittance and propagation function. The required fields are self-explanatory.</td></tr></tbody></table>
{% endtab %}

{% tab title="Cable length" %}

| Parameter                                  | Description                                                                                                                                                           |
| ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Cable length**                           | Length of the cable.                                                                                                                                                  |
| **Earth resistivity**                      | Value of the earth resistivity.                                                                                                                                       |
| **Earth relative permeability**            | Value of the earth relative permeability.                                                                                                                             |
| **Conductance breakpoint frequency (FG0)** | <p>Breakpoint frequency (FG0) of the shunt conductance for all insulating layers. For all insulators:<br>G = 2pi (FG0 + Frequency) \* Loss Factor \* Capacitance.</p> |
| {% endtab %}                               |                                                                                                                                                                       |

{% tab title="Output options" %}

| Parameter                  | Description                                                     |
| -------------------------- | --------------------------------------------------------------- |
| **Special output options** | The variables required for these settings are self-explanatory. |
| **Extra output options**   | The variables required for these settings are self-explanatory. |
| {% endtab %}               |                                                                 |

{% tab title="Save and run this case" %}

| Parameter                                                                  | Description                                                                                                                                                                                                                                                                                                                                                                                                                            |
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Options for saving this case**                                           | <p>Before running, provide a valid Case Data File identification (model identification and device name). Generated model data is available in a model data file created by the Cable Data Calculation program.</p><ul><li>For the “CP m-phase” device, load the generated model data using the “Load data from file” option.</li><li>For the “WB line” device, select the model data in the WB fitter to generate line data.</li></ul> |
| **Current Case Data File name**                                            | Enter a unique name to save the model.                                                                                                                                                                                                                                                                                                                                                                                                 |
| **Run this case to create a model data file for the selected cable model** | Select to generate line model data. When you click OK, HYPERSIM starts a separate Cable Data calculation function to generate cable data.                                                                                                                                                                                                                                                                                              |
| {% endtab %}                                                               |                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| {% endtabs %}                                                              |                                                                                                                                                                                                                                                                                                                                                                                                                                        |

## Inputs

This block has no inputs.

## Outputs

This block has no outputs.

## Example

A sample case of complete cable and conductor data for single-core contains three identical single-core cables, each one has two conductors.

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-b71198d44a93701915bdd1ef2f3384d83e7dddc6%2Fimage%20(1105).png?alt=media" alt="" width="563"><figcaption></figcaption></figure>

The complete layout is shown below. In this figure, only the outer radius of the conductors and the outer insulation radius are displayed. Each conductor is assigned a non-zero phase number, so the generated model for this example will include six distinct modes (corresponding to six wires).<br>

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-8107e1afe50f1f785a3bdc92c6d95a89c86b4a63%2Fimage%20(1106).png?alt=media" alt="" width="548"><figcaption></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://www.opal-rt.com/docs/hypersim/library-blocks-reference/network-lines-and-cables/cable-data.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
