Module:Gas/doc: Difference between revisions
More actions
Move gas data fields to Module:gas/data/doc |
Add documentation for Property method |
||
| Line 1: | Line 1: | ||
<includeonly>Documentation for this module can be edited at [[Module:Gas/doc]]</includeonly> | <includeonly>Documentation for this module can be edited at [[Module:Gas/doc]]</includeonly> | ||
==Methods== | ==Methods== | ||
===Lua Methods=== | |||
====GetGas==== | ====GetGas==== | ||
''Use: GetGas(User input)'' | ''Use: GetGas(User input)'' | ||
| Line 49: | Line 49: | ||
=====EvaporationTemperature===== | =====EvaporationTemperature===== | ||
''Use: EvaporationTemperatureClamped(gasTable, | ''Use: EvaporationTemperatureClamped(gasTable, Pressure) | ||
<br>'''gasTable''': a table containing information for a given gas (obtainable through [[Module: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)''. | ||
===Wikitext Methods=== | |||
=====Property===== | |||
''Use: <nowiki>{{#invoke:Gas|Property|gas|property}}</nowiki>'' | |||
<br>'''gas''': An identifier for the gas the property is being queried from. Uses [[Module:Gas/doc#GetGas|GetGas]] internally. | |||
<br>'''property''': the property for a given gas. See [[Module:Gas/data/doc]] for available property fields. | |||
==Objects== | ==Objects== | ||
Latest revision as of 02:59, 24 July 2026
Methods
Lua 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, 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 currently the same as EvaporationTemperatureUnclamped(gasTable, Pressure).
Wikitext Methods
Property
Use: {{#invoke:Gas|Property|gas|property}}
gas: An identifier for the gas the property is being queried from. Uses GetGas internally.
property: the property for a given gas. See Module:Gas/data/doc for available property fields.
Objects
Gas
A table containing data for a gas. Editing these should be done through Module:Gas/data.
Fields
See Module:Gas/data/doc.