group_particles
Loading...
Searching...
No Matches
Public Member Functions | List of all members
CallbackUtils::radius::Simple< AFields, RField > Class Template Reference

radius is propertional to one of the group properties. More...

#include <callback_utils_radius.hpp>

Inheritance diagram for CallbackUtils::radius::Simple< AFields, RField >:
Inheritance graph
[legend]

Public Member Functions

 Simple (typename RField::value_type scaling_)
 
 Simple ()
 
- 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 bool grp_select (const GrpProperties &grp) const
 Inform the code whether a group should be considered.
 
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 RField>
class CallbackUtils::radius::Simple< AFields, RField >

radius is propertional to one of the group properties.

Template Parameters
RFieldthe group property the radius is proportional to

Constructor & Destructor Documentation

◆ Simple() [1/2]

template<typename AFields , typename RField >
CallbackUtils::radius::Simple< AFields, RField >::Simple ( typename RField::value_type  scaling_)
inline
Parameters
scalingthe propertionality factor, the group radius is computed as scaling * RField

◆ Simple() [2/2]

template<typename AFields , typename RField >
CallbackUtils::radius::Simple< AFields, RField >::Simple ( )
inline

default constructor sets the proportionality factor to 1.


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