deploy: ForestClaw/forestclaw@e905560

docs/develop/fclaw2d__clawpatch__options_8h_source.html

@@ -143,32 +143,33 @@
 <div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="structfclaw2d__clawpatch__options.html#a76f5546b04cdb65bc8ecd6210b5d011f">   84</a></span>&#160;    <span class="keywordtype">int</span> <a class="code" href="structfclaw2d__clawpatch__options.html#a76f5546b04cdb65bc8ecd6210b5d011f">interp_stencil_width</a>; </div>
 <div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="structfclaw2d__clawpatch__options.html#aaca9ac369fb51887cbfdd368f264504c">   85</a></span>&#160;    <span class="keywordtype">int</span> <a class="code" href="structfclaw2d__clawpatch__options.html#aaca9ac369fb51887cbfdd368f264504c">ghost_patch_pack_aux</a>; </div>
 <div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="structfclaw2d__clawpatch__options.html#a8c9eeefc4194a53cd240130f8e98c16e">   86</a></span>&#160;    <span class="keywordtype">int</span> <a class="code" href="structfclaw2d__clawpatch__options.html#a8c9eeefc4194a53cd240130f8e98c16e">save_aux</a>;             </div>
-<div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="structfclaw2d__clawpatch__options.html#a403bff0b09ec6d2bfd4ca37a2a23b897">   89</a></span>&#160;    <span class="keywordtype">int</span> <a class="code" href="structfclaw2d__clawpatch__options.html#a403bff0b09ec6d2bfd4ca37a2a23b897">is_registered</a>; </div>
-<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;};</div>
-<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160; </div>
-<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;<a class="code" href="structfclaw2d__clawpatch__options.html">fclaw2d_clawpatch_options_t</a> *</div>
-<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;<a class="code" href="fclaw2d__clawpatch__options_8h.html#a632b1d34c4242f9071f58b36c1f95db5">fclaw2d_clawpatch_options_register</a>(<a class="code" href="fclaw__base_8h.html#acefeaedd4aae14e6a175ecc6c442dc15">fclaw_app_t</a>* app, <span class="keyword">const</span> <span class="keywordtype">char</span>* name, <span class="keyword">const</span> <span class="keywordtype">char</span>* configfile);</div>
-<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160; </div>
-<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160; </div>
-<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;<span class="keywordtype">void</span> <a class="code" href="fclaw2d__clawpatch__options_8h.html#a33382ce0a3837db50ea234f75ebdc391">fclaw2d_clawpatch_options_store</a> (<span class="keyword">struct</span> <a class="code" href="structfclaw2d__global.html">fclaw2d_global</a> *glob, </div>
-<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;                                      <a class="code" href="structfclaw2d__clawpatch__options.html">fclaw2d_clawpatch_options_t</a>* clawpatch_options);</div>
-<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160; </div>
-<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;<a class="code" href="structfclaw2d__clawpatch__options.html">fclaw2d_clawpatch_options_t</a>* <a class="code" href="fclaw2d__clawpatch__options_8h.html#a9e40049be60a98a8ce38ec4b72fe48ab">fclaw2d_clawpatch_get_options</a>(<span class="keyword">struct</span> <a class="code" href="structfclaw2d__global.html">fclaw2d_global</a>* glob);</div>
-<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160; </div>
-<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;<span class="keyword">const</span> <a class="code" href="structfclaw__packing__vtable.html">fclaw_packing_vtable_t</a>* <a class="code" href="fclaw2d__clawpatch__options_8h.html#a358e528b323125d38e488095bdada697">fclaw2d_clawpatch_options_get_packing_vtable</a>();</div>
-<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160; </div>
-<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160; </div>
-<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
-<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;<span class="preprocessor">#if 0</span></div>
-<div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;{                               <span class="comment">/* need this because indent is dumb */</span></div>
-<div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;<span class="preprocessor">#endif</span></div>
-<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;}</div>
+<div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="structfclaw2d__clawpatch__options.html#a9769a9c526be0e2a47913f0026e14c61">   89</a></span>&#160;    <span class="keywordtype">int</span> <a class="code" href="structfclaw2d__clawpatch__options.html#a9769a9c526be0e2a47913f0026e14c61">vtk_patch_threshold</a>; </div>
+<div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="structfclaw2d__clawpatch__options.html#a403bff0b09ec6d2bfd4ca37a2a23b897">   91</a></span>&#160;    <span class="keywordtype">int</span> <a class="code" href="structfclaw2d__clawpatch__options.html#a403bff0b09ec6d2bfd4ca37a2a23b897">is_registered</a>; </div>
+<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;};</div>
+<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160; </div>
+<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;<a class="code" href="structfclaw2d__clawpatch__options.html">fclaw2d_clawpatch_options_t</a> *</div>
+<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;<a class="code" href="fclaw2d__clawpatch__options_8h.html#a632b1d34c4242f9071f58b36c1f95db5">fclaw2d_clawpatch_options_register</a>(<a class="code" href="fclaw__base_8h.html#acefeaedd4aae14e6a175ecc6c442dc15">fclaw_app_t</a>* app, <span class="keyword">const</span> <span class="keywordtype">char</span>* name, <span class="keyword">const</span> <span class="keywordtype">char</span>* configfile);</div>
+<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160; </div>
+<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160; </div>
+<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;<span class="keywordtype">void</span> <a class="code" href="fclaw2d__clawpatch__options_8h.html#a33382ce0a3837db50ea234f75ebdc391">fclaw2d_clawpatch_options_store</a> (<span class="keyword">struct</span> <a class="code" href="structfclaw2d__global.html">fclaw2d_global</a> *glob, </div>
+<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;                                      <a class="code" href="structfclaw2d__clawpatch__options.html">fclaw2d_clawpatch_options_t</a>* clawpatch_options);</div>
+<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160; </div>
+<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;<a class="code" href="structfclaw2d__clawpatch__options.html">fclaw2d_clawpatch_options_t</a>* <a class="code" href="fclaw2d__clawpatch__options_8h.html#a9e40049be60a98a8ce38ec4b72fe48ab">fclaw2d_clawpatch_get_options</a>(<span class="keyword">struct</span> <a class="code" href="structfclaw2d__global.html">fclaw2d_global</a>* glob);</div>
+<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160; </div>
+<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;<span class="keyword">const</span> <a class="code" href="structfclaw__packing__vtable.html">fclaw_packing_vtable_t</a>* <a class="code" href="fclaw2d__clawpatch__options_8h.html#a358e528b323125d38e488095bdada697">fclaw2d_clawpatch_options_get_packing_vtable</a>();</div>
+<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160; </div>
+<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160; </div>
+<div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
+<div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;<span class="preprocessor">#if 0</span></div>
+<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;{                               <span class="comment">/* need this because indent is dumb */</span></div>
 <div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;<span class="preprocessor">#endif</span></div>
-<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160; </div>
-<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* FCLAW2D_CLAWPATCH_OPTIONS_H */</span><span class="preprocessor"></span></div>
+<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;}</div>
+<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;<span class="preprocessor">#endif</span></div>
+<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160; </div>
+<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* FCLAW2D_CLAWPATCH_OPTIONS_H */</span><span class="preprocessor"></span></div>
 </div><!-- fragment --></div><!-- contents -->
 <div class="ttc" id="astructfclaw2d__clawpatch__options_html_a46f6b21262ebd35289be7e6e5226a573"><div class="ttname"><a href="structfclaw2d__clawpatch__options.html#a46f6b21262ebd35289be7e6e5226a573">fclaw2d_clawpatch_options::meqn</a></div><div class="ttdeci">int meqn</div><div class="ttdoc">number fields in solution</div><div class="ttdef"><b>Definition:</b> fclaw2d_clawpatch_options.h:76</div></div>
