/[escript]/branches/symbolic_from_3470/escript/py_src/heat.py
ViewVC logotype

Annotation of /branches/symbolic_from_3470/escript/py_src/heat.py

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2625 - (hide annotations)
Fri Aug 21 06:30:25 2009 UTC (9 years, 9 months ago) by jfenwick
Original Path: trunk/escript/py_src/heat.py
File MIME type: text/x-python
File size: 5703 byte(s)
Merging changes from new doco branch.
All docstrings are now in reStructured text.
A few email addresses have been fixes as well.
1 ksteube 1809
2     ########################################################
3 gross 1417 #
4 jfenwick 2548 # Copyright (c) 2003-2009 by University of Queensland
5 ksteube 1809 # Earth Systems Science Computational Center (ESSCC)
6     # http://www.uq.edu.au/esscc
7 gross 1417 #
8 ksteube 1809 # Primary Business: Queensland, Australia
9     # Licensed under the Open Software License version 3.0
10     # http://www.opensource.org/licenses/osl-3.0.php
11 gross 1417 #
12 ksteube 1809 ########################################################
13 gross 1417
14 jfenwick 2549 __copyright__="""Copyright (c) 2003-2009 by University of Queensland
15 ksteube 1809 Earth Systems Science Computational Center (ESSCC)
16     http://www.uq.edu.au/esscc
17     Primary Business: Queensland, Australia"""
18     __license__="""Licensed under the Open Software License version 3.0
19     http://www.opensource.org/licenses/osl-3.0.php"""
20 jfenwick 2344 __url__="https://launchpad.net/escript-finley"
21 ksteube 1809
22 gross 1417 """
23     Some models for heat advection-diffusion
24    
25 jfenwick 2625 :var __author__: name of author
26     :var __copyright__: copyrights
27     :var __license__: licence agreement
28     :var __url__: url entry point on documentation
29     :var __version__: version
30     :var __date__: date of the version
31 gross 1417 """
32    
33     __author__="Lutz Gross, l.gross@uq.edu.au"
34    
35     # from escript import *
36     import util
37     from linearPDEs import TransportPDE
38    
39     class TemperatureCartesian(TransportPDE):
40 caltinay 2169 """
41     Represents and solves the temperature advection-diffusion problem
42 gross 1417
43 jfenwick 2625 *rhocp(T_{,t} + v_i T_{,i} - ( k T_{,i})_i = Q*
44 caltinay 2158
45 jfenwick 2625 *k T_{,i}*n_i=surface_flux* and *T_{,t} = 0* where ``given_T_mask``>0.
46 caltinay 2158
47 caltinay 2169 If surface_flux is not given 0 is assumed.
48 gross 1417
49 caltinay 2169 Typical usage::
50 gross 1417
51 caltinay 2169 sp = TemperatureCartesian(domain)
52     sp.setTolerance(1.e-4)
53     t = 0
54     T = ...
55     sp.setValues(rhocp=..., v=..., k=..., given_T_mask=...)
56     sp.setInitialTemperature(T)
57     while t < t_end:
58     sp.setValue(Q=...)
59     T = sp.getTemperature(dt)
60     t += dt
61     """
62 gross 2337 def __init__(self,domain,useBackwardEuler=False,**kwargs):
63 gross 1417 """
64 caltinay 2169 Initializes the temperature advection-diffusion problem.
65 gross 1417
66 jfenwick 2625 :param domain: domain of the problem
67     :param useBackwardEuler: if set the backward Euler scheme is used. Otherwise the Crank-Nicholson scheme is applied. Not that backward Euler scheme will return a safe time step size which is practically infinity as the scheme is unconditional unstable. So other measures need to be applied to control the time step size. The Crank-Nicholson scheme provides a higher accuracy but requires to limit the time step size to be stable.
68     :type useBackwardEuler: ``bool``
69 gross 1417 """
70 gross 2337 TransportPDE.__init__(self,domain,numEquations=1,useBackwardEuler=useBackwardEuler,**kwargs)
71 gross 1841 self.setReducedOrderOn()
72 gross 1417 self.__rhocp=None
73     self.__v=None
74 caltinay 2158
75 caltinay 2169 def setInitialTemperature(self,T):
76     """
77 jfenwick 2625 Same as `setInitialSolution`.
78 caltinay 2169 """
79 gross 1417 self.setInitialSolution(T)
80 caltinay 2158
81 caltinay 2169 def setValue(self,rhocp=None,v=None,k=None,Q=None,surface_flux=None,given_T_mask=None):
82     if rhocp!=None:
83     self.__rhocp=rhocp
84     if v!=None:
85     self.__v=v
86     if rhocp!=None:
87     super(TemperatureCartesian,self).setValue(M=self.__rhocp)
88     if (rhocp!=None or v!=None) and self.__rhocp!=None and self.__v!=None:
89     super(TemperatureCartesian,self).setValue(C=-self.__rhocp*self.__v)
90     if k!=None:
91     super(TemperatureCartesian,self).setValue(A=-k*util.kronecker(self.getDomain()))
92     if Q!=None:
93     super(TemperatureCartesian,self).setValue(Y=Q)
94     if surface_flux!=None:
95     super(TemperatureCartesian,self).setValue(y=surface_flux)
96     if given_T_mask!=None:
97     super(TemperatureCartesian,self).setValue(q=given_T_mask)
98 caltinay 2158
99 caltinay 2169 def getTemperature(self,dt,**kwargs):
100     """
101 jfenwick 2625 Same as `getSolution`.
102 caltinay 2169 """
103     return self.getSolution(dt,**kwargs)
104 caltinay 2158
105 gross 2479
106     class Tracer(TransportPDE):
107     """
108     Represents and solves the tracer problem
109    
110 jfenwick 2625 *C_{,t} + v_i C_{,i} - ( k T_{,i})_i) = 0*
111 gross 2479
112 jfenwick 2625 *C_{,t} = 0* where ``given_C_mask``>0.
113     *C_{,i}*n_i=0*
114 gross 2479
115     Typical usage::
116    
117     sp = Tracer(domain)
118     sp.setTolerance(1.e-4)
119     t = 0
120     T = ...
121     sp.setValues(given_C_mask=...)
122     sp.setInitialTracer(C)
123     while t < t_end:
124     sp.setValue(v=...)
125     dt.getSaveTimeStepSize()
126     C = sp.getTracer(dt)
127     t += dt
128     """
129     def __init__(self,domain,useBackwardEuler=False,**kwargs):
130     """
131     Initializes the Tracer advection problem
132    
133 jfenwick 2625 :param domain: domain of the problem
134     :param useBackwardEuler: if set the backward Euler scheme is used. Otherwise the Crank-Nicholson scheme is applied. Not that backward Euler scheme will return a safe time step size which is practically infinity as the scheme is unconditional unstable. So other measures need to be applied to control the time step size. The Crank-Nicholson scheme provides a higher accuracy but requires to limit the time step size to be stable.
135     :type useBackwardEuler: ``bool``
136 gross 2479 """
137     TransportPDE.__init__(self,domain,numEquations=1,useBackwardEuler=useBackwardEuler,**kwargs)
138     self.setReducedOrderOn()
139     super(Tracer,self).setValue(M=1.)
140    
141     def setInitialTracer(self,C):
142     """
143 jfenwick 2625 Same as `setInitialSolution`.
144 gross 2479 """
145     self.setInitialSolution(C)
146    
147     def setValue(self,v=None,given_C_mask=None, k=None):
148     if v!=None:
149     super(Tracer,self).setValue(C=-v)
150     if k!=None:
151     super(Tracer,self).setValue(A=-k*util.kronecker(self.getDomain()))
152     if given_C_mask!=None:
153     super(Tracer,self).setValue(q=given_C_mask)
154    
155     def getTracer(self,dt,**kwargs):
156     """
157 jfenwick 2625 Same as `getSolution`.
158 gross 2479 """
159     return self.getSolution(dt,**kwargs)
160    

  ViewVC Help
Powered by ViewVC 1.1.26