phyvars

Lists of physical variables made available by StagPy.

They are organized by kind of variables (field, profiles, and time series). EXTRA lists group variables that are not directly output by StagYY and need to be computed from other variables.

FIELD module-attribute

FIELD: Mapping[str, Varf] = MappingProxyType(
    {
        "T": Varf("Temperature", "K"),
        "v1": Varf("x Velocity", "m/s"),
        "v2": Varf("y Velocity", "m/s"),
        "v3": Varf("z Velocity", "m/s"),
        "p": Varf("Pressure", "Pa"),
        "eta": Varf("Viscosity", "Pa.s"),
        "rho": Varf("Density", "kg/m3"),
        "rho4rhs": Varf("Density term in RHS", "kg/m3"),
        "trarho": Varf("Density from tracer mass", "kg/m3"),
        "sII": Varf(
            "Second invariant of stress tensor", "Pa"
        ),
        "sx1": Varf(
            "1st comp. of principal stress eigenvector",
            "Pa",
        ),
        "sx2": Varf(
            "2nd comp. of principal stress eigenvector",
            "Pa",
        ),
        "sx3": Varf(
            "3rd comp. of principal stress eigenvector",
            "Pa",
        ),
        "s1val": Varf("Principal stress eigenvalue", "Pa"),
        "edot": Varf("Strain rate", "1/s"),
        "Tcond": Varf("Thermal conductivity", "W/(m.K)"),
        "c": Varf("Composition", "1"),
        "cFe": Varf("FeO content", "1"),
        "hpe": Varf("HPE content", "1"),
        "wtr": Varf("Water concentration", "1"),
        "age": Varf("Age", "s"),
        "contID": Varf("ID of continents", "1"),
        "rs1": Varf("x Momentum residue", "1"),
        "rs2": Varf("y Momentum residue", "1"),
        "rs3": Varf("z Momentum residue", "1"),
        "rsc": Varf("Continuity residue", "1"),
        "basalt": Varf("Basalt fraction", "1"),
        "harzburgite": Varf("Harzburgite fraction", "1"),
        "impactor": Varf("Impactor fraction", "1"),
        "prim": Varf("Primordial layer", "1"),
        "meltfrac": Varf("Melt fraction", "1"),
        "meltcompo": Varf("Melt composition", "1"),
        "meltrate": Varf("Melting rate", "1"),
        "meltvel": Varf("Melt velocity", "1"),
        "nmelt": Varf("N melt", "1"),
        "fSiO2": Varf("fSiO2", "1"),
        "fMgO": Varf("fMgO", "1"),
        "fFeO": Varf("fFeO", "1"),
        "fXO": Varf("fXO", "1"),
        "fFeR": Varf("fFeR", "1"),
    }
)

Scalar fields output by StagYY.

FIELD_EXTRA module-attribute

FIELD_EXTRA: Mapping[str, Callable[[Step], Field]] = (
    MappingProxyType({"stream": stream_function})
)

Scalar fields that StagPy can compute.

SFIELD module-attribute

SFIELD: Mapping[str, Varf] = MappingProxyType(
    {
        "topo_top": Varf("Topography at top", "m"),
        "topo_bot": Varf("Topography at bottom", "m"),
        "geoid_top": Varf("Geoid at top", "m"),
        "geoid_bot": Varf("Geoid at bottom", "m"),
        "topo_g_top": Varf(
            "Topography for geoid at top", "m"
        ),
        "topo_g_bot": Varf(
            "Topography for geoid at bottom", "m"
        ),
        "ftop": Varf("Heat flux at top", "W/m2"),
        "fbot": Varf("Heat flux at bottom", "W/m2"),
        "fstop": Varf(
            "Heat flux from spectrum at top", "W/m2"
        ),
        "fsbot": Varf(
            "Heat flux from spectrum at bottom", "W/m2"
        ),
        "crust": Varf("Crustal thickness", "m"),
    }
)

Surface scalar fields output by StagYY.

RPROF module-attribute

