<?xml-stylesheet type="text/xsl" href="../styles/pmathml.xsl"?>
<!-- saved from url=(0014)about:internet -->
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:dsi="http://www.w3.org/1999/xlink" xmlns:m="http://www.w3.org/1998/Math/MathML" xml:space="preserve"><head><meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"/><title>D02NXF : NAG Library, Mark 22</title><link rel="stylesheet" href="../styles/libdoc.css" type="text/css"/><script type="text/javascript">
   function showLevel(_levelId){
    var thisLevel = document.getElementById(_levelId);
    var thisplus = document.getElementById( _levelId.concat('plus'));
    var thisminus = document.getElementById( _levelId.concat('minus'));
    if(thisLevel.style.display != "block"){
     thisLevel.style.display = "block";
     thisplus.style.display = "none";
     thisminus.style.display = "inline";
     }
    else{
     thisLevel.style.display = "none";
     thisminus.style.display = "none";
     thisplus.style.display = "inline";
     }
    }
  </script></head><body><hr/><div><a class="rout" href="../../pdf/D02/d02nxf.pdf">D02NXF (PDF version)</a></div><div><a class="chap" href="d02conts.xml">D02 Chapter Contents</a></div><div><a class="chapint" href="d02intro.xml">D02 Chapter Introduction</a></div>
