> 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/smart-power-simulation-software-sps/blocks-functions-tools/power-transmission-and-distribution/power_cableparam.md).

# power\_cableparam

## Description

The **power\_cableparam** function computes RLC parameters of radial copper cables with single screen, based on conductor and insulator characteristics.

## Syntax

```matlab
power_cableparam
DATA = power_cableparam(‘new’)
DATA = power_cableparam(CableData)
```

## Description

power\_cableparam opens the [Cable Parameter Calculator](https://www.opal-rt.com/docs/smart-power-simulation-software-sps/blocks-functions-tools/simulation-and-analysis/cable-parameter-calculator.md) app with the default cable parameter values provided by SPS software.

**DATA = power\_cableparam('new')** returns a structure variable with default cable geometry parameters. You can use DATA as a template variable to configure a new cable geometry and to compute the cable parameters.

**DATA = power\_cableparam(CableData)** computes the cable parameters for the geometric cable parameters given in the CableData structure. The function computes the R, L, C, and G fields of DATA structure as N-by-N matrices where N is the number of phases defined in the cable arrangement. The WB field of the DATA structure variable contains the frequency-dependent model parameters for the given frequency-range.

If you specify the DATA structure in the format of R2022a, the function assumes that a cable consists of an inner copper phase conductor with an outer screen conductor, using cross-linked polyethylene (XLPE) insulator material. The R, L, C, and Z parameters are then computed as in R2022a. The G and WB parameters are not computed.

## Input Arguments

**CableData** — Conductor and insulator characteristics : Structure specifying conductor and insulator characteristics for a set of cables that have a screen conductor. The structure contains these fields:

<table data-header-hidden><thead><tr><th width="200.84442138671875">Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>Field</strong></td><td><strong>Description</strong></td></tr><tr><td>configuration</td><td>Specify the configuration of the cable arrangement: 'underground', 'aerial', 'pipe'.</td></tr><tr><td>cables</td><td>Structure specifying the cable arrangement geometry.</td></tr><tr><td>types</td><td>Structure specifying the geometrical and electrical parameters of the cable types.</td></tr><tr><td>pipe</td><td>Structure specifying the parameters of the pipe.</td></tr><tr><td>crossbondTheSheaths</td><td>Set to 1 to cross bond the sheaths. See the documentation of the Power Cable Parameters app for more information.</td></tr><tr><td>frequency</td><td>The frequency, in hertz, at which to evaluate the RLC cable arrangement parameters.</td></tr><tr><td>frequencyRange</td><td>Specify a vector of three elements [X1, X2, N] to define a frequency vector in the logspace(X1, X2, N) format, consisting of N logarithmically equally spaced points between 10^X1 and 10^X2.</td></tr><tr><td>length</td><td>Length of the cable arrangement in meters.</td></tr><tr><td>groundResistivity</td><td>Ground resistivity in ohm-meters. Set to <code>0</code> to specify perfectly conducting ground.</td></tr><tr><td>comments</td><td>Comments related to the cable arrangement.</td></tr></tbody></table>

The **cables field of CableData** is a structure with the following fields (the length of the cables structure corresponds to the number of cables in your cable arrangement):

<table data-header-hidden><thead><tr><th width="201.42218017578125">Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>Field</strong></td><td><strong>Description</strong></td></tr><tr><td>Vdist</td><td><p>When configuration is aerial or underground, vertical position of the center of the cable in meters.</p><p>For pipe, cable position relative to the center of the pipe in meters.</p></td></tr><tr><td>Hdist</td><td><p>When configuration is aerial or underground, horizontal position of the center of the cable in meters.</p><p>For pipe, position angle of the cable inside the pipe in meters.</p></td></tr><tr><td>Rout</td><td>External radius of the cable.</td></tr><tr><td>type</td><td>Cable type as an integer between 1 and Number of Types.</td></tr><tr><td>phase</td><td>Associate each conductor of the cable to an electrical phase of the network.</td></tr></tbody></table>

The types field of CableData is a structure with the fields in this table. The length of the types structure corresponds to the number of cable types that are defined in your cable arrangement.

<table data-header-hidden><thead><tr><th width="200.66668701171875"></th><th></th></tr></thead><tbody><tr><td><strong>Field</strong></td><td><strong>Description</strong></td></tr><tr><td>Conductor</td><td>Geometric and electric parameters of the cable</td></tr></tbody></table>

The **conductors field** structure contains these fields:

<table data-header-hidden><thead><tr><th width="200.13330078125">Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>Field</strong></td><td><strong>Description</strong></td></tr><tr><td>R_in</td><td>Inside radius of the conductor.</td></tr><tr><td>R_out</td><td>Outside radius of the conductor.</td></tr><tr><td>Rho</td><td>Conductor resistivity.</td></tr><tr><td>MUE</td><td>Conductor relative permeability.</td></tr><tr><td>MUE_IN</td><td>Surrounding insulation relative permeability.</td></tr><tr><td>EPS_IN</td><td>Surrounding insulation relative permittivity.</td></tr><tr><td>LFCT_IN</td><td>Surrounding insulation loss factor.</td></tr></tbody></table>

**pipe** is a structure with these fields:

<table data-header-hidden><thead><tr><th width="199.68896484375">Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>Field</strong></td><td><strong>Description</strong></td></tr><tr><td>R_in</td><td>Internal radius of the metallic pipe in meters.</td></tr><tr><td>R_out</td><td>External radius of the metallic pipe.</td></tr><tr><td>R_ext</td><td>External radius of the outer insulator.</td></tr><tr><td>V_dpth</td><td>Depth of center of the pipe below the ground level.</td></tr><tr><td>Rho</td><td>Pipe resistivity.</td></tr><tr><td>MUE</td><td>Metallic pipe relative permeability.</td></tr><tr><td>MUE_in</td><td>Inside insulation relative permeability.</td></tr><tr><td>EPS_IN</td><td>Inside insulation relative permittivity.</td></tr><tr><td>LFCT_IN</td><td>Inside insulation loss factor.</td></tr><tr><td>MUE_out</td><td>Outside insulation relative permeability.</td></tr><tr><td>EPS_out</td><td>Outside insulation relative permittivity.</td></tr><tr><td>LFCT_out</td><td>Outside insulation loss factor.</td></tr><tr><td>phase</td><td>Phase number connected to the metallic pipe.</td></tr></tbody></table>

## Output Arguments

DATA — Cable parameters : Structure containing the computed cable parameters with these fields:

<table><thead><tr><th width="199.51104736328125">Field</th><th>Description</th></tr></thead><tbody><tr><td>R</td><td>Resistance per unit length matrix of the cable arrangement.</td></tr><tr><td>L</td><td>Inductance per unit length matrix of the cable arrangement.</td></tr><tr><td>C</td><td>Capacitance per unit length matrix of the cable arrangement.</td></tr><tr><td>G</td><td>Admittance per unit length matrix of the cable arrangement.</td></tr><tr><td>WB</td><td>Frequency dependent parameters of the cable arrangement.</td></tr></tbody></table>

## Building the RLC Matrices

These computed resistances, impedances, and capacitances need to be organized into *2N*-by-*2N* matrices that can be directly used in the block you selected to model your cable. See the 4 Cables with screen (PI model) block in the `power_cable` example.

The RLC matrices are defined as follows (the example is given for a 3-cable configuration):

$$
R =
\begin{bmatrix}
r\_{aa} & r\_{ax} & r\_{ab} & r\_{aa} & r\_{ax} & r\_{ab} \\
r\_{ax} & r\_{xx} & r\_{ab} & r\_{ax} & r\_{xx} & r\_{ab} \\
r\_{ab} & r\_{ab} & r\_{aa} & r\_{ab} & r\_{ab} & r\_{aa} \\
r\_{aa} & r\_{ax} & r\_{ab} & r\_{aa} & r\_{ax} & r\_{ab} \\
r\_{ax} & r\_{xx} & r\_{ab} & r\_{ax} & r\_{xx} & r\_{ab} \\
r\_{ab} & r\_{ab} & r\_{aa} & r\_{ab} & r\_{ab} & r\_{aa}
\end{bmatrix}
\space

L =
\begin{bmatrix}
l\_{aa} & l\_{ax} & l\_{ab} & l\_{aa} & l\_{ax} & l\_{ab} \\
l\_{ax} & l\_{xx} & l\_{ab} & l\_{ax} & l\_{xx} & l\_{ab} \\
l\_{ab} & l\_{ab} & l\_{aa} & l\_{ab} & l\_{ab} & l\_{aa} \\
l\_{aa} & l\_{ax} & l\_{ab} & l\_{aa} & l\_{ax} & l\_{ab} \\
l\_{ax} & l\_{xx} & l\_{ab} & l\_{ax} & l\_{xx} & l\_{ab} \\
l\_{ab} & l\_{ab} & l\_{aa} & l\_{ab} & l\_{ab} & l\_{aa}
\end{bmatrix}
\\\[8pt]
C =
\begin{bmatrix}
c\_{ax} & -c\_{ax} & 0 & 0 & 0 & 0 \\
-c\_{ax} & c\_{ax} + c\_{xe} & 0 & 0 & 0 & 0 \\
0 & 0 & c\_{ax} & -c\_{ax} & 0 & 0 \\
0 & 0 & -c\_{ax} & c\_{ax} + c\_{xe} & 0 & 0 \\
0 & 0 & 0 & 0 & c\_{ax} & -c\_{ax} \\
0 & 0 & 0 & 0 & -c\_{ax} & c\_{ax} + c\_{xe}
\end{bmatrix}
\\\[8pt]
$$

## Examples

For an example using the power\_cableparam function, see the [Four Coupled 66-kV Cables](https://www.opal-rt.com/docs/smart-power-simulation-software-sps/example-models/simulation-and-analysis/four-coupled-66-kv-cables.md)\
(power\_cable) model.


---

# 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/smart-power-simulation-software-sps/blocks-functions-tools/power-transmission-and-distribution/power_cableparam.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.
