izone.h

Go to the documentation of this file.

// izone.h
#pragma once
 
#include "module/interface/dim.h"
#include "utility/interface/igroup.h"
#include "models/src/igenericzone.h"
#include "base/src/farray.h"
#include "base/src/property.h"
 
namespace itasca {
 class IThing;
 class IFish;
}
namespace itascaxd {
 class Parse;
 class IRange;
}
namespace models {
 class ConstitutiveModel;
}
namespace fish {
 class File;
 class IParameter;
}
namespace zone {
 using namespace itasca;
 using namespace itascaxd;
 
 static const uint32 ulNumZoneType = dimval(2,5); // number of zone types: 2 in 2D, 5 in 3D
 static const uint32 numTperOv_ = dimval(2,5); // number of tets/triangles per zone: 2 in 2D, 5 in 3D
 static const uint32 numGPperZ_ = dimval(4,8); // max number of gridpoints per zone in 2D/3D
 static const uint32 numGPperT_ = dimval(3,4); // number of gridpoint per triangle (2D) / tetra (3D)
 static const uint32 numAdjZones_ = dimval(4,6); // max number of adjoint zones to a zone in 2D/3D
 static const uint32 numFacesZ_ = dimval(4,6); // max number of faces per zones in 2D/3D; in 2D a face is the edge of a quad or triangle
 static const uint32 numGPperFace_ = dimval(2,4); // max number of gripoints per face in 2D/3D; in 2D a face is the edge of a quad or triangle
 static const uint32 minGPperFace_ = dimval(2,3); // min number of GP that define face in 2D/3D
 static const uint32 numEdgeZ_ = dimval(4,12); // max number of edges per zone in 2D/3D
 
 class IGp;
 class IFace;
 class ITet;
 class IHysDamp;
 class IThermZone;
 class IFluidZone;
 class IDynZone;
 
 class FaceID {
 public:
 static constexpr uint32 size() { return numGPperFace_; }
 
 FaceID() { std::fill(id_.begin(), id_.end(), 0); }
 FaceID(const FaceID &fid) : id_(fid.id_) {} // We assume already sorted
 FaceID(const std::array<uint64, numGPperFace_>& id) : id_(id) { sort(); }
 
 inline const FaceID& operator=(const FaceID& id) { id_ = id.id_; return *this; }
 inline bool operator==(const FaceID &id) const { return id_==id.id_; }
 inline bool operator!=(const FaceID &id) const { return !operator==(id); }
 inline bool operator<(const FaceID& id) const { return id_<id.id_; }
 inline uint64 &operator[](uint32 index) { return id_[index]; }
 inline const uint64 &operator[](uint32 index) const { return id_[index]; }
 inline uint32 replace(uint64 oldID, uint64 newID);
 inline void sort(); // Entures id numbers organized from highest to lowest.
 
 static inline size_t hash(const FaceID &fid);
 
 private:
 std::array<uint64, numGPperFace_> id_;
 };
 
 class IZone : public models::IGenericZone {
 public:
 inline static const TType type_ = 0x4c815bf8;
 enum class Change { Null, AddToList, RemoveFromList, Active };
 enum class Code {
#ifdef THREED
 Brick=0, 
 Wedge, 
 Pyramid, 
 DBrick, 
 Tetra 
#else
 Quad = 0, 
 Tria 
#endif
 };
 struct IFacePair {
 const IZone *zone_=nullptr;
 uint32 side_=0;
 };
 
 const IThing * getIThing() const override =0;
 IThing * getIThing() override =0;
 virtual const IZone * getNext() const=0;
 virtual IZone * getNext()=0;
 virtual uint32 getNumGp() const=0;
 virtual uint32 getNumFace() const=0;
 virtual const IGp * getGp(uint32 index) const=0;
 virtual uint32 getFaceSize(uint32 face) const=0;
 virtual const IGp * getFaceGp(uint32 face,uint32 index) const=0;
 virtual uint32 getFaceGpIndex(uint32 face,uint32 index) const=0;
 virtual uint32 getEdgeGpIndex(uint32 edge, uint32 index) const=0;
 
