Skip to content

Commit

Permalink
Update Stub Files
Browse files Browse the repository at this point in the history
  • Loading branch information
WeiqunZhang authored and github-actions[bot] committed Oct 23, 2024
1 parent 62f23ae commit 1aa1db3
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 3 deletions.
9 changes: 8 additions & 1 deletion src/amrex/space1d/amrex_1d_pybind/__init__.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -4935,6 +4935,10 @@ class BoxArray:
@typing.overload
def coarsenable(self, arg0: IntVect1D, arg1: IntVect1D) -> bool: ...
def define(self, arg0: Box) -> None: ...
@typing.overload
def enclosed_cells(self) -> BoxArray: ...
@typing.overload
def enclosed_cells(self, arg0: int) -> BoxArray: ...
def get(self, arg0: int) -> Box: ...
def ix_type(self) -> IndexType: ...
@typing.overload
Expand Down Expand Up @@ -6276,7 +6280,7 @@ class MultiFab(FabArray_FArrayBox):
"""
dst = src + a*dst
"""
def __getitem__(self, index):
def __getitem__(self, index, with_internal_ghosts=False):
"""
Returns slice of the MultiFab using global indexing, as a numpy array.
This uses numpy array indexing, with the indexing relative to the global array.
Expand All @@ -6298,6 +6302,9 @@ class MultiFab(FabArray_FArrayBox):
----------
index : the index using numpy style indexing
Index of the slice to return.
with_internal_ghosts : bool, optional
Whether to include internal ghost cells. When true, data from ghost cells may be used that
overlaps valid cells.

"""
@typing.overload
Expand Down
9 changes: 8 additions & 1 deletion src/amrex/space2d/amrex_2d_pybind/__init__.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -4959,6 +4959,10 @@ class BoxArray:
@typing.overload
def coarsenable(self, arg0: IntVect2D, arg1: IntVect2D) -> bool: ...
def define(self, arg0: Box) -> None: ...
@typing.overload
def enclosed_cells(self) -> BoxArray: ...
@typing.overload
def enclosed_cells(self, arg0: int) -> BoxArray: ...
def get(self, arg0: int) -> Box: ...
def ix_type(self) -> IndexType: ...
@typing.overload
Expand Down Expand Up @@ -6304,7 +6308,7 @@ class MultiFab(FabArray_FArrayBox):
"""
dst = src + a*dst
"""
def __getitem__(self, index):
def __getitem__(self, index, with_internal_ghosts=False):
"""
Returns slice of the MultiFab using global indexing, as a numpy array.
This uses numpy array indexing, with the indexing relative to the global array.
Expand All @@ -6326,6 +6330,9 @@ class MultiFab(FabArray_FArrayBox):
----------
index : the index using numpy style indexing
Index of the slice to return.
with_internal_ghosts : bool, optional
Whether to include internal ghost cells. When true, data from ghost cells may be used that
overlaps valid cells.

"""
@typing.overload
Expand Down
9 changes: 8 additions & 1 deletion src/amrex/space3d/amrex_3d_pybind/__init__.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -4935,6 +4935,10 @@ class BoxArray:
@typing.overload
def coarsenable(self, arg0: IntVect3D, arg1: IntVect3D) -> bool: ...
def define(self, arg0: Box) -> None: ...
@typing.overload
def enclosed_cells(self) -> BoxArray: ...
@typing.overload
def enclosed_cells(self, arg0: int) -> BoxArray: ...
def get(self, arg0: int) -> Box: ...
def ix_type(self) -> IndexType: ...
@typing.overload
Expand Down Expand Up @@ -6283,7 +6287,7 @@ class MultiFab(FabArray_FArrayBox):
"""
dst = src + a*dst
"""
def __getitem__(self, index):
def __getitem__(self, index, with_internal_ghosts=False):
"""
Returns slice of the MultiFab using global indexing, as a numpy array.
This uses numpy array indexing, with the indexing relative to the global array.
Expand All @@ -6305,6 +6309,9 @@ class MultiFab(FabArray_FArrayBox):
----------
index : the index using numpy style indexing
Index of the slice to return.
with_internal_ghosts : bool, optional
Whether to include internal ghost cells. When true, data from ghost cells may be used that
overlaps valid cells.

"""
@typing.overload
Expand Down

0 comments on commit 1aa1db3

Please sign in to comment.