SubcriticalMaserBoundaryTEST.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 SUBCRITICALMASERBOUNDARYTEST_H
#define SUBCRITICALMASERBOUNDARYTEST_H
 
#include "Particles/BaseParticle.h"
#include "Boundaries/PeriodicBoundary.h"
 
class ParticleSpecies;
 
class SubcriticalMaserBoundaryTEST : public PeriodicBoundary
{
public:
    SubcriticalMaserBoundaryTEST();
    
    ~SubcriticalMaserBoundaryTEST() override;
    
    SubcriticalMaserBoundaryTEST* copy() const override;
    
    void read(std::istream& is) override;
    
    void write(std::ostream& os) const override;
    
    std::string getName() const override;
    
    void actionsBeforeTimeLoop() override;
    
    void createPeriodicParticle(BaseParticle* p, ParticleHandler& pH) override;
    
    bool checkBoundaryAfterParticleMoved(BaseParticle* p, ParticleHandler& pH) const;
    
    void checkBoundaryAfterParticlesMove(ParticleHandler& pH) override;
    
    void activateMaser();
 
    void deactivateMaser();
 
    bool isActivated() const;
    
    void setActivationTime(Mdouble time);
    
    Mdouble getDistance(const Vec3D& position) const override;
    
    Mdouble getDistanceFromRight(const Vec3D& position) const;
    
    void modifyPeriodicComplexity(std::vector<int>& complexity, int& totalPeriodicComplexity,
                                  BaseParticle* particle, int i) const override;
    
    void modifyGhostAfterCreation(BaseParticle* particle, int i) override;
    
    
    void performActionsBeforeAddingParticles() override;
    
    void extendBottom() const;
    
    void copyExtraParticles() const;
    
    void setCopyFlowParticles(bool copyFlowParticles);
 
private:
    bool maserIsActivated_;
    
    Mdouble activationTime_;
    
    bool copyFlowParticles_;
    
};
 
#endif