About the IOM_plugin_energy class
The WaveBlocks Project
@author: R. Bourquin
@copyright: Copyright (C) 2010, 2011, 2012 R. Bourquin
@license: Modified BSD License
Class documentation
The WaveBlocks Project
IOM plugin providing functions for handling energy data.
@author: R. Bourquin
@copyright: Copyright (C) 2010, 2011 R. Bourquin
@license: Modified BSD License
-
IOM_plugin_energy.delete_energy(self, blockid=0)[source]
Remove the stored energies
-
IOM_plugin_energy.has_energy(self, blockid=0)[source]
Ask if the specified data block has the desired data tensor.
-
IOM_plugin_energy.save_energy(self, energies, timestep=None, blockid=0)[source]
Save the kinetic and potential energies to a file.
| Parameters: | energies – A tuple (ekin, epot) containing the energies. |
|---|
-
IOM_plugin_energy.save_energy_total(self, total_energy, timestep=None, blockid=0)[source]
Save the total to a file.
| Parameters: | total_energy – An array containing a time series of the total energy. |
|---|