File: petscao.h.html

package info (click to toggle)
petsc 3.23.1%2Bdfsg1-1exp1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 515,576 kB
  • sloc: ansic: 751,607; cpp: 51,542; python: 38,598; f90: 17,352; javascript: 3,493; makefile: 3,157; sh: 1,502; xml: 619; objc: 445; java: 13; csh: 1
file content (91 lines) | stat: -rw-r--r-- 14,295 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
<center><a href="https://gitlab.com/petsc/petsc/-/blob/966382dc56242773704ef5f5cee7aa2db3ebc577/include/petscao.h">Actual source code: petscao.h</a></center><br>

<html>
<head>
<title></title>
<meta name="generator" content="c2html 0.9.6">
<meta name="date" content="2025-04-30T18:14:50+00:00">
</head>

<body bgcolor="#FFFFFF">
<pre width=80>
<a name="line1">  1: </a><font color="#A020F0">#pragma once</font>

<a name="line3">  3: </a>#include <A href="../include/petscis.h.html">&lt;petscis.h&gt;</A>

<a name="line5">  5: </a><font color="#B22222">/* MANSEC = <a href="../manualpages/Vec/Vec.html">Vec</a> */</font>
<a name="line6">  6: </a><font color="#B22222">/* SUBMANSEC = <a href="../manualpages/AO/AO.html">AO</a> */</font>

<a name="line8">  8: </a><font color="#B22222">/*S</font>
<a name="line9">  9: </a><font color="#B22222">   <a href="../manualpages/AO/AO.html">AO</a> - Abstract PETSc object that manages mapping between different global numberings</font>

<a name="line11"> 11: </a><font color="#B22222">   Level: intermediate</font>

<a name="line13"> 13: </a><font color="#B22222">   Note:</font>
<a name="line14"> 14: </a><font color="#B22222">   An application ordering is usually a mapping between an application-centric</font>
<a name="line15"> 15: </a><font color="#B22222">   numbering (the ordering that is "natural" for the application) and</font>
<a name="line16"> 16: </a><font color="#B22222">   the parallel numbering ($0$ to $n_0-1$ on the first MPI process, $n_0$ to $n_1 - 1$ on the second MPI process, etc)</font>
<a name="line17"> 17: </a><font color="#B22222">   that PETSc uses.</font>

<a name="line19"> 19: </a><font color="#B22222">.seealso: `<a href="../manualpages/AO/AOCreateBasic.html">AOCreateBasic</a>()`, `<a href="../manualpages/AO/AOCreateBasicIS.html">AOCreateBasicIS</a>()`, `<a href="../manualpages/AO/AOPetscToApplication.html">AOPetscToApplication</a>()`, `<a href="../manualpages/AO/AOView.html">AOView</a>()`, `<a href="../manualpages/AO/AOApplicationToPetsc.html">AOApplicationToPetsc</a>()`, `<a href="../manualpages/AO/AOType.html">AOType</a>`, `<a href="../manualpages/AO/AOSetType.html">AOSetType</a>()`</font>
<a name="line20"> 20: </a><font color="#B22222">S*/</font>
<a name="line21"> 21: </a><font color="#4169E1">typedef struct _p_AO *<a href="../manualpages/AO/AO.html">AO</a>;</font>