 virtual FaceID getFaceID(uint32 side) const=0;
 
 //virtual uint32 getFaceOnEdge(uint32 edge, uint32 index) const=0;
 
 virtual DVect getFaceNormal(uint32 face,bool normalize) const=0;
 virtual DVect getFaceCentroid(uint32 face) const=0;
 virtual const IZone * getJoin(uint32 face) const=0;
 // Face Group support
 virtual const IGroup * getFaceGroup(uint32 side,const ISlotID &slot=ISlotID((uint32)0)) const=0;
 virtual QString getFaceGroupName(uint32 side,const ISlotID &slot=ISlotID()) const=0;
 virtual bool addFaceGroup(uint32 side,const IGroupID &group)=0;
 virtual bool removeFaceGroup(uint32 side,const IGroupID &group)=0;
 virtual uint32 isFaceInGroup(uint32 side,const FArray<IGroupID> &ids,TType type=0,bool only=false) const=0;
 virtual uint32 getFaceGroupList(uint32 side,FArray<IGroupID> *list) const=0;
 virtual void copyFaceGroups(uint32 side,const IThing *t)=0;
 virtual std::vector<uint32> getFaceExtraIndices(uint32 side) const=0;
 virtual const fish::IParameter *getFaceExtra(uint32 side,uint32 index) const=0;
 virtual void setFaceExtra(uint32 side,uint32 index,const fish::IParameter &p)=0;
 virtual bool getFaceHidden(uint32 side) const=0;
 virtual bool setFaceHidden(uint32 side,bool b)=0;
 virtual bool getFaceSelected(uint32 side) const=0;
 virtual bool setFaceSelected(uint32 side,bool b)=0;
 virtual bool isFaceInRange(uint32 side,const IRange *range) const=0;
 virtual double getDensity() const=0;
 virtual double getWetDensity() const=0;
 virtual void setDensity(const double &d)=0;
 //virtual double getFluidDensity() const=0;
 virtual Code getCode() const=0;
 virtual double getAspectTest() const=0;
 virtual double getAspectTetTest() const=0;
 virtual void copyState(const IZone *zone)=0;
 virtual DVect getThermalFlux() const=0; // jkf: should be const
 virtual int getFace(const FaceID &fid) const=0;
 enum class StrainMode { ShearRate=1, ShearInc=2, VolRate=3, VolInc=4, FullRate=5, FullInc=6, FullRotRate=7, FullRotInc=8 };
 virtual double getSSR(StrainMode mode,SymTensor *fsr) const=0;
 virtual SymTensor getTetStrainRate(int overlay,int number) const=0;
 virtual SymTensor getTetStrainIncrement(int overlay,int number) const=0;
 virtual SymTensor getStrainRate() const=0;
 virtual SymTensor getStrainIncrement() const=0;
 virtual string getIsDegenerate() const =0;
 virtual string getSupports2Overlays() const =0;
 virtual string getCheckGeom() const = 0;
 virtual const ITet * getOverlay(uint32 ov) const=0;
 virtual ITet * getOverlay(uint32 ov)=0;
 virtual const IHysDamp * getHysDamp() const=0;
 virtual IHysDamp * getHysDamp() =0;
 virtual IHysDamp * setHysDamp() =0;
 
