IOM_plugin_norm

About the IOM_plugin_norm class

The WaveBlocks Project

@author: R. Bourquin @copyright: Copyright (C) 2010, 2011, 2012, 2013, 2014, 2015, 2016 R. Bourquin @license: Modified BSD License

Class documentation

The WaveBlocks Project

IOM plugin providing functions for handling norm data.

@author: R. Bourquin @copyright: Copyright (C) 2010, 2011, 2012, 2013 R. Bourquin @license: Modified BSD License

IOM_plugin_norm.add_norm(self, parameters, timeslots=None, blockid=0)[source]

Add storage for the norms.

Parameters:
  • parameters – A ParameterProvider instance containing at least the key ncomponents.
  • timeslots – The number of time slots we need. Can be set to None to get automatically growing datasets.
  • blockid – The ID of the data block to operate on.
IOM_plugin_norm.delete_norm(self, blockid=0)[source]

Remove the stored norms.

Parameters:blockid – The ID of the data block to operate on.
IOM_plugin_norm.has_norm(self, blockid=0)[source]

Ask if the specified data block has the desired data tensor.

Parameters:blockid – The ID of the data block to operate on.
IOM_plugin_norm.load_norm(self, timestep=None, split=False, blockid=0)[source]

Load the norm data.

Parameters:
  • timestep – Load only the data of this timestep.
  • split – Split the data array into one array for each component.
  • blockid – The ID of the data block to operate on.
IOM_plugin_norm.load_norm_timegrid(self, blockid=0)[source]

Load the timegrid corresponding to the norm data.

Parameters:blockid – The ID of the data block to operate on.
IOM_plugin_norm.save_norm(self, norm, timestep=None, blockid=0)[source]

Save the norm of wavefunctions or wavepackets.

Parameters:
  • norm – The norm values to save.
  • timestep – The timestep at which we save the data.
  • blockid – The ID of the data block to operate on.