source: issm/trunk-jpl/src/m/classes/mask.py@ 15604

Last change on this file since 15604 was 15604, checked in by cborstad, 12 years ago

CHG: mask.py syntax can be more like matlab

File size: 3.1 KB
Line 
1from fielddisplay import fielddisplay
2from EnumDefinitions import *
3from checkfield import *
4from WriteData import *
5
6class mask(object):
7 """
8 MASK class definition
9
10 Usage:
11 mask=mask();
12 """
13
14 def __init__(self): # {{{
15 self.elementonfloatingice = float('NaN')
16 self.elementongroundedice = float('NaN')
17 self.elementonwater = float('NaN')
18 self.vertexonfloatingice = float('NaN')
19 self.vertexongroundedice = float('NaN')
20 self.vertexonwater = float('NaN')
21 self.icelevelset = float('NaN')
22
23 #set defaults
24 self.setdefaultparameters()
25
26 #}}}
27 def __repr__(self): # {{{
28 string=" masks:"
29
30 string="%s\n%s"%(string,fielddisplay(self,"elementonfloatingice","element on floating ice flags list"))
31 string="%s\n%s"%(string,fielddisplay(self,"vertexonfloatingice","vertex on floating ice flags list"))
32 string="%s\n%s"%(string,fielddisplay(self,"elementongroundedice","element on grounded ice list"))
33 string="%s\n%s"%(string,fielddisplay(self,"vertexongroundedice","vertex on grounded ice flags list"))
34 string="%s\n%s"%(string,fielddisplay(self,"elementonwater","element on water flags list"))
35 string="%s\n%s"%(string,fielddisplay(self,"vertexonwater","vertex on water flags list"))
36 string="%s\n%s"%(string,fielddisplay(self,"icelevelset","presence of ice if > 0, icefront position if = 0, no ice if < 0"))
37 return string
38 #}}}
39 def setdefaultparameters(self): # {{{
40 return self
41 #}}}
42 def checkconsistency(self,md,solution,analyses): # {{{
43
44 md = checkfield(md,'mask.elementonfloatingice','size',[md.mesh.numberofelements],'values',[0,1])
45 md = checkfield(md,'mask.elementongroundedice','size',[md.mesh.numberofelements],'values',[0,1])
46 md = checkfield(md,'mask.elementonwater' ,'size',[md.mesh.numberofelements],'values',[0,1])
47 md = checkfield(md,'mask.vertexonfloatingice' ,'size',[md.mesh.numberofvertices],'values',[0,1])
48 md = checkfield(md,'mask.vertexongroundedice' ,'size',[md.mesh.numberofvertices],'values',[0,1])
49 md = checkfield(md,'mask.vertexonwater' ,'size',[md.mesh.numberofvertices],'values',[0,1])
50 md = checkfield(md,'mask.icelevelset' ,'size',[md.mesh.numberofvertices])
51 isice=numpy.array(md.mask.icelevelset>0,int)
52 totallyicefree=(numpy.sum(isice[md.mesh.elements-1],axis=1)==0).astype(int)
53 if any(totallyicefree):
54 raise TypeError("elements with no ice not implemented yet, each element should have at least one vertex with md.mask.icelevelset > 0")
55
56 return md
57 # }}}
58 def marshall(self,md,fid): # {{{
59 WriteData(fid,'object',self,'fieldname','elementonfloatingice','format','BooleanMat','mattype',2)
60 WriteData(fid,'object',self,'fieldname','elementongroundedice','format','BooleanMat','mattype',2)
61 WriteData(fid,'object',self,'fieldname','elementonwater','format','BooleanMat','mattype',2)
62 WriteData(fid,'object',self,'fieldname','vertexonfloatingice','format','DoubleMat','mattype',1)
63 WriteData(fid,'object',self,'fieldname','vertexongroundedice','format','DoubleMat','mattype',1)
64 WriteData(fid,'object',self,'fieldname','vertexonwater','format','DoubleMat','mattype',1)
65 WriteData(fid,'object',self,'fieldname','icelevelset','format','DoubleMat','mattype',1)
66 # }}}
Note: See TracBrowser for help on using the repository browser.