processing

Computations of phyvars that are not output by StagYY.

Time series are returned along with the time at which the variables are evaluated. Radial profiles are returned along with the radial positions at which the variables are evaluated.

dtime

dtime(sdat: StagyyData) -> Tseries

Time increment.

Compute dt as a function of time.

Parameters:

Name	Type	Description	Default
sdat	StagyyData	a StagyyData instance.	required

Returns:

Type	Description
Tseries	dt and time arrays.

dt_dt

dt_dt(sdat: StagyyData) -> Tseries

Time derivative of temperature.

Compute dT/dt as a function of time using an explicit Euler scheme.

Parameters:

Name	Type	Description	Default
sdat	StagyyData	a StagyyData instance.	required

Returns:

Type	Description
Tseries	derivative of temperature and time arrays.

ebalance

ebalance(sdat: StagyyData) -> Tseries

Energy balance.

Compute Nu_t - Nu_b + V*dT/dt as a function of time using an explicit Euler scheme. This should be zero if energy is conserved.

Parameters:

Name	Type	Description	Default
sdat	StagyyData	a StagyyData instance.	required

Returns:

Type	Description
Tseries	energy balance and time arrays.

mobility

mobility(sdat: StagyyData) -> Tseries

Plates mobility.

Compute the ratio vsurf / vrms.

Parameters:

Name	Type	Description	Default
sdat	StagyyData	a StagyyData instance.	required

Returns:

Type	Description
Tseries	mobility and time arrays.

delta_r

delta_r(step: Step) -> Rprof

Cell thicknesses.

Parameters:

Name	Type	Description	Default
step	Step	a Step of a StagyyData instance.	required

Returns:

Type	Description
Rprof	the thickness of the cells and radius.

diff_prof

diff_prof(step: Step) -> Rprof

Diffusion flux.

Parameters:

Name	Type	Description	Default
step	Step	a Step of a StagyyData instance.	required

Returns:

Type	Description
Rprof	the diffusion and radius.

diffs_prof

diffs_prof(step: Step) -> Rprof

Scaled diffusion flux.

This computation takes sphericity into account if necessary.

Parameters:

Name	Type	Description	Default
step	Step	a Step of a StagyyData instance.	required

Returns:

Type	Description
Rprof	the diffusion and radius.

advts_prof

advts_prof(step: Step) -> Rprof

Scaled advection flux.

This computation takes sphericity into account if necessary.

Parameters:

Name	Type	Description	Default
step	Step	a Step of a StagyyData instance.	required

Returns:

Type	Description
Rprof	the scaled advection and radius.

advds_prof

advds_prof(step: Step) -> Rprof

Scaled downward advection flux.

This computation takes sphericity into account if necessary.

Parameters:

Name	Type	Description	Default
step	Step	a Step of a StagyyData instance.	required

Returns:

Type	Description
Rprof	the scaled downward advection and radius.

advas_prof

advas_prof(step: Step) -> Rprof

Scaled upward advection flux.

This computation takes sphericity into account if necessary.

Parameters:

Name	Type	Description	Default
step	Step	a Step of a StagyyData instance.	required

Returns:

Type	Description
Rprof	the scaled upward advection and radius.

energy_prof

energy_prof(step: Step) -> Rprof

Total heat flux.

This computation takes sphericity into account if necessary.

Parameters:

Name	Type	Description	Default
step	Step	a Step of a StagyyData instance.	required

Returns:

Type	Description
Rprof	the energy flux and radius.

stream_function

stream_function(step: Step) -> Field

Stream function (2D).

Parameters:

Name	Type	Description	Default
step	Step	a Step of a StagyyData instance.	required

Returns:

Type	Description
Field	the stream function field.