Python API

Imports

pyAMReX provides the public imports amrex.space1d, amrex.space2d and amrex.space3d, mirroring the compile-time option AMReX_SPACEDIM.

Due to limitations in AMReX, currently, only one of the imports can be used at a time in the same Python process. For example:

import amrex.space3d as amr

A 1D or 2D AMReX run needs its own Python process. Another dimensionality cannot be imported into the same Python process after choosing a specific dimensionality for import.

For brevity, below the 3D APIs are shown. pyAMReX classes and functions follow the same structure as the C++ AMReX APIs.

Base

class amrex.space3d.AMReX[source]
static empty() bool[source]
static erase(arg0: AMReX) None[source]
static size() int[source]
static top() AMReX[source]
class amrex.space3d.Config[source]
amrex_version: ClassVar[str] = '24.01'
gpu_backend = None
have_gpu: ClassVar[bool] = False
have_mpi: ClassVar[bool] = True
have_omp: ClassVar[bool] = False
spacedim: ClassVar[int] = 3
verbose: ClassVar[int] = 1
amrex.space3d.initialize(arg0: list) AMReX[source]

Initialize AMReX library

amrex.space3d.finalize(*args, **kwds)

Helper for @overload to raise when called.

amrex.space3d.initialized() bool[source]

Returns true if there are any currently-active and initialized AMReX instances (i.e. one for which amrex::Initialize has been called, and amrex::Finalize has not). Otherwise false.

amrex.space3d.size() int[source]

The amr stack size, the number of amr instances pushed.

class amrex.space3d.Arena[source]
class amrex.space3d.Direction[source]
class amrex.space3d.CoordSys[source]
class amrex.space3d.CoordSys(arg0: CoordSys)
Coord() CoordType[source]
CoordInt() int[source]
class CoordType(value: int)[source]

Members:

undef

cartesian

RZ

SPHERICAL

RZ: ClassVar[CoordType]
SPHERICAL: ClassVar[CoordType]
cartesian: ClassVar[CoordType]
property name: str
undef: ClassVar[CoordType]
property value: int
IsCartesian() bool[source]
IsRZ() bool[source]
IsSPHERICAL() bool[source]
RZ: ClassVar[CoordType]
SPHERICAL: ClassVar[CoordType]
SetCoord(arg0: CoordType) None[source]
cartesian: ClassVar[CoordType]
ok() bool[source]
undef: ClassVar[CoordType]
class amrex.space3d.DistributionMapping[source]
class amrex.space3d.DistributionMapping(arg0: DistributionMapping)
class amrex.space3d.DistributionMapping(arg0: Vector_int)
class amrex.space3d.DistributionMapping(boxes: BoxArray)
class amrex.space3d.DistributionMapping(boxes: BoxArray, nprocs: int)
ProcessorMap() Vector_int[source]
property capacity: int
define(boxes: BoxArray) None
define(boxes: BoxArray, nprocs: int) None
define(arg0: Vector_int) None

Helper for @overload to raise when called.

property empty: bool
property size: int
class amrex.space3d.GeometryData[source]
CellSize() Annotated[list[float], pybind11_stubgen.typing_ext.FixedSize(3)]
CellSize(arg0: int) float

Helper for @overload to raise when called.

Coord() int[source]

return integer coordinate type

Domain() Box[source]

Returns our rectangular domain

ProbHi() Annotated[list[float], pybind11_stubgen.typing_ext.FixedSize(3)]
ProbHi(arg0: int) float

Helper for @overload to raise when called.

ProbLo() Annotated[list[float], pybind11_stubgen.typing_ext.FixedSize(3)]
ProbLo(arg0: int) float

Helper for @overload to raise when called.

property coord: int
property domain: Box
property dx: list[float]
isPeriodic() Annotated[list[int], pybind11_stubgen.typing_ext.FixedSize(3)]
isPeriodic(arg0: int) int

Helper for @overload to raise when called.

property is_periodic: list[int]
property prob_domain: RealBox
class amrex.space3d.Geometry[source]
class amrex.space3d.Geometry(dom: Box, rb: RealBox, coord: int, is_per: Annotated[list[int], pybind11_stubgen.typing_ext.FixedSize(3)])
Domain() Box
Domain(arg0: Box) None

Helper for @overload to raise when called.

ProbDomain() RealBox
ProbDomain(arg0: RealBox) None

Helper for @overload to raise when called.

ProbHi(arg0: int) float
ProbHi() Annotated[list[float], pybind11_stubgen.typing_ext.FixedSize(3)]

Helper for @overload to raise when called.

ProbLength(arg0: int) float[source]

length of problem domain in specified dimension

ProbLo(arg0: int) float
ProbLo() Annotated[list[float], pybind11_stubgen.typing_ext.FixedSize(3)]

Helper for @overload to raise when called.

ProbSize() float[source]

the overall size of the domain

ResetDefaultCoord() None[source]

Reset default coord of Geometry class with an Array of int

ResetDefaultPeriodicity() None[source]

Reset default periodicity of Geometry class with an Array of int

ResetDefaultProbDomain() None[source]

Reset default problem domain of Geometry class with a RealBox

coarsen(arg0: IntVect) None[source]
data() GeometryData[source]

Returns non-static copy of geometry’s stored data

define(arg0: Box, arg1: RealBox, arg2: int, arg3: list[int]) None[source]

Set geometry

growNonPeriodicDomain(arg0: IntVect) Box
growNonPeriodicDomain(arg0: int) Box

Helper for @overload to raise when called.

growPeriodicDomain(arg0: IntVect) Box
growPeriodicDomain(arg0: int) Box

Helper for @overload to raise when called.

insideRoundOffDomain(arg0: float, arg1: float, arg2: float) bool[source]

Returns true if a point is inside the roundoff domain. All particles with positions inside the roundoff domain are sure to be mapped to cells inside the Domain() box. Note that the same need not be true for all points inside ProbDomain()

isAllPeriodic() bool[source]

Is domain periodic in all directions?

isAnyPeriodic() bool[source]

Is domain periodic in any direction?

isPeriodic(arg0: int) bool
isPeriodic() Annotated[list[int], pybind11_stubgen.typing_ext.FixedSize(3)]

Helper for @overload to raise when called.

outsideRoundOffDomain(arg0: float, arg1: float, arg2: float) bool[source]

Returns true if a point is outside the roundoff domain. All particles with positions inside the roundoff domain are sure to be mapped to cells inside the Domain() box. Note that the same need not be true for all points inside ProbDomain()

