SubcriticalMaserBoundary.h

Go to the documentation of this file.

// This file is part of the MercuryDPM project (https://www.mercurydpm.org).
// Copyright (c), The MercuryDPM Developers Team. All rights reserved.
// License: BSD 3-Clause License; see the LICENSE file in the root directory.
 
#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