DeletionBoundary.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 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_),
          trackerCustom_(d.trackerCustom_) {}
 
    ~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 setTrackerCustom(std::function<void(std::ofstream&, BaseParticle*)> trackerCustom)
    {
        trackOutflow_ = false;
        trackerCustom_ = trackerCustom;
    }
 
    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;
    std::function<void(std::ofstream&, BaseParticle*)> trackerCustom_ = [] (std::ofstream&, BaseParticle*) {};
};
 
#endif