TemporalVectorFields class

class IMTreatment.core.temporalvectorfields.TemporalVectorFields[source]

Bases: IMTreatment.core.temporalfields.TemporalFields

Class representing a set of time-evolving velocity fields.

Vx
Vx_as_sf
Vy
Vy_as_sf
fill(tof='spatial', kind='linear', value=[0.0, 0.0], inplace=False, crop=False)[source]

Fill the masked part of the array in place.

Parameters:
  • tof (string) – Can be ‘temporal’ for temporal interpolation, or ‘spatial’ for spatial interpolation.
  • kind (string, optional) – Type of algorithm used to fill. ‘value’ : fill with a given value ‘nearest’ : fill with nearest available data ‘linear’ : fill using linear interpolation ‘cubic’ : fill using cubic interpolation
  • value (2x1 array) – Value for filling, ‘[Vx, Vy]’ (only usefull with tof=’value’)
  • inplace (boolean, optional) –

    .

  • crop (boolean, optional) – If ‘True’, TVF borders are croped before filling.
get_mean_kinetic_energy()[source]

Calculate the mean kinetic energy.

get_mean_tke()[source]
get_reynolds_stress(nmb_val_min=1)[source]

Calculate the reynolds stress.

Returns:Re_xx, Re_yy, Re_xy – Reynolds shear stress
Return type:ScalarField objects
get_spectral_filtering(fmin, fmax, order=2, inplace=False)[source]

Perform a temporal spectral filtering

Parameters:
  • fmax (fmin,) – Minimal and maximal frequencies
  • order (integer, optional) – Butterworth filter order
Returns:

filt_tvf – Filtered temporal field
Return type:

TemporalVectorFields
get_time_auto_correlation()[source]

Return auto correlation based on Vx and Vy.

get_tke()[source]

Calculate the turbulent kinetic energy.

get_turbulent_intensity()[source]

Calculate the turbulent intensity.

TI = sqrt(2/3*k)/sqrt(Vx**2 + Vy**2)

magnitude
magnitude_as_sf
theta
theta_as_sf