DeletionBoundary.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 DELETIONBOUNDARY_H
#define DELETIONBOUNDARY_H
 
#include "BaseBoundary.h"
#include "Math/Vector.h"
 
class ParticleHandler;
 
class BaseParticle;
 
class DeletionBoundary : public BaseBoundary
{
public:
    DeletionBoundary();
 
    DeletionBoundary(DeletionBoundary const &d)
        : normal_(d.normal_), scaleFactor_(d.scaleFactor_), distance_(d.distance_),
          numberOfParticlesDeleted_(d.numberOfParticlesDeleted_), massDeleted_(d.massDeleted_),
          volumeDeleted_(d.volumeDeleted_), isActivated_(d.isActivated_), trackOutflow_(d.trackOutflow_) {}
 
    ~DeletionBoundary() override;
    
    DeletionBoundary* copy() const override;
    
    void set(const Vec3D& normal, Mdouble distance);
    
    void move(Mdouble position);
    
    virtual Mdouble getDistance(const Vec3D& position) const;
    
    bool checkBoundaryAfterParticleMoved(BaseParticle* p, ParticleHandler& pH);
    
    void checkBoundaryAfterParticlesMove(ParticleHandler& pH) override;
    
    unsigned int getNumberOfParticlesDeleted() const;
    
    double getMassOfParticlesDeleted() const;
    
    double getVolumeOfParticlesDeleted() const;
    
    void reset();
    
    
    void activate();
    
    void deactivate();
 
    void trackOutflow(bool trackOutflow = true) {trackOutflow_ = trackOutflow;}
 
    void read(std::istream& is) override;
    
    MERCURYDPM_DEPRECATED
    void oldRead(std::istream& is);
    
    void write(std::ostream& os) const override;
    
    std::string getName() const override;
 
private:
    Vec3D normal_;
    
    Mdouble scaleFactor_;
    
    Mdouble distance_;
    
    unsigned int numberOfParticlesDeleted_;
    double massDeleted_;
    double trackMassDeleted_;
    double volumeDeleted_;
    
    bool isActivated_;
 
    bool trackOutflow_;
 
    std::ofstream tracker;
 
};
 
#endif