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
|
<center><a href="https://gitlab.com/petsc/petsc/-/blob/9fe822445bcdd45fb93170ff68fa7403d3f52f09/include/petscmatlab.h">Actual source code: petscmatlab.h</a></center><br>
<html>
<head>
<title></title>
<meta name="generator" content="c2html 0.9.6">
<meta name="date" content="2025-03-28T21:10:41+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"> Defines an interface to the MATLAB Engine from PETSc</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><font color="#B22222">/* SUBMANSEC = Sys */</font>
<a name="line8"> 8: </a>PETSC_EXTERN <a href="../manualpages/Sys/PetscClassId.html">PetscClassId</a> MATLABENGINE_CLASSID;
<a name="line10"> 10: </a><font color="#B22222">/*S</font>
<a name="line11"> 11: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscMatlabEngine.html">PetscMatlabEngine</a> - Object used to communicate with MATLAB</font>
<a name="line13"> 13: </a><font color="#B22222"> Level: intermediate</font>
<a name="line15"> 15: </a><font color="#B22222"> Notes:</font>
<a name="line16"> 16: </a><font color="#B22222"> `<a href="../manualpages/Mat/Mat.html">Mat</a>`s transferred between PETSc and MATLAB and vis versa are transposed in the other space</font>
<a name="line17"> 17: </a><font color="#B22222"> (this is because MATLAB uses compressed column format and PETSc uses compressed row format)</font>
<a name="line19"> 19: </a><font color="#B22222"> One must `./configure` PETSc with `--with-matlab [-with-matlab-dir=matlab_root_directory]` to</font>
<a name="line20"> 20: </a><font color="#B22222"> use this capability</font>
<a name="line22"> 22: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscMatlabEngineCreate.html">PetscMatlabEngineCreate</a>()`, `<a href="../manualpages/Sys/PetscMatlabEngineDestroy.html">PetscMatlabEngineDestroy</a>()`, `<a href="../manualpages/Sys/PetscMatlabEngineEvaluate.html">PetscMatlabEngineEvaluate</a>()`,</font>
<a name="line23"> 23: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscMatlabEngineGetOutput.html">PetscMatlabEngineGetOutput</a>()`, `<a href="../manualpages/Sys/PetscMatlabEnginePut.html">PetscMatlabEnginePut</a>()`, `<a href="../manualpages/Sys/PetscMatlabEngineGet.html">PetscMatlabEngineGet</a>()`,</font>
<a name="line24"> 24: </a><font color="#B22222"> `<a href="../manualpages/Sys/PetscMatlabEnginePrintOutput.html">PetscMatlabEnginePrintOutput</a>()`, `<a href="../manualpages/Sys/PetscMatlabEnginePutArray.html">PetscMatlabEnginePutArray</a>()`, `<a href="../manualpages/Sys/PetscMatlabEngineGetArray.html">PetscMatlabEngineGetArray</a>()`,</font>
<a name="line25"> 25: </a><font color="#B22222"> `<a href="../manualpages/Sys/PETSC_MATLAB_ENGINE_.html">PETSC_MATLAB_ENGINE_</a>()`, `<a href="../manualpages/Sys/PETSC_MATLAB_ENGINE_SELF.html">PETSC_MATLAB_ENGINE_SELF</a>`, `<a href="../manualpages/Sys/PETSC_MATLAB_ENGINE_WORLD.html">PETSC_MATLAB_ENGINE_WORLD</a>`</font>
<a name="line26"> 26: </a><font color="#B22222">S*/</font>
<a name="line27"> 27: </a><font color="#4169E1">typedef struct _p_PetscMatlabEngine *<a href="../manualpages/Sys/PetscMatlabEngine.html">PetscMatlabEngine</a>;</font>
<a name="line29"> 29: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscMatlabEngineCreate.html">PetscMatlabEngineCreate</a>(<a href="../manualpages/Sys/MPI_Comm.html">MPI_Comm</a>, const char[], <a href="../manualpages/Sys/PetscMatlabEngine.html">PetscMatlabEngine</a> *)</font></strong>;
<a name="line30"> 30: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscMatlabEngineDestroy.html">PetscMatlabEngineDestroy</a>(<a href="../manualpages/Sys/PetscMatlabEngine.html">PetscMatlabEngine</a> *)</font></strong>;
<a name="line31"> 31: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscMatlabEngineEvaluate.html">PetscMatlabEngineEvaluate</a>(<a href="../manualpages/Sys/PetscMatlabEngine.html">PetscMatlabEngine</a>, const char[], ...)</font></strong>;
<a name="line32"> 32: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscMatlabEngineGetOutput.html">PetscMatlabEngineGetOutput</a>(<a href="../manualpages/Sys/PetscMatlabEngine.html">PetscMatlabEngine</a>, const char **)</font></strong>;
<a name="line33"> 33: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscMatlabEnginePrintOutput.html">PetscMatlabEnginePrintOutput</a>(<a href="../manualpages/Sys/PetscMatlabEngine.html">PetscMatlabEngine</a>, FILE *)</font></strong>;
<a name="line34"> 34: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscMatlabEnginePut.html">PetscMatlabEnginePut</a>(<a href="../manualpages/Sys/PetscMatlabEngine.html">PetscMatlabEngine</a>, <a href="../manualpages/Sys/PetscObject.html">PetscObject</a>)</font></strong>;
<a name="line35"> 35: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscMatlabEngineGet.html">PetscMatlabEngineGet</a>(<a href="../manualpages/Sys/PetscMatlabEngine.html">PetscMatlabEngine</a>, <a href="../manualpages/Sys/PetscObject.html">PetscObject</a>)</font></strong>;
<a name="line36"> 36: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscMatlabEnginePutArray.html">PetscMatlabEnginePutArray</a>(<a href="../manualpages/Sys/PetscMatlabEngine.html">PetscMatlabEngine</a>, int, int, const <a href="../manualpages/Sys/PetscScalar.html">PetscScalar</a> *, const char[])</font></strong>;
<a name="line37"> 37: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscMatlabEngineGetArray.html">PetscMatlabEngineGetArray</a>(<a href="../manualpages/Sys/PetscMatlabEngine.html">PetscMatlabEngine</a>, int, int, <a href="../manualpages/Sys/PetscScalar.html">PetscScalar</a> *, const char[])</font></strong>;
<a name="line39"> 39: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscMatlabEngine.html">PetscMatlabEngine</a> <a href="../manualpages/Sys/PETSC_MATLAB_ENGINE_.html">PETSC_MATLAB_ENGINE_</a>(<a href="../manualpages/Sys/MPI_Comm.html">MPI_Comm</a>)</font></strong>;
<a name="line41"> 41: </a><font color="#B22222">/*MC</font>
<a name="line42"> 42: </a><font color="#B22222"> <a href="../manualpages/Sys/PETSC_MATLAB_ENGINE_WORLD.html">PETSC_MATLAB_ENGINE_WORLD</a> - same as <a href="../manualpages/Sys/PETSC_MATLAB_ENGINE_.html">PETSC_MATLAB_ENGINE_</a>(<a href="../manualpages/Sys/PETSC_COMM_WORLD.html">PETSC_COMM_WORLD</a>)</font>
<a name="line44"> 44: </a><font color="#B22222"> Level: intermediate</font>
<a name="line46"> 46: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscMatlabEngine.html">PetscMatlabEngine</a>`, `<a href="../manualpages/Sys/PETSC_MATLAB_ENGINE_.html">PETSC_MATLAB_ENGINE_</a>()`, `<a href="../manualpages/Sys/PETSC_MATLAB_ENGINE_SELF.html">PETSC_MATLAB_ENGINE_SELF</a>`</font>
<a name="line47"> 47: </a><font color="#B22222">M*/</font>
<a name="line48"> 48: </a><strong><font color="#228B22">#define <a href="../manualpages/Sys/PETSC_MATLAB_ENGINE_WORLD.html">PETSC_MATLAB_ENGINE_WORLD</a> <a href="../manualpages/Sys/PETSC_MATLAB_ENGINE_.html">PETSC_MATLAB_ENGINE_</a>(<a href="../manualpages/Sys/PETSC_COMM_WORLD.html">PETSC_COMM_WORLD</a>)</font></strong>
<a name="line50"> 50: </a><font color="#B22222">/*MC</font>
<a name="line51"> 51: </a><font color="#B22222"> <a href="../manualpages/Sys/PETSC_MATLAB_ENGINE_SELF.html">PETSC_MATLAB_ENGINE_SELF</a> - same as <a href="../manualpages/Sys/PETSC_MATLAB_ENGINE_.html">PETSC_MATLAB_ENGINE_</a>(<a href="../manualpages/Sys/PETSC_COMM_SELF.html">PETSC_COMM_SELF</a>)</font>
<a name="line53"> 53: </a><font color="#B22222"> Level: intermediate</font>
<a name="line55"> 55: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscMatlabEngine.html">PetscMatlabEngine</a>`, `<a href="../manualpages/Sys/PETSC_MATLAB_ENGINE_.html">PETSC_MATLAB_ENGINE_</a>()`, `<a href="../manualpages/Sys/PETSC_MATLAB_ENGINE_WORLD.html">PETSC_MATLAB_ENGINE_WORLD</a>`</font>
<a name="line56"> 56: </a><font color="#B22222">M*/</font>
<a name="line57"> 57: </a><strong><font color="#228B22">#define <a href="../manualpages/Sys/PETSC_MATLAB_ENGINE_SELF.html">PETSC_MATLAB_ENGINE_SELF</a> <a href="../manualpages/Sys/PETSC_MATLAB_ENGINE_.html">PETSC_MATLAB_ENGINE_</a>(<a href="../manualpages/Sys/PETSC_COMM_SELF.html">PETSC_COMM_SELF</a>)</font></strong>
</pre>
</body>
</html>
|
