~ubuntu-branches/ubuntu/karmic/hypre/karmic

« back to all changes in this revision

Viewing changes to docs/HYPRE_ref_manual/StructSMGSolver.html

  • Committer: Bazaar Package Importer
  • Author(s): Adam C. Powell, IV
  • Date: 2009-03-20 11:40:12 UTC
  • mfrom: (4.1.2 sid)
  • Revision ID: james.westby@ubuntu.com-20090320114012-132h6ok9w2r6o609
Tags: 2.4.0b-2
Rebuild against new openmpi.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<html><head><TITLE>Struct SMG Solver</TITLE></head>
 
2
<body>
 
3
<H2><A HREF ="#DOC.DOCU" > <IMG BORDER=0 SRC=down.gif></A>  Struct SMG Solver  </H2>
 
4
<hr>
 
5
<DL>
 
6
<DT>
 
7
<IMG BORDER=0 SRC=icon1.gif>int  <B>HYPRE_StructSMGCreate</B>(MPI_Comm comm, <!2><A HREF="StructSolvers.2.html#DOC.4.1.1">HYPRE_StructSolver</A> *solver)
 
8
 <DD><I>
 
9
Create a solver object</I>
 
10
<DT>
 
11
<IMG BORDER=0 SRC=icon1.gif>int  <B>HYPRE_StructSMGDestroy</B>(<!2><A HREF="StructSolvers.2.html#DOC.4.1.1">HYPRE_StructSolver</A> solver)
 
12
 <DD><I>
 
13
Destroy a solver object</I>
 
14
<DT>
 
15
<IMG BORDER=0 SRC=icon1.gif> <A HREF=HYPRE_StructSMGSetup.html><B>HYPRE_StructSMGSetup</B></A> 
 
16
 <DD><I>
 
17
Prepare to solve the system</I>
 
18
<DT>
 
19
<IMG BORDER=0 SRC=icon1.gif>int  <B>HYPRE_StructSMGSolve</B>(<!2><A HREF="StructSolvers.2.html#DOC.4.1.1">HYPRE_StructSolver</A> solver, <!2><A HREF="StructMatrices.html#DOC.1.3.13">HYPRE_StructMatrix</A> A, <!2><A HREF="StructVectors.html#DOC.1.4.8">HYPRE_StructVector</A> b, <!2><A HREF="StructVectors.html#DOC.1.4.8">HYPRE_StructVector</A> x)
 
20
 <DD><I>
 
21
Solve the system</I>
 
22
<DT>
 
23
<IMG BORDER=0 SRC=icon1.gif>int  <B>HYPRE_StructSMGSetTol</B>(<!2><A HREF="StructSolvers.2.html#DOC.4.1.1">HYPRE_StructSolver</A> solver, double tol)
 
24
 <DD><I>
 
25
(Optional) Set the convergence tolerance</I>
 
26
<DT>
 
27
<IMG BORDER=0 SRC=icon1.gif>int  <B>HYPRE_StructSMGSetMaxIter</B>(<!2><A HREF="StructSolvers.2.html#DOC.4.1.1">HYPRE_StructSolver</A> solver, int max_iter)
 
28
 <DD><I>
 
29
(Optional) Set maximum number of iterations</I>
 
30
<DT>
 
31
<IMG BORDER=0 SRC=icon1.gif>int  <B>HYPRE_StructSMGSetRelChange</B>(<!2><A HREF="StructSolvers.2.html#DOC.4.1.1">HYPRE_StructSolver</A> solver, int rel_change)
 
32
 <DD><I>
 
33
(Optional) Additionally require that the relative difference in
 
34
successive iterates be small</I>
 
35
<DT>
 
36
<IMG BORDER=0 SRC=icon1.gif> <A HREF=HYPRE_StructSMGSetZeroGuess.html><B>HYPRE_StructSMGSetZeroGuess</B></A> 
 
37
 <DD><I>
 
38
(Optional) Use a zero initial guess</I>
 
39
<DT>
 
40
<IMG BORDER=0 SRC=icon1.gif> <A HREF=HYPRE_StructSMGSetNonZeroGuess.html><B>HYPRE_StructSMGSetNonZeroGuess</B></A> 
 
41
 <DD><I>
 
42
(Optional) Use a nonzero initial guess</I>
 
43
<DT>
 
44
<IMG BORDER=0 SRC=icon1.gif>int  <B>HYPRE_StructSMGSetNumPreRelax</B>(<!2><A HREF="StructSolvers.2.html#DOC.4.1.1">HYPRE_StructSolver</A> solver, int num_pre_relax)
 
45
 <DD><I>
 
46
(Optional) Set number of relaxation sweeps before coarse-grid correction</I>
 
47
<DT>
 
48
<IMG BORDER=0 SRC=icon1.gif>int  <B>HYPRE_StructSMGSetNumPostRelax</B>(<!2><A HREF="StructSolvers.2.html#DOC.4.1.1">HYPRE_StructSolver</A> solver, int num_post_relax)
 
49
 <DD><I>
 
50
(Optional) Set number of relaxation sweeps after coarse-grid correction</I>
 
51
<DT>
 
52
<IMG BORDER=0 SRC=icon1.gif>int  <B>HYPRE_StructSMGSetLogging</B>(<!2><A HREF="StructSolvers.2.html#DOC.4.1.1">HYPRE_StructSolver</A> solver, int logging)
 
53
 <DD><I>
 
54
(Optional) Set the amount of logging to do</I>
 
55
<DT>
 
56
<IMG BORDER=0 SRC=icon1.gif>int  <B>HYPRE_StructSMGSetPrintLevel</B>(<!2><A HREF="StructSolvers.2.html#DOC.4.1.1">HYPRE_StructSolver</A> solver, int print_level)
 
57
 <DD><I>
 
58
(Optional) Set the amount of printing to do to the screen</I>
 
59
<DT>
 
60
<IMG BORDER=0 SRC=icon1.gif>int  <B>HYPRE_StructSMGGetNumIterations</B>(<!2><A HREF="StructSolvers.2.html#DOC.4.1.1">HYPRE_StructSolver</A> solver, int *num_iterations)
 
61
 <DD><I>
 
62
Return the number of iterations taken</I>
 
63
<DT>
 
64
<IMG BORDER=0 SRC=icon1.gif>int  <B>HYPRE_StructSMGGetFinalRelativeResidualNorm</B>(<!2><A HREF="StructSolvers.2.html#DOC.4.1.1">HYPRE_StructSolver</A> solver, double *norm)
 
65
 <DD><I>
 
66
Return the norm of the final relative residual</I>
 
67
</DL>
 
68
<A NAME="DOC.DOCU">
 
69
<DL></DL><P><I><A HREF="aindex.html"> alphabetic index</A></I>  <I><A HREF="HIER.html"> hierarchy of classes</A></I><P><hr>
 
70
<center>
 
71
<img src="hypre_wiw.gif">
 
72
</center>
 
73
 
 
74
<P Align=right><I>generated by <A HREF="http://www.zib.de/Visual/software/doc++/index.html">doc++</A></I>
 
75
</BODY>