-<div class="ttc" id="astructfclaw2d__clawpatch__options_html_a403bff0b09ec6d2bfd4ca37a2a23b897"><div class="ttname"><a href="structfclaw2d__clawpatch__options.html#a403bff0b09ec6d2bfd4ca37a2a23b897">fclaw2d_clawpatch_options::is_registered</a></div><div class="ttdeci">int is_registered</div><div class="ttdoc">true if options have been registered</div><div class="ttdef"><b>Definition:</b> fclaw2d_clawpatch_options.h:89</div></div>
+<div class="ttc" id="astructfclaw2d__clawpatch__options_html_a403bff0b09ec6d2bfd4ca37a2a23b897"><div class="ttname"><a href="structfclaw2d__clawpatch__options.html#a403bff0b09ec6d2bfd4ca37a2a23b897">fclaw2d_clawpatch_options::is_registered</a></div><div class="ttdeci">int is_registered</div><div class="ttdoc">true if options have been registered</div><div class="ttdef"><b>Definition:</b> fclaw2d_clawpatch_options.h:91</div></div>
 <div class="ttc" id="astructfclaw2d__clawpatch__options_html"><div class="ttname"><a href="structfclaw2d__clawpatch__options.html">fclaw2d_clawpatch_options</a></div><div class="ttdoc">Clawpatch options.</div><div class="ttdef"><b>Definition:</b> fclaw2d_clawpatch_options.h:68</div></div>
 <div class="ttc" id="astructfclaw2d__clawpatch__options_html_a10aa55d26682c570edaa38658a6bed61"><div class="ttname"><a href="structfclaw2d__clawpatch__options.html#a10aa55d26682c570edaa38658a6bed61">fclaw2d_clawpatch_options::mbc</a></div><div class="ttdeci">int mbc</div><div class="ttdoc">the number of ghost cells</div><div class="ttdef"><b>Definition:</b> fclaw2d_clawpatch_options.h:74</div></div>
 <div class="ttc" id="afclaw__base_8h_html_acefeaedd4aae14e6a175ecc6c442dc15"><div class="ttname"><a href="fclaw__base_8h.html#acefeaedd4aae14e6a175ecc6c442dc15">fclaw_app_t</a></div><div class="ttdeci">struct fclaw_app fclaw_app_t</div><div class="ttdoc">An application container whose use is optional.</div><div class="ttdef"><b>Definition:</b> fclaw_base.h:178</div></div>
