gas_mixture

Vars
gc_share	Whether to call garbage_collect() on the sharer during shares, used for immutable mixtures
last_share	The last tick this gas mixture shared on. A counter that turfs use to manage activity
pipeline_cycle	When this gas mixture was last touched by pipeline processing I am sorry
reaction_results	Tells us what reactions have happened in our gasmix. Assoc list of reaction - moles reacted pair.
temperature	The temperature of the gas mix in kelvin. Should never be lower then TCMB
temperature_archived	Used, like all archived variables, to ensure turf sharing is consistent inside a tick, no matter The order of operations
volume	Volume in liters (duh)
Procs
add_gas	add_gas(gas_id) - similar to assert_gas(), but does not check for an existing gas list for this id. This can clobber existing gases. Used instead of assert_gas() when you know the gas does not exist. Faster than assert_gas().
add_gases	add_gases(args) - shorthand for calling add_gas() once for each gas_type.
archive	Update archived versions of variables. Returns: 1 in all cases
assert_gas	assert_gas(gas_id) - used to guarantee that the gas list for this id exists in gas_mixture.gases. Must be used before adding to a gas. May be used before reading from a gas.
assert_gases	assert_gases(args) - shorthand for calling ASSERT_GAS() once for each gas type.
compare	Compares sample to self to see if within acceptable ranges that group processing may be enabled Takes the gas index to read from as a second arg (either MOLES or ARCHIVE) Returns: a string indicating what check failed, or "" if check passes
copy	Creates new, identical gas mixture Returns: duplicate gas mixture
copy_from	Copies variables from sample Returns: TRUE if we are mutable, FALSE otherwise
copy_from_ratio	Copies variables from sample, moles multiplicated by partial Returns: TRUE if we are mutable, FALSE otherwise
equalize	Distributes the contents of two mixes equally between themselves
garbage_collect	garbage_collect() - removes any gas list which is empty. If called with a list as an argument, only removes gas lists with IDs from that list. Must be used after subtracting from a gas. Must be used after assert_gas() if assert_gas() was called only to read from the gas. By removing empty gases, processing speed is increased.
gas_pressure_approximate	Approximation of the quadratic equation using Newton-Raphson's Method. We use the slope of an approximate value to get closer to the root of a given equation.
gas_pressure_calculate
gas_pressure_minimum_transfer	Counts how much pressure will there be if we impart MOLAR_ACCURACY amounts of our gas to the output gasmix. We do all of this without actually transferring it so don't worry about it changing the gasmix. Returns: Resulting pressure (number). Args:
gas_pressure_quadratic	Actually tries to solve the quadratic equation. Do mind that the numbers can get very big and might hit BYOND's single point float limit.
get_breath_partial_pressure	Returns the partial pressure of the gas in the breath based on BREATH_VOLUME eg: Plas_PP = get_breath_partial_pressure(gas_mixture.gases/datum/gas/plasma) O2_PP = get_breath_partial_pressure(gas_mixture.gases/datum/gas/oxygen) get_breath_partial_pressure(gas_mole_count) --> PV = nRT, P = nRT/V
has_gas	Checks to see if gas amount exists in mixture. Do NOT use this in code where performance matters! It's better to batch calls to garbage_collect(), especially in places where you're checking many gastypes
heat_capacity	joules per kelvin
merge	Merges all air from giver into self. Deletes giver. Returns: 1 if we are mutable, 0 otherwise
pump_gas_to	Pumps gas from src to output_air. Amount depends on target_pressure
react	Performs various reactions such as combustion and fabrication Returns: 1 if any reaction took place; 0 otherwise
release_gas_to	Releases gas from src to output air. This means that it can not transfer air to gas mixture with higher pressure.
remove	Proportionally removes amount of gas from the gas_mixture. Returns: gas_mixture with the gases removed
remove_ratio	Proportionally removes amount of gas from the gas_mixture. Returns: gas_mixture with the gases removed
remove_specific	Removes an amount of a specific gas from the gas_mixture. Returns: gas_mixture with the gas removed
return_pressure	Calculate pressure in kilopascals
return_temperature	Calculate temperature in kelvins
return_visuals	Gets the gas visuals for everything in this mixture
return_volume	Calculate volume in liters
share	Performs air sharing calculations between two gas_mixtures share() is communitive, which means A.share(B) needs to be the same as B.share(A) If we don't retain this, we will get negative moles. Don't do it Returns: amount of gas exchanged (+ if sharer received)
temperature_share	Performs temperature sharing calculations (via conduction) between two gas_mixtures assuming only 1 boundary length Returns: new temperature of the sharer
thermal_energy	Calculate thermal energy in joules
total_moles	Calculate moles

Var Details

var
gc_share
–

Whether to call garbage_collect() on the sharer during shares, used for immutable mixtures

var
last_share
–

The last tick this gas mixture shared on. A counter that turfs use to manage activity

var
pipeline_cycle
–

When this gas mixture was last touched by pipeline processing I am sorry

var
reaction_results
– /list

Tells us what reactions have happened in our gasmix. Assoc list of reaction - moles reacted pair.

var
temperature
–

The temperature of the gas mix in kelvin. Should never be lower then TCMB

var
temperature_archived
– /tmp

Used, like all archived variables, to ensure turf sharing is consistent inside a tick, no matter The order of operations

var
volume
–

Volume in liters (duh)

Proc Details

proc
add_gas
(gas_id)

add_gas(gas_id) - similar to assert_gas(), but does not check for an existing gas list for this id. This can clobber existing gases. Used instead of assert_gas() when you know the gas does not exist. Faster than assert_gas().

proc
add_gases
(...)

add_gases(args) - shorthand for calling add_gas() once for each gas_type.

proc
archive
()

Update archived versions of variables. Returns: 1 in all cases

proc
assert_gas
(gas_id)

assert_gas(gas_id) - used to guarantee that the gas list for this id exists in gas_mixture.gases. Must be used before adding to a gas. May be used before reading from a gas.

proc
assert_gases
(...)

assert_gases(args) - shorthand for calling ASSERT_GAS() once for each gas type.

proc
compare
(/datum/gas_mixture/sample, index)

Compares sample to self to see if within acceptable ranges that group processing may be enabled Takes the gas index to read from as a second arg (either MOLES or ARCHIVE) Returns: a string indicating what check failed, or "" if check passes

proc
copy
()

Creates new, identical gas mixture Returns: duplicate gas mixture

proc
copy_from
(/datum/gas_mixture/sample)

Copies variables from sample Returns: TRUE if we are mutable, FALSE otherwise

proc
copy_from_ratio
(/datum/gas_mixture/sample, partial)

Copies variables from sample, moles multiplicated by partial Returns: TRUE if we are mutable, FALSE otherwise

proc
equalize
(/datum/gas_mixture/other)

Distributes the contents of two mixes equally between themselves

proc
garbage_collect
(/list/tocheck)

garbage_collect() - removes any gas list which is empty. If called with a list as an argument, only removes gas lists with IDs from that list. Must be used after subtracting from a gas. Must be used after assert_gas() if assert_gas() was called only to read from the gas. By removing empty gases, processing speed is increased.

proc
gas_pressure_approximate
(a, b, c, lower_limit, upper_limit)

Approximation of the quadratic equation using Newton-Raphson's Method. We use the slope of an approximate value to get closer to the root of a given equation.

proc
gas_pressure_calculate
(/datum/gas_mixture/output_air, target_pressure, ignore_temperature)

Returns the amount of gas to be pumped to a specific container.
Args:
- output_air. The gas mix we want to pump to.
- target_pressure. The target pressure we want.
- ignore_temperature. Returns a cheaper form of gas calculation, useful if the temperature difference between the two gasmixes is low or nonexistent.

proc
gas_pressure_minimum_transfer
(/datum/gas_mixture/output_air)

Counts how much pressure will there be if we impart MOLAR_ACCURACY amounts of our gas to the output gasmix. We do all of this without actually transferring it so don't worry about it changing the gasmix. Returns: Resulting pressure (number). Args:

output_air (gasmix).

proc
gas_pressure_quadratic
(a, b, c, lower_limit, upper_limit)

Actually tries to solve the quadratic equation. Do mind that the numbers can get very big and might hit BYOND's single point float limit.

proc
get_breath_partial_pressure
(gas_mole_count)

Returns the partial pressure of the gas in the breath based on BREATH_VOLUME eg: Plas_PP = get_breath_partial_pressure(gas_mixture.gases/datum/gas/plasma) O2_PP = get_breath_partial_pressure(gas_mixture.gases/datum/gas/oxygen) get_breath_partial_pressure(gas_mole_count) --> PV = nRT, P = nRT/V

10/205 = 2.5 10 = 2.5/520

proc
has_gas
(gas_id, amount)

Checks to see if gas amount exists in mixture. Do NOT use this in code where performance matters! It's better to batch calls to garbage_collect(), especially in places where you're checking many gastypes

proc
heat_capacity
(data)

joules per kelvin

proc
merge
(/datum/gas_mixture/giver)

Merges all air from giver into self. Deletes giver. Returns: 1 if we are mutable, 0 otherwise

proc
pump_gas_to
(/datum/gas_mixture/output_air, target_pressure, specific_gas, /datum/gas_mixture/output_pipenet_air)

Pumps gas from src to output_air. Amount depends on target_pressure

proc
react
(/datum/holder)

Performs various reactions such as combustion and fabrication Returns: 1 if any reaction took place; 0 otherwise

proc
release_gas_to
(/datum/gas_mixture/output_air, target_pressure, rate, /datum/gas_mixture/output_pipenet_air)

Releases gas from src to output air. This means that it can not transfer air to gas mixture with higher pressure.

proc
remove
(amount)

Proportionally removes amount of gas from the gas_mixture. Returns: gas_mixture with the gases removed

proc
remove_ratio
(ratio)

Proportionally removes amount of gas from the gas_mixture. Returns: gas_mixture with the gases removed

proc
remove_specific
(gas_id, amount)

