Ticket #9715: BroadcastWorkspace-v1.html

File BroadcastWorkspace-v1.html, 6.7 KB (added by Vickie Lynch, 6 years ago)
Line 
1<!DOCTYPE html>
2
3
4<html xmlns="http://www.w3.org/1999/xhtml">
5  <head>
6    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7   
8    <title>BroadcastWorkspace v1 &mdash; MantidProject 3.1.20140617.1756 documentation</title>
9   
10    <link rel="stylesheet" href="../_static/basic.css" type="text/css" />
11    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
12    <link rel="stylesheet" href="../_static/bootstrap-3.1.0/css/bootstrap.min.css" type="text/css" />
13    <link rel="stylesheet" href="../_static/bootstrap-3.1.0/css/bootstrap-theme.min.css" type="text/css" />
14    <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
15    <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
16   
17    <script type="text/javascript">
18      var DOCUMENTATION_OPTIONS = {
19        URL_ROOT:    '../',
20        VERSION:     '3.1.20140617.1756',
21        COLLAPSE_INDEX: false,
22        FILE_SUFFIX: '.html',
23        HAS_SOURCE:  true
24      };
25    </script>
26    <script type="text/javascript" src="../_static/jquery.js"></script>
27    <script type="text/javascript" src="../_static/underscore.js"></script>
28    <script type="text/javascript" src="../_static/doctools.js"></script>
29    <script type="text/javascript" src="../_static/js/jquery-1.11.0.min.js"></script>
30    <script type="text/javascript" src="../_static/js/jquery-fix.js"></script>
31    <script type="text/javascript" src="../_static/bootstrap-3.1.0/js/bootstrap.min.js"></script>
32    <script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script>
33    <link rel="top" title="MantidProject 3.1.20140617.1756 documentation" href="../index.html" />
34    <link rel="next" title="CalMuonDeadTime v1" href="CalMuonDeadTime-v1.html" />
35    <link rel="prev" title="BinaryOperateMasks v1" href="BinaryOperateMasks-v1.html" />
36<meta charset='utf-8'>
37<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
38<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
39<meta name="apple-mobile-web-app-capable" content="yes">
40
41  </head>
42  <body>
43
44  <div id="navbar" class="navbar navbar-default navbar-fixed-top">
45    <div class="container">
46      <div class="navbar-header">
47        <!-- .btn-navbar is used as the toggle for collapsed navbar content -->
48        <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
49          <span class="icon-bar"></span>
50          <span class="icon-bar"></span>
51          <span class="icon-bar"></span>
52        </button>
53        <a class="navbar-brand" href="../index.html"><img class="logo" src="../_static/Mantid_Logo_Transparent_Cropped.png" alt="Logo" width=113 height=24/></a>
54           </a>
55        <span class="navbar-text navbar-version pull-left"><b>3.1</b></span>
56      </div>
57
58        <div class="collapse navbar-collapse nav-collapse">
59          <ul class="nav navbar-nav">
60            <li class="divider-vertical"></li>
61           
62                <li><a href="/.html">Home</a></li>
63                <li><a href="http://download.mantidproject.org">Download</a></li>
64                <li><a href="/documentation.html">Documentation</a></li>
65                <li><a href="/contact-us.html">Contact Us</a></li>
66           
67           
68             
69             
70           
71           
72           
73           
74           
75          </ul>
76
77         
78           
79<form class="navbar-form navbar-right" action="../search.html" method="get">
80 <div class="form-group">
81  <input type="text" name="q" class="form-control" placeholder="Search" />
82 </div>
83  <input type="hidden" name="check_keywords" value="yes" />
84  <input type="hidden" name="area" value="default" />
85</form>
86         
87        </div>
88    </div>
89  </div>
90
91<div class="container">
92  <div class="row">
93    <div class="col-md-12">
94     
95  <div class="section" id="broadcastworkspace-v1">
96<span id="algm-broadcastworkspace"></span><span id="algm-broadcastworkspace-v1"></span><h1>BroadcastWorkspace v1<a class="headerlink" href="#broadcastworkspace-v1" title="Permalink to this headline">¶</a></h1>
97<div class="figure align-right">
98<a class="screenshot reference internal image-reference" href="../_images/BroadcastWorkspace-v1_dlg.png"><img alt="../_images/BroadcastWorkspace-v1_dlg.png" class="screenshot" src="../_images/BroadcastWorkspace-v1_dlg.png" style="width: 420px;" /></a>
99<p class="caption"><strong>BroadcastWorkspace</strong> dialog.</p>
100</div>
101<div class="contents local topic" id="table-of-contents">
102<p class="topic-title first">Table of Contents</p>
103<ul class="simple">
104<li><a class="reference internal" href="#summary" id="id1">Summary</a></li>
105<li><a class="reference internal" href="#properties" id="id2">Properties</a></li>
106<li><a class="reference internal" href="#description" id="id3">Description</a></li>
107</ul>
108</div>
109<div class="section" id="summary">
110<h2><a class="toc-backref" href="#id1">Summary</a><a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
111<p>Copy a workspace from one process to all the others.</p>
112</div>
113<div class="section" id="properties">
114<h2><a class="toc-backref" href="#id2">Properties</a><a class="headerlink" href="#properties" title="Permalink to this headline">¶</a></h2>
115<table border="1" class="docutils">
116<colgroup>
117<col width="32%" />
118<col width="14%" />
119<col width="32%" />
120<col width="20%" />
121<col width="2%" />
122</colgroup>
123<thead valign="bottom">
124<tr class="row-odd"><th class="head">Name</th>
125<th class="head">Direction</th>
126<th class="head">Type</th>
127<th class="head">Default</th>
128<th class="head">Description</th>
129</tr>
130</thead>
131<tbody valign="top">
132<tr class="row-even"><td>InputWorkspace</td>
133<td>Input</td>
134<td>MatrixWorkspace</td>
135<td>&nbsp;</td>
136<td>&nbsp;</td>
137</tr>
138<tr class="row-odd"><td>OutputWorkspace</td>
139<td>Output</td>
140<td>MatrixWorkspace</td>
141<td>Mandatory</td>
142<td>&nbsp;</td>
143</tr>
144<tr class="row-even"><td>BroadcasterRank</td>
145<td>Input</td>
146<td>number</td>
147<td>0</td>
148<td>&nbsp;</td>
149</tr>
150</tbody>
151</table>
152</div>
153<div class="section" id="description">
154<h2><a class="toc-backref" href="#id3">Description</a><a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
155<p>BroadcastWorkspace is only availble for MPI builds.  It is used to copy a workspace from one process to all the others.</p>
156<p><strong>Categories</strong>: <a class="reference external" href="../categories/Algorithms.html">Algorithms</a> | <a class="reference external" href="../categories/MPI.html">MPI</a></p>
157</div>
158</div>
159
160
161    </div>
162     
163  </div>
164</div>
165<footer class="footer">
166  <div class="container">
167    <p class="pull-right">
168      <a href="#">Back to top</a>
169     
170    </p>
171    <p>
172        &copy; Copyright 2014, Mantid.<br/>
173    </p>
174  </div>
175</footer>
176  </body>
177</html>