File: petscbag.h.html

package info (click to toggle)
petsc 3.18.5%2Bdfsg1-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 523,616 kB
  • sloc: ansic: 740,865; cpp: 41,511; python: 36,523; f90: 16,706; makefile: 12,524; javascript: 11,855; sh: 1,007; xml: 619; objc: 445; java: 13; csh: 1
file content (84 lines) | stat: -rw-r--r-- 13,849 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
 
<center><a href="https://gitlab.com/petsc/petsc/-/blob/01a2522431ef63feaceabbc11dd32b16a352f77d/include/petscbag.h">Actual source code: petscbag.h</a></center><br>

<html>
<head>
<title></title>
<meta name="generator" content="c2html 0.9.4">
<meta name="date" content="2023-02-27T22:24:48+00:00">
</head>

<body bgcolor="#FFFFFF">
<pre width="80">

<a name="line2">  2: </a><font color="#A020F0">#ifndef PETSCBAG_H</font>
<a name="line3">  3: </a><strong><font color="#228B22">#define PETSCBAG_H</font></strong>

<a name="line5">  5: </a>#include <A href="petscsys.h.html">&lt;petscsys.h&gt;</A>

<a name="line7">  7: </a><font color="#B22222">/* SUBMANSEC = Sys */</font>

<a name="line9">  9: </a><font color="#B22222">/*S</font>
<a name="line10"> 10: </a><font color="#B22222">     <a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a> - PETSc object that manages a collection of user data including parameters.</font>
<a name="line11"> 11: </a><font color="#B22222">           A bag is essentially a C struct with serialization (you can save it and load it from files).</font>

<a name="line13"> 13: </a><font color="#B22222">   Level: beginner</font>

<a name="line15"> 15: </a><font color="#B22222">    Sample Usage:</font>
<a name="line16"> 16: </a><font color="#B22222">.vb</font>
<a name="line17"> 17: </a><font color="#B22222">      typedef struct {</font>
<a name="line18"> 18: </a><font color="#B22222">         <a href="../docs/manualpages/Sys/PetscInt.html">PetscInt</a>     height;</font>
<a name="line19"> 19: </a><font color="#B22222">         <a href="../docs/manualpages/Sys/PetscScalar.html">PetscScalar</a>  root;</font>
<a name="line20"> 20: </a><font color="#B22222">         <a href="../docs/manualpages/Sys/PetscReal.html">PetscReal</a>    byebye;</font>
<a name="line21"> 21: </a><font color="#B22222">      } MyParameters;</font>

<a name="line23"> 23: </a><font color="#B22222">      <a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a>     bag;</font>
<a name="line24"> 24: </a><font color="#B22222">      MyParameters *params;</font>

<a name="line26"> 26: </a><font color="#B22222">      <a href="../docs/manualpages/Sys/PetscBagCreate.html">PetscBagCreate</a>(<a href="../docs/manualpages/Sys/PETSC_COMM_WORLD.html">PETSC_COMM_WORLD</a>,sizeof(MyParameters),&amp;bag);</font>
<a name="line27"> 27: </a><font color="#B22222">      <a href="../docs/manualpages/Sys/PetscBagGetData.html">PetscBagGetData</a>(bag,(void **)&amp;params);</font>
<a name="line28"> 28: </a><font color="#B22222">      <a href="../docs/manualpages/Sys/PetscBagSetName.html">PetscBagSetName</a>(bag,"MyParameters");</font>
<a name="line29"> 29: </a><font color="#B22222">      <a href="../docs/manualpages/Sys/PetscBagRegisterInt.html">PetscBagRegisterInt</a>(bag,&amp;params.height,22,"height","Height of the water tower");</font>
<a name="line30"> 30: </a><font color="#B22222">.ve</font>

<a name="line32"> 32: </a><font color="#B22222">.seealso: `<a href="../docs/manualpages/Sys/PetscBagSetName.html">PetscBagSetName</a>()`, `<a href="../docs/manualpages/Sys/PetscBagGetName.html">PetscBagGetName</a>()`, `<a href="../docs/manualpages/Sys/PetscBagView.html">PetscBagView</a>()`, `<a href="../docs/manualpages/Sys/PetscBagLoad.html">PetscBagLoad</a>()`, `<a href="../docs/manualpages/Sys/PetscBagGetData.html">PetscBagGetData</a>()`</font>
<a name="line33"> 33: </a><font color="#B22222">          `<a href="../docs/manualpages/Sys/PetscBagRegisterReal.html">PetscBagRegisterReal</a>()`, `<a href="../docs/manualpages/Sys/PetscBagRegisterInt.html">PetscBagRegisterInt</a>()`, `<a href="../docs/manualpages/Sys/PetscBagRegisterBool.html">PetscBagRegisterBool</a>()`, `<a href="../docs/manualpages/Sys/PetscBagRegisterScalar.html">PetscBagRegisterScalar</a>()`</font>
<a name="line34"> 34: </a><font color="#B22222">          `<a href="../docs/manualpages/Sys/PetscBagSetFromOptions.html">PetscBagSetFromOptions</a>()`, `PetscBagRegisterVec()`, `<a href="../docs/manualpages/Sys/PetscBagCreate.html">PetscBagCreate</a>()`, `<a href="../docs/manualpages/Sys/PetscBagDestroy.html">PetscBagDestroy</a>()`, `<a href="../docs/manualpages/Sys/PetscBagRegisterEnum.html">PetscBagRegisterEnum</a>()`</font>
<a name="line35"> 35: </a><font color="#B22222">S*/</font>
<a name="line36"> 36: </a><font color="#4169E1">typedef struct _n_PetscBag     *<a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a>;</font>
<a name="line37"> 37: </a><font color="#4169E1">typedef struct _n_PetscBagItem *PetscBagItem;</font>

