Merge pull request #1056 from PowerGridModel/docs/add-invalid-values-current-sensor

Current Sensor: Mention invalid measured values in docs

Author: nitbharambe

docs/user_manual/components.md

@@ -985,6 +985,11 @@ See the documentation on [state estimation calculation methods](calculations.md#
 per method on how the variances are taken into account for both the global and local angle measurement types and for the
 individual phases.
 
+```{note}
+The combination of `i_measured=0` and `i_angle_measured=nπ/2` renders the current sensor invalid for PGM. 
+See [State estimate sensor transformations](calculations.md#state-estimate-sensor-transformations).
+```
+
 ##### Steady state output
 
 ```{note}
@@ -1016,7 +1021,9 @@ Global angle current measurements require at least one voltage angle measurement
 As a sign convention, the angle is the phase shift of the current relative to the reference angle, i.e.,
 
 $$
-\underline{I} = \text{i_measured} \cdot e^{j \text{i_angle_measured}} \text{ .}
+   \begin{eqnarray}
+      \underline{I} = \text{i}_{\text{measured}} \cdot e^{j \text{i}_{\text{angle,measured}}} \text{ .}
+   \end{eqnarray}
 $$
 
 ```{warning}
@@ -1033,8 +1040,8 @@ As a result, the global current phasor depends on the local voltage phase offset
 formula.
 
 $$
-\underline{I} = \underline{I}_{\text{local}}^{*} \frac{\underline{U}}{|\underline{U}|}
-              = \text{i_measured} \cdot e^{\mathrm{j} \left(\theta_{U} - \text{i_angle_measured}\right)}
+   \underline{I} = \underline{I}_{\text{local}}^{*} \frac{\underline{U}}{|\underline{U}|}
+      = \text{i}_{\text{measured}} \cdot e^{\mathrm{j} \left(\theta_{U} - \text{i}_{\text{angle,measured}}\right)}
 $$
 
 ```{note}

tests/benchmark_cpp/benchmark.cpp

@@ -20,7 +20,7 @@ MathSolverDispatcher const& get_math_solver_dispatcher() {
     return math_solver_dispatcher;
 }
 
-auto const get_benchmark_run_title(Option const& option, MainModelOptions const& model_options, Idx batch_size) {
+auto get_benchmark_run_title(Option const& option, MainModelOptions const& model_options) {
     auto const mv_ring_type = option.has_mv_ring ? "meshed grid" : "radial grid";
     auto const sym_type =
         model_options.calculation_symmetry == CalculationSymmetry::symmetric ? "symmetric" : "asymmetric";
@@ -84,7 +84,7 @@ struct PowerGridBenchmark {
         generator.generate_grid(option, 0);
         InputData const& input = generator.input_data();
 
-        std::cout << get_benchmark_run_title(option, model_options, batch_size) << '\n';
+        std::cout << get_benchmark_run_title(option, model_options) << '\n';
 
         auto const run = [this, &model_options, &info](Idx batch_size_) {
             switch (model_options.calculation_type) {