-
Notifications
You must be signed in to change notification settings - Fork 0
/
architecture.html
153 lines (133 loc) · 7.83 KB
/
architecture.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
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Architecture — ROOSTER documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=b0fc30b0" />
<link rel="shortcut icon" href="_static/favicon.ico"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Input description" href="input.html" />
<link rel="prev" title="Why a new code?" href="motivation.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
ROOSTER
<img src="_static/logo.svg" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="motivation.html">Why a new code?</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="input.html">Input description</a></li>
<li class="toctree-l1"><a class="reference internal" href="theory.html">Theory manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="references.html">References</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">ROOSTER</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Architecture</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="architecture">
<h1>Architecture<a class="headerlink" href="#architecture" title="Link to this heading"></a></h1>
<p>A constructor of the <a class="reference external" href="https://github.com/rooster-code/rooster/blob/main/B_reactor.py">Reactor</a> class creates instances of five classes:</p>
<ul>
<li><p>Class <a class="reference external" href="https://github.com/rooster-code/rooster/blob/main/B0_control.py">Control</a></p>
<blockquote>
<div><ul class="simple">
<li><p>reads input data;</p></li>
<li><p>evaluates signals using symbolic algebra;</p></li>
<li><p>provides interfaces between classes and</p></li>
<li><p>hosts an ODE solver.</p></li>
</ul>
</div></blockquote>
</li>
<li><p>Class <a class="reference external" href="https://github.com/rooster-code/rooster/blob/main/B1_solid.py">Solid</a> generates a required number of instances of <a class="reference external" href="https://github.com/rooster-code/rooster/blob/main/B1B_fuelrod.py">FuelRod</a> and <a class="reference external" href="https://github.com/rooster-code/rooster/blob/main/B1A_heatstructure.py">HeatStructure</a> classes.</p>
<blockquote>
<div><ul>
<li><p>Class <a class="reference external" href="https://github.com/rooster-code/rooster/blob/main/B1B_fuelrod.py">Fuelrod</a> generates for every axial slice</p>
<blockquote>
<div><ul class="simple">
<li><p>Class <a class="reference external" href="https://github.com/rooster-code/rooster/blob/main/B1B0_fuel.py">Fuel</a></p></li>
<li><p>Class <a class="reference external" href="https://github.com/rooster-code/rooster/blob/main/B1B1_fuel.py">InnerGas</a></p></li>
<li><p>Class <a class="reference external" href="https://github.com/rooster-code/rooster/blob/main/B1B2_clad.py">Clad</a></p></li>
</ul>
</div></blockquote>
</li>
<li><p>Class <a class="reference external" href="https://github.com/rooster-code/rooster/blob/main/B1A_heatstructure.py">Heatstructure</a></p></li>
</ul>
</div></blockquote>
</li>
<li><p>Class <a class="reference external" href="https://github.com/rooster-code/rooster/blob/main/B2_fluid.py">Fluid</a> solves mass, momentum and energy conservation equations for incompressible single-phase one-dimensional flow.</p></li>
<li><p>Class <a class="reference external" href="https://github.com/rooster-code/rooster/blob/main/B3_core.py">Core</a> generates a required number of instances of <a class="reference external" href="https://github.com/rooster-code/rooster/blob/main/B3A_isotope.py">Isotope</a> and <a class="reference external" href="https://github.com/rooster-code/rooster/blob/main/B3B_mix.py">Mix</a> classes and includes the <a class="reference external" href="https://github.com/rooster-code/rooster/blob/main/B3_coreF.f90">solve_eigenvalue_problem</a> function containing Monte Carlo neutron transport and neutron diffusion solvers.</p></li>
<li><p>Class <a class="reference external" href="https://github.com/rooster-code/rooster/blob/main/B4_data.py">Data</a> calculates material properties, Nusselt numbers and friction factors for Fluid and Solid classes.</p></li>
</ul>
<figure class="align-center" id="fig2e041504">
<a class="reference internal image-reference" href="_images/2e041504.png"><img alt="_images/2e041504.png" src="_images/2e041504.png" style="width: 100%;" /></a>
</figure>
<p>.</p>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="motivation.html" class="btn btn-neutral float-left" title="Why a new code?" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="input.html" class="btn btn-neutral float-right" title="Input description" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2023-2024, Konstantin Mikityuk.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>