relentless.model.Volume

class relentless.model.Volume

Three-dimensional region of space.

A Volume can be any region of space; typically, it is a simulation “box.” Any deriving class must implement the volume method that computes the scalar volume of the region. Additionally, methods to serialize and deserialize a Volume must be specified so that the object can be saved to disk.

Methods

from_json(data)	Deserialize from a dictionary.
to_json()	Serialize as a dictionary.

Attributes

extent

Extent of the region.

abstract property extent

Extent of the region.

Type:

float

abstract classmethod from_json(data)

Deserialize from a dictionary.

Returns:

The object reconstructed from the data.

Return type:

Extent

abstract to_json()

Serialize as a dictionary.

The serialized data can be saved to file as JSON data.

Returns:

The serialized data.

Return type:

dict