matlab_class/gcmfaces_calc/calc_budget_heat.m

function [budgO,budgI,budgOI]=calc_budget_heat(kBudget);
% CALC_BUDGET_HEAT(kBudget)

gcmfaces_global;

%get variables from caller routine:
%----------------------------------

global myparms;

list_variables={'THETA','AB_gT','TRELAX','SIheff','SIhsnow',...
                'TFLUX','geothFlux','SItflux','SIaaflux','oceQnet',...
                'SIatmQnt','SIsnPrcp','SIacSubl','WTHMASS',...
                'ADVx_TH','DFxE_TH','ADVy_TH','DFyE_TH',...
                'ADVxHEFF','ADVxSNOW','DFxEHEFF','DFxESNOW',...
                'ADVyHEFF','ADVySNOW','DFyEHEFF','DFyESNOW'};

if kBudget>1; 
  list_variables={list_variables{:},'oceQsw','ADVr_TH','DFrE_TH',...
                  'DFrI_TH','ADVr_TH','DFrE_TH','DFrI_TH'};
end;

for vv=1:length(list_variables);
  v = evalin('caller',list_variables{vv});
  eval([list_variables{vv} '=v;']);
end;
clear v;

test3d=length(size(ADVx_TH{1}))>2;

%compute mapped budget:
%----------------------

budgO.tend=myparms.rcp*THETA-myparms.rcp*AB_gT;
budgI.tend=-myparms.flami*(SIheff*myparms.rhoi+SIhsnow*myparms.rhosn);
%
budgO.tend=mk3D(mygrid.RAC,budgO.tend).*budgO.tend;%Watt
budgI.tend=mygrid.RAC.*budgI.tend;%Watt
%
budgO.tend=nansum(budgO.tend,3);
budgOI.tend=budgO.tend+budgI.tend;

%vertical divergence (air-sea fluxes or vertical adv/dif)
budgO.zconv=TFLUX+geothFlux;
budgI.zconv=-(SItflux+TFLUX-TRELAX);
%in linear surface we omit :
if ~myparms.useNLFS; budgO.zconv=budgO.zconv-myparms.rcp*WTHMASS; end;
%in virtual salt flux we omit :
if ~myparms.useRFWF|~myparms.useNLFS; budgI.zconv=budgI.zconv+SIaaflux; end;
%working approach for real fresh water (?) and virtual salt flux
if 0; budgI.zconv=-oceQnet-SIatmQnt-myparms.flami*(SIsnPrcp-SIacSubl); end;
%for deep ocean layer :
if kBudget>1;
budgO.zconv=-(ADVr_TH+DFrE_TH+DFrI_TH)./mygrid.RAC*myparms.rcp;
dd=mygrid.RF(kBudget); msk=mygrid.mskC(:,:,kBudget);
swfrac=0.62*exp(dd/0.6)+(1-0.62)*exp(dd/20);
if dd<-200; swfrac=0; end;
budgO.zconv=budgO.zconv+swfrac*oceQsw+geothFlux;%.*msk;
end;
%
%note: geothFlux remains to be accounted for in the following
if test3d;
  trWtop=-(ADVr_TH+DFrE_TH+DFrI_TH)*myparms.rcp;
  %
  dd=mygrid.RF(1:end-1);
  swfrac=0.62*exp(dd/0.6)+(1-0.62)*exp(dd/20);
  swfrac(dd<-200)=0;
  swtop=mk3D(swfrac,trWtop).*mk3D(mygrid.RAC.*oceQsw,trWtop);
  swtop(isnan(mygrid.mskC))=0;
  trWtop=trWtop+swtop;
  %
  trWtop(:,:,1)=budgO.zconv.*mygrid.RAC;
  trWbot=trWtop(:,:,2:length(mygrid.RC));
  trWbot(:,:,length(mygrid.RC))=0;
  %
  budgO.fluxes.trWtop=trWtop;%Watt
  budgO.fluxes.trWbot=trWbot;%Watt
else;
  budgO.fluxes.trWtop=mygrid.RAC.*(budgO.zconv-geothFlux);
  budgO.fluxes.trWbot=mygrid.RAC.*geothFlux;%Watt