period(arg0: int) int[source]

Return the period in the specified direction

periodicity() Periodicity
periodicity(arg0: Box) Periodicity

Helper for @overload to raise when called.

refine(arg0: IntVect) None[source]
setPeriodicity(arg0: list[int]) list[int][source]
amrex.space3d.ParallelDescriptor.IOProcessor() bool
amrex.space3d.ParallelDescriptor.IOProcessorNumber() int
amrex.space3d.ParallelDescriptor.MyProc() int
amrex.space3d.ParallelDescriptor.NProcs() int
class amrex.space3d.Periodicity[source]
class amrex.space3d.Periodicity(arg0: IntVect)
property domain: Box

Cell-centered domain Box “infinitely” long in non-periodic directions.

property is_all_periodic: bool
property is_any_periodic: bool
is_periodic(dir: int) bool[source]
static non_periodic() Periodicity[source]

Return the Periodicity object that is not periodic in any direction

property shift_IntVect: list[amrex.space3d.amrex_3d_pybind.IntVect]
class amrex.space3d.RealBox[source]
class amrex.space3d.RealBox(x_lo: float, y_lo: float, z_lo: float, x_hi: float, y_hi: float, z_hi: float)
class amrex.space3d.RealBox(a_lo: Annotated[list[float], pybind11_stubgen.typing_ext.FixedSize(3)], a_hi: Annotated[list[float], pybind11_stubgen.typing_ext.FixedSize(3)])
class amrex.space3d.RealBox(bx: Box, dx: Annotated[list[float], pybind11_stubgen.typing_ext.FixedSize(3)], base: Annotated[list[float], pybind11_stubgen.typing_ext.FixedSize(3)])
contains(rb: XDim3, eps: float = 0.0) bool
contains(rb: RealVect, eps: float = 0.0) bool
contains(rb: RealBox, eps: float = 0.0) bool
contains(rb: list[float], eps: float = 0.0) bool

Helper for @overload to raise when called.

hi(arg0: int) float
hi() Annotated[list[float], pybind11_stubgen.typing_ext.FixedSize(3)]

Helper for @overload to raise when called.

intersects(arg0: RealBox) bool[source]

determine if box intersects with a box

length(arg0: int) float[source]
lo(arg0: int) float
lo() Annotated[list[float], pybind11_stubgen.typing_ext.FixedSize(3)]

Helper for @overload to raise when called.

ok() bool[source]

Determine if RealBox satisfies xlo[i]<xhi[i] for i=0,1,...,AMREX_SPACEDIM.

setHi(arg0: list[float]) None
setHi(arg0: int, arg1: float) None

Helper for @overload to raise when called.

setLo(arg0: list[float]) None
setLo(arg0: int, arg1: float) None

Helper for @overload to raise when called.

volume() float[source]
property xhi: list[float]
property xlo: list[float]
amrex.space3d.AlmostEqual(rb1: RealBox, rb2: RealBox, eps: float = 0.0) bool[source]

Determine if two boxes are equal to within a tolerance

Index Types

class amrex.space3d.Box(small: IntVect, big: IntVect)[source]
class amrex.space3d.Box(small: IntVect, big: IntVect, typ: IntVect)
class amrex.space3d.Box(small: IntVect, big: IntVect, t: IndexType)
class amrex.space3d.Box(small: Annotated[list[int], pybind11_stubgen.typing_ext.FixedSize(3)], big: Annotated[list[int], pybind11_stubgen.typing_ext.FixedSize(3)])
class amrex.space3d.Box(small: Annotated[list[int], pybind11_stubgen.typing_ext.FixedSize(3)], big: Annotated[list[int], pybind11_stubgen.typing_ext.FixedSize(3)], t: IndexType)
begin(arg0: Box) Dim3[source]
property big_end: IntVect
property cell_centered: bool
contains(arg0: IntVect) bool[source]
convert(arg0: IndexType) Box
convert(arg0: IntVect) Box

Helper for @overload to raise when called.

property d_num_pts: float
enclosed_cells() Box
enclosed_cells(dir: int) Box
enclosed_cells(d: Direction) Box

Helper for @overload to raise when called.

end(arg0: Box) Dim3[source]
grow(n_cell: int) Box
grow(n_cells: IntVect) Box
grow(idir: int, n_cell: int) Box
grow(d: Direction, n_cell: int) Box

Helper for @overload to raise when called.

grow_high(idir: int, n_cell: int) Box
grow_high(d: Direction, n_cell: int) Box

Helper for @overload to raise when called.

grow_low(idir: int, n_cell: int) Box
grow_low(d: Direction, n_cell: int) Box

Helper for @overload to raise when called.

property hi_vect: IntVect
intersects(arg0: Box) bool[source]
property is_empty: bool
property is_square: bool
property ix_type: IndexType
lbound(arg0: Box) Dim3[source]
length() IntVect
length(arg0: int) int

Helper for @overload to raise when called.

property lo_vect: IntVect
make_slab(direction: int, slab_index: int) Box[source]
normalize() None[source]
numPts() int[source]

Return the number of points in the Box.

property num_pts: int
property ok: bool
same_size(arg0: Box) bool[source]
same_type(arg0: Box) bool[source]
shift(arg0: IntVect) Box[source]
property size: IntVect
property small_end: IntVect
strictly_contains(arg0: IntVect) bool[source]
surrounding_nodes() Box
surrounding_nodes(dir: int) Box
surrounding_nodes(d: Direction) Box

Helper for @overload to raise when called.

property the_unit_box: Box
property type: IntVect
ubound(arg0: Box) Dim3[source]
property volume: int
class amrex.space3d.BoxArray[source]
class amrex.space3d.BoxArray(arg0: Box)
class amrex.space3d.BoxArray(arg0: Box, arg1: int)
property capacity: int
cell_equal(arg0: BoxArray) bool[source]
clear() None[source]
coarsen(arg0: IntVect) BoxArray
coarsen(arg0: int) BoxArray

Helper for @overload to raise when called.

coarsenable(arg0: int, arg1: int) bool
coarsenable(arg0: IntVect, arg1: int) bool
coarsenable(arg0: IntVect, arg1: IntVect) bool

Helper for @overload to raise when called.

property d_numPts: float
define(arg0: Box) None[source]
property empty: bool
get(arg0: int) Box[source]
ix_type() IndexType[source]
max_size(arg0: int) BoxArray
max_size(arg0: IntVect) BoxArray

Helper for @overload to raise when called.

