celeritas::AllVolumesView Class Reference

GPU-compatible view of the full volume hierarchy graph. More...

#include <AllVolumesView.hh>

Public Types
Type aliases
using	ParamsRef = NativeCRef< VolumeParamsData >

Public Member Functions
	AllVolumesView (ParamsRef const &params)
	Construct with shared params data.
VolumeId	world () const
	Root volume of the geometry graph.
VolumeInstanceId	world_instance () const
	Enclosing instance of the world volume (null if world is a true root)
VolumeId::size_type	num_volumes () const
	Number of logical volumes (nodes)
VolumeInstanceId::size_type	num_volume_instances () const
	Number of volume instances (edges)
VolumeUniqueInstanceId::size_type	num_unique_instances () const
	Total number of unique root-to-node paths.
VolumeLevelId::size_type	num_volume_levels () const
	Depth of the volume graph (1 for a world with no children)
VolumeId	volume_id (VolumeInstanceId vi_id) const
	Get the logical volume instantiated by a volume instance.
VolumeUniqueInstanceId::size_type	offset (VolumeInstanceId vi_id) const
	Get the precomputed unique-instance offset for a volume instance.
VolumeView	volume (VolumeId vol_id) const
	Construct a VolumeView for the given volume.

Detailed Description

GPU-compatible view of the full volume hierarchy graph.

This provides device-accessible accessors over the complete VolumeParamsData: scalar graph properties (world ID, depth, unique instance count) and instance-to-volume mapping, as well as per-volume VolumeView objects.

Member Function Documentation

num_unique_instances()

VolumeUniqueInstanceId::size_type celeritas::AllVolumesView::num_unique_instances ( ) const

inline

Total number of unique root-to-node paths.

Get the total number of unique root-to-node paths.

num_volume_instances()

VolumeInstanceId::size_type celeritas::AllVolumesView::num_volume_instances ( ) const

inline

Number of volume instances (edges)

Get the number of volume instances.

num_volume_levels()

VolumeLevelId::size_type celeritas::AllVolumesView::num_volume_levels ( ) const

inline

Depth of the volume graph (1 for a world with no children)

Get the depth of the volume graph.

num_volumes()

VolumeId::size_type celeritas::AllVolumesView::num_volumes ( ) const

inline

Number of logical volumes (nodes)

Get the number of logical volumes.

world()

VolumeId celeritas::AllVolumesView::world ( ) const

inline

Root volume of the geometry graph.

Get the root volume of the geometry graph.

world_instance()

VolumeInstanceId celeritas::AllVolumesView::world_instance ( ) const

inline

Enclosing instance of the world volume (null if world is a true root)

Get the enclosing instance of the world volume.

---

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

• AllVolumesView.hh