Source code for dolfinx.common

# Copyright (C) 2018 Michal Habera
# This file is part of DOLFINx (
# SPDX-License-Identifier:    LGPL-3.0-or-later
"""General tools for timing and configuration."""

import functools
import typing

from dolfinx import cpp as _cpp
from dolfinx.cpp.common import (

__all__ = [

TimingType = _cpp.common.TimingType
Reduction = _cpp.common.Reduction

def timing(task: str):
    return _cpp.common.timing(task)

def list_timings(comm, timing_types: list, reduction=Reduction.max):
    """Print out a summary of all Timer measurements, with a choice of
    wall time, system time or user time. When used in parallel, a
    reduction is applied across all processes. By default, the maximum
    time is shown."""
    _cpp.common.list_timings(comm, timing_types, reduction)

[docs] class Timer: """A timer can be used for timing tasks. The basic usage is:: with Timer(\"Some costly operation\"): costly_call_1() costly_call_2() or:: with Timer() as t: costly_call_1() costly_call_2() print(\"Elapsed time so far: %s\" % t.elapsed()[0]) The timer is started when entering context manager and timing ends when exiting it. It is also possible to start and stop a timer explicitly by:: t = Timer(\"Some costly operation\") t.start() costly_call() t.stop() and retrieve timing data using:: t.elapsed() Timings are stored globally (if task name is given) and may be printed using functions ``timing``, ``timings``, ``list_timings``, ``dump_timings_to_xml``, e.g.:: list_timings(comm, [TimingType.wall, TimingType.user]) """ _cpp_object: _cpp.common.Timer def __init__(self, name: typing.Optional[str] = None): if name is None: self._cpp_object = _cpp.common.Timer() else: self._cpp_object = _cpp.common.Timer(name) def __enter__(self): self._cpp_object.start() return self def __exit__(self, *args): self._cpp_object.stop()
[docs] def start(self): self._cpp_object.start()
[docs] def stop(self): return self._cpp_object.stop()
[docs] def resume(self): self._cpp_object.resume()
[docs] def elapsed(self): return self._cpp_object.elapsed()
[docs] def timed(task: str): """Decorator for timing functions.""" def decorator(func): @functools.wraps(func) def wrapper(*args, **kwargs): with Timer(task): return func(*args, **kwargs) return wrapper return decorator