minimal_box() Box[source]
property numPts: int
refine(arg0: int) BoxArray
refine(arg0: IntVect) BoxArray

Helper for @overload to raise when called.

resize(arg0: int) None[source]
property size: int
class amrex.space3d.Dim3(arg0: int, arg1: int, arg2: int)[source]
x: int
y: int
z: int
class amrex.space3d.XDim3(arg0: float, arg1: float, arg2: float)[source]
x: float
y: float
z: float
class amrex.space3d.IndexType[source]
class amrex.space3d.IndexType(arg0: IndexType)
class amrex.space3d.IndexType(arg0: IndexType.CellIndex, arg1: IndexType.CellIndex, arg2: IndexType.CellIndex)
CELL: ClassVar[CellIndex]
class CellIndex(value: int)[source]

Members:

CELL

NODE

CELL: ClassVar[CellIndex]
NODE: ClassVar[CellIndex]
property name: str
property value: int
NODE: ClassVar[CellIndex]
any() bool[source]
cell_centered() bool
cell_centered(arg0: int) bool

Helper for @overload to raise when called.

static cell_type() IndexType[source]
clear() None[source]
flip(arg0: int) None[source]
ix_type() IntVect
ix_type(arg0: int) IndexType.CellIndex

Helper for @overload to raise when called.

node_centered() bool
node_centered(arg0: int) bool

Helper for @overload to raise when called.

static node_type() IndexType[source]
ok() bool[source]
set(arg0: int) None[source]
set_type(arg0: int, arg1: CellIndex) None[source]
setall() None[source]
test(arg0: int) bool[source]
to_IntVect() IntVect[source]
unset(arg0: int) None[source]

Vectors

class amrex.space3d.IntVect[source]
class amrex.space3d.IntVect(arg0: int, arg1: int, arg2: int)
class amrex.space3d.IntVect(arg0: int)
class amrex.space3d.IntVect(arg0: Annotated[list[int], pybind11_stubgen.typing_ext.FixedSize(3)])
static cell_vector() IntVect[source]
dim3() Dim3[source]
property max: int
static max_vector() IntVect[source]
property min: int
static min_vector() IntVect[source]
static node_vector() IntVect[source]
numpy() ndarray[source]
property sum: int
static unit_vector() IntVect[source]
static zero_vector() IntVect[source]
class amrex.space3d.RealVect[source]
class amrex.space3d.RealVect(arg0: float, arg1: float, arg2: float)
class amrex.space3d.RealVect(arg0: IntVect)
class amrex.space3d.RealVect(arg0: list[float])
class amrex.space3d.RealVect(arg0: float)
BASISREALV() RealVect[source]

return basis vector in given coordinate direction

ceil() IntVect[source]

Return an IntVect whose components are the std::ceil of the vector components

crossProduct(arg0: RealVect) RealVect[source]

Return cross product of this vector with another

dotProduct(arg0: RealVect) float[source]

Return dot product of this vector with another

floor() IntVect[source]

Return an IntVect whose components are the std::floor of the vector components

max(arg0: RealVect) RealVect[source]

Replace vector with the component-wise maxima of this vector and another

maxDir(arg0: bool) int[source]

direction or index of maximum value of this vector

min(arg0: RealVect) RealVect[source]

Replace vector with the component-wise minima of this vector and another

minDir(arg0: bool) int[source]

direction or index of minimum value of this vector

property product: float

Product of entries of this vector

property radSquared: float

Length squared of this vector

round() IntVect[source]

Return an IntVect whose components are the std::round of the vector components

scale(arg0: float) RealVect[source]

Multiplify each component of this vector by a scalar

property sum: float

Sum of the components of this vector

static unit_vector() RealVect[source]
property vectorLength: float

Length or 2-Norm of this vector

static zero_vector() RealVect[source]
amrex.space3d.min(arg0: RealVect, arg1: RealVect) RealVect[source]
amrex.space3d.max(arg0: RealVect, arg1: RealVect) RealVect[source]

amrex::Vector<T> is implemented for many types, e.g.,

class amrex.space3d.Vector_Real[source]
class amrex.space3d.Vector_Real(arg0: Vector_Real)
class amrex.space3d.Vector_Real(arg0: Iterable)
class amrex.space3d.Vector_Real
class amrex.space3d.Vector_Real(arg0: Vector_Real)
append(x: float) None[source]

Add an item to the end of the list

clear() None[source]

Clear the contents

count(x: float) int[source]

Return the number of times x appears in the list

extend(L: Vector_Real) None
extend(L: Iterable) None

Helper for @overload to raise when called.

insert(i: int, x: float) None[source]

Insert an item at a given position.

pop() float
pop(i: int) float

Helper for @overload to raise when called.

remove(x: float) None[source]

Remove the first item from the list whose value is x. It is an error if there is no such item.

size() int[source]
class amrex.space3d.Vector_int[source]
class amrex.space3d.Vector_int(arg0: Vector_int)
class amrex.space3d.Vector_int(arg0: Iterable)
class amrex.space3d.Vector_int
class amrex.space3d.Vector_int(arg0: Vector_int)
append(x: int) None[source]

Add an item to the end of the list

clear() None[source]

Clear the contents

count(x: int) int[source]

Return the number of times x appears in the list

extend(L: Vector_int) None
extend(L: Iterable) None

Helper for @overload to raise when called.

insert(i: int, x: int) None[source]

Insert an item at a given position.

pop() int
pop(i: int) int

Helper for @overload to raise when called.

remove(x: int) None[source]

Remove the first item from the list whose value is x. It is an error if there is no such item.

size() int[source]
class amrex.space3d.Vector_string[source]
class amrex.space3d.Vector_string(arg0: Vector_string)
class amrex.space3d.Vector_string(arg0: Iterable)
class amrex.space3d.Vector_string
class amrex.space3d.Vector_string(arg0: Vector_string)
append(x: str) None[source]

Add an item to the end of the list

clear() None[source]

Clear the contents

count(x: str) int[source]

Return the number of times x appears in the list

extend(L: Vector_string) None
extend(L: Iterable) None

Helper for @overload to raise when called.

insert(i: int, x: str) None[source]

Insert an item at a given position.

pop() str
pop(i: int) str

Helper for @overload to raise when called.

remove(x: str) None[source]

Remove the first item from the list whose value is x. It is an error if there is no such item.

size() int[source]

Data Containers

amrex::Array4<T> is implemented for many floating point and integer types, e.g.,