end;
budgI.fluxes.trWtop=mygrid.RAC.*(budgI.zconv+budgO.zconv);
budgI.fluxes.trWbot=mygrid.RAC.*budgO.zconv;%Watt
%
budgO.zconv=mk3D(mygrid.RAC,budgO.zconv).*budgO.zconv;%Watt
budgI.zconv=mygrid.RAC.*budgI.zconv;%Watt
budgOI.zconv=budgO.zconv+budgI.zconv;

%horizontal divergence (advection and diffusion)
tmpUo=myparms.rcp*(ADVx_TH+DFxE_TH); tmpVo=myparms.rcp*(ADVy_TH+DFyE_TH);
budgO.hconv=calc_UV_conv(nansum(tmpUo,3),nansum(tmpVo,3));
tmpUi=-myparms.flami*(myparms.rhoi*DFxEHEFF+myparms.rhosn*DFxESNOW+myparms.rhoi*ADVxHEFF+myparms.rhosn*ADVxSNOW);
tmpVi=-myparms.flami*(myparms.rhoi*DFyEHEFF+myparms.rhosn*DFyESNOW+myparms.rhoi*ADVyHEFF+myparms.rhosn*ADVySNOW);
budgI.hconv=calc_UV_conv(tmpUi,tmpVi); %no dh needed here
budgOI.hconv=budgO.hconv+budgI.hconv;
%
budgO.fluxes.trU=tmpUo; budgO.fluxes.trV=tmpVo;%Watt
budgI.fluxes.trU=tmpUi; budgI.fluxes.trV=tmpVi;%Watt

