SEDIMENT_TIME_GRID

CLASS

class slcode.grid.SEDIMENT_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=2600, grid_name='time_grid', from_file=(False,))

The SEDIMENT_TIME_GRID class is used to represent sediment deposited thickness and time over time. It inherit from TIME_GRID and just add a default value of sediment density at 2600 kg/m3.

Note

This class must include the developement of [Ferrier et al., 2017] on sediment compaction and it’s effect on water redistriution.

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 value is 2600.

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.

Method

save

used to save data

METHODS

slcode.grid.SEDIMENT_TIME_GRID.save(self, save_way='')

The save method is used to save the grid data to a file. It call the super method save method with no additional saved parameters.

Note

Because we need to include [Ferrier et al., 2017] works, this save function will be modified to include data about the sediment compaction.

Attributes

rhofloat

Density value of the sediment as a constant, default value is 2600.

Return

None