class amrex.space3d.Array4_double[source]
class amrex.space3d.Array4_double(arg0: Array4_double)
class amrex.space3d.Array4_double(arg0: Array4_double, arg1: int)
class amrex.space3d.Array4_double(arg0: Array4_double, arg1: int, arg2: int)
class amrex.space3d.Array4_double(arg0: numpy.ndarray[numpy.float64])
contains(arg0: int, arg1: int, arg2: int) bool[source]
property nComp: int
property num_comp: int
property size: int
to_cupy(copy=False, order='F')[source]

Provide a Cupy view into an Array4.

Note on the order of indices: By default, this is as in AMReX in Fortran contiguous order, indexing as x,y,z. This has performance implications for use in external libraries such as cupy. The order=”C” option will index as z,y,x and perform better with cupy. https://github.com/AMReX-Codes/pyamrex/issues/55#issuecomment-1579610074

Parameters

selfamrex.Array4_*

An Array4 class in pyAMReX

copybool, optional

Copy the data if true, otherwise create a view (default).

orderstring, optional

F order (default) or C. C is faster with external libraries.

Returns

cupy.array

A cupy n-dimensional array.

Raises

ImportError

Raises an exception if cupy is not installed

to_host() ndarray[float64][source]
to_numpy(copy=False, order='F')[source]

Provide a Numpy view into an Array4.

Note on the order of indices: By default, this is as in AMReX in Fortran contiguous order, indexing as x,y,z. This has performance implications for use in external libraries such as cupy. The order=”C” option will index as z,y,x and perform better with cupy. https://github.com/AMReX-Codes/pyamrex/issues/55#issuecomment-1579610074

Parameters

selfamrex.Array4_*

An Array4 class in pyAMReX

copybool, optional

Copy the data if true, otherwise create a view (default).

orderstring, optional

F order (default) or C. C is faster with external libraries.

Returns

np.array

A numpy n-dimensional array.

class amrex.space3d.BaseFab_Real[source]
class amrex.space3d.BaseFab_Real(arg0: Arena)
class amrex.space3d.BaseFab_Real(arg0: Box, arg1: int, arg2: Arena)
class amrex.space3d.BaseFab_Real(arg0: Box, arg1: int, arg2: float)
class amrex.space3d.BaseFab_Real(arg0: Box, arg1: int, arg2: float)
class amrex.space3d.BaseFab_Real(arg0: Array4_double)
class amrex.space3d.BaseFab_Real(arg0: Array4_double, arg1: IndexType)
class amrex.space3d.BaseFab_Real(arg0: Array4_double_const)
class amrex.space3d.BaseFab_Real(arg0: Array4_double_const, arg1: IndexType)
array() Array4_double[source]
big_end() IntVect[source]
box() Box[source]
clear() None[source]
const_array() Array4_double_const[source]
hi_vect() int[source]
is_allocated() bool[source]
length() IntVect[source]
lo_vect() int[source]
n_bytes() int
n_bytes(arg0: Box, arg1: int) int

Helper for @overload to raise when called.

n_bytes_owned() int[source]
n_comp() int[source]
num_pts() int[source]
resize(arg0: Box, arg1: int, arg2: Arena) None[source]
size() int[source]
small_end() IntVect[source]
to_host() BaseFab_Real[source]
class amrex.space3d.FArrayBox[source]
class amrex.space3d.FArrayBox(arg0: Arena)
class amrex.space3d.FArrayBox(arg0: Box, arg1: int, arg2: Arena)
class amrex.space3d.FArrayBox(arg0: Box, arg1: int, arg2: bool, arg3: bool, arg4: Arena)
class amrex.space3d.FArrayBox(arg0: Box, arg1: int, arg2: float)
class amrex.space3d.FArrayBox(arg0: Box, arg1: int, arg2: float)
class amrex.space3d.FArrayBox(arg0: Array4_double)
class amrex.space3d.FArrayBox(arg0: Array4_double, arg1: IndexType)
class amrex.space3d.FArrayBox(arg0: Array4_double_const)
class amrex.space3d.FArrayBox(arg0: Array4_double_const, arg1: IndexType)
class amrex.space3d.MultiFab[source]
class amrex.space3d.MultiFab(arg0: BoxArray, arg1: DistributionMapping, arg2: int, arg3: int)
class amrex.space3d.MultiFab(arg0: BoxArray, arg1: DistributionMapping, arg2: int, arg3: int, arg4: MFInfo)
class amrex.space3d.MultiFab(arg0: BoxArray, arg1: DistributionMapping, arg2: int, arg3: IntVect)
class amrex.space3d.MultiFab(arg0: BoxArray, arg1: DistributionMapping, arg2: int, arg3: IntVect, arg4: MFInfo)
abs(arg0: int, arg1: int) None
abs(arg0: int, arg1: int, arg2: int) None

Helper for @overload to raise when called.

static add(arg0: MultiFab, arg1: MultiFab, arg2: int, arg3: int, arg4: int, arg5: int) None
static add(arg0: MultiFab, arg1: MultiFab, arg2: int, arg3: int, arg4: int, arg5: IntVect) None

Helper for @overload to raise when called.

static add_product(arg0: MultiFab, arg1: MultiFab, arg2: int, arg3: MultiFab, arg4: int, arg5: int, arg6: int, arg7: int) None
static add_product(arg0: MultiFab, arg1: MultiFab, arg2: int, arg3: MultiFab, arg4: int, arg5: int, arg6: int, arg7: IntVect) None

Helper for @overload to raise when called.

average_sync(arg0: Periodicity) None[source]
box_array() BoxArray[source]
contains_inf(arg0: bool) bool
contains_inf(arg0: int, arg1: int, arg2: int, arg3: bool) bool
contains_inf(arg0: int, arg1: int, arg2: IntVect, arg3: bool) bool

Helper for @overload to raise when called.

contains_nan(arg0: bool) bool
contains_nan(arg0: int, arg1: int, arg2: int, arg3: bool) bool
contains_nan(arg0: int, arg1: int, arg2: IntVect, arg3: bool) bool

Helper for @overload to raise when called.

static copy(dst: MultiFab, src: MultiFab, srccomp: int, dstcomp: int, numcomp: int, nghost: int) None
static copy(dst: MultiFab, src: MultiFab, srccomp: int, dstcomp: int, numcomp: int, nghost: IntVect) None

Helper for @overload to raise when called.

divi(arg0: MultiFab, arg1: int, arg2: int, arg3: int) None[source]
static divide(arg0: MultiFab, arg1: MultiFab, arg2: int, arg3: int, arg4: int, arg5: int) None
static divide(arg0: MultiFab, arg1: MultiFab, arg2: int, arg3: int, arg4: int, arg5: IntVect) None

