OrientationField.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 MERCURYDPM_ORIENTATIONFIELD_H
#define MERCURYDPM_ORIENTATIONFIELD_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 OrientationField : public BaseFields
    {
    public:
        OrientationField();
        
        OrientationField(const OrientationField& other) = default;
        
        ~OrientationField() = default;
        
        static void writeNames(std::ostream& os, unsigned countVariables);
        
        void write(std::ostream& os) const;
        
        void output(std::ostream& os) const;
        
        void setZero();
        
        OrientationField getSquared() const;
        
        OrientationField& operator=(const OrientationField& P);
        
        OrientationField& operator+=(const OrientationField& P);
        
        OrientationField& operator-=(const OrientationField& P);
        
        OrientationField& operator/=(Mdouble a);
        
        OrientationField operator*(Mdouble a) const;
        
        void addParticleStatistics(Mdouble phi, const OrientationField& currentInteraction);
        
        void setFields(const BaseParticle& p);
        
        void setCylindricalFields(const BaseParticle& p);
        
        
        MatrixSymmetric3D getOrientation() const
        {
            return orientation_;
        }
        
        
        static bool evaluateFixedParticles()
        {
            return false;
        }
        
        static bool doInteractionStatistics()
        {
            return false;
        }
        
        static bool isDifferentialField()
        {
            return false;
        }
        
        void setFields(const BaseInteraction& c, IntegralType type)
        {}
        
        void setCylindricalFields(const BaseInteraction& c, IntegralType type)
        {}
        
        void addParticleDifferentialStatistics(Vec3D& dphi, const OrientationField& currentInteraction)
        {}
        
        void addInteractionStatistics(Mdouble psi, const OrientationField& currentInteraction)
        {}
        
        void addContactPointStatistics(Mdouble phi, const OrientationField& currentInteraction)
        {}
    
    private:
        MatrixSymmetric3D orientation_;
    };
}
 
#endif //MERCURYDPM_ORIENTATIONFIELD_H