matlab_class/gcmfaces_diags/diags_grid_parms.m

function []=diags_grid_parms(listTimes);
%object : load grid, set params, and save both to dirMat
%input : listTimes is the time list obtained from diags_list_times

%global variables
gcmfaces_global;
global myparms;

%load grid
if isempty(dir('GRID'));
    dirGrid=input('grid directory?\n');
else;
    dirGrid='GRID/'
end;

nF=input('number of faces? (1, 4, 5or 6)\n'); 

frmt=input('file format ? (''straight'', ''cube'' or ''compact'')\n');

memoryLimit=input('memoryLimit ? (0=load full grid, 1=load less, 2=load even less)\n');

grid_load(dirGrid,nF,frmt,memoryLimit);

%set default for model run parameters
choiceParams=input('choice of default parameters? (1=ecco v4, 2=core, 3=ecco2 adjoint, 4=ecco v3, 5=core-Jeff)\n');
myparms=default_parms(choiceParams);

%allow user to change model params if necessary
myparms=review_parms(myparms,listTimes);

function [parms]=default_parms(choiceParams);
%set model parameters to default (ecco_v4)

if choiceParams==1|choiceParams==2|choiceParams==4|choiceParams==5;
parms.yearFirst=1992; %first year covered by model integration
parms.yearLast =2011; %last year covered by model integration
parms.yearInAve=[parms.yearFirst parms.yearLast]; %period for time averages and variance computations
parms.timeStep =3600; %model time step for tracers
parms.iceModel =1;%0=use freezing point   1=use pkg/seaice   2=use pkg/thsice
parms.useRFWF  =1;%1=real fresh water flux 0=virtual salt flux
parms.useNLFS  =2;%2=rstar 1=nlfs 0=linear free surface
parms.rhoconst =1029; %sea water density
parms.rcp      =3994*parms.rhoconst; % sea water rho X heat capacity
parms.rhoi     = 910; %sea ice density
parms.rhosn    = 330; %snow density
parms.flami    = 3.34e05; % latent heat of fusion of ice/snow (J/kg)
parms.flamb    = 2.50e06; % latent heat of evaporation (J/kg)
parms.SIsal0   =4;
if choiceParams==2;
  parms.yearFirst=1948; %first year covered by model integration
  parms.yearLast =2007; %last year covered by model integration
end;
if choiceParams==4;
  parms.useRFWF  =0;%1=real fresh water flux 0=virtual salt flux
  parms.useNLFS  =0;%2=rstar 1=nlfs 0=linear free surface
end;
if choiceParams==5;
 parms.yearFirst=2006; %first year covered by model integration
 parms.yearLast =2305; %last year covered by model integration
 parms.yearInAve = [2006 2305];
end;
end;

if choiceParams==3;
        parms.yearFirst=2004; %first year covered by model integration
        parms.yearLast =2005; %last year covered by model integration
        parms.yearInAve=[parms.yearFirst parms.yearLast]; %period for time averages and variance computations
        parms.timeStep =1200; %model time step for tracers
        parms.iceModel =1;%0=use freezing point   1=use pkg/seaice   2=use pkg/thsice
        parms.useRFWF  =0;%1=real fresh water flux 0=virtual salt flux
        parms.useNLFS  =0;%2=rstar 1=nlfs 0=linear free surface
        parms.rhoconst =1027.5; %sea water density
        parms.rcp      =3994*parms.rhoconst; % sea water rho X heat capacity
        parms.rhoi     = 910; %sea ice density
        parms.rhosn    = 330; %snow density
        parms.flami    = 3.34e05; % latent heat of fusion of ice/snow (J/kg)
        parms.flamb    = 2.50e06; % latent heat of evaporation (J/kg)
        parms.SIsal0   = 0;
end;

function [parms]=review_parms(parms,listTimes);
%review model parameters, correct them if needed, and check a couple more things

