warpy.host_actions.diagnostics_writer.diagnostics_writer Class Reference

Inheritance diagram for warpy.host_actions.diagnostics_writer.diagnostics_writer:

Public Member Functions
def	__init__ (self, name, diagnostics, write_interval, output_file)
def	name (self, stage=None)
def	attrs (self, stage=None)
def	generate (self, start=None, stop=None, stride=1, explode_name=True, explode_args=True)
Public Member Functions inherited from warpy.host_actions.host_action.host_action
def	__init__ (self, name, req_attrs, opt_attrs=None, variables=None)
def	variables (self)

Public Attributes
	diagnostics
Public Attributes inherited from warpy.host_actions.host_action.host_action
	vars_

Constructor & Destructor Documentation

__init__()

def warpy.host_actions.diagnostics_writer.diagnostics_writer.__init__	(		self,
			name,
			diagnostics,
			write_interval,
			output_file
	)

Parameters

name
diagnostics	a dictionary which maps diagnostics with a list of strings containing the names for the samples.
write_interval	the minimum amount of simulation time between successive diagnostic samples. Note that the simulation does not try to adjust timesteps to reach the specified diagnostic write interval.
output_file	Path to the file the diagnostics writer should write to. Note that for relative paths, this is relative to the working directory of WARPXM.

Reimplemented from warpy.host_actions.host_action.host_action.

Member Function Documentation

attrs()

def warpy.host_actions.diagnostics_writer.diagnostics_writer.attrs	(		self,
			stage = None
	)

generate()

def warpy.host_actions.diagnostics_writer.diagnostics_writer.generate	(		self,
			start = None,
			stop = None,
			stride = 1,
			explode_name = True,
			explode_args = True
	)

name()

def warpy.host_actions.diagnostics_writer.diagnostics_writer.name	(		self,
			stage = None
	)

Member Data Documentation

diagnostics

warpy.host_actions.diagnostics_writer.diagnostics_writer.diagnostics

---

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

• tools/warpy/host_actions/diagnostics_writer.py