escript  Revision_
AbstractContinuousDomain.h
Go to the documentation of this file.
1 
2 /*****************************************************************************
3 *
4 * Copyright (c) 2003-2018 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 #ifndef __ESCRIPT_ABSTRACTCONTINUOUSDOMAIN_H__
19 #define __ESCRIPT_ABSTRACTCONTINUOUSDOMAIN_H__
20 
21 #include "system_dep.h"
22 #include "AbstractDomain.h"
23 #include "AbstractSystemMatrix.h"
25 
26 #include <string>
27 #include <vector>
28 
29 namespace escript {
30 
31 //
32 // Forward declaration
33 class Data;
34 
45 class ESCRIPT_DLL_API AbstractContinuousDomain : public AbstractDomain
46 {
47 
48  public:
49 
63  AbstractContinuousDomain();
64 
78  virtual ~AbstractContinuousDomain();
79 
85  virtual bool isValidFunctionSpaceType(int functionSpaceType) const;
86 
91  virtual std::string getDescription() const;
92 
97  virtual int getContinuousFunctionCode() const;
98 
103  virtual int getReducedContinuousFunctionCode() const;
104 
109  virtual int getFunctionCode() const;
110 
115  virtual int getReducedFunctionCode() const;
116 
121  virtual int getFunctionOnBoundaryCode() const;
122 
127  virtual int getReducedFunctionOnBoundaryCode() const;
128 
129 
134  virtual int getFunctionOnContactZeroCode() const;
135 
140  virtual int getReducedFunctionOnContactZeroCode() const;
141 
146  virtual int getFunctionOnContactOneCode() const;
147 
152  virtual int getReducedFunctionOnContactOneCode() const;
153 
158  virtual int getSolutionCode() const;
159 
164  virtual int getReducedSolutionCode() const;
165 
170  virtual int getDiracDeltaFunctionsCode() const;
171 
177  virtual int getSystemMatrixTypeId(const boost::python::object& options) const;
178 
185  virtual int getTransportTypeId(int solver, int preconditioner, int package, bool symmetry) const;
186 
193  virtual void setToIntegrals(std::vector<DataTypes::real_t>& integrals,
194  const escript::Data& arg) const;
195  virtual void setToIntegrals(std::vector<DataTypes::cplx_t>& integrals,
196  const escript::Data& arg) const;
197 
198 // /**
199 // \brief
200 // Return the domain as const AbstractContinuousDomain&
201 // */
202 // static const AbstractContinuousDomain& asAbstractContinuousDomain(const AbstractDomain& domain);
203 
204 
205 
206 
211  virtual void addPDEToSystem(
212  AbstractSystemMatrix& mat, escript::Data& rhs,
213  const escript::Data& A, const escript::Data& B, const escript::Data& C,
214  const escript::Data& D, const escript::Data& X, const escript::Data& Y,
215  const escript::Data& d, const escript::Data& y,
216  const escript::Data& d_contact, const escript::Data& y_contact,
217  const escript::Data& d_dirac, const escript::Data& y_dirac) const;
218 
219 // We do not require this method at this level since the python side checks to ensure it exists
220 // before calling it.
221 
222 // /**
223 // \brief
224 // adds a PDE onto the lumped stiffness matrix matrix
225 // */
226 // virtual void addPDEToLumpedSystem(
227 // escript::Data& mat,
228 // const escript::Data& D,
229 // const escript::Data& d) const;
230 
235  virtual void addPDEToRHS(escript::Data& rhs,
236  const escript::Data& X, const escript::Data& Y,
237  const escript::Data& y, const escript::Data& y_contact, const escript::Data& y_dirac) const;
243  virtual void addPDEToTransportProblem(
244  AbstractTransportProblem& tp, escript::Data& source,
245  const escript::Data& M,
246  const escript::Data& A, const escript::Data& B, const escript::Data& C,const escript::Data& D,
247  const escript::Data& X,const escript::Data& Y,
248  const escript::Data& d, const escript::Data& y,
249  const escript::Data& d_contact,const escript::Data& y_contact,
250  const escript::Data& d_dirac,const escript::Data& y_dirac) const;
251 
256  virtual ASM_ptr newSystemMatrix(
257  const int row_blocksize,
258  const escript::FunctionSpace& row_functionspace,
259  const int column_blocksize,
260  const escript::FunctionSpace& column_functionspace,
261  const int type) const;
268  virtual ATP_ptr newTransportProblem(
269  const int blocksize,
270  const escript::FunctionSpace& functionspace,
271  const int type) const;
272 
277  virtual DataTypes::dim_t getNumDataPointsGlobal() const;
278 
284  virtual std::pair<int,DataTypes::dim_t> getDataShape(int functionSpaceCode) const;
285 
290  virtual void setNewX(const escript::Data& arg);
291 
296  virtual void Print_Mesh_Info(const bool full=false) const;
297 };
298 
299 } // end of namespace
300 
301 #endif // __ESCRIPT_ABSTRACTCONTINUOUSDOMAIN_H__
302 
ESCRIPT_DLL_API
#define ESCRIPT_DLL_API
Definition: escriptcore/src/system_dep.h:28
AbstractTransportProblem.h
escript::AbstractTransportProblem
Give a short description of what AbstractTransportProblem does.
Definition: AbstractTransportProblem.h:54
escript::FunctionSpace
Definition: FunctionSpace.h:45
system_dep.h
escript::Data
Data represents a collection of datapoints.
Definition: Data.h:62
escript::DataTypes::dim_t
index_t dim_t
Definition: DataTypes.h:87
escript::ATP_ptr
boost::shared_ptr< AbstractTransportProblem > ATP_ptr
Definition: AbstractTransportProblem.h:171
escript::AbstractSystemMatrix
Base class for escript system matrices.
Definition: AbstractSystemMatrix.h:53
AbstractDomain.h
AbstractContinuousDomain.h
escript
Definition: AbstractContinuousDomain.cpp:22
AbstractSystemMatrix.h
paso::M
static dim_t M
Definition: SparseMatrix_saveHB.cpp:48
Data.h
escript::ASM_ptr
boost::shared_ptr< AbstractSystemMatrix > ASM_ptr
Definition: AbstractSystemMatrix.h:43