test1=1;%so that we print params at least once
while test1;
    fprintf('\n\n');
    gcmfaces_msg('model parameters summary','==== ');
    
    tmp1=sprintf('parms.yearFirst  = %i (first year covered by model integration)',parms.yearFirst); gcmfaces_msg(tmp1,'== ');
    tmp1=sprintf('parms.yearLast   = %i (first year covered by model integration)',parms.yearLast);  gcmfaces_msg(tmp1,'== ');
    tmp1=sprintf('parms.yearInAve  = [%i %i] (time mean and variance years)',parms.yearInAve);  gcmfaces_msg(tmp1,'== ');
    tmp1=sprintf('parms.timeStep   = %i (model time step for tracers)',parms.timeStep);  gcmfaces_msg(tmp1,'== ');
    tmp1=sprintf('parms.iceModel   = %i (0=freezing point  1=pkg/seaice  2=pkg/thsice)',parms.iceModel);  gcmfaces_msg(tmp1,'== ');
    tmp1=sprintf('parms.useRFWF    = %i (1=real fresh water flux 0=virtual salt flux)',parms.useRFWF);  gcmfaces_msg(tmp1,'== ');
    tmp1=sprintf('parms.useNLFS    = %i; (2=rstar 1=nlfs 0=linear free surface)',parms.useNLFS);  gcmfaces_msg(tmp1,'== ');
    tmp1=sprintf('parms.rhoconst   = %0.6g (sea water density)',parms.rhoconst);  gcmfaces_msg(tmp1,'== ');
    tmp1=sprintf('parms.rcp        = %0.6g (sea water density X heat capacity)',parms.rcp);  gcmfaces_msg(tmp1,'== ');
    if parms.iceModel==1;
        tmp1=sprintf('parms.rhoi       = %0.6g (sea ice density)',parms.rhoi);  gcmfaces_msg(tmp1,'== ');
        tmp1=sprintf('parms.rhosn      = %0.6g (snow density)',parms.rhosn);  gcmfaces_msg(tmp1,'== ');
        tmp1=sprintf('parms.flami      = %0.6g (latent heat of fusion of ice/snow in J/kg)',parms.flami);  gcmfaces_msg(tmp1,'== ');
        tmp1=sprintf('parms.flamb      = %0.6g (latent heat of evaporation in J/kg)',parms.flamb);  gcmfaces_msg(tmp1,'== ');
        tmp1=sprintf('parms.SIsal0     = %0.6g (sea ice constant salinity)',parms.SIsal0);  gcmfaces_msg(tmp1,'== ');
        %tmp1=sprintf('',);  gcmfaces_msg(tmp1,'== ');
    else;
        error('only parms.iceModel=1 is currently treated\n');
    end;
    
    gcmfaces_msg('to change a param type e.g. ''parms.yearFirst=1;'' or hit return if all params are ok. Change a param?','==== ');
    tmp1=input('');
    test1=~isempty(tmp1); %so that we change param and iterate process
    if test1; eval(tmp1); end;
    
end;

%determine a few more things about the diagnostic time axis
fprintf('\n\n');
parms.diagsNbRec=length(listTimes);
test1=median(diff(listTimes)*parms.timeStep/86400);
if abs(test1-30.5)<1; parms.diagsAreMonthly=1; else; parms.diagsAreMonthly=0; end;
if abs(test1-365.25)<1; parms.diagsAreAnnual=1; else; parms.diagsAreAnnual=0; end;
tmp1=sprintf('parms.diagsNbRec       = %i (number of records, based on model output files)',parms.diagsNbRec); gcmfaces_msg(tmp1,'== ');
tmp1=sprintf('parms.diagsAreMonthly  = %i (0/1 = false/true; based on output frequency)',parms.diagsAreMonthly); gcmfaces_msg(tmp1,'== ');
tmp1=sprintf('parms.diagsAreAnnual   = %i (0/1 = false/true; based on output frequency)',parms.diagsAreAnnual); gcmfaces_msg(tmp1,'== ');
gcmfaces_msg('hit return if this seems correct otherwise stop here','== '); test0=input(''); if ~isempty(test0); error('likely dir problem'); end;

listTimes2=parms.yearFirst+listTimes*parms.timeStep/86400/365.25;%this approximation of course makes things simpler
tmp1=-0.5*diff(listTimes,1,1)*parms.timeStep/86400/365.25; tmp1=[median(tmp1);tmp1];
listTimes2=listTimes2+tmp1;%this converts the enddate to the middate of pkg/diags
ii=find(listTimes2>=parms.yearInAve(1)&listTimes2<=parms.yearInAve(2)+1);
if parms.diagsAreMonthly;%then restrict to full years
    ni=floor(length(ii)/12)*12; 
    if ni>0; 
      parms.recInAve=[ii(1) ii(floor(ni))];
    else;
      parms.recInAve=[ii(1) ii(end)];
    end;
elseif ~isempty(ii);
    parms.recInAve=[ii(1) ii(end)];
else;
    parms.recInAve=[1 1];
end;
tmp1=sprintf('parms.recInAve  = [%i %i] (time mean and variance records)',parms.recInAve);  gcmfaces_msg(tmp1,'== ');

fprintf('\n\n');

