yt.lagos.AMRCylinderBase

class yt.lagos.AMRCylinderBase(center, normal, radius, height, fields=None, pf=None, **kwargs)

We can define a cylinder (or disk) to act as a data object.

Methods

clear_cache() Clears out all cache, freeing memory.
clear_data() Clears out all data from the AMRData instance, freeing memory.
convert(datatype) This will attempt to convert a given unit to cgs from code units.
cut_region(field_cuts) Return an InLineExtractedRegion, where the grid cells are cut on the
extract_connected_sets(field, num_levels, ...) This function will create a set of contour objects, defined
extract_region(indices) Return an ExtractedRegion where the points contained in it are defined
get_data([fields, in_grids, force_particle_read])
get_field_parameter(name[, default]) This is typically only used by derived field functions, but
has_field_parameter(name) Checks if a field parameter is set.
has_key(key) Checks if a data field already exists.
keys()
paint_grids(field, value[, default_value]) This function paints every cell in our dataset with a given value.
save_object(name[, filename]) Save an object.
select_grid_indices(level)
select_grids(level) Return all grids on a given level.
set_field_parameter(name, val) Here we set up dictionaries that get passed up and down and ultimately
volume([unit]) Return the volume of the cylinder in units of unit.
write_out(filename[, fields, format])

By providing a center, a normal, a radius and a height we can define a cylinder of any proportion. Only cells whose centers are within the cylinder will be selected.

Methods

clear_cache() Clears out all cache, freeing memory.
clear_data() Clears out all data from the AMRData instance, freeing memory.
convert(datatype) This will attempt to convert a given unit to cgs from code units.
cut_region(field_cuts) Return an InLineExtractedRegion, where the grid cells are cut on the
extract_connected_sets(field, num_levels, ...) This function will create a set of contour objects, defined
extract_region(indices) Return an ExtractedRegion where the points contained in it are defined
get_data([fields, in_grids, force_particle_read])
get_field_parameter(name[, default]) This is typically only used by derived field functions, but
has_field_parameter(name) Checks if a field parameter is set.
has_key(key) Checks if a data field already exists.
keys()
paint_grids(field, value[, default_value]) This function paints every cell in our dataset with a given value.
save_object(name[, filename]) Save an object.
select_grid_indices(level)
select_grids(level) Return all grids on a given level.
set_field_parameter(name, val) Here we set up dictionaries that get passed up and down and ultimately
volume([unit]) Return the volume of the cylinder in units of unit.
write_out(filename[, fields, format])

Previous topic

yt.lagos.AMRCuttingPlaneBase.write_out

Next topic

yt.lagos.AMRCylinderBase.clear_cache

This Page