File: index.html

package info (click to toggle)
petsc 3.7.5%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 163,864 kB
  • ctags: 618,438
  • sloc: ansic: 515,133; python: 29,793; makefile: 20,458; fortran: 18,998; cpp: 6,515; f90: 3,914; sh: 1,012; xml: 621; objc: 445; csh: 240; java: 13
file content (139 lines) | stat: -rw-r--r-- 6,052 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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 <html>
  <head> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/index.html" />
    <meta http-equiv="content-type" content="text/html;charset=utf-8">
    <title>Documentation</title>
  </head>
  <body bgcolor="#ffffff">
   <div id="version" align=right><b>petsc-3.7.5 2017-01-01</b></div>
   <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.7.5 v3.7.5 docs/index.html "><small>Report Typos and Errors</small></a></div>

    <h1>Documentation</h1>

    

    <div id="main">

      <p>
        <b>PETSc</b> is a sophisticated package and fully understanding its usage
        requires time. However, application programmers can easily begin to
        use <b>PETSc</b> from a high level and then gradually learn more
        details according to their needs. Users should read the users
        manual before attempting to do any serious coding with <b>PETSc</b>!
      </p>

      <ul>
        <li><b>PETSc users manual</b> - <a href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manual.pdf">pdf (fully searchable with hyperlinks)</a></li>
        <li><b>TAO users manual</b> - <a href="http://www.mcs.anl.gov/petsc/petsc-current/docs/tao_manual.pdf">pdf (fully searchable with hyperlinks)</a></li>
        <li><a href="manualpages/help.html">Index</a> of all help topics</li>
        <li><a href="manualpages/singleindex.html">Index</a> of all manual pages</li>
        <li><a href="manualpages/Sys/UsingFortran.html">Strategies</a> for using PETSc with Fortran</li>
      </ul>

      <p>
        <b>PETSc Manual Pages and Examples</b>
        &nbsp;&nbsp;<a href="http://www.mcs.anl.gov/mpi/www">MPI</a>
      </p>

      <ul>
        <li>
          <a href="manualpages/Vec/index.html">Vector Operations (Vec)</a>
          <ul>
            <li><a href="manualpages/PF/index.html">Defining your own mathematical functions (PF)</a></li>
          </ul>
        </li>

        <li>
          <a href="manualpages/Mat/index.html">Matrix Operations (Mat)</a>
          <ul>
            <li><a href="manualpages/MatOrderings/index.html">Matrix colorings (MatColoring), orderings (MatOrdering), and partitionings (MatPartitioning)</a></li>
            <li><a href="manualpages/MatFD/index.html">Finite difference computation of Jacobians (MatFD)</a></li>
          </ul>

          <br>
        </li>

        <li>
          Data and grid management
          <ul>
            <li><a href="manualpages/PetscSF/index.html">Star Forest Communication (PetscSF)</a></li>
            <li><a href="manualpages/IS/index.html">Index sets (IS)</a></li>
            <li><a href="manualpages/DM/index.html">Data Management (DM) between Vec and Mat, and the distributed mesh datastructures</a></li>
            <li><a href="manualpages/AO/index.html">Application Orderings (AO)</a></li>
          </ul>

          <br>
        </li>

        <li>
          <a href="manualpages/KSP/index.html">Linear Solvers (KSP)</a>
          <ul>
            <li><a href="linearsolvertable.html">Summary table of all linear solvers</a></li>
            <li><a href="manualpages/PC/index.html">Preconditioners (PC)</a></li>
            <li><a href="manualpages/KSP/index.html">Krylov Subspace Methods (KSP)</a></li>
          </ul>

          <br>
        </li>

        <li>
          <a href="manualpages/SNES/index.html">Nonlinear Solvers (SNES)</a>
          <ul>
            <li><a href="nonlinearsolvertable.html">Summary table of all nonlinear solvers</a></li>
            <li><a href="manualpages/SNES/MatCreateSNESMF.html">Matrix-free nonlinear solvers (MATMFFD)</a></li>
          </ul>

          <br>
        </li>

        <li><a href="manualpages/TS/index.html">Time Stepping (TS) ODE solvers</a></li>
        <br>
        <li>
          <a href="manualpages/Tao/index.html">Optimization Solvers (Tao)</a>
          <ul>
            <li><a href="manualpages/TaoLineSearch/index.html"> Optimization LineSearch Solver (TaoLineSearch)</a></li>
          </ul>
          <br>
        </li>
        <li>
          Utilities
          <ul>
            <li><a href="manualpages/Viewer/index.html">Viewing Objects</a></li>
            <li><a href="manualpages/Draw/index.html">Graphics (Draw)</a></li>
            <li><a href="manualpages/Sys/index.html">System Routines (Options, IO, utilities)</a></li>
            <li><a href="manualpages/Profiling/index.html">Profiling and Logging</a></li>
          </ul>
        </li>

      </ul>

      <p>
        The manual pages are split into four categories; we recommend that you begin
        with basic functionality and then gradually explore more sophisticated library
        features.
      </p>

      <ul>
        <li><em>Beginner</em> - Basic usage</li>
        <li><em>Intermediate</em> - Setting options for algorithms and data structures</li>
        <li><em>Advanced</em> - Setting more advanced options and customization</li>
        <li><em>Developer</em> - Interfaces intended primarily for library developers</li>
      </ul>

      <h3><a name="Supplementary">Supplementary Documentation</a></h3>
      <ul>
        <li><a href="installation.html">Installation</a> - detailed instructions for installing PETSc</li>
        <li><a href="changes/index.html">Changes</a> - changes and new features in recent versions of PETSc</li>
        <li><a href="bugreporting.html">Bug Reporting</a> - details on how to report bugs</li>
        <li><a href="codemanagement.html">Code Management</a> - hints for efficient management of large-scale application codes</li>
        <li><a href="faq.html">FAQ</a> - frequently asked questions about PETSc</li>
        <li><a href="license.html">License</a> - statement of the PETSc copyright</li>
	<li><a href="../README.Debian.gz">README.Debian</a> - a description of the PETSc Debian package</li>
      </ul>

    </div>

    
  </body>
</html>