 virtual int initializeModels()=0;
 virtual bool isNull() const=0;
 virtual bool isMechActive() const=0; // false if NULL *or* if constitutive model is inActive
 virtual bool isFluidActive() const=0; // false if NULL *or* if constitutive model is inActive
 virtual bool isThermActive() const=0; // false if NULL *or* if constitutive model is inActive
 virtual string getModelName() const=0;
 virtual const models::ConstitutiveModel *getModel() const=0;
 virtual void setModelName(const string &qs,bool updateFlags=true) =0;
 virtual double getSmallestNormalizedTetVolume(bool deformed=false) const=0;
#ifdef THREED
 virtual double getQualityTest(int iTestNum) const=0;
 virtual double getPlanarity() const=0;
#endif
 virtual int getNumTets() const =0;
 virtual double getOrthoTest() const=0;
 virtual double getVolumeTest() const=0;
 virtual double getZoneCondition(int i=0) const=0;
#ifdef TWOD
 virtual bool getBadZoneExtruder() const=0;
#endif
 virtual double getAvgPP() const=0;
 //virtual double getAvgSaturation() const=0;
 virtual base::Property getProperty(const string &sc) const =0;
 virtual base::Property getProperty(uint32 index) const=0;
 virtual bool setProperty(const string &sc,const base::Property &v) =0;
 virtual bool setProperty(int index,const base::Property &v) =0;
 virtual double getVolumeD(bool deformed) const=0;
 virtual double getVolume() const=0;
 virtual DVect getCentroid() const=0;
 virtual SymTensor getAveStress(bool effective=false) const=0;
 virtual double getAvgTemp() const=0;
 virtual DVect getFlowVector() const=0;
 virtual uint32 getAvgState(int *piNum, bool bAvgKeyword, bool noPast=false) const=0;
 virtual string getStateName(uint32 bit) const=0;
 virtual void setStress(const double &val,uint32 pn)=0;
 virtual void setStress(const SymTensor &sym)=0;
 virtual void setState(uint32 state)=0;
 virtual void getTetGridPoints(int iOverlay, int iTet, IGp *gplist[]) =0;
 virtual const IThermZone * getIThermZone() const=0;
 virtual IThermZone * getIThermZone() =0;
 virtual StringList getPropertyNames() const=0;
 virtual uint32 getPropertyIndex(const string &sc) const=0;
 virtual string getPropertyName(uint32 index) const=0;
 virtual bool getBit(int bit) const=0;
 virtual void setBit(int bit,bool b) const=0;
 virtual QVariant getValue(int index) const=0;
 virtual void setValue(int index,const QVariant &v) const=0;
 virtual const IFluidZone * getIFluidZone() const=0;
 virtual IFluidZone * getIFluidZone() =0;
 virtual const IDynZone * getIDynZone() const=0;
 virtual IDynZone * getIDynZone() =0;
 virtual IZone * getLinkZone(uint32 index)=0;
 virtual const IZone * getLinkZone(uint32 index) const=0; 
 virtual uint32 getLinkIndex(uint32 index) const=0;
 
 virtual bool fishIO(bool save,fish::File *pnt)=0;
 virtual double getStrengthStressRatio(const SymTensor &s) const=0;
 //virtual QString applyBoundaryCondition(uint32 face,QString item,QString options,const double &val)=0;
 
 virtual double getWPVol() const =0;
 virtual void setWPVol(const double &dwpv)=0;
 virtual double getWPShear() const=0;
 virtual void setWPShear(const double &dwps)=0;
 virtual double getWPTotal() const=0;
 virtual double getWEVol() const =0;
 virtual void setWEVol(const double &dwpv)=0;
 virtual double getWEShear() const=0;
 virtual void setWEShear(const double &dwps)=0;
 virtual double getWETotal() const=0;
 virtual string getFluidModel() const=0;
 virtual StringList getFluidProperties()const=0;
 virtual base::Property getFluidProp(const string &name,bool exception) const =0;
 virtual int getFluidPropIndex(const string &name) const=0;
 virtual base::Property getFluidProp(uint32 index) const=0;
 virtual void setFluidProp(const string &name,const base::Property &val)=0;
 virtual void setFluidProp(uint32 index, const base::Property &val)=0;
 virtual void setThermModel(const string &name)=0;
 virtual StringList getThermProperties() const=0;
 virtual string getThermModel(bool exception) const=0;
 virtual base::Property getThermProp(const string &name,bool exception) const =0;
 virtual uint32 getThermPropIndex(const string &name) const=0;
 virtual base::Property getThermProp(uint32 index) const=0;
 virtual void setThermProp(const string &name, const base::Property &prop)=0;
 virtual void setThermProp(uint32 index, const base::Property &prop)=0;
 
