-
Notifications
You must be signed in to change notification settings - Fork 0
/
doc-contents.html
154 lines (152 loc) · 9.45 KB
/
doc-contents.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
<!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>MPI-AMRVAC: Code Contents</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", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="my_customdoxygen.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">MPI-AMRVAC
 <span id="projectnumber">3.1</span>
</div>
<div id="projectbrief">The MPI - Adaptive Mesh Refinement - Versatile Advection Code (development version)</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><!-- top -->
<div class="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">Code Contents </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p><a class="anchor" id="md_doc_contents"></a></p>
<h1><a class="anchor" id="intro_new_users"></a>
Introduction for new users</h1>
<ul>
<li><a class="el" href="md_doc_installation.html">Installation</a> How to install MPI-AMRVAC.</li>
<li><a class="el" href="md_doc_getting_started.html">Getting Started</a> How to run your first test problem.</li>
<li><a class="el" href="md_doc_features.html">Features</a> An overview of the main features of MPI-AMRVAC.</li>
<li><a class="el" href="md_doc_acknowledgments.html">Acknowledgments</a> Information on collaboration and financial support.</li>
<li><a class="el" href="md_doc_faq.html">FAQ</a> Frequently asked questions.</li>
<li><a href="test.html"><b>Tests</b></a> An overview of documented test cases.</li>
<li><a class="el" href="md_doc_demo_movies.html">MPI-AMRVAC 3.0 Demo simulations</a></li>
<li><a class="el" href="md_doc_contributing.html">Contributing to MPI-AMRVAC and its documentation</a></li>
<li><a class="el" href="md_doc_documentation.html">Documentation</a> How the documentation works.</li>
</ul>
<h1><a class="anchor" id="general"></a>
General</h1>
<ul>
<li><a class="el" href="md_doc_equations.html">Equations</a> The equations and parameters in physics modules.</li>
<li><a class="el" href="md_doc_amrvacusr.html">User files</a> How to create a new problem, specify initial conditions and customize functionalities.</li>
<li><a class="el" href="md_doc_par.html">Parameters</a> Description of all parameters in "amrvac.par" parameter file.</li>
<li><a class="el" href="md_doc_mpiamrvac_nw.html">Auxiliary variables</a> Description of the intended use for <em>nw, nwflux, nwaux, nwextra, nwauxio</em> parameters.</li>
<li><a class="el" href="md_doc_commandline.html">Command line</a> Help on command-line parameters.</li>
<li><a class="el" href="md_doc_examples.html">Examples</a> Description of various example simulations for which parameter files and user modules have been provided.</li>
</ul>
<h1><a class="anchor" id="discretization"></a>
Discretization methods and AMR strategy</h1>
<ul>
<li><a class="el" href="md_doc_discretization.html">Discretization</a> The equation and its discretization, the basic variables, the structure of the grid, boundaries, ghost cells.</li>
<li><a class="el" href="md_doc_time_discretization.html">Time Discretization</a> The way the time integration works.</li>
<li><a class="el" href="md_doc_methods.html">Methods</a> Properties of the discretization methods like TVDLF, TVDMU, TVD, HLL...</li>
<li><a class="el" href="md_doc_limiter.html">Slope limiters</a> Slope limiters for reconstruction to suppress spurious numerical oscillations</li>
<li><a class="el" href="md_doc_amrstructure.html">AMR aspects</a> Some essential info on global parameters and the data structures for the block-tree AMR.</li>
<li><a class="el" href="md_doc_axial.html">Using polar/cylindrical/spherical coordinates</a> Some information on simulations using non-Cartesian grids.</li>
<li><a class="el" href="md_doc_smallvalues.html">Small Values</a> Info on positivity fixes for (M)HD runs.</li>
</ul>
<h1><a class="anchor" id="special_sources"></a>
Additional Physics</h1>
<ul>
<li><a class="el" href="md_doc_thermal_conduction.html">Thermal conduction</a> Description of solving thermal conduction.</li>
<li><a class="el" href="md_doc_radiative_cooling.html">Radiative cooling</a> Description of adding radiative cooling.</li>
<li><a class="el" href="md_doc_dust.html">Pressure less fluids (dust)</a> Getting started with the dust module.</li>
<li><a class="el" href="md_doc_particle.html">Test particles in (M)HD</a> Description of test particle tracing routines.</li>
<li><a class="el" href="md_doc_reaction_diffusion.html">Reaction-diffusion equations</a> Getting started with the reaction-diffusion module.</li>
<li><a class="el" href="md_doc_advection_reaction_diffusion.html">Advection-Reaction-diffusion equations</a> Using the advection-reaction-diffusion module.</li>
<li><a class="el" href="md_doc_twofluid.html">Two-fluid equations</a> Getting started with the two-fluid module.</li>
<li><a class="el" href="md_doc_cakforce.html">CAK radiation force</a> Getting started with the CAK force for line-driven wind outflows.</li>
<li><a class="el" href="md_doc_rotatingframe.html">Rotating frame</a> Solve governing equations in a rotating frame of reference.</li>
<li><a class="el" href="md_doc_addmodule.html">Adding a new physics module</a> Description of how to add your own physics module.</li>
</ul>
<h1><a class="anchor" id="source_code"></a>
Source Code</h1>
<ul>
<li><a class="el" href="md_doc_source.html">Source</a> Description of the dimension independent source language, which is translated to F90 by the VACPP preprocessor.</li>
<li><a class="el" href="md_doc_varnames.html">Variable Names</a> How variable names are formed in the source files.</li>
<li><a class="el" href="md_doc_vacpp.html">VACPP</a> Making and running the VACPP preprocessor itself.</li>
<li><a class="el" href="md_doc_compilation.html">Compilation</a> Info on compilation, debugging and adding libraries.</li>
</ul>
<h1><a class="anchor" id="io"></a>
IO and data analysis</h1>
<ul>
<li><a class="el" href="md_doc_fileformat.html">File format</a> Description of the format of MPI-AMRVAC data file (.dat).</li>
<li><a class="el" href="md_doc_yt_usage.html">Visualisation and analysis in Python with yt</a> without data conversion.</li>
<li><a class="el" href="md_doc_convert.html">Converting data files for visualization</a> Brief notes on how to convert to Tecplot (.plt), and VTK (.vtu) data files.</li>
<li><a class="el" href="md_doc_slices.html">Slices</a> How to output hypersurfaces (slices) for restart or visualization.</li>
<li><a class="el" href="md_doc_collapsed.html">Line of sight views</a> How to output collapsed views for visualisation and analysis (e.g. column densities).</li>
<li><a class="el" href="md_doc_analysis.html">Analysis routine</a> Using the run-time analysis routine.</li>
<li><a class="el" href="md_doc_print3D.html">3D Printing</a> A note on how to generate 3D printed results.</li>
<li><a class="el" href="md_doc_yt_usage.html">Yt visualization</a> The recommended yt usage for visualization. </li>
</ul>
</div></div><!-- contents -->
</div><!-- PageDoc -->
<!-- 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>