escript  Revision_
SplitWorld.h
Go to the documentation of this file.
1 
2 /*****************************************************************************
3 *
4 * Copyright (c) 2014-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 #ifndef escript_SplitWorld_H
18 #define escript_SplitWorld_H
19 
20 #include "AbstractReducer.h"
21 #include "SubWorld.h"
22 
23 #include <boost/python.hpp>
24 #include <boost/smart_ptr.hpp>
25 
26 namespace escript
27 {
28 
38 class SplitWorld
39 {
40 public:
41  SplitWorld(unsigned int numgroups, MPI_Comm global=MPI_COMM_WORLD);
42  ~SplitWorld();
43  boost::python::object buildDomains(boost::python::tuple t, boost::python::dict kwargs);
44 
45  void runJobs();
46 
47  void addJob(boost::python::object creator, boost::python::tuple tup, boost::python::dict kw);
48  void addJobPerWorld(boost::python::object creator, boost::python::tuple tup, boost::python::dict kw);
49 
50  void addVariable(std::string name, boost::python::object creator, boost::python::tuple ntup, boost::python::dict kwargs);
51  void removeVariable(std::string name);
52  void clearVariable(std::string name);
53  std::list<std::pair<std::string, bool> > getVarList();
54  boost::python::object getVarPyList();
55  boost::python::object getVarPyInfo();
56 
57  void clearAllJobs();
58 
59  DataTypes::real_t getScalarVariable(const std::string& name);
60  boost::python::object getLocalObjectVariable(const std::string& name);
61 
62  int getSubWorldCount();
63  int getSubWorldID();
64 
65  void copyVariable(const std::string& src, const std::string& dest);
66 
67 
68 private:
69  JMPI globalcom; // communicator linking all procs used in this splitworld
70  JMPI leadercom; // communicator linking the first proc in each subworld
71  escript::SubWorld_ptr localworld; // subworld which this process belongs to
72  unsigned int swcount; // number of subwords
73  unsigned int localid; // position of localworld in overall world sequence
74 
75  // details of jobs to be created
76  std::vector<boost::python::object> create;
77  std::vector<boost::python::tuple> tupargs;
78  std::vector<boost::python::dict> kwargs;
79 
80  unsigned int jobcounter; // note that the id of the first job is 1 not 0.
81  bool manualimport; // if false, all reduced vars will be shipped to all subworlds
82  void clearPendingJobs();
83  void distributeJobs();
84 
85 };
86 
87 
91 boost::python::object raw_buildDomains(boost::python::tuple t, boost::python::dict kwargs);
92 
96 boost::python::object raw_addJob(boost::python::tuple t, boost::python::dict kwargs);
97 
101 boost::python::object raw_addJobPerWorld(boost::python::tuple t, boost::python::dict kwargs);
102 
106 boost::python::object raw_addVariable(boost::python::tuple t, boost::python::dict kwargs);
107 }
108 #endif
109 
escript::SplitWorld::kwargs
std::vector< boost::python::dict > kwargs
Definition: SplitWorld.h:101
escript::SplitWorld::jobcounter
unsigned int jobcounter
Definition: SplitWorld.h:103
escript::SplitWorld::tupargs
std::vector< boost::python::tuple > tupargs
Definition: SplitWorld.h:100
escript::DataTypes::real_t
double real_t
type of all real-valued scalars in escript
Definition: DataTypes.h:73
escript::SplitWorld::getScalarVariable
DataTypes::real_t getScalarVariable(const std::string &name)
Definition: SplitWorld.cpp:28
AbstractReducer.h
escript::SplitWorld::swcount
unsigned int swcount
Definition: SplitWorld.h:95
escript::SplitWorld::removeVariable
void removeVariable(std::string name)
Definition: SplitWorld.cpp:298
escript::reducerstatus
Definition: AbstractReducer.h:39
escript::SplitWorld::getVarPyInfo
boost::python::object getVarPyInfo()
Definition: SplitWorld.cpp:330
escript::SplitWorld::distributeJobs
void distributeJobs()
Definition: SplitWorld.cpp:361
escript::SplitWorld::getSubWorldCount
int getSubWorldCount()
Definition: SplitWorld.cpp:426
escript::raw_addJob
boost::python::object raw_addJob(boost::python::tuple t, boost::python::dict kwargs)
Definition: SplitWorld.cpp:471
escript::NoCOMM_WORLD
Definition: EsysMPI.h:168
escript::Domain_ptr
boost::shared_ptr< AbstractDomain > Domain_ptr
Definition: AbstractDomain.h:47
SplitWorldException.h
escript::checkResult
bool checkResult(int res, int &mres, const JMPI &info)
Everyone puts in their error code and everyone gets the largest one.
Definition: EsysMPI.cpp:120
escript::SplitWorld::localworld
escript::SubWorld_ptr localworld
Definition: SplitWorld.h:94
escript::makeInfo
JMPI makeInfo(MPI_Comm comm, bool owncom)
Definition: EsysMPI.cpp:39
escript::SplitWorld::addVariable
void addVariable(std::string name, boost::python::object creator, boost::python::tuple ntup, boost::python::dict kwargs)
Definition: SplitWorld.cpp:285
escript::SplitWorld::clearAllJobs
void clearAllJobs()
Definition: SplitWorld.cpp:346
escript::SplitWorld::leadercom
JMPI leadercom
Definition: SplitWorld.h:93
escript::SplitWorld::copyVariable
void copyVariable(const std::string &src, const std::string &dest)
Definition: SplitWorld.cpp:436
escript::Reducer_ptr
boost::shared_ptr< AbstractReducer > Reducer_ptr
Definition: AbstractReducer.h:128
escript::SplitWorld::globalcom
JMPI globalcom
Definition: SplitWorld.h:92
SplitWorld.h
MPI_COMM_WORLD
#define MPI_COMM_WORLD
Definition: EsysMPI.h:46
escript::JMPI
boost::shared_ptr< JMPI_ > JMPI
Definition: EsysMPI.h:70
escript::SplitWorld::localid
unsigned int localid
Definition: SplitWorld.h:96
escript::SplitWorldException
Definition: SplitWorldException.h:38
AbstractDomain.h
escript::SubWorld
Definition: SubWorld.h:58
escript::SplitWorld::SplitWorld
SplitWorld(unsigned int numgroups, MPI_Comm global=91)
Definition: SplitWorld.cpp:41
escript::SplitWorld::runJobs
void runJobs()
Definition: SplitWorld.cpp:122
SubWorld.h
escript::SplitWorld::addJobPerWorld
void addJobPerWorld(boost::python::object creator, boost::python::tuple tup, boost::python::dict kw)
Definition: SplitWorld.cpp:233
escript::SplitWorld::getVarList
std::list< std::pair< std::string, bool > > getVarList()
Definition: SplitWorld.cpp:309
escript::SubWorld_ptr
boost::shared_ptr< SubWorld > SubWorld_ptr
Definition: SubWorld.h:157
escript::SplitWorld::getSubWorldID
int getSubWorldID()
Definition: SplitWorld.cpp:431
escript::SplitWorld
Definition: SplitWorld.h:49
escript
Definition: AbstractContinuousDomain.cpp:22
escript::SplitWorld::clearPendingJobs
void clearPendingJobs()
Definition: SplitWorld.cpp:352
escript::SplitWorld::create
std::vector< boost::python::object > create
Definition: SplitWorld.h:99
escript::SplitWorld::getVarPyList
boost::python::object getVarPyList()
Definition: SplitWorld.cpp:315
escript::SplitWorld::addJob
void addJob(boost::python::object creator, boost::python::tuple tup, boost::python::dict kw)
Definition: SplitWorld.cpp:222
MPI_Comm
int MPI_Comm
Definition: EsysMPI.h:40
escript::SplitWorld::buildDomains
boost::python::object buildDomains(boost::python::tuple t, boost::python::dict kwargs)
Definition: SplitWorld.cpp:96
escript::raw_addJobPerWorld
boost::python::object raw_addJobPerWorld(boost::python::tuple t, boost::python::dict kwargs)
Definition: SplitWorld.cpp:490
escript::raw_addVariable
boost::python::object raw_addVariable(boost::python::tuple t, boost::python::dict kwargs)
Definition: SplitWorld.cpp:511
escript::SplitWorld::getLocalObjectVariable
boost::python::object getLocalObjectVariable(const std::string &name)
Definition: SplitWorld.cpp:34
escript::shipString
bool shipString(const char *src, char **dest, MPI_Comm &comm)
Definition: EsysMPI.cpp:174
escript::getStringFromPyException
void getStringFromPyException(boost::python::error_already_set e, std::string &errormsg)
Definition: pyerr.cpp:38
escript::SplitWorld::manualimport
bool manualimport
Definition: SplitWorld.h:104
pyerr.h
escript::SplitWorld::~SplitWorld
~SplitWorld()
Definition: SplitWorld.cpp:89
escript::raw_buildDomains
boost::python::object raw_buildDomains(boost::python::tuple t, boost::python::dict kwargs)
Definition: SplitWorld.cpp:454
escript::SplitWorld::clearVariable
void clearVariable(std::string name)
Definition: SplitWorld.cpp:304