 //virtual StringList getPermeabilityProperties() const = 0;
 //virtual string getPermeabilityModel(bool exception = true)const = 0;
 //virtual base::Property getPermeabilityProp(uint32 index) const = 0;
 //virtual void setPermeabilityProp(int index,const base::Property &val) = 0;
 
 virtual bool isInZn(const DVect &dv,const double &relTol=1.0e-5, bool use2=false) const=0; // use same default epsilon factor as ZoneList::zoneIn function
 virtual bool checkZoneForPlot(bool removeHidden,bool showSelected,bool hideNull) const=0;
 
 struct FaceCheckInput {
 uint32 side_ = 0;
 bool internalFaces_ = false; // Show ALL faces, not just surface faces.
 int bit_ = 0; // Used to check if a zone is in or out of the range of zones being considered (only if internalFace_ is false).
 bool zoneFace_ = false; // If true, then being used for plot of faces (as opposed to a plot of zones).
 bool onlySelectedFaces_ = false; // Only show selected faces (ignored if zoneFace_ is false).
 };
 struct FaceCheckOutput { // Filled out only if return value is true.
 bool selected_ = false; // True if zone or face is selected (based on zoneFace_ flag).
 uint64 id_ = 0; // ID number of zones
 FArray<DVect> vertices_; // Vertices of zone face.
 
 };
 virtual bool checkFaceForPlot(const FaceCheckInput &inp,FaceCheckOutput *outp) const=0;
 virtual bool checkFaceForPlotFace(uint32 side,uint64 *id,FArray<DVect> *vertices,bool excludeSelected=true) const=0;
 virtual bool checkFaceForPlotFaceSelected(uint32 side,uint64 *id,FArray<DVect> *vertices) const=0;
 virtual void fillZoneVertices(FArray<DVect> *vertices) const=0;
 virtual void fillAllZoneFaces(FArray<FArray<DVect>> *allVertices,bool *selected,uint64 *id) const=0;
 virtual int findFaceNormal(const DVect &v) const=0;
 virtual double getMultiplier() const=0;
 virtual bool CMSupportsHysDamp()const {return false;} ;
 
 static const char *unassignedModelName() { return "unassigned"; }
 };
 
 inline size_t FaceID::hash(const FaceID& fid) {
 size_t ret = std::hash<uint64>()(fid.id_[0]);
 for (uint32 i = 1; i<size(); ++i)
 ret ^= std::hash<uint64>()(fid.id_[i]);
 return ret;
 }
 
 inline uint32 FaceID::replace(uint64 oldID, uint64 newID) {
 uint32 count(0);
 for (uint32 i = 0; i<size();++i) {
 if (id_[i]==oldID) {
 id_[i] = newID;
 count++;
 }
 }
 if (count)
 sort();
 return count;
 
 }
 
 void FaceID::sort() {
 if (id_[1]>id_[0])
 std::swap(id_[0], id_[1]);
#ifdef THREED
 if (id_[2]>id_[1]) {
 std::swap(id_[2], id_[1]);
 if (id_[1]>id_[0])
 std::swap(id_[0], id_[1]);
 }
 if (id_[3]>id_[2]) {
 std::swap(id_[3], id_[2]);
 if (id_[2]>id_[1]) {
 std::swap(id_[2], id_[1]);
 if (id_[1]>id_[0])
 std::swap(id_[0], id_[1]);
 }
 }
#endif
 }
} // namespace zone
namespace std {
 template <> struct hash<zone::FaceID> {
 size_t operator()(const zone::FaceID& fid) const { return zone::FaceID::hash(fid); }
 };
}
// EoF