| /petsc/src/binding/petsc4py/docs/source/ |
| H A D | documentation_standards.rst | 8 The documentation should be consistent with the corresponding C API
11 performance factors) should not be copied.
15 Docstrings are to be written in `numpydoc:format` format.
17 The first line of a class, function or method docstring must be a short
19 "Return" is to be preferred over "Get" in this sentence. A blank line must
23 collective, then this information must be repeated on the next line of the
30 should be referred to from here.
40 allowed by numpydoc may be included if they are useful.
45 This is required for methods unless there are no parameters, or it will be
49 their types must be explicitly documented within this section.
[all …]
|
| H A D | install.rst | 27 If you are cross-compiling, and the :mod:`numpy` module cannot be loaded on
29 :envvar:`NUMPY_INCLUDE` environment variable to the path that would be returned
37 When installing from source, the petsc4py complete testsuite can be run as::
46 Specific tests can be run using the command-line option ``-k``, e.g.::
56 If not otherwise specified, all tests will be run in sequential mode.
78 The resulting HTML files will be in :file:`_build/html`.
|
| H A D | petsc_options.rst | 6 A very powerful feature of PETSc is that objects can be configured via command-line options.
7 In this way, one can choose the method to be used or set different parameters without changing the …
27 When the above initialization method is not possible, PETSc options can be also specified via envir…
33 Command-line options can be read via an instance of the ``Options`` class. For instance:
48 …` will get the values ``50`` and ``8.8``, respectively, while ``eta`` will be assigned the value s…
|
| /petsc/doc/developers/ |
| H A D | style.md | 75 2. `PetscCount` is `ptrdiff_t`, (on 64-bit systems it is 64-bits) and should be used for array size…
76 and indices that may become large. `PetscIntCast()` should always be used when converting
79 when these arrays get too large then `--with-64-bit-indices` must be used to
83 It should **not** be used for the number of
84 entries in an array, or to index into an array, that should be `PetscCount`, or `PetscInt`.
85 Though `size_t` is unsigned and hence can have values larger than those that can be stored
86 …in a `PetscCount` those sizes will never be reached in practice so it is ok to cast with `(PetscCo…
111 sizeof(MPI_Count) may be strictly greater than sizeof(PetscInt64)
121 … in the entire repository with `make clangformat`. All merge requests must be properly formatted; …
123 …ang-format` there are still many decisions about code formatting that must be constantly made. A s…
[all …]
|
| H A D | articles.md | 4 an incomplete selection which may be of interest to developers.
6 You may also be interested in [publications using PETSc](https://petsc.org/release/miscellaneous/ap…
8 Higher-level views of PETSc can be found in {cite}`keyprefix-s2011`,
|
| /petsc/src/binding/petsc4py/conf/ |
| H A D | epydoc.cfg | 3 # The list of objects to document. Objects can be named using
8 # The type of output that should be generated. Should be one
12 # The path to the output directory. May be relative or absolute.
15 # An integer indicating how verbose epydoc should be. The default
35 # Whether or not parsing should be used to examine objects.
38 # Whether or not introspection should be used to examine objects.
55 # It should be one of: 'grouped', 'listed', 'included'.
59 # private variables will be hidden by default.)
82 # The CSS stylesheet for HTML output. Can be the name of a builtin
87 # unspecified, the project link will be generated based on the
[all …]
|
| /petsc/doc/manual/ |
| H A D | section.md | 12 structures that can be understood by the linear algebraic and solver components of PETSc (`Vec`, `M…
15 … `DMNetwork` mesh descriptions, much of its operation is general enough to be utilized for other t…
22 Specific entries (or collections of entries) in a `Vec` (or a simple array) can be associated with …
24 Other iterable set examples can be as simple as the points of a finite difference grid, or cells of…
27 So given the tuple for a mesh point, its data can be accessed by `array[offset + d]`, where `d` in …
31 The mesh points for a `PetscSection` must be contiguously numbered and are defined to be in some ra…
33 … must be contiguously numbered, the indexes into the array (defined by each `(ndof, offset)` tuple…
34 In other words, there may be elements in the array that are not associated with any mesh points, th…
40 If `ndof` is not set for a mesh point, it is assumed to be 0.
44 This concatenation can be done in a different order by setting a permutation, which is described in…
[all …]
|
| H A D | tao.md | 69 call-back routines will be used for evaluating the objective function,
86 `TaoSetType()` can be overridden at runtime by using an options
107 A TAO solver can be created by calling the
115 communicator indicates a collection of processors that will be used to
118 communicator `PETSC_COMM_SELF` can be used with no understanding of
119 MPI. Even parallel users need to be familiar with only the basic
131 can be used to set the algorithm TAO uses to solve the application. The
132 various types of TAO solvers and the flags that identify them will be
133 discussed in the following sections. The solution method should be
137 accordingly. The user must also be aware of the derivative information
[all …]
|
| H A D | mat.md | 9 specialized formats can be easily added.
32 The type of matrix created can be controlled with either
44 and the options database option `-dm_mat_type <aij or baij or aijcusparse etc>` Matrices can be cre…
88 respectively, indicate the global row and column numbers to be inserted.
92 the values that are to be inserted. By default the values are given in
94 meaning that the value to be put in row `idxm[i]` and column
105 This notation should not be a mystery to anyone. For example, to insert
120 they must be processed (also called “assembled”) before they can be
130 with the `INSERT_VALUES` and `ADD_VALUES` options *cannot* be mixed
133 be `MAT_FLUSH_ASSEMBLY`, which omits some of the work of the full
[all …]
|
| H A D | snes.md | 52 Other defect-correction algorithms can be implemented by using different
62 can be approximated with finite differences. For codes that are
117 where `x` should be initialized to the initial guess before calling and contains the solution on re…
141 evaluation routine; `NULL` should be used if such information is not
143 which various objects can be stashed; in Fortran a user context can be
174 formats (including “matrix-free” methods) can be used.
192 `-snes_mf_operator` may be used to obtain the exact solution, where
209 would be linearized as
218 Picard iterative procedure can be performed by defining $\mathbf{J}(\mathbf{x})$
219 to be $\mathbf{A}(\mathbf{x})$. Sometimes this iteration exhibits better global
[all …]
|
| H A D | other.md | 33 that can be explicitly called from within a program to set compile-time
95 spaces either, and tab characters cannot be used between the option
116 Comments can be placed in the `.petscrc` file by using `#` in the
121 Options prefixes allow specific objects to be controlled from the
133 which can also be used from the command line, e.g. `-options_file my_options.opts`.
201 Usually `pre` should be set to `NULL` (or `PETSC_NULL_CHARACTER`
205 methods used on the individual blocks can be controlled via the options
221 `PetscOptionsMonitorSet()` can be used to provide custom monitors.
238 - Passing in a zero (`0`) for the viewer causes the object to be
240 debugger but should be avoided in source code.
[all …]
|
| H A D | ksp.md | 18 techniques and their associated options can be selected at runtime.
20 `KSP` can also be used to solve least squares problems, using, for example, `KSPLSQR`. See
57 the matrix from which the preconditioner is to be constructed, `Pmat`,
63 Much of the power of `KSP` can be accessed through the single routine
80 process stopped can be obtained using
91 regarding convergence testing. Note that multiple linear solves can be
93 longer needed, it should be destroyed with the command
139 `PCFactorSetUseInPlace()`, discussed below, causes factorization to be
150 for ILU) will be done during the first call to `KSPSolve()` only; such
151 operations will *not* be repeated for successive solves.
[all …]
|
| /petsc/doc/changes/ |
| H A D | 33.md | 17 - VecSetBlockSize() cannot be called after VecCreateSeq() or
18 VecCreateMPI() and must be called before VecSetUp() or
36 - MatSetBlockSize() must be called before MatSetUp() or
79 argument to indicate whether local subdomains should be
89 preconditioner so it can be used with normal Krylov methods rather
116 - Changed options and command-line arguments for SNESFAS to be in
124 - SNES line search type should be set by name with
132 - The default SNESLineSearch of a SNES may be gotten with
134 - The linesearch type may be set with SNESLineSearchSetType() or
138 - Pre/Post-check methods may be set with
[all …]
|
| H A D | 2016.md | 24 Similarly, multiple monitors can be used from the options database
37 Similarly, multiple monitors can be used from the options database
51 which causes all entries on any processor destined to be stored on
52 a different processor to be dropped instead. This is useful if you
74 which causes all entries on any processor destined to be stored on
75 a different processor to be dropped instead. This is useful if you
101 useful during code development. This can often be a substitute for
105 options in the specified file to be treated as if they were typed
110 debugger. Can be used in conjunction with the -log_info option.
112 interval over which random numbers will be uniformly distributed.
|
| /petsc/doc/manualpages/doctext/ |
| H A D | doctextcommon.txt | 37 the contents of any externally held references to internal data structures should be
38 considered to be in an undefined state. A well-defined state can only be restored by
45 of the top-most pointer is guaranteed to always be valid. For example, given a routine
47 of said pointer is immediately valid but dereferencing the pointer may not be.
50 may not be).
|
| /petsc/src/sys/tests/linter/output/ |
| H A D | testDuplicates.patch | 20 /* ~should~ be removed but won't be */
24 /* ~should~ be removed but won't be */
30 /* ~should~ be removed but won't be */
|
| /petsc/doc/community/ |
| H A D | governance.md | 7 or other work to PETSc. Anyone can be a contributor. The PETSc **community** consists of the contri…
13 …ge can contribute their knowledge in the confidence that their voices will be heard, because thoug…
15 on decisions; they need not be a contributor.
17 The mechanism we use to accomplish this goal may be unfamiliar for those who are not experienced wi…
36 and best efforts (e.g., all substantive API changes must be posted to the mailing list in order to …
38 PETSc should be on the mailing list). If no-one bothers to comment on the mailing list
44 When a decision cannot be made by community consensus, community members may request a formal vote …
47 - Vote on decisions that cannot be made by consensus; with a simple majority vote of all council me…
48 - Vote on changes to the NumFOCUS signatories which will be conducted by the council using the Schu…
50 …be on the PETSc Council, one need not be a contributor. The initial council consisted of the 15 mo…
[all …]
|
| /petsc/src/ts/tutorials/output/ |
| H A D | ex45_2d_p1.out | 3 Function appears to be linear
6 Function appears to be linear
|
| H A D | ex45_2d_q1.out | 3 Function appears to be linear
6 Function appears to be linear
|
| H A D | ex45_3d_p1.out | 3 Function appears to be linear
6 Function appears to be linear
|
| H A D | ex45_3d_q1.out | 3 Function appears to be linear
6 Function appears to be linear
|
| H A D | ex45_3d_q2.out | 3 Function appears to be linear
6 Function appears to be linear
|
| H A D | ex53_3d_cryer.out | 3 Function appears to be linear
6 Function appears to be linear
|
| H A D | ex45_2d_q2.out | 3 Function appears to be linear
6 Function appears to be linear
|
| H A D | ex45_3d_p2.out | 3 Function appears to be linear
6 Function appears to be linear
|