<div><a class="htmltoc" href="../FRONTMATTER/manconts.xml">NAG Library Manual</a></div><hr/><h1 class="libdoc">NAG Library Routine Document<br/><br/>D02NXF</h1><div class="paramtext"><div class="header"><b>Note:</b>&#160; before using this routine, please read the Users' Note for your implementation to check the interpretation of <span class="bitalic">bold italicised</span> terms and other implementation-dependent details.</div></div> 
<div class="htmltoc">
<h2 class="htmltoc"><span class="htmltochead" onclick="showLevel('htmltoc');"><span class="htmltocplus" id="htmltocplus">+</span><span class="htmltocminus" id="htmltocminus">&#8722;</span></span>&#160;Contents</h2>
<div class="htmltocitem" id="htmltoc">
<div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#purpose">1&#160;&#160;<b>Purpose</b></a>
</div><div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#specification">2&#160;&#160;<b>Specification</b></a>
</div><div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#description">3&#160;&#160;<b>Description</b></a>
</div><div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#references">4&#160;&#160;<b>References</b></a>
</div><div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#parameters">5&#160;&#160;<b>Parameters</b></a>
</div><div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#errors">6&#160;&#160;<b>Error Indicators and Warnings</b></a>
</div><div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#accuracy">7&#160;&#160;<b>Accuracy</b></a>
</div><div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#fcomments">8&#160;&#160;<b>Further Comments</b></a>
</div><div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#example">9&#160;&#160;<b>Example</b></a>
</div>
</div>
</div><h2 class="standard"><a class="sec" name="purpose" id="purpose"/>1&#160;&#160;Purpose</h2>
<div class="paramtext">D02NXF is an optional output routine which you may call, on exit from an integrator in <a class="chap" href="../D02/d02conts.xml">sub-chapter D02M&#8211;N</a>, if sparse matrix linear algebra has been selected.</div><h2 class="standard"><a class="sec" name="specification" id="specification"/>2&#160;&#160;Specification</h2>
<table class="fspec"><tr><td class="tdfspec1">SUBROUTINE&#160;D02NXF&#160;(</td><td class="tdfspec2"><a class="arg" href="#ICALL">ICALL</a>, <a class="arg" href="#LIWREQ">LIWREQ</a>, <a class="arg" href="#LIWUSD">LIWUSD</a>, <a class="arg" href="#LRWREQ">LRWREQ</a>, <a class="arg" href="#LRWUSD">LRWUSD</a>, <a class="arg" href="#NLU">NLU</a>, <a class="arg" href="#NNZ">NNZ</a>, <a class="arg" href="#NGP">NGP</a>, <a class="arg" href="#ISPLIT">ISPLIT</a>, <a class="arg" href="#IGROW">IGROW</a>, <a class="arg" href="#LBLOCK">LBLOCK</a>, <a class="arg" href="#NBLOCK">NBLOCK</a>, <a class="arg" href="#INFORM">INFORM</a>)</td></tr><tr><td class="tdfspec1">INTEGER</td><td class="tdfspec2">ICALL, LIWREQ, LIWUSD, LRWREQ, LRWUSD, NLU, NNZ, NGP, ISPLIT, IGROW, NBLOCK, INFORM(23)</td></tr><tr><td class="tdfspec1">LOGICAL</td><td class="tdfspec2">LBLOCK</td></tr></table><h2 class="standard"><a class="sec" name="description" id="description"/>3&#160;&#160;Description</h2>
<div class="paramtext">D02NXF permits you to examine the various outputs from the sparse linear algebra routines called by the integrator.</div><h2 class="standard"><a class="sec" name="references" id="references"/>4&#160;&#160;References</h2>
<div class="paramtext">See the <a class="chapint" href="../D02/d02mnintro.xml">D02M&#8211;N sub-chapter Introduction</a>.</div><h2 class="standard"><a class="sec" name="parameters" id="parameters"/>5&#160;&#160;Parameters</h2>
<dl><dt class="paramhead"><a name="ICALL" id="ICALL"/>1: &#160;&#160;&#8194; ICALL &#8211; INTEGER<span class="pclass">Input</span></dt><dd>
<div class="paramtext"><i>On entry</i>: indicates whether or not all output parameters have been set during the call to the integrator. If so, that is, if the integrator returned with <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#IFAIL"><m:mi mathcolor="#EE0000" mathvariant="bold">IFAIL</m:mi></m:maction><m:mo>=</m:mo><m:maction actiontype="link" dsi:type="simple" dsi:href="../D02/d02ndf.xml#errors"><m:mn mathcolor="#003399" mathvariant="bold">0</m:mn></m:maction></m:math>&#160;or <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="../D02/d02ndf.xml#IFeq12"><m:mn mathcolor="#003399" mathvariant="bold">12</m:mn></m:maction></m:math>, then <a class="arg" href="#ICALL">ICALL</a> must be set to <m:math><m:mn>0</m:mn></m:math>. Otherwise <a class="arg" href="#ICALL">ICALL</a> must be set to <m:math><m:mn>1</m:mn></m:math>, indicating that integration did not take place due to lack of space in arrays <a class="arg" href="../D02/d02nnf.xml#WKJAC">WKJAC</a> and <a class="arg" href="../D02/d02nnf.xml#JACPVT">JACPVT</a>, and only <a class="arg" href="#LIWREQ">LIWREQ</a>, <a class="arg" href="#LIWUSD">LIWUSD</a>, <a class="arg" href="#LRWREQ">LRWREQ</a>, <a class="arg" href="#LRWUSD">LRWUSD</a> have been set.</div></dd><dt class="paramhead"><a name="LIWREQ" id="LIWREQ"/>2: &#160;&#160;&#8194; LIWREQ &#8211; INTEGER<span class="pclass">Output</span></dt><dd>
<div class="paramtext"><i>On exit</i>: the length of the INTEGER workspace <a class="arg" href="../D02/d02nnf.xml#JACPVT">JACPVT</a> reserved for the sparse matrix routines.</div></dd><dt class="paramhead"><a name="LIWUSD" id="LIWUSD"/>3: &#160;&#160;&#8194; LIWUSD &#8211; INTEGER<span class="pclass">Output</span></dt><dd>
<div class="paramtext"><i>On exit</i>: the length of the INTEGER workspace <a class="arg" href="../D02/d02nnf.xml#JACPVT">JACPVT</a> actually used by the sparse matrix routines.</div></dd><dt class="paramhead"><a name="LRWREQ" id="LRWREQ"/>4: &#160;&#160;&#8194; LRWREQ &#8211; INTEGER<span class="pclass">Output</span></dt><dd>
<div class="paramtext"><i>On exit</i>: the length of the <span class="bitalic">double precision</span> workspace <a class="arg" href="../D02/d02nnf.xml#WKJAC">WKJAC</a> reserved for the sparse matrix routines.</div></dd><dt class="paramhead"><a name="LRWUSD" id="LRWUSD"/>5: &#160;&#160;&#8194; LRWUSD &#8211; INTEGER<span class="pclass">Output</span></dt><dd>
<div class="paramtext"><i>On exit</i>: the length of the <span class="bitalic">double precision</span> workspace <a class="arg" href="../D02/d02nnf.xml#WKJAC">WKJAC</a> actually used by the sparse matrix routines.</div></dd><dt class="paramhead"><a name="NLU" id="NLU"/>6: &#160;&#160;&#8194; NLU &#8211; INTEGER<span class="pclass">Output</span></dt><dd>
<div class="paramtext"><i>On exit</i>: the number of <m:math><m:mi>L</m:mi><m:mi>U</m:mi></m:math>&#160;decompositions done during the integration.</div></dd><dt class="paramhead"><a name="NNZ" id="NNZ"/>7: &#160;&#160;&#8194; NNZ &#8211; INTEGER<span class="pclass">Output</span></dt><dd>
<div class="paramtext"><i>On exit</i>: the number of nonzeros in the Jacobian.</div></dd><dt class="paramhead"><a name="NGP" id="NGP"/>8: &#160;&#160;&#8194; NGP &#8211; INTEGER<span class="pclass">Output</span></dt><dd>
<div class="paramtext"><i>On exit</i>: the number of <a class="arg" href="../D02/d02ndf.xml#FCN">FCN</a> or <a class="arg" href="../D02/d02njf.xml#RESID">RESID</a> calls needed to form the Jacobian.</div></dd><dt class="paramhead"><a name="ISPLIT" id="ISPLIT"/>9: &#160;&#160;&#8194; ISPLIT &#8211; INTEGER<span class="pclass">Output</span></dt><dd>
<div class="paramtext"><i>On exit</i>: an appropriate value for the parameter <a class="arg" href="#ISPLIT">ISPLIT</a> when calling <a class="rout" href="../D02/d02nuf.xml">D02NUF</a> for subsequent runs of similar problems.</div></dd><dt class="paramhead"><a name="IGROW" id="IGROW"/>10: &#8194; IGROW &#8211; INTEGER<span class="pclass">Output</span></dt><dd>
<div class="paramtext"><i>On exit</i>: an estimate of the growth of the elements encountered during the last <m:math><m:mi>L</m:mi><m:mi>U</m:mi></m:math>&#160;decomposition performed. If the actual estimate exceeds the largest possible integer value for the machine being used (see <a class="rout" href="../X02/x02bbf.xml">X02BBF</a>) <a class="arg" href="#IGROW">IGROW</a> is set to the value returned by <a class="rout" href="../X02/x02bbf.xml">X02BBF</a>.</div></dd><dt class="paramhead"><a name="LBLOCK" id="LBLOCK"/>11: &#8194; LBLOCK &#8211; LOGICAL<span class="pclass">Input</span></dt><dd>
<div class="paramtext"><i>On entry</i>: the value used for the parameter <a class="arg" href="#LBLOCK">LBLOCK</a> when calling <a class="rout" href="../D02/d02nuf.xml">D02NUF</a>.</div></dd><dt class="paramhead"><a name="NBLOCK" id="NBLOCK"/>12: &#8194; NBLOCK &#8211; INTEGER<span class="pclass">Output</span></dt><dd>
<div class="paramtext"><i>On exit</i>: if <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#LBLOCK"><m:mi mathcolor="#EE0000" mathvariant="bold">LBLOCK</m:mi></m:maction><m:mo>=</m:mo><m:mi mathvariant="normal">.TRUE.</m:mi></m:math>, <a class="arg" href="#NBLOCK">NBLOCK</a> contains the number of diagonal blocks in the Jacobian matrix permuted to block lower triangular form. If <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#NBLOCK"><m:mi mathcolor="#EE0000" mathvariant="bold">NBLOCK</m:mi></m:maction><m:mo>=</m:mo><m:mn>1</m:mn></m:math>&#160;then on subsequent runs of a similar problem <a class="arg" href="#LBLOCK">LBLOCK</a> should be set to .FALSE. in the call to <a class="rout" href="../D02/d02nuf.xml">D02NUF</a>. 
<div class="paramtext">If <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#LBLOCK"><m:mi mathcolor="#EE0000" mathvariant="bold">LBLOCK</m:mi></m:maction><m:mo>=</m:mo><m:mi mathvariant="normal">.FALSE.</m:mi></m:math>, <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#NBLOCK"><m:mi mathcolor="#EE0000" mathvariant="bold">NBLOCK</m:mi></m:maction><m:mo>=</m:mo><m:mn>1</m:mn></m:math>.</div>
</div></dd><dt class="paramhead"><a name="INFORM" id="INFORM"/>13: &#8194; INFORM(<m:math><m:mn>23</m:mn></m:math>) &#8211; INTEGER array<span class="pclass">Communication Array</span></dt><dd>
<div class="paramtext"><i>On entry</i>: contains information supplied by the integrator.</div>
</dd></dl><h2 class="standard"><a class="sec" name="errors" id="errors"/>6&#160;&#160;Error Indicators and Warnings</h2>
<div class="paramtext">None.</div><h2 class="standard"><a class="sec" name="accuracy" id="accuracy"/>7&#160;&#160;Accuracy</h2>
<div class="paramtext">Not applicable.</div><h2 class="standard"><a class="sec" name="fcomments" id="fcomments"/>8&#160;&#160;Further Comments</h2>
<div class="paramtext">The output from D02NXF, in particular the values of <a class="arg" href="#LIWREQ">LIWREQ</a>, <a class="arg" href="#LIWUSD">LIWUSD</a>, <a class="arg" href="#LRWREQ">LRWREQ</a>, <a class="arg" href="#LRWUSD">LRWUSD</a>, <a class="arg" href="#ISPLIT">ISPLIT</a> and <a class="arg" href="#IGROW">IGROW</a>, should be used to determine appropriate values for the parameters of the setup routine <a class="rout" href="../D02/d02nuf.xml">D02NUF</a> on further calls to the integrator for the same or similar problems.</div><h2 class="standard"><a class="sec" name="example" id="example"/>9&#160;&#160;Example</h2>
<div class="paramtext">See Section 9 in <a class="rout" href="../D02/d02ndf.xml">D02NDF</a>, <a class="rout" href="../D02/d02njf.xml">D02NJF</a> and <a class="rout" href="../D02/d02nnf.xml">D02NNF</a>.</div>
<hr/><div><a class="rout" href="../../pdf/D02/d02nxf.pdf">D02NXF (PDF version)</a></div><div><a class="chap" href="d02conts.xml">D02 Chapter Contents</a></div><div><a class="chapint" href="d02intro.xml">D02 Chapter Introduction</a></div>
<div><a class="htmltoc" href="../FRONTMATTER/manconts.xml">NAG Library Manual</a></div>
<div><hr/><a class="genint" href="../FRONTMATTER/copyright.xml">&#169; The Numerical Algorithms Group Ltd, Oxford, UK. 2009</a></div></body></html>
