chrono::particlefactory::ChParticleEventTrigger Class Referenceabstract

Description

BASE class for event triggers for the ChParticleProcessor You can directly use the ready-to-use triggers for common triggering (particle collides with some object, particle inside a box, etc.), or inherit your own class with custom triggering.

#include <ChParticleEventTrigger.h>

Inheritance diagram for chrono::particlefactory::ChParticleEventTrigger:

Public Member Functions

virtual bool TriggerEvent (std::shared_ptr< ChBody > mbody, ChSystem &msystem)=0
 Children classes MUST implement this. More...
 
virtual void SetupPreProcess (ChSystem &msystem)
 Children classes might optionally implement this. More...
 
virtual void SetupPostProcess (ChSystem &msystem)
 Children classes might optionally implement this. More...
 

Member Function Documentation

virtual void chrono::particlefactory::ChParticleEventTrigger::SetupPostProcess ( ChSystem msystem)
virtual

Children classes might optionally implement this.

The ChParticleProcessor will call this once, after each ProcessParticles()

Reimplemented in chrono::particlefactory::ChParticleEventFlowInRectangle.

virtual void chrono::particlefactory::ChParticleEventTrigger::SetupPreProcess ( ChSystem msystem)
virtual

Children classes might optionally implement this.

The ChParticleProcessor will call this once, before each ProcessParticles()

virtual bool chrono::particlefactory::ChParticleEventTrigger::TriggerEvent ( std::shared_ptr< ChBody mbody,
ChSystem msystem 
)
pure virtual

Children classes MUST implement this.

Return true means that a ChParticleProcessEvent must be done, return false means that no ChParticleProcessEvent must be done.

Implemented in chrono::particlefactory::ChParticleEventFlowInRectangle, chrono::particlefactory::ChParticleEventTriggerBox, and chrono::particlefactory::ChParticleEventTriggerNever.