1	gforget	1.3	function [budgO,budgI,budgOI]=calc_budget_heat(kBudget);
2	gforget	1.1	% CALC_BUDGET_HEAT(kBudget)
3
4			gcmfaces_global;
5
6			%get variables from caller routine:
7			%----------------------------------
8
9			global myparms;
10
11			list_variables={'THETA','AB_gT','TRELAX','SIheff','SIhsnow',...
12			'TFLUX','geothFlux','SItflux','SIaaflux','oceQnet',...
13			'SIatmQnt','SIsnPrcp','SIacSubl','WTHMASS',...
14			'ADVx_TH','DFxE_TH','ADVy_TH','DFyE_TH',...
15			'ADVxHEFF','ADVxSNOW','DFxEHEFF','DFxESNOW',...
16			'ADVyHEFF','ADVySNOW','DFyEHEFF','DFyESNOW'};
17
18			if kBudget>1;
19			list_variables={list_variables{:},'oceQsw','ADVr_TH','DFrE_TH',...
20			'DFrI_TH','ADVr_TH','DFrE_TH','DFrI_TH'};
21			end;
22
23			for vv=1:length(list_variables);
24			v = evalin('caller',list_variables{vv});
25			eval([list_variables{vv} '=v;']);
26			end;
27			clear v;
28
29			test3d=length(size(ADVx_TH{1}))>2;
30
31			%compute mapped budget:
32			%----------------------
33
34	gforget	1.5	budgO.tend=myparms.rcpTHETA-myparms.rcpAB_gT;
35			budgI.tend=-myparms.flami(SIheffmyparms.rhoi+SIhsnow*myparms.rhosn);
36	gforget	1.1	%
37	gforget	1.5	budgO.tend=mk3D(mygrid.RAC,budgO.tend).*budgO.tend;%Watt
38			budgI.tend=mygrid.RAC.*budgI.tend;%Watt
39	gforget	1.1	%
40	gforget	1.5	budgO.tend=nansum(budgO.tend,3);
41			budgOI.tend=budgO.tend+budgI.tend;
42	gforget	1.1
43			%vertical divergence (air-sea fluxes or vertical adv/dif)
44	gforget	1.5	budgO.zconv=TFLUX+geothFlux;
45			budgI.zconv=-(SItflux+TFLUX-TRELAX);
46	gforget	1.1	%in linear surface we omit :
47	gforget	1.5	if ~myparms.useNLFS; budgO.zconv=budgO.zconv-myparms.rcp*WTHMASS; end;
48	gforget	1.1	%in virtual salt flux we omit :
49	gforget	1.5	if ~myparms.useRFWF\|~myparms.useNLFS; budgI.zconv=budgI.zconv+SIaaflux; end;
50	gforget	1.1	%working approach for real fresh water (?) and virtual salt flux
51	gforget	1.5	if 0; budgI.zconv=-oceQnet-SIatmQnt-myparms.flami*(SIsnPrcp-SIacSubl); end;
52	gforget	1.1	%for deep ocean layer :
53			if kBudget>1;
54	gforget	1.5	budgO.zconv=-(ADVr_TH+DFrE_TH+DFrI_TH)./mygrid.RAC*myparms.rcp;
55	gforget	1.1	dd=mygrid.RF(kBudget); msk=mygrid.mskC(:,:,kBudget);
56			swfrac=0.62exp(dd/0.6)+(1-0.62)exp(dd/20);
57			if dd<-200; swfrac=0; end;
58	gforget	1.5	budgO.zconv=budgO.zconv+swfracoceQsw+geothFlux;%.msk;
59	gforget	1.1	end;
60			%
61			%note: geothFlux remains to be accounted for in the following
62			if test3d;
63			trWtop=-(ADVr_TH+DFrE_TH+DFrI_TH)*myparms.rcp;
64			%
65			dd=mygrid.RF(1:end-1);
66			swfrac=0.62exp(dd/0.6)+(1-0.62)exp(dd/20);
67			swfrac(dd<-200)=0;
68			swtop=mk3D(swfrac,trWtop).mk3D(mygrid.RAC.oceQsw,trWtop);
69			swtop(isnan(mygrid.mskC))=0;
70			trWtop=trWtop+swtop;
71			%
72	gforget	1.5	trWtop(:,:,1)=budgO.zconv.*mygrid.RAC;
73	gforget	1.1	trWbot=trWtop(:,:,2:length(mygrid.RC));
74			trWbot(:,:,length(mygrid.RC))=0;
75			%
76	gforget	1.5	budgO.fluxes.trWtop=trWtop;%Watt
77			budgO.fluxes.trWbot=trWbot;%Watt
78	gforget	1.1	else;
79	gforget	1.5	budgO.fluxes.trWtop=mygrid.RAC.*(budgO.zconv-geothFlux);
80			budgO.fluxes.trWbot=mygrid.RAC.*geothFlux;%Watt
81	gforget	1.1	end;
82	gforget	1.5	budgI.fluxes.trWtop=mygrid.RAC.*(budgI.zconv+budgO.zconv);
83			budgI.fluxes.trWbot=mygrid.RAC.*budgO.zconv;%Watt
84			%
85			budgO.zconv=mk3D(mygrid.RAC,budgO.zconv).*budgO.zconv;%Watt
86			budgI.zconv=mygrid.RAC.*budgI.zconv;%Watt
87			budgOI.zconv=budgO.zconv+budgI.zconv;
88	gforget	1.1
89			%horizontal divergence (advection and diffusion)
90			tmpUo=myparms.rcp(ADVx_TH+DFxE_TH); tmpVo=myparms.rcp(ADVy_TH+DFyE_TH);
91	gforget	1.5	budgO.hconv=calc_UV_conv(nansum(tmpUo,3),nansum(tmpVo,3));
92	gforget	1.1	tmpUi=-myparms.flami(myparms.rhoiDFxEHEFF+myparms.rhosnDFxESNOW+myparms.rhoiADVxHEFF+myparms.rhosn*ADVxSNOW);
93			tmpVi=-myparms.flami(myparms.rhoiDFyEHEFF+myparms.rhosnDFyESNOW+myparms.rhoiADVyHEFF+myparms.rhosn*ADVySNOW);
94	gforget	1.5	budgI.hconv=calc_UV_conv(tmpUi,tmpVi); %no dh needed here
95			budgOI.hconv=budgO.hconv+budgI.hconv;
96	gforget	1.1	%
97	gforget	1.5	budgO.fluxes.trU=tmpUo; budgO.fluxes.trV=tmpVo;%Watt
98			budgI.fluxes.trU=tmpUi; budgI.fluxes.trV=tmpVi;%Watt
99	gforget	1.1