StandardFields.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 StandardFields_H
#define StandardFields_H
 
#include <Math/Matrix.h>
#include <Math/MatrixSymmetric.h>
#include <CG/Functions/IntegralType.h>
#include <array>
 
#include "BaseFields.h"
 
class BaseParticle;
 
class BaseInteraction;
 
namespace CGFields
{
 
class StandardFields : public BaseFields
{
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;
    }
 
protected:
    void setContactStress(Matrix3D contactStress)
    {
        contactStress_ = contactStress;
    }
 
    void addContactStress(Matrix3D contactStress)
    {
        contactStress_ += contactStress;
    }
 
    void setInteractionForceDensity(Vec3D interactionForceDensity)
    {
        interactionForceDensity_ = interactionForceDensity;
    }
 
    void addInteractionForceDensity(Vec3D interactionForceDensity)
    {
        interactionForceDensity_ += interactionForceDensity;
    }
    
private:
    
    Mdouble volumeFraction_;
    
    Mdouble density_;
    
    Vec3D momentum_;
    
    MatrixSymmetric3D momentumFlux_;
    
    Matrix3D contactStress_;
    
    Vec3D interactionForceDensity_;
    
    std::array<Mdouble, 6> particleSizeDensity_;
    
};
    
}
#endif