Hipace
Public Member Functions | Public Attributes | List of all members
openpmd_backend.Backend Class Reference

Public Member Functions

def __init__ (self, filename)
 
def fields_list (self)
 
def species_list (self)
 
def n_levels (self)
 
def get_field_checksum (self, lev, field, test_name)
 
def get_species_attributes (self, species)
 
def get_species_checksum (self, species, attribute)
 

Public Attributes

 dataset
 

Detailed Description

 Use openPMD-viewer as the backend reader to read openPMD files

Constructor & Destructor Documentation

◆ __init__()

def openpmd_backend.Backend.__init__ (   self,
  filename 
)
 Constructor: store the dataset object

Member Function Documentation

◆ fields_list()

def openpmd_backend.Backend.fields_list (   self)
 Return the list of fields defined on the grid

◆ get_field_checksum()

def openpmd_backend.Backend.get_field_checksum (   self,
  lev,
  field,
  test_name 
)
 Calculate the checksum for a given field at a given level in the dataset

◆ get_species_attributes()

def openpmd_backend.Backend.get_species_attributes (   self,
  species 
)
 Return the list of attributes for a given species in the dataset

◆ get_species_checksum()

def openpmd_backend.Backend.get_species_checksum (   self,
  species,
  attribute 
)
 Calculate the checksum for a given attribute of a given species in the dataset

◆ n_levels()

def openpmd_backend.Backend.n_levels (   self)
 Return the number of MR levels in the dataset

◆ species_list()

def openpmd_backend.Backend.species_list (   self)
 Return the list of species in the dataset

Member Data Documentation

◆ dataset

openpmd_backend.Backend.dataset

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