jointmodel.h

Go to the documentation of this file.

#pragma once

#include "jmodelbase.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 UInt        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 Variant     getProperty(UInt index) const=0; // Return real/0.0 if property doesn't exist.
    virtual void        setProperty(UInt index,const Variant &p,UInt restoreVersion=0); // Calls setValid(0).  Return true if error.
    virtual void        save(std::ostream &o) const;
    virtual void        restore(std::istream &i,UInt 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(UByte dim,State *s); 
    virtual void        initialize(UByte dim,State *s); 
    virtual Double      getStressStrengthRatio(const State &) const { return(10.0); }
    virtual void        scaleProperties(const Double &,const std::vector<UInt> &) { std::logic_error("Does not support property scaling"); }
    virtual bool        supportsStressStrengthRatio() 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 L"energy-strain-shear,energy-strain-compression,energy-strain-tension,energy-slip"; }
    virtual double      getEnergy(UInt) const { return 0.0; }                   // Base 1
    virtual bool        getEnergyAccumulate(UInt) const { return false; }       // Base 1
    virtual void        setEnergy(UInt, 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 UInt getMajorVersion();
    static UInt getLibraryMinorVersion();
    bool isValid(UByte dimVal) const { return(valid_==dimVal); }
    void setValid(UByte 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:
    UByte valid_;
    bool  can_fail_;
    bool  plugin_;
  };
} // namespace jmodels

// EoF