Removes an amount of a specific gas from the gas_mixture. Returns: gas_mixture with the gas removed

proc
return_pressure
()

Calculate pressure in kilopascals

proc
return_temperature
()

Calculate temperature in kelvins

proc
return_visuals
(/turf/z_context)

Gets the gas visuals for everything in this mixture

proc
return_volume
()

Calculate volume in liters

Performs air sharing calculations between two gas_mixtures share() is communitive, which means A.share(B) needs to be the same as B.share(A) If we don't retain this, we will get negative moles. Don't do it Returns: amount of gas exchanged (+ if sharer received)

proc
temperature_share
(/datum/gas_mixture/sharer, conduction_coefficient, sharer_temperature, sharer_heat_capacity)

Performs temperature sharing calculations (via conduction) between two gas_mixtures assuming only 1 boundary length Returns: new temperature of the sharer

proc
thermal_energy
()

Calculate thermal energy in joules

proc
total_moles
()

Calculate moles

gas_mixture /datum/gas_mixture

Vars

Procs

Var Details

var gc_share –

var last_share –

var pipeline_cycle –

var reaction_results – /list

var temperature –

var temperature_archived – /tmp

var volume –

Proc Details

proc add_gas(gas_id)

proc add_gases(...)

proc archive()

proc assert_gas(gas_id)

proc assert_gases(...)

proc compare(/datum/gas_mixture/sample, index)

proc copy()

proc copy_from(/datum/gas_mixture/sample)

proc copy_from_ratio(/datum/gas_mixture/sample, partial)

proc equalize(/datum/gas_mixture/other)

proc garbage_collect(/list/tocheck)

proc gas_pressure_approximate(a, b, c, lower_limit, upper_limit)

proc gas_pressure_calculate(/datum/gas_mixture/output_air, target_pressure, ignore_temperature)

proc gas_pressure_minimum_transfer(/datum/gas_mixture/output_air)

proc gas_pressure_quadratic(a, b, c, lower_limit, upper_limit)

proc get_breath_partial_pressure(gas_mole_count)

proc has_gas(gas_id, amount)

proc heat_capacity(data)

proc merge(/datum/gas_mixture/giver)

proc pump_gas_to(/datum/gas_mixture/output_air, target_pressure, specific_gas, /datum/gas_mixture/output_pipenet_air)

proc react(/datum/holder)

proc release_gas_to(/datum/gas_mixture/output_air, target_pressure, rate, /datum/gas_mixture/output_pipenet_air)

proc remove(amount)

proc remove_ratio(ratio)

proc remove_specific(gas_id, amount)

proc return_pressure()

proc return_temperature()

proc return_visuals(/turf/z_context)

proc return_volume()

proc share(/datum/gas_mixture/sharer, our_coeff, sharer_coeff)

proc temperature_share(/datum/gas_mixture/sharer, conduction_coefficient, sharer_temperature, sharer_heat_capacity)

proc thermal_energy()

proc total_moles()

gas_mixture
/datum/gas_mixture

var
gc_share
–

var
last_share
–

var
pipeline_cycle
–

var
reaction_results
– /list

var
temperature
–

var
temperature_archived
– /tmp

var
volume
–

proc
add_gas
(gas_id)

proc
add_gases
(...)

proc
archive
()

proc
assert_gas
(gas_id)

proc
assert_gases
(...)

proc
compare
(/datum/gas_mixture/sample, index)

proc
copy
()

proc
copy_from
(/datum/gas_mixture/sample)

proc
copy_from_ratio
(/datum/gas_mixture/sample, partial)

proc
equalize
(/datum/gas_mixture/other)

proc
garbage_collect
(/list/tocheck)

proc
gas_pressure_approximate
(a, b, c, lower_limit, upper_limit)

proc
gas_pressure_calculate
(/datum/gas_mixture/output_air, target_pressure, ignore_temperature)

proc
gas_pressure_minimum_transfer
(/datum/gas_mixture/output_air)

proc
gas_pressure_quadratic
(a, b, c, lower_limit, upper_limit)

proc
get_breath_partial_pressure
(gas_mole_count)

proc
has_gas
(gas_id, amount)

proc
heat_capacity
(data)

proc
merge
(/datum/gas_mixture/giver)

proc
pump_gas_to
(/datum/gas_mixture/output_air, target_pressure, specific_gas, /datum/gas_mixture/output_pipenet_air)

proc
react
(/datum/holder)

proc
release_gas_to
(/datum/gas_mixture/output_air, target_pressure, rate, /datum/gas_mixture/output_pipenet_air)

proc
remove
(amount)

proc
remove_ratio
(ratio)

proc
remove_specific
(gas_id, amount)

proc
return_pressure
()

proc
return_temperature
()

proc
return_visuals
(/turf/z_context)

proc
return_volume
()

proc
share
(/datum/gas_mixture/sharer, our_coeff, sharer_coeff)

proc
temperature_share
(/datum/gas_mixture/sharer, conduction_coefficient, sharer_temperature, sharer_heat_capacity)

proc
thermal_energy
()

proc
total_moles
()