tfParticleTimeEvent.h

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of Tissue Forge.
 * Copyright (c) 2022-2024 T.J. Sego
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * 
 ******************************************************************************/

 
#ifndef _SOURCE_EVENT_TFPARTICLETIMEEVENT_H_
#define _SOURCE_EVENT_TFPARTICLETIMEEVENT_H_
 
#include "tfTimeEvent.h"
#include "tfParticleEvent.h"
 
 
namespace TissueForge {
 
 
    struct ParticleType;
 
 
    namespace event { 
 
 
        struct ParticleEvent;
 
        struct ParticleTimeEvent;
 
        using ParticleTimeEventMethod = EventMethodT<ParticleTimeEvent>;
 
        using ParticleTimeEventNextTimeSetter = FloatP_t (*)(ParticleTimeEvent&, const FloatP_t&);

        CPPAPI_FUNC(FloatP_t) particleTimeEventSetNextTimeExponential(ParticleTimeEvent &event, const FloatP_t &time);

        CPPAPI_FUNC(FloatP_t) particleTimeEventSetNextTimeDeterministic(ParticleTimeEvent &event, const FloatP_t &time);
 
        using ParticleTimeEventParticleSelector = ParticleEventParticleSelectorT<ParticleTimeEvent>;

        CPPAPI_FUNC(ParticleHandle*) particleTimeEventParticleSelectorUniform(const ParticleTimeEvent &event);

        CPPAPI_FUNC(ParticleHandle*) particleTimeEventParticleSelectorLargest(const ParticleTimeEvent &event);
 
        // keys for selecting a particle selector
        enum class ParticleTimeEventParticleSelectorEnum : unsigned int {
            LARGEST, 
            UNIFORM,
            DEFAULT
        };
 
        typedef std::unordered_map<ParticleTimeEventParticleSelectorEnum, ParticleTimeEventParticleSelector> ParticleTimeEventParticleSelectorMapType;
        static ParticleTimeEventParticleSelectorMapType particleTimeEventParticleSelectorMap {
            {ParticleTimeEventParticleSelectorEnum::LARGEST, &particleTimeEventParticleSelectorLargest}, 
            {ParticleTimeEventParticleSelectorEnum::UNIFORM, &particleTimeEventParticleSelectorUniform}, 
            {ParticleTimeEventParticleSelectorEnum::DEFAULT, &particleTimeEventParticleSelectorUniform}
        };
 
        typedef std::unordered_map<std::string, ParticleTimeEventParticleSelectorEnum> ParticleTimeEventParticleSelectorNameMapType;
        static ParticleTimeEventParticleSelectorNameMapType particleTimeEventParticleSelectorNameMap {
            {"largest", ParticleTimeEventParticleSelectorEnum::LARGEST}, 
            {"uniform", ParticleTimeEventParticleSelectorEnum::UNIFORM}, 
            {"default", ParticleTimeEventParticleSelectorEnum::DEFAULT}
        };

        CPPAPI_FUNC(ParticleTimeEventParticleSelector*) getParticleTimeEventParticleSelector(ParticleTimeEventParticleSelectorEnum selectorEnum);

        CPPAPI_FUNC(ParticleTimeEventParticleSelector*) getParticleTimeEventParticleSelectorN(std::string setterName);

        enum class ParticleTimeEventTimeSetterEnum : unsigned int {
            DETERMINISTIC,
            EXPONENTIAL,
            DEFAULT
        };
 
        typedef std::unordered_map<ParticleTimeEventTimeSetterEnum, ParticleTimeEventNextTimeSetter> ParticleTimeEventNextTimeSetterMapType;
        static ParticleTimeEventNextTimeSetterMapType particleTimeEventNextTimeSetterMap {
            {ParticleTimeEventTimeSetterEnum::DETERMINISTIC, &particleTimeEventSetNextTimeDeterministic},
            {ParticleTimeEventTimeSetterEnum::EXPONENTIAL, &particleTimeEventSetNextTimeExponential},
            {ParticleTimeEventTimeSetterEnum::DEFAULT, &particleTimeEventSetNextTimeDeterministic}
        };
 