Helper for @overload to raise when called.

dm() DistributionMapping[source]
static dot(arg0: MultiFab, arg1: int, arg2: MultiFab, arg3: int, arg4: int, arg5: int, arg6: bool) float
static dot(arg0: MultiFab, arg1: int, arg2: int, arg3: int, arg4: bool) float

Helper for @overload to raise when called.

static finalize() None[source]
static initialize() None[source]
invert(arg0: float, arg1: int) None
invert(arg0: float, arg1: int, arg2: int) None
invert(arg0: float, arg1: int, arg2: int, arg3: int) None
invert(arg0: float, arg1: Box, arg2: int) None
invert(arg0: float, arg1: Box, arg2: int, arg3: int, arg4: int) None

Helper for @overload to raise when called.

static lin_comb(arg0: MultiFab, arg1: float, arg2: MultiFab, arg3: int, arg4: float, arg5: MultiFab, arg6: int, arg7: int, arg8: int, arg9: int) None[source]
max(comp: int = 0, nghost: int = 0, local: bool = False) float
max(region: Box, comp: int = 0, nghost: int = 0, local: bool = False) float

Helper for @overload to raise when called.

maxIndex(arg0: int, arg1: int) IntVect[source]
min(comp: int = 0, nghost: int = 0, local: bool = False) float
min(region: Box, comp: int = 0, nghost: int = 0, local: bool = False) float

Helper for @overload to raise when called.

minIndex(arg0: int, arg1: int) IntVect[source]
minus(arg0: MultiFab, arg1: int, arg2: int, arg3: int) None[source]
mult(arg0: float, arg1: int) None
mult(arg0: float, arg1: int, arg2: int) None
mult(arg0: float, arg1: int, arg2: int, arg3: int) None
mult(arg0: float, arg1: Box, arg2: int) None
mult(arg0: float, arg1: Box, arg2: int, arg3: int, arg4: int) None

Helper for @overload to raise when called.

static multiply(arg0: MultiFab, arg1: MultiFab, arg2: int, arg3: int, arg4: int, arg5: int) None
static multiply(arg0: MultiFab, arg1: MultiFab, arg2: int, arg3: int, arg4: int, arg5: IntVect) None

Helper for @overload to raise when called.

property n_comp: int
property n_grow_vect: IntVect
negate(arg0: int) None
negate(arg0: int, arg1: int, arg2: int) None
negate(arg0: Box, arg1: int) None
negate(arg0: Box, arg1: int, arg2: int, arg3: int) None

Helper for @overload to raise when called.

norm0(arg0: int, arg1: int, arg2: bool, arg3: bool) float[source]
norm1(arg0: int, arg1: Periodicity, arg2: bool) float
norm1(arg0: int, arg1: int, arg2: bool) float
norm1(arg0: Vector_int, arg1: int, arg2: bool) Vector_Real

Helper for @overload to raise when called.

norm2(arg0: int) float
norm2(arg0: int, arg1: Periodicity) float
norm2(arg0: Vector_int) Vector_Real

Helper for @overload to raise when called.

norminf(arg0: int, arg1: int, arg2: bool, arg3: bool) float[source]
plus(arg0: float, arg1: int) None
plus(arg0: float, arg1: int, arg2: int) None
plus(arg0: float, arg1: int, arg2: int, arg3: int) None
plus(arg0: float, arg1: Box, arg2: int) None
plus(arg0: float, arg1: Box, arg2: int, arg3: int, arg4: int) None
plus(arg0: MultiFab, arg1: int, arg2: int, arg3: int) None

Helper for @overload to raise when called.

static saxpy(arg0: MultiFab, arg1: float, arg2: MultiFab, arg3: int, arg4: int, arg5: int, arg6: int) None[source]
set_val(arg0: float) None
set_val(arg0: float, arg1: int, arg2: int) None
set_val(arg0: float, arg1: int, arg2: int, arg3: int) None
set_val(arg0: float, arg1: int, arg2: int, arg3: IntVect) None

Helper for @overload to raise when called.

static subtract(arg0: MultiFab, arg1: MultiFab, arg2: int, arg3: int, arg4: int, arg5: int) None
static subtract(arg0: MultiFab, arg1: MultiFab, arg2: int, arg3: int, arg4: int, arg5: IntVect) None

Helper for @overload to raise when called.

sum(comp: int = 0, local: bool = False) float[source]

Returns the sum of component ‘comp’ over the MultiFab – no ghost cells are included.

sum_unique(comp: int = 0, local: bool = False, period: Periodicity = Ellipsis) float[source]

Same as sum with local=false, but for non-cell-centered data, thisskips non-unique points that are owned by multiple boxes.

static swap(arg0: MultiFab, arg1: MultiFab, arg2: int, arg3: int, arg4: int, arg5: int) None
static swap(arg0: MultiFab, arg1: MultiFab, arg2: int, arg3: int, arg4: int, arg5: IntVect) None

Helper for @overload to raise when called.

to_cupy(copy=False, order='F')[source]

Provide a Cupy view into a MultiFab.

Note on the order of indices: By default, this is as in AMReX in Fortran contiguous order, indexing as x,y,z. This has performance implications for use in external libraries such as cupy. The order=”C” option will index as z,y,x and perform better with cupy. https://github.com/AMReX-Codes/pyamrex/issues/55#issuecomment-1579610074

Parameters

selfamrex.MultiFab

A MultiFab class in pyAMReX

copybool, optional

Copy the data if true, otherwise create a view (default).

orderstring, optional

F order (default) or C. C is faster with external libraries.

Returns

list of cupy.array

A list of cupy n-dimensional arrays, for each local block in the MultiFab.

Raises

ImportError

Raises an exception if cupy is not installed

to_numpy(copy=False, order='F')[source]

Provide a Numpy view into a MultiFab.

Note on the order of indices: By default, this is as in AMReX in Fortran contiguous order, indexing as x,y,z. This has performance implications for use in external libraries such as cupy. The order=”C” option will index as z,y,x and perform better with cupy. https://github.com/AMReX-Codes/pyamrex/issues/55#issuecomment-1579610074

Parameters

selfamrex.MultiFab

A MultiFab class in pyAMReX

copybool, optional

Copy the data if true, otherwise create a view (default).

orderstring, optional

F order (default) or C. C is faster with external libraries.

Returns

list of numpy.array

