matlab_class/gcmfaces_IO/grid_load.m

function []=grid_load(dirGrid,nFaces,fileFormat);
%object:    load grid information, convert it to gcmfaces format
%           and encapsulate it in the global mygrid structure.
%inputs:    dirGrid is the directory where the grid files (gcm output) can be found.
%           nFaces is the number of faces in this gcm set-up of current interest.
%           fileFormat is the file format ('straight','cube','compact')

input_list_check('grid_load',nargin);

gcmfaces_global; mygrid=[];

mygrid.dirGrid=dirGrid;
mygrid.nFaces=nFaces;
mygrid.fileFormat=fileFormat;
mygrid.gcm2facesFast=false;

if  ~(nFaces==1&strcmp(fileFormat,'straight'))&...
        ~(nFaces==6&strcmp(fileFormat,'cube'))&...
        ~(nFaces==6&strcmp(fileFormat,'compact'))&...
        ~(nFaces==5&strcmp(fileFormat,'compact'));
    %     if myenv.verbose;
    %         fprintf('\nconvert2gcmfaces.m init: there are several supported file conventions. \n');
    %         fprintf('  By default gcmfaces assumes MITgcm type binary formats as follows: \n')
    %         fprintf('  (1 face) straight global format; (4 or 5 faces) compact global format\n');
    %         fprintf('  (6 faces) cube format with one face after the other. \n');
    %         fprintf('  If this is inadequate, you can change the format below.\n\n');
    %     end;
    error('non-tested topology/fileFormat');
end;

%the various grid fields:
list0={'XC','XG','YC','YG','RAC','RAZ','DXC','DXG','DYC','DYG',...
    'hFacC','hFacS','hFacW','Depth'};
for iFld=1:length(list0);
    eval(['mygrid.' list0{iFld} '=rdmds2gcmfaces([dirGrid ''' list0{iFld} '*'']);']);
end;

list0={'AngleCS','AngleSN'};
test0=~isempty(dir([dirGrid 'AngleCS*']));
if test0;
    for iFld=1:length(list0);
        eval(['mygrid.' list0{iFld} '=rdmds2gcmfaces([dirGrid ''' list0{iFld} '*'']);']);
    end;
else;
    warning('\n AngleCS/AngleSN not found; set to 1/0 assuming lat/lon grid.\n');
    mygrid.AngleCS=mygrid.XC; mygrid.AngleCS(:)=1;
    mygrid.AngleSN=mygrid.XC; mygrid.AngleSN(:)=0;
end;

list0={'RC','RF','DRC','DRF'};
for iFld=1:length(list0);
    eval(['mygrid.' list0{iFld} '=squeeze(rdmds([dirGrid ''' list0{iFld} '*'']));']);
end;

%masks:
mygrid.hFacCsurf=mygrid.hFacC;
for ff=1:mygrid.hFacC.nFaces; mygrid.hFacCsurf{ff}=mygrid.hFacC{ff}(:,:,1); end;

mskC=mygrid.hFacC; mskC(mskC==0)=NaN; mskC(mskC>0)=1; mygrid.mskC=mskC;
mskW=mygrid.hFacW; mskW(mskW==0)=NaN; mskW(mskW>0)=1; mygrid.mskW=mskW;
mskS=mygrid.hFacS; mskS(mskS==0)=NaN; mskS(mskS>0)=1; mygrid.mskS=mskS;

%to allow convert2gcmfaces/doFast:
tmp1=convert2gcmfaces(mygrid.XC);
tmp1(:)=[1:length(tmp1(:))];
nn=length(tmp1(:));
mygrid.gcm2faces=convert2gcmfaces(tmp1);
mygrid.faces2gcmSize=size(tmp1);
mygrid.faces2gcm=convert2gcmfaces(tmp1);
for iFace=1:mygrid.nFaces;
    n=length(mygrid.gcm2faces{iFace}(:));
    mygrid.faces2gcm{iFace}=mygrid.gcm2faces{iFace}(:);
    mygrid.gcm2faces{iFace}=sparse([1:n],mygrid.gcm2faces{iFace}(:),ones(1,n),n,nn);
end;
mygrid.gcm2facesFast=true;


