dolfinx.cpp.common

Common module

Classes

IndexMap(, order=, writable=False], ...)	Overloaded function.
Reduction(*values)
Scatterer(self, index_map)
Timer(self, task)	Timer class

class dolfinx.cpp.common.IndexMap(self, comm: mpi4py.MPI.Comm, local_size: int)

class dolfinx.cpp.common.IndexMap(self, comm: mpi4py.MPI.Comm, local_size: int, ghosts: ndarray[dtype=int64, shape=(*), order='C', writable=False], ghost_owners: ndarray[dtype=int32, shape=(*), order='C', writable=False], tag: int)

class dolfinx.cpp.common.IndexMap(self, comm: mpi4py.MPI.Comm, local_size: int, dest_src: collections.abc.Sequence[ndarray[dtype=int32, shape=(*), order='C', writable=False]], ghosts: ndarray[dtype=int64, shape=(*), order='C', writable=False], ghost_owners: ndarray[dtype=int32, shape=(*), order='C', writable=False])

Bases: object

Overloaded function.

1. __init__(self, comm: mpi4py.MPI.Comm, local_size: int) -> None

2. __init__(self, comm: mpi4py.MPI.Comm, local_size: int, ghosts: ndarray[dtype=int64, shape=(*), order='C', writable=False], ghost_owners: ndarray[dtype=int32, shape=(*), order='C', writable=False], tag: int) -> None

3. __init__(self, comm: mpi4py.MPI.Comm, local_size: int, dest_src: collections.abc.Sequence[ndarray[dtype=int32, shape=(*), order='C', writable=False]], ghosts: ndarray[dtype=int64, shape=(*), order='C', writable=False], ghost_owners: ndarray[dtype=int32, shape=(*), order='C', writable=False]) -> None

Create an IndexMap with explicit neighbour ranks. dest_src contains destination ranks followed by source ranks. ghost_owners[i] owns ghosts[i]; its unique values must equal the source ranks.

property comm

(self) -> mpi4py.MPI.Comm

property ghosts

Return list of ghost indices

global_to_local(self, global_index: ndarray[dtype=int64, shape=(*), order='C', writable=False]) → numpy.ndarray[dtype=int32]

index_to_dest_ranks(self, tag: int) → tuple[numpy.ndarray[dtype=int32], numpy.ndarray[dtype=int32]]

property local_range

Range of indices owned by this map

local_to_global(self, local: ndarray[dtype=int32, shape=(*), order='C', writable=False]) → numpy.ndarray[dtype=int64]

property num_ghosts

(self) -> int

property owners

(self) -> numpy.ndarray[dtype=int32, shape=(*), writable=False]

property size_global

(self) -> int

property size_local

(self) -> int

class dolfinx.cpp.common.Reduction(*values)

Bases: Enum

average = 0

max = 1

min = 2

class dolfinx.cpp.common.Scatterer(self, index_map: dolfinx.cpp.common.IndexMap)

Bases: object

property local_indices_block

Indices of owned data packed/unpacked in a forward/reverse scatter, used to size a caller-provided packing buffer.

property remote_indices_block

Indices of ghost data packed/unpacked in a reverse/forward scatter, used to size a caller-provided packing buffer.

scatter_fwd_begin(self, local_buffer: ndarray[dtype=int64, shape=(*), order='C', writable=False], remote_buffer: ndarray[dtype=int64, shape=(*), order='C'], bs: int) → mpi4py.MPI.Request

scatter_fwd_begin(self, local_buffer: ndarray[dtype=float64, shape=(*), order='C', writable=False], remote_buffer: ndarray[dtype=float64, shape=(*), order='C'], bs: int) → mpi4py.MPI.Request

scatter_fwd_begin(self, local_buffer: ndarray[dtype=float32, shape=(*), order='C', writable=False], remote_buffer: ndarray[dtype=float32, shape=(*), order='C'], bs: int) → mpi4py.MPI.Request

scatter_fwd_begin(self, local_buffer: ndarray[dtype=complex128, shape=(*), order='C', writable=False], remote_buffer: ndarray[dtype=complex128, shape=(*), order='C'], bs: int) → mpi4py.MPI.Request

scatter_fwd_begin(self, local_buffer: ndarray[dtype=complex64, shape=(*), order='C', writable=False], remote_buffer: ndarray[dtype=complex64, shape=(*), order='C'], bs: int) → mpi4py.MPI.Request

scatter_fwd_end(self, request: mpi4py.MPI.Request) → None

scatter_fwd_end(self, request: mpi4py.MPI.Request) → None

scatter_fwd_end(self, request: mpi4py.MPI.Request) → None

scatter_fwd_end(self, request: mpi4py.MPI.Request) → None

scatter_fwd_end(self, request: mpi4py.MPI.Request) → None

scatter_rev_begin(self, remote_buffer: ndarray[dtype=int64, shape=(*), order='C', writable=False], local_buffer: ndarray[dtype=int64, shape=(*), order='C'], bs: int) → mpi4py.MPI.Request

scatter_rev_begin(self, remote_buffer: ndarray[dtype=float64, shape=(*), order='C', writable=False], local_buffer: ndarray[dtype=float64, shape=(*), order='C'], bs: int) → mpi4py.MPI.Request

scatter_rev_begin(self, remote_buffer: ndarray[dtype=float32, shape=(*), order='C', writable=False], local_buffer: ndarray[dtype=float32, shape=(*), order='C'], bs: int) → mpi4py.MPI.Request

scatter_rev_begin(self, remote_buffer: ndarray[dtype=complex128, shape=(*), order='C', writable=False], local_buffer: ndarray[dtype=complex128, shape=(*), order='C'], bs: int) → mpi4py.MPI.Request

scatter_rev_begin(self, remote_buffer: ndarray[dtype=complex64, shape=(*), order='C', writable=False], local_buffer: ndarray[dtype=complex64, shape=(*), order='C'], bs: int) → mpi4py.MPI.Request

scatter_rev_end(self, request: mpi4py.MPI.Request) → None

scatter_rev_end(self, request: mpi4py.MPI.Request) → None

scatter_rev_end(self, request: mpi4py.MPI.Request) → None

scatter_rev_end(self, request: mpi4py.MPI.Request) → None

scatter_rev_end(self, request: mpi4py.MPI.Request) → None

class dolfinx.cpp.common.Timer(self, task: str | None)

Bases: object

Timer class

Create and start timer. Elapsed time is optionally registered in the logger when the Timer destructor is called.

elapsed(self) → datetime.timedelta

Elapsed time

flush(self) → None

Flush timer

resume(self) → None

Resume timer

start(self) → None

Start timer

stop(self) → datetime.timedelta

Stop timer