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

Add/rename electric quantities #1444

Merged
merged 11 commits into from
Dec 28, 2024
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Common/UnitDefinitions/ApparentEnergy.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
"Name": "ApparentEnergy",
"BaseUnit": "VoltampereHour",
"XmlDocSummary": "A unit for expressing the integral of apparent power over time, equal to the product of 1 volt-ampere and 1 hour, or to 3600 joules.",
"XmlDocRemarks": "<see cref=\"ApparentEnergy\" /> has been renamed to <see cref=\"ElectricApparentEnergy\" />, and will be removed in a later major version.",
"ObsoleteText": "ApparentEnergy has been renamed to ElectricApparentEnergy, and will be removed in a later major version.",
"BaseDimensions": {
"L": 2,
"M": 1,
Expand Down
2 changes: 2 additions & 0 deletions Common/UnitDefinitions/ApparentPower.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
"Name": "ApparentPower",
"BaseUnit": "Voltampere",
"XmlDocSummary": "Power engineers measure apparent power as the magnitude of the vector sum of active and reactive power. Apparent power is the product of the root-mean-square of voltage and current.",
"XmlDocRemarks": "<see cref=\"ApparentPower\" /> has been renamed to <see cref=\"ElectricApparentPower\" />, and will be removed in a later major version.",
"ObsoleteText": "ApparentPower has been renamed to ElectricApparentPower, and will be removed in a later major version.",
"BaseDimensions": {
"L": 2,
"M": 1,
Expand Down
3 changes: 2 additions & 1 deletion Common/UnitDefinitions/Capacitance.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
"Name": "Capacitance",
"BaseUnit": "Farad",
"XmlDocSummary": "Capacitance is the ability of a body to store an electric charge.",
"XmlDocRemarks": "https://en.wikipedia.org/wiki/Capacitance",
"XmlDocRemarks": "<see cref=\"Capacitance\" /> has been renamed to <see cref=\"ElectricCapacitance\" />, and will be removed in a later major version.",
"ObsoleteText": "Capacitance has been renamed to ElectricCapacitance, and will be removed in a later major version.",
"BaseDimensions": {
"L": -2,
"M": -1,
Expand Down
19 changes: 17 additions & 2 deletions Common/UnitDefinitions/ElectricAdmittance.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
{
"Name": "ElectricAdmittance",
"BaseUnit": "Siemens",
"XmlDocSummary": "Electric admittance is a measure of how easily a circuit or device will allow a current to flow. It is defined as the inverse of impedance. The SI unit of admittance is the siemens (symbol S).",
"XmlDocSummary": "Electric admittance is a measure of how easily a circuit or device will allow a current to flow by the combined effect of conductance and susceptance in a circuit. It is defined as the inverse of impedance. The SI unit of admittance is the siemens (symbol S).",
"XmlDocRemarks": "https://en.wikipedia.org/wiki/Electrical_admittance",
"ObsoleteText": "Admittance is a complex number, which is not currently supported by UnitsNet. Please use either ElectricConductance or ElectricSusceptance instead.",
angularsen marked this conversation as resolved.
Show resolved Hide resolved
"BaseDimensions": {
"L": -2,
"M": -1,
Expand All @@ -14,13 +16,26 @@
"PluralName": "Siemens",
"FromUnitToBaseFunc": "{x}",
"FromBaseToUnitFunc": "{x}",
"Prefixes": [ "Nano", "Micro", "Milli" ],
"Prefixes": [ "Nano", "Micro", "Milli", "Kilo", "Mega", "Giga", "Tera" ],
"Localization": [
{
"Culture": "en-US",
"Abbreviations": [ "S" ]
}
]
},
{
"SingularName": "Mho",
"PluralName": "Mhos",
"FromUnitToBaseFunc": "{x}",
"FromBaseToUnitFunc": "{x}",
"Prefixes": [ "Nano", "Micro", "Milli", "Kilo", "Mega", "Giga", "Tera" ],
"Localization": [
{
"Culture": "en-US",
"Abbreviations": [ "" ]
}
]
}
]
}
25 changes: 25 additions & 0 deletions Common/UnitDefinitions/ElectricApparentEnergy.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"Name": "ElectricApparentEnergy",
"BaseUnit": "VoltampereHour",
"XmlDocSummary": "A unit for expressing the integral of apparent power over time, equal to the product of 1 volt-ampere and 1 hour, or to 3600 joules.",
"BaseDimensions": {
"L": 2,
"M": 1,
"T": -2
},
"Units": [
{
"SingularName": "VoltampereHour",
"PluralName": "VoltampereHours",
"FromUnitToBaseFunc": "{x}",
"FromBaseToUnitFunc": "{x}",
"Prefixes": [ "Kilo", "Mega" ],
"Localization": [
{
"Culture": "en-US",
"Abbreviations": [ "VAh" ]
}
]
}
]
}
26 changes: 26 additions & 0 deletions Common/UnitDefinitions/ElectricApparentPower.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"Name": "ElectricApparentPower",
"BaseUnit": "Voltampere",
"XmlDocSummary": "Power engineers measure apparent power as the magnitude of the vector sum of active and reactive power. It is the product of the root mean square voltage (in volts) and the root mean square current (in amperes).",
"XmlDocRemarks": "https://en.wikipedia.org/wiki/AC_power#Active,_reactive,_apparent,_and_complex_power_in_sinusoidal_steady-state",
"BaseDimensions": {
"L": 2,
"M": 1,
"T": -3
},
"Units": [
{
"SingularName": "Voltampere",
"PluralName": "Voltamperes",
"FromUnitToBaseFunc": "{x}",
"FromBaseToUnitFunc": "{x}",
"Prefixes": [ "Micro", "Milli", "Kilo", "Mega", "Giga" ],
"Localization": [
{
"Culture": "en-US",
"Abbreviations": [ "VA" ]
}
]
}
]
}
33 changes: 33 additions & 0 deletions Common/UnitDefinitions/ElectricCapacitance.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{
"Name": "ElectricCapacitance",
"BaseUnit": "Farad",
"XmlDocSummary": "Capacitance is the capacity of a material object or device to store electric charge.",
"XmlDocRemarks": "https://en.wikipedia.org/wiki/Capacitance",
"BaseDimensions": {
"L": -2,
"M": -1,
"T": 4,
"I": 2
},
"Units": [
{
"SingularName": "Farad",
"PluralName": "Farads",
"BaseUnits": {
"L": "Meter",
"M": "Kilogram",
"T": "Second",
"I": "Ampere"
},
"FromUnitToBaseFunc": "{x}",
"FromBaseToUnitFunc": "{x}",
"Prefixes": [ "Pico", "Nano", "Micro", "Milli", "Kilo", "Mega" ],
"Localization": [
{
"Culture": "en-US",
"Abbreviations": [ "F" ]
}
]
}
]
}
17 changes: 15 additions & 2 deletions Common/UnitDefinitions/ElectricConductance.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"Name": "ElectricConductance",
"BaseUnit": "Siemens",
"XmlDocSummary": "The electrical conductance of an electrical conductor is a measure of the easeness to pass an electric current through that conductor.",
"XmlDocSummary": "The electrical conductance of an object is a measure of the ease with which an electric current passes. Along with susceptance, it is one of two elements of admittance. Its reciprocal quantity is electrical resistance.",
"XmlDocRemarks": "https://en.wikipedia.org/wiki/Electrical_resistance_and_conductance",
"BaseDimensions": {
"L": -2,
Expand All @@ -15,13 +15,26 @@
"PluralName": "Siemens",
"FromUnitToBaseFunc": "{x}",
"FromBaseToUnitFunc": "{x}",
"Prefixes": [ "Nano", "Micro", "Milli", "Kilo" ],
"Prefixes": [ "Nano", "Micro", "Milli", "Kilo", "Mega", "Giga", "Tera" ],
"Localization": [
{
"Culture": "en-US",
"Abbreviations": [ "S" ]
}
]
},
{
"SingularName": "Mho",
"PluralName": "Mhos",
"FromUnitToBaseFunc": "{x}",
"FromBaseToUnitFunc": "{x}",
"Prefixes": [ "Nano", "Micro", "Milli", "Kilo", "Mega", "Giga", "Tera" ],
"Localization": [
{
"Culture": "en-US",
"Abbreviations": [ "℧" ]
}
]
}
]
}
1 change: 1 addition & 0 deletions Common/UnitDefinitions/ElectricCurrent.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"Name": "ElectricCurrent",
"BaseUnit": "Ampere",
"XmlDocSummary": "An electric current is a flow of electric charge. In electric circuits this charge is often carried by moving electrons in a wire. It can also be carried by ions in an electrolyte, or by both ions and electrons such as in a plasma.",
"XmlDocRemarks": "If you want to map more parameters into the <see cref=\"ElectricCurrent\" /> class (amps RMS, phase angle, etc.), create your own wrapper type such as a record or named tuple.",
"BaseDimensions": {
"I": 1
},
Expand Down
28 changes: 28 additions & 0 deletions Common/UnitDefinitions/ElectricImpedance.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"Name": "ElectricImpedance",
"BaseUnit": "Ohm",
"XmlDocSummary": "Electric impedance is the opposition to alternating current presented by the combined effect of resistance and reactance in a circuit. It is defined as the inverse of admittance. The SI unit of impedance is the ohm (symbol Ω).",
"XmlDocRemarks": "https://en.wikipedia.org/wiki/Electrical_impedance",
"ObsoleteText": "Impedance is a complex number, which is not currently supported by UnitsNet. Please use either ElectricResistance or ElectricReactance instead.",
angularsen marked this conversation as resolved.
Show resolved Hide resolved
"BaseDimensions": {
"L": 2,
"M": 1,
"T": -3,
"I": -2
},
"Units": [
{
"SingularName": "Ohm",
"PluralName": "Ohms",
"FromUnitToBaseFunc": "{x}",
"FromBaseToUnitFunc": "{x}",
"Prefixes": [ "Nano", "Micro", "Milli", "Kilo", "Mega", "Giga", "Tera" ],
"Localization": [
{
"Culture": "en-US",
"Abbreviations": [ "Ω" ]
}
]
}
]
}
1 change: 1 addition & 0 deletions Common/UnitDefinitions/ElectricPotential.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"Name": "ElectricPotential",
"BaseUnit": "Volt",
"XmlDocSummary": "In classical electromagnetism, the electric potential (a scalar quantity denoted by Φ, ΦE or V and also called the electric field potential or the electrostatic potential) at a point is the amount of electric potential energy that a unitary point charge would have when located at that point.",
"XmlDocRemarks": "If you want to map more parameters into the <see cref=\"ElectricPotential\" /> class (volts RMS, phase angle, etc.), create your own wrapper type such as a record or named tuple.",
"BaseDimensions": {
"L": 2,
"M": 1,
Expand Down
2 changes: 2 additions & 0 deletions Common/UnitDefinitions/ElectricPotentialAc.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
"Name": "ElectricPotentialAc",
"BaseUnit": "VoltAc",
"XmlDocSummary": "The Electric Potential of a system known to use Alternating Current.",
"XmlDocRemarks": "<see cref=\"ElectricPotentialAc\" /> has been merged into <see cref=\"ElectricPotential\" />, and will be removed in a later major version. If you want to map more parameters into the <see cref=\"ElectricPotential\" /> class (volts RMS, phase angle, etc.), create your own wrapper type such as a record or named tuple.",
"ObsoleteText": "ElectricPotentialAc has been merged into ElectricPotential, and will be removed in a later major version. If you want to map more parameters into the ElectricPotential class (volts RMS, phase angle, etc.), create your own wrapper type such as a record or named tuple.",
"Units": [
{
"SingularName": "VoltAc",
Expand Down
2 changes: 2 additions & 0 deletions Common/UnitDefinitions/ElectricPotentialDc.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
"Name": "ElectricPotentialDc",
"BaseUnit": "VoltDc",
"XmlDocSummary": "The Electric Potential of a system known to use Direct Current.",
"XmlDocRemarks": "<see cref=\"ElectricPotentialDc\" /> has been merged into <see cref=\"ElectricPotential\" />, and will be removed in a later major version. If you want to map more parameters into the <see cref=\"ElectricPotential\" /> class (volts RMS, phase angle, etc.), create your own wrapper type such as a record or named tuple.",
"ObsoleteText": "ElectricPotentialDc has been merged into ElectricPotential, and will be removed in a later major version. If you want to map more parameters into the ElectricPotential class (volts RMS, phase angle, etc.), create your own wrapper type such as a record or named tuple.",
"Units": [
{
"SingularName": "VoltDc",
Expand Down
27 changes: 27 additions & 0 deletions Common/UnitDefinitions/ElectricReactance.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"Name": "ElectricReactance",
"BaseUnit": "Ohm",
"XmlDocSummary": "In electrical circuits, reactance is the opposition presented to alternating current by inductance and capacitance. Along with resistance, it is one of two elements of impedance.",
"XmlDocRemarks": "https://en.wikipedia.org/wiki/Electrical_reactance",
"BaseDimensions": {
"L": 2,
"M": 1,
"T": -3,
"I": -2
},
"Units": [
{
"SingularName": "Ohm",
"PluralName": "Ohms",
"FromUnitToBaseFunc": "{x}",
"FromBaseToUnitFunc": "{x}",
"Prefixes": [ "Nano", "Micro", "Milli", "Kilo", "Mega", "Giga", "Tera" ],
"Localization": [
{
"Culture": "en-US",
"Abbreviations": [ "Ω" ]
}
]
}
]
}
25 changes: 25 additions & 0 deletions Common/UnitDefinitions/ElectricReactiveEnergy.json
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is the Joule an applicable / useful unit for this quantity? If yes- then it would allow us to have an SI unit for #1463

Copy link
Collaborator

Choose a reason for hiding this comment

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

Sorry, I actually meant to comment on #1467 but got my tabs confused..

Copy link
Collaborator

Choose a reason for hiding this comment

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

Alternatively VoltampereReactiveSecond would also do the trick, if you think it's a better fit (note, we don't have any rules about it- if you think neither units make sense, we could just [Skip] the tests and deal with it later).

Copy link
Owner

Choose a reason for hiding this comment

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

I'll merge this now, we can still add this unit later if it makes sense.

Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"Name": "ElectricReactiveEnergy",
"BaseUnit": "VoltampereReactiveHour",
"XmlDocSummary": "The volt-ampere reactive hour (expressed as varh) is the reactive power of one Volt-ampere reactive produced in one hour.",
"BaseDimensions": {
"L": 2,
"M": 1,
"T": -1
angularsen marked this conversation as resolved.
Show resolved Hide resolved
},
"Units": [
{
"SingularName": "VoltampereReactiveHour",
"PluralName": "VoltampereReactiveHours",
"FromUnitToBaseFunc": "{x}",
"FromBaseToUnitFunc": "{x}",
"Prefixes": [ "Kilo", "Mega" ],
"Localization": [
{
"Culture": "en-US",
"Abbreviations": [ "varh" ]
}
]
}
]
}
26 changes: 26 additions & 0 deletions Common/UnitDefinitions/ElectricReactivePower.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"Name": "ElectricReactivePower",
"BaseUnit": "VoltampereReactive",
"XmlDocSummary": "In electric power transmission and distribution, volt-ampere reactive (var) is a unit of measurement of reactive power. Reactive power exists in an AC circuit when the current and voltage are not in phase.",
"XmlDocRemarks": "https://en.wikipedia.org/wiki/AC_power#Active,_reactive,_apparent,_and_complex_power_in_sinusoidal_steady-state",
"BaseDimensions": {
"L": 2,
"M": 1,
"T": -3
},
"Units": [
{
"SingularName": "VoltampereReactive",
"PluralName": "VoltamperesReactive",
"FromUnitToBaseFunc": "{x}",
"FromBaseToUnitFunc": "{x}",
"Prefixes": [ "Kilo", "Mega", "Giga" ],
"Localization": [
{
"Culture": "en-US",
"Abbreviations": [ "var" ]
}
]
}
]
}
5 changes: 3 additions & 2 deletions Common/UnitDefinitions/ElectricResistance.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
{
"Name": "ElectricResistance",
"BaseUnit": "Ohm",
"XmlDocSummary": "The electrical resistance of an electrical conductor is the opposition to the passage of an electric current through that conductor.",
"XmlDocSummary": "The electrical resistance of an object is a measure of its opposition to the flow of electric current. Along with reactance, it is one of two elements of impedance. Its reciprocal quantity is electrical conductance.",
"XmlDocRemarks": "https://en.wikipedia.org/wiki/Electrical_resistance_and_conductance",
"BaseDimensions": {
"L": 2,
"M": 1,
Expand All @@ -14,7 +15,7 @@
"PluralName": "Ohms",
"FromUnitToBaseFunc": "{x}",
"FromBaseToUnitFunc": "{x}",
"Prefixes": [ "Micro", "Milli", "Kilo", "Mega", "Giga", "Tera" ],
"Prefixes": [ "Nano", "Micro", "Milli", "Kilo", "Mega", "Giga", "Tera" ],
"Localization": [
{
"Culture": "en-US",
Expand Down
40 changes: 40 additions & 0 deletions Common/UnitDefinitions/ElectricSusceptance.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
{
"Name": "ElectricSusceptance",
"BaseUnit": "Siemens",
"XmlDocSummary": "Electrical susceptance is the imaginary part of admittance, where the real part is conductance.",
"XmlDocRemarks": "https://en.wikipedia.org/wiki/Electrical_susceptance",
"BaseDimensions": {
"L": -2,
"M": -1,
"T": 3,
"I": 2
},
"Units": [
{
"SingularName": "Siemens",
"PluralName": "Siemens",
"FromUnitToBaseFunc": "{x}",
"FromBaseToUnitFunc": "{x}",
"Prefixes": [ "Nano", "Micro", "Milli", "Kilo", "Mega", "Giga", "Tera" ],
"Localization": [
{
"Culture": "en-US",
"Abbreviations": [ "S" ]
}
]
},
{
"SingularName": "Mho",
"PluralName": "Mhos",
"FromUnitToBaseFunc": "{x}",
"FromBaseToUnitFunc": "{x}",
"Prefixes": [ "Nano", "Micro", "Milli", "Kilo", "Mega", "Giga", "Tera" ],
"Localization": [
{
"Culture": "en-US",
"Abbreviations": [ "" ]
}
]
}
]
}
Loading