Module:Gas/doc: Difference between revisions
More actions
Initial documentation |
Move gas data fields to Module:gas/data/doc |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<includeonly>Documentation for this module can be edited at [[Module:Gas/doc]]</includeonly> | |||
==Methods== | ==Methods== | ||
| Line 4: | Line 5: | ||
''Use: GetGas(User input)'' | ''Use: GetGas(User input)'' | ||
Returns a | Returns a read-only [[Module:Gas/doc#Gas|Gas]] object containing information for a given gas. | ||
If no gas is found that can match the input, throws an error. | If no gas is found that can match the input, throws an error. | ||
| Line 13: | Line 14: | ||
=====EvaporationPressureUnclamped===== | =====EvaporationPressureUnclamped===== | ||
''Use: EvaporationPressureClamped(gasTable, Temperature) | ''Use: EvaporationPressureClamped(gasTable, Temperature) | ||
<br>'''gasTable''': a table containing information for a given gas (obtainable through [[Gas/doc#GetGas|GetGas]]) | <br>'''gasTable''': a table containing information for a given gas (obtainable through [[Module:Gas/doc#GetGas|GetGas]]) | ||
<br>'''Temperature''': The current gas gemperature in kelvin | <br>'''Temperature''': The current gas gemperature in kelvin | ||
| Line 20: | Line 21: | ||
=====EvaporationPressureClamped===== | =====EvaporationPressureClamped===== | ||
''Use: EvaporationPressureUnclamped(gasTable, Temperature) | ''Use: EvaporationPressureUnclamped(gasTable, Temperature) | ||
<br>'''gasTable''': a table containing information for a given gas (obtainable through [[Gas/doc#GetGas|GetGas]]) | <br>'''gasTable''': a table containing information for a given gas (obtainable through [[Module:Gas/doc#GetGas|GetGas]]) | ||
<br>'''Temperature''': The current gas gemperature in kelvin | <br>'''Temperature''': The current gas gemperature in kelvin | ||
| Line 27: | Line 28: | ||
=====EvaporationPressure===== | =====EvaporationPressure===== | ||
''Use: EvaporationPressure(gasTable, Temperature) | ''Use: EvaporationPressure(gasTable, Temperature) | ||
<br>'''gasTable''': a table containing information for a given gas (obtainable through [[Gas/doc#GetGas|GetGas]]) | <br>'''gasTable''': a table containing information for a given gas (obtainable through [[Module:Gas/doc#GetGas|GetGas]]) | ||
<br>'''Temperature''': The current gas gemperature in kelvin | <br>'''Temperature''': The current gas gemperature in kelvin | ||
| Line 35: | Line 36: | ||
=====EvaporationTemperatureUnclamped===== | =====EvaporationTemperatureUnclamped===== | ||
''Use: EvaporationPressureUnclamped(gasTable, Pressure) | ''Use: EvaporationPressureUnclamped(gasTable, Pressure) | ||
<br>'''gasTable''': a table containing information for a given gas (obtainable through [[Gas/doc#GetGas|GetGas]]) | <br>'''gasTable''': a table containing information for a given gas (obtainable through [[Module:Gas/doc#GetGas|GetGas]]) | ||
<br>'''Pressure''': The current gas pressure in kPa | <br>'''Pressure''': The current gas pressure in kPa | ||
| Line 42: | Line 43: | ||
=====EvaporationTemperatureClamped===== | =====EvaporationTemperatureClamped===== | ||
''Use: EvaporationTemperatureClamped(gasTable, Pressure) | ''Use: EvaporationTemperatureClamped(gasTable, Pressure) | ||
<br>'''gasTable''': a table containing information for a given gas (obtainable through [[Gas/doc#GetGas|GetGas]]) | <br>'''gasTable''': a table containing information for a given gas (obtainable through [[Module:Gas/doc#GetGas|GetGas]]) | ||
<br>'''Pressure''': The current gas pressure in kPa | <br>'''Pressure''': The current gas pressure in kPa | ||
| Line 49: | Line 50: | ||
=====EvaporationTemperature===== | =====EvaporationTemperature===== | ||
''Use: EvaporationTemperatureClamped(gasTable, Temperature) | ''Use: EvaporationTemperatureClamped(gasTable, Temperature) | ||
<br>'''gasTable''': a table containing information for a given gas (obtainable through [[Gas/doc#GetGas|GetGas]]) | <br>'''gasTable''': a table containing information for a given gas (obtainable through [[Module:Gas/doc#GetGas|GetGas]]) | ||
<br>'''Pressure''': The current gas pressure in kPa | <br>'''Pressure''': The current gas pressure in kPa | ||
Evaluates the gas's evaporation pressure curve for a given ''Pressure'', returning its corresponding evaporation temperature in kelvin. This is currently the same as ''EvaporationTemperatureUnclamped(gasTable, Pressure)''. | Evaluates the gas's evaporation pressure curve for a given ''Pressure'', returning its corresponding evaporation temperature in kelvin. This is currently the same as ''EvaporationTemperatureUnclamped(gasTable, Pressure)''. | ||
==Objects== | |||
====Gas==== | |||
A table containing data for a gas. Editing these should be done through [[Module:Gas/data]]. | |||
=====Fields===== | |||
See [[Module:Gas/data/doc]]. | |||
Latest revision as of 01:30, 14 March 2026
Methods
GetGas
Use: GetGas(User input)
Returns a read-only Gas object containing information for a given gas.
If no gas is found that can match the input, throws an error.
Phase change methods
Evaporation Pressure
EvaporationPressureUnclamped
Use: EvaporationPressureClamped(gasTable, Temperature)
gasTable: a table containing information for a given gas (obtainable through GetGas)
Temperature: The current gas gemperature in kelvin
Evaluates the gas's evaporation pressure curve for a given Temperature, returning its corresponding evaporation pressure in kPa. This is just the curve function without any compensation for phase change characteristics.
EvaporationPressureClamped
Use: EvaporationPressureUnclamped(gasTable, Temperature)
gasTable: a table containing information for a given gas (obtainable through GetGas)
Temperature: The current gas gemperature in kelvin
Evaluates the gas's evaporation pressure curve for a given Temperature, returning its corresponding evaporation pressure in kPa. Unlike EvaporationPressureClamped, this first clamps the input temperature to values within the range where the gas can exist as a non-frozen liquid.
EvaporationPressure
Use: EvaporationPressure(gasTable, Temperature)
gasTable: a table containing information for a given gas (obtainable through GetGas)
Temperature: The current gas gemperature in kelvin
Evaluates the gas's evaporation pressure curve for a given Temperature, returning its corresponding evaporation pressure in kPa. Unlike the other methods, this provides additional handling to return the evaporation pressure for supercooled liquids when given a liquid as input.
Evaporation Temperature
EvaporationTemperatureUnclamped
Use: EvaporationPressureUnclamped(gasTable, Pressure)
gasTable: a table containing information for a given gas (obtainable through GetGas)
Pressure: The current gas pressure in kPa
Evaluates the gas's evaporation pressure curve for a given Pressure, returning its corresponding evaporation temperature in kelvin. This is just the curve function without any compensation for phase change characteristics.
EvaporationTemperatureClamped
Use: EvaporationTemperatureClamped(gasTable, Pressure)
gasTable: a table containing information for a given gas (obtainable through GetGas)
Pressure: The current gas pressure in kPa
Evaluates the gas's evaporation pressure curve for a given Pressure, returning its corresponding evaporation temperature in kelvin. Pressure values are clamped to the range of values the gas can exist as a non-frozen, non-supercritical liquid.
EvaporationTemperature
Use: EvaporationTemperatureClamped(gasTable, Temperature)
gasTable: a table containing information for a given gas (obtainable through GetGas)
Pressure: The current gas pressure in kPa
Evaluates the gas's evaporation pressure curve for a given Pressure, returning its corresponding evaporation temperature in kelvin. This is currently the same as EvaporationTemperatureUnclamped(gasTable, Pressure).
Objects
Gas
A table containing data for a gas. Editing these should be done through Module:Gas/data.
Fields
See Module:Gas/data/doc.