Webel: Psy/MPsy: Psychrometrics for Mathematica: Variable/quantity registry and naming conventions, with symbol markup.

Icon class

icon_class

far fa-sticky-note

icon_class_computed

far fa-sticky-note

Note kind

CONVENTION

NAMING

Policy level

INFORMATIVE

Keywords

Psychrometrics
Webel::MPsy
Webel::Psy
humid air
water
liquid water
steam
gas
fluid
vapour
water vapour

Click on the image to view it full size

Note that the same variable markup "symbol" (which is not necessarily a Mathematica Symbol) is sometimes used for a variable or quantity used in different contexts; the different documentation provides information for usage as an argument in a particular function:

Visit also: Webel: Psy/MPsy: Psychrometrics for Mathematica: Equation registry with variable/quantity markup

Relates to

SysML4Mathematica: Psychrometrics (humid air physics) Air Conditioning scenarios in graphical Systems Modeling Language (SysMLv1.x) and Mathematica

[CONVENTION, NAMING]{STRONG} Webel: Psy/MPsy: Psychrometrics for Mathematica: A suffix '$g' in a water-related variable name refers to water vapour (a special case of gas) or steam. A suffix '$f' refers to liquid (fluid) water. [Although a gas is a fluid.]

[CONVENTION, NAMING]{STRICT} Webel: Psy/MPsy: Psychrometrics for Mathematica: A suffix '$ha' indicates a HUMID air mixture variable, quantity, or function or a PER humid air mass quantity.

[CONVENTION, NAMING]{STRICT} Webel: Psy/MPsy: Psychrometrics for Mathematica: A suffix '$sat' indicates a humid air mixture quantity at saturation (relative humidity = 1 or degree of saturation = 1).

[CONVENTION, NAMING]{STRICT} Webel: Psy/MPsy: Psychrometrics for Mathematica: A suffix '$wat$i' indicates water (liquid or vapour) flow TO (into) the humid air mixture. A suffix '$wat$o' indicates water (liquid or vapour) flow FROM (out of) the humid air mixture.

[CONVENTION, NAMING]{STRICT} Webel: Psy/MPsy: Psychrometrics for Mathematica: A suffix '$wat' indicates a water-related variable, quantity, or function (note that 'w' is reserved for the humidity ratio).

[CONVENTION]{STRICT} Webel: Psy/MPsy: Psychrometrics for Mathematica: CONVENTION: 'Q' as a quantity symbol in equations indicates the energy GAINED BY the system as heat energy transfer; 'W' indicates the work DONE BY the system on its external surroundings.

[CONVENTION]{STRICT} Webel: Psy/MPsy: Psychrometrics for Mathematica: Humidity ratio (absolute humidity) is indicated by a lower case 'w' and measured in mass (water) / mass (dry air) units, so the SI and IP representations are equal Real (without an explicit unit system)

[CONVENTION]{STRICT} Webel: Psy/MPsy: Psychrometrics for Mathematica: Relative humidity is indicated by a lower case 'r' and measured as a Real fraction (rather than as a Percentage). [Some tables and plots do SHOW the relative humidity as a Percentage.]

[CONVENTION, NAMING]{STRICT} Webel: Psy/MPsy: Psychrometrics for Mathematica: The term 'steam' (indicated in variable names with a suffix '$s') is reserved for water vapour created through boiling.

[CONVENTION]{STRICT} Webel: Psy/MPsy: Psychrometrics for Mathematica: Transferred heat (energy "Q") has field names with lower case 'qTot', 'qSen', 'qLat'. Heat rates (energy per time) have field names 'qDotTot', 'qDotSen', 'qDotLat' (to avoid clashes with Mathematica core)

Related notes (backlinks)

[CONVENTION, NAMING]{STRICT} Mathematica: CONVENTION: A prefix 'eq$' indicates a symbolic equation (typically using 'sym$' human-friendly markup "symbols")
[CONVENTION, NAMING]{STRICT} Webel: Mathematica: CONVENTION: A prefix '$doc' indicates a documentation String for each primary variable/quantity (argument or output)
[CONVENTION, NAMING]{STRICT} Webel: Mathematica: CONVENTION: A prefix 'sym$' indicates a markup variable "symbol" for a documented variable. It need not be a String, but each referenced part MUST be a String - not a Mathematica Symbol - to avoid namespace clashes!

Related snippets (extracts)

Visit also

Visit also (backlinks)

Flags