<a name="line39"> 39: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../docs/manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../docs/manualpages/Sys/PetscBagCreate.html">PetscBagCreate</a>(<a href="../docs/manualpages/Sys/MPI_Comm.html">MPI_Comm</a>, size_t, <a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a> *)</font></strong>;
<a name="line40"> 40: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../docs/manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../docs/manualpages/Sys/PetscBagDestroy.html">PetscBagDestroy</a>(<a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a> *)</font></strong>;
<a name="line41"> 41: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../docs/manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../docs/manualpages/Sys/PetscBagGetData.html">PetscBagGetData</a>(<a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a>, void **)</font></strong>;
<a name="line42"> 42: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../docs/manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../docs/manualpages/Sys/PetscBagRegisterReal.html">PetscBagRegisterReal</a>(<a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a>, void *, <a href="../docs/manualpages/Sys/PetscReal.html">PetscReal</a>, const char *, const char *)</font></strong>;
<a name="line43"> 43: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../docs/manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../docs/manualpages/Sys/PetscBagRegisterRealArray.html">PetscBagRegisterRealArray</a>(<a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a>, void *, <a href="../docs/manualpages/Sys/PetscInt.html">PetscInt</a>, const char *, const char *)</font></strong>;
<a name="line44"> 44: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../docs/manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../docs/manualpages/Sys/PetscBagRegisterString.html">PetscBagRegisterString</a>(<a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a>, void *, <a href="../docs/manualpages/Sys/PetscInt.html">PetscInt</a>, const char *, const char *, const char *)</font></strong>;
<a name="line45"> 45: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../docs/manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../docs/manualpages/Sys/PetscBagRegisterScalar.html">PetscBagRegisterScalar</a>(<a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a>, void *, <a href="../docs/manualpages/Sys/PetscScalar.html">PetscScalar</a>, const char *, const char *)</font></strong>;
<a name="line46"> 46: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../docs/manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../docs/manualpages/Sys/PetscBagRegisterInt.html">PetscBagRegisterInt</a>(<a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a>, void *, <a href="../docs/manualpages/Sys/PetscInt.html">PetscInt</a>, const char *, const char *)</font></strong>;
<a name="line47"> 47: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../docs/manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../docs/manualpages/Sys/PetscBagRegisterInt64.html">PetscBagRegisterInt64</a>(<a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a>, void *, PetscInt64, const char *, const char *)</font></strong>;
<a name="line48"> 48: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../docs/manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../docs/manualpages/Sys/PetscBagRegisterIntArray.html">PetscBagRegisterIntArray</a>(<a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a>, void *, <a href="../docs/manualpages/Sys/PetscInt.html">PetscInt</a>, const char *, const char *)</font></strong>;
<a name="line49"> 49: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../docs/manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../docs/manualpages/Sys/PetscBagRegisterEnum.html">PetscBagRegisterEnum</a>(<a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a>, void *, const char *const *, <a href="../docs/manualpages/Sys/PetscEnum.html">PetscEnum</a>, const char *, const char *)</font></strong>;
<a name="line50"> 50: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../docs/manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../docs/manualpages/Sys/PetscBagRegisterBool.html">PetscBagRegisterBool</a>(<a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a>, void *, <a href="../docs/manualpages/Sys/PetscBool.html">PetscBool</a>, const char *, const char *)</font></strong>;
<a name="line51"> 51: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../docs/manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../docs/manualpages/Sys/PetscBagRegisterBoolArray.html">PetscBagRegisterBoolArray</a>(<a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a>, void *, <a href="../docs/manualpages/Sys/PetscInt.html">PetscInt</a>, const char *, const char *)</font></strong>;
<a name="line52"> 52: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../docs/manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../docs/manualpages/Sys/PetscBagGetNames.html">PetscBagGetNames</a>(<a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a>, const char *[])</font></strong>;

