SpeciesHandler.h

Go to the documentation of this file.

//Copyright (c) 2013-2023, The MercuryDPM Developers Team. All rights reserved.
//For the list of developers, see <http://www.MercuryDPM.org/Team>.
//
//Redistribution and use in source and binary forms, with or without
//modification, are permitted provided that the following conditions are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name MercuryDPM nor the
//    names of its contributors may be used to endorse or promote products
//    derived from this software without specific prior written permission.
//
//THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
//ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
//WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
//DISCLAIMED. IN NO EVENT SHALL THE MERCURYDPM DEVELOPERS TEAM BE LIABLE FOR ANY
//DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
//(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
//LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
//ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
//(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
//SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 
#ifndef SPECIESHANDLER_H
#define SPECIESHANDLER_H
 
#include "BaseHandler.h"
#include "Species/ParticleSpecies.h"
 
class SpeciesHandler final : public BaseHandler<ParticleSpecies>
{
public:
    SpeciesHandler();
    
    SpeciesHandler(const SpeciesHandler& other);
    
    SpeciesHandler& operator=(const SpeciesHandler& rhs);
    
    ~SpeciesHandler() override;
    
    void addObject(ParticleSpecies* S) override;
    
    void clear() override
    {
        BaseHandler<ParticleSpecies>::clear();
        mixedObjects_.clear();
    }
    
    void removeObject(unsigned int index) override;
    
    void readAndAddObject(std::istream& is) override;
    
    ParticleSpecies* readOldObject(std::istream& is);
    
    unsigned int getMixedId(unsigned int id1, unsigned int id2) const;
    
    template<typename U>
    typename std::enable_if<!std::is_pointer<typename U::MixedSpeciesType>::value, typename U::MixedSpeciesType*>::type
    getMixedObject(const U* S, const U* T)
    {
        return static_cast<typename U::MixedSpeciesType*>(getMixedObject(S->getIndex(), T->getIndex()));
    }
    
    BaseSpecies* getMixedObject(unsigned int id1, unsigned int id2);
    
    const std::vector<BaseSpecies*>& getMixedObjects() const;
    
    void updateMixedObjects();
    
    virtual void write(std::ostream& os) const;
    
    std::string getName() const override;
    
    bool useAngularDOFs();
 
private:
    std::vector<BaseSpecies*> mixedObjects_;
};
 
#endif