Second-generation Louvain-la-Neuve Ice-ocean model - User interface
 
Contact: jonathan.lambrechts@uclouvain.be
webpage: www.climate.be/slim
 
SLIM solves the governing equations on adaptative unstructured meshes using the discontinuous Galerkin finite element method.
 
slimPost contains some post processing tools usable with results from slim (for simulations, see slim.py file), such as fourier series ...
 
To generate the post processing results, run the script my_postpro_script.py:
    - On a single core: rundgpy my_prepro_script.py

Modules
		dgpy numpy os matplotlib.pyplot dgpy.scripts.slim_private time

Classes
		builtins.object Fourier_series Particle_tracker   class Fourier_series(builtins.object)     compute the fourier series     Methods defined here: __init__(self, mesh_file_name, path_input, initial_index, final_index, initial_time, n_period, n_iter, n, period) keyword arguments:   * mesh_file_name                 path to the mesh file (.msh format) * path_input                path to the sea surface elevation file provided by slim (.idx format) * initial_index     index of the first iteration  * final_index     index of the last iteration * initial_time     time of the first iteration in seconds * n_period     number of period between the first and the last iteration * n_iter     number of iteration per period * n     number of terms of the fourier serie * period     length of a period fourier(self, iNodeIndex, iElemIndex, iGroupIndex, plot=True, fig_name=None) Return the fourier serie at a node of the mesh   keyword arguments:   * iNode     index of the node * iElem     index of the element * iGroup     index of the group * plot     flag to plot the signal, the component and the spectal analysis * fig_name     name of the file (.png extension) if you want to save the figure fourier_map(self, iComp, range_file, phase_file) Return two .msh file containing a map of the tidal range and tidal phase of the iComp tidal component   keyword arguments:   * iComp     number of the tidal component * range_file     name of the output file for the tidal range * phase     name of the output file for the tidal phase getNodeIndex(self, elemId, output='elemID') Create a .msh file with the element Idendity, return the index of the element and of the group of the element ID given in elemId, and print the index of all the node of the element, the element, and the group of the element ID given in elemId   keyword arguments:   * elemId     Element idendity of th eelement for which the index of the node, the element and the group will be printed * output     name of the .msh file containing the element Idendity for each element of the mesh Data descriptors defined here: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)   class Particle_tracker(builtins.object)     predict the path of particles from the velocity field predicted by SLIM     Methods defined here: __init__(self, mesh_file_name, path_input, bathy, index_start, n_iter, n_period, dt, diffusivity=None) keyword arguments:   * mesh_file_name                 path to the mesh file (.msh format) * path_input                path to the output files provided by slim (sw2d folder ex: path_input/sw2d/eta/eta.idx) * bathy              bathymetric file [in meters, positive] (.msh, .idx or .nc format) * diffusivity             diffusivity of the model (.msh, .idx or .nc format) (default: 0) * index_start     index of the first iteration  * n_iter     number of iteration * n_period     number of times the loop of hydrodynamic solution will be run  * dt     time step addParticleAtPoint(self, x, y, number_of_particles, time_step, locationId, status=0, particleId=-1) Seed particle(s) at location (x,y) and time step time_step   keyword arguments:   * x     x coordinates where the particle is seeded  * y     y coordinates where the particle is seeded * number_of_particles     number of particles seeded at this location *time_step     index of the time step at which the particle is seeded *status     status of the particle (dead or alive, default: 0) *LocationId     Identification of the source *particleId     Identification of the particle (default: each particle is identified depending on the source) loop(self, path_output) Compute the particle(s) position at each time step and store it in a .pos file   keyword arguments:   * path_output     name of the .pos files which will contain the position of the particle(s) Data descriptors defined here: __dict__ dictionary for instance variables (if defined) __weakref__ list of weak references to the object (if defined)