/[escript]/trunk/escript/src/AbstractTransportProblem.h
ViewVC logotype

Contents of /trunk/escript/src/AbstractTransportProblem.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1407 - (show annotations)
Mon Feb 4 06:45:48 2008 UTC (11 years, 8 months ago) by gross
File MIME type: text/plain
File size: 3185 byte(s)
new upwinding algorithm (still fails)
1
2 /* $Id$ */
3
4 /*******************************************************
5 *
6 * Copyright 2007 by University of Queensland
7 *
8 * http://esscc.uq.edu.au
9 * Primary Business: Queensland, Australia
10 * Licensed under the Open Software License version 3.0
11 * http://www.opensource.org/licenses/osl-3.0.php
12 *
13 *******************************************************/
14
15 #if !defined escript_AbstractTransportProblem_H
16 #define escript_AbstractTransportProblem_H
17 #include "system_dep.h"
18
19 #include "FunctionSpace.h"
20 #include "TransportProblemException.h"
21
22 #include <boost/python/dict.hpp>
23
24 //
25 // Forward declaration
26 class Data;
27
28 namespace escript {
29
30 /**
31 \brief
32 Give a short description of what AbstractTransportProblem does.
33
34 Description:
35 Give a detailed description of AbstractTransportProblem
36
37 Template Parameters:
38 For templates describe any conditions that the parameters used in the
39 template must satisfy
40 */
41 class AbstractTransportProblem {
42
43 public:
44
45 /**
46 \brief
47 Default constructor for AbstractTransportProblem
48
49 Description:
50 Default constructor for AbstractTransportProblem
51
52 Preconditions:
53 Describe any preconditions
54
55 Throws:
56 Describe any exceptions thrown
57 */
58 ESCRIPT_DLL_API
59 AbstractTransportProblem();
60
61 ESCRIPT_DLL_API
62 AbstractTransportProblem(const double theta,
63 const int blocksize,
64 const FunctionSpace& functionspace);
65
66 /**
67 \brief
68 Destructor.
69 */
70 ESCRIPT_DLL_API
71 virtual ~AbstractTransportProblem();
72
73 ESCRIPT_DLL_API
74 int isEmpty() const;
75
76 /**
77 \brief
78 returns the column function space
79 */
80 ESCRIPT_DLL_API
81 inline FunctionSpace getFunctionSpace() const
82 {
83 if (isEmpty())
84 throw TransportProblemException("Error - Transport Problem is empty.");
85 return m_functionspace;
86 }
87
88 /**
89 \brief
90 returns the block size
91 */
92 ESCRIPT_DLL_API
93 inline int getBlockSize() const
94 {
95 if (isEmpty())
96 throw TransportProblemException("Error - Transport Problem is empty.");
97 return m_blocksize;
98 }
99
100 /**
101 \brief
102 returns the solution u for a time step dt>0
103 */
104 ESCRIPT_DLL_API
105 Data solve(Data& source, const double dt, const boost::python::dict& options) const;
106
107 /**
108 \brief
109 sets the value for u at time t=0.
110 */
111 ESCRIPT_DLL_API
112 void setInitialValue(Data& u) const;
113 /**
114 \brief resets the transport operator typically as they have been updated.
115 */
116 ESCRIPT_DLL_API
117 virtual void resetTransport() const;
118
119 /**
120 * \brief returns a save time step size.
121 * */
122 ESCRIPT_DLL_API
123 virtual double getSafeTimeStepSize() const;
124
125
126 protected:
127
128 private:
129
130 /**
131 \brief
132 sets solution out by time step dt.
133 */
134 ESCRIPT_DLL_API
135 virtual void setToSolution(Data& out,Data& source,const double dt, const boost::python::dict& options) const;
136
137 /**
138 \brief
139 copies the initial value into the problem
140 */
141 ESCRIPT_DLL_API
142 virtual void copyInitialValue(Data& u) const;
143
144 int m_empty;
145 int m_blocksize;
146 double m_theta;
147 FunctionSpace m_functionspace;
148
149 };
150
151
152 } // end of namespace
153 #endif

Properties

Name Value
svn:eol-style native
svn:keywords Author Date Id Revision

  ViewVC Help
Powered by ViewVC 1.1.26