@@ -183,6 +184,7 @@
 <div class="ttc" id="astructfclaw2d__clawpatch__options_html_a76f5546b04cdb65bc8ecd6210b5d011f"><div class="ttname"><a href="structfclaw2d__clawpatch__options.html#a76f5546b04cdb65bc8ecd6210b5d011f">fclaw2d_clawpatch_options::interp_stencil_width</a></div><div class="ttdeci">int interp_stencil_width</div><div class="ttdoc">The width of the interpolation stencil.</div><div class="ttdef"><b>Definition:</b> fclaw2d_clawpatch_options.h:84</div></div>
 <div class="ttc" id="afclaw__base_8h_html"><div class="ttname"><a href="fclaw__base_8h.html">fclaw_base.h</a></div></div>
 <div class="ttc" id="afclaw2d__clawpatch__options_8h_html_a33382ce0a3837db50ea234f75ebdc391"><div class="ttname"><a href="fclaw2d__clawpatch__options_8h.html#a33382ce0a3837db50ea234f75ebdc391">fclaw2d_clawpatch_options_store</a></div><div class="ttdeci">void fclaw2d_clawpatch_options_store(struct fclaw2d_global *glob, fclaw2d_clawpatch_options_t *clawpatch_options)</div><div class="ttdoc">Store the options in the global context.</div></div>
+<div class="ttc" id="astructfclaw2d__clawpatch__options_html_a9769a9c526be0e2a47913f0026e14c61"><div class="ttname"><a href="structfclaw2d__clawpatch__options.html#a9769a9c526be0e2a47913f0026e14c61">fclaw2d_clawpatch_options::vtk_patch_threshold</a></div><div class="ttdeci">int vtk_patch_threshold</div><div class="ttdoc">The buffer threshold for vtk output.</div><div class="ttdef"><b>Definition:</b> fclaw2d_clawpatch_options.h:89</div></div>
 <div class="ttc" id="astructfclaw2d__clawpatch__options_html_afead7cd9224dcea5444ef425d1d5feab"><div class="ttname"><a href="structfclaw2d__clawpatch__options.html#afead7cd9224dcea5444ef425d1d5feab">fclaw2d_clawpatch_options::rhs_fields</a></div><div class="ttdeci">int rhs_fields</div><div class="ttdoc">number of rhs fields for elliptic problems</div><div class="ttdef"><b>Definition:</b> fclaw2d_clawpatch_options.h:77</div></div>
 <div class="ttc" id="astructfclaw2d__clawpatch__options_html_ab66c94ad07f1efc5520048a3f3d9a39c"><div class="ttname"><a href="structfclaw2d__clawpatch__options.html#ab66c94ad07f1efc5520048a3f3d9a39c">fclaw2d_clawpatch_options::kv_refinement_criteria</a></div><div class="ttdeci">sc_keyvalue_t * kv_refinement_criteria</div><div class="ttdoc">The refinement criteria.</div><div class="ttdef"><b>Definition:</b> fclaw2d_clawpatch_options.h:80</div></div>
 <div class="ttc" id="astructfclaw__packing__vtable_html"><div class="ttname"><a href="structfclaw__packing__vtable.html">fclaw_packing_vtable</a></div><div class="ttdoc">vtable for packing functions</div><div class="ttdef"><b>Definition:</b> fclaw_packing.h:78</div></div>

docs/develop/fclaw2d__clawpatch__output__vtk_8h.html

