jointmodel.h

Go to the documentation of this file.

#pragma once
 
#include "jmodelbase.h"
#include "base/src/property.h"
 
#include <vector>
#include <iostream>
 
namespace jmodels {
    struct State;
 
 
    class JMODEL_EXPORT JointModel {
    public:
        virtual string      getName() const = 0;
        virtual string      getPluginName() const { return getName(); }
        virtual string      getFullName() const = 0; // Full name of model.
        virtual uint32     getMinorVersion() const; // Returns minor version of base implementation, override for actual model.
        virtual string      getProperties() const = 0; // comma delimited
        virtual string      getStates() const = 0; // comma delimited
        virtual base::Property  getProperty(uint32 index) const = 0; // Return real/0.0 if property doesn't exist.
        virtual void        setProperty(uint32 index, const base::Property& p, uint32 restoreVersion = 0); // Calls setValid(0).  Return true if error.
        virtual void        save(std::ostream& o) const;
        virtual void        restore(std::istream& i, uint32 restoreVersion);
        virtual JointModel* clone() const = 0;
        virtual double      getMaxNormalStiffness() const = 0;
        virtual double      getMaxShearStiffness() const = 0;
        virtual void        copy(const JointModel* mod);
        virtual void        run(uint32 dim, State* s);
        virtual void        initialize(uint32 dim, State* s);
        virtual double      getStrengthStressRatio(const State&) const { return(10.0); }
        virtual void        scaleProperties(const double&, const std::vector<uint32>&) { throw std::logic_error("Does not support property scaling"); }
        virtual bool        supportsStrengthStressRatio() const { return(false); }
        virtual bool        supportsPropertyScaling() const { return(false); }
        virtual void        destroy() { delete this; }
        virtual bool        isSliding(const State&) { return false; }
        virtual bool        isBonded(const State&) { return true; }
 
        enum EnergyKeys { kwEStrainShear = 1, kwEStrainCompression, kwEStrainTension, kwESlip };
        virtual string      getEnergies() const { return "energy-strain-shear,energy-strain-compression,energy-strain-tension,energy-slip"; }
        virtual double      getEnergy(uint32) const { return 0.0; }                   // Base 1
        virtual bool        getEnergyAccumulate(uint32) const { return false; }       // Base 1
        virtual void        setEnergy(uint32, const double&) {}                       // Base 1    
        virtual void        activateEnergy() {}
        virtual bool        getEnergyActivated() const { return false; }  // Returns a boolean indicating if energies have been instanciated
 
 
        JointModel();
        virtual ~JointModel();
        static uint32 getMajorVersion();
        static uint32 getLibraryMinorVersion();
        bool isValid(uint32 dimVal) const { return(valid_ == dimVal); }
        void setValid(uint32 dimVal) { valid_ = dimVal; }
        bool canFail() const { return(can_fail_); }
        void setIfCanFail(bool b) { can_fail_ = b; }
        bool getPlugIn() const { return plugin_; }
        void setPlugIn(bool b) { plugin_ = b; }
 
    private:
        uint32 valid_;
        bool  can_fail_;
        bool  plugin_;
    };
} // namespace jmodels
 
// EoF