|
99 | 99 | <div class="headertitle"><div class="title">conditional_ostreams.h</div></div>
|
100 | 100 | </div><!--header-->
|
101 | 101 | <div class="contents">
|
102 |
| -<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef conditional_ostreams_h</span></div> |
103 |
| -<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define conditional_ostreams_h</span></div> |
| 102 | +<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// SPDX-FileCopyrightText: © 2025 PRISMS Center at the University of Michigan</span></div> |
| 103 | +<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// SPDX-License-Identifier: GNU Lesser General Public Version 2.1</span></div> |
104 | 104 | <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
|
105 |
| -<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include <deal.II/base/conditional_ostream.h></span></div> |
106 |
| -<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div> |
107 |
| -<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include <prismspf/config.h></span></div> |
108 |
| -<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div> |
109 |
| -<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include <fstream></span></div> |
110 |
| -<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div> |
111 |
| -<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span>PRISMS_PF_BEGIN_NAMESPACE</div> |
112 |
| -<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div> |
113 |
| -<div class="foldopen" id="foldopen00017" data-start="{" data-end="};"> |
114 |
| -<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="classconditionalOStreams.html"> 17</a></span><span class="keyword">class </span><a class="code hl_class" href="classconditionalOStreams.html">conditionalOStreams</a></div> |
115 |
| -<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span>{</div> |
116 |
| -<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="keyword">public</span>:</div> |
117 |
| -<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <a class="code hl_function" href="classconditionalOStreams.html#ac724e2f4c59f68c0bd04f3938ecfb931">conditionalOStreams</a>();</div> |
118 |
| -<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div> |
119 |
| -<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <a class="code hl_function" href="classconditionalOStreams.html#ae9eafe0dc5354d6dce44d309eaf797dc">~conditionalOStreams</a>();</div> |
120 |
| -<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div> |
121 |
| -<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">static</span> dealii::ConditionalOStream &</div> |
122 |
| -<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <a class="code hl_function" href="classconditionalOStreams.html#a2efcf782fde21881ad5f696f62a4f2ba">pout_base</a>();</div> |
123 |
| -<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div> |
124 |
| -<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">static</span> dealii::ConditionalOStream &</div> |
125 |
| -<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <a class="code hl_function" href="classconditionalOStreams.html#a6d3d22d58e8e6ad572ec786d3e9752f9">pout_verbose</a>();</div> |
126 |
| -<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div> |
127 |
| -<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">static</span> dealii::ConditionalOStream &</div> |
128 |
| -<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <a class="code hl_function" href="classconditionalOStreams.html#a78ca7c60d1c6bb1adfc3f0ec72e4fbb3">pout_summary</a>();</div> |
129 |
| -<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div> |
130 |
| -<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="keyword">private</span>:</div> |
131 |
| -<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="comment">// summary.log file</span></div> |
132 |
| -<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">static</span> std::ofstream summary_log_file;</div> |
133 |
| -<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span>};</div> |
| 105 | +<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#ifndef conditional_ostreams_h</span></div> |
| 106 | +<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#define conditional_ostreams_h</span></div> |
| 107 | +<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div> |
| 108 | +<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include <deal.II/base/conditional_ostream.h></span></div> |
| 109 | +<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div> |
| 110 | +<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include <prismspf/config.h></span></div> |
| 111 | +<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div> |
| 112 | +<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include <fstream></span></div> |
| 113 | +<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div> |
| 114 | +<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span>PRISMS_PF_BEGIN_NAMESPACE</div> |
| 115 | +<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div> |
| 116 | +<div class="foldopen" id="foldopen00020" data-start="{" data-end="};"> |
| 117 | +<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="classconditionalOStreams.html"> 20</a></span><span class="keyword">class </span><a class="code hl_class" href="classconditionalOStreams.html">conditionalOStreams</a></div> |
| 118 | +<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span>{</div> |
| 119 | +<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="keyword">public</span>:</div> |
| 120 | +<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <a class="code hl_function" href="classconditionalOStreams.html#ac724e2f4c59f68c0bd04f3938ecfb931">conditionalOStreams</a>();</div> |
| 121 | +<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div> |
| 122 | +<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <a class="code hl_function" href="classconditionalOStreams.html#ae9eafe0dc5354d6dce44d309eaf797dc">~conditionalOStreams</a>();</div> |
| 123 | +<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div> |
| 124 | +<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">static</span> dealii::ConditionalOStream &</div> |
| 125 | +<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <a class="code hl_function" href="classconditionalOStreams.html#a2efcf782fde21881ad5f696f62a4f2ba">pout_base</a>();</div> |
| 126 | +<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div> |
| 127 | +<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">static</span> dealii::ConditionalOStream &</div> |
| 128 | +<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <a class="code hl_function" href="classconditionalOStreams.html#a6d3d22d58e8e6ad572ec786d3e9752f9">pout_verbose</a>();</div> |
| 129 | +<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div> |
| 130 | +<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">static</span> dealii::ConditionalOStream &</div> |
| 131 | +<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <a class="code hl_function" href="classconditionalOStreams.html#a78ca7c60d1c6bb1adfc3f0ec72e4fbb3">pout_summary</a>();</div> |
| 132 | +<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div> |
| 133 | +<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="keyword">private</span>:</div> |
| 134 | +<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="comment">// summary.log file</span></div> |
| 135 | +<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">static</span> std::ofstream summary_log_file;</div> |
| 136 | +<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span>};</div> |
134 | 137 | </div>
|
135 |
| -<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div> |
136 |
| -<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span>PRISMS_PF_END_NAMESPACE</div> |
137 |
| -<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div> |
138 |
| -<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="preprocessor">#endif</span></div> |
139 |
| -<div class="ttc" id="aclassconditionalOStreams_html"><div class="ttname"><a href="classconditionalOStreams.html">conditionalOStreams</a></div><div class="ttdoc">A class that allows printing to different output streams that are classified based on their verbosity...</div><div class="ttdef"><b>Definition</b> conditional_ostreams.h:18</div></div> |
140 |
| -<div class="ttc" id="aclassconditionalOStreams_html_a2efcf782fde21881ad5f696f62a4f2ba"><div class="ttname"><a href="classconditionalOStreams.html#a2efcf782fde21881ad5f696f62a4f2ba">conditionalOStreams::pout_base</a></div><div class="ttdeci">static dealii::ConditionalOStream & pout_base()</div><div class="ttdoc">Generic parallel output stream. Used for essential information in release and debug mode.</div><div class="ttdef"><b>Definition</b> conditional_ostreams.cc:31</div></div> |
141 |
| -<div class="ttc" id="aclassconditionalOStreams_html_a6d3d22d58e8e6ad572ec786d3e9752f9"><div class="ttname"><a href="classconditionalOStreams.html#a6d3d22d58e8e6ad572ec786d3e9752f9">conditionalOStreams::pout_verbose</a></div><div class="ttdeci">static dealii::ConditionalOStream & pout_verbose()</div><div class="ttdoc">Verbose parallel output stream. Used for additional information in debug mode.</div><div class="ttdef"><b>Definition</b> conditional_ostreams.cc:40</div></div> |
142 |
| -<div class="ttc" id="aclassconditionalOStreams_html_a78ca7c60d1c6bb1adfc3f0ec72e4fbb3"><div class="ttname"><a href="classconditionalOStreams.html#a78ca7c60d1c6bb1adfc3f0ec72e4fbb3">conditionalOStreams::pout_summary</a></div><div class="ttdeci">static dealii::ConditionalOStream & pout_summary()</div><div class="ttdoc">Log output stream for writing a summary.log file.</div><div class="ttdef"><b>Definition</b> conditional_ostreams.cc:22</div></div> |
143 |
| -<div class="ttc" id="aclassconditionalOStreams_html_ac724e2f4c59f68c0bd04f3938ecfb931"><div class="ttname"><a href="classconditionalOStreams.html#ac724e2f4c59f68c0bd04f3938ecfb931">conditionalOStreams::conditionalOStreams</a></div><div class="ttdeci">conditionalOStreams()</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition</b> conditional_ostreams.cc:51</div></div> |
144 |
| -<div class="ttc" id="aclassconditionalOStreams_html_ae9eafe0dc5354d6dce44d309eaf797dc"><div class="ttname"><a href="classconditionalOStreams.html#ae9eafe0dc5354d6dce44d309eaf797dc">conditionalOStreams::~conditionalOStreams</a></div><div class="ttdeci">~conditionalOStreams()</div><div class="ttdoc">Destructor.</div><div class="ttdef"><b>Definition</b> conditional_ostreams.cc:59</div></div> |
| 138 | +<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div> |
| 139 | +<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span>PRISMS_PF_END_NAMESPACE</div> |
| 140 | +<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div> |
| 141 | +<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="preprocessor">#endif</span></div> |
| 142 | +<div class="ttc" id="aclassconditionalOStreams_html"><div class="ttname"><a href="classconditionalOStreams.html">conditionalOStreams</a></div><div class="ttdoc">A class that allows printing to different output streams that are classified based on their verbosity...</div><div class="ttdef"><b>Definition</b> conditional_ostreams.h:21</div></div> |
| 143 | +<div class="ttc" id="aclassconditionalOStreams_html_a2efcf782fde21881ad5f696f62a4f2ba"><div class="ttname"><a href="classconditionalOStreams.html#a2efcf782fde21881ad5f696f62a4f2ba">conditionalOStreams::pout_base</a></div><div class="ttdeci">static dealii::ConditionalOStream & pout_base()</div><div class="ttdoc">Generic parallel output stream. Used for essential information in release and debug mode.</div><div class="ttdef"><b>Definition</b> conditional_ostreams.cc:34</div></div> |
| 144 | +<div class="ttc" id="aclassconditionalOStreams_html_a6d3d22d58e8e6ad572ec786d3e9752f9"><div class="ttname"><a href="classconditionalOStreams.html#a6d3d22d58e8e6ad572ec786d3e9752f9">conditionalOStreams::pout_verbose</a></div><div class="ttdeci">static dealii::ConditionalOStream & pout_verbose()</div><div class="ttdoc">Verbose parallel output stream. Used for additional information in debug mode.</div><div class="ttdef"><b>Definition</b> conditional_ostreams.cc:43</div></div> |
| 145 | +<div class="ttc" id="aclassconditionalOStreams_html_a78ca7c60d1c6bb1adfc3f0ec72e4fbb3"><div class="ttname"><a href="classconditionalOStreams.html#a78ca7c60d1c6bb1adfc3f0ec72e4fbb3">conditionalOStreams::pout_summary</a></div><div class="ttdeci">static dealii::ConditionalOStream & pout_summary()</div><div class="ttdoc">Log output stream for writing a summary.log file.</div><div class="ttdef"><b>Definition</b> conditional_ostreams.cc:25</div></div> |
| 146 | +<div class="ttc" id="aclassconditionalOStreams_html_ac724e2f4c59f68c0bd04f3938ecfb931"><div class="ttname"><a href="classconditionalOStreams.html#ac724e2f4c59f68c0bd04f3938ecfb931">conditionalOStreams::conditionalOStreams</a></div><div class="ttdeci">conditionalOStreams()</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition</b> conditional_ostreams.cc:54</div></div> |
| 147 | +<div class="ttc" id="aclassconditionalOStreams_html_ae9eafe0dc5354d6dce44d309eaf797dc"><div class="ttname"><a href="classconditionalOStreams.html#ae9eafe0dc5354d6dce44d309eaf797dc">conditionalOStreams::~conditionalOStreams</a></div><div class="ttdeci">~conditionalOStreams()</div><div class="ttdoc">Destructor.</div><div class="ttdef"><b>Definition</b> conditional_ostreams.cc:62</div></div> |
145 | 148 | </div><!-- fragment --></div><!-- contents -->
|
146 | 149 | </div><!-- doc-content -->
|
147 | 150 | <!-- start footer part -->
|
|
0 commit comments