RPROF: Mapping[str, Varr] = MappingProxyType(
    {
        "r": Varr("Radial coordinate", "Radius", "m"),
        "Tmean": Varr("Temperature", "Temperature", "K"),
        "Tmin": Varr("Min temperature", "Temperature", "K"),
        "Tmax": Varr("Max temperature", "Temperature", "K"),
        "vrms": Varr("rms velocity", "Velocity", "m/s"),
        "vmin": Varr("Min velocity", "Velocity", "m/s"),
        "vmax": Varr("Max velocity", "Velocity", "m/s"),
        "vzabs": Varr("Radial velocity", "Velocity", "m/s"),
        "vzmin": Varr(
            "Min radial velocity", "Velocity", "m/s"
        ),
        "vzmax": Varr(
            "Max radial velocity", "Velocity", "m/s"
        ),
        "vhrms": Varr(
            "Horizontal velocity", "Velocity", "m/s"
        ),
        "vhmin": Varr(
            "Min horiz velocity", "Velocity", "m/s"
        ),
        "vhmax": Varr(
            "Max horiz velocity", "Velocity", "m/s"
        ),
        "etalog": Varr("Viscosity", "Viscosity", "Pa"),
        "etamin": Varr("Min viscosity", "Viscosity", "Pa"),
        "etamax": Varr("Max viscosity", "Viscosity", "Pa"),
        "elog": Varr("Strain rate", "Strain rate", "1/s"),
        "emin": Varr(
            "Min strain rate", "Strain rate", "1/s"
        ),
        "emax": Varr(
            "Max strain rate", "Strain rate", "1/s"
        ),
        "slog": Varr("Stress", "Stress", "Pa"),
        "smin": Varr("Min stress", "Stress", "Pa"),
        "smax": Varr("Max stress", "Stress", "Pa"),
        "whrms": Varr(
            "Horizontal vorticity", "Vorticity", "1/s"
        ),
        "whmin": Varr(
            "Min horiz vorticity", "Vorticity", "1/s"
        ),
        "whmax": Varr(
            "Max horiz vorticity", "Vorticity", "1/s"
        ),
        "wzrms": Varr(
            "Radial vorticity", "Vorticity", "1/s"
        ),
        "wzmin": Varr(
            "Min radial vorticity", "Vorticity", "1/s"
        ),
        "wzmax": Varr(
            "Max radial vorticity", "Vorticity", "1/s"
        ),
        "drms": Varr("Divergence", "Divergence", "1/s"),
        "dmin": Varr("Min divergence", "Divergence", "1/s"),
        "dmax": Varr("Max divergence", "Divergence", "1/s"),
        "enadv": Varr("Advection", "Heat flux", "W/m2"),
        "endiff": Varr("Diffusion", "Heat flux", "W/m2"),
        "enradh": Varr(
            "Radiogenic heating", "Heat flux", "W/m2"
        ),
        "enviscdiss": Varr(
            "Viscous dissipation", "Heat flux", "W/m2"
        ),
        "enadiabh": Varr(
            "Adiabatic heating", "Heat flux", "W/m2"
        ),
        "cmean": Varr(
            "Concentration", "Concentration", "1"
        ),
        "cmin": Varr(
            "Min concentration", "Concentration", "1"
        ),
        "cmax": Varr(
            "Max concentration", "Concentration", "1"
        ),
        "rhomean": Varr("Density", "Density", "kg/m3"),
        "rhomin": Varr("Min density", "Density", "kg/m3"),
        "rhomax": Varr("Max density", "Density", "kg/m3"),
        "airmean": Varr("Air", "Air", "1"),
        "airmin": Varr("Min air", "Air", "1"),
        "airmax": Varr("Max air", "Air", "1"),
        "primmean": Varr(
            "Primordial", "Concentration", "1"
        ),
        "primmin": Varr(
            "Min primordial", "Concentration", "1"
        ),
        "primmax": Varr(
            "Max primordial", "Concentration", "1"
        ),
        "ccmean": Varr("Continental crust", "Crust", "1"),
        "ccmin": Varr(
            "Min continental crust", "Crust", "1"
        ),
        "ccmax": Varr(
            "Max continental crust", "Crust", "1"
        ),
        "fmeltmean": Varr(
            "Melt fraction", "Melt fraction", "1"
        ),
        "fmeltmin": Varr(
            "Min melt fraction", "Melt fraction", "1"
        ),
        "fmeltmax": Varr(
            "Max melt fraction", "Melt fraction", "1"
        ),
        "metalmean": Varr("Metal", "Concentration", "1"),
        "metalmin": Varr("Min metal", "Concentration", "1"),
        "metalmax": Varr("Max metal", "Concentration", "1"),
        "gsmean": Varr("Grain size", "Grain size", "m"),
        "gsmin": Varr("Min grain size", "Grain size", "m"),
        "gsmax": Varr("Max grain", "Grain size", "m"),
        "viscdisslog": Varr(
            "Viscous dissipation", "Heat flux", "W/m2"
        ),
        "viscdissmin": Varr(
            "Min visc dissipation", "Heat flux", "W/m2"
        ),
        "viscdissmax": Varr(
            "Max visc dissipation", "Heat flux", "W/m2"
        ),
        "advtot": Varr("Advection", "Heat flux", "W/m2"),
        "advdesc": Varr(
            "Downward advection", "Heat flux", "W/m2"
        ),
        "advasc": Varr(
            "Upward advection", "Heat flux", "W/m2"
        ),
    }
)

Radial profiles output by StagYY.

RPROF_EXTRA module-attribute

RPROF_EXTRA: Mapping[str, Callable[[Step], Rprof]] = (
    MappingProxyType(
        {
            "dr": delta_r,
            "diff": diff_prof,
            "diffs": diffs_prof,
            "advts": advts_prof,
            "advds": advds_prof,
            "advas": advas_prof,
            "energy": energy_prof,
            "ciover": init_c_overturn,
            "cfover": c_overturned,
            "advth": advth,
        }
    )
)