<a name="line23"> 23: </a><font color="#B22222">/*J</font>
<a name="line24"> 24: </a><font color="#B22222">    <a href="../manualpages/AO/AOType.html">AOType</a> - String with the name of a PETSc application ordering type</font>

<a name="line26"> 26: </a><font color="#B22222">   Level: beginner</font>

<a name="line28"> 28: </a><font color="#B22222">.seealso: `<a href="../manualpages/AO/AOSetType.html">AOSetType</a>()`, `<a href="../manualpages/AO/AO.html">AO</a>`, `<a href="../manualpages/AO/AOApplicationToPetsc.html">AOApplicationToPetsc</a>()`, `<a href="../manualpages/AO/AOCreateBasic.html">AOCreateBasic</a>()`, `<a href="../manualpages/AO/AOCreate.html">AOCreate</a>()`</font>
<a name="line29"> 29: </a><font color="#B22222">J*/</font>
<a name="line30"> 30: </a><font color="#4169E1">typedef const char *<a href="../manualpages/AO/AOType.html">AOType</a>;</font>
<a name="line31"> 31: </a><strong><font color="#228B22">#define AOBASIC          </font><font color="#666666">"basic"</font><font color="#228B22"></font></strong>
<a name="line32"> 32: </a><strong><font color="#228B22">#define AOADVANCED       </font><font color="#666666">"advanced"</font><font color="#228B22"></font></strong>
<a name="line33"> 33: </a><strong><font color="#228B22">#define AOMAPPING        </font><font color="#666666">"mapping"</font><font color="#228B22"></font></strong>
<a name="line34"> 34: </a><strong><font color="#228B22">#define AOMEMORYSCALABLE </font><font color="#666666">"memoryscalable"</font><font color="#228B22"></font></strong>

<a name="line36"> 36: </a><font color="#B22222">/* Logging support */</font>
<a name="line37"> 37: </a>PETSC_EXTERN <a href="../manualpages/Sys/PetscClassId.html">PetscClassId</a> AO_CLASSID;

<a name="line39"> 39: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/AO/AOInitializePackage.html">AOInitializePackage</a>(void)</font></strong>;
<a name="line40"> 40: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/AO/AOFinalizePackage.html">AOFinalizePackage</a>(void)</font></strong>;

<a name="line42"> 42: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/AO/AOCreate.html">AOCreate</a>(<a href="../manualpages/Sys/MPI_Comm.html">MPI_Comm</a>, <a href="../manualpages/AO/AO.html">AO</a> *)</font></strong>;
<a name="line43"> 43: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/AO/AOSetIS.html">AOSetIS</a>(<a href="../manualpages/AO/AO.html">AO</a>, <a href="../manualpages/IS/IS.html">IS</a>, <a href="../manualpages/IS/IS.html">IS</a>)</font></strong>;
<a name="line44"> 44: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/AO/AOSetFromOptions.html">AOSetFromOptions</a>(<a href="../manualpages/AO/AO.html">AO</a>)</font></strong>;

<a name="line46"> 46: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/AO/AOCreateBasic.html">AOCreateBasic</a>(<a href="../manualpages/Sys/MPI_Comm.html">MPI_Comm</a>, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>, const <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>[], const <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>[], <a href="../manualpages/AO/AO.html">AO</a> *)</font></strong>;
<a name="line47"> 47: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/AO/AOCreateBasicIS.html">AOCreateBasicIS</a>(<a href="../manualpages/IS/IS.html">IS</a>, <a href="../manualpages/IS/IS.html">IS</a>, <a href="../manualpages/AO/AO.html">AO</a> *)</font></strong>;
<a name="line48"> 48: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/AO/AOCreateMemoryScalable.html">AOCreateMemoryScalable</a>(<a href="../manualpages/Sys/MPI_Comm.html">MPI_Comm</a>, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>, const <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>[], const <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>[], <a href="../manualpages/AO/AO.html">AO</a> *)</font></strong>;
<a name="line49"> 49: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/AO/AOCreateMemoryScalableIS.html">AOCreateMemoryScalableIS</a>(<a href="../manualpages/IS/IS.html">IS</a>, <a href="../manualpages/IS/IS.html">IS</a>, <a href="../manualpages/AO/AO.html">AO</a> *)</font></strong>;
<a name="line50"> 50: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/AO/AOCreateMapping.html">AOCreateMapping</a>(<a href="../manualpages/Sys/MPI_Comm.html">MPI_Comm</a>, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>, const <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>[], const <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>[], <a href="../manualpages/AO/AO.html">AO</a> *)</font></strong>;
<a name="line51"> 51: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/AO/AOCreateMappingIS.html">AOCreateMappingIS</a>(<a href="../manualpages/IS/IS.html">IS</a>, <a href="../manualpages/IS/IS.html">IS</a>, <a href="../manualpages/AO/AO.html">AO</a> *)</font></strong>;

