hyperion.grid.CartesianGrid

class hyperion.grid.CartesianGrid(*args)

A cartesian grid.

The grid can be initialized by passing the x, y, and z coordinates of cell walls:

>>> grid = CartesianGrid(x_wall, y_wall, z_wall)

where x_wall, y_wall, and z_wall are 1-d sequences of wall positions. The number of cells in the resulting grid will be one less in each dimension that the length of these arrays.

CartesianGrid objects may contain multiple quantities (e.g. density, specific energy). To access these, you can specify the name of the quantity as an item:

>>> grid['density']

which is no longer a CartesianGrid object, but a CartesianGridView object. When setting this for the first time, this can be set either to another CartesianGridView object, an external h5py link, or an empty list. For example, the following should work:

>>> grid['density_new'] = grid['density']

CartesianGridView objects allow the specific dust population to be selected as an index:

>>> grid['density'][0]

Which is also a CartesianGridView object. The data can then be accessed with the array attribute:

>>> grid['density'][0].array

which is a 3-d array of the requested quantity.

Methods

set_walls(x_wall, y_wall, z_wall)
read(group[, quantities]) Read the geometry and physical quantities from a cartesian grid
read_geometry(group) Read in geometry information from a cartesian grid
read_quantities(group[, quantities]) Read in physical quantities from a cartesian grid
write(group[, quantities, copy, …]) Write out the cartesian grid
write_single_array(group, name, array[, …]) Write out a single quantity, checking for consistency with geometry
add_derived_quantity(name, function)
to_yt([dust_id]) Convert cartesian grid to a yt object (requires yt)

Methods (detail)

set_walls(x_wall, y_wall, z_wall)
read(group, quantities='all')

Read the geometry and physical quantities from a cartesian grid

Parameters:

group : h5py.Group

The HDF5 group to read the grid from. This group should contain groups named ‘Geometry’ and ‘Quantities’.

quantities : ‘all’ or list

Which physical quantities to read in. Use ‘all’ to read in all quantities or a list of strings to read only specific quantities.

read_geometry(group)

Read in geometry information from a cartesian grid

Parameters:

group : h5py.Group

The HDF5 group to read the grid geometry from.

read_quantities(group, quantities='all')

Read in physical quantities from a cartesian grid

Parameters:

group : h5py.Group

The HDF5 group to read the grid quantities from

quantities : ‘all’ or list

Which physical quantities to read in. Use ‘all’ to read in all quantities or a list of strings to read only specific quantities.

write(group, quantities='all', copy=True, absolute_paths=False, compression=True, wall_dtype=<type 'float'>, physics_dtype=<type 'float'>)

Write out the cartesian grid

Parameters:

group : h5py.Group

The HDF5 group to write the grid to

quantities : ‘all’ or list

Which physical quantities to write out. Use ‘all’ to write out all quantities or a list of strings to write only specific quantities.

copy : bool

Whether to copy external links, or leave them as links.

absolute_paths : bool

If copy is False, then this indicates whether to use absolute or relative paths for links.

compression : bool

Whether to compress the arrays in the HDF5 file

wall_dtype : type

The datatype to use to write the wall positions

physics_dtype : type

The datatype to use to write the physical quantities

write_single_array(group, name, array, copy=True, absolute_paths=False, compression=True, physics_dtype=<type 'float'>)

Write out a single quantity, checking for consistency with geometry

Parameters:

group : h5py.Group

The HDF5 group to write the grid to

name : str

The name of the array in the group

array : np.ndarray

The array to write out

copy : bool

Whether to copy external links, or leave them as links.

absolute_paths : bool

If copy is False, then this indicates whether to use absolute or relative paths for links.

compression : bool

Whether to compress the arrays in the HDF5 file

wall_dtype : type

The datatype to use to write the wall positions

physics_dtype : type

The datatype to use to write the physical quantities

add_derived_quantity(name, function)
to_yt(dust_id=0)

Convert cartesian grid to a yt object (requires yt)

This can only be used for regular cartesian grids

Parameters:

dust_id : int, optional

The ID of the dust population to extract. If not set, this defaults to 0 (the first dust population).

class hyperion.grid.CartesianGridView(grid, quantity)

Methods

append(grid) Used to append quantities from another grid
add(grid) Used to add quantities from another grid

Methods (detail)

append(grid)

Used to append quantities from another grid

Parameters:

grid : 3D Numpy array or CartesianGridView instance

The grid to copy the quantity from

add(grid)

Used to add quantities from another grid

Parameters:

grid : 3D Numpy array or CartesianGridView instance

The grid to copy the quantity from