escript  Revision_Unversioneddirectory
AbstractTransportProblem.h
Go to the documentation of this file.
1 
2 /*****************************************************************************
3 *
4 * Copyright (c) 2003-2016 by The University of Queensland
5 * http://www.uq.edu.au
6 *
7 * Primary Business: Queensland, Australia
8 * Licensed under the Apache License, version 2.0
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Development until 2012 by Earth Systems Science Computational Center (ESSCC)
12 * Development 2012-2013 by School of Earth Sciences
13 * Development from 2014 by Centre for Geoscience Computing (GeoComp)
14 *
15 *****************************************************************************/
16 
17 
18 #if !defined escript_AbstractTransportProblem_H
19 #define escript_AbstractTransportProblem_H
20 #include "system_dep.h"
21 
22 #include "FunctionSpace.h"
24 #include <boost/python/object.hpp>
25 
26 
27 
28 namespace escript {
29 
30 //
31 // Forward declaration
32 class Data;
33 
46 
47  public:
48 
64 
66  AbstractTransportProblem(const int blocksize,
67  const FunctionSpace& functionspace);
68 
74  virtual ~AbstractTransportProblem();
75 
77  int isEmpty() const;
78 
85  {
86  if (isEmpty())
87  throw TransportProblemException("Error - Transport Problem is empty.");
88  return m_functionspace;
89  }
90 
96  inline int getBlockSize() const
97  {
98  if (isEmpty())
99  throw TransportProblemException("Error - Transport Problem is empty.");
100  return m_blocksize;
101  }
102 
108  Data solve(Data& u0, Data& source, const double dt, boost::python::object& options) const;
109 
110 
115  virtual void resetTransport() const;
116 
122  void insertConstraint(Data& source, Data& q, Data& r) const;
123  /*
124  * \brief returns a safe time step size.
125  */
127  virtual double getSafeTimeStepSize() const;
128  /*
129  * \brief returns the value for unlimited time step size.
130  */
132  virtual double getUnlimitedTimeStepSize() const;
133 
134 
135  protected:
136 
137  private:
138 
144  virtual void setToSolution(Data& out, Data& u0, Data& source, const double dt, boost::python::object& options) const;
145 
153  virtual void copyConstraint(Data& source, Data& q, Data& r) const;
154 
155  int m_empty;
158 
159 };
160 
161 
162 typedef boost::shared_ptr<AbstractTransportProblem> ATP_ptr;
163 
164 } // end of namespace
165 #endif
Definition: FunctionSpace.h:34
int m_empty
Definition: AbstractTransportProblem.h:155
Definition: AbstractContinuousDomain.cpp:24
virtual double getSafeTimeStepSize() const
Definition: AbstractTransportProblem.cpp:114
FunctionSpace getFunctionSpace() const
returns the column function space
Definition: AbstractTransportProblem.h:84
int m_blocksize
Definition: AbstractTransportProblem.h:156
int getBlockSize() const
returns the block size
Definition: AbstractTransportProblem.h:96
virtual void copyConstraint(Data &source, Data &q, Data &r) const
copy constraint u_{,t}=r where q>0 into the problem it can be assumed that q and r are not empty and ...
Definition: AbstractTransportProblem.cpp:101
boost::shared_ptr< AbstractTransportProblem > ATP_ptr
Definition: AbstractTransportProblem.h:162
AbstractTransportProblem()
Default constructor for AbstractTransportProblem.
Definition: AbstractTransportProblem.cpp:28
FunctionSpace m_functionspace
Definition: AbstractTransportProblem.h:157
void insertConstraint(Data &source, Data &q, Data &r) const
inserts constraint u_{,t}=r where q>0 into the problem
Definition: AbstractTransportProblem.cpp:74
TransportProblemException exception class.
Definition: TransportProblemException.h:35
int isEmpty() const
Definition: AbstractTransportProblem.cpp:47
Data represents a collection of datapoints.
Definition: Data.h:68
virtual void resetTransport() const
resets the transport operator typically as they have been updated.
Definition: AbstractTransportProblem.cpp:110
virtual void setToSolution(Data &out, Data &u0, Data &source, const double dt, boost::python::object &options) const
sets solution out by time step dt.
Definition: AbstractTransportProblem.cpp:106
virtual ~AbstractTransportProblem()
Destructor.
Definition: AbstractTransportProblem.cpp:44
virtual double getUnlimitedTimeStepSize() const
Definition: AbstractTransportProblem.cpp:118
Give a short description of what AbstractTransportProblem does.
Definition: AbstractTransportProblem.h:45
#define ESCRIPT_DLL_API
Definition: escriptcore/src/system_dep.h:54
Data solve(Data &u0, Data &source, const double dt, boost::python::object &options) const
returns the solution u for a time step dt>0 with initial value u0 at time t=0
Definition: AbstractTransportProblem.cpp:52