Saving and loading eigenfunctions

Saving and loading eigenfunctions#

mascaret.load_eigenfunction(filename)#

Load eigenfunction saved in a hdf5 file.

filenamestr or Path object

Filename

Returns:

The loaded mode properties.

Return type:

astropy.Table

mascaret.save_eigenfunction(filename, x, xi_r, W, model=None, omega=None, l=None, m=None, n=None, n_g=None, n_p=None, delta=None, T=None, rot_solar_rate=None, save_adimensioned=False, y1=None, y2=None, profile_to_save=None)#

Save eigenfunction as a hdf5 file.

filenamestr or Path object

Filename

xndarray

Radial coordinate. x is normally given as r/R with R the outer radius of the grid (which is not mandatorily Rstar), R and Rstar are both accessible in the file in order to allow rescaling when necessary.

xi_rndarray

Radial displacement.

Wndarray

Reduced pressure perturbation.

modelStellarModel

Mode associated stellar model.

omegafloat

Mode angular frequency.

lint

Mode angular degree.

mint

Mode azimuthal number.

nint

Mode radial order.

n_gint

Mode characteristic gravity number.

n_pint

Mode characteristic acoustic number.

deltafloat

Discriminant of the mode numerical computation.

Tfloat

Radiative/convective transmission coefficient.

rot_solar_ratefloat

Stellar rotation frequency, in solar units.

save_adimensionedbool

Whether to save or not adimensioned variables computed by the solver. y1 and y2`` must be provided in this case. Optional, default False.

y1ndarrray

First adimensioned variable. Optional, default None.

y2: ndarray

Second adimensioned variable. Optional, default None.

profile_to_savelist or array-like

List of profile to interpolate and save from the stellar model. Optional, default None.