StandardFields.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 StandardFields_H
#define StandardFields_H
 
#include <Math/Matrix.h>
#include <Math/MatrixSymmetric.h>
#include <CG/Functions/IntegralType.h>
#include <array>
 
class BaseParticle;
 
class BaseInteraction;
 
namespace CGFields
{
 
class StandardFields
{
public:
    
    StandardFields();
    
    StandardFields(const StandardFields& P) = default;
    
    ~StandardFields() = default;
    
    static void writeNames(std::ostream& os, unsigned countVariables);
    
    void write(std::ostream& os) const;
    
    void output(std::ostream& os) const;
    
    void setZero();
    
    StandardFields getSquared() const;
    
    StandardFields& operator=(const StandardFields& P);
    
    StandardFields& operator+=(const StandardFields& P);
    
    StandardFields& operator-=(const StandardFields& P);
    
    StandardFields& operator/=(Mdouble a);
    
    StandardFields operator*(Mdouble a) const;
    
    void addParticleStatistics(Mdouble phi, const StandardFields& currentInteraction);
    
    void addParticleDifferentialStatistics(Vec3D& dphi, const StandardFields& currentInteraction);
    
    void addInteractionStatistics(Mdouble psi, const StandardFields& currentInteraction);
    
    void addContactPointStatistics(Mdouble phi, const StandardFields& currentInteraction);
    
    void setFields(const BaseInteraction& c, IntegralType type);
    
    void setCylindricalFields(const BaseInteraction& c, IntegralType type);
    
    void setFields(const BaseParticle& p);
    
    void setCylindricalFields(const BaseParticle& p);
    
    
    static bool doInteractionStatistics();
    
    Mdouble getVolumeFraction() const
    {
        return volumeFraction_;
    }
    
    Mdouble getDensity() const
    {
        return density_;
    }
    
    Vec3D getMomentum() const
    {
        return momentum_;
    }
    
    MatrixSymmetric3D getMomentumFlux() const
    {
        return momentumFlux_;
    }
    
    Matrix3D getContactStress() const
    {
        return contactStress_;
    }
    
    Vec3D getInteractionForceDensity() const
    {
        return interactionForceDensity_;
    }
    
    Mdouble getParticleSizeDensity(size_t i) const
    {
        return particleSizeDensity_[i];
    }
    
    std::array<Mdouble, 6> getParticleSizeDensity() const
    {
        return particleSizeDensity_;
    }
    
    std::array<Mdouble, 6> getParticleSizeMomenta() const;
    
    std::array<Mdouble, 6> getCentralParticleSizeMomenta() const;
    
    std::array<Mdouble, 6> getStandardisedParticleSizeMomenta() const;
    
    void outputStandardisedParticleSizeMomenta(std::ostream& os) const;
    
    static bool evaluateFixedParticles()
    {
        return false;
    }
    
    static bool isDifferentialField()
    {
        return false;
    }
 
private:
    
    Mdouble volumeFraction_;
    
    Mdouble density_;
    
    Vec3D momentum_;
    
    MatrixSymmetric3D momentumFlux_;
    
    Matrix3D contactStress_;
    
    Vec3D interactionForceDensity_;
    
    std::array<Mdouble, 6> particleSizeDensity_;
    
};
    
}
#endif