1	gforget	1.1	function []=diags_grid_parms(listTimes);
2			%object : load grid, set params, and save both to dirMat
3			%input : listTimes is the time list obtained from diags_list_times
4
5			%global variables
6			gcmfaces_global;
7			global myparms;
8
9			%load grid
10			if isempty(dir('GRID'));
11			dirGrid=input('grid directory?\n');
12			else;
13			dirGrid='GRID/'
14			end;
15	gforget	1.2
16			nF=input('number of faces? (1, 4, 5or 6)\n');
17
18			frmt=input('file format ? (''straight'', ''cube'' or ''compact'')\n');
19
20			memoryLimit=input('memoryLimit ? (0=load full grid, 1=load less, 2=load even less)\n');
21
22			grid_load(dirGrid,nF,frmt,memoryLimit);
23	gforget	1.1
24			%set default for model run parameters
25	gforget	1.6	choiceParams=input('choice of default parameters? (1=ecco v4, 2=core, 3=ecco2 adjoint, 4=ecco v3, 5=core-Jeff)\n');
26	gforget	1.2	myparms=default_parms(choiceParams);
27	gforget	1.1
28			%allow user to change model params if necessary
29			myparms=review_parms(myparms,listTimes);
30
31	gforget	1.2	function [parms]=default_parms(choiceParams);
32	gforget	1.1	%set model parameters to default (ecco_v4)
33
34	gforget	1.6	if choiceParams==1\|choiceParams==2\|choiceParams==4\|choiceParams==5;
35	gforget	1.3	parms.yearFirst=1992; %first year covered by model integration
36	gforget	1.5	parms.yearLast =2011; %last year covered by model integration
37	gforget	1.1	parms.yearInAve=[parms.yearFirst parms.yearLast]; %period for time averages and variance computations
38	gforget	1.3	parms.timeStep =3600; %model time step for tracers
39	gforget	1.1	parms.iceModel =1;%0=use freezing point 1=use pkg/seaice 2=use pkg/thsice
40	gforget	1.3	parms.useRFWF =1;%1=real fresh water flux 0=virtual salt flux
41			parms.useNLFS =2;%2=rstar 1=nlfs 0=linear free surface
42			parms.rhoconst =1029; %sea water density
43	gforget	1.1	parms.rcp =3994*parms.rhoconst; % sea water rho X heat capacity
44			parms.rhoi = 910; %sea ice density
45			parms.rhosn = 330; %snow density
46			parms.flami = 3.34e05; % latent heat of fusion of ice/snow (J/kg)
47			parms.flamb = 2.50e06; % latent heat of evaporation (J/kg)
48	gforget	1.3	parms.SIsal0 =4;
49	gforget	1.2	if choiceParams==2;
50			parms.yearFirst=1948; %first year covered by model integration
51			parms.yearLast =2007; %last year covered by model integration
52			end;
53	gforget	1.4	if choiceParams==4;
54			parms.useRFWF =0;%1=real fresh water flux 0=virtual salt flux
55			parms.useNLFS =0;%2=rstar 1=nlfs 0=linear free surface
56			end;
57	gforget	1.6	if choiceParams==5;
58			parms.yearFirst=2006; %first year covered by model integration
59			parms.yearLast =2305; %last year covered by model integration
60			parms.yearInAve = [2006 2305];
61			end;
62	gforget	1.2	end;
63
64			if choiceParams==3;
65			parms.yearFirst=2004; %first year covered by model integration
66			parms.yearLast =2005; %last year covered by model integration
67			parms.yearInAve=[parms.yearFirst parms.yearLast]; %period for time averages and variance computations
68			parms.timeStep =1200; %model time step for tracers
69			parms.iceModel =1;%0=use freezing point 1=use pkg/seaice 2=use pkg/thsice
70			parms.useRFWF =0;%1=real fresh water flux 0=virtual salt flux
71			parms.useNLFS =0;%2=rstar 1=nlfs 0=linear free surface
72			parms.rhoconst =1027.5; %sea water density
73			parms.rcp =3994*parms.rhoconst; % sea water rho X heat capacity
74			parms.rhoi = 910; %sea ice density
75			parms.rhosn = 330; %snow density
76			parms.flami = 3.34e05; % latent heat of fusion of ice/snow (J/kg)
77			parms.flamb = 2.50e06; % latent heat of evaporation (J/kg)
78			parms.SIsal0 = 0;
79			end;
80	gforget	1.1
81			function [parms]=review_parms(parms,listTimes);
82			%review model parameters, correct them if needed, and check a couple more things
83
84			test1=1;%so that we print params at least once
85			while test1;
86			fprintf('\n\n');
87			gcmfaces_msg('model parameters summary','==== ');
88
89			tmp1=sprintf('parms.yearFirst = %i (first year covered by model integration)',parms.yearFirst); gcmfaces_msg(tmp1,'== ');
90			tmp1=sprintf('parms.yearLast = %i (first year covered by model integration)',parms.yearLast); gcmfaces_msg(tmp1,'== ');
91			tmp1=sprintf('parms.yearInAve = [%i %i] (time mean and variance years)',parms.yearInAve); gcmfaces_msg(tmp1,'== ');
92			tmp1=sprintf('parms.timeStep = %i (model time step for tracers)',parms.timeStep); gcmfaces_msg(tmp1,'== ');
93			tmp1=sprintf('parms.iceModel = %i (0=freezing point 1=pkg/seaice 2=pkg/thsice)',parms.iceModel); gcmfaces_msg(tmp1,'== ');
94			tmp1=sprintf('parms.useRFWF = %i (1=real fresh water flux 0=virtual salt flux)',parms.useRFWF); gcmfaces_msg(tmp1,'== ');
95			tmp1=sprintf('parms.useNLFS = %i; (2=rstar 1=nlfs 0=linear free surface)',parms.useNLFS); gcmfaces_msg(tmp1,'== ');
96			tmp1=sprintf('parms.rhoconst = %0.6g (sea water density)',parms.rhoconst); gcmfaces_msg(tmp1,'== ');
97			tmp1=sprintf('parms.rcp = %0.6g (sea water density X heat capacity)',parms.rcp); gcmfaces_msg(tmp1,'== ');
98			if parms.iceModel==1;
99			tmp1=sprintf('parms.rhoi = %0.6g (sea ice density)',parms.rhoi); gcmfaces_msg(tmp1,'== ');
100			tmp1=sprintf('parms.rhosn = %0.6g (snow density)',parms.rhosn); gcmfaces_msg(tmp1,'== ');
101			tmp1=sprintf('parms.flami = %0.6g (latent heat of fusion of ice/snow in J/kg)',parms.flami); gcmfaces_msg(tmp1,'== ');
102			tmp1=sprintf('parms.flamb = %0.6g (latent heat of evaporation in J/kg)',parms.flamb); gcmfaces_msg(tmp1,'== ');
103			tmp1=sprintf('parms.SIsal0 = %0.6g (sea ice constant salinity)',parms.SIsal0); gcmfaces_msg(tmp1,'== ');
104			%tmp1=sprintf('',); gcmfaces_msg(tmp1,'== ');
105			else;
106			error('only parms.iceModel=1 is currently treated\n');
107			end;
108
109			gcmfaces_msg('to change a param type e.g. ''parms.yearFirst=1;'' or hit return if all params are ok. Change a param?','==== ');
110			tmp1=input('');
111			test1=~isempty(tmp1); %so that we change param and iterate process
112			if test1; eval(tmp1); end;
113
114			end;
115
116			%determine a few more things about the diagnostic time axis
117			fprintf('\n\n');
118			parms.diagsNbRec=length(listTimes);
119			test1=median(diff(listTimes)*parms.timeStep/86400);
120			if abs(test1-30.5)<1; parms.diagsAreMonthly=1; else; parms.diagsAreMonthly=0; end;
121			if abs(test1-365.25)<1; parms.diagsAreAnnual=1; else; parms.diagsAreAnnual=0; end;
122			tmp1=sprintf('parms.diagsNbRec = %i (number of records, based on model output files)',parms.diagsNbRec); gcmfaces_msg(tmp1,'== ');
123			tmp1=sprintf('parms.diagsAreMonthly = %i (0/1 = false/true; based on output frequency)',parms.diagsAreMonthly); gcmfaces_msg(tmp1,'== ');
124			tmp1=sprintf('parms.diagsAreAnnual = %i (0/1 = false/true; based on output frequency)',parms.diagsAreAnnual); gcmfaces_msg(tmp1,'== ');
125			gcmfaces_msg('hit return if this seems correct otherwise stop here','== '); test0=input(''); if ~isempty(test0); error('likely dir problem'); end;
126
127			listTimes2=parms.yearFirst+listTimes*parms.timeStep/86400/365.25;%this approximation of course makes things simpler
128			tmp1=-0.5diff(listTimes,1,1)parms.timeStep/86400/365.25; tmp1=[median(tmp1);tmp1];
129			listTimes2=listTimes2+tmp1;%this converts the enddate to the middate of pkg/diags
130			ii=find(listTimes2>=parms.yearInAve(1)&listTimes2<=parms.yearInAve(2)+1);
131			if parms.diagsAreMonthly;%then restrict to full years
132	gforget	1.6	ni=floor(length(ii)/12)*12;
133			if ni>0;
134			parms.recInAve=[ii(1) ii(floor(ni))];
135			else;
136			parms.recInAve=[ii(1) ii(end)];
137			end;
138	gforget	1.1	elseif ~isempty(ii);
139			parms.recInAve=[ii(1) ii(end)];
140			else;
141			parms.recInAve=[1 1];
142			end;
143			tmp1=sprintf('parms.recInAve = [%i %i] (time mean and variance records)',parms.recInAve); gcmfaces_msg(tmp1,'== ');
144
145			fprintf('\n\n');
146