Ignore:
Timestamp:
06/12/06 16:49:30 (18 years ago)
Author:
pinsard
Message:

start to modify headers of ReadWrite? *.pro files for better idldoc output

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_html_output/ReadWrite/readoldoparestart.html

    r104 r106  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments"> read the old restart files of OPA (before NetCDF) 
     90      based on the OPA subroutine dtrlec included at the end of the 
     91      file.</div> 
    9092 
    9193       
     
    102104           
    103105          <dt><p><a href="#_read2fromopa"><span class="result">result = </span>read2fromopa(<span class="result">unit, params, num</span>)</a></p><dt> 
    104           <dd>  NAME:readoldoparestart       based on the OPA subroutine dtrlec included at the end of the       file.</dd>      
     106          <dd> </dd>     
    105107           
    106108          <dt><p><a href="#_read3fromopa"><span class="result">result = </span>read3fromopa(<span class="result">unit, params, num</span>)</a></p><dt> 
     
    119121        <div class="routine_details" id="_read2fromopa"> 
    120122 
    121           <h2><a class="top" href="#container">top</a>read2fromopa </h2> 
     123          <h2><a class="top" href="#container">top</a>read2fromopa <span class="categories"> for OPA before NetCDF 
     124</span></h2> 
    122125         
    123126          <p class="header"> 
     
    125128         
    126129          <div class="comments"> 
    127  NAME:readoldoparestart 
    128       based on the OPA subroutine dtrlec included at the end of the 
    129       file. 
    130  
    131  PURPOSE:read the old restart files of OPA (before NetCDF) 
    132  
    133  CATEGORY:for OPA before NetCDF 
    134  
    135  CALLING SEQUENCE:readoldoparestart, filename, jpiglo, jpjglo, jpk 
    136   
    137  INPUTS: 
    138      filename: with the whole path if necessary 
    139      jpiglo, jpjglo, jpk: dimensions of the opa grid 
    140  
    141  KEYWORD PARAMETERS: 
    142      IBLOC: ibloc size, default: ibloc = 4096L 
    143      JPBYT: jpbyt size, defalut: jpbyt = 8L 
    144      NUMREC: number of records in the file. defalut: numrec = 19L*jpk 
    145      UB, VB, TB, SB, ROTB, HDIVB, UN, VN, TN, SN, ROTN, HDIVN, GCX, 
    146      GCXB, ETAB, TAN, BSFB, BSFN, BSFD, EN: the variable we want to 
    147      read.  
    148  
    149  OUTPUTS:according to the given keywords. 
    150  
    151  COMMON BLOCKS:none 
    152  
    153  SIDE EFFECTS: 
    154  
    155  RESTRICTIONS:bug for etab and etan written on the same record??? 
    156  
    157  EXAMPLE: 
    158130</div> 
    159131 
     
    209181 
    210182           
    211            
    212            
    213            
    214            
    215            
    216            
    217            
    218            
    219            
    220            
    221            
     183          <h3>Version history</h3> 
     184           
     185           
     186          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     187                      June 2002</div> 
     188           
     189           
     190          <h3>Known issues</h3> 
     191           
     192           
     193           
     194          <h4>Restrictions</h4><div class="value"> bug for etab and etan written on the same record??? 
     195</div> 
    222196         
    223197           
     
    294268 
    295269           
    296            
    297            
    298            
    299            
     270          <h3>Version history</h3> 
     271           
     272           
     273          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     274                      June 2002</div> 
    300275           
    301276           
     
    321296        <div class="routine_details" id="_readoldoparestart"> 
    322297 
    323           <h2><a class="top" href="#container">top</a>readoldoparestart </h2> 
     298          <h2><a class="top" href="#container">top</a>readoldoparestart <span class="categories"> for OPA before NetCDF</span></h2> 
    324299         
    325300          <p class="header"> 
     
    328303          <div class="comments"></div> 
    329304 
    330            
     305          <h3>Return value</h3><div class="value"> according to the given keywords.</div> 
    331306 
    332307           
     
    335310             
    336311            <h4 id="_readoldoparestart_param_filename">filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    337                
    338                
    339                
    340                
    341                
    342                
    343                
    344                
    345             </h4> 
    346          
    347           <div class="comments"></div> 
     312              <span class="attr">in</span> 
     313               
     314               
     315              <span class="attr">required</span> 
     316               
     317               
     318               
     319               
     320            </h4> 
     321         
     322          <div class="comments"> with the whole path if necessary</div> 
    348323             
    349324            <h4 id="_readoldoparestart_param_jpiglo">jpiglo&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    350                
    351                
    352                
    353                
     325              <span class="attr">in</span> 
     326               
     327               
     328              <span class="attr">required</span> 
    354329               
    355330               
     
    361336             
    362337            <h4 id="_readoldoparestart_param_jpjglo">jpjglo&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    363                
    364                
    365                
    366                
     338              <span class="attr">in</span> 
     339               
     340               
     341              <span class="attr">required</span> 
    367342               
    368343               
     
    374349             
    375350            <h4 id="_readoldoparestart_param_jpk">jpk&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    376                
    377                
    378                
    379                
    380                
    381                
    382                
    383                
    384             </h4> 
    385          
    386           <div class="comments"></div> 
     351              <span class="attr">in</span> 
     352               
     353               
     354              <span class="attr">required</span> 
     355               
     356               
     357               
     358               
     359            </h4> 
     360         
     361          <div class="comments"> 
     362       dimensions of the opa grid</div> 
    387363             
    388364 
     
    404380            </h4> 
    405381         
    406             <div class="comments"></div> 
     382            <div class="comments"> ibloc size, default: ibloc = 4096L</div> 
    407383             
    408384            <h4 id="_readoldoparestart_keyword_JPBYT">JPBYT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    417393            </h4> 
    418394         
    419             <div class="comments"></div> 
     395            <div class="comments"> jpbyt size, defalut: jpbyt = 8L</div> 
    420396             
    421397            <h4 id="_readoldoparestart_keyword_NUMREC">NUMREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    430406            </h4> 
    431407         
    432             <div class="comments"></div> 
     408            <div class="comments"> number of records in the file. defalut: numrec = 19L*jpk</div> 
    433409             
    434410            <h4 id="_readoldoparestart_keyword_ub">ub&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    690666            </h4> 
    691667         
    692             <div class="comments"></div> 
    693              
    694            
    695  
    696            
    697            
    698            
    699            
    700            
    701            
    702            
    703            
    704            
    705            
    706            
    707            
     668            <div class="comments"> 
     669       the variable we want to read.  
     670</div> 
     671             
     672           
     673 
     674           
     675          <h3>Version history</h3> 
     676           
     677           
     678          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     679                      June 2002</div> 
     680           
     681           
     682          <h3>Known issues</h3> 
     683           
     684           
     685           
     686          <h4>Restrictions</h4><div class="value"> bug for etab and etan written on the same record??? 
     687</div> 
    708688         
    709689           
Note: See TracChangeset for help on using the changeset viewer.