dolfinx.cpp.common

Common module

Functions

init_logging(arg0)

list_timings(arg0, arg1, arg2)

timing(arg0)

Classes

Direction(self, value)

Members:

IndexMap(self, arg0, arg1, arg2, arg3, arg4)

Reduction(self, value)

Members:

ScatterMode(self, value)

Members:

Timer(*args, **kwargs)

Timer class

TimingType(self, value)

Members:

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

Bases: pybind11_builtins.pybind11_object

Members:

forward

reverse

forward = <Direction.forward: 1>
property name
reverse = <Direction.reverse: 0>
property value
class dolfinx.cpp.common.IndexMap(self: dolfinx.cpp.common.IndexMap, arg0: MPICommWrapper, arg1: int, arg2: List[int], arg3: List[int], arg4: List[int]) None

Bases: pybind11_builtins.pybind11_object

comm(self: dolfinx.cpp.common.IndexMap, arg0: dolfinx.cpp.common.Direction) MPICommWrapper

Return MPI communicator

create_submap(self: dolfinx.cpp.common.IndexMap, arg0: numpy.ndarray[numpy.int32]) Tuple[dolfinx.cpp.common.IndexMap, numpy.ndarray[numpy.int32]]
ghost_owners(self: dolfinx.cpp.common.IndexMap) numpy.ndarray[numpy.int32]

Return owning process for each ghost index

property ghosts

Return list of ghost indices

global_indices(self: dolfinx.cpp.common.IndexMap) List[int]
property local_range

Range of indices owned by this map

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

Bases: pybind11_builtins.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.ScatterMode(self: dolfinx.cpp.common.ScatterMode, value: int) None

Bases: pybind11_builtins.pybind11_object

Members:

add

insert

add = <ScatterMode.add: 1>
insert = <ScatterMode.insert: 0>
property name
property value
class dolfinx.cpp.common.Timer(*args, **kwargs)

Bases: pybind11_builtins.pybind11_object

Timer class

Overloaded function.

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

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

elapsed(self: dolfinx.cpp.common.Timer) List[float[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) None

Bases: pybind11_builtins.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(arg0: List[str]) None
dolfinx.cpp.common.list_timings(arg0: MPICommWrapper, arg1: List[dolfinx.cpp.common.TimingType], arg2: dolfinx.cpp.common.Reduction) None
dolfinx.cpp.common.timing(arg0: str) Tuple[int, float, float, float]