"Fossies" - the Fresh Open Source Software Archive

Member "petsc-3.12.4/docs/manualpages/Sys/PetscOptionsRealArray.html" (4 Feb 2020, 5215 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/PetscOptionsRealArray.html" />
    4 <META NAME="GENERATOR" CONTENT="DOCTEXT">
    5 <TITLE>PetscOptionsRealArray</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/PetscOptionsRealArray.html "><small>Report Typos and Errors</small></a></div>
   10 <A NAME="PetscOptionsRealArray"><H1>PetscOptionsRealArray</H1></A>
   11 Gets an array of double values for a particular option in the database. The values must be separated with commas with no intervening spaces. 
   12 <H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
   13 <PRE>
   14 #include "petscsys.h"   
   15 <A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> PetscOptionsRealArray_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> value[],<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *n,<A HREF="../Sys/PetscBool.html#PetscBool">PetscBool</A>  *set)
   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 Parameters</FONT></H3>
   20 <TABLE border="0" cellpadding="0" cellspacing="0">
   21 <TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>opt </B></TD><TD>- the option one is seeking
   22 </TD></TR>
   23 <TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>text </B></TD><TD>- short string describing option
   24 </TD></TR>
   25 <TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>man </B></TD><TD>- manual page for option
   26 </TD></TR>
   27 <TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>nmax </B></TD><TD>- maximum number of values
   28 </TD></TR></TABLE>
   29 <P>
   30 <H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
   31 <TABLE border="0" cellpadding="0" cellspacing="0">
   32 <TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>value </B></TD><TD>- location to copy values
   33 </TD></TR>
   34 <TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>nmax </B></TD><TD>- actual number of values found
   35 </TD></TR>
   36 <TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>set </B></TD><TD>- <A HREF="../Sys/PETSC_TRUE.html#PETSC_TRUE">PETSC_TRUE</A> if found, else <A HREF="../Sys/PETSC_FALSE.html#PETSC_FALSE">PETSC_FALSE</A>
   37 </TD></TR></TABLE>
   38 <P>
   39 
   40 <P>
   41 <H3><FONT COLOR="#CC3333">Notes</FONT></H3>
   42 The user should pass in an array of doubles
   43 <P>
   44 Must be between a <A HREF="../Sys/PetscOptionsBegin.html#PetscOptionsBegin">PetscOptionsBegin</A>() and a <A HREF="../Sys/PetscOptionsEnd.html#PetscOptionsEnd">PetscOptionsEnd</A>()
   45 <P>
   46 <H3><FONT COLOR="#CC3333">See Also</FONT></H3>
   47  <A HREF="../Sys/PetscOptionsGetInt.html#PetscOptionsGetInt">PetscOptionsGetInt</A>(), <A HREF="../Sys/PetscOptionsGetReal.html#PetscOptionsGetReal">PetscOptionsGetReal</A>(),
   48 <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>(),
   49 <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>(),
   50 <A HREF="../Sys/PetscOptionsStringArray.html#PetscOptionsStringArray">PetscOptionsStringArray</A>(),<A HREF="../Sys/PetscOptionsRealArray.html#PetscOptionsRealArray">PetscOptionsRealArray</A>(), <A HREF="../Sys/PetscOptionsScalar.html#PetscOptionsScalar">PetscOptionsScalar</A>(),
   51 <A HREF="../Sys/PetscOptionsBoolGroupBegin.html#PetscOptionsBoolGroupBegin">PetscOptionsBoolGroupBegin</A>(), <A HREF="../Sys/PetscOptionsBoolGroup.html#PetscOptionsBoolGroup">PetscOptionsBoolGroup</A>(), <A HREF="../Sys/PetscOptionsBoolGroupEnd.html#PetscOptionsBoolGroupEnd">PetscOptionsBoolGroupEnd</A>(),
   52 <A HREF="../Sys/PetscOptionsFList.html#PetscOptionsFList">PetscOptionsFList</A>(), <A HREF="../Sys/PetscOptionsEList.html#PetscOptionsEList">PetscOptionsEList</A>()
   53 <P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>beginner<BR>
   54 <H3><FONT COLOR="#CC3333">Location</FONT></H3>
   55 </B><A HREF="../../../src/sys/objects/aoptions.c.html#PetscOptionsRealArray">src/sys/objects/aoptions.c</A>
   56 <P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
   57 <A HREF="../../../src/ts/examples/tutorials/ex11.c.html">src/ts/examples/tutorials/ex11.c.html</A><BR>
   58 <A HREF="../../../src/ts/examples/tutorials/ex48.c.html">src/ts/examples/tutorials/ex48.c.html</A><BR>
   59 <BR><A HREF="./index.html">Index of all Sys routines</A>
   60 <BR><A HREF="../../index.html">Table of Contents for all manual pages</A>
   61 <BR><A HREF="../singleindex.html">Index of all manual pages</A>
   62 </BODY></HTML>