-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathCalvingAtThickness_8hh_source.html
157 lines (155 loc) · 20.1 KB
/
CalvingAtThickness_8hh_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PISM, A Parallel Ice Sheet Model: src/frontretreat/calving/CalvingAtThickness.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="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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="browser.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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">PISM, A Parallel Ice Sheet Model
 <span id="projectnumber">stable v2.1.1 committed by Constantine Khrulev on 2024-12-04 13:36:58 -0900</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_1086a38ef1db31700667572fb79f4dd3.html">frontretreat</a></li><li class="navelem"><a class="el" href="dir_326388fa4e75349239ed164d26e8c5a9.html">calving</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">CalvingAtThickness.hh</div> </div>
</div><!--header-->
<div class="contents">
<a href="CalvingAtThickness_8hh.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* Copyright (C) 2013, 2014, 2015, 2016, 2017, 2018, 2021, 2022, 2023 PISM Authors</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * This file is part of PISM.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * PISM is free software; you can redistribute it and/or modify it under the</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * terms of the GNU General Public License as published by the Free Software</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * Foundation; either version 3 of the License, or (at your option) any later</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * version.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * PISM is distributed in the hope that it will be useful, but WITHOUT ANY</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * details.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * You should have received a copy of the GNU General Public License</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * along with PISM; if not, write to the Free Software</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef _PISMCALVINGATTHICKNESS_H_</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define _PISMCALVINGATTHICKNESS_H_</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "pism/util/Component.hh"</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "pism/util/array/CellType.hh"</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">namespace </span><a class="code" href="namespacepism.html">pism</a> {</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span>calving {</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"></span> </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">/*! \brief Calving mechanism removing the ice at the shelf front that</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> has thickness below a given threshold. */</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classpism_1_1calving_1_1CalvingAtThickness.html"> 32</a></span> <span class="keyword">class </span><a class="code" href="classpism_1_1calving_1_1CalvingAtThickness.html">CalvingAtThickness</a> : <span class="keyword">public</span> <a class="code" href="classpism_1_1Component.html">Component</a></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> {</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <a class="code" href="classpism_1_1calving_1_1CalvingAtThickness_abf0eecd95661f0e42e44c27588b0c848.html#abf0eecd95661f0e42e44c27588b0c848">CalvingAtThickness</a>(std::shared_ptr<const Grid> <a class="code" href="namespacepism_a47d754ed3e959d5866b02a1b78b6a5b5.html#a47d754ed3e959d5866b02a1b78b6a5b5">g</a>);</div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classpism_1_1calving_1_1CalvingAtThickness_ae44e576ebfa75e985b33e7f43d8e2024.html#ae44e576ebfa75e985b33e7f43d8e2024"> 36</a></span>  <span class="keyword">virtual</span> <a class="code" href="classpism_1_1calving_1_1CalvingAtThickness_ae44e576ebfa75e985b33e7f43d8e2024.html#ae44e576ebfa75e985b33e7f43d8e2024">~CalvingAtThickness</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">void</span> <a class="code" href="classpism_1_1calving_1_1CalvingAtThickness_a8b81d7ef96daebd980a1d682a3e269ca.html#a8b81d7ef96daebd980a1d682a3e269ca">init</a>();</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">void</span> <a class="code" href="classpism_1_1calving_1_1CalvingAtThickness_ab1ec79f7efd9b3858d2541bdab291932.html#ab1ec79f7efd9b3858d2541bdab291932">update</a>(<span class="keywordtype">double</span> t,</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordtype">double</span> dt,</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="classpism_1_1array_1_1Scalar.html">array::Scalar</a> &cell_type,</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="classpism_1_1array_1_1Scalar.html">array::Scalar</a> &ice_thickness);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">const</span> <a class="code" href="classpism_1_1array_1_1Scalar.html">array::Scalar</a>& <a class="code" href="classpism_1_1calving_1_1CalvingAtThickness_adf86e3a191d22bf74db55d336c272066.html#adf86e3a191d22bf74db55d336c272066">threshold</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="namespacepism_a6154a990ba873c6ca606d8a320c441ac.html#a6154a990ba873c6ca606d8a320c441ac">DiagnosticList</a> <a class="code" href="classpism_1_1calving_1_1CalvingAtThickness_ad119f11faf2e84be4ef63111cb62e08b.html#ad119f11faf2e84be4ef63111cb62e08b">diagnostics_impl</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classpism_1_1calving_1_1CalvingAtThickness_a70edb3882b3c930e0f1de09429cd0431.html#a70edb3882b3c930e0f1de09429cd0431"> 48</a></span>  std::shared_ptr<array::Forcing> <a class="code" href="classpism_1_1calving_1_1CalvingAtThickness_a70edb3882b3c930e0f1de09429cd0431.html#a70edb3882b3c930e0f1de09429cd0431">m_calving_threshold</a>;</div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classpism_1_1calving_1_1CalvingAtThickness_ab47ee5f306773fcb59f43258e4b59d11.html#ab47ee5f306773fcb59f43258e4b59d11"> 49</a></span>  <a class="code" href="classpism_1_1array_1_1CellType1.html">array::CellType1</a> <a class="code" href="classpism_1_1calving_1_1CalvingAtThickness_ab47ee5f306773fcb59f43258e4b59d11.html#ab47ee5f306773fcb59f43258e4b59d11">m_old_mask</a>;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> };</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> } <span class="comment">// end of namespace calving</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> } <span class="comment">// end of namespace pism</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#endif </span><span class="comment">/* _PISMCALVINGATTHICKNESS_H_ */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aclasspism_1_1Component_html"><div class="ttname"><a href="classpism_1_1Component.html">pism::Component</a></div><div class="ttdoc">A class defining a common interface for most PISM sub-models.</div><div class="ttdef"><b>Definition:</b> <a href="Component_8hh_source.html#l00118">Component.hh:118</a></div></div>
<div class="ttc" id="aclasspism_1_1array_1_1CellType1_html"><div class="ttname"><a href="classpism_1_1array_1_1CellType1.html">pism::array::CellType1</a></div><div class="ttdef"><b>Definition:</b> <a href="CellType_8hh_source.html#l00072">CellType.hh:72</a></div></div>
<div class="ttc" id="aclasspism_1_1array_1_1Scalar_html"><div class="ttname"><a href="classpism_1_1array_1_1Scalar.html">pism::array::Scalar</a></div><div class="ttdef"><b>Definition:</b> <a href="Scalar_8hh_source.html#l00031">Scalar.hh:31</a></div></div>
<div class="ttc" id="aclasspism_1_1calving_1_1CalvingAtThickness_a70edb3882b3c930e0f1de09429cd0431_html_a70edb3882b3c930e0f1de09429cd0431"><div class="ttname"><a href="classpism_1_1calving_1_1CalvingAtThickness_a70edb3882b3c930e0f1de09429cd0431.html#a70edb3882b3c930e0f1de09429cd0431">pism::calving::CalvingAtThickness::m_calving_threshold</a></div><div class="ttdeci">std::shared_ptr< array::Forcing > m_calving_threshold</div><div class="ttdef"><b>Definition:</b> <a href="CalvingAtThickness_8hh_source.html#l00048">CalvingAtThickness.hh:48</a></div></div>
<div class="ttc" id="aclasspism_1_1calving_1_1CalvingAtThickness_a8b81d7ef96daebd980a1d682a3e269ca_html_a8b81d7ef96daebd980a1d682a3e269ca"><div class="ttname"><a href="classpism_1_1calving_1_1CalvingAtThickness_a8b81d7ef96daebd980a1d682a3e269ca.html#a8b81d7ef96daebd980a1d682a3e269ca">pism::calving::CalvingAtThickness::init</a></div><div class="ttdeci">void init()</div><div class="ttdef"><b>Definition:</b> <a href="CalvingAtThickness_8cc_source.html#l00059">CalvingAtThickness.cc:59</a></div></div>
<div class="ttc" id="aclasspism_1_1calving_1_1CalvingAtThickness_ab1ec79f7efd9b3858d2541bdab291932_html_ab1ec79f7efd9b3858d2541bdab291932"><div class="ttname"><a href="classpism_1_1calving_1_1CalvingAtThickness_ab1ec79f7efd9b3858d2541bdab291932.html#ab1ec79f7efd9b3858d2541bdab291932">pism::calving::CalvingAtThickness::update</a></div><div class="ttdeci">void update(double t, double dt, array::Scalar &cell_type, array::Scalar &ice_thickness)</div><div class="ttdef"><b>Definition:</b> <a href="CalvingAtThickness_8cc_source.html#l00101">CalvingAtThickness.cc:101</a></div></div>
<div class="ttc" id="aclasspism_1_1calving_1_1CalvingAtThickness_ab47ee5f306773fcb59f43258e4b59d11_html_ab47ee5f306773fcb59f43258e4b59d11"><div class="ttname"><a href="classpism_1_1calving_1_1CalvingAtThickness_ab47ee5f306773fcb59f43258e4b59d11.html#ab47ee5f306773fcb59f43258e4b59d11">pism::calving::CalvingAtThickness::m_old_mask</a></div><div class="ttdeci">array::CellType1 m_old_mask</div><div class="ttdef"><b>Definition:</b> <a href="CalvingAtThickness_8hh_source.html#l00049">CalvingAtThickness.hh:49</a></div></div>
<div class="ttc" id="aclasspism_1_1calving_1_1CalvingAtThickness_abf0eecd95661f0e42e44c27588b0c848_html_abf0eecd95661f0e42e44c27588b0c848"><div class="ttname"><a href="classpism_1_1calving_1_1CalvingAtThickness_abf0eecd95661f0e42e44c27588b0c848.html#abf0eecd95661f0e42e44c27588b0c848">pism::calving::CalvingAtThickness::CalvingAtThickness</a></div><div class="ttdeci">CalvingAtThickness(std::shared_ptr< const Grid > g)</div><div class="ttdef"><b>Definition:</b> <a href="CalvingAtThickness_8cc_source.html#l00034">CalvingAtThickness.cc:34</a></div></div>
<div class="ttc" id="aclasspism_1_1calving_1_1CalvingAtThickness_ad119f11faf2e84be4ef63111cb62e08b_html_ad119f11faf2e84be4ef63111cb62e08b"><div class="ttname"><a href="classpism_1_1calving_1_1CalvingAtThickness_ad119f11faf2e84be4ef63111cb62e08b.html#ad119f11faf2e84be4ef63111cb62e08b">pism::calving::CalvingAtThickness::diagnostics_impl</a></div><div class="ttdeci">DiagnosticList diagnostics_impl() const</div><div class="ttdef"><b>Definition:</b> <a href="CalvingAtThickness_8cc_source.html#l00134">CalvingAtThickness.cc:134</a></div></div>
<div class="ttc" id="aclasspism_1_1calving_1_1CalvingAtThickness_adf86e3a191d22bf74db55d336c272066_html_adf86e3a191d22bf74db55d336c272066"><div class="ttname"><a href="classpism_1_1calving_1_1CalvingAtThickness_adf86e3a191d22bf74db55d336c272066.html#adf86e3a191d22bf74db55d336c272066">pism::calving::CalvingAtThickness::threshold</a></div><div class="ttdeci">const array::Scalar & threshold() const</div><div class="ttdef"><b>Definition:</b> <a href="CalvingAtThickness_8cc_source.html#l00130">CalvingAtThickness.cc:130</a></div></div>
<div class="ttc" id="aclasspism_1_1calving_1_1CalvingAtThickness_ae44e576ebfa75e985b33e7f43d8e2024_html_ae44e576ebfa75e985b33e7f43d8e2024"><div class="ttname"><a href="classpism_1_1calving_1_1CalvingAtThickness_ae44e576ebfa75e985b33e7f43d8e2024.html#ae44e576ebfa75e985b33e7f43d8e2024">pism::calving::CalvingAtThickness::~CalvingAtThickness</a></div><div class="ttdeci">virtual ~CalvingAtThickness()=default</div></div>
<div class="ttc" id="aclasspism_1_1calving_1_1CalvingAtThickness_html"><div class="ttname"><a href="classpism_1_1calving_1_1CalvingAtThickness.html">pism::calving::CalvingAtThickness</a></div><div class="ttdoc">Calving mechanism removing the ice at the shelf front that has thickness below a given threshold.</div><div class="ttdef"><b>Definition:</b> <a href="CalvingAtThickness_8hh_source.html#l00032">CalvingAtThickness.hh:33</a></div></div>
<div class="ttc" id="anamespacepism_a47d754ed3e959d5866b02a1b78b6a5b5_html_a47d754ed3e959d5866b02a1b78b6a5b5"><div class="ttname"><a href="namespacepism_a47d754ed3e959d5866b02a1b78b6a5b5.html#a47d754ed3e959d5866b02a1b78b6a5b5">pism::g</a></div><div class="ttdeci">static const double g</div><div class="ttdef"><b>Definition:</b> <a href="exactTestP_8cc_source.html#l00036">exactTestP.cc:36</a></div></div>
<div class="ttc" id="anamespacepism_a6154a990ba873c6ca606d8a320c441ac_html_a6154a990ba873c6ca606d8a320c441ac"><div class="ttname"><a href="namespacepism_a6154a990ba873c6ca606d8a320c441ac.html#a6154a990ba873c6ca606d8a320c441ac">pism::DiagnosticList</a></div><div class="ttdeci">std::map< std::string, Diagnostic::Ptr > DiagnosticList</div><div class="ttdef"><b>Definition:</b> <a href="Diagnostic_8hh_source.html#l00125">Diagnostic.hh:125</a></div></div>
<div class="ttc" id="anamespacepism_html"><div class="ttname"><a href="namespacepism.html">pism</a></div><div class="ttdef"><b>Definition:</b> <a href="AgeColumnSystem_8cc_source.html#l00023">AgeColumnSystem.cc:23</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
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.1
</small></address>
</body>
</html>