Changeset 142 for trunk/SRC/ToBeReviewed/CALCULS/hdyn.pro

Timestamp:

07/21/06 14:47:49 (18 years ago)

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/ToBeReviewed/CALCULS/hdyn.pro (modified) (2 diffs)

trunk/SRC/ToBeReviewed/CALCULS/hdyn.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:hdyn
 ;
-; PURPOSE:calcule la hauteur dynamique par rapport a un etat de
-; reference pour une profondeur de reference. Cf les mots cles pour
-; les differentes possibilites. 
-; Par defaut l''etat de reference est
-; rho=1020 et la profondeur de reference est gdepw[ka] avec ka le
-; premier niveau W directement au dessus de 1000 m. 
+; @file_comments
+; Calculate the height by rapport to a reference state for a depth reference. 
+; See keywords for different possibilities. By default, the state reference 
+; is rho=1020 and the depth reference is gdepw[ka] with ka the first W level 
+; directly above 1000 m. 
 ;
-; CATEGORY: calculs de post-traitement
+; @categories
+; Post-traiment calculation
 ;
-; CALLING SEQUENCE:res=hdyn(sn,tn)
+; @param TABSN {in}{required}
+; array representing the salinity
 ;
-; INPUTS:sn et tn sont des tableaux de meme taille representant la
-; salinite et la temperature.
+; @param TABTN {in}{required}
+; array representing the temperature.Has the same size than SN
 ;
-; KEYWORD PARAMETERS:
+; @keyword GILL We activate this key if we want to calculate the dinamic height 
+; like in the GILL page 215, which means by rapport to a reference state which 
+; vary in depth and which is determinated by a reference temperature tref at 0°C 
+; and a reference salinity sref at 35psu
 ;
-;        GILL: activer cette cle si on veut faire le calcul de la
-;        hauteur dynamique comme ds le GILL page 215 cad par rapport a
-;        un etat de reference qui varie en profondeur et qui est
-;        determine par une temperature de reference tref a 0 degre et
-;        une salinite de reference sref a 35psu
+; @keyword LEVEL
+; It is the same reference level to take. This level is defined like 
+; that gdepw[level] is the reference depth
+; 
+; @keyword SREF 
+; Give a value to this keyword to change the reference salinity used in the 
+; calculation when GILL  is activated. 
+;   
+; @keyword TREF
+; Give a value to this keyword to change the reference temperature used in the 
+; calculation when GILL  is activated.
+; 
+; @keyword PROFREF
+; Give a depth to this keyword which will be considerated as the refeence depth 
+; (in this case, LEVEL has not any effect). the calculation will be effectuated 
+; until this depth effecting an interpolation between the the last W level above 
+; PROFREF and PROFREF.
 ;
-;        LEVEL: C''est le niveau de reference a prendre. Ce niveau est
-;        definit tel que gdepw[level] est la profondeur de reference
+; @keyword SURFACE_LEVEL 
+; It is the level where we wan to calculate the dynamic height. By default, it is 
+; the level 0.
 ;
-;        SREF: donner une valeur a ce mot cle pour changer la salinite
-;        de reference utiliser ds le calcul lorsque GILL est active.
-;   
-;        TREF: donner une valeur a ce mot cle pour changer la temperature
-;        de reference utiliser ds le calcul lorsque GILL est active.
+; @returns
+; An array of the same size of sn and tn representing the dynamic height calculated 
+; from a reference depth nd by rapport to a reference state.
 ;
-;        PROFREF: donner a ce mot cle une profondeur qui sera prise comme
-;        la profondeur de reference (ds ce cas LEVEL n'' a aucun
-;        effet). le calcul sera alors effectue jusqu''a cette
-;        profondeur en effectuant une interpolation entre le dernier
-;        niveau W au dessus de PROFREF et PROFREF.
+; @uses 
+; common.pro
 ;
-;        SURFACE_LEVEL: C''est le niveau auquel on veut calculer la
-;        hauteur dynamique. Par defaut c''est le niveau 0.
+; @restrictions
+; Points for which we can not calculate the dynamic height (whose the batymetry 
+; is less deep than the reference depth) are put at the value !values.f_nan
 ;
-; OUTPUTS:un tableau de la meme taille que sn et tn representant la
-; hauteur dynamique calculee a partir d''une profondeur de reference
-; et par rapport a un etat de reference.
+; @restrictions
+; approximation: The pressure in decibars is equal to the depth in meters (the pressure increase of 1bar all 10m)
 ;
-; COMMON BLOCKS:
-;       common.pro
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;
-; SIDE EFFECTS:
-; les points pour lesquels on nje peut calcule la hauteur dynamique
-; (dont la batymetrie est moins profonde que la profondeur de
-; reference) sont mis a la valeur !values.f_nan
-;
-; RESTRICTIONS:approximation: la pression en decibars est egale a la
-; profondeur en metres (la pression augmente de 1bar tous les 10m)
-;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @version
+; $Id$
 ;
 ;-
@@ -72 +74 @@
   compile_opt idl2, strictarrsubs
 ;
-   tempsun = systime(1)         ; pour key_performance
+   tempsun = systime(1)         ; for key_performance
 @common
 
    if NOT keyword_set(surface_level) then surface_level = 0
-; utile si GILL est active
+; useful if GILL is activated
    if NOT keyword_set(tref) then tref = 0.
    if NOT keyword_set(sref) then sref = 35.
-; on determine si besoin est la profondeur de reference et le niveau
-; W situe directement au dessus.
+; If needed, we determinate the reference depth and the W level situated directly above.
    if keyword_set(profref) then begin
       rien = where(gdepw LE profref, level)