source: issm/trunk-jpl/src/py3/classes/calvinglevermann.py@ 19903

from fielddisplay import fielddisplay
from EnumDefinitions import *
from StringToEnum import StringToEnum
from checkfield import checkfield
from WriteData import WriteData

class calvinglevermann(object):
        """
        CALVINGLEVERMANN class definition

           Usage:
              calvinglevermann=calvinglevermann();
        """

        def __init__(self): # {{{

                self.stabilization = 0
                self.spclevelset   = float('NaN')
                self.coeff         = float('NaN')
                self.meltingrate   = float('NaN')

                #set defaults
                self.setdefaultparameters()

                #}}}
        def __repr__(self): # {{{
                string='   Calving Levermann parameters:'
                string="%s\n%s"%(string,fielddisplay(self,'spclevelset','levelset constraints (NaN means no constraint)'))
                string="%s\n%s"%(string,fielddisplay(self,'stabilization','0: no, 1: artificial_diffusivity, 2: streamline upwinding'))
                string="%s\n%s"%(string,fielddisplay(self,'coeff','proportionality coefficient in Levermann model'))
                string="%s\n%s"%(string,fielddisplay(self,'meltingrate','melting rate at given location [m/a]'))

                return string
                #}}}
        def extrude(self,md): # {{{
                self.spclevelset=project3d(md,'vector',self.spclevelset,'type','node')
                self.coeff=project3d(md,'vector',self.coeff,'type','node')
                self.meltingrate=project3d(md,'vector',self.meltingrate,'type','node')
                return self
        #}}}
        def setdefaultparameters(self): # {{{

                #stabilization = 2 by default
                self.stabilization = 2

                #Proportionality coefficient in Levermann model
                self.coeff=2e13;
        #}}}
        def checkconsistency(self,md,solution,analyses):    # {{{

                #Early return
                if (solution!=TransientSolutionEnum()) or (not md.transient.iscalving):
                        return md

                md = checkfield(md,'fieldname','calving.spclevelset','Inf',1,'timeseries',1)
                md = checkfield(md,'fieldname','calving.stabilization','values',[0,1,2]);
                md = checkfield(md,'fieldname','calving.coeff','size',[md.mesh.numberofvertices],'>',0)
                md = checkfield(md,'fieldname','calving.meltingrate','NaN',1,'Inf',1,'size',[md.mesh.numberofvertices],'>=',0)
                return md
        # }}}
        def marshall(self,md,fid):    # {{{
                yts=365.*24.*3600.
                WriteData(fid,'enum',CalvingLawEnum(),'data',CalvingLevermannEnum(),'format','Integer');
                WriteData(fid,'enum',LevelsetStabilizationEnum(),'data',self.stabilization,'format','Integer');
                WriteData(fid,'enum',SpcLevelsetEnum(),'data',self.spclevelset,'format','DoubleMat','mattype',1,'timeserieslength',md.mesh.numberofvertices+1);
                WriteData(fid,'enum',CalvinglevermannCoeffEnum(),'data',self.coeff,'format','DoubleMat','mattype',1)
                WriteData(fid,'object',self,'fieldname','meltingrate','format','DoubleMat','mattype',1,'timeserieslength',md.mesh.numberofvertices+1,'scale',1./yts)
        # }}}