source: issm/trunk-jpl/src/m/classes/SMBforcing.py@ 23833

import numpy as np
from fielddisplay import fielddisplay
from checkfield import checkfield
from WriteData import WriteData
from project3d import project3d

class SMBforcing(object):
    """
    SMBforcing Class definition

       Usage:
          SMB=SMBforcing();
    """

    def __init__(self): # {{{
        self.mass_balance = float('NaN')
        self.requested_outputs      = []
        self.isclimatology = 0
        #}}}
    def __repr__(self): # {{{
        string="   surface forcings parameters:"
        string="%s\n%s"%(string,fielddisplay(self,'mass_balance','surface mass balance [m/yr ice eq]'))
        string="%s\n%s"%(string,fielddisplay(self,'isclimatology','repeat all forcings when past last forcing time (default false)'))
        string="%s\n%s"%(string,fielddisplay(self,'requested_outputs','additional outputs requested'))
        return string
        #}}}
    def extrude(self,md): # {{{

        self.mass_balance=project3d(md,'vector',self.mass_balance,'type','node');
        return self
    #}}}
    def defaultoutputs(self,md): # {{{
        return []
    #}}}
    def initialize(self,md): # {{{

        if np.all(np.isnan(self.mass_balance)):
            self.mass_balance=np.zeros((md.mesh.numberofvertices))
            print("      no SMBforcing.mass_balance specified: values set as zero")

        return self
    #}}}
    def checkconsistency(self,md,solution,analyses):    # {{{

        if 'MasstransportAnalysis' in analyses:
            md = checkfield(md,'fieldname','smb.mass_balance','timeseries',1,'NaN',1,'Inf',1)

        if 'BalancethicknessAnalysis' in analyses:
            md = checkfield(md,'fieldname','smb.mass_balance','size',[md.mesh.numberofvertices],'NaN',1,'Inf',1)

        md = checkfield(md,'fieldname','masstransport.requested_outputs','stringrow',1)
        md = checkfield(md,'fieldname','smb.isclimatology','values',[0,1])
        if (self.isclimatology>0):
            md = checkfield(md,'fieldname', 'smb.mass_balance', 'size',[md.mesh.numberofvertices+1],'message','mass_balance must have md.mesh.numberofvertices+1 rows in order to force a climatology')

        return md
    # }}}
    def marshall(self,prefix,md,fid):    # {{{

        yts=md.constants.yts

        WriteData(fid,prefix,'name','md.smb.model','data',1,'format','Integer');
        WriteData(fid,prefix,'object',self,'class','smb','fieldname','mass_balance','format','DoubleMat','mattype',1,'scale',1./yts,'timeserieslength',md.mesh.numberofvertices+1,'yts',md.constants.yts)
        #WriteData(fid,prefix,'object',self,'class','smb','fieldname','mass_balance','format','CompressedMat','mattype',1,'scale',1./yts,'timeserieslength',md.mesh.numberofvertices+1,'yts',md.constants.yts);
        
        #process requested outputs
        outputs = self.requested_outputs
        indices = [i for i, x in enumerate(outputs) if x == 'default']
        if len(indices) > 0:
            outputscopy=outputs[0:max(0,indices[0]-1)]+self.defaultoutputs(md)+outputs[indices[0]+1:]
            outputs    =outputscopy
        WriteData(fid,prefix,'data',outputs,'name','md.smb.requested_outputs','format','StringArray')
        WriteData(fid,prefix,'object',self,'class','smb','fieldname','isclimatology','format','Boolean')

    # }}}