Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
#ifndef MANTID_API_TRIVIALLYPARALLELALGORITHM_H_
#define MANTID_API_TRIVIALLYPARALLELALGORITHM_H_
#include "MantidAPI/Algorithm.h"
#include "MantidAPI/DllConfig.h"
namespace Mantid {
namespace API {
/** Base class for algorithms that treat all spectra independently, i.e., we can
trivially parallelize over the spectra without changes. The assumption is that
we have one input and one output workspace. The storage mode is just
propagated from input to output. When a specific algorithm is determined to be
trivially parallel (this is a manual process), the only required change to add
MPI support is to inherit from this class instead of Algorithm. Inheriting
from TriviallyParallelAlgorithm instead of from Algorithm provides the
necessary overriden method(s) to allow running an algorithm with MPI. This
works under the following conditions:
1. The algorithm must have a single input and a single output workspace.
2. No output files may be written since filenames would clash.
@author Simon Heybrock
@date 2017
Copyright © 2017 ISIS Rutherford Appleton Laboratory, NScD Oak Ridge
National Laboratory & European Spallation Source
This file is part of Mantid.
Mantid is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
Mantid is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
File change history is stored at: <https://github.com/mantidproject/mantid>
Code Documentation is available at: <http://doxygen.mantidproject.org>
*/
class MANTID_API_DLL TriviallyParallelAlgorithm : public Algorithm {
protected:
Parallel::ExecutionMode getParallelExecutionMode(
const std::map<std::string, Parallel::StorageMode> &storageModes)
const override;
};
} // namespace API
} // namespace Mantid
#endif /* MANTID_API_TRIVIALLYPARALLELALGORITHM_H_ */