Skip to content

Commit

Permalink
Update Stub Files
Browse files Browse the repository at this point in the history
  • Loading branch information
ax3l authored and github-actions[bot] committed Apr 11, 2024
1 parent 173d739 commit a9e0188
Show file tree
Hide file tree
Showing 6 changed files with 51 additions and 9 deletions.
2 changes: 1 addition & 1 deletion src/amrex/space1d/__init__.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -475,4 +475,4 @@ __author__: str = (
"Axel Huebl, Ryan T. Sandberg, Shreyas Ananthan, David P. Grote, Revathi Jambunathan, Edoardo Zoni, Remi Lehe, Andrew Myers, Weiqun Zhang"
)
__license__: str = "BSD-3-Clause-LBNL"
__version__: str = "24.04"
__version__: str = "24.04-14-g6c6247554f27"
18 changes: 16 additions & 2 deletions src/amrex/space1d/amrex_1d_pybind/__init__.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -3594,7 +3594,7 @@ class BoxArray:
def size(self) -> int: ...

class Config:
amrex_version: typing.ClassVar[str] = "24.04"
amrex_version: typing.ClassVar[str] = "24.04-14-g6c6247554f27"
gpu_backend = None
have_gpu: typing.ClassVar[bool] = False
have_mpi: typing.ClassVar[bool] = True
Expand Down Expand Up @@ -5217,18 +5217,32 @@ class MultiFab(FabArray_FArrayBox):
modified.
"""

@typing.overload
def sum(self, comp: int = 0, local: bool = False) -> float:
"""
Returns the sum of component 'comp' over the MultiFab -- no ghost cells are included.
"""

@typing.overload
def sum(self, region: Box, comp: int = 0, local: bool = False) -> float:
"""
Returns the sum of component 'comp' in the given 'region'. -- no ghost cells are included.
"""

@typing.overload
def sum_unique(
self, comp: int = 0, local: bool = False, period: Periodicity = ...
) -> float:
"""
Same as sum with local=false, but for non-cell-centered data, thisskips non-unique points that are owned by multiple boxes.
"""

@typing.overload
def sum_unique(self, region: Box, comp: int = 0, local: bool = False) -> float:
"""
Returns the unique sum of component `comp` in the given region. Non-unique points owned by multiple boxes in the MultiFab areonly added once. No ghost cells are included. This function does not takeperiodicity into account in the determination of uniqueness of points.
"""

def to_cupy(self, copy=False, order="F"):
"""
Expand Down Expand Up @@ -14581,4 +14595,4 @@ __author__: str = (
"Axel Huebl, Ryan T. Sandberg, Shreyas Ananthan, David P. Grote, Revathi Jambunathan, Edoardo Zoni, Remi Lehe, Andrew Myers, Weiqun Zhang"
)
__license__: str = "BSD-3-Clause-LBNL"
__version__: str = "24.04"
__version__: str = "24.04-14-g6c6247554f27"
2 changes: 1 addition & 1 deletion src/amrex/space2d/__init__.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -523,4 +523,4 @@ __author__: str = (
"Axel Huebl, Ryan T. Sandberg, Shreyas Ananthan, David P. Grote, Revathi Jambunathan, Edoardo Zoni, Remi Lehe, Andrew Myers, Weiqun Zhang"
)
__license__: str = "BSD-3-Clause-LBNL"
__version__: str = "24.04"
__version__: str = "24.04-14-g6c6247554f27"
18 changes: 16 additions & 2 deletions src/amrex/space2d/amrex_2d_pybind/__init__.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -3618,7 +3618,7 @@ class BoxArray:
def size(self) -> int: ...

