StressStrainControlBoundary.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 StressStrainControlBoundary_H
#define StressStrainControlBoundary_H
 
#include "BaseBoundary.h"
#include "Math/ExtendedMath.h"
#include "Side.h"
#include "LeesEdwardsBoundary.h"
#include "PeriodicBoundary.h"
#include "Controllers/PController.h"
#include "Controllers/PIController.h"
#include "Controllers/PIDController.h"
class PeriodicBoundaryHandler;
 
class StressStrainControlBoundary : public BaseBoundary
{
public:
 
    StressStrainControlBoundary();
    
    StressStrainControlBoundary(const StressStrainControlBoundary& b) = default;
    
    virtual ~StressStrainControlBoundary() = default;
    
    void read(std::istream& is) override;
    
    void write(std::ostream& os) const override;
    
    std::string getName() const override;
    
    StressStrainControlBoundary* copy() const override;
    
    void checkBoundaryAfterParticlesMove(ParticleHandler& particleHandler) override;
 
    void set(const Matrix3D& stressGoal, const Matrix3D& strainRate, const Matrix3D& gainFactor,
             bool isStrainRateControlled);
 
    void setStrainRate(const Matrix3D& strainRate);
 
    void createPeriodicParticles(ParticleHandler& particleHandler) override;
    
    //helper functions
    
    void checkPeriodicLeesEdwardsBoundariesAfterParticlesMove(ParticleHandler& particleHandler);
    
    void determineLengthAndCentre();
 
    void activateStrainRateControl(const ParticleHandler& particleHandler);
    
    void computeStrainRate();
    
    void determineStressControlledShearBoundaries();
 
    void updateDomainSize();
 
    Matrix3D getStrainRate() const {return strainRate_;}
 
    Matrix3D getStressGoal() const {return stressGoal_;}
 
    Matrix3D getGainFactor() const {return gainFactor_;}
 
 
    Mdouble computeStressError();
 
 
 
    double getIntegratedShift() const {return integratedShift_;}
 
//    // Proportional Controller
//    static void pControl (Mdouble& strainRate, Mdouble stress, Mdouble stressGoal, Mdouble pGain) {
//        strainRate = pGain * (stress- stressGoal);
//    }
 
 
private:
 
    //Set by the user.
    Matrix3D stressGoal_, strainRate_, gainFactor_;
 
    bool isStrainRateControlled_;
 
    Mdouble integratedShift_;
 
    //Defined in the set function.
 
    std::vector<LeesEdwardsBoundary> leesEdwardsBoundaries_;
    std::vector<PeriodicBoundary> periodicBoundaries_;
};
 
#endif