"Fossies" - the Fresh Open Source Software Archive

Member "petsc-3.12.4/docs/manualpages/Sys/PetscOptionsHead.html" (4 Feb 2020, 3969 Bytes) of package /linux/misc/petsc-3.12.4.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) HTML source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
    2 <HTML>
    3 <HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Sys/PetscOptionsHead.html" />
    4 <META NAME="GENERATOR" CONTENT="DOCTEXT">
    5 <TITLE>PetscOptionsHead</TITLE>
    6 </HEAD>
    7 <BODY BGCOLOR="FFFFFF">
    8    <div id="version" align=right><b>petsc-3.12.4 2020-02-04</b></div>
    9    <div id="bugreport" align=right><a href="mailto:petsc-maint@mcs.anl.gov?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: petsc-3.12.4 v3.12.4 docs/manualpages/Sys/PetscOptionsHead.html "><small>Report Typos and Errors</small></a></div>
   10 <A NAME="PetscOptionsHead"><H1>PetscOptionsHead</H1></A>
   11 Puts a heading before listing any more published options. Used, for example, in KSPSetFromOptions_GMRES(). 
   12 <H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
   13 <PRE>
   14 #include "petscsys.h"   
   15 <A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A>  <A HREF="../Sys/PetscOptionsHead.html#PetscOptionsHead">PetscOptionsHead</A>(PetscOptionItems *PetscOptionsObject,const char head[])
   16 </PRE>
   17 Logically Collective on the communicator passed in <A HREF="../Sys/PetscOptionsBegin.html#PetscOptionsBegin">PetscOptionsBegin</A>()
   18 <P>
   19 <H3><FONT COLOR="#CC3333">Input Parameter</FONT></H3>
   20 <DT><B>head </B> -the heading text
   21 <br>
   22 <P>
   23 <P>
   24 
   25 <P>
   26 <H3><FONT COLOR="#CC3333">Notes</FONT></H3>
   27 Must be between a <A HREF="../Sys/PetscOptionsBegin.html#PetscOptionsBegin">PetscOptionsBegin</A>() and a <A HREF="../Sys/PetscOptionsEnd.html#PetscOptionsEnd">PetscOptionsEnd</A>()
   28 <P>
   29 Can be followed by a call to <A HREF="../Sys/PetscOptionsTail.html#PetscOptionsTail">PetscOptionsTail</A>() in the same function.
   30 <P>
   31 <H3><FONT COLOR="#CC3333">See Also</FONT></H3>
   32  <A HREF="../Sys/PetscOptionsGetInt.html#PetscOptionsGetInt">PetscOptionsGetInt</A>(), <A HREF="../Sys/PetscOptionsGetReal.html#PetscOptionsGetReal">PetscOptionsGetReal</A>(),
   33 <BR><A HREF="../Sys/PetscOptionsHasName.html#PetscOptionsHasName">PetscOptionsHasName</A>(), <A HREF="../Sys/PetscOptionsGetIntArray.html#PetscOptionsGetIntArray">PetscOptionsGetIntArray</A>(), <A HREF="../Sys/PetscOptionsGetRealArray.html#PetscOptionsGetRealArray">PetscOptionsGetRealArray</A>(), <A HREF="../Sys/PetscOptionsBool.html#PetscOptionsBool">PetscOptionsBool</A>(),
   34 <A HREF="../Sys/PetscOptionsName.html#PetscOptionsName">PetscOptionsName</A>(), <A HREF="../Sys/PetscOptionsBegin.html#PetscOptionsBegin">PetscOptionsBegin</A>(), <A HREF="../Sys/PetscOptionsEnd.html#PetscOptionsEnd">PetscOptionsEnd</A>(), <A HREF="../Sys/PetscOptionsHead.html#PetscOptionsHead">PetscOptionsHead</A>(),
   35 <A HREF="../Sys/PetscOptionsStringArray.html#PetscOptionsStringArray">PetscOptionsStringArray</A>(),<A HREF="../Sys/PetscOptionsRealArray.html#PetscOptionsRealArray">PetscOptionsRealArray</A>(), <A HREF="../Sys/PetscOptionsScalar.html#PetscOptionsScalar">PetscOptionsScalar</A>(),
   36 <A HREF="../Sys/PetscOptionsBoolGroupBegin.html#PetscOptionsBoolGroupBegin">PetscOptionsBoolGroupBegin</A>(), <A HREF="../Sys/PetscOptionsBoolGroup.html#PetscOptionsBoolGroup">PetscOptionsBoolGroup</A>(), <A HREF="../Sys/PetscOptionsBoolGroupEnd.html#PetscOptionsBoolGroupEnd">PetscOptionsBoolGroupEnd</A>(),
   37 <A HREF="../Sys/PetscOptionsFList.html#PetscOptionsFList">PetscOptionsFList</A>(), <A HREF="../Sys/PetscOptionsEList.html#PetscOptionsEList">PetscOptionsEList</A>()
   38 <P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>intermediate<BR>
   39 <H3><FONT COLOR="#CC3333">Location</FONT></H3>
   40 </B><A HREF="../../../src/sys/objects/aoptions.c.html#PetscOptionsHead">src/sys/objects/aoptions.c</A>
   41 <P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
   42 <A HREF="../../../src/ts/examples/tutorials/ex11.c.html">src/ts/examples/tutorials/ex11.c.html</A><BR>
   43 <BR><A HREF="./index.html">Index of all Sys routines</A>
   44 <BR><A HREF="../../index.html">Table of Contents for all manual pages</A>
   45 <BR><A HREF="../singleindex.html">Index of all manual pages</A>
   46 </BODY></HTML>