tfParticleList.h

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of mdcore.
 * 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 _MDCORE_INCLUDE_TFPARTICLELIST_H_
#define _MDCORE_INCLUDE_TFPARTICLELIST_H_
 
#include <mdcore_config.h>
#include <io/tf_io.h>
#include <types/tf_types.h>
 
#include <vector>
 
 
namespace TissueForge { 
 
 
    enum ParticleListFlags {
        // list owns the data the ParticleList::parts
        PARTICLELIST_OWNDATA = 1 << 0,
        
        // list supports insertion / deletion
        PARTICLELIST_MUTABLE = 1 << 1
    };
 
    struct ParticleHandle;
 
    struct CAPI_EXPORT ParticleList {
        int32_t *parts;
        int32_t nr_parts;
        int32_t size_parts;
        uint16_t flags;
        
        // frees the memory associated with the parts list.
        void free();
 
        HRESULT reserve(size_t _nr_parts);
        
        // inserts the given id into the list, returns the index of the item. 
        uint16_t insert(int32_t item);
 
        uint16_t insert(const ParticleHandle *particle);
        
        uint16_t remove(int32_t id);
        
        uint16_t extend(const ParticleList &other);
 
        bool has(const int32_t &pid);
 
        bool has(ParticleHandle *part);
 
        ParticleHandle *item(const int32_t &i);
 
        int32_t operator[](const size_t &i);
 
        std::vector<int32_t> vector();
 
        static ParticleList all();
 
        FMatrix3 getVirial();
        FPTYPE getRadiusOfGyration();
        FVector3 getCenterOfMass();
        FVector3 getCentroid();
        FMatrix3 getMomentOfInertia();
        std::vector<FVector3> getPositions();
        std::vector<FVector3> getVelocities();
        std::vector<FVector3> getForces();
 
        std::vector<FVector3> sphericalPositions(FVector3 *origin=NULL);
 
        bool getOwnsData() const;
 
        void setOwnsData(const bool &_flag);
 
        bool getMutable() const;
 
        void setMutable(const bool &_flag);
 
        ParticleList();
        ParticleList(uint16_t init_size, uint16_t flags = PARTICLELIST_OWNDATA | PARTICLELIST_MUTABLE);
        ParticleList(ParticleHandle *part);
        ParticleList(std::vector<ParticleHandle> particles);
        ParticleList(std::vector<ParticleHandle*> particles);
        ParticleList(uint16_t nr_parts, int32_t *parts);
        ParticleList(const ParticleList &other);
        ParticleList(const std::vector<int32_t> &pids);
        ~ParticleList();
 
        std::string toString();
 
        static ParticleList *fromString(const std::string &str);
        
    };
 
 
};
 
#endif // _MDCORE_INCLUDE_TFPARTICLELIST_H_