-
Notifications
You must be signed in to change notification settings - Fork 122
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deploying to gh-pages from @ ca89734 🚀
- Loading branch information
Showing
366 changed files
with
21,289 additions
and
13,440 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,182 @@ | ||
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | ||
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> | ||
| <head> | ||
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=11"/> | ||
| <meta name="generator" content="Doxygen 1.9.8"/> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"/> | ||
| <title>PRISMS-PF Manual: /home/runner/work/phaseField/phaseField/include/field_input/IntegrationTools/pfield/Coordinate.hh Source File</title> | ||
| <link href="tabs.css" rel="stylesheet" type="text/css"/> | ||
| <script type="text/javascript" src="jquery.js"></script> | ||
| <script type="text/javascript" src="dynsections.js"></script> | ||
| <link href="navtree.css" rel="stylesheet" type="text/css"/> | ||
| <script type="text/javascript" src="resize.js"></script> | ||
| <script type="text/javascript" src="navtreedata.js"></script> | ||
| <script type="text/javascript" src="navtree.js"></script> | ||
| <link href="search/search.css" rel="stylesheet" type="text/css"/> | ||
| <script type="text/javascript" src="search/searchdata.js"></script> | ||
| <script type="text/javascript" src="search/search.js"></script> | ||
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> | ||
| <link href="custom.css" rel="stylesheet" type="text/css"/> | ||
| </head> | ||
| <body> | ||
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> | ||
| <div id="titlearea"> | ||
| <table cellspacing="0" cellpadding="0"> | ||
| <tbody> | ||
| <tr id="projectrow"> | ||
| <td id="projectlogo"><img alt="Logo" src="logo_v2_small.png"/></td> | ||
| <td id="projectalign"> | ||
| <div id="projectname">PRISMS-PF Manual<span id="projectnumber"> v3.0-pre</span> | ||
| </div> | ||
| </td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| </div> | ||
| <!-- end header part --> | ||
| <!-- Generated by Doxygen 1.9.8 --> | ||
| <script type="text/javascript"> | ||
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||
| var searchBox = new SearchBox("searchBox", "search/",'.html'); | ||
| /* @license-end */ | ||
| </script> | ||
| <script type="text/javascript" src="menudata.js"></script> | ||
| <script type="text/javascript" src="menu.js"></script> | ||
| <script type="text/javascript"> | ||
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||
| $(function() { | ||
| initMenu('',true,false,'search.php','Search'); | ||
| $(document).ready(function() { init_search(); }); | ||
| }); | ||
| /* @license-end */ | ||
| </script> | ||
| <div id="main-nav"></div> | ||
| <script type="text/javascript"> | ||
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||
| $(document).ready(function() { init_codefold(0); }); | ||
| /* @license-end */ | ||
| </script> | ||
| </div><!-- top --> | ||
| <div id="side-nav" class="ui-resizable side-nav-resizable"> | ||
| <div id="nav-tree"> | ||
| <div id="nav-tree-contents"> | ||
| <div id="nav-sync" class="sync"></div> | ||
| </div> | ||
| </div> | ||
| <div id="splitbar" style="-moz-user-select:none;" | ||
| class="ui-resizable-handle"> | ||
| </div> | ||
| </div> | ||
| <script type="text/javascript"> | ||
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||
| $(document).ready(function(){initNavTree('Coordinate_8hh_source.html',''); initResizable(); }); | ||
| /* @license-end */ | ||
| </script> | ||
| <div id="doc-content"> | ||
| <!-- window showing the filter options --> | ||
| <div id="MSearchSelectWindow" | ||
| onmouseover="return searchBox.OnSearchSelectShow()" | ||
| onmouseout="return searchBox.OnSearchSelectHide()" | ||
| onkeydown="return searchBox.OnSearchSelectKey(event)"> | ||
| </div> | ||
|
|
||
| <!-- iframe showing the search results (closed by default) --> | ||
| <div id="MSearchResultsWindow"> | ||
| <div id="MSearchResults"> | ||
| <div class="SRPage"> | ||
| <div id="SRIndex"> | ||
| <div id="SRResults"></div> | ||
| <div class="SRStatus" id="Loading">Loading...</div> | ||
| <div class="SRStatus" id="Searching">Searching...</div> | ||
| <div class="SRStatus" id="NoMatches">No Matches</div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
|
|
||
| <div class="header"> | ||
| <div class="headertitle"><div class="title">Coordinate.hh</div></div> | ||
| </div><!--header--> | ||
| <div class="contents"> | ||
| <div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef Coordinate_HH</span></div> | ||
| <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define Coordinate_HH</span></div> | ||
| <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div> | ||
| <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include <ostream></span></div> | ||
| <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div> | ||
| <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="keyword">namespace </span>PRISMS</div> | ||
| <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span>{</div> | ||
| <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div> | ||
| <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> <span class="keyword">template</span> <<span class="keywordtype">int</span> dim></div> | ||
| <div class="foldopen" id="foldopen00015" data-start="{" data-end="};"> | ||
| <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="classPRISMS_1_1Coordinate.html"> 15</a></span> <span class="keyword">class </span><a class="code hl_class" href="classPRISMS_1_1Coordinate.html">Coordinate</a></div> | ||
| <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> {</div> | ||
| <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">public</span>:</div> | ||
| <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> [[nodiscard]] <span class="keywordtype">int</span></div> | ||
| <div class="foldopen" id="foldopen00022" data-start="{" data-end="}"> | ||
| <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="classPRISMS_1_1Coordinate.html#ae2759bb253ad34554cec5bc00c954f1d"> 22</a></span> <a class="code hl_function" href="classPRISMS_1_1Coordinate.html#ae2759bb253ad34554cec5bc00c954f1d">size</a>()<span class="keyword"> const</span></div> | ||
| <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="keyword"> </span>{</div> | ||
| <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keywordflow">return</span> dim;</div> | ||
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> }</div> | ||
| </div> | ||
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div> | ||
| <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keywordtype">float</span> &</div> | ||
| <div class="foldopen" id="foldopen00031" data-start="{" data-end="}"> | ||
| <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="classPRISMS_1_1Coordinate.html#af4266297c77bc3ab5f54ac38f89768b6"> 31</a></span> <a class="code hl_function" href="classPRISMS_1_1Coordinate.html#af4266297c77bc3ab5f54ac38f89768b6">operator[]</a>(<span class="keywordtype">int</span> i)</div> | ||
| <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> {</div> | ||
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordflow">return</span> coordinate[i];</div> | ||
| <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> }</div> | ||
| </div> | ||
| <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div> | ||
| <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">const</span> <span class="keywordtype">float</span> &</div> | ||
| <div class="foldopen" id="foldopen00040" data-start="{" data-end="}"> | ||
| <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="classPRISMS_1_1Coordinate.html#a1958e8c8cfa8dcc55d5aa149ce705990"> 40</a></span> <a class="code hl_function" href="classPRISMS_1_1Coordinate.html#a1958e8c8cfa8dcc55d5aa149ce705990">operator[]</a>(<span class="keywordtype">int</span> i)<span class="keyword"> const</span></div> | ||
| <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="keyword"> </span>{</div> | ||
| <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keywordflow">return</span> coordinate[i];</div> | ||
| <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> }</div> | ||
| </div> | ||
| <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div> | ||
| <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">template</span> <<span class="keywordtype">int</span> D></div> | ||
| <div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">friend</span> std::ostream &</div> | ||
| <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <a class="code hl_friend" href="classPRISMS_1_1Coordinate.html#a456ffea5294dc3f977c157ca36ab15eb">operator<<</a>(std::ostream &outstream, <span class="keyword">const</span> <a class="code hl_class" href="classPRISMS_1_1Coordinate.html">Coordinate<D></a> &coord);</div> | ||
| <div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div> | ||
| <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">private</span>:</div> | ||
| <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keywordtype">float</span> coordinate[dim];</div> | ||
| <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> };</div> | ||
| </div> | ||
| <div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div> | ||
| <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keyword">template</span> <<span class="keywordtype">int</span> D></div> | ||
| <div class="foldopen" id="foldopen00057" data-start="{" data-end="};"> | ||
| <div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="classPRISMS_1_1Coordinate.html#a456ffea5294dc3f977c157ca36ab15eb"> 57</a></span> std::ostream &</div> | ||
| <div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> operator<<(std::ostream &outstream, <span class="keyword">const</span> <a class="code hl_class" href="classPRISMS_1_1Coordinate.html">Coordinate<D></a> &coord)</div> | ||
| <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> {</div> | ||
| <div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < coord.<a class="code hl_function" href="classPRISMS_1_1Coordinate.html#ae2759bb253ad34554cec5bc00c954f1d">size</a>(); i++)</div> | ||
| <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> {</div> | ||
| <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> outstream << coord[i];</div> | ||
| <div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="keywordflow">if</span> (i < coord.size() - 1)</div> | ||
| <div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> {</div> | ||
| <div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> outstream << <span class="stringliteral">" "</span>;</div> | ||
| <div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> }</div> | ||
| <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> }</div> | ||
| <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="keywordflow">return</span> outstream;</div> | ||
| <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> }</div> | ||
| </div> | ||
| <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span>} <span class="comment">// namespace PRISMS</span></div> | ||
| <div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div> | ||
| <div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><span class="preprocessor">#endif</span></div> | ||
| <div class="ttc" id="aclassPRISMS_1_1Coordinate_html"><div class="ttname"><a href="classPRISMS_1_1Coordinate.html">PRISMS::Coordinate</a></div><div class="ttdoc">A class for a coordinate, templated by dimension. This is a possible option anyplace 'Coordinate' cla...</div><div class="ttdef"><b>Definition</b> Coordinate.hh:16</div></div> | ||
| <div class="ttc" id="aclassPRISMS_1_1Coordinate_html_a1958e8c8cfa8dcc55d5aa149ce705990"><div class="ttname"><a href="classPRISMS_1_1Coordinate.html#a1958e8c8cfa8dcc55d5aa149ce705990">PRISMS::Coordinate::operator[]</a></div><div class="ttdeci">const float & operator[](int i) const</div><div class="ttdoc">Get a const reference to the ith coordinate.</div><div class="ttdef"><b>Definition</b> Coordinate.hh:40</div></div> | ||
| <div class="ttc" id="aclassPRISMS_1_1Coordinate_html_a456ffea5294dc3f977c157ca36ab15eb"><div class="ttname"><a href="classPRISMS_1_1Coordinate.html#a456ffea5294dc3f977c157ca36ab15eb">PRISMS::Coordinate::operator<<</a></div><div class="ttdeci">friend std::ostream & operator<<(std::ostream &outstream, const Coordinate< D > &coord)</div><div class="ttdoc">Friend function for output stream.</div><div class="ttdef"><b>Definition</b> Coordinate.hh:58</div></div> | ||
| <div class="ttc" id="aclassPRISMS_1_1Coordinate_html_ae2759bb253ad34554cec5bc00c954f1d"><div class="ttname"><a href="classPRISMS_1_1Coordinate.html#ae2759bb253ad34554cec5bc00c954f1d">PRISMS::Coordinate::size</a></div><div class="ttdeci">int size() const</div><div class="ttdoc">Get the number of dimensions.</div><div class="ttdef"><b>Definition</b> Coordinate.hh:22</div></div> | ||
| <div class="ttc" id="aclassPRISMS_1_1Coordinate_html_af4266297c77bc3ab5f54ac38f89768b6"><div class="ttname"><a href="classPRISMS_1_1Coordinate.html#af4266297c77bc3ab5f54ac38f89768b6">PRISMS::Coordinate::operator[]</a></div><div class="ttdeci">float & operator[](int i)</div><div class="ttdoc">Get the ith coordinate.</div><div class="ttdef"><b>Definition</b> Coordinate.hh:31</div></div> | ||
| </div><!-- fragment --></div><!-- contents --> | ||
| </div><!-- doc-content --> | ||
| <!-- start footer part --> | ||
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> | ||
| <ul> | ||
| <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_9f498c3b3c03a22a29ad8907a509f21d.html">field_input</a></li><li class="navelem"><a class="el" href="dir_2dfa234f82a985d83cbcd87f0e67f442.html">IntegrationTools</a></li><li class="navelem"><a class="el" href="dir_114ed7cbb533d1a7babf57466c2fe9c6.html">pfield</a></li><li class="navelem"><b>Coordinate.hh</b></li> | ||
| <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li> | ||
| </ul> | ||
| </div> | ||
| </body> | ||
| </html> |
Oops, something went wrong.