A list of numpy n-dimensional arrays, for each local block in the MultiFab.

weighted_sync(arg0: MultiFab, arg1: Periodicity) None[source]
static xpay(arg0: MultiFab, arg1: float, arg2: MultiFab, arg3: int, arg4: int, arg5: int, arg6: int) None[source]
class amrex.space3d.MFInfo[source]
alloc: bool
arena: Arena
set_alloc(arg0: bool) MFInfo[source]
set_arena(arg0: Arena) MFInfo[source]
set_tag(arg0: str) None[source]
tags: Vector_string
class amrex.space3d.MFIter(arg0: FabArrayBase)[source]
class amrex.space3d.MFIter(arg0: MultiFab)
fabbox() Box[source]
grownnodaltilebox(int: int = -1, ng: int = -1000000) Box
grownnodaltilebox(int: int, ng: IntVect) Box

Helper for @overload to raise when called.

growntilebox(ng: IntVect = -1000000) Box[source]
property index: int
property is_valid: bool
property length: int
nodaltilebox(dir: int = -1) Box[source]
tilebox() Box
tilebox(arg0: IntVect) Box
tilebox(arg0: IntVect, arg1: IntVect) Box

Helper for @overload to raise when called.

validbox() Box[source]

amrex::PODVector<T, Allocator> is implemented for many allocators, e.g.,

class amrex.space3d.PODVector_real_arena[source]
class amrex.space3d.PODVector_real_arena(size: int)
class amrex.space3d.PODVector_real_arena(other: PODVector_real_arena)
capacity() int[source]
clear() None[source]
empty() bool[source]
pop_back() None[source]
push_back(arg0: float) None[source]
reserve(arg0: int) None[source]
resize(arg0: int) None
resize(arg0: int, arg1: float) None

Helper for @overload to raise when called.

shrink_to_fit() None[source]
size() int[source]
to_cupy(copy=False)[source]

Provide a Cupy view into a PODVector (e.g., RealVector, IntVector).

Parameters

selfamrex.PODVector_*

A PODVector class in pyAMReX

copybool, optional

Copy the data if true, otherwise create a view (default).

Returns

cupy.array

A 1D cupy array.

Raises

ImportError

Raises an exception if cupy is not installed

to_host() PODVector_real_pinned[source]
to_numpy(copy=False)[source]

Provide a Numpy view into a PODVector (e.g., RealVector, IntVector).

Parameters

selfamrex.PODVector_*

A PODVector class in pyAMReX

copybool, optional

Copy the data if true, otherwise create a view (default).

Returns

np.array

A 1D numpy array.

class amrex.space3d.PODVector_int_pinned[source]
class amrex.space3d.PODVector_int_pinned(size: int)
class amrex.space3d.PODVector_int_pinned(other: PODVector_int_pinned)
capacity() int[source]
clear() None[source]
empty() bool[source]
pop_back() None[source]
push_back(arg0: int) None[source]
reserve(arg0: int) None[source]
resize(arg0: int) None
resize(arg0: int, arg1: int) None

Helper for @overload to raise when called.

shrink_to_fit() None[source]
size() int[source]
to_cupy(copy=False)[source]

Provide a Cupy view into a PODVector (e.g., RealVector, IntVector).

Parameters

selfamrex.PODVector_*

A PODVector class in pyAMReX

copybool, optional

Copy the data if true, otherwise create a view (default).

Returns

cupy.array

A 1D cupy array.

Raises

ImportError

Raises an exception if cupy is not installed

to_host() PODVector_int_pinned[source]
to_numpy(copy=False)[source]

Provide a Numpy view into a PODVector (e.g., RealVector, IntVector).

Parameters

selfamrex.PODVector_*

A PODVector class in pyAMReX

copybool, optional

Copy the data if true, otherwise create a view (default).

Returns

np.array

A 1D numpy array.

Utility

class amrex.space3d.ParmParse(prefix: str = '')[source]
add(arg0: str, arg1: bool) None
add(arg0: str, arg1: int) None
add(arg0: str, arg1: int) None
add(arg0: str, arg1: int) None
add(arg0: str, arg1: float) None
add(arg0: str, arg1: float) None
add(arg0: str, arg1: str) None
add(arg0: str, arg1: IntVect) None
add(arg0: str, arg1: Box) None

Helper for @overload to raise when called.

addarr(arg0: str, arg1: list[int]) None
addarr(arg0: str, arg1: list[int]) None
addarr(arg0: str, arg1: list[int]) None
addarr(arg0: str, arg1: list[float]) None
addarr(arg0: str, arg1: list[float]) None
addarr(arg0: str, arg1: list[str]) None
addarr(arg0: str, arg1: list[IntVect]) None
addarr(arg0: str, arg1: list[Box]) None

Helper for @overload to raise when called.

static addfile(arg0: str) None[source]
get_bool(name: str, ival: int = 0) bool[source]

parses input values

get_int(name: str, ival: int = 0) int[source]

parses input values

get_real(name: str, ival: int = 0) float[source]

parses input values

query_int(name: str, ival: int = 0) tuple[bool, int][source]

queries input values

remove(arg0: str) int[source]
amrex.space3d.Print(*args, **kwargs)[source]

Wrap amrex::Print() - only the IO processor writes

amrex.space3d.d_decl(x, y, z)[source]

Return a tuple of the three passed elements

amrex.space3d.concatenate(root: str, num: int, mindigits: int = 5) str[source]

Builds plotfile name

amrex.space3d.write_single_level_plotfile(plotfilename: str, mf: MultiFab, varnames: Vector_string, geom: Geometry, time: float, level_step: int, versionName: str = 'HyperCLaw-V1.1', levelPrefix: str = 'Level_', mfPrefix: str = 'Cell', extra_dirs: Vector_string = Ellipsis) None[source]

Writes single level plotfile

AmrCore

class amrex.space3d.AmrInfo[source]
blocking_factor(arg0: int) IntVect[source]
check_input: bool
grid_eff: float
iterate_on_new_grids: bool
max_grid_size(arg0: int) IntVect[source]
max_level: int
n_error_buf(arg0: int) IntVect[source]
n_proper: int
ref_ratio(arg0: int) IntVect[source]
refine_grid_layout: bool
refine_grid_layout_dims: IntVect
use_fixed_coarse_grids: bool
use_fixed_upto_level: int
use_new_chop: bool
verbose: int
class amrex.space3d.AmrMesh[source]
class amrex.space3d.AmrMesh(rb: RealBox, max_level_in: int, n_cell_in: Vector_int, coord: int, ref_ratios: Vector_IntVect, is_per: Annotated[list[int], pybind11_stubgen.typing_ext.FixedSize(3)])
property finest_level: int
property max_level: int
ref_ratio() Vector_IntVect
ref_ratio(arg0: int) IntVect

