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
|
<center><a href="https://gitlab.com/petsc/petsc/-/blob/966382dc56242773704ef5f5cee7aa2db3ebc577/include/petscpf.h">Actual source code: petscpf.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="#B22222">/*</font>
<a name="line2"> 2: </a><font color="#B22222"> mathematical function module.</font>
<a name="line3"> 3: </a><font color="#B22222">*/</font>
<a name="line4"> 4: </a><font color="#A020F0">#pragma once</font>
<a name="line6"> 6: </a>#include <A href="../include/petscvec.h.html"><petscvec.h></A>
<a name="line8"> 8: </a><font color="#B22222">/* MANSEC = <a href="../manualpages/Vec/Vec.html">Vec</a> */</font>
<a name="line9"> 9: </a><font color="#B22222">/* SUBMANSEC = <a href="../manualpages/PF/PF.html">PF</a> */</font>
<a name="line11"> 11: </a><font color="#B22222">/*</font>
<a name="line12"> 12: </a><font color="#B22222"> PFList contains the list of mathematical functions currently registered</font>
<a name="line13"> 13: </a><font color="#B22222"> These are added with <a href="../manualpages/PF/PFRegister.html">PFRegister</a>()</font>
<a name="line14"> 14: </a><font color="#B22222">*/</font>
<a name="line15"> 15: </a>PETSC_EXTERN <a href="../manualpages/Sys/PetscFunctionList.html">PetscFunctionList</a> PFList;
<a name="line17"> 17: </a><font color="#B22222">/*J</font>
<a name="line18"> 18: </a><font color="#B22222"> <a href="../manualpages/PF/PFType.html">PFType</a> - Type of PETSc mathematical function, a string name</font>
<a name="line20"> 20: </a><font color="#B22222"> Level: beginner</font>
<a name="line22"> 22: </a><font color="#B22222">.seealso: `<a href="../manualpages/PF/PFSetType.html">PFSetType</a>()`, `<a href="../manualpages/PF/PF.html">PF</a>`</font>
<a name="line23"> 23: </a><font color="#B22222">J*/</font>
<a name="line24"> 24: </a><font color="#4169E1">typedef const char *<a href="../manualpages/PF/PFType.html">PFType</a>;</font>
<a name="line25"> 25: </a><strong><font color="#228B22">#define PFCONSTANT </font><font color="#666666">"constant"</font><font color="#228B22"></font></strong>
<a name="line26"> 26: </a><strong><font color="#228B22">#define PFMAT </font><font color="#666666">"mat"</font><font color="#228B22"></font></strong>
<a name="line27"> 27: </a><strong><font color="#228B22">#define PFSTRING </font><font color="#666666">"string"</font><font color="#228B22"></font></strong>
<a name="line28"> 28: </a><strong><font color="#228B22">#define PFQUICK </font><font color="#666666">"quick"</font><font color="#228B22"></font></strong>
<a name="line29"> 29: </a><strong><font color="#228B22">#define PFIDENTITY </font><font color="#666666">"identity"</font><font color="#228B22"></font></strong>
<a name="line30"> 30: </a><strong><font color="#228B22">#define PFMATLAB </font><font color="#666666">"matlab"</font><font color="#228B22"></font></strong>
<a name="line32"> 32: </a><font color="#B22222">/*S</font>
<a name="line33"> 33: </a><font color="#B22222"> <a href="../manualpages/PF/PF.html">PF</a> - Abstract PETSc mathematical function that can be evaluated with `<a href="../manualpages/PF/PFApply.html">PFApply</a>()` and may be constructed at run time (see `PFSTRING`)</font>
<a name="line35"> 35: </a><font color="#B22222"> Level: beginner</font>
<a name="line37"> 37: </a><font color="#B22222">.seealso: `<a href="../manualpages/PF/PFCreate.html">PFCreate</a>()`, `<a href="../manualpages/PF/PFDestroy.html">PFDestroy</a>()`, `<a href="../manualpages/PF/PFSetType.html">PFSetType</a>()`, `<a href="../manualpages/PF/PFApply.html">PFApply</a>()`, `<a href="../manualpages/PF/PFApplyVec.html">PFApplyVec</a>()`, `<a href="../manualpages/PF/PFSet.html">PFSet</a>()`, `<a href="../manualpages/PF/PFType.html">PFType</a>`</font>
<a name="line38"> 38: </a><font color="#B22222">S*/</font>
<a name="line39"> 39: </a><font color="#4169E1">typedef struct _p_PF *<a href="../manualpages/PF/PF.html">PF</a>;</font>
<a name="line41"> 41: </a>PETSC_EXTERN <a href="../manualpages/Sys/PetscClassId.html">PetscClassId</a> PF_CLASSID;
<a name="line43"> 43: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/PF/PFCreate.html">PFCreate</a>(<a href="../manualpages/Sys/MPI_Comm.html">MPI_Comm</a>, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>, <a href="../manualpages/PF/PF.html">PF</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/PF/PFSetType.html">PFSetType</a>(<a href="../manualpages/PF/PF.html">PF</a>, <a href="../manualpages/PF/PFType.html">PFType</a>, void *)</font></strong>;
<a name="line45"> 45: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/PF/PFSet.html">PFSet</a>(<a href="../manualpages/PF/PF.html">PF</a>, <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> (*)(void *, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>, const <a href="../manualpages/Sys/PetscScalar.html">PetscScalar</a> *, <a href="../manualpages/Sys/PetscScalar.html">PetscScalar</a> *), <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> (*)(void *, <a href="../manualpages/Vec/Vec.html">Vec</a>, <a href="../manualpages/Vec/Vec.html">Vec</a>), <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> (*)(void *, <a href="../manualpages/Viewer/PetscViewer.html">PetscViewer</a>), <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> (*)(void *), void *)</font></strong>;
<a name="line46"> 46: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/PF/PFApply.html">PFApply</a>(<a href="../manualpages/PF/PF.html">PF</a>, <a href="../manualpages/Sys/PetscInt.html">PetscInt</a>, const <a href="../manualpages/Sys/PetscScalar.html">PetscScalar</a> *, <a href="../manualpages/Sys/PetscScalar.html">PetscScalar</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/PF/PFApplyVec.html">PFApplyVec</a>(<a href="../manualpages/PF/PF.html">PF</a>, <a href="../manualpages/Vec/Vec.html">Vec</a>, <a href="../manualpages/Vec/Vec.html">Vec</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/PF/PFStringSetFunction.html">PFStringSetFunction</a>(<a href="../manualpages/PF/PF.html">PF</a>, const char *)</font></strong>;
<a name="line51"> 51: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/PF/PFInitializePackage.html">PFInitializePackage</a>(void)</font></strong>;
<a name="line52"> 52: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/PF/PFFinalizePackage.html">PFFinalizePackage</a>(void)</font></strong>;
<a name="line54"> 54: </a><strong><font color="#4169E1"><a name="PFRegister"></a>PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/PF/PFRegister.html">PFRegister</a>(const char[], <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> (*)(<a href="../manualpages/PF/PF.html">PF</a>, void *)</font></strong>);
<a name="line56"> 56: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/PF/PFDestroy.html">PFDestroy</a>(<a href="../manualpages/PF/PF.html">PF</a> *)</font></strong>;
<a name="line57"> 57: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/PF/PFSetFromOptions.html">PFSetFromOptions</a>(<a href="../manualpages/PF/PF.html">PF</a>)</font></strong>;
<a name="line58"> 58: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/PF/PFGetType.html">PFGetType</a>(<a href="../manualpages/PF/PF.html">PF</a>, <a href="../manualpages/PF/PFType.html">PFType</a> *)</font></strong>;
<a name="line60"> 60: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/PF/PFView.html">PFView</a>(<a href="../manualpages/PF/PF.html">PF</a>, <a href="../manualpages/Viewer/PetscViewer.html">PetscViewer</a>)</font></strong>;
<a name="line61"> 61: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/PF/PFViewFromOptions.html">PFViewFromOptions</a>(<a href="../manualpages/PF/PF.html">PF</a>, <a href="../manualpages/Sys/PetscObject.html">PetscObject</a>, const char[])</font></strong>;
<a name="line63"> 63: </a><strong><font color="#228B22">#define PFSetOptionsPrefix(a, s) <a href="../manualpages/Sys/PetscObjectSetOptionsPrefix.html">PetscObjectSetOptionsPrefix</a>((<a href="../manualpages/Sys/PetscObject.html">PetscObject</a>)(a), s)</font></strong>
</pre>
</body>
</html>
|
