Get OverloadType PETSc.vec

pyadjoint/adjfloat.py

@@ -130,6 +130,16 @@ def _ad_str(self):
         """Return the string of the taped value of this variable."""
         return str(self.block_variable.saved_output)
 
+    def _ad_petsc_vec_write_only(self):
+        raise NotImplementedError(
+            "It requires more thought to write only a PETSc Vec from `AdjFloat`."
+        )
+
+    def _ad_petsc_vec_read_only(self):
+        raise NotImplementedError(
+            "It requires more thought to read only a PETSc Vec from `AdjFloat`."
+        )
+
 
 _exp = math.exp
 _log = math.log

pyadjoint/overloaded_type.py

@@ -320,6 +320,42 @@ def _ad_str(self):
         """
         return str(self)
 
+    def _ad_petsc_vec_read_only(self):
+        """This method should be overwritten by types which can return a PETSc Vec.
+
+        This method must be used as a context manager.
+
+        Usage:
+
+        .. code-block:: python
+
+                with OverloadedType._ad_petsc_vec_read_only() as vec:
+                    # Do something with vec
+
+        Returns:
+            PETSc.Vec: A PETSc Vec object containing the read-only data of the overloaded
+            instance, excluding halo data.
+        """
+        raise NotImplementedError
+
+    def _ad_petsc_vec_write_only(self):
+        """This method should be overwritten by types which can return a PETSc Vec.
+
+        This method must be used as a context manager.
+
+        Usage:
+
+        .. code-block:: python
+
+                with OverloadedType._ad_petsc_vec_write_only() as vec:
+                    # Do something with vec
+
+        Returns:
+            PETSc.Vec: A PETSc Vec object containing the write-only data of the overloaded
+            instance, excluding halo data.
+        """
+        raise NotImplementedError
+
 
 class FloatingType(OverloadedType):
     def __init__(self, *args, **kwargs):