Helper for @overload to raise when called.

property verbose: int

Particles

Particle support is implemented for both legacy (AoS+SoA) and pure SoA particle memory layouts in AMReX. Additional runtime attributes (Real or Int) are always in SoA memory layout.

amrex::StructOfArrays<NReal, NInt, Allocator> is implemented for many numbers of Real and Int arguments, and allocators, e.g.,

amrex::ParticleTile<T_ParticleType, NArrayReal, NArrayInt, Allocator> is implemented for both legacy (AoS+SoA) and pure SoA particle types, many number of Real and Int arguments, and allocators, e.g.,

amrex::ParticleTileData<T_ParticleType, NArrayReal> is implemented for both legacy (AoS+SoA) and pure SoA particle types, many number of Real and Int arguments, e.g.,

amrex::ParticleContainer_impl<ParticleType, T_NArrayReal, T_NArrayInt, Allocator> is implemented for both legacy (AoS+SoA) and pure SoA particle types, many number of Real and Int arguments, and allocators, e.g.,

class amrex.space3d.ParticleContainer_1_1_2_1_default[source]
class amrex.space3d.ParticleContainer_1_1_2_1_default(arg0: Geometry, arg1: DistributionMapping, arg2: BoxArray)
class amrex.space3d.ParticleContainer_1_1_2_1_default(arg0: Vector_Geometry, arg1: Vector_DistributionMapping, arg2: Vector_BoxArray, arg3: Vector_int)
class amrex.space3d.ParticleContainer_1_1_2_1_default(arg0: Vector_Geometry, arg1: Vector_DistributionMapping, arg2: Vector_BoxArray, arg3: Vector_IntVect)
AddParticlesAtLevel(particles: ParticleTile_1_1_2_1_default, level: int, ngrow: int = 0) None[source]
ByteSpread() list[int][source]
Define(arg0: Geometry, arg1: DistributionMapping, arg2: BoxArray) None
Define(arg0: Vector_Geometry, arg1: Vector_DistributionMapping, arg2: Vector_BoxArray, arg3: Vector_int) None
Define(arg0: Vector_Geometry, arg1: Vector_DistributionMapping, arg2: Vector_BoxArray, arg3: Vector_IntVect) None

Helper for @overload to raise when called.

GetParticles(level: int) dict[tuple[int, int], amrex.space3d.amrex_3d_pybind.ParticleTile_1_1_2_1_default][source]
Increment(arg0: MultiFab, arg1: int) None[source]
InitOnePerCell(arg0: float, arg1: float, arg2: float, arg3: ParticleInitType_1_1_2_1) None[source]
InitRandom(arg0: int, arg1: int, arg2: ParticleInitType_1_1_2_1, arg3: bool, arg4: RealBox) None[source]
InitRandomPerBox(arg0: int, arg1: int, arg2: ParticleInitType_1_1_2_1) None[source]
NArrayInt: ClassVar[int] = 1
NArrayReal: ClassVar[int] = 2
NStructInt: ClassVar[int] = 1
NStructReal: ClassVar[int] = 1
NumberOfParticlesAtLevel(level: int, only_valid: bool = True, only_local: bool = False) int[source]
NumberOfParticlesInGrid(level: int, only_valid: bool = True, only_local: bool = False) Vector_Long[source]
OK(lev_min: int = 0, lev_max: int = -1, nGrow: int = 0) bool[source]
PrintCapacity() list[int][source]
Redistribute(lev_min: int = 0, lev_max: int = -1, nGrow: int = 0, local: int = 0, remove_negative: bool = True) None[source]
RemoveParticlesAtLevel(arg0: int) None[source]
RemoveParticlesNotAtFinestLevel() None[source]
ShrinkToFit() None[source]
SortParticlesByBin(arg0: IntVect) None[source]
SortParticlesByCell() None[source]
TotalNumberOfParticles(only_valid: bool = True, only_local: bool = False) int[source]
clearParticles() None[source]
const_iterator

alias of ParConstIter_1_1_2_1_default

property finest_level: int
is_soa_particle: ClassVar[bool] = False
iterator

alias of ParIter_1_1_2_1_default

numLocalTilesAtLevel(arg0: int) int[source]
property num_int_comps: int

The number of compile-time and runtime int components in SoA

property num_real_comps: int

The number of compile-time and runtime Real components in SoA

property num_runtime_int_comps: int

The number of runtime Int components in SoA

property num_runtime_real_comps: int

The number of runtime Real components in SoA

reserve_data() None[source]
resize_data() None[source]
to_df(local=True, comm=None, root_rank=0)[source]

Copy all particles into a pandas.DataFrame

Parameters

selfamrex.ParticleContainer_*

A ParticleContainer class in pyAMReX

localbool

MPI rank-local particles only

commMPI Communicator

if local is False, this defaults to mpi4py.MPI.COMM_WORLD

root_rankMPI root rank to gather to

if local is False, this defaults to 0

Returns

A concatenated pandas.DataFrame with particles from all levels.

Returns None if no particles were found. If local=False, then all ranks but the root_rank will return None.

class amrex.space3d.ParticleContainer_pureSoA_8_0_default[source]
class amrex.space3d.ParticleContainer_pureSoA_8_0_default(arg0: Geometry, arg1: DistributionMapping, arg2: BoxArray)
class amrex.space3d.ParticleContainer_pureSoA_8_0_default(arg0: Vector_Geometry, arg1: Vector_DistributionMapping, arg2: Vector_BoxArray, arg3: Vector_int)
class amrex.space3d.ParticleContainer_pureSoA_8_0_default(arg0: Vector_Geometry, arg1: Vector_DistributionMapping, arg2: Vector_BoxArray, arg3: Vector_IntVect)
AddParticlesAtLevel(particles: ParticleTile_pureSoA_0_0_8_0_default, level: int, ngrow: int = 0) None[source]
ByteSpread() list[int][source]
Define(arg0: Geometry, arg1: DistributionMapping, arg2: BoxArray) None
Define(arg0: Vector_Geometry, arg1: Vector_DistributionMapping, arg2: Vector_BoxArray, arg3: Vector_int) None
Define(arg0: Vector_Geometry, arg1: Vector_DistributionMapping, arg2: Vector_BoxArray, arg3: Vector_IntVect) None

