incomp-flame-post/fortran_api/module/m_parameters.html
2026-06-05 13:27:38 +00:00

967 lines
No EOL
28 KiB
HTML

<!-- -*- mode: jinja2 -*- -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="Tridiagonal compact finite difference solver, mathematical operators, and MPI-IO drivers.">
<meta name="author" content="Google DeepMind Team & Ignis" >
<link rel="icon" href="../favicon.png">
<title>m_parameters &ndash; HPC DNS Post-Processing Fortran Core</title>
<!-- Bootstrap -->
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css" rel="stylesheet"
integrity="sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH" crossorigin="anonymous">
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/js/bootstrap.bundle.min.js"
integrity="sha384-YvpcrYf0tY3lHB60NNkmXc5s9fDVZLESaAA55NDzOxhy9GkcIdslK1eN7N6jIeHz" crossorigin="anonymous"></script>
<!-- Font Awesome -->
<link href="../css/fontawesome.min.css" rel="stylesheet">
<link href="../css/brands.min.css" rel="stylesheet">
<link href="../css/regular.min.css" rel="stylesheet">
<link href="../css/solid.min.css" rel="stylesheet">
<link href="../css/v4-font-face.min.css" rel="stylesheet">
<link href="../css/v4-shims.min.css" rel="stylesheet">
<!-- MathJax -->
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
TeX: { equationNumbers: { autoNumber: "AMS" } }
});
</script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@2.7.9/MathJax.js?config=TeX-AMS-MML_HTMLorMML" async
integrity="sha256-DViIOMYdwlM/axqoGDPeUyf0urLoHMN4QACBKyB58Uw=" crossorigin="anonymous"></script>
<!-- Other scripts and stylesheets -->
<link href="../css/local.css" rel="stylesheet">
<link href="../css/pygments.css" rel="stylesheet">
<script src="../js/svg-pan-zoom.min.js"></script>
</head>
<body>
<!-- Fixed navbar -->
<div class="container-fluid mb-sm-4 mb-xl-2">
<nav class="navbar navbar-expand-lg navbar-dark bg-dark fixed-top">
<div class="container">
<a class="navbar-brand" href="../index.html">HPC DNS Post-Processing Fortran Core <small>1.0.0</small></a>
<button type="button" class="navbar-toggler" data-bs-toggle="collapse" data-bs-target="#navbar"
aria-expanded="false" aria-controls="navbar" aria-label="Toggle navigation">
<span class="navbar-toggler-icon">
</button>
<div id="navbar" class="navbar-collapse collapse">
<ul class="navbar-nav">
<li class="nav-item">
<a class="nav-link" href="../lists/files.html">Source Files</a>
</li>
<li class="nav-item">
<a class="nav-link" href="../lists/modules.html">Modules</a>
</li>
<li class="nav-item">
<a class="nav-link" href="../lists/procedures.html">Procedures</a>
</li>
<li class="nav-item">
<a class="nav-link" href="../lists/programs.html">Programs</a>
</li>
</ul>
<div class="d-flex align-items-end flex-grow-1">
<form action="../search.html" role="search" class="ms-auto">
<input type="text" class="form-control" aria-label="Search" placeholder="Search" name="q" id="tipue_search_input" autocomplete="off" required>
</form>
</div>
</div><!--/.nav-collapse -->
</div>
</nav>
</div>
<div class="container">
<div class="row">
<h1>m_parameters
<small>Module</small>
</h1>
<div class="container p-2 mb-4 bg-light border rounded-3">
<div class="row align-items-center justify-content-between" id="info-bar">
<div class="col">
<ul class="list-inline" style="margin-bottom:0px;display:inline">
<li class="list-inline-item" id="statements"><i class="fa fa-list-ol"></i>
<a data-bs-toggle="tooltip" data-bs-placement="bottom" data-bs-html="true"
title="11.6% of total for modules and submodules.">127 statements</a>
</li>
<li class="list-inline-item" id="source-file">
<i class="fa fa-code"></i>
<a href="../src/m_parameters.f90"> Source File</a>
</li>
</ul>
</div>
<div class="col">
<nav aria-label="breadcrumb">
<ol class="breadcrumb justify-content-end mb-0">
<li class="breadcrumb-item"><a href='../sourcefile/m_parameters.f90.html'>m_parameters.f90</a></li>
<li class="breadcrumb-item active" aria-current="page">m_parameters</li>
</ol>
</nav>
</div>
</div>
</div>
<script>
// Enable Bootstrap tooltips
(function () {
const tooltipTriggerList = document.querySelectorAll('[data-bs-toggle="tooltip"]')
const tooltipList = [...tooltipTriggerList].map(tooltipTriggerEl => new bootstrap.Tooltip(tooltipTriggerEl))
})();
</script>
</div>
<div class="row">
<div class="col-md-3">
<div id="sidebar">
<h3>Contents</h3>
<div class="card mb-4">
<a data-bs-toggle="collapse" href="#vars-0"
aria-expanded="false" aria-controls="vars-0">
<h4 class="card-header bg-primary text-white">Variables</h4>
</a>
<div id="vars-0" class="collapse">
<div class="list-group list-group-flush">
<a class="list-group-item" href="../module/m_parameters.html#variable-nxp">nxp</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-nyp">nyp</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-nzp">nzp</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-hxp">hxp</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-hyp">hyp</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-hzp">hzp</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-l_0">l_0</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-startnum">startnum</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-endnum">endnum</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-skipnum">skipnum</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-shiftnum">shiftnum</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-scp">scp</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-prp">prp</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-lep">lep</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-vis0p">vis0p</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-rod">rod</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-prof_wr">prof_wr</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-min_wr">min_wr</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-min_fsd">min_fsd</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-min_c">min_c</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-refwr">refwr</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-pre">pre</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-ac">ac</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-bc">bc</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-c_cut">c_cut</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-c_ref">c_ref</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-syp">syp</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-eyp">eyp</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-twod">twod</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-sl_u">SL_u</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-omitnum">omitnum</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-omit_t">omit_t</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-file_dist">file_dist</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-export_offset">export_offset</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-pi">pi</a>
<a class="list-group-item" href="../module/m_parameters.html#variable-me">me</a>
</div>
</div>
</div>
<div class="card mb-4">
<a data-bs-toggle="collapse" href="#funcs-0"
aria-expanded="false" aria-controls="funcs-0">
<h4 class="card-header bg-primary text-white">Functions</h4>
</a>
<div id="funcs-0" class="collapse">
<div class="list-group list-group-flush">
<a class="list-group-item" href="../module/m_parameters.html#proc-to_omit">to_omit</a>
</div>
</div>
</div>
<div class="card mb-4">
<a data-bs-toggle="collapse" href="#subs-0"
aria-expanded="false" aria-controls="subs-0">
<h4 class="card-header bg-primary text-white">Subroutines</h4>
</a>
<div id="subs-0" class="collapse">
<div class="list-group list-group-flush">
<a class="list-group-item" href="../module/m_parameters.html#proc-read_intro">read_intro</a>
</div>
</div>
</div>
</div>
</div>
<div class="col-md-9" id='text'>
<br> <div class="card mb-4">
<h3 class="card-header card-title bg-light">Uses</h3>
<div class="card-body">
<ul class="list-group list-group-flush">
<li class="list-group-item">
<ul class="list-inline">
<li class="list-inline-item"><a href='http://fortranwiki.org/fortran/show/iso_fortran_env'>iso_fortran_env</a></li>
<li class="list-inline-item"><a href='m_openmpi.html'>m_openmpi</a></li>
</ul>
</li>
</ul>
</div>
</div>
<br>
<section>
<h2>Variables</h2>
<table class="table table-striped varlist">
<thead>
<tr>
<th scope="col">Type</th>
<th scope="col">Visibility</th> <th scope="col">Attributes</th>
<th scope="col"></th>
<th scope="col">Name</th>
<th></th><th scope="col">Initial</th> <th scope="col"></th>
</thead>
<tbody>
<tr>
<td>
<span class="anchor" id="variable-nxp"></span>
integer,
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>nxp</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-nyp"></span>
integer,
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>nyp</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-nzp"></span>
integer,
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>nzp</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-hxp"></span>
real(kind=real64),
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>hxp</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-hyp"></span>
real(kind=real64),
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>hyp</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-hzp"></span>
real(kind=real64),
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>hzp</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-l_0"></span>
real(kind=real64),
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>l_0</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-startnum"></span>
integer,
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>startnum</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-endnum"></span>
integer,
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>endnum</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-skipnum"></span>
integer,
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>skipnum</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-shiftnum"></span>
integer,
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>shiftnum</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-scp"></span>
real(kind=real64),
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>scp</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-prp"></span>
real(kind=real64),
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>prp</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-lep"></span>
real(kind=real64),
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>lep</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-vis0p"></span>
real(kind=real64),
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>vis0p</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-rod"></span>
real(kind=real64),
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>rod</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-prof_wr"></span>
real(kind=real64),
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>prof_wr</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-min_wr"></span>
real(kind=real64),
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>min_wr</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-min_fsd"></span>
real(kind=real64),
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>min_fsd</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-min_c"></span>
real(kind=real64),
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>min_c</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-refwr"></span>
real(kind=real64),
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>refwr</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-pre"></span>
real(kind=real64),
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>pre</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-ac"></span>
real(kind=real64),
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>ac</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-bc"></span>
real(kind=real64),
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>bc</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-c_cut"></span>
real(kind=real64),
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>c_cut</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-c_ref"></span>
real(kind=real64),
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>c_ref</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-syp"></span>
integer,
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>syp</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-eyp"></span>
integer,
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>eyp</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-twod"></span>
integer,
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>twod</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-sl_u"></span>
real(kind=real64),
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>SL_u</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-omitnum"></span>
integer,
</td>
<td>public</td>
<td>
</td>
<td>::</td>
<td><strong>omitnum</strong></td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-omit_t"></span>
integer,
</td>
<td>public,</td>
<td>
allocatable
</td>
<td>::</td>
<td><strong>omit_t</strong>(:,:)</td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-file_dist"></span>
integer,
</td>
<td>public,</td>
<td>
allocatable
</td>
<td>::</td>
<td><strong>file_dist</strong>(:)</td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-export_offset"></span>
integer,
</td>
<td>public,</td>
<td>
allocatable
</td>
<td>::</td>
<td><strong>export_offset</strong>(:)</td>
<td></td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-pi"></span>
real(kind=real64),
</td>
<td>public,</td>
<td>
parameter
</td>
<td>::</td>
<td><strong>pi</strong></td>
<td> =</td>
<td>3.14159265358979323846_real64</td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-me"></span>
real(kind=real64),
</td>
<td>public,</td>
<td>
parameter
</td>
<td>::</td>
<td><strong>me</strong></td>
<td> =</td>
<td>1.00e-20_real64</td>
<td>
</td>
</tr>
</tbody>
</table>
</section>
<br>
<section>
<h2>Functions</h2>
<div class="card">
<div class="card-header codesum"><span class="anchor" id="proc-to_omit"></span> <h3>public function <a href='../proc/to_omit.html'>to_omit</a>(num)
</h3></div>
<div class="card-body">
<h4>Arguments</h4>
<table class="table table-striped varlist">
<thead>
<tr>
<th scope="col">Type</th>
<th scope="col">Intent</th><th scope="col">Optional</th> <th scope="col">Attributes</th>
<th scope="col"></th>
<th scope="col">Name</th>
<th scope="col"></th>
</thead>
<tbody>
<tr>
<td>
<span class="anchor" id="variable-num"></span>
integer,
</td>
<td>intent(in)</td>
<td></td> <td>
</td>
<td>::</td>
<td><strong>num</strong></td>
<td>
</td>
</tr>
</tbody>
</table>
<h4>
Return Value
<small>logical</small>
</h4>
</div>
</div>
</section>
<br>
<section>
<h2>Subroutines</h2>
<div class="card">
<div class="card-header codesum"><span class="anchor" id="proc-read_intro"></span> <h3>public subroutine <a href='../proc/read_intro.html'>read_intro</a>()
</h3></div>
<div class="card-body">
<h4>Arguments</h4>
<em>None</em>
</div>
</div>
</section>
<br>
</div>
</div>
<hr>
</div> <!-- /container -->
<footer>
<div class="container">
<div class="row justify-content-between">
<div class="col">
<p>
HPC DNS Post-Processing Fortran Core
was developed by Google DeepMind Team & Ignis<br> &copy; 2026
</p>
</div>
<div class="col">
<p class="text-end">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
</p>
</div>
</div>
<br>
</div> <!-- /container -->
</footer>
</body>
</html>