        typedef std::unordered_map<std::string, ParticleTimeEventTimeSetterEnum> ParticleTimeEventNextTimeSetterNameMapType;
        static ParticleTimeEventNextTimeSetterNameMapType particleTimeEventNextTimeSetterNameMap {
            {"deterministic", ParticleTimeEventTimeSetterEnum::DETERMINISTIC},
            {"exponential", ParticleTimeEventTimeSetterEnum::EXPONENTIAL},
            {"default", ParticleTimeEventTimeSetterEnum::DEFAULT}
        };

        CPPAPI_FUNC(ParticleTimeEventNextTimeSetter*) getParticleTimeEventNextTimeSetter(ParticleTimeEventTimeSetterEnum setterEnum);

        CPPAPI_FUNC(ParticleTimeEventNextTimeSetter*) getParticleTimeEventNextTimeSetterN(std::string setterName);
 
        // Time-dependent particle event
        struct CAPI_EXPORT ParticleTimeEvent : EventBase {

            ParticleType *targetType;

            ParticleHandle *targetParticle;

            FloatP_t next_time;

            FloatP_t period;

            FloatP_t start_time;

            FloatP_t end_time;
            
            ParticleTimeEvent() {}
            ParticleTimeEvent(
                ParticleType *targetType, 
                const FloatP_t &period, 
                ParticleTimeEventMethod *invokeMethod, 
                ParticleTimeEventMethod *predicateMethod, 
                ParticleTimeEventNextTimeSetter *nextTimeSetter=NULL, 
                const FloatP_t &start_time=0, 
                const FloatP_t &end_time=-1,
                ParticleTimeEventParticleSelector *particleSelector=NULL
            );
            virtual ~ParticleTimeEvent() {}
 
            virtual HRESULT predicate();
            virtual HRESULT invoke();
            virtual HRESULT eval(const FloatP_t &time);
 
            operator TimeEvent&() const;
 
        protected:
 
            FloatP_t getNextTime(const FloatP_t &current_time);
            ParticleHandle *getNextParticle();
 
            HRESULT setParticleTimeEventNextTimeSetter(ParticleTimeEventNextTimeSetter *nextTimeSetter);
            HRESULT setParticleTimeEventNextTimeSetter(ParticleTimeEventTimeSetterEnum setterEnum);
            HRESULT setParticleTimeEventNextTimeSetter(std::string setterName);
 
            HRESULT setParticleTimeEventParticleSelector(ParticleTimeEventParticleSelector *particleSelector);
            HRESULT setParticleTimeEventParticleSelector(ParticleTimeEventParticleSelectorEnum selectorEnum);
            HRESULT setParticleTimeEventParticleSelector(std::string selectorName);
 
        private:
 
            ParticleTimeEventMethod *invokeMethod;
            ParticleTimeEventMethod *predicateMethod;
            ParticleTimeEventNextTimeSetter *nextTimeSetter;
            ParticleTimeEventParticleSelector *particleSelector;
 
        };
 
        // Event list for time-dependent particle events
        using ParticleTimeEventList = EventListT<ParticleTimeEvent>;
 
        // Module entry points

        CPPAPI_FUNC(ParticleTimeEvent*) onParticleTimeEvent(
            ParticleType *targetType, 
            const FloatP_t &period, 
            ParticleTimeEventMethod *invokeMethod, 
            ParticleTimeEventMethod *predicateMethod=NULL, 
            unsigned int nextTimeSetterEnum=0, 
            const FloatP_t &start_time=0, 
            const FloatP_t &end_time=-1, 
            unsigned int particleSelectorEnum=0
        );

        CPPAPI_FUNC(ParticleTimeEvent*) onParticleTimeEventN(
            ParticleType *targetType, 
            const FloatP_t &period, 
            ParticleTimeEventMethod *invokeMethod, 
            ParticleTimeEventMethod *predicateMethod=NULL, 
            const std::string &distribution="default", 
            const FloatP_t &start_time=0, 
            const FloatP_t &end_time=-1, 
            const std::string &selector="default"
        );
 
}};
 
#endif // _SOURCE_EVENT_TFPARTICLETIMEEVENT_H_