<a name="line53"> 53: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/AO/AOView.html">AOView</a>(<a href="../manualpages/AO/AO.html">AO</a>, <a href="../manualpages/Viewer/PetscViewer.html">PetscViewer</a>)</font></strong>;
<a name="line54"> 54: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/AO/AOViewFromOptions.html">AOViewFromOptions</a>(<a href="../manualpages/AO/AO.html">AO</a>, <a href="../manualpages/Sys/PetscObject.html">PetscObject</a>, const char[])</font></strong>;
<a name="line55"> 55: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/AO/AODestroy.html">AODestroy</a>(<a href="../manualpages/AO/AO.html">AO</a> *)</font></strong>;

<a name="line57"> 57: </a><font color="#B22222">/* Dynamic creation and loading functions */</font>
<a name="line58"> 58: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/AO/AOSetType.html">AOSetType</a>(<a href="../manualpages/AO/AO.html">AO</a>, <a href="../manualpages/AO/AOType.html">AOType</a>)</font></strong>;
<a name="line59"> 59: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/AO/AOGetType.html">AOGetType</a>(<a href="../manualpages/AO/AO.html">AO</a>, <a href="../manualpages/AO/AOType.html">AOType</a> *)</font></strong>;

<a name="line61"> 61: </a><strong><font color="#4169E1"><a name="AORegister"></a>PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/AO/AORegister.html">AORegister</a>(const char[], <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> (*)(<a href="../manualpages/AO/AO.html">AO</a>)</font></strong>);
<a name="line62"> 62: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/AO/AORegisterAll.html">AORegisterAll</a>(void)</font></strong>;

<a name="line64"> 64: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/AO/AOPetscToApplication.html">AOPetscToApplication</a>(<a href="../manualpages/AO/AO.html">AO</a>, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>[])</font></strong>;
<a name="line65"> 65: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/AO/AOApplicationToPetsc.html">AOApplicationToPetsc</a>(<a href="../manualpages/AO/AO.html">AO</a>, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>[])</font></strong>;
<a name="line66"> 66: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/AO/AOPetscToApplicationIS.html">AOPetscToApplicationIS</a>(<a href="../manualpages/AO/AO.html">AO</a>, <a href="../manualpages/IS/IS.html">IS</a>)</font></strong>;
<a name="line67"> 67: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/AO/AOApplicationToPetscIS.html">AOApplicationToPetscIS</a>(<a href="../manualpages/AO/AO.html">AO</a>, <a href="../manualpages/IS/IS.html">IS</a>)</font></strong>;

<a name="line69"> 69: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/AO/AOPetscToApplicationPermuteInt.html">AOPetscToApplicationPermuteInt</a>(<a href="../manualpages/AO/AO.html">AO</a>, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>[])</font></strong>;
<a name="line70"> 70: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/AO/AOApplicationToPetscPermuteInt.html">AOApplicationToPetscPermuteInt</a>(<a href="../manualpages/AO/AO.html">AO</a>, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>[])</font></strong>;
<a name="line71"> 71: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/AO/AOPetscToApplicationPermuteReal.html">AOPetscToApplicationPermuteReal</a>(<a href="../manualpages/AO/AO.html">AO</a>, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>, <a href="../manualpages/Sys/PetscReal.html">PetscReal</a>[])</font></strong>;
<a name="line72"> 72: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/AO/AOApplicationToPetscPermuteReal.html">AOApplicationToPetscPermuteReal</a>(<a href="../manualpages/AO/AO.html">AO</a>, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>, <a href="../manualpages/Sys/PetscReal.html">PetscReal</a>[])</font></strong>;

<a name="line74"> 74: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/AO/AOMappingHasApplicationIndex.html">AOMappingHasApplicationIndex</a>(<a href="../manualpages/AO/AO.html">AO</a>, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
<a name="line75"> 75: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/AO/AOMappingHasPetscIndex.html">AOMappingHasPetscIndex</a>(<a href="../manualpages/AO/AO.html">AO</a>, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>, <a href="../manualpages/Sys/PetscBool.html">PetscBool</a> *)</font></strong>;
</pre>
</body>

</html>