WarpX
Public Member Functions | Public Attributes | List of all members
Checksum.benchmark.Benchmark Class Reference

Public Member Functions

def __init__ (self, test_name, data=None)
 
def reset (self)
 
def get (self)
 

Public Attributes

 test_name
 
 json_file
 
 data
 

Detailed Description

Holds data and functions for referenc benchmark of one checksum test.

Constructor & Destructor Documentation

◆ __init__()

def Checksum.benchmark.Benchmark.__init__ (   self,
  test_name,
  data = None 
)
Benchmark constructor.
Store test name and reference checksum value, either from benchmark
(used for comparison) or from a plotfile (used to reset a benchmark).

Parameters
----------
test_name: string
    Name of test, as found between [] in .ini file.

data: dictionary, optional
    Checksum value.
    If None, it is read from benchmark.

Member Function Documentation

◆ get()

def Checksum.benchmark.Benchmark.get (   self)
Read benchmark from reference json file.

◆ reset()

def Checksum.benchmark.Benchmark.reset (   self)
Update the benchmark (overwrites reference json file).

Member Data Documentation

◆ data

Checksum.benchmark.Benchmark.data

◆ json_file

Checksum.benchmark.Benchmark.json_file

◆ test_name

Checksum.benchmark.Benchmark.test_name

The documentation for this class was generated from the following file: