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
|
<!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=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SuperLU: EXAMPLE/sp_ienv.c File Reference</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="doxygen.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 id="projectrow">
<td id="projectalign">
<div id="projectname">SuperLU<span id="projectnumber"> 7.0.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_2ed5cd83c419d7f3788213bde77ef248.html">EXAMPLE</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">sp_ienv.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Chooses machine-dependent parameters for the local environment.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="slu__Cnames_8h_source.html">slu_Cnames.h</a>"</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for sp_ienv.c:</div>
<div class="dyncontent">
<div class="center"><img src="EXAMPLE_2sp__ienv_8c__incl.png" border="0" usemap="#aEXAMPLE_2sp__ienv_8c" alt=""/></div>
<map name="aEXAMPLE_2sp__ienv_8c" id="aEXAMPLE_2sp__ienv_8c">
<area shape="rect" title="Chooses machine-dependent parameters for the local environment." alt="" coords="5,5,151,32"/>
<area shape="rect" href="slu__Cnames_8h.html" title="Macros defining how C routines will be called." alt="" coords="25,80,131,107"/>
</map>
</div>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a21109476f1261abd6b256a393f5fd9e7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="EXAMPLE_2sp__ienv_8c.html#a21109476f1261abd6b256a393f5fd9e7">sp_ienv</a> (int ispec)</td></tr>
<tr class="separator:a21109476f1261abd6b256a393f5fd9e7"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><pre>
-- SuperLU routine (version 4.1) --
Univ. of California Berkeley, Xerox Palo Alto Research Center,
and Lawrence Berkeley National Lab.
November, 2010
</pre> </div><h2 class="groupheader">Function Documentation</h2>
<a id="a21109476f1261abd6b256a393f5fd9e7" name="a21109476f1261abd6b256a393f5fd9e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21109476f1261abd6b256a393f5fd9e7">◆ </a></span>sp_ienv()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int sp_ienv </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>ispec</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<pre>
Purpose
=======
<a class="el" href="SRC_2sp__ienv_8c.html#a21109476f1261abd6b256a393f5fd9e7">sp_ienv()</a> is inquired to choose machine-dependent parameters for the
local environment. See ISPEC for a description of the parameters.
This version provides a set of parameters which should give good,
but not optimal, performance on many of the currently available
computers. Users are encouraged to modify this subroutine to set
the tuning parameters for their particular machine using the option
and problem size information in the arguments.
Arguments
=========
ISPEC (input) int
Specifies the parameter to be returned as the value of SP_IENV.
= 1: the panel size w; a panel consists of w consecutive
columns of matrix A in the process of Gaussian elimination.
The best value depends on machine's cache characters.
= 2: the relaxation parameter relax; if the number of
nodes (columns) in a subtree of the elimination tree is less
than relax, this subtree is considered as one supernode,
regardless of their row structures.
= 3: the maximum size for a supernode in complete LU;
= 4: the minimum row dimension for 2-D blocking to be used;
= 5: the minimum column dimension for 2-D blocking to be used;
= 6: the estimated fills factor for L and U, compared with A;
= 7: the maximum size for a supernode in ILU.
(SP_IENV) (output) int
>= 0: the value of the parameter specified by ISPEC
< 0: if SP_IENV = -k, the k-th argument had an illegal value.
=====================================================================
</pre> <div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="EXAMPLE_2sp__ienv_8c_a21109476f1261abd6b256a393f5fd9e7_cgraph.png" border="0" usemap="#aEXAMPLE_2sp__ienv_8c_a21109476f1261abd6b256a393f5fd9e7_cgraph" alt=""/></div>
<map name="aEXAMPLE_2sp__ienv_8c_a21109476f1261abd6b256a393f5fd9e7_cgraph" id="aEXAMPLE_2sp__ienv_8c_a21109476f1261abd6b256a393f5fd9e7_cgraph">
<area shape="rect" title=" " alt="" coords="5,5,73,32"/>
<area shape="rect" href="input__error_8c.html#ad4e27444570b55672c6d20dc1adb12c0" title=" " alt="" coords="121,5,208,32"/>
</map>
</div>
</div>
</div>
</div><!-- contents -->
<!-- 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.4
</small></address>
</body>
</html>
|