Update Stub Files

AMReX-Codes · Mar 26, 2024 · bde1901 · bde1901
1 parent 1eb8cb7
commit bde1901
Show file tree

Hide file tree

Showing 6 changed files with 195 additions and 60 deletions.
diff --git a/src/amrex/space1d/__init__.pyi b/src/amrex/space1d/__init__.pyi
@@ -87,6 +87,7 @@ from amrex.space1d.amrex_1d_pybind import (
     DistributionMapping,
     FabArray_FArrayBox,
     FabArrayBase,
+    FabFactory_FArrayBox,
     FArrayBox,
     Geometry,
     GeometryData,
@@ -224,6 +225,7 @@ from amrex.space1d.amrex_1d_pybind import (
     begin,
     coarsen,
     concatenate,
+    copy_mfab,
     dtoh_memcpy,
     end,
     finalize,
@@ -291,6 +293,7 @@ __all__ = [
     "FArrayBox",
     "FabArrayBase",
     "FabArray_FArrayBox",
+    "FabFactory_FArrayBox",
     "Geometry",
     "GeometryData",
     "IndexType",
@@ -429,6 +432,7 @@ __all__ = [
     "begin",
     "coarsen",
     "concatenate",
+    "copy_mfab",
     "d_decl",
     "dtoh_memcpy",
     "end",

diff --git a/src/amrex/space1d/amrex_1d_pybind/__init__.pyi b/src/amrex/space1d/amrex_1d_pybind/__init__.pyi
@@ -88,6 +88,7 @@ __all__ = [
     "FArrayBox",
     "FabArrayBase",
     "FabArray_FArrayBox",
+    "FabFactory_FArrayBox",
     "Geometry",
     "GeometryData",
     "IndexType",
@@ -224,6 +225,7 @@ __all__ = [
     "begin",
     "coarsen",
     "concatenate",
+    "copy_mfab",
     "dtoh_memcpy",
     "end",
     "finalize",
@@ -3705,6 +3707,15 @@ class FabArray_FArrayBox(FabArrayBase):
     def sum_boundary(
         self, arg0: int, arg1: int, arg2: IntVect, arg3: Periodicity
     ) -> None: ...
+    @property
+    def arena(self) -> Arena: ...
+    @property
+    def factory(self) -> FabFactory_FArrayBox: ...
+    @property
+    def has_EB_fab_factory(self) -> bool: ...
+
+class FabFactory_FArrayBox:
+    pass
 
 class Geometry(CoordSys):
     @typing.overload
@@ -4201,26 +4212,6 @@ class MultiFab(FabArray_FArrayBox):
     ) -> None: ...
     @staticmethod
     @typing.overload
-    def copy(
-        dst: MultiFab,
-        src: MultiFab,
-        srccomp: int,
-        dstcomp: int,
-        numcomp: int,
-        nghost: int,
-    ) -> None: ...
-    @staticmethod
-    @typing.overload
-    def copy(
-        dst: MultiFab,
-        src: MultiFab,
-        srccomp: int,
-        dstcomp: int,
-        numcomp: int,
-        nghost: IntVect,
-    ) -> None: ...
-    @staticmethod
-    @typing.overload
     def divide(
         arg0: MultiFab, arg1: MultiFab, arg2: int, arg3: int, arg4: int, arg5: int
     ) -> None: ...
@@ -4326,6 +4317,16 @@ class MultiFab(FabArray_FArrayBox):
         arg4: MFInfo,
     ) -> None: ...
     @typing.overload
+    def __init__(
+        self,
+        arg0: BoxArray,
+        arg1: DistributionMapping,
+        arg2: int,
+        arg3: int,
+        arg4: MFInfo,
+        arg5: FabFactory_FArrayBox,
+    ) -> None: ...
+    @typing.overload
     def __init__(
         self, arg0: BoxArray, arg1: DistributionMapping, arg2: int, arg3: IntVect
     ) -> None: ...
@@ -4338,6 +4339,16 @@ class MultiFab(FabArray_FArrayBox):
         arg3: IntVect,
         arg4: MFInfo,
     ) -> None: ...
+    @typing.overload
+    def __init__(
+        self,
+        arg0: BoxArray,
+        arg1: DistributionMapping,
+        arg2: int,
+        arg3: IntVect,
+        arg4: MFInfo,
+        arg5: FabFactory_FArrayBox,
+    ) -> None: ...
     def __repr__(self) -> str: ...
     @typing.overload
     def abs(self, arg0: int, arg1: int) -> None: ...
@@ -4357,6 +4368,23 @@ class MultiFab(FabArray_FArrayBox):
     def contains_nan(self, arg0: int, arg1: int, arg2: int, arg3: bool) -> bool: ...
     @typing.overload
     def contains_nan(self, arg0: int, arg1: int, arg2: IntVect, arg3: bool) -> bool: ...
+    def copy(self):
+        """
+
+        Create a copy of this MultiFab, using the same Arena.
+
+        Parameters
+        ----------
+        self : amrex.MultiFab
+            A MultiFab class in pyAMReX
+
+        Returns
+        -------
+        amrex.MultiFab
+            A copy of this MultiFab.
+
+        """
+
     def divi(self, arg0: MultiFab, arg1: int, arg2: int, arg3: int) -> None: ...
     def dm(self: FabArrayBase) -> DistributionMapping: ...
     @typing.overload
@@ -13393,6 +13421,19 @@ def concatenate(root: str, num: int, mindigits: int = 5) -> str:
     Builds plotfile name
     """
 
+@typing.overload
+def copy_mfab(
+    dst: MultiFab, src: MultiFab, srccomp: int, dstcomp: int, numcomp: int, nghost: int
+) -> None: ...
+@typing.overload
+def copy_mfab(
+    dst: MultiFab,
+    src: MultiFab,
+    srccomp: int,
+    dstcomp: int,
+    numcomp: int,
+    nghost: IntVect,
+) -> None: ...
 @typing.overload
 def dtoh_memcpy(dest: FabArray_FArrayBox, src: FabArray_FArrayBox) -> None: ...
 @typing.overload

diff --git a/src/amrex/space2d/__init__.pyi b/src/amrex/space2d/__init__.pyi
@@ -87,6 +87,7 @@ from amrex.space2d.amrex_2d_pybind import (
     DistributionMapping,
     FabArray_FArrayBox,
     FabArrayBase,
+    FabFactory_FArrayBox,
     FArrayBox,
     Geometry,
     GeometryData,
@@ -248,6 +249,7 @@ from amrex.space2d.amrex_2d_pybind import (
     begin,
     coarsen,
     concatenate,
+    copy_mfab,
     dtoh_memcpy,
     end,
     finalize,
@@ -315,6 +317,7 @@ __all__ = [
     "FArrayBox",
     "FabArrayBase",
     "FabArray_FArrayBox",
+    "FabFactory_FArrayBox",
     "Geometry",
     "GeometryData",
     "IndexType",
@@ -477,6 +480,7 @@ __all__ = [
     "begin",
     "coarsen",
     "concatenate",
+    "copy_mfab",
     "d_decl",
     "dtoh_memcpy",
     "end",

diff --git a/src/amrex/space2d/amrex_2d_pybind/__init__.pyi b/src/amrex/space2d/amrex_2d_pybind/__init__.pyi
@@ -88,6 +88,7 @@ __all__ = [
     "FArrayBox",
     "FabArrayBase",
     "FabArray_FArrayBox",
+    "FabFactory_FArrayBox",
     "Geometry",
     "GeometryData",
     "IndexType",
@@ -248,6 +249,7 @@ __all__ = [
     "begin",
     "coarsen",
     "concatenate",
+    "copy_mfab",
     "dtoh_memcpy",
     "end",
     "finalize",
@@ -3729,6 +3731,15 @@ class FabArray_FArrayBox(FabArrayBase):
     def sum_boundary(
         self, arg0: int, arg1: int, arg2: IntVect, arg3: Periodicity
     ) -> None: ...
+    @property
+    def arena(self) -> Arena: ...
+    @property
+    def factory(self) -> FabFactory_FArrayBox: ...
+    @property
+    def has_EB_fab_factory(self) -> bool: ...
+
+class FabFactory_FArrayBox:
+    pass
 
 class Geometry(CoordSys):
     @typing.overload
@@ -4231,26 +4242,6 @@ class MultiFab(FabArray_FArrayBox):
     ) -> None: ...
     @staticmethod
     @typing.overload
-    def copy(
-        dst: MultiFab,
-        src: MultiFab,
-        srccomp: int,
-        dstcomp: int,
-        numcomp: int,
-        nghost: int,
-    ) -> None: ...
-    @staticmethod
-    @typing.overload
-    def copy(
-        dst: MultiFab,
-        src: MultiFab,
-        srccomp: int,
-        dstcomp: int,
-        numcomp: int,
-        nghost: IntVect,
-    ) -> None: ...
-    @staticmethod
-    @typing.overload
     def divide(
         arg0: MultiFab, arg1: MultiFab, arg2: int, arg3: int, arg4: int, arg5: int
     ) -> None: ...
@@ -4356,6 +4347,16 @@ class MultiFab(FabArray_FArrayBox):
         arg4: MFInfo,
     ) -> None: ...
     @typing.overload
+    def __init__(
+        self,
+        arg0: BoxArray,
+        arg1: DistributionMapping,
+        arg2: int,
+        arg3: int,
+        arg4: MFInfo,
+        arg5: FabFactory_FArrayBox,
+    ) -> None: ...
+    @typing.overload
     def __init__(
         self, arg0: BoxArray, arg1: DistributionMapping, arg2: int, arg3: IntVect
     ) -> None: ...
@@ -4368,6 +4369,16 @@ class MultiFab(FabArray_FArrayBox):
         arg3: IntVect,
         arg4: MFInfo,
     ) -> None: ...
+    @typing.overload
+    def __init__(
+        self,
+        arg0: BoxArray,
+        arg1: DistributionMapping,
+        arg2: int,
+        arg3: IntVect,
+        arg4: MFInfo,
+        arg5: FabFactory_FArrayBox,
+    ) -> None: ...
     def __repr__(self) -> str: ...
     @typing.overload
     def abs(self, arg0: int, arg1: int) -> None: ...
@@ -4387,6 +4398,23 @@ class MultiFab(FabArray_FArrayBox):
     def contains_nan(self, arg0: int, arg1: int, arg2: int, arg3: bool) -> bool: ...
     @typing.overload
     def contains_nan(self, arg0: int, arg1: int, arg2: IntVect, arg3: bool) -> bool: ...
+    def copy(self):
+        """
+
+        Create a copy of this MultiFab, using the same Arena.
+
+        Parameters
+        ----------
+        self : amrex.MultiFab
+            A MultiFab class in pyAMReX
+
+        Returns
+        -------
+        amrex.MultiFab
+            A copy of this MultiFab.
+
+        """
+
     def divi(self, arg0: MultiFab, arg1: int, arg2: int, arg3: int) -> None: ...
     def dm(self: FabArrayBase) -> DistributionMapping: ...
     @typing.overload
@@ -15125,6 +15153,19 @@ def concatenate(root: str, num: int, mindigits: int = 5) -> str:
     Builds plotfile name
     """
 
+@typing.overload
+def copy_mfab(
+    dst: MultiFab, src: MultiFab, srccomp: int, dstcomp: int, numcomp: int, nghost: int
+) -> None: ...
+@typing.overload
+def copy_mfab(
+    dst: MultiFab,
+    src: MultiFab,
+    srccomp: int,
+    dstcomp: int,
+    numcomp: int,
+    nghost: IntVect,
+) -> None: ...
 @typing.overload
 def dtoh_memcpy(dest: FabArray_FArrayBox, src: FabArray_FArrayBox) -> None: ...
 @typing.overload

diff --git a/src/amrex/space3d/__init__.pyi b/src/amrex/space3d/__init__.pyi
@@ -87,6 +87,7 @@ from amrex.space3d.amrex_3d_pybind import (
     DistributionMapping,
     FabArray_FArrayBox,
     FabArrayBase,
+    FabFactory_FArrayBox,
     FArrayBox,
     Geometry,
     GeometryData,
@@ -224,6 +225,7 @@ from amrex.space3d.amrex_3d_pybind import (
     begin,
     coarsen,
     concatenate,
+    copy_mfab,
     dtoh_memcpy,
     end,
     finalize,
@@ -291,6 +293,7 @@ __all__ = [
     "FArrayBox",
     "FabArrayBase",
     "FabArray_FArrayBox",
+    "FabFactory_FArrayBox",
     "Geometry",
     "GeometryData",
     "IndexType",
@@ -429,6 +432,7 @@ __all__ = [
     "begin",
     "coarsen",
     "concatenate",
+    "copy_mfab",
     "d_decl",
     "dtoh_memcpy",
     "end",