OCEAN_TIME_GRID

CLASS

class slcode.grid.OCEAN_TIME_GRID(time_step=array([1, 2]), maxdeg=64, height_time_grid=None, mass_time_grid=None, mass_time_coeff=None, height_time_coeff=None, rho=1000, grid_name='time_grid', from_file=(False,))

The OCEAN_TIME_GRID class is used to represent the ocean thickness variation and contains the method to resolve the sea level equation. This method inherit from TIME_GRID.

…

Attributes

time_stepnp.array([time_step_number,])
This array contains the time step of the data you are importing. They will be use for temporal interpolation.

maxdegint
Maximum harmonic coefficient degree of the data. this define the chape of the grid and coefficient arrays

height_time_gridnp.array([maxedg*2,maxdeg])
This array is the height grid at each time steps defined in grid_time_step

mass_time_gridnp.array([maxedg*2,maxdeg])
This array is the mass grid at each time steps defined in grid_time_step

height_time_coeffnp.array([(maxdeg+1)(maxedg+2)/2,])
This array is the height spherical harmonic coefficient at each time steps defined in grid_time_step

mass_time_coeffnp.array([(maxdeg+1)(maxedg+2)/2,])
This array is the mass spherical harmonic coefficient at each time steps defined in grid_time_step

rhofloat
The density of the considered layer. Default is 1000 kg/m3.

Note

In future development the density may vary threw space and time. We’ll have to make a variable object more then a constant density.

grid_namestr
The name of the grid. We recommand you to choose a specific name for each grid you create. This name is used to save the grid in an nc file with `save`_.

from_file(bool,way)
This parameter define if the data are new or loaded from a previously saved model in a nc file. If the first element is False, the code will create a blank object, based on provided datas. If the first element is True, the method will get the data from the file way specified in the second element of this attribute.

Methods

update_0
set the grd_0 from the actual grd loaded in the grid

evaluate_ocean
evaluate the ocean function based on the Gaussian grid of the topography

METHODS

slcode.grid.OCEAN_TIME_GRID.update_0(self): The update_0 method update the grd_0 parameter of the object to the currend loaded grd.

Attributes

None

Return

None

slcode.grid.OCEAN_TIME_GRID.evaluate_ocean(self, topo)

The evaluate_ocean method evaluate the ocean function using the topography. It create a 0-1 matrix wich is 1 where topo<0 and 0 where topo>0. The ocean function is described in ocean function.

Attribute

toponp.array(maxdeg,maxdegx2)
topographic gaussian grid.

Returns :: None

slcode.grid.OCEAN_TIME_GRID.sea_level_solver(self, load, ice_time_grid, sed_time_grid, love_number, TO, t_it, conv_it, conv_lim)

The sea_level_solver method solve the sea level equation until. Beacause of the iterative type of the resolution of the SLE, this method define also a first guess of the Sea level at the first iteration and the first time step. This function is based on the convergence iteration for the estimation of the variability defined in Convergence parameter.

Attribute

loadLOAD_TIME_GRID class object
The load time grid as specified in the class object. This grid needs to be of the same shape (maxdeg) then the one of the current object.

ice_time_gridICE_TIME_GRID class object
The ice time grid as specified in the class object. This grid needs to be of the same shape (maxdeg) then the one of the current object.

sed_time_gridSEDIMENT_TIME_GRID class object
The sediment time grid as specified in the class object. This grid needs to be of the same shape (maxdeg) then the one of the current object.

love_numberLOVE class object
The love numbers as specified in the class object. The love numbers must have been set up with the same maximm degree thne the currend object.

TOsphericalobject class object
The ocean contours variability area computed as a sphericalobject class computed for the previous iteration. !Trouver où définir ce calcul!.

t_itint
The time iteration of the current computation on wich apply the resolution of the SLE.

conv_itint
convergence iteration set to 0 if it’s for a simple resolution of the SLE on one time step. This is used when you are working on a topographic convergence. In the code, the first guess for the SLE will be if it’s not the first topographic convergence iteration, the guess of the previuous one.

conv_limfloat
To stop the convergence of the solution, the conv_lim is usually set to 10^-3. The number of required step is then between 13 and 7.

Return

None

slcode.grid.OCEAN_TIME_GRID.sea_level_equation(self, load, ice_time_grid, sed_time_grid, love_number, TO, t_it)

The sea_level_equation method calculate the Sea level variation following the SLE. Tis function is resolving both the conservation of mass equation and the SL variation. This follows the method described in Resolution of SLE including the deconvolution.

Attribute

loadLOAD_TIME_GRID class object
The load time grid as specified in the class object. This grid needs to be of the same shape (maxdeg) then the one of the current object.

ice_time_gridICE_TIME_GRID class object
The ice time grid as specified in the class object. This grid needs to be of the same shape (maxdeg) then the one of the current object.

sed_time_gridSEDIMENT_TIME_GRID class object
The sediment time grid as specified in the class object. This grid needs to be of the same shape (maxdeg) then the one of the current object.

love_numberLOVE class object
The love numbers as specified in the class object. The love numbers must have been set up with the same maximm degree thne the currend object.

TOsphericalobject class object
The ocean contours variability area computed as a sphericalobject class computed for the previous iteration. !Trouver où définir ce calcul!.

t_itint
The time iteration of the current computation on wich apply the resolution of the SLE.

Return

None