|
1478 | 1478 | </dl> |
1479 | 1479 | </dd></dl> |
1480 | 1480 |
|
| 1481 | +<dl class="py method"> |
| 1482 | +<dt class="sig sig-object py" id="esa.saw.SAW.get_lodf_matrix_fast"> |
| 1483 | +<span class="sig-name descname"><span class="pre">get_lodf_matrix_fast</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esa.saw.SAW.get_lodf_matrix_fast" title="Permalink to this definition">¶</a></dt> |
| 1484 | +<dd><p>Calculate the line outage distribution factor natively. This method should be much |
| 1485 | +faster than the PW script command for large cases.</p> |
| 1486 | +<dl class="field-list simple"> |
| 1487 | +<dt class="field-odd">Returns</dt> |
| 1488 | +<dd class="field-odd"><p>A dense float matrix in the numpy array format.</p> |
| 1489 | +</dd> |
| 1490 | +</dl> |
| 1491 | +</dd></dl> |
| 1492 | + |
1481 | 1493 | <dl class="py method"> |
1482 | 1494 | <dt class="sig sig-object py" id="esa.saw.SAW.get_power_flow_results"> |
1483 | 1495 | <span class="sig-name descname"><span class="pre">get_power_flow_results</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ObjectType</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">additional_fields</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">None</span><span class="p"><span class="pre">,</span> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">None</span><span class="p"><span class="pre">,</span> </span><span class="pre">pandas.core.frame.DataFrame</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#esa.saw.SAW.get_power_flow_results" title="Permalink to this definition">¶</a></dt> |
|
1502 | 1514 | </dl> |
1503 | 1515 | </dd></dl> |
1504 | 1516 |
|
| 1517 | +<dl class="py method"> |
| 1518 | +<dt class="sig sig-object py" id="esa.saw.SAW.get_ptdf_matrix_fast"> |
| 1519 | +<span class="sig-name descname"><span class="pre">get_ptdf_matrix_fast</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esa.saw.SAW.get_ptdf_matrix_fast" title="Permalink to this definition">¶</a></dt> |
| 1520 | +<dd><p>Calculate the power transfer distribution factor natively. This method should be much |
| 1521 | +faster than the PW script command for large cases.</p> |
| 1522 | +<dl class="field-list simple"> |
| 1523 | +<dt class="field-odd">Returns</dt> |
| 1524 | +<dd class="field-odd"><p>A dense float matrix in the numpy array format.</p> |
| 1525 | +</dd> |
| 1526 | +</dl> |
| 1527 | +</dd></dl> |
| 1528 | + |
| 1529 | +<dl class="py method"> |
| 1530 | +<dt class="sig sig-object py" id="esa.saw.SAW.get_shift_factor_matrix"> |
| 1531 | +<span class="sig-name descname"><span class="pre">get_shift_factor_matrix</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">'DC'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#esa.saw.SAW.get_shift_factor_matrix" title="Permalink to this definition">¶</a></dt> |
| 1532 | +<dd><p>Calculate the injection shift factor matrix using the auxiliary |
| 1533 | +script CalculateShiftFactorsMultipleElement.</p> |
| 1534 | +<dl class="field-list simple"> |
| 1535 | +<dt class="field-odd">Parameters</dt> |
| 1536 | +<dd class="field-odd"><p><strong>method</strong> – The linear method to be used for the calculation. The</p> |
| 1537 | +</dd> |
| 1538 | +</dl> |
| 1539 | +<p>options are AC, DC or DCPS. |
| 1540 | +:returns: A dense float matrix in the numpy array format.</p> |
| 1541 | +</dd></dl> |
| 1542 | + |
| 1543 | +<dl class="py method"> |
| 1544 | +<dt class="sig sig-object py" id="esa.saw.SAW.get_shift_factor_matrix_fast"> |
| 1545 | +<span class="sig-name descname"><span class="pre">get_shift_factor_matrix_fast</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esa.saw.SAW.get_shift_factor_matrix_fast" title="Permalink to this definition">¶</a></dt> |
| 1546 | +<dd><p>Calculate the injection shift factor matrix directly using the incidence |
| 1547 | +matrix and the susceptance matrix. This method should be much faster than |
| 1548 | +the PW script command for large cases.</p> |
| 1549 | +<dl class="field-list simple"> |
| 1550 | +<dt class="field-odd">Returns</dt> |
| 1551 | +<dd class="field-odd"><p>A dense float matrix in the numpy array format.</p> |
| 1552 | +</dd> |
| 1553 | +</dl> |
| 1554 | +</dd></dl> |
| 1555 | + |
1505 | 1556 | <dl class="py method"> |
1506 | 1557 | <dt class="sig sig-object py" id="esa.saw.SAW.get_shunt_admittance"> |
1507 | 1558 | <span class="sig-name descname"><span class="pre">get_shunt_admittance</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esa.saw.SAW.get_shunt_admittance" title="Permalink to this definition">¶</a></dt> |
|
0 commit comments