source: issm/trunk/src/m/classes/basalforcings.m@ 21341

%BASAL FORCINGS class definition
%
%   Usage:
%      basalforcings=basalforcings();

classdef basalforcings
        properties (SetAccess=public) 
                groundedice_melting_rate  = NaN;
                floatingice_melting_rate  = NaN;
                geothermalflux            = NaN;
        end
        methods
                function self = extrude(self,md) % {{{
                        self.groundedice_melting_rate=project3d(md,'vector',self.groundedice_melting_rate,'type','node','layer',1); 
                        self.floatingice_melting_rate=project3d(md,'vector',self.floatingice_melting_rate,'type','node','layer',1); 
                        self.geothermalflux=project3d(md,'vector',self.geothermalflux,'type','node','layer',1); %bedrock only gets geothermal flux
                end % }}}
                function self = basalforcings(varargin) % {{{
                        switch nargin
                                case 0
                                        self=setdefaultparameters(self);
                                otherwise
                                        error('constructor not supported');
                        end
                end % }}}
                function self = initialize(self,md) % {{{

                        if isnan(self.groundedice_melting_rate),
                                self.groundedice_melting_rate=zeros(md.mesh.numberofvertices,1);
                                disp('      no basalforcings.groundedice_melting_rate specified: values set as zero');
                        end

                        if isnan(self.floatingice_melting_rate),
                                self.floatingice_melting_rate=zeros(md.mesh.numberofvertices,1);
                                disp('      no basalforcings.floatingice_melting_rate specified: values set as zero');
                        end

                end % }}}
                function self = setdefaultparameters(self) % {{{

                end % }}}
                function md = checkconsistency(self,md,solution,analyses) % {{{

                        if ismember('MasstransportAnalysis',analyses) & ~(strcmp(solution,'TransientSolution') & md.transient.ismasstransport==0),
                                md = checkfield(md,'fieldname','basalforcings.groundedice_melting_rate','NaN',1,'Inf',1,'timeseries',1);
                                md = checkfield(md,'fieldname','basalforcings.floatingice_melting_rate','NaN',1,'Inf',1,'timeseries',1);
                        end
                        if ismember('BalancethicknessAnalysis',analyses),
                                md = checkfield(md,'fieldname','basalforcings.groundedice_melting_rate','NaN',1,'Inf',1,'size',[md.mesh.numberofvertices 1]);
                                md = checkfield(md,'fieldname','basalforcings.floatingice_melting_rate','NaN',1,'Inf',1,'size',[md.mesh.numberofvertices 1]);
                        end
                        if ismember('ThermalAnalysis',analyses) & ~(strcmp(solution,'TransientSolution') & md.transient.isthermal==0),
                                md = checkfield(md,'fieldname','basalforcings.groundedice_melting_rate','NaN',1,'Inf',1,'timeseries',1);
                                md = checkfield(md,'fieldname','basalforcings.floatingice_melting_rate','NaN',1,'Inf',1,'timeseries',1);
                                md = checkfield(md,'fieldname','basalforcings.geothermalflux','NaN',1,'Inf',1,'timeseries',1,'>=',0);
                        end
                end % }}}
                function disp(self) % {{{
                        disp(sprintf('   basal forcings parameters:'));

                        fielddisplay(self,'groundedice_melting_rate','basal melting rate (positive if melting) [m/yr]');
                        fielddisplay(self,'floatingice_melting_rate','basal melting rate (positive if melting) [m/yr]');
                        fielddisplay(self,'geothermalflux','geothermal heat flux [W/m^2]');

                end % }}}
                function marshall(self,prefix,md,fid) % {{{

                        yts=md.constants.yts;

                        WriteData(fid,prefix,'name','md.basalforcings.model','data',1,'format','Integer');
                        WriteData(fid,prefix,'object',self,'fieldname','groundedice_melting_rate','format','DoubleMat','mattype',1,'scale',1./yts,'timeserieslength',md.mesh.numberofvertices+1,'yts',md.constants.yts)
                        WriteData(fid,prefix,'object',self,'fieldname','floatingice_melting_rate','format','DoubleMat','mattype',1,'scale',1./yts,'timeserieslength',md.mesh.numberofvertices+1,'yts',md.constants.yts)
                        WriteData(fid,prefix,'object',self,'fieldname','geothermalflux','format','DoubleMat','mattype',1,'timeserieslength',md.mesh.numberofvertices+1,'yts',md.constants.yts);
                end % }}}
                function savemodeljs(self,fid,modelname) % {{{
                
                        writejs1Darray(fid,[modelname '.basalforcings.groundedice_melting_rate'],self.groundedice_melting_rate);
                        writejs1Darray(fid,[modelname '.basalforcings.floatingice_melting_rate'],self.floatingice_melting_rate);
                        writejs1Darray(fid,[modelname '.basalforcings.geothermalflux'],self.geothermalflux);

                end % }}}
        end
end