dolfinx.cpp.common

Common module

Functions

init_logging(args)

list_timings(comm, type, reduction)

timing(arg0)

Classes

IndexMap(*args, **kwargs)

Overloaded function.

Reduction(self, value)

Members:

Timer(*args, **kwargs)

Timer class

TimingType(self, value)

Members:
class dolfinx.cpp.common.IndexMap(*args, **kwargs)

Bases: pybind11_object

Overloaded function.

  1. __init__(self: dolfinx.cpp.common.IndexMap, comm: MPICommWrapper, local_size: int) -> None

  2. __init__(self: dolfinx.cpp.common.IndexMap, comm: MPICommWrapper, local_size: int, ghosts: numpy.ndarray[numpy.int64], ghost_owners: numpy.ndarray[numpy.int32]) -> None

  3. __init__(self: dolfinx.cpp.common.IndexMap, comm: MPICommWrapper, local_size: int, dest_src: Annotated[List[numpy.ndarray[numpy.int32]], FixedSize(2)], ghosts: numpy.ndarray[numpy.int64], ghost_owners: numpy.ndarray[numpy.int32]) -> None

property comm
create_submap(self: dolfinx.cpp.common.IndexMap, entities: numpy.ndarray[numpy.int32]) → Tuple[dolfinx.cpp.common.IndexMap, numpy.ndarray[numpy.int32]]
property ghosts

Return list of ghost indices

property imbalance

Imbalance of the current IndexMap.

property index_to_dest_ranks
property local_range

Range of indices owned by this map

local_to_global(self: dolfinx.cpp.common.IndexMap, local: numpy.ndarray[numpy.int32]) → numpy.ndarray[numpy.int64]
property num_ghosts
property owners
property size_global
property size_local
class dolfinx.cpp.common.Reduction(self: dolfinx.cpp.common.Reduction, value: int)

Bases: pybind11_object

Members:

max

min

average

average = <Reduction.average: 0>
max = <Reduction.max: 1>
min = <Reduction.min: 2>
property name
property value
class dolfinx.cpp.common.Timer(*args, **kwargs)

Bases: pybind11_object

Timer class

Overloaded function.

  1. __init__(self: dolfinx.cpp.common.Timer) -> None

  2. __init__(self: dolfinx.cpp.common.Timer, task: str) -> None

elapsed(self: dolfinx.cpp.common.Timer) → Annotated[List[float], FixedSize(3)]
resume(self: dolfinx.cpp.common.Timer) → None
start(self: dolfinx.cpp.common.Timer) → None

Start timer

stop(self: dolfinx.cpp.common.Timer) → float

Stop timer

class dolfinx.cpp.common.TimingType(self: dolfinx.cpp.common.TimingType, value: int)

Bases: pybind11_object

Members:

wall

system

user

property name
system = <TimingType.system: 2>
user = <TimingType.user: 1>
property value
wall = <TimingType.wall: 0>
dolfinx.cpp.common.init_logging(args: List[str]) → None
dolfinx.cpp.common.list_timings(comm: MPICommWrapper, type: List[dolfinx.cpp.common.TimingType], reduction: dolfinx.cpp.common.Reduction) → None
dolfinx.cpp.common.timing(arg0: str) → Tuple[int, float, float, float]