Skip to content

Commit

Permalink
typos in unit comments
Browse files Browse the repository at this point in the history
  • Loading branch information
eltorio committed Jan 27, 2025
1 parent 7bc2845 commit c1b50cb
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 32 deletions.
16 changes: 14 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@sctg/aga8-js",
"version": "1.0.5",
"version": "1.0.6",
"description": "WebAssembly bindings for AGA8 gas properties calculation",
"type": "module",
"main": "dist/index.js",
Expand Down Expand Up @@ -41,5 +41,8 @@
"repository": {
"type": "git",
"url": "git+https://github.com/sctg-development/aga8-js.git"
},
"dependencies": {
"@sctg/aga8-js": "^1.0.5"
}
}
58 changes: 29 additions & 29 deletions src/cpp/intellisense.patch
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@
+ * Density result
+ */
export type DensityResult = {
+ /** Density in kg/m³ */
+ /** Density in mol/L */
D: number,
+ /** Error code (0 = no error) */
ierr: number,
Expand All @@ -102,25 +102,25 @@
d2PdTD: number,
+ /** Derivative of pressure with respect to temperature */
dPdT: number,
+ /** Internal energy in J/kg */
+ /** Internal energy in J/mol */
U: number,
+ /** Enthalpy in J/kg */
+ /** Enthalpy in J/mol */
H: number,
+ /** Entropy in J/kg/K */
+ /** Entropy in J/mol/K */
S: number,
+ /** Specific heat at constant volume in J/kg/K */
+ /** Specific heat at constant volume in J/mol/K */
Cv: number,
+ /** Specific heat at constant pressure in J/kg/K */
+ /** Specific heat at constant pressure in J/mol/K */
Cp: number,
+ /** Speed of sound in m/s */
W: number,
+ /** Gibbs free energy in J/kg */
+ /** Gibbs free energy in J/mol */
G: number,
+ /** Joule-Thomson coefficient in K/kPa */
JT: number,
+ /** Isentropic exponent */
Kappa: number,
+ /** Helmholtz free energy in J/kg */
+ /** Helmholtz free energy in J/mol */
Cf: number
};

Expand All @@ -140,25 +140,25 @@
d2PdTD: number,
+ /** Derivative of pressure with respect to temperature */
dPdT: number,
+ /** Internal energy in J/kg */
+ /** Internal energy in J/mol */
U: number,
+ /** Enthalpy in J/kg */
+ /** Enthalpy in J/mol */
H: number,
+ /** Entropy in J/kg/K */
+ /** Entropy in J/mol/K */
S: number,
+ /** Specific heat at constant volume in J/kg/K */
+ /** Specific heat at constant volume in J/mol/K */
Cv: number,
+ /** Specific heat at constant pressure in J/kg/K */
+ /** Specific heat at constant pressure in J/mol/K */
Cp: number,
+ /** Speed of sound in m/s */
W: number,
+ /** Gibbs free energy in J/kg */
+ /** Gibbs free energy in J/mol */
G: number,
+ /** Joule-Thomson coefficient in K/kPa */
JT: number,
+ /** Isentropic exponent */
Kappa: number,
+ /** Helmholtz free energy in J/kg */
+ /** Helmholtz free energy in J/mol */
A: number,
+ /** Critical flow factor */
Cf: number
Expand All @@ -184,9 +184,9 @@
export type GrossHvResult = {
+ /** Gross method composition in mole fraction */
xGrs: xGrs,
+ /** Normal enthalpy in J/kg */
+ /** Normal enthalpy in J/mol */
HN: number,
+ /** Hydrocarbon enthalpy in J/kg */
+ /** Hydrocarbon enthalpy in J/mol */
HCH: number
};

Expand All @@ -198,9 +198,9 @@
xGrs: xGrs,
+ /** Relative density */
Gr: number,
+ /** Normal enthalpy in J/kg */
+ /** Normal enthalpy in J/mol */
HN: number,
+ /** Hydrocarbon enthalpy in J/kg */
+ /** Hydrocarbon enthalpy in J/mol */
HCH: number,
+ /** Error code (0 = no error) */
ierr: number,
Expand Down Expand Up @@ -230,9 +230,9 @@
xGrs: xGrs,
+ /** Molar mass in g/mol */
Mm: number,
+ /** Hydrocarbon enthalpy in J/kg */
+ /** Hydrocarbon enthalpy in J/mol */
HCH: number,
+ /** Normal enthalpy in J/kg */
+ /** Normal enthalpy in J/mol */
HN: number,
+ /** Error code (0 = no error) */
ierr: number,
Expand All @@ -246,13 +246,13 @@
export type GrossMethod2Result = {
+ /** Gross method composition in mole fraction */
xGrs: xGrs,
+ /** Enthalpy in J/kg */
+ /** Enthalpy in J/mol */
Hv: number,
+ /** Molar mass in g/mol */
Mm: number,
+ /** Hydrocarbon enthalpy in J/kg */
+ /** Hydrocarbon enthalpy in J/mol */
HCH: number,
+ /** Normal enthalpy in J/kg */
+ /** Normal enthalpy in J/mol */
HN: number,
+ /** Error code (0 = no error) */
ierr: number,
Expand Down Expand Up @@ -292,7 +292,7 @@
+ /**
+ * Calculate the pressure of a gas mixture
+ * @param T - Temperature in K
+ * @param D - Density in kg/m³
+ * @param D - Density in mol/L
+ * @param x - Gas mixture composition in mole fraction
+ * @returns {PressureResult} Pressure result
+ */
Expand All @@ -310,7 +310,7 @@
+ /**
+ * Calculate the properties of a gas mixture
+ * @param T - Temperature in K
+ * @param D - Density in kg/m³
+ * @param D - Density in mol/L
+ * @param x - Gas mixture composition in mole fraction
+ * @returns Properties detail result
+ */
Expand All @@ -332,7 +332,7 @@
+ /**
+ * Calculate the pressure of a gas mixture
+ * @param T - Temperature in K
+ * @param D - Density in kg/m³
+ * @param D - Density in mol/L
+ * @param x - Gas mixture composition in mole fraction
+ * @returns {PressureResult} Pressure result
+ */
Expand All @@ -351,7 +351,7 @@
+ /**
+ * Calculate the properties of a gas mixture
+ * @param T - Temperature in K
+ * @param D - Density in kg/m³
+ * @param D - Density in mol/L
+ * @param x - Gas mixture composition in mole fraction
+ * @returns Properties GERG result
+ */
Expand All @@ -373,7 +373,7 @@
+ /**
+ * Calculate the pressure of a gas mixture
+ * @param T - Temperature in K
+ * @param D - Density in kg/m³
+ * @param D - Density in mol/L
+ * @param x - Compositions of the equivalent hydrocarbon, nitrogen, and CO2 (mole fractions)
+ * @param HCH - Molar ideal gross heating value of the equivalent hydrocarbon (kJ/mol) at 298.15 K. Call subroutine GrossHv or GrossInputs first to obtain HCH.
+ * @returns {PressureGrossResult} Pressure result
Expand Down

0 comments on commit c1b50cb

Please sign in to comment.