interface class to include a selection function in Callback::grp_select. More...
#include <callback_utils_select.hpp>
Inheritance diagram for CallbackUtils::select::MultiSelect< AFields, Child >:
Protected Member Functions | |
| virtual bool | this_grp_select (const GrpProperties &grp) const =0 |
Additional Inherited Members | |
 Public Member Functions inherited from Callback< AFields > | |
| virtual bool | grp_chunk (size_t chunk_idx, std::string &fname) const =0 |
| Where to find the group files. | |
| virtual bool | prt_chunk (size_t chunk_idx, std::string &fname) const =0 |
| Where to find the particle files. | |
| virtual std::string | grp_name () const =0 |
| Where to find the group fields in the hdf5 file. | |
| virtual std::string | prt_name () const =0 |
| Where to find the particle fields in the hdf5 file. | |
| virtual void | read_grp_meta_init (std::shared_ptr< H5::H5File > fptr) |
| Allows the user to read meta-data from the 0th group chunk. | |
| virtual void | read_prt_meta_init (std::shared_ptr< H5::H5File > fptr) |
| Allows the user to read meta-data from the 0th particle chunk. | |
| virtual void | read_grp_meta (size_t chunk_idx, std::shared_ptr< H5::H5File > fptr, size_t &Ngroups) const =0 |
| Inform the code how many groups there are in a group chunk. | |
| virtual void | read_prt_meta (size_t chunk_idx, std::shared_ptr< H5::H5File > fptr, coord_t &Bsize, size_t &Nparts) const =0 |
| Inform the code how large the box is and how many particles there are in a particle chunk. | |
| virtual void | grp_action (const GrpProperties &grp)=0 |
| Action to take for each group for which grp_select returned true. | |
| virtual coord_t | grp_radius (const GrpProperties &grp) const =0 |
| Inform the code how large this group is. | |
| virtual void | prt_action (size_t grp_idx, const GrpProperties &grp, const PrtProperties &prt, coord_t Rsq)=0 |
| Action to take for each particle that falls within grp_radius from a group. | |
| virtual coord_t | prt_coord_rescale () const |
| Rescaling of particle coordinates. | |
| virtual void | prt_modify (PrtProperties &prt) |
| Modifications to particle properties. | |
Detailed Description
template<typename AFields, typename Child>
class CallbackUtils::select::MultiSelect< AFields, Child >
class CallbackUtils::select::MultiSelect< AFields, Child >
interface class to include a selection function in Callback::grp_select.
- Template Parameters
-
Child the inheriting type
- Note
- Child has to make this class friend.
See CallbackUtils::select::Window for an example.
Member Function Documentation
◆ this_grp_select()
template<typename AFields , typename Child >
|
protectedpure virtual |
The user should override this function with the desired selection that is to be performed on the group's properties.
The documentation for this class was generated from the following file:
