SubcriticalMaserBoundary.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 SUBCRITICALMASERBOUNDARY_H
#define SUBCRITICALMASERBOUNDARY_H
 
#include <map>
 
#include "Particles/BaseParticle.h"
#include "Boundaries/BaseBoundary.h"
#include "Boundaries/PeriodicBoundary.h"
#include "Interactions/BaseInteraction.h"
#include "Math/Vector.h"
 
class ParticleSpecies;
 
class SubcriticalMaserBoundary : public BaseBoundary
{
public:
    SubcriticalMaserBoundary();
    
    explicit SubcriticalMaserBoundary(const PeriodicBoundary& periodicBoundary);
    
    SubcriticalMaserBoundary* copy() const override;
    
    void set(Vec3D normal, Vec3D planewiseShift, Mdouble distanceLeft, Mdouble distanceRight);
 
    void set(Vec3D normal, Mdouble distanceLeft, Mdouble distanceRight);
    
    void setPlanewiseShift(Vec3D planewiseShift);
 
    void setShift(Vec3D shift);
 
    void read(std::istream& is) override;
    
    void write(std::ostream& os) const override;
    
    std::string getName() const override;
    
    void createPeriodicParticle(BaseParticle* p, ParticleHandler& pH) override;
    
    void createPeriodicParticles(ParticleHandler& pH) override;
    
    bool checkBoundaryAfterParticleMoved(BaseParticle* p, ParticleHandler& pH) const;
    
    void checkBoundaryAfterParticlesMove(ParticleHandler& pH) override;
    
    void addParticleToMaser(BaseParticle* p);
    
    void removeParticleFromMaser(BaseParticle* p);
    
    bool isMaserParticle(BaseParticle* p) const;
    
    bool isNormalParticle(BaseParticle* p) const;
    
    void actionsBeforeTimeLoop() override;
    
    void activateMaser();
    
    void deactivateMaser();
    
    Mdouble getDistanceLeft() const;
    
    Mdouble getDistanceRight() const;
 
protected:
    
    void shiftPosition(BaseParticle* p) const;
    
    BaseParticle* createGhostCopy(BaseParticle* p) const;
    
    bool isClosestToRightBoundary(const BaseParticle* const p) const
    {
        const Mdouble distance = Vec3D::dot(p->getPosition(), normal_);
        return (distanceRight_ - distance < distance - distanceLeft_);
    }
    
    Mdouble getDistance(BaseParticle* p) const
    {
        const Mdouble distance = Vec3D::dot(p->getPosition(), normal_);
        return std::min(distance - distanceLeft_, distanceRight_ - distance);
    }
    
    Vec3D normal_;
    
    Mdouble distanceLeft_;
    
    Mdouble distanceRight_;
    
    Vec3D shift_;
    
    std::map<const ParticleSpecies*, const ParticleSpecies*> speciesConversionNormalToMaser_;
    
    std::map<const ParticleSpecies*, const ParticleSpecies*> speciesConversionMaserToNormal_;
    
    bool maserIsActivated_;
    
};
 
#endif