Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation of AronSensor #3186

Merged
merged 11 commits into from
Dec 15, 2019
Merged

Update documentation of AronSensor #3186

merged 11 commits into from
Dec 15, 2019

Conversation

max-privato
Copy link
Contributor

Proposed the following documentation changes:

  1. removed reference to the need to have sinusoidal voltages and currents (Aron sensor works with any shape of voltages and currents)
  2. added basic explanation of the Aron connection and a reference.

Proposed the following documentation changes:
1) removed reference to the need to have sinusoidal voltages and currents (Aron sensor works with any shape of voltages and currents)
2) added basic explanation of the Aron connection and a reference.
@beutlich beutlich added the L: Electrical.Polyphase Issue addresses Modelica.Electrical.Polyhase label Nov 1, 2019
@beutlich beutlich self-assigned this Nov 1, 2019
@beutlich beutlich added this to the MSL4.0.0 milestone Nov 1, 2019
Copy link
Member

@beutlich beutlich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

HTML Tags are not balanced.

@beutlich beutlich added the documentation Issue addresses the documentation label Nov 1, 2019
@christiankral
Copy link
Contributor

I would very much appreciate @AHaumer review here as he agreed to make a review and as this PR modifies the documentation of the model he developed.

Copy link
Contributor

@AHaumer AHaumer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please correct:
This device works only for in three-phase systems without neutral.
We could add:
In case of a three-phase system without neutral (i.e. the sum of the three currrents is zero) ...

@AHaumer
Copy link
Contributor

AHaumer commented Nov 12, 2019

@max-privato Please correct the typo:
Either "This device works only for three-phase systems without neutral" or "This device works only in three-phase systems without neutral".

Just one short summary (that would be sufficient for documenation - and much mor concise!):
Two subcircuits are linked by n connecting lines. The sum of these n currents has to be zero. If we use one of the connecting lines as reference potential, n-1 wattmeters are sufficient to determine the total power transfer between the subsystems.
To illustrate the principle:
In case of three-phase systems with 4 connection lines (inluding neutral) we need 3 wattmeters.
In case of three-phase systems with 3 connection lines (without neutral) we need only 2 wattmeters (the AronSensor).

@max-privato
Copy link
Contributor Author

Typo corrected.

Just one short summary (that would be sufficient for documenation - and much mor concise!):
[...]

Info can be more detailed or more concise.
It depends on the style one prefers. Pursuing conciseness allows faster reading, using more details with formulas makes understanding deeper.
In case the Modelica choice is towards conciseness, your text is the best, otherwise (IMO) mine.

I proposed a rather detailed description because I was asked to add some biblio reference. Adding a reference discussing the Aron connection seemed to me overkill. I preferred an in-model description of it that, being in competition with a biblio reference, must be detailed and precise enough.
Therefore I added (what I think is) a technically sound description, with a biblio reference pointing to the very roots behind it.

For me, both solutions (I mean AHaumer's and mine) are good enough. I leave to the Library managers the final choice.

@beutlich
Copy link
Member

@AHaumer @christiankral What is left to do here?

Copy link
Contributor

@AHaumer AHaumer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For me the documentation is fine now.

to be equivalent with the Analog implementation
@christiankral
Copy link
Contributor

@max-privato please merge https://github.com/max-privato/ModelicaStandardLibrary/pull/2 so that we have the same documentation in the Analog and QuasiStatic.SinglePhase package.

Copy link
Contributor

@christiankral christiankral left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@christiankral
Copy link
Contributor

One more note: the Aron sensor could also be extended so that it works with an arbitrary number of phases, considering that there is no neutral connected. So the limitation to m=3 is actually not required.

Aron sensor documentation for quasi stastic domain
@beutlich beutlich requested review from christiankral and beutlich and removed request for beutlich December 11, 2019 09:38
@beutlich beutlich merged commit fec8159 into modelica:master Dec 15, 2019
@beutlich beutlich changed the title Update AronSensor.mo Update documentation of AronSensor Dec 15, 2019
@beutlich beutlich added the L: Electrical.QuasiStatic Issue addresses Modelica.Electrical.QuasiStatic label Dec 15, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issue addresses the documentation L: Electrical.Polyphase Issue addresses Modelica.Electrical.Polyhase L: Electrical.QuasiStatic Issue addresses Modelica.Electrical.QuasiStatic
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants