xref: /petsc/src/mat/impls/python/pythonmat.c (revision 4f572ea9526f19623f23a8c158f3503516190bbc)

#include <petsc/private/matimpl.h> /*I "petscmat.h" I*/

/*@C
   MatPythonSetType - Initialize a `Mat` object implemented in Python.

   Collective

   Input Parameters:
+  mat - the matrix object.
-  pyname - full dotted Python name [package].module[.{class|function}]

   Options Database Key:
.  -mat_python_type <pyname> - python class

   Level: intermediate

.seealso: [](ch_matrices), `Mat`, `MatType`, `MatCreate()`, `MatSetType()`, `MATPYTHON`, `PetscPythonInitialize()`
@*/
PetscErrorCode MatPythonSetType(Mat mat, const char pyname[])
{
  PetscFunctionBegin;
  PetscValidHeaderSpecific(mat, MAT_CLASSID, 1);
  PetscAssertPointer(pyname, 2);
  PetscTryMethod(mat, "MatPythonSetType_C", (Mat, const char[]), (mat, pyname));
  PetscFunctionReturn(PETSC_SUCCESS);
}

/*@C
   MatPythonGetType - Get the Python name of a `Mat` object implemented in Python.

   Not Collective

   Input Parameter:
.  mat - the matrix

   Output Parameter:
.  pyname - full dotted Python name [package].module[.{class|function}]

   Level: intermediate

.seealso: [](ch_matrices), `Mat`, `MatType`, `MatCreate()`, `MatSetType()`, `MATPYTHON`, `PetscPythonInitialize()`, `MatPythonSetType()`
@*/
PetscErrorCode MatPythonGetType(Mat mat, const char *pyname[])
{
  PetscFunctionBegin;
  PetscValidHeaderSpecific(mat, MAT_CLASSID, 1);
  PetscAssertPointer(pyname, 2);
  PetscUseMethod(mat, "MatPythonGetType_C", (Mat, const char *[]), (mat, pyname));
  PetscFunctionReturn(PETSC_SUCCESS);
}

/*@C
   MatPythonCreate - Create a `Mat` object implemented in Python.

   Collective

   Input Parameters:
+  comm - MPI communicator
.  m - number of local rows (or `PETSC_DECIDE` to have calculated if `M` is given)
.  n - number of local columns (or `PETSC_DECIDE` to have calculated if `N` is given)
.  M - number of global rows (or `PETSC_DECIDE` to have calculated if `m` is given)
.  N - number of global columns (or `PETSC_DECIDE` to have calculated if `n` is given)
-  pyname - full dotted Python name [package].module[.{class|function}]

   Output Parameter:
.  A - the matrix

   Level: intermediate

.seealso: [](ch_matrices), `Mat`, `MatType`, `MATPYTHON`, `MatPythonSetType()`, `PetscPythonInitialize()`
@*/
PetscErrorCode MatPythonCreate(MPI_Comm comm, PetscInt m, PetscInt n, PetscInt M, PetscInt N, const char pyname[], Mat *A)
{
  PetscFunctionBegin;
  PetscAssertPointer(pyname, 6);
  PetscAssertPointer(A, 6);
  PetscCall(MatCreate(comm, A));
  PetscCall(MatSetSizes(*A, m, n, M, N));
  PetscCall(MatSetType(*A, MATPYTHON));
  PetscCall(MatPythonSetType(*A, pyname));
  PetscCall(MatBindToCPU(*A, PETSC_FALSE));
  PetscFunctionReturn(PETSC_SUCCESS);
}