1	gforget	1.5	function []=grid_load(dirGrid,nFaces,fileFormat);
2			%object: load grid information, convert it to gcmfaces format
3			% and encapsulate it in the global mygrid structure.
4			%inputs: dirGrid is the directory where the grid files (gcm output) can be found.
5			% nFaces is the number of faces in this gcm set-up of current interest.
6			% fileFormat is the file format ('straight','cube','compact')
7
8			input_list_check('grid_load',nargin);
9	gforget	1.1
10	gforget	1.7	gcmfaces_global; mygrid=[];
11
12	gforget	1.5	mygrid.dirGrid=dirGrid;
13			mygrid.nFaces=nFaces;
14			mygrid.fileFormat=fileFormat;
15	gforget	1.6	mygrid.gcm2facesFast=false;
16	gforget	1.1
17	gforget	1.5	if ~(nFaces==1&strcmp(fileFormat,'straight'))&...
18			~(nFaces==6&strcmp(fileFormat,'cube'))&...
19			~(nFaces==6&strcmp(fileFormat,'compact'))&...
20			~(nFaces==5&strcmp(fileFormat,'compact'));
21	gforget	1.8	% if myenv.verbose;
22			% fprintf('\nconvert2gcmfaces.m init: there are several supported file conventions. \n');
23			% fprintf(' By default gcmfaces assumes MITgcm type binary formats as follows: \n')
24			% fprintf(' (1 face) straight global format; (4 or 5 faces) compact global format\n');
25			% fprintf(' (6 faces) cube format with one face after the other. \n');
26			% fprintf(' If this is inadequate, you can change the format below.\n\n');
27			% end;
28	gforget	1.5	error('non-tested topology/fileFormat');
29	gforget	1.1	end;
30
31	gforget	1.6	%the various grid fields:
32	gforget	1.1	list0={'XC','XG','YC','YG','RAC','RAZ','DXC','DXG','DYC','DYG',...
33	gforget	1.8	'hFacC','hFacS','hFacW','Depth'};
34	gforget	1.1	for iFld=1:length(list0);
35	gforget	1.8	eval(['mygrid.' list0{iFld} '=rdmds2gcmfaces([dirGrid ''' list0{iFld} '*'']);']);
36	gforget	1.1	end;
37
38	gforget	1.4	list0={'AngleCS','AngleSN'};
39			test0=~isempty(dir([dirGrid 'AngleCS*']));
40			if test0;
41	gforget	1.8	for iFld=1:length(list0);
42			eval(['mygrid.' list0{iFld} '=rdmds2gcmfaces([dirGrid ''' list0{iFld} '*'']);']);
43			end;
44	gforget	1.4	else;
45	gforget	1.8	warning('\n AngleCS/AngleSN not found; set to 1/0 assuming lat/lon grid.\n');
46			mygrid.AngleCS=mygrid.XC; mygrid.AngleCS(:)=1;
47			mygrid.AngleSN=mygrid.XC; mygrid.AngleSN(:)=0;
48	gforget	1.4	end;
49
50	gforget	1.1	list0={'RC','RF','DRC','DRF'};
51			for iFld=1:length(list0);
52	gforget	1.8	eval(['mygrid.' list0{iFld} '=squeeze(rdmds([dirGrid ''' list0{iFld} '*'']));']);
53	gforget	1.1	end;
54
55	gforget	1.6	%masks:
56	gforget	1.1	mygrid.hFacCsurf=mygrid.hFacC;
57			for ff=1:mygrid.hFacC.nFaces; mygrid.hFacCsurf{ff}=mygrid.hFacC{ff}(:,:,1); end;
58
59	gforget	1.2	mskC=mygrid.hFacC; mskC(mskC==0)=NaN; mskC(mskC>0)=1; mygrid.mskC=mskC;
60			mskW=mygrid.hFacW; mskW(mskW==0)=NaN; mskW(mskW>0)=1; mygrid.mskW=mskW;
61			mskS=mygrid.hFacS; mskS(mskS==0)=NaN; mskS(mskS>0)=1; mygrid.mskS=mskS;
62
63	gforget	1.8	%to allow convert2gcmfaces/doFast:
64	gforget	1.6	tmp1=convert2gcmfaces(mygrid.XC);
65	gforget	1.7	tmp1(:)=[1:length(tmp1(:))];
66	gforget	1.6	nn=length(tmp1(:));
67			mygrid.gcm2faces=convert2gcmfaces(tmp1);
68			mygrid.faces2gcmSize=size(tmp1);
69			mygrid.faces2gcm=convert2gcmfaces(tmp1);
70	gforget	1.7	for iFace=1:mygrid.nFaces;
71	gforget	1.8	n=length(mygrid.gcm2faces{iFace}(:));
72			mygrid.faces2gcm{iFace}=mygrid.gcm2faces{iFace}(:);
73			mygrid.gcm2faces{iFace}=sparse([1:n],mygrid.gcm2faces{iFace}(:),ones(1,n),n,nn);
74	gforget	1.6	end;
75			mygrid.gcm2facesFast=true;
76
77	gforget	1.1