class Config:
amrex_version: typing.ClassVar[str] = "24.04"
amrex_version: typing.ClassVar[str] = "24.04-14-g6c6247554f27"
gpu_backend = None
have_gpu: typing.ClassVar[bool] = False
have_mpi: typing.ClassVar[bool] = True
Expand Down Expand Up @@ -5247,18 +5247,32 @@ class MultiFab(FabArray_FArrayBox):
modified.
"""

@typing.overload
def sum(self, comp: int = 0, local: bool = False) -> float:
"""
Returns the sum of component 'comp' over the MultiFab -- no ghost cells are included.
"""

@typing.overload
def sum(self, region: Box, comp: int = 0, local: bool = False) -> float:
"""
Returns the sum of component 'comp' in the given 'region'. -- no ghost cells are included.
"""

@typing.overload
def sum_unique(
self, comp: int = 0, local: bool = False, period: Periodicity = ...
) -> float:
"""
Same as sum with local=false, but for non-cell-centered data, thisskips non-unique points that are owned by multiple boxes.
"""

@typing.overload
def sum_unique(self, region: Box, comp: int = 0, local: bool = False) -> float:
"""
Returns the unique sum of component `comp` in the given region. Non-unique points owned by multiple boxes in the MultiFab areonly added once. No ghost cells are included. This function does not takeperiodicity into account in the determination of uniqueness of points.
"""

def to_cupy(self, copy=False, order="F"):
"""

Expand Down Expand Up @@ -16343,4 +16357,4 @@ __author__: str = (
"Axel Huebl, Ryan T. Sandberg, Shreyas Ananthan, David P. Grote, Revathi Jambunathan, Edoardo Zoni, Remi Lehe, Andrew Myers, Weiqun Zhang"
)
__license__: str = "BSD-3-Clause-LBNL"
__version__: str = "24.04"
__version__: str = "24.04-14-g6c6247554f27"
2 changes: 1 addition & 1 deletion src/amrex/space3d/__init__.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -475,4 +475,4 @@ __author__: str = (
"Axel Huebl, Ryan T. Sandberg, Shreyas Ananthan, David P. Grote, Revathi Jambunathan, Edoardo Zoni, Remi Lehe, Andrew Myers, Weiqun Zhang"
)
__license__: str = "BSD-3-Clause-LBNL"
__version__: str = "24.04"
__version__: str = "24.04-14-g6c6247554f27"
18 changes: 16 additions & 2 deletions src/amrex/space3d/amrex_3d_pybind/__init__.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -3594,7 +3594,7 @@ class BoxArray:
def size(self) -> int: ...

class Config:
amrex_version: typing.ClassVar[str] = "24.04"
amrex_version: typing.ClassVar[str] = "24.04-14-g6c6247554f27"
gpu_backend = None
have_gpu: typing.ClassVar[bool] = False
have_mpi: typing.ClassVar[bool] = True
Expand Down Expand Up @@ -5226,18 +5226,32 @@ class MultiFab(FabArray_FArrayBox):
modified.
"""

@typing.overload
def sum(self, comp: int = 0, local: bool = False) -> float:
"""
Returns the sum of component 'comp' over the MultiFab -- no ghost cells are included.
"""

@typing.overload
def sum(self, region: Box, comp: int = 0, local: bool = False) -> float:
"""
Returns the sum of component 'comp' in the given 'region'. -- no ghost cells are included.
"""

@typing.overload
def sum_unique(
self, comp: int = 0, local: bool = False, period: Periodicity = ...
) -> float:
"""
Same as sum with local=false, but for non-cell-centered data, thisskips non-unique points that are owned by multiple boxes.
"""

@typing.overload
def sum_unique(self, region: Box, comp: int = 0, local: bool = False) -> float:
"""
Returns the unique sum of component `comp` in the given region. Non-unique points owned by multiple boxes in the MultiFab areonly added once. No ghost cells are included. This function does not takeperiodicity into account in the determination of uniqueness of points.
"""

def to_cupy(self, copy=False, order="F"):
"""
Expand Down Expand Up @@ -14615,4 +14629,4 @@ __author__: str = (
"Axel Huebl, Ryan T. Sandberg, Shreyas Ananthan, David P. Grote, Revathi Jambunathan, Edoardo Zoni, Remi Lehe, Andrew Myers, Weiqun Zhang"
)
__license__: str = "BSD-3-Clause-LBNL"
__version__: str = "24.04"
__version__: str = "24.04-14-g6c6247554f27"

0 comments on commit a9e0188

Please sign in to comment.