/[MITgcm]/MITgcm_contrib/gael/matlab_class/gcmfaces_IO/write2nctiles.m

Diff of /MITgcm_contrib/gael/matlab_class/gcmfaces_IO/write2nctiles.m

Parent Directory | Revision Log | View Revision Graph Revision Graph | View Patch Patch

-revision 1.6 by gforget,
Sun Jan 18 14:07:15 2015 UTC
+revision 1.10 by gforget,
Thu Mar 16 13:15:39 2017 UTC
 Line 1
  function [dimOut]=write2nctiles(fileOut,fldIn,doCreate,varargin);
- %object : write gcmfaces object to netcdf files (tiled)
+ % WRITE2NCTILES writes a gcmfaces object to nctiles, tiled netcdf, files
- %inputs : fileOut is the name of the file to be created
+ %
- %         fldIn is the array to write to disk
+ % inputs :
- %         doCreate is a 0/1 switch; 1 => create file ; 0 => append to file.
+ %    - fileOut is the name of the file to be created
- %optional paramaters :
+ %    - fldIn is the array to write to disk
- %         can be provided in the form {'name',value}
+ %    - doCreate: if 1 (default) then create file ; if 0 then append to file.
- %         those that are currently active are
+ %
- %               'descr' is the file description (default '').
+ % additional paramaters can be provided afterwards in the {'name',value} form:
- %               'rdm' is the extended estimate description (default '').
+ %         'fldName' is the nc variable name for fld (see "notes" regarding default)
- %               'fldName' is the nc variable name for fld (default : the outside name of fldIn).
+ %         'longName' is the corresponding long name ('' by default).
- %               'longName' is the corresponding long name (default : '').
+ %         'units' is the unit of fld ('(unknown)' by default).
- %               'units' is the unit of fld (default : '(unknown)').
+ %         'missval' is the missing value (NaN by default).
- %               'missval' is the missing value (default : NaN).
+ %         'fillval' is the fill value (NaN by default).
- %               'fillval' is the fill value (default : NaN).
+ %         'tileNo' is a map of tile indices (face # by default)
- %               'tileNo' is a map of tile indices (default is face number)
+ %         'coord' is auxilliary coordinates attribute (e.g. 'lon lat dep')
- %               'coord' is auxilliary coordinates attribute (e.g. 'lon lat dep')
+ %         'dimsize' is the array size associated with 'coord'
- %netcdf dimensions : array dimensions are simply set to 'i1,i2,...'
+ %         'xtype' is the variable ('double' by default)
+ %         'rdm' is the extended estimate description ('' by default).
+ %         'descr' is the file description ('' by default).
+ %
+ % notes:
+ %    - if fldName is not explicitly specified then the input variable
+ %      name (if ok) or file name (otherwise) is used as fldName.
+ %    - netcdf dimensions are simply set to 'i1,i2,...'
+ %
+ % examples:
+ %
+ %    write2nctiles('test1',mygrid.RAC,1,{'fldName','RAC'});
+ %    RAC=read_nctiles('test1','RAC');
+ %
+ %    write2nctiles('test2',mygrid.RAC);
+ %    RAC=read_nctiles('test2','test2');
+ %    RAC=read_nctiles('test2');
  gcmfaces_global;
  if ~(myenv.useNativeMatlabNetcdf);
-Line 24 
 end;
+Line 40 
 end;
  doCheck=0;%set to one to print stuff to screen
+ if isempty(whos('fileOut')); error('fileOut must be specified'); end;
+ if isempty(whos('fldIn')); error('fldIn must be specified'); end;
+ if isempty(whos('doCreate')); doCreate=1; end;
+ fldInIsaGcmfaces=isa(fldIn,'gcmfaces');
+ if fldInIsaGcmfaces;
+   fldInIsEmpty=isempty(fldIn{1});
+ else;
+   fldInIsEmpty=isempty(fldIn);
+ end;
  %set more optional paramaters to default values
- descr='';
+ fldName=inputname(2);
- rdm='';
+ if isempty(fldName);
- fldName=inputname(2); longName='';
+     [tmp1,fldName,tmp2] = fileparts(fileOut);
- units='(unknown)'; missval=NaN; fillval=NaN; dimIn=[];
+ end;
+ longName=''; units='(unknown)'; missval=NaN; fillval=NaN; dimIn=[];
  tileNo=mygrid.XC; for ff=1:mygrid.nFaces; tileNo{ff}(:)=ff; end;
- coord='';
+ coord=''; dimsize=[]; xtype='double'; descr=''; rdm='';
  %set more optional paramaters to user defined values
  for ii=1:nargin-3;
-Line 57 
 for ii=1:nargin-3;
+Line 85 
 for ii=1:nargin-3;
                  strcmp(varargin{ii}{1},'fillval')|...
                  strcmp(varargin{ii}{1},'tileNo')|...
                  strcmp(varargin{ii}{1},'coord')|...
+                 strcmp(varargin{ii}{1},'dimsize')|...
+                 strcmp(varargin{ii}{1},'xtype')|...
                  strcmp(varargin{ii}{1},'dimIn');
              eval([varargin{ii}{1} '=varargin{ii}{2};']);
          else;
-Line 71 
 tileList=unique(convert2vector(tileNo));
+Line 101 
 tileList=unique(convert2vector(tileNo));
  tileList=tileList(~isnan(tileList));
  ntile=length(tileList);
  %
- if isa(fldIn,'gcmfaces');
+ if fldInIsaGcmfaces&~fldInIsEmpty;
   for ff=1:ntile;
     tmp1=[];
     for gg=1:mygrid.nFaces;
-Line 84 
 if isa(fldIn,'gcmfaces');
+Line 114 
 if isa(fldIn,'gcmfaces');
     end;
     fldTiles{ff}=tmp1;
   end;
+  clear fldIn;
+ elseif fldInIsaGcmfaces;
+  for ff=1:ntile;
+    fldTiles{ff}=[];
+  end;
  end;
  %start processing loop
  for ff=1:ntile;
- if isa(fldIn,'gcmfaces');
+ if fldInIsaGcmfaces;
    fldTile=fldTiles{ff};
    %reverse order of dimensions
    nn=length(size(fldTile));
    fldTile=permute(fldTile,[nn:-1:1]);
+   if ntile==1; clear fldTiles; end;
  else;
    fldTile=fldIn;
  end;
  fileTile=[fileOut sprintf('.%04d.nc',ff)];
  %select dimensions of relevance:
- nDim=length(size(fldTile));
+ if ~fldInIsEmpty;
- dimsize=size(fldTile);
+   nDim=length(size(fldTile));
+   dimsize=size(fldTile);
+ elseif ~isempty(dimsize);
+   nDim=length(dimsize);
+ else;
+   error('undertermined array size');
+ end;
  for iDim=1:nDim;
- if size(fldTile,iDim)~=1;
+ if dimsize(iDim)~=1;
      dimlist{iDim}=['i' num2str(iDim)];
      dimName{iDim}=['array index ' num2str(iDim)];
-     eval(['dimvec.i' num2str(iDim) '=[1:size(fldTile,iDim)];']);
+     eval(['dimvec.i' num2str(iDim) '=[1:dimsize(iDim)];']);
  end;
  end;
-Line 138 
 dimOut{ff}=dimlist;
+Line 181 
 dimOut{ff}=dimlist;
  if doCreate;
    %create netcdf file:
    %-------------------
- % ncid=nccreate(fileTile,'NETCDF4');%to allow for big files
+   if prod(dimsize)*4/1e9<1.5;%use (always available) basic netcdf:
-   ncid=nccreate(fileTile,'clobber');
+     mode='clobber';
+   else;%to allow for large file:
+     mode='NETCDF4';
+   end;
+   ncid=nccreateFile(fileTile,mode);
    nc_global=netcdf.getConstant('NC_GLOBAL');
    if ~isempty(rdm);
-Line 153 
 if doCreate;
+Line 200 
 if doCreate;
    netcdf.putAtt(ncid,nc_global,tmp1,rdm{pp});
    end;
    %append readme
-   pp=length(rdm)+1;
+   if length(rdm)>0; pp=length(rdm)+1; tmp1=char(pp+63); else; tmp1='A'; end;
    netcdf.putAtt(ncid,nc_global,tmp1,'file created using gcmfaces_IO/write2nctiles.m');
    ncputAtt(ncid,'','date',date);
    netcdf.putAtt(ncid,nc_global,'Conventions','CF-1.6')
-Line 188 
 if ~isempty(dimIn); dimlist=dimIn{ff}; e
+Line 235 
 if ~isempty(dimIn); dimlist=dimIn{ff}; e
  ncid=ncopen(fileTile,'write');
  %
  netcdf.reDef(ncid);
- ncdefVar(ncid,fldName,'double',flipdim(dimlist,2));%note the direction flip
+ ncdefVar(ncid,fldName,xtype,flipdim(dimlist,2));%note the direction flip
  if ~isempty(longName); ncputAtt(ncid,fldName,'long_name',longName); end;
  if ~isempty(units); ncputAtt(ncid,fldName,'units',units); end;
  if ~isempty(coord); ncputAtt(ncid,fldName,'coordinates',coord); end;
-Line 201 
 if strcmp(fldName,'area'); ncputAtt(ncid
+Line 248 
 if strcmp(fldName,'area'); ncputAtt(ncid
  if strcmp(fldName,'thic'); ncputAtt(ncid,fldName,'standard_name','cell_thickness'); end;
  netcdf.endDef(ncid);
  %
- ncputvar(ncid,fldName,fldTile);
+ if ~fldInIsEmpty; ncputvar(ncid,fldName,fldTile); end;
+ %
  ncclose(ncid);
  end;%for ff=1:ntile;

 Legend:



Removed from v.1.6
 


changed lines


 
Added in v.1.10
 Legend:



Removed from v.1.6
 


changed lines


 
Added in v.1.10
-Removed from v.1.6
+Added in v.1.10

	ViewVC Help
Powered by ViewVC 1.1.22