MCell.h

Go to the documentation of this file.

#ifndef INC_KURUSVIEW_MCELL_H
#define INC_KURUSVIEW_MCELL_H


#include <iostream>
#include <fstream>
#include <vector>
#include <memory>

#include "MVector.h"
#include "MMaterial.h"

class MCell {
private:

    static unsigned long int MCellInstanceCount;


protected:

    explicit MCell(std::vector<std::shared_ptr<MVector>> vertices, std::shared_ptr<MMaterial> material, long int id);

    MCell() = delete;

    ~MCell();

    mutable double MCellVolume{};

    mutable double MCellWeight{};

    const long int MCellID;

    std::vector<std::shared_ptr<MVector>> MCellVertices;

    std::vector<unsigned int> vertexIDs;

    std::shared_ptr<MMaterial> MCellMaterial;


    mutable std::shared_ptr<MVector> MCellCOG;


    enum class MCellType_TypeDef {
        NONE,
        TETRAHEDRON,
        HEXAHEDRON,
        PYRAMID,
    };


    MCellType_TypeDef MCellType;

    virtual double calcVolume() const = 0;

    virtual double calcWeight() const = 0;

    virtual std::shared_ptr<MVector> calcCentreOfGrav() const = 0;


public:

    // TODO: do overloaded operators and friends require this visibility?
    // ====================== OPERATORS ==========================

    //MCell& operator=( const MCell& _mcell );

    friend std::ostream &operator<<(std::ostream &os, const MCell &mCell);

    friend std::ofstream &operator<<(std::ofstream &os, const MCell &mCell);

    // ======================= ACCESSORS =========================

    // XXX: a note on const return: https://stackoverflow.com/questions/8406898/benefits-of-using-const-with-scalar-type-e-g-const-double-or-const-int
    // XXX: a note on return by value https://en.wikipedia.org/wiki/Copy_elision#Return_value_optimization
    // XXX: a not on returning vector: std::vector: http://www.cplusplus.com/forum/general/56177/

    double getVolume() const;

    double getWeight() const;

    double getID() const;

    static double getCount();

    std::vector<std::string> getType() const;

    std::shared_ptr<MVector> getCentreOfGrav() const;

    std::shared_ptr<MMaterial> getMaterial() const;

    std::vector<std::shared_ptr<MVector>> getVertices() const;

    const std::vector<unsigned int> &getVertexIndices();

    void setMaterial(std::shared_ptr<MMaterial> material);

    void setVertices(std::vector<std::shared_ptr<MVector>> vertices);

};

#endif //INC_KURUSVIEW_MCELL_H