<a name="line54"> 54: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../docs/manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../docs/manualpages/Sys/PetscBagSetFromOptions.html">PetscBagSetFromOptions</a>(<a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a>)</font></strong>;
<a name="line55"> 55: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../docs/manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../docs/manualpages/Sys/PetscBagGetName.html">PetscBagGetName</a>(<a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a>, char **)</font></strong>;
<a name="line56"> 56: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../docs/manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../docs/manualpages/Sys/PetscBagSetName.html">PetscBagSetName</a>(<a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a>, const char *, const char *)</font></strong>;
<a name="line57"> 57: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../docs/manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../docs/manualpages/Sys/PetscBagSetOptionsPrefix.html">PetscBagSetOptionsPrefix</a>(<a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a>, const char *)</font></strong>;

<a name="line59"> 59: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../docs/manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../docs/manualpages/Sys/PetscBagView.html">PetscBagView</a>(<a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a>, <a href="../docs/manualpages/Viewer/PetscViewer.html">PetscViewer</a>)</font></strong>;
<a name="line60"> 60: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../docs/manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../docs/manualpages/Sys/PetscBagLoad.html">PetscBagLoad</a>(<a href="../docs/manualpages/Viewer/PetscViewer.html">PetscViewer</a>, <a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a>)</font></strong>;
<a name="line61"> 61: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../docs/manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../docs/manualpages/Sys/PetscBagViewFromOptions.html">PetscBagViewFromOptions</a>(<a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a>, <a href="../docs/manualpages/Sys/PetscObject.html">PetscObject</a>, const char[])</font></strong>;

<a name="line63"> 63: </a><strong><font color="#4169E1"><a name="PetscBagSetViewer"></a>PETSC_EXTERN <a href="../docs/manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscBagSetViewer(<a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a>, <a href="../docs/manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> (*)(<a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a>, <a href="../docs/manualpages/Viewer/PetscViewer.html">PetscViewer</a>)</font></strong>);
<a name="line64"> 64: </a><strong><font color="#4169E1"><a name="PetscBagSetLoader"></a>PETSC_EXTERN <a href="../docs/manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscBagSetLoader(<a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a>, <a href="../docs/manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> (*)(<a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a>, <a href="../docs/manualpages/Viewer/PetscViewer.html">PetscViewer</a>)</font></strong>);
<a name="line65"> 65: </a><strong><font color="#4169E1"><a name="PetscBagSetDestroy"></a>PETSC_EXTERN <a href="../docs/manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> PetscBagSetDestroy(<a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a>, <a href="../docs/manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> (*)(<a href="../docs/manualpages/Sys/PetscBag.html">PetscBag</a>)</font></strong>);

<a name="line67"> 67: </a><strong><font color="#228B22">#define PETSC_BAG_FILE_CLASSID 1211219</font></strong>

<a name="line69"> 69: </a><font color="#A020F0">#endif</font>
</pre>
</body>

</html>