Skip to content

Commit

Permalink
javadoc fixes
Browse files Browse the repository at this point in the history
Signed-off-by: Damien Jeandemange <damien.jeandemange@artelys.com>
  • Loading branch information
gverger authored and jeandemanged committed Jan 31, 2024
1 parent 6e6b05a commit 644475a
Showing 1 changed file with 9 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ public interface FlowDecompositionObserver {
void computingBaseCase();

/**
* Called when starting to compute for the contingency
* Called when a contingency computation starts
*
* @param contingencyId The current contingency id
*/
Expand All @@ -46,57 +46,57 @@ public interface FlowDecompositionObserver {
void computedGlsk(Map<Country, Map<String, Double>> glsks);

/**
* Called when net positions are computed (during base case computation)
* Called when net positions are computed (for base case computation)
*
* @param netPositions the net positions per country
*/
void computedNetPositions(Map<Country, Double> netPositions);

/**
* Called when the nodal injection matrix is computed (during n-state or contingency)
* Called when the nodal injection matrix is computed (for base case or contingency)
*
* @param nodalInjections the matrix of nodal injections indexed by(node, flow)
*/
void computedNodalInjectionsMatrix(Map<String, Map<String, Double>> nodalInjections);

/**
* Called when the PTDF matrix is computed (during n-state or contingency)
* Called when the PTDF matrix is computed (for base case or contingency)
*
* @param pdtfMatrix the matrix of ptdf indexed by (line, node)
*/
void computedPtdfMatrix(Map<String, Map<String, Double>> pdtfMatrix);

/**
* Called when the psdf matrix is computed (during n-state or contingency)
* Called when the PSDF matrix is computed (for base case or contingency)
*
* @param psdfMatrix the matrix of psdf indexed by (line, node)
*/
void computedPsdfMatrix(Map<String, Map<String, Double>> psdfMatrix);

/**
* Called when the AC nodal injections matrix is computed (during n-state or contingency)
* Called when the AC nodal injections matrix is computed (for base case or contingency)
*
* @param positions the positions after AC loadflow
* @param fallbackHasBeenActivated true if AC loadflow didn't converge
*/
void computedAcNodalInjections(Map<String, Double> positions, boolean fallbackHasBeenActivated);

/**
* Called when the DC nodal injections matrix is computed (during n-state or contingency)
* Called when the DC nodal injections matrix is computed (for base case or contingency)
*
* @param positions the positions after DC loadflow
*/
void computedDcNodalInjections(Map<String, Double> positions);

/**
* Called when the AC loadflow is computed (during n-state or contingency)
* Called when the AC loadflow is computed (for base case or contingency)
*
* @param flows the flows for all branches
*/
void computedAcFlows(Map<String, Double> flows);

/**
* Called when the DC loadflow is computed (during n-state or contingency)
* Called when the DC loadflow is computed (for base case or contingency)
*
* @param flows the flows for all branches
*/
Expand Down

0 comments on commit 644475a

Please sign in to comment.