Skip to content

Commit

Permalink
#216 Fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
Le Courtois Florent committed Dec 9, 2021
1 parent c57cae4 commit 7c8b28e
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions sources/Inputs/include/Node.h
Original file line number Diff line number Diff line change
Expand Up @@ -141,13 +141,13 @@ class Tfo {
/// @brief Topological shunt
struct Shunt {
using ShuntId = std::string; ///< alias for shunt id
using BusId = std::string; ///< Alias for bus id regulated by the shunt
using BusId = std::string; ///< Alias for bus id connected to the shunt

/**
* @brief Construct a new Shunt
*
* @param id the shunt id
* @param busId the bus regulated by the shunt
* @param busId the connected bus id
* @param targetV the target voltage of the shunt
* @param voltageRegulationOn whether voltage regulation is enabled for the shunt
* @param bs the vector of the susceptance values for the shunt
Expand Down Expand Up @@ -177,7 +177,7 @@ struct Shunt {
const BusId busId; ///< the connected bus of the shunt
const double targetV; ///< the target V of the shunt
const bool voltageRegulationOn; ///< whether voltage regulation is enabled for the shunt
const std::vector<double> bSections; ///< the vector of the B values for the shunt
const std::vector<double> bSections; ///< the vector of the susceptance values for the shunt
const unsigned int sectionNumber; ///< initial section index in sections
};

Expand Down
8 changes: 4 additions & 4 deletions sources/Outputs/include/Constants.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ namespace outputs {
/// @brief Namespace for constant variables common to all writers
namespace constants {

/// @brief Alias for map of references to shunts by regulated bus id
/// @brief Alias for map of references to shunts by connected bus id
using RefShuntsByIdMap = std::unordered_map<inputs::Shunt::BusId, std::vector<std::reference_wrapper<const inputs::Shunt>>>;

/**
Expand Down Expand Up @@ -69,7 +69,7 @@ std::string diagramFilename(const std::string& id);
/**
* @brief Retrieve the shunt regulation id
*
* @param busId the bus id to which the shunt is connected
* @param busId the connected bus id of the shunt
* @return the computed shunt regulation id
*/
static inline std::string
Expand All @@ -78,7 +78,7 @@ computeShuntRegulationId(const std::string& busId) {
}

/**
* @brief Compute the list of shunts, sorting by regulated bus id
* @brief Compute the list of shunts, sorting by connected bus id
*
* @param shuntDefinitions the shund definitions to use
* @return the sorted list of shunts
Expand All @@ -97,7 +97,7 @@ const std::string propSignalNGeneratorFixedPParId{"propSignalNGeneratorFixedP"};
const std::string remoteVControlParId{"remoteVControl"}; ///< PAR id for using remote voltage control
const std::string remoteSignalNGeneratorFixedP{"remoteSignalNFixedP"}; ///< PAR id for using remote signal N with fixed P
const std::string xmlEncoding{"UTF-8"}; ///< Default encoding for XML outputs files
const std::string diagramTableBPu{"tableBPu"}; ///< Name of the table in b sections diagram files
const std::string diagramTableBPu{"tableBPu"}; ///< Name of the table in susceptance sections diagram files

constexpr double powerValueMax = std::numeric_limits<double>::max(); ///< Maximum value for powers, meaning infinite

Expand Down
2 changes: 1 addition & 1 deletion sources/Outputs/include/Par.h
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ class Par {
/**
* @brief Write the parameters for a shunt regulation set
*
* @param busId the bus id of the shunt regulation
* @param busId the connected bus id of the shunt regulation
* @param shunts the list of the shunts for the bus
* @return the parameter set of the shunt regulation
*/
Expand Down
2 changes: 1 addition & 1 deletion sources/Outputs/src/Par.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -533,7 +533,7 @@ Par::writeShuntRegulation(const inputs::Shunt::BusId& busId, const std::vector<s

set->addParameter(helper::buildParameter("nbShunts", static_cast<int>(shunts.size())));
set->addParameter(helper::buildParameter("tNext", 10.));
set->addParameter(helper::buildParameter("URef0Pu", shunts.front().get().targetV)); // All target V for shunts regulated on same bus are the same
set->addParameter(helper::buildParameter("URef0Pu", shunts.front().get().targetV)); // All target V for shunts connected on same bus are the same
for (auto it = shunts.begin(); it != shunts.end(); ++it) {
const auto& shunt = it->get();
unsigned int index = it - shunts.begin();
Expand Down

0 comments on commit 7c8b28e

Please sign in to comment.