-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathorganisation.html
159 lines (140 loc) · 6.91 KB
/
organisation.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
158
159
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<!-- Licensed under the Apache 2.0 License -->
<link rel="stylesheet" type="text/css" href="_static/fonts/open-sans/stylesheet.css" />
<!-- Licensed under the SIL Open Font License -->
<link rel="stylesheet" type="text/css" href="_static/fonts/source-serif-pro/source-serif-pro.css" />
<link rel="stylesheet" type="text/css" href="_static/css/bootstrap.min.css" />
<link rel="stylesheet" type="text/css" href="_static/css/bootstrap-theme.min.css" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Code organisation — XVOF documentation</title>
<link rel="stylesheet" href="_static/guzzle.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="XVOF Documentation" href="documentation.html" />
<link rel="prev" title="Welcome to XVOF !" href="index.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="documentation.html" title="XVOF Documentation"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="Welcome to XVOF !"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">XVOF documentation</a> »</li>
</ul>
</div>
<div class="container-wrapper">
<div id="mobile-toggle">
<a href="#"><span class="glyphicon glyphicon-align-justify" aria-hidden="true"></span></a>
</div>
<div id="left-column">
<div class="sphinxsidebar">
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">Welcome to XVOF !</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="documentation.html"
title="next chapter">XVOF Documentation</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/organisation.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div class="sidebar-block">
<div class="sidebar-wrapper">
<div id="main-search">
<form class="form-inline" action="search.html" method="GET" role="form">
<div class="input-group">
<input name="q" type="text" class="form-control" placeholder="Search...">
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
</div>
</div>
</div>
<div id="right-column">
<div role="navigation" aria-label="breadcrumbs navigation">
<ol class="breadcrumb">
<li><a href="index.html">Docs</a></li>
<li>Code organisation</li>
</ol>
</div>
<div class="document clearer body">
<div class="section" id="code-organisation">
<h1>Code organisation<a class="headerlink" href="#code-organisation" title="Permalink to this headline">¶</a></h1>
<p>The XVOF repository contains a repository <code class="docutils literal notranslate"><span class="pre">xfv/</span></code> and different programs to be executed and parameter files to be used when modifications are pushed on the GitHub repository.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">xfv/</span></code> is organized as follows :</p>
<ul class="simple">
<li><code class="docutils literal notranslate"><span class="pre">data/</span></code> : available material data for constitutive model and an example of data set for case creation</li>
<li><code class="docutils literal notranslate"><span class="pre">doc/</span></code> : scripts to build code documentation (sphinx) and the html doc</li>
<li><code class="docutils literal notranslate"><span class="pre">post_processing/</span></code> : some scripts to plot the results (field evolution, space-time diagram, free surface velocity, …)</li>
<li><code class="docutils literal notranslate"><span class="pre">src/</span></code> : source of the program</li>
<li><code class="docutils literal notranslate"><span class="pre">tests/</span></code> : non regression tests (unit tests data set and integration tests) and other tests</li>
<li><code class="docutils literal notranslate"><span class="pre">generate_mesh.py</span></code> : program to generate the mesh for a test case</li>
<li><code class="docutils literal notranslate"><span class="pre">XtendedFiniteVolume.py</span></code> : the executable to launch</li>
</ul>
</div>
</div>
<div class="footer-relations">
<div class="pull-left">
<a class="btn btn-default" href="index.html" title="previous chapter (use the left arrow)">Welcome to XVOF !</a>
</div>
<div class="pull-right">
<a class="btn btn-default" href="documentation.html" title="next chapter (use the right arrow)">XVOF Documentation</a>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="clearfix"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="documentation.html" title="XVOF Documentation"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="Welcome to XVOF !"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">XVOF documentation</a> »</li>
</ul>
</div>
<script type="text/javascript">
$("#mobile-toggle a").click(function () {
$("#left-column").toggle();
});
</script>
<script type="text/javascript" src="_static/js/bootstrap.js"></script>
<div class="footer">
© Copyright 2020, M. Gorecki, G. Peillex. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
</div>
</body>
</html>