File: RGRingGetParameters.html

package info (click to toggle)
slepc 3.14.2%2Bdfsg1-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 31,976 kB
  • sloc: ansic: 102,426; python: 3,151; makefile: 2,969; f90: 1,607; fortran: 1,525; sh: 250; cpp: 189
file content (48 lines) | stat: -rw-r--r-- 2,709 bytes parent folder | download
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="https://slepc.upv.es/documentation/current/docs/manualpages/RG/RGRingGetParameters.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>RGRingGetParameters</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
   <div id="version" align=right><b>slepc-3.14.2 2021-02-01</b></div>
   <div id="bugreport" align=right><a href="mailto:slepc-maint@upv.es?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: slepc-3.14.2 v3.14.2 docs/manualpages/RG/RGRingGetParameters.html "><small>Report Typos and Errors</small></a></div>
<H1>RGRingGetParameters</H1>
Gets the parameters that define the ring region. 
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepcrg.h" 
PetscErrorCode <A HREF="../RG/RGRingGetParameters.html#RGRingGetParameters">RGRingGetParameters</A>(<A HREF="../RG/RG.html#RG">RG</A> rg,PetscScalar *center,PetscReal *radius,PetscReal *vscale,PetscReal *start_ang,PetscReal *end_ang,PetscReal *width)
</PRE>
Not Collective
<P>
<H3><FONT COLOR="#883300">Input Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>rg     </B></TD><TD>&nbsp;- the region context
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Output Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>center    </B></TD><TD>&nbsp;- center of the region
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>radius    </B></TD><TD>&nbsp;- radius of the region
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>vscale    </B></TD><TD>&nbsp;- vertical scale of the region
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>start_ang </B></TD><TD>&nbsp;- the right-hand side angle
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>end_ang   </B></TD><TD>&nbsp;- the left-hand side angle
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>width     </B></TD><TD>&nbsp;- width of the ring
</TD></TR></TABLE>
<P>

<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
 <A HREF="../RG/RGRingSetParameters.html#RGRingSetParameters">RGRingSetParameters</A>()
<BR><P><B><FONT COLOR="#883300">Location: </FONT></B><A HREF="../../../src/sys/classes/rg/impls/ring/rgring.c.html#RGRingGetParameters">src/sys/classes/rg/impls/ring/rgring.c</A>
<BR><A HREF="./index.html">Index of all RG routines</A>
<BR><A HREF="../../index.html">Table of Contents for all manual pages</A>
<BR><A HREF="../singleindex.html">Index of all manual pages</A>
</BODY></HTML>