Helper for @overload to raise when called.

GetParticles(level: int) dict[tuple[int, int], amrex.space3d.amrex_3d_pybind.ParticleTile_pureSoA_0_0_8_0_default][source]
Increment(arg0: MultiFab, arg1: int) None[source]
NArrayInt: ClassVar[int] = 0
NArrayReal: ClassVar[int] = 8
NStructInt: ClassVar[int] = 0
NStructReal: ClassVar[int] = 0
NumberOfParticlesAtLevel(level: int, only_valid: bool = True, only_local: bool = False) int[source]
NumberOfParticlesInGrid(level: int, only_valid: bool = True, only_local: bool = False) Vector_Long[source]
OK(lev_min: int = 0, lev_max: int = -1, nGrow: int = 0) bool[source]
PrintCapacity() list[int][source]
Redistribute(lev_min: int = 0, lev_max: int = -1, nGrow: int = 0, local: int = 0, remove_negative: bool = True) None[source]
RemoveParticlesAtLevel(arg0: int) None[source]
RemoveParticlesNotAtFinestLevel() None[source]
ShrinkToFit() None[source]
SortParticlesByBin(arg0: IntVect) None[source]
SortParticlesByCell() None[source]
TotalNumberOfParticles(only_valid: bool = True, only_local: bool = False) int[source]
clearParticles() None[source]
const_iterator

alias of ParConstIter_pureSoA_8_0_default

property finest_level: int
is_soa_particle: ClassVar[bool] = True
iterator

alias of ParIter_pureSoA_8_0_default

numLocalTilesAtLevel(arg0: int) int[source]
property num_int_comps: int

The number of compile-time and runtime int components in SoA

property num_real_comps: int

The number of compile-time and runtime Real components in SoA

property num_runtime_int_comps: int

The number of runtime Int components in SoA

property num_runtime_real_comps: int

The number of runtime Real components in SoA

reserve_data() None[source]
resize_data() None[source]
to_df(local=True, comm=None, root_rank=0)[source]

Copy all particles into a pandas.DataFrame

Parameters

selfamrex.ParticleContainer_*

A ParticleContainer class in pyAMReX

localbool

MPI rank-local particles only

commMPI Communicator

if local is False, this defaults to mpi4py.MPI.COMM_WORLD

root_rankMPI root rank to gather to

if local is False, this defaults to 0

Returns

A concatenated pandas.DataFrame with particles from all levels.

Returns None if no particles were found. If local=False, then all ranks but the root_rank will return None.

Likewise for other classes accessible and usable on particle containers:

class amrex.space3d.ParIter_pureSoA_8_0_default(particle_container: ParticleContainer_pureSoA_8_0_default, level: int)[source]
is_soa_particle: ClassVar[bool] = True
class amrex.space3d.ParConstIter_pureSoA_8_0_default(particle_container: ParticleContainer_pureSoA_8_0_default, level: int)[source]
class amrex.space3d.ParticleInitType_1_1_2_1[source]
int_array_data: list[int]
int_struct_data: list[int]
is_soa_particle: ClassVar[bool] = False
real_array_data: list[float]
real_struct_data: list[float]

AoS

This is for the legacy, AoS + SoA particle containers only:

amrex::ArrayOfStructs<T_ParticleType, Allocator> is implemented for many numbers of extra Real and Int arguments, and allocators, e.g.,

class amrex.space3d.ArrayOfStructs_0_0_default[source]
back() Particle_0_0[source]

get back member. Problem!!!!! this is perfo

empty() bool
empty() bool

Helper for @overload to raise when called.

getNumNeighbors() int[source]
numNeighborParticles() int[source]
numParticles() int[source]
numRealParticles() int[source]
numTotalParticles() int[source]
pop_back() None[source]
push_back(arg0: Particle_0_0) None[source]
setNumNeighbors(arg0: int) None[source]
size() int[source]
static test_sizes() None[source]
to_cupy(copy=False)[source]

Provide Cupy views into a ArrayOfStructs.

Parameters

selfamrex.ArrayOfStructs_*

An ArrayOfStructs class in pyAMReX

copybool, optional

Copy the data if true, otherwise create a view (default).

Returns

namedtuple

A tuple with real and int components that are each lists of 1D numpy arrays.

Raises

ImportError

Raises an exception if cupy is not installed

to_host() ArrayOfStructs_0_0_pinned[source]
to_numpy(copy=False)[source]

Provide Numpy views into a ArrayOfStructs.

Parameters

selfamrex.ArrayOfStructs_*

An ArrayOfStructs class in pyAMReX

copybool, optional

Copy the data if true, otherwise create a view (default).

Returns

namedtuple

A tuple with real and int components that are each lists of 1D numpy arrays.

amrex::Particle<T_NReal, T_NInt> is implemented for many numbers of extra Real and Int arguments, e.g.,

class amrex.space3d.Particle_0_0[source]
class amrex.space3d.Particle_0_0(arg0: float, arg1: float, arg2: float)
class amrex.space3d.Particle_0_0(arg0: float, arg1: float, arg2: float, *args)
class amrex.space3d.Particle_0_0(arg0: float, arg1: float, arg2: float, **kwargs)
class amrex.space3d.Particle_0_0(**kwargs)
NInt: ClassVar[int] = 0
NReal: ClassVar[int] = 0
NextID() int
NextID(arg0: int) None

Helper for @overload to raise when called.

cpu() int[source]
get_idata(arg0: int) None
get_idata() None

Helper for @overload to raise when called.

get_rdata(arg0: int) None
get_rdata() None

Helper for @overload to raise when called.

id() int[source]
pos(arg0: int) float
pos() RealVect

Helper for @overload to raise when called.

setPos(arg0: int, arg1: float) None
setPos(arg0: RealVect) None
setPos(arg0: Annotated[list[float], pybind11_stubgen.typing_ext.FixedSize(3)]) None

Helper for @overload to raise when called.

set_idata(arg0: int, arg1: int) None
set_idata(arg0: IntVect) None
set_idata(arg0: Annotated[list[int], pybind11_stubgen.typing_ext.FixedSize(0)]) None

Helper for @overload to raise when called.

set_rdata(arg0: int, arg1: float) None
set_rdata(arg0: RealVect) None
set_rdata(arg0: Annotated[list[float], pybind11_stubgen.typing_ext.FixedSize(0)]) None

Helper for @overload to raise when called.

x: float
y: float
z: float