Radial profiles that StagPy can compute.

TIME module-attribute

TIME: Mapping[str, Vart] = MappingProxyType(
    {
        "t": Vart("Time", "Time", "s"),
        "ftop": Vart(
            "Heat flux at top", "Heat flux", "W/m2"
        ),
        "fbot": Vart(
            "Heat flux at bottom", "Heat flux", "W/m2"
        ),
        "Tmin": Vart("Min temperature", "Temperature", "K"),
        "Tmean": Vart("Temperature", "Temperature", "K"),
        "Tmax": Vart("Max temperature", "Temperature", "K"),
        "vmin": Vart("Min velocity", "Velocity", "m/s"),
        "vrms": Vart("rms velocity", "Velocity", "m/s"),
        "vmax": Vart("Max velocity", "Velocity", "m/s"),
        "etamin": Vart(
            "Min viscosity", "Viscosity", "Pa.s"
        ),
        "etamean": Vart("Viscosity", "Viscosity", "Pa.s"),
        "etamax": Vart(
            "Max viscosity", "Viscosity", "Pa.s"
        ),
        "Raeff": Vart(
            "Effective Ra", "$\\mathrm{Ra}$", "1"
        ),
        "Nutop": Vart(
            "Nusselt at top", "$\\mathrm{Nu}$", "1"
        ),
        "Nubot": Vart(
            "Nusselt at bot", "$\\mathrm{Nu}$", "1"
        ),
        "Cmin": Vart(
            "Min concentration", "Concentration", "1"
        ),
        "Cmean": Vart(
            "Concentration", "Concentration", "1"
        ),
        "Cmax": Vart(
            "Max concentration", "Concentration", "1"
        ),
        "moltenf_mean": Vart(
            "Molten fraction", "Fraction", "1"
        ),
        "moltenf_max": Vart(
            "Max molten fraction", "Fraction", "1"
        ),
        "erupt_rate": Vart(
            "Eruption rate", "Eruption rate", "1/s"
        ),
        "erupt_tot": Vart(
            "Erupta total", "Eruption rate", "1/s"
        ),
        "erupt_heat": Vart(
            "Erupta heat", "Eruption rate", "1/s"
        ),
        "entrainment": Vart(
            "Entrainment", "Eruption rate", "1/s"
        ),
        "Cmass_error": Vart("Error on Cmass", "Error", "1"),
        "H_int": Vart(
            "Internal heating", "Internal heating", "W/m3"
        ),
        "r_ic": Vart(
            "Inner core radius", "Inner core radius", "m"
        ),
        "topT_val": Vart(
            "Temperature at top", "Temperature", "K"
        ),
        "botT_val": Vart(
            "Temperature at bottom", "Temperature", "K"
        ),
    }
)

Time series output by StagYY.

TIME_EXTRA module-attribute

TIME_EXTRA: Mapping[
    str, Callable[[StagyyData], Tseries]
] = MappingProxyType(
    {
        "dt": dtime,
        "dTdt": dt_dt,
        "ebalance": ebalance,
        "mobility": mobility,
    }
)

Time series that StagPy can compute.

REFSTATE module-attribute

REFSTATE: Mapping[str, Varr] = MappingProxyType(
    {
        "z": Varr("z position", "z position", "m"),
        "T": Varr("Temperature", "Temperature", "K"),
        "rho": Varr("Density", "Density", "kg/m3"),
        "expan": Varr(
            "Thermal expansivity",
            "Thermal expansivity",
            "1/K",
        ),
        "Cp": Varr(
            "Heat capacity", "Heat capacity", "J/(kg.K)"
        ),
        "Tcond": Varr(
            "Conductivity", "Conductivity", "W/(m.K)"
        ),
        "P": Varr("Pressure", "Pressure", "Pa"),
        "grav": Varr("Gravity", "Gravity", "m/s2"),
    }
)

Variables in Refstate.

SCALES module-attribute

SCALES: Mapping[str, Callable[[Scales], float]] = (
    MappingProxyType(
        {
            "m": attrgetter("length"),
            "kg/m3": attrgetter("density"),
            "K": attrgetter("temperature"),
            "W/m2": attrgetter("heat_flux"),
            "Pa": attrgetter("stress"),
            "Pa.s": attrgetter("dyn_visc"),
            "s": attrgetter("time"),
            "W/(m.K)": attrgetter("th_cond"),
            "m2/s": attrgetter("th_diff"),
            "W/m3": attrgetter("heat_production"),
            "1/s": lambda scl: 1 / time,
            "K/s": lambda scl: temperature / time,
            "m/s": attrgetter("velocity"),
            "m/s2": attrgetter("acceleration"),
        }
    )
)

Scales to make values dimensional, see Scales.