@@ -83,9 +83,9 @@
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 Functions</h2></td></tr>
-<tr class="memitem:af465e3567bf624b599a28c7aee73949d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fclaw2d__clawpatch__output__vtk_8h.html#af465e3567bf624b599a28c7aee73949d">fclaw2d_vtk_write_file</a> (struct <a class="el" href="structfclaw2d__global.html">fclaw2d_global</a> *glob, const char *basename, int mx, int my, int meqn, double vtkspace, int vtkwrite, <a class="el" href="fclaw2d__clawpatch__output__vtk_8h.html#ac153da8da83c41490f788a7102493297">fclaw2d_vtk_patch_data_t</a> coordinate_cb, <a class="el" href="fclaw2d__clawpatch__output__vtk_8h.html#ac153da8da83c41490f788a7102493297">fclaw2d_vtk_patch_data_t</a> value_cb)</td></tr>
-<tr class="memdesc:af465e3567bf624b599a28c7aee73949d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a file in VTK format for the whole domain in parallel.  <a href="fclaw2d__clawpatch__output__vtk_8h.html#af465e3567bf624b599a28c7aee73949d">More...</a><br /></td></tr>
-<tr class="separator:af465e3567bf624b599a28c7aee73949d"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a3a6e38092e66290d6baaea94fdd9d4d0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fclaw2d__clawpatch__output__vtk_8h.html#a3a6e38092e66290d6baaea94fdd9d4d0">fclaw2d_vtk_write_file</a> (struct <a class="el" href="structfclaw2d__global.html">fclaw2d_global</a> *glob, const char *basename, int mx, int my, int meqn, double vtkspace, int vtkwrite, <a class="el" href="fclaw2d__clawpatch__output__vtk_8h.html#ac153da8da83c41490f788a7102493297">fclaw2d_vtk_patch_data_t</a> coordinate_cb, <a class="el" href="fclaw2d__clawpatch__output__vtk_8h.html#ac153da8da83c41490f788a7102493297">fclaw2d_vtk_patch_data_t</a> value_cb, int patch_threshold)</td></tr>
+<tr class="memdesc:a3a6e38092e66290d6baaea94fdd9d4d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a file in VTK format for the whole domain in parallel.  <a href="fclaw2d__clawpatch__output__vtk_8h.html#a3a6e38092e66290d6baaea94fdd9d4d0">More...</a><br /></td></tr>
+<tr class="separator:a3a6e38092e66290d6baaea94fdd9d4d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:abef90f303844ead5fb07650a5ee7c513"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fclaw2d__clawpatch__output__vtk_8h.html#abef90f303844ead5fb07650a5ee7c513">fclaw2d_clawpatch_output_vtk</a> (struct <a class="el" href="structfclaw2d__global.html">fclaw2d_global</a> *glob, int iframe)</td></tr>
 <tr class="memdesc:abef90f303844ead5fb07650a5ee7c513"><td class="mdescLeft">&#160;</td><td class="mdescRight">Output vtu file.  <a href="fclaw2d__clawpatch__output__vtk_8h.html#abef90f303844ead5fb07650a5ee7c513">More...</a><br /></td></tr>
 <tr class="separator:abef90f303844ead5fb07650a5ee7c513"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -157,8 +157,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#abef90f303844ead5fb07650a
 
 </div>
 </div>
-<a id="af465e3567bf624b599a28c7aee73949d"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#af465e3567bf624b599a28c7aee73949d">&#9670;&nbsp;</a></span>fclaw2d_vtk_write_file()</h2>
+<a id="a3a6e38092e66290d6baaea94fdd9d4d0"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a3a6e38092e66290d6baaea94fdd9d4d0">&#9670;&nbsp;</a></span>fclaw2d_vtk_write_file()</h2>
 
 <div class="memitem">
 <div class="memproto">
@@ -215,7 +215,13 @@ <h2 class="memtitle"><span class="permalink"><a href="#af465e3567bf624b599a28c7a
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype"><a class="el" href="fclaw2d__clawpatch__output__vtk_8h.html#ac153da8da83c41490f788a7102493297">fclaw2d_vtk_patch_data_t</a>&#160;</td>
-          <td class="paramname"><em>value_cb</em>&#160;</td>
+          <td class="paramname"><em>value_cb</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">int&#160;</td>
+          <td class="paramname"><em>patch_threshold</em>&#160;</td>
         </tr>
         <tr>
           <td></td>
@@ -236,6 +242,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#af465e3567bf624b599a28c7a
     <tr><td class="paramdir">[in]</td><td class="paramname">vtkwrite</td><td>Mode of writing: (unused; uses 1 by default) 0 for MPI_File_write_all (faster), 1 for MPI_File_write (less memory usage). </td></tr>
     <tr><td class="paramdir">[in]</td><td class="paramname">coordniate_cb</td><td>the callback to write a patch's coordinate binary data </td></tr>
     <tr><td class="paramdir">[in]</td><td class="paramname">value_cb</td><td>the callback to write a patch's value binary data </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">patch_threshold</td><td>The maximal number of buffered patches. 0 means that an unlimited number of patches is buffered and flushed to disk at the end. </td></tr>
   </table>
   </dd>
 </dl>