Skip to content

Commit ecf2653

Browse files
author
MFC Action
committed
Docs @ 756d391
1 parent 37d21e1 commit ecf2653

File tree

11 files changed

+751
-81
lines changed

11 files changed

+751
-81
lines changed

documentation/jquery.js

Lines changed: 180 additions & 10 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

documentation/tabs.css

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

post_process/jquery.js

Lines changed: 180 additions & 10 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

post_process/namespaces.html

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -135,21 +135,20 @@
135135
</div><!--header-->
136136
<div class="contents">
137137
<div class="textblock">Here is a list of all modules with brief descriptions:</div><div class="directory">
138-
<div class="levels">[detail level <span onclick="javascript:dynsection.toggleLevel(1);">1</span><span onclick="javascript:dynsection.toggleLevel(2);">2</span>]</div><table class="directory">
138+
<table class="directory">
139139
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">M</span></span><a class="el" href="namespacem__checker.html" target="_self">m_checker</a></td><td class="desc">The purpose of the module is to check for compatible input files </td></tr>
140140
<tr id="row_1_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">M</span></span><a class="el" href="namespacem__checker__common.html" target="_self">m_checker_common</a></td><td class="desc">The purpose of the module is to check for compatible input files for. inputs common to pre-processing, post-processing and simulation </td></tr>
141141
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">M</span></span><a class="el" href="namespacem__compile__specific.html" target="_self">m_compile_specific</a></td><td class="desc">This module contains subroutines that are compiler specific </td></tr>
142142
<tr id="row_3_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">M</span></span><a class="el" href="namespacem__constants.html" target="_self">m_constants</a></td><td class="desc"></td></tr>
143-
<tr id="row_4_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_4_" class="arrow" onclick="dynsection.toggleFolder('4_')">&#9660;</span><span class="icona"><span class="icon">M</span></span><a class="el" href="namespacem__data__input.html" target="_self">m_data_input</a></td><td class="desc">This module features procedures, which for a specific time-step, read in the raw simulation data for the grid and the conservative variables and fill out their buffer regions </td></tr>
144-
<tr id="row_4_0_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interfacem__data__input_1_1s__read__abstract__data__files.html" target="_self">s_read_abstract_data_files</a></td><td class="desc">Subroutine for reading data files </td></tr>
145-
<tr id="row_5_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">M</span></span><a class="el" href="namespacem__data__output.html" target="_self">m_data_output</a></td><td class="desc">This module enables the restructuring of the raw simulation data file(s) into formatted database file(s). The formats that may be chosen from include Silo-HDF5 and Binary. Each of these database structures contains information about the grid as well as each of the flow variable(s) that were chosen by the user to be included </td></tr>
146-
<tr id="row_6_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">M</span></span><a class="el" href="namespacem__delay__file__access.html" target="_self">m_delay_file_access</a></td><td class="desc"></td></tr>
147-
<tr id="row_7_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">M</span></span><a class="el" href="namespacem__derived__variables.html" target="_self">m_derived_variables</a></td><td class="desc">This module features subroutines that allow for the derivation of numerous flow variables from the conservative and primitive ones. Currently, the available derived variables include the unadvected volume fraction, specific heat ratio, liquid stiffness, speed of sound, vorticity and the numerical Schlieren function </td></tr>
148-
<tr id="row_8_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">M</span></span><a class="el" href="namespacem__eigen__solver.html" target="_self">m_eigen_solver</a></td><td class="desc">The purpose of the module is to solve an eigenvalue problem for a complex general matrix. Subroutines are imported from EISPACK (<a href="https://netlib.org/eispack/">https://netlib.org/eispack/</a>) with minor modifications for compatibility </td></tr>
149-
<tr id="row_9_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">M</span></span><a class="el" href="namespacem__global__parameters.html" target="_self">m_global_parameters</a></td><td class="desc">This module contains all of the parameters characterizing the computational domain, simulation algorithm, stiffened equation of state and finally, the formatted database file(s) structure </td></tr>
150-
<tr id="row_10_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">M</span></span><a class="el" href="namespacem__helper__basic.html" target="_self">m_helper_basic</a></td><td class="desc"></td></tr>
151-
<tr id="row_11_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">M</span></span><a class="el" href="namespacem__mpi__proxy.html" target="_self">m_mpi_proxy</a></td><td class="desc">This module serves as a proxy to the parameters and subroutines available in the MPI implementation's MPI module. Specifically, the role of the proxy is to harness basic MPI commands into more complex procedures as to achieve the required communication goals for the post-process </td></tr>
152-
<tr id="row_12_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">M</span></span><a class="el" href="namespacem__start__up.html" target="_self">m_start_up</a></td><td class="desc">This module contains the subroutines that read in and check the consistency of the user provided inputs. This module also allocates, initializes and deallocates the relevant variables and sets up the time stepping, MPI decomposition and I/O procedures </td></tr>
143+
<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">M</span></span><a class="el" href="namespacem__data__input.html" target="_self">m_data_input</a></td><td class="desc">This module features procedures, which for a specific time-step, read in the raw simulation data for the grid and the conservative variables and fill out their buffer regions </td></tr>
144+
<tr id="row_5_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">M</span></span><a class="el" href="namespacem__data__output.html" target="_self">m_data_output</a></td><td class="desc">This module enables the restructuring of the raw simulation data file(s) into formatted database file(s). The formats that may be chosen from include Silo-HDF5 and Binary. Each of these database structures contains information about the grid as well as each of the flow variable(s) that were chosen by the user to be included </td></tr>
145+
<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">M</span></span><a class="el" href="namespacem__delay__file__access.html" target="_self">m_delay_file_access</a></td><td class="desc"></td></tr>
146+
<tr id="row_7_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">M</span></span><a class="el" href="namespacem__derived__variables.html" target="_self">m_derived_variables</a></td><td class="desc">This module features subroutines that allow for the derivation of numerous flow variables from the conservative and primitive ones. Currently, the available derived variables include the unadvected volume fraction, specific heat ratio, liquid stiffness, speed of sound, vorticity and the numerical Schlieren function </td></tr>
147+
<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">M</span></span><a class="el" href="namespacem__eigen__solver.html" target="_self">m_eigen_solver</a></td><td class="desc">The purpose of the module is to solve an eigenvalue problem for a complex general matrix. Subroutines are imported from EISPACK (<a href="https://netlib.org/eispack/">https://netlib.org/eispack/</a>) with minor modifications for compatibility </td></tr>
148+
<tr id="row_9_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">M</span></span><a class="el" href="namespacem__global__parameters.html" target="_self">m_global_parameters</a></td><td class="desc">This module contains all of the parameters characterizing the computational domain, simulation algorithm, stiffened equation of state and finally, the formatted database file(s) structure </td></tr>
149+
<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">M</span></span><a class="el" href="namespacem__helper__basic.html" target="_self">m_helper_basic</a></td><td class="desc"></td></tr>
150+
<tr id="row_11_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">M</span></span><a class="el" href="namespacem__mpi__proxy.html" target="_self">m_mpi_proxy</a></td><td class="desc">This module serves as a proxy to the parameters and subroutines available in the MPI implementation's MPI module. Specifically, the role of the proxy is to harness basic MPI commands into more complex procedures as to achieve the required communication goals for the post-process </td></tr>
151+
<tr id="row_12_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">M</span></span><a class="el" href="namespacem__start__up.html" target="_self">m_start_up</a></td><td class="desc">This module contains the subroutines that read in and check the consistency of the user provided inputs. This module also allocates, initializes and deallocates the relevant variables and sets up the time stepping, MPI decomposition and I/O procedures </td></tr>
153152
</table>
154153
</div><!-- directory -->
155154
</div><!-- contents -->

0 commit comments

Comments
 (0)