Context Navigation

Computation

Timestamp:

04/08/14 11:28:29 (10 years ago)

Author:

pinsard

Message:

fix some typos in comments

Location:

trunk/SRC/Computation

Files:

r462	r493
22	22	;
23	23	; @keyword REFVALUE {type=scalar} {default=0.}
24		; the bsf value that we want to spe~~fic~~y at the position defined by refpoint
	24	; the bsf value that we want to specify at the position defined by refpoint
25	25	;
26	26	; @keyword TRANSPORT {type=scalar: 0 or 1} {default=0.}
…	…
79	79	umsk = (umask())[firstx:lastx, firsty:lasty, firstz:lastz]
80	80	IF total(umsk[, , nz-1]) NE 0 THEN return, report('The bottom of the box (defined by lastzt) must be set to land value (=0)')
81		IF total(umsk[, 0, ]) NE 0 THEN return, report('southern boudary must be land point if you want to compute the bsf with this function')
	81	IF total(umsk[, 0, ]) NE 0 THEN return, report('southern boundary must be land point if you want to compute the bsf with this function')
82	82	;
83	83	un = litchamp(z3d)

-                      r445
+                      r493
 ; @keyword e1 {default=0}{type=scalar: 0 or 1}
 ; activate to compute e1 * e3 instead of e3
 ; note that of both keywords e1 and e2 are acticated we compute e1 * e2 * e3 instead of e3
+; note that of both keywords e1 and e2 are activated we compute e1 * e2 * e3 instead of e3
+;
 ; @keyword e2 {default=0}{type=scalar: 0 or 1}
 ; activate to compute e2 * e3 instead of e3
 ; note that of both keywords e1 and e2 are acticated we compute e1 * e2 * e3 instead of e3
+; note that of both keywords e1 and e2 are activated we compute e1 * e2 * e3 instead of e3
+;
 ; @returns

-                      r454
+                      r493
 ; @keyword e1 {default=0}{type=scalar: 0 or 1}
 ; activate to compute e1t * e3t instead of e3t
 ; note that of both keywords e1 and e2 are acticated we compute e1t * e2t * e3t instead of e3t
+; note that of both keywords e1 and e2 are activated we compute e1t * e2t * e3t instead of e3t
+;
 ; @keyword e2 {default=0}{type=scalar: 0 or 1}
 ; activate to compute e2t * e3t instead of e3t
 ; note that of both keywords e1 and e2 are acticated we compute e1t * e2t * e3t instead of e3t
+; note that of both keywords e1 and e2 are activated we compute e1t * e2t * e3t instead of e3t
+;
 ; @returns

-                      r454
+                      r493
 ; @keyword e1 {default=0}{type=scalar: 0 or 1}
 ; activate to compute e1u * e3u instead of e3u
 ; note that of both keywords e1 and e2 are acticated we compute e1u * e2u * e3u instead of e3u
+; note that of both keywords e1 and e2 are activated we compute e1u * e2u * e3u instead of e3u
+;
 ; @keyword e2 {default=0}{type=scalar: 0 or 1}
 ; activate to compute e2u * e3u instead of e3u
 ; note that of both keywords e1 and e2 are acticated we compute e1u * e2u * e3u instead of e3u
+; note that of both keywords e1 and e2 are activated we compute e1u * e2u * e3u instead of e3u
+;
 ; @returns

-                      r454
+                      r493
 ; @keyword e1 {default=0}{type=scalar: 0 or 1}
 ; activate to compute e1v * e3v instead of e3v
 ; note that of both keywords e1 and e2 are acticated we compute e1v * e2v * e3v instead of e3v
+; note that of both keywords e1 and e2 are activated we compute e1v * e2v * e3v instead of e3v
+;
 ; @keyword e2 {default=0}{type=scalar: 0 or 1}
 ; activate to compute e2v * e3v instead of e3v
 ; note that of both keywords e1 and e2 are acticated we compute e1v * e2v * e3v instead of e3v
+; note that of both keywords e1 and e2 are activated we compute e1v * e2v * e3v instead of e3v
+;
 ; @returns

-                      r454
+                      r493
 ; @keyword e1 {default=0}{type=scalar: 0 or 1}
 ; activate to compute e1t * e3w instead of e3w
 ; note that of both keywords e1 and e2 are acticated we compute e1t * e2t * e3w instead of e3w
+; note that of both keywords e1 and e2 are activated we compute e1t * e2t * e3w instead of e3w
+;
 ; @keyword e2 {default=0}{type=scalar: 0 or 1}
 ; activate to compute e2t * e3w instead of e3w
 ; note that of both keywords e1 and e2 are acticated we compute e1t * e2t * e3w instead of e3w
+; note that of both keywords e1 and e2 are activated we compute e1t * e2t * e3w instead of e3w
+;
 ; @returns

-                      r462
+                      r493
+;
 ; @param mask2d {in} {type=2D xy array} {optional} {default=1 everywhere}
 ; land/sea (0/1) mask to be applied (in addtion to the 3D mask
+; land/sea (0/1) mask to be applied (in addition to the 3D mask
 ; of the model) to mask some parts of the domain (and keep for example
 ; the northend atlantic).
 …
 ; @keyword INDEXBOXZOOM
 ; Set this keyword to a named variable in which msf will return the x
 ; and y indexes definig the zoom-box that should be used by pltz to do
+; and y indexes defining the zoom-box that should be used by pltz to do
 ; the plot (see example)
+;
 …
   IF total(msk[*, *, nz-1]) NE 0 THEN return, report('The bottom of the box (defined by lastzt) must be set to land value (=0)')
   IF (total(msk[0, *, *]) NE 0 OR total(msk[nx-1, *, *]) NE 0) AND NOT (keyword_set(key_periodic) AND nx EQ jpi) THEN $
      return, report('for non-periodic domains, eastern and western bondaries must be land point')
+     return, report('for non-periodic domains, eastern and western boundaries must be land point')
   IF keyword_set(key_partialstep) AND total(msk[*, ny-1, *]) NE 0 THEN flagdata = 1
+;

-                      r371
+                      r493
 ; We recover the complete grid to establish a big mask extent in the four
 ; direction to cover pointsfor which a land point has been
 ; considerated (make a small drawing)
+; considerate (make a small drawing)
 ;----------------------------------------------------------------------------
       mask = tmask[indice2d+jpi*jpj*firstzt]
 …
 ; We recover the complete grid to establish a big mask extent in the four
 ; direction to cover pointsfor which a land point has been
 ; considerated (make a small drawing)
+; considerate (make a small drawing)
 ;----------------------------------------------------------------------------
       mask = tmask[indice2d+jpi*jpj*firstzt]

Note: See TracChangeset for help on using the changeset viewer.