aethermodel.github.io/classNeutrals.html at main · AetherModel/aethermodel.github.io · GitHub

History

231 lines (229 loc) · 21.9 KB

Raw

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

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>Aether: Neutrals Class Reference</title>

MathJax.Hub.Config({

extensions: ["tex2jax.js"],

jax: ["input/TeX","output/HTML-CSS"],

});

</script>

</head>

<body>

<tbody>

<div id="projectname">Aether

</div>

<div id="projectbrief">Ionosphere-Thermosphere model</div>

</td>

</tr>

</tbody>

</table>

</div>

/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */

var searchBox = new SearchBox("searchBox", "search",false,'Search');

/* @license-end */

</script>

/* @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="MSearchSelectWindow"

onmouseover="return searchBox.OnSearchSelectShow()"

onmouseout="return searchBox.OnSearchSelectHide()"

onkeydown="return searchBox.OnSearchSelectKey(event)">

</div>

name="MSearchResults" id="MSearchResults">

</iframe>

</div>

</div>

<a href="#nested-classes">Data Structures</a> |

<a href="#pub-methods">Public Member Functions</a> |

<a href="#pub-attribs">Data Fields</a> </div>

<div class="title">Neutrals Class Reference</div> </div>

</div>

Data Structures</h2></td></tr>

<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structNeutrals_1_1species__chars.html">species_chars</a></td></tr>

</table><table class="memberdecls">

Public Member Functions</h2></td></tr>

 </td><td class="memItemRight" valign="bottom"><b>Neutrals</b> (<a class="el" href="classGrid.html">Grid</a> grid, <a class="el" href="classInputs.html">Inputs</a> input, <a class="el" href="classReport.html">Report</a> report)</td></tr>

<a class="el" href="structNeutrals_1_1species__chars.html">species_chars</a> </td><td class="memItemRight" valign="bottom"><b>create_species</b> (<a class="el" href="classGrid.html">Grid</a> grid)</td></tr>

int </td><td class="memItemRight" valign="bottom"><b>read_planet_file</b> (<a class="el" href="classInputs.html">Inputs</a> input, <a class="el" href="classReport.html">Report</a> report)</td></tr>

int </td><td class="memItemRight" valign="bottom"><b>initial_conditions</b> (<a class="el" href="classGrid.html">Grid</a> grid, <a class="el" href="classInputs.html">Inputs</a> input, <a class="el" href="classReport.html">Report</a> report)</td></tr>

void </td><td class="memItemRight" valign="bottom"><b>fill_with_hydrostatic</b> (<a class="el" href="classGrid.html">Grid</a> grid, <a class="el" href="classReport.html">Report</a> report)</td></tr>

void </td><td class="memItemRight" valign="bottom"><b>calc_mass_density</b> (<a class="el" href="classReport.html">Report</a> &report)</td></tr>

void </td><td class="memItemRight" valign="bottom"><b>calc_specific_heat</b> (<a class="el" href="classReport.html">Report</a> &report)</td></tr>

void </td><td class="memItemRight" valign="bottom"><b>calc_chapman</b> (<a class="el" href="classGrid.html">Grid</a> grid, <a class="el" href="classReport.html">Report</a> &report)</td></tr>

void </td><td class="memItemRight" valign="bottom"><b>calc_conduction</b> (<a class="el" href="classGrid.html">Grid</a> grid, <a class="el" href="classTimes.html">Times</a> time, <a class="el" href="classReport.html">Report</a> &report)</td></tr>

void </td><td class="memItemRight" valign="bottom"><b>add_sources</b> (<a class="el" href="classTimes.html">Times</a> time, <a class="el" href="classReport.html">Report</a> &report)</td></tr>

void </td><td class="memItemRight" valign="bottom"><b>set_bcs</b> (<a class="el" href="classReport.html">Report</a> &report)</td></tr>

int </td><td class="memItemRight" valign="bottom"><b>get_species_id</b> (std::string name, <a class="el" href="classReport.html">Report</a> &report)</td></tr>

</table><table class="memberdecls">

Data Fields</h2></td></tr>

arma_cube </td><td class="memItemRight" valign="bottom"><a class="el" href="classNeutrals.html#aa04de879f1a84f690e8e72ab02cfc2b4">density_scgc</a></td></tr>

<tr class="memdesc:aa04de879f1a84f690e8e72ab02cfc2b4"><td class="mdescLeft"> </td><td class="mdescRight">bulk number density (/m3) <br /></td></tr>

std::vector< arma_cube > </td><td class="memItemRight" valign="bottom"><a class="el" href="classNeutrals.html#a1651b3e1f66ed993049e6b63063d0ac9">velocity_vcgc</a></td></tr>

<tr class="memdesc:a1651b3e1f66ed993049e6b63063d0ac9"><td class="mdescLeft"> </td><td class="mdescRight">bulk velocity (m/s) <br /></td></tr>

arma_cube </td><td class="memItemRight" valign="bottom"><a class="el" href="classNeutrals.html#ae7436c55bc8aa5a6e236f7cd796fc05c">temperature_scgc</a></td></tr>

<tr class="memdesc:ae7436c55bc8aa5a6e236f7cd796fc05c"><td class="mdescLeft"> </td><td class="mdescRight">bunk temperature (K) <br /></td></tr>

arma_cube </td><td class="memItemRight" valign="bottom"><a class="el" href="classNeutrals.html#af7945b9ffdf35a2f9006a886d06bc585">rho_scgc</a></td></tr>

<tr class="memdesc:af7945b9ffdf35a2f9006a886d06bc585"><td class="mdescLeft"> </td><td class="mdescRight">bulk mass density (kg/m3) <br /></td></tr>

arma_cube </td><td class="memItemRight" valign="bottom"><a class="el" href="classNeutrals.html#a22eebf81dc8649f3a5246d9d15501697">mean_major_mass_scgc</a></td></tr>

<tr class="memdesc:a22eebf81dc8649f3a5246d9d15501697"><td class="mdescLeft"> </td><td class="mdescRight">mean major mass (kg) <br /></td></tr>

arma_cube </td><td class="memItemRight" valign="bottom"><a class="el" href="classNeutrals.html#a35380c111f05f764adc6e73da93ecbd7">pressure_scgc</a></td></tr>

<tr class="memdesc:a35380c111f05f764adc6e73da93ecbd7"><td class="mdescLeft"> </td><td class="mdescRight">mean pressure (Pa) <br /></td></tr>

arma_cube </td><td class="memItemRight" valign="bottom"><a class="el" href="classNeutrals.html#a616a899ebfd88ce9f4f29cd331eaae6c">sound_scgc</a></td></tr>

<tr class="memdesc:a616a899ebfd88ce9f4f29cd331eaae6c"><td class="mdescLeft"> </td><td class="mdescRight">speed of sound (m/s) <br /></td></tr>

arma_cube </td><td class="memItemRight" valign="bottom"><a class="el" href="classNeutrals.html#a00853b11b26bb41e152eb6d895f83578">Cv_scgc</a></td></tr>

<tr class="memdesc:a00853b11b26bb41e152eb6d895f83578"><td class="mdescLeft"> </td><td class="mdescRight">Specific heat (constant volume): <br /></td></tr>

arma_cube </td><td class="memItemRight" valign="bottom"><a class="el" href="classNeutrals.html#a925914cbafef01773b36bf4d3e8e9399">gamma_scgc</a></td></tr>

<tr class="memdesc:a925914cbafef01773b36bf4d3e8e9399"><td class="mdescLeft"> </td><td class="mdescRight">Bulk Gamma: <br /></td></tr>

arma_cube </td><td class="memItemRight" valign="bottom"><a class="el" href="classNeutrals.html#a2eafb4dbc68042d27c1ddb6866322b01">kappa_scgc</a></td></tr>

<tr class="memdesc:a2eafb4dbc68042d27c1ddb6866322b01"><td class="mdescLeft"> </td><td class="mdescRight">Bulk thermal heat conduction: <br /></td></tr>

std::vector< <a class="el" href="structNeutrals_1_1species__chars.html">species_chars</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classNeutrals.html#a342877ade22733eb78967989f3e49d98">species</a></td></tr>

<tr class="memdesc:a342877ade22733eb78967989f3e49d98"><td class="mdescLeft"> </td><td class="mdescRight">Vector of all species-specific items: <br /></td></tr>

precision_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classNeutrals.html#a122f2d148d743e8e62feb03f6abdb11d">max_chapman</a> = 1.0e26</td></tr>

<tr class="memdesc:a122f2d148d743e8e62feb03f6abdb11d"><td class="mdescLeft"> </td><td class="mdescRight">Maximum Chapman integral (will give nearly infinite tau in EUV) <br /></td></tr>

arma_cube </td><td class="memItemRight" valign="bottom"><a class="el" href="classNeutrals.html#aa50e6fb831fce960ab693349d5449c7a">conduction_scgc</a></td></tr>

<tr class="memdesc:aa50e6fb831fce960ab693349d5449c7a"><td class="mdescLeft"> </td><td class="mdescRight">Bulk neutral thermal conduction temperature change rate (K/s) <br /></td></tr>

arma_cube </td><td class="memItemRight" valign="bottom"><a class="el" href="classNeutrals.html#a1b8155432fc44efab5d7f740d4e890f5">heating_euv_scgc</a></td></tr>

<tr class="memdesc:a1b8155432fc44efab5d7f740d4e890f5"><td class="mdescLeft"> </td><td class="mdescRight">Bulk neutral EUV heating temperatuare change (K/s) <br /></td></tr>

precision_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classNeutrals.html#ac69890b30ccfb477208a6417951639e7">heating_efficiency</a></td></tr>

<tr class="memdesc:ac69890b30ccfb477208a6417951639e7"><td class="mdescLeft"> </td><td class="mdescRight">Nuetral gas direct absorption heating efficiency (~5%) <br /></td></tr>

float * </td><td class="memItemRight" valign="bottom"><a class="el" href="classNeutrals.html#a13fbed7a9ecbe686c0d8da48b25cce4d">initial_temperatures</a></td></tr>

<tr class="memdesc:a13fbed7a9ecbe686c0d8da48b25cce4d"><td class="mdescLeft"> </td><td class="mdescRight">Initial temperature profile, read in through the planet.in file: <br /></td></tr>

float * </td><td class="memItemRight" valign="bottom"><b>initial_altitudes</b></td></tr>

int </td><td class="memItemRight" valign="bottom"><b>nInitial_temps</b> = 0</td></tr>

std::string </td><td class="memItemRight" valign="bottom"><b>density_name</b> = "Neutral Bulk Density"</td></tr>

std::string </td><td class="memItemRight" valign="bottom"><b>density_unit</b> = "(/m3)"</td></tr>

std::vector< std::string > </td><td class="memItemRight" valign="bottom"><b>velocity_name</b></td></tr>

std::string </td><td class="memItemRight" valign="bottom"><b>velocity_unit</b> = "(m/s)"</td></tr>

std::string </td><td class="memItemRight" valign="bottom"><b>temperature_name</b> = "Temperature"</td></tr>

std::string </td><td class="memItemRight" valign="bottom"><b>temperature_unit</b> = "(K)"</td></tr>

</table>

<hr/>The documentation for this class was generated from the following files:<ul>

<li>include/<a class="el" href="neutrals_8h_source.html">neutrals.h</a></li>

<li>src/add_sources.cpp</li>

<li>src/calc_neutral_derived.cpp</li>

<li>src/neutrals.cpp</li>

</ul>

</div>

Generated by  <a href="http://www.doxygen.org/index.html">

</a> 1.8.17

</small></address>

</body>

</html>

aethermodel.github.io/classNeutrals.html at main · AetherModel/aethermodel.github.io · GitHub

Uh oh!

Expand file tree

Breadcrumbs

classNeutrals.html

Latest commit

History

Breadcrumbs

classNeutrals.html

File metadata and controls