 # Diff of /trunk/esys2/modellib/py_src/geometry.py

revision 148 by jgs, Tue Aug 23 01:24:31 2005 UTC revision 149 by jgs, Thu Sep 1 03:31:39 2005 UTC
# Line 1  Line 1
1  # \$Id\$  # \$Id\$
2
3
4  from escript.escript import *  from esys.escript import *
5  from escript.modelframe import Model,ParameterSet  from esys.escript.modelframe import Model,ParameterSet
6  from finley import finley  from esys import finley
7
8  class RectangularDomain(Model):  class RectangularDomain(Model):
9         """generates a mesh over a rectangular domain finley         """
10           Generates a mesh over a rectangular domain finley.
dim
l
n
order
periodic
intergration order

domain (callable)
11
12           @ivar dim:
13           @ivar l:
14           @ivar n:
15           @ivar order:
16           @ivar periodic:
17           @ivar intergration order:
18           @ivar domain (callable):
19         """         """
20         def __init__(self,debug=False):         def __init__(self,debug=False):
21             Model.__init__(self,debug=debug)             Model.__init__(self,debug=debug)
# Line 55  class RectangularDomain(Model): Line 54  class RectangularDomain(Model):
54            return self._domain            return self._domain
55
56  class ScalarConstrainer(ParameterSet):  class ScalarConstrainer(ParameterSet):
57       """@brief creates a characteristic function for the location of constraints for a scalar value       """
58         Creates a characteristic function for the location of constraints
59                @param domain (in) - rectangular domain       for a scalar value.
@param left (in)  - True to set a constraint at the left face of the domain (x=min x), default is False
@param right (in) - True to set a constraint at the left face of the domain (x=max x), default is False
@param top (in)  - True to set a constraint at the left face of the domain (x=min x), default is False
@param bottom (in) - True to set a constraint at the left face of the domain (x=max x), default is False
@param front (in)  - True to set a constraint at the left face of the domain (x=min x), default is False
@param back (in) - True to set a constraint at the left face of the domain (x=max x), default is False
@param location_of_constraint (out) - object that defines the location of the constraints.
60
61         In the case that the spatial dimension is two, teh arguments front and back are ignored       In the case that the spatial dimension is two, the arguments front
62         and back are ignored.
63
64         @ivar domain (in): rectangular domain
65         @ivar left (in): True to set a constraint at the left face of the
66                   domain (x=min x), default is False
67         @ivar right (in): True to set a constraint at the left face of the
68                   domain (x=max x), default is False
69         @ivar top (in): True to set a constraint at the left face of the
70                   domain (x=min x), default is False
71         @ivar bottom (in): True to set a constraint at the left face of the
72                   domain (x=max x), default is False
73         @ivar front (in): True to set a constraint at the left face of the
74                   domain (x=min x), default is False
75         @ivar back (in): True to set a constraint at the left face of the
76                   domain (x=max x), default is False
77         @ivar location_of_constraint (out): object that defines the location
78                   of the constraints.
79       """       """
80       def __init__(self,debug=False):       def __init__(self,debug=False):
81             ParameterSet.__init__(self,debug=debug)             ParameterSet.__init__(self,debug=debug)
# Line 81  class ScalarConstrainer(ParameterSet): Line 89  class ScalarConstrainer(ParameterSet):
89             self._location_of_constraint=None             self._location_of_constraint=None
90
91       def location_of_constraint(self):       def location_of_constraint(self):
92            """returns the mask of the location of constraint"""            """
93              Returns the mask of the location of constraint.
94              """
95            if self._location_of_constraint==None:            if self._location_of_constraint==None:
96               x=self.domain.getX()               x=self.domain.getX()
97               self._location_of_constraint=Scalar(0,x.getFunctionSpace())               self._location_of_constraint=Scalar(0,x.getFunctionSpace())
# Line 100  class ScalarConstrainer(ParameterSet): Line 110  class ScalarConstrainer(ParameterSet):
110            return self._location_of_constraint            return self._location_of_constraint
111
112  class VectorConstrainer(ParameterSet):  class VectorConstrainer(ParameterSet):
113        """@brief creates a characteristic function for the location of constraints for a scalar value        """
114          Creates a characteristic function for the location of constraints
115                @param domain (in) - rectangular domain        for a scalar value.
@param left (in)  - list of three boolean. left[i]==True sets a constraint for the i-th component at the left
face of the domain (x=min x), default is [False,False,False]
@param right (in) - list of three boolean. left[i]==True sets a constraint for the i-th component at the right
face of the domain (x=max x), default is [False,False,False]
@param top (in)  - list of three boolean. left[i]==True sets a constraint for the i-th component at the top
face of the domain (x=min x), default is [False,False,False]
@param bottom (in) - list of three boolean. left[i]==True sets a constraint for the i-th component at the bottom
face of the domain (x=min x), default is [False,False,False]
@param front (in)  - list of three boolean. left[i]==True sets a constraint for the i-th component at the front
face of the domain (x=min x), default is [False,False,False]
@param back (in) - list of three boolean. left[i]==True sets a constraint for the i-th component at the back
face of the domain (x=max x), default is [False,False,False]
@param location_of_constraint (callable) - object that defines the location of the constraints for each vector component.
116
117         In the case that the spatial dimension is two, thh arguments front and back as well as the third component of each argument is ignored.        @ivar domain (in): rectangular domain
118          @ivar left (in): list of three boolean. left[i]==True sets a
119                    constraint for the i-th component at the left
120                    face of the domain (x=min x),
121                    default is [False,False,False]
122          @ivar right (in): list of three boolean. left[i]==True sets a
123                    constraint for the i-th component at the right
124                    face of the domain (x=max x),
125                    default is [False,False,False]
126          @ivar top (in): list of three boolean. left[i]==True sets a
127                    constraint for the i-th component at the top
128                    face of the domain (x=min x),
129                    default is [False,False,False]
130          @ivar bottom (in): list of three boolean. left[i]==True sets a
131                    constraint for the i-th component at the bottom
132                    face of the domain (x=min x),
133                    default is [False,False,False]
134          @ivar front (in): list of three boolean. left[i]==True sets a
135                    constraint for the i-th component at the front
136                    face of the domain (x=min x),
137                    default is [False,False,False]
138          @ivar back (in): list of three boolean. left[i]==True sets a
139                    constraint for the i-th component at the back
140                    face of the domain (x=max x),
141                    default is [False,False,False]
142          @ivar location_of_constraint (callable): object that defines the location of the constraints for each vector component.
143
144          In the case that the spatial dimension is two, thh arguments front and
145          back as well as the third component of each argument is ignored.
146        """        """
147        def __init__(self,debug=False):        def __init__(self,debug=False):
148             ParameterSet.__init__(self,debug=debug)             ParameterSet.__init__(self,debug=debug)
# Line 131  class VectorConstrainer(ParameterSet): Line 155  class VectorConstrainer(ParameterSet):
155                                   back=[0,0,0])                                   back=[0,0,0])
156             self._location_of_constraint=None             self._location_of_constraint=None
157        def location_of_constraint(self):        def location_of_constraint(self):
158            """returns the mask of the location of constraint"""            """
159              Returns the mask of the location of constraint.
160              """
161            if self._location_of_constraint==None:            if self._location_of_constraint==None:
162               x=self.domain.getX()               x=self.domain.getX()
163               self._location_of_constraint=Vector(0,x.getFunctionSpace())               self._location_of_constraint=Vector(0,x.getFunctionSpace())
# Line 174  class VectorConstrainer(ParameterSet): Line 200  class VectorConstrainer(ParameterSet):