• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<html>
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5<title>Struct cartesian_dimension</title>
6<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
8<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
9<link rel="up" href="../../mpi/reference.html#header.boost.mpi.cartesian_communicator_hpp" title="Header &lt;boost/mpi/cartesian_communicator.hpp&gt;">
10<link rel="prev" href="cartesian_communicator.html" title="Class cartesian_communicator">
11<link rel="next" href="cartesian_topology.html" title="Class cartesian_topology">
12</head>
13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
14<table cellpadding="2" width="100%"><tr>
15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
16<td align="center"><a href="../../../../index.html">Home</a></td>
17<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
20<td align="center"><a href="../../../../more/index.htm">More</a></td>
21</tr></table>
22<hr>
23<div class="spirit-nav">
24<a accesskey="p" href="cartesian_communicator.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../mpi/reference.html#header.boost.mpi.cartesian_communicator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="cartesian_topology.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
25</div>
26<div class="refentry">
27<a name="boost.mpi.cartesian_dimension"></a><div class="titlepage"></div>
28<div class="refnamediv">
29<h2><span class="refentrytitle">Struct cartesian_dimension</span></h2>
30<p>boost::mpi::cartesian_dimension — Specify the size and periodicity of the grid in a single dimension. </p>
31</div>
32<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
33<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../mpi/reference.html#header.boost.mpi.cartesian_communicator_hpp" title="Header &lt;boost/mpi/cartesian_communicator.hpp&gt;">boost/mpi/cartesian_communicator.hpp</a>&gt;
34
35</span>
36<span class="keyword">struct</span> <a class="link" href="cartesian_dimension.html" title="Struct cartesian_dimension">cartesian_dimension</a> <span class="special">{</span>
37  <span class="comment">// <a class="link" href="cartesian_dimension.html#boost.mpi.cartesian_dimensionconstruct-copy-destruct">construct/copy/destruct</a></span>
38  <a class="link" href="cartesian_dimension.html#id-1_3_27_7_3_2_1_2_6-bb"><span class="identifier">cartesian_dimension</span></a><span class="special">(</span><span class="keyword">int</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span><span class="special">;</span>
39
40  <span class="comment">// <a class="link" href="cartesian_dimension.html#id-1_3_27_7_3_2_1_2_7-bb">private member functions</a></span>
41  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Archive<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="cartesian_dimension.html#id-1_3_27_7_3_2_1_2_7_1-bb"><span class="identifier">serialize</span></a><span class="special">(</span><span class="identifier">Archive</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span>
42
43  <span class="comment">// <a class="link" href="cartesian_dimension.html#boost.mpi.cartesian_dimensionpublic-data-members">public data members</a></span>
44  <span class="keyword">int</span> <a class="link" href="cartesian_dimension.html#boost.mpi.cartesian_dimension.size"><span class="identifier">size</span></a><span class="special">;</span>
45  <span class="keyword">bool</span> <a class="link" href="cartesian_dimension.html#boost.mpi.cartesian_dimension.periodic"><span class="identifier">periodic</span></a><span class="special">;</span>
46<span class="special">}</span><span class="special">;</span></pre></div>
47<div class="refsect1">
48<a name="id-1.3.27.7.4.5.4"></a><h2>Description</h2>
49<p>POD lightweight object. </p>
50<div class="refsect2">
51<a name="id-1.3.27.7.4.5.4.3"></a><h3>
52<a name="boost.mpi.cartesian_dimensionconstruct-copy-destruct"></a><code class="computeroutput">cartesian_dimension</code>
53        public
54       construct/copy/destruct</h3>
55<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="id-1_3_27_7_3_2_1_2_6-bb"></a><span class="identifier">cartesian_dimension</span><span class="special">(</span><span class="keyword">int</span> sz <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="keyword">bool</span> p <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div>
56</div>
57<div class="refsect2">
58<a name="id-1.3.27.7.4.5.4.4"></a><h3>
59<a name="id-1_3_27_7_3_2_1_2_7-bb"></a><code class="computeroutput">cartesian_dimension</code> private member functions</h3>
60<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Archive<span class="special">&gt;</span>
61  <span class="keyword">void</span> <a name="id-1_3_27_7_3_2_1_2_7_1-bb"></a><span class="identifier">serialize</span><span class="special">(</span><span class="identifier">Archive</span> <span class="special">&amp;</span> ar<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> version<span class="special">)</span><span class="special">;</span></pre></li></ol></div>
62</div>
63<div class="refsect2">
64<a name="id-1.3.27.7.4.5.4.5"></a><h3>
65<a name="boost.mpi.cartesian_dimensionpublic-data-members"></a><code class="computeroutput">cartesian_dimension</code>
66        public
67       public data members</h3>
68<div class="orderedlist"><ol class="orderedlist" type="1">
69<li class="listitem">
70<pre class="literallayout"><span class="keyword">int</span> <a name="boost.mpi.cartesian_dimension.size"></a><span class="identifier">size</span><span class="special">;</span></pre>
71<p>The size of the grid n this dimension. </p>
72</li>
73<li class="listitem">
74<pre class="literallayout"><span class="keyword">bool</span> <a name="boost.mpi.cartesian_dimension.periodic"></a><span class="identifier">periodic</span><span class="special">;</span></pre>
75<p>Is the grid periodic in this dimension. </p>
76</li>
77</ol></div>
78</div>
79</div>
80</div>
81<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
82<td align="left"></td>
83<td align="right"><div class="copyright-footer">Copyright © 2005-2007 Douglas Gregor,
84      Matthias Troyer, Trustees of Indiana University<p>
85        Distributed under the Boost Software License, Version 1.0. (See accompanying
86        file LICENSE_1_0.txt or copy at &lt;ulink url="http://www.boost.org/LICENSE_1_0.txt"&gt;
87        http://www.boost.org/LICENSE_1_0.txt &lt;/ulink&gt;)
88      </p>
89</div></td>
90</tr></table>
91<hr>
92<div class="spirit-nav">
93<a accesskey="p" href="cartesian_communicator.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../mpi/reference.html#header.boost.mpi.cartesian_communicator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="cartesian_topology.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
94</div>
95</body>
96</html>
97