Itasca C++ Interface
Loading...
Searching...
No Matches
izone.h
Go to the documentation of this file.
1// izone.h
2#pragma once
3
8
9#include "module/interface/dim.h"
10#include "utility/interface/igroup.h"
11#include "models/src/igenericzone.h"
12#include "base/src/farray.h"
13#include "base/src/property.h"
14
15namespace itasca {
16 class IThing;
17 class IFish;
18}
19namespace itascaxd {
20 class Parse;
21 class IRange;
22}
23namespace models {
24 class ConstitutiveModel;
25}
26namespace fish {
27 class File;
28 class IParameter;
29}
30namespace zone {
31 using namespace itasca;
32 using namespace itascaxd;
33
34 static const uint32 ulNumZoneType = dimval(2,5); // number of zone types: 2 in 2D, 5 in 3D
35 static const uint32 numTperOv_ = dimval(2,5); // number of tets/triangles per zone: 2 in 2D, 5 in 3D
36 static const uint32 numGPperZ_ = dimval(4,8); // max number of gridpoints per zone in 2D/3D
37 static const uint32 numGPperT_ = dimval(3,4); // number of gridpoint per triangle (2D) / tetra (3D)
38 static const uint32 numAdjZones_ = dimval(4,6); // max number of adjoint zones to a zone in 2D/3D
39 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
40 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
41 static const uint32 minGPperFace_ = dimval(2,3); // min number of GP that define face in 2D/3D
42 static const uint32 numEdgeZ_ = dimval(4,12); // max number of edges per zone in 2D/3D
43
44 class IGp;
45 class IFace;
46 class ITet;
47 class IHysDamp;
48 class IThermZone;
49 class IFluidZone;
50 class IDynZone;
51
55 class FaceID {
56 public:
57 static constexpr uint32 size() { return numGPperFace_; }
58
59 FaceID() { std::fill(id_.begin(), id_.end(), 0); }
60 FaceID(const FaceID &fid) : id_(fid.id_) {} // We assume already sorted
61 FaceID(const std::array<uint64, numGPperFace_>& id) : id_(id) { sort(); }
62
63 inline const FaceID& operator=(const FaceID& id) { id_ = id.id_; return *this; }
64 inline bool operator==(const FaceID &id) const { return id_==id.id_; }
65 inline bool operator!=(const FaceID &id) const { return !operator==(id); }
66 inline bool operator<(const FaceID& id) const { return id_<id.id_; }
67 inline uint64 &operator[](uint32 index) { return id_[index]; }
68 inline const uint64 &operator[](uint32 index) const { return id_[index]; }
69 inline uint32 replace(uint64 oldID, uint64 newID);
70 inline void sort(); // Entures id numbers organized from highest to lowest.
71
72 static inline size_t hash(const FaceID &fid);
73
74 private:
75 std::array<uint64, numGPperFace_> id_;
76 };
77
80 class IZone : public models::IGenericZone {
81 public:
83 inline static const TType type_ = 0x4c815bf8;
84 enum class Change { MechNull, AddToList, RemoveFromList, FlNull, ThNull };
86 enum class Code {
87#ifdef THREED
88 Brick=0,
89 Wedge,
90 Pyramid,
91 DBrick,
92 Tetra
93#else
94 Quad = 0,
95 Tria
96#endif
97 };
98 struct IFacePair {
99 const IZone *zone_=nullptr;
100 uint32 side_=0;
101 };
102
104 const IThing * getIThing() const override =0;
106 IThing * getIThing() override =0;
109 virtual const IZone * getNext() const=0;
112 virtual IZone * getNext()=0;
114 virtual uint32 getNumGp() const=0;
116 virtual uint32 getNumFace() const=0;
119 virtual const IGp * getGp(uint32 index) const=0;
122 virtual uint32 getFaceSize(uint32 face) const=0;
126 virtual const IGp * getFaceGp(uint32 face,uint32 index) const=0;
130 virtual uint32 getFaceGpIndex(uint32 face,uint32 index) const=0;
134 virtual uint32 getEdgeGpIndex(uint32 edge, uint32 index) const=0;
135
136 virtual FaceID getFaceID(uint32 side) const=0;
137
141 //virtual uint32 getFaceOnEdge(uint32 edge, uint32 index) const=0;
142
145 virtual DVect getFaceNormal(uint32 face,bool normalize) const=0;
148 virtual DVect getFaceCentroid(uint32 face) const=0;
151 virtual const IZone * getJoin(uint32 face) const=0;
152 // Face Group support
154 virtual const IGroup * getFaceGroup(uint32 side,const ISlotID &slot=ISlotID((uint32)0)) const=0;
158 virtual QString getFaceGroupName(uint32 side,const ISlotID &slot=ISlotID()) const=0;
161 virtual bool addFaceGroup(uint32 side,const IGroupID &group)=0;
163 virtual bool removeFaceGroup(uint32 side,const IGroupID &group)=0;
166 virtual uint32 isFaceInGroup(uint32 side,const FArray<IGroupID> &ids,TType type=0,bool only=false) const=0;
168 virtual uint32 getFaceGroupList(uint32 side,FArray<IGroupID> *list) const=0;
170 virtual void copyFaceGroups(uint32 side,const IThing *t)=0;
173 virtual uint32 getFaceExtraSize(uint32 side) const=0;
175 virtual const fish::IParameter *getFaceExtra(uint32 side,uint32 index) const=0;
178 virtual void setFaceExtra(uint32 side,uint32 index,const fish::IParameter &p)=0;
180 virtual bool getFaceHidden(uint32 side) const=0;
182 virtual bool setFaceHidden(uint32 side,bool b)=0;
184 virtual bool getFaceSelected(uint32 side) const=0;
186 virtual bool setFaceSelected(uint32 side,bool b)=0;
188 virtual bool isFaceInRange(uint32 side,const IRange *range) const=0;
190 virtual double getDensity() const=0;
192 virtual void setDensity(const double &d)=0;
194 virtual double getFluidDensity() const=0;
196 virtual bool isMechanicalNull() const=0;
198 virtual bool isThermalNull() const = 0;
200 virtual bool isFluidNull() const = 0;
202 virtual Code getCode() const=0;
205 virtual double getAspectTest() const=0;
208 virtual double getAspectTetTest() const=0;
210 virtual void copyState(const IZone *zone)=0;
212 virtual string getFlowModel() const=0;
214 virtual DVect getThermalFlux() const=0; // jkf: should be const
217 virtual int getFace(const FaceID &fid) const=0;
230 enum class StrainMode { ShearRate=1, ShearInc=2, VolRate=3, VolInc=4, FullRate=5, FullInc=6, FullRotRate=7, FullRotInc=8 };
231 virtual double getSSR(StrainMode mode,SymTensor *fsr) const=0;
232 virtual SymTensor getTetStrainRate(int overlay,int number) const=0;
233 virtual SymTensor getTetStrainIncrement(int overlay,int number) const=0;
234 virtual SymTensor getStrainRate() const=0;
235 virtual SymTensor getStrainIncrement() const=0;
237 virtual string getIsDegenerate() const =0;
239 virtual string getSupports2Overlays() const =0;
240 virtual string getCheckGeom() const = 0;
242 virtual const ITet * getOverlay(uint32 ov) const=0;
244 virtual ITet * getOverlay(uint32 ov)=0;
246 virtual const IHysDamp * getHysDamp() const=0;
248 virtual IHysDamp * getHysDamp() =0;
249 virtual IHysDamp * setHysDamp() =0;
250
252 virtual int initializeModels()=0;
254 virtual bool getHasALiveMechModel() const=0;
256 virtual bool getHasALiveFluidModel() const=0;
258 virtual bool getHasALiveThermModel() const=0;
260 virtual string getModelName() const=0;
261 virtual const models::ConstitutiveModel *getModel() const=0;
264 virtual void setModelName(const string &qs) =0;
266 virtual double getSmallestNormalizedTetVolume(bool deformed=false) const=0;
267#ifdef THREED
272 virtual double getQualityTest(int iTestNum) const=0;
274 virtual double getPlanarity() const=0;
275#endif
277 virtual int getNumTets() const =0;
279 virtual double getOrthoTest() const=0;
281 virtual double getVolumeTest() const=0;
283 virtual double getZoneCondition(int i=0) const=0;
284#ifdef TWOD
286 virtual bool getBadZoneExtruder() const=0;
287#endif
289 virtual double getAvePP() const=0;
292 virtual base::Property getProperty(const string &sc) const =0;
293 virtual base::Property getProperty(uint32 index) const=0;
296 virtual bool setProperty(const string &sc,const base::Property &v) =0;
297 virtual bool setProperty(int index,const base::Property &v) =0;
300 virtual double getVolumeD(bool deformed) const=0;
301 virtual double getVolume() const=0;
303 virtual DVect getCentroid() const=0;
305 virtual SymTensor getAveStress(bool effective=false) const=0;
307 virtual double getAvgTemp() const=0;
309 virtual DVect getFlowVector() const=0;
315 virtual uint32 getAvgState(int *piNum, bool bAvgKeyword, bool noPast=false) const=0;
318 virtual string getStateName(uint32 bit) const=0;
327 virtual void setStress(const double &val,uint32 pn)=0;
329 virtual void setStress(const SymTensor &sym)=0;
332 virtual void setState(uint32 state)=0;
337 virtual void getTetGridPoints(int iOverlay, int iTet, IGp *gplist[]) =0;
339 virtual const IThermZone * getIThermZone() const=0;
341 virtual IThermZone * getIThermZone() =0;
343 virtual StringList getPropertyNames() const=0;
346 virtual uint32 getPropertyIndex(const string &sc) const=0;
349 virtual string getPropertyName(uint32 index) const=0;
352 virtual bool getBit(int bit) const=0;
357 virtual void setBit(int bit,bool b) const=0;
360 virtual QVariant getValue(int index) const=0;
364 virtual void setValue(int index,const QVariant &v) const=0;
366 virtual const IFluidZone * getIFluidZone() const=0;
368 virtual IFluidZone * getIFluidZone() =0;
370 virtual const IDynZone * getIDynZone() const=0;
372 virtual IDynZone * getIDynZone() =0;
375 virtual IZone * getLinkZone(uint32 index)=0;
376 virtual const IZone * getLinkZone(uint32 index) const=0;
380 virtual uint32 getLinkIndex(uint32 index) const=0;
381
386 virtual bool fishIO(bool save,fish::File *pnt)=0;
391 virtual double getStrengthStressRatio(const SymTensor &s) const=0;
396 //virtual QString applyBoundaryCondition(uint32 face,QString item,QString options,const double &val)=0;
397
399 virtual double getWPVol() const =0;
401 virtual void setWPVol(const double &dwpv)=0;
403 virtual double getWPShear() const=0;
405 virtual void setWPShear(const double &dwps)=0;
407 virtual double getWPTotal() const=0;
409 virtual double getWEVol() const =0;
411 virtual void setWEVol(const double &dwpv)=0;
413 virtual double getWEShear() const=0;
415 virtual void setWEShear(const double &dwps)=0;
417 virtual double getWETotal() const=0;
420 virtual void setFluidModel(const string &name)=0;
422 virtual string getFluidModel(bool exception=true)const=0;
424 virtual StringList getFluidProperties()const=0;
426 virtual double getFluidProp(const string &name,bool exception=true) const =0;
427 virtual int getFluidPropIndex(const string &name) const=0;
428 virtual double getFluidProp(uint32 index) const=0;
430 virtual void setFluidProp(const string &name, const double &val)=0;
431 virtual void setFluidProp(int index, const double &val)=0;
434 virtual void setThermModel(const string &name)=0;
436 virtual StringList getThermProperties() const=0;
438 virtual string getThermModel(bool exception=true)const=0;
440 virtual double getThermProp(const string &name,bool exception=true) const =0;
441 virtual int getThermPropIndex(const string &name) const=0;
442 virtual double getThermProp(uint32 index) const=0;
444 virtual void setThermProp(const string &name, const double &val)=0;
445 virtual void setThermProp(int index, const double &val)=0;
446
448 //virtual StringList getPermeabilityProperties() const = 0;
450 //virtual string getPermeabilityModel(bool exception = true)const = 0;
452 //virtual base::Property getPermeabilityProp(uint32 index) const = 0;
454 //virtual void setPermeabilityProp(int index,const base::Property &val) = 0;
455
462 virtual bool invalidZone(bool mech=true,bool therm=false,bool fluid=false,bool orVal=false) const=0;
470 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
471 virtual bool checkZoneForPlot(bool removeHidden,bool showSelected,bool hideMech,bool hideTherm,bool hideFluid) const=0;
472
473 struct FaceCheckInput {
474 uint32 side_ = 0;
475 bool internalFaces_ = false; // Show ALL faces, not just surface faces.
476 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).
477 bool zoneFace_ = false; // If true, then being used for plot of faces (as opposed to a plot of zones).
478 bool onlySelectedFaces_ = false; // Only show selected faces (ignored if zoneFace_ is false).
479 };
480 struct FaceCheckOutput { // Filled out only if return value is true.
481 bool selected_ = false; // True if zone or face is selected (based on zoneFace_ flag).
482 uint64 id_ = 0; // ID number of zones
483 FArray<DVect> vertices_; // Vertices of zone face.
484
485 };
486 virtual bool checkFaceForPlot(const FaceCheckInput &inp,FaceCheckOutput *outp) const=0;
487 virtual bool checkFaceForPlotFace(uint32 side,uint64 *id,FArray<DVect> *vertices,bool excludeSelected=true) const=0;
488 virtual bool checkFaceForPlotFaceSelected(uint32 side,uint64 *id,FArray<DVect> *vertices) const=0;
489 virtual void fillZoneVertices(FArray<DVect> *vertices) const=0;
490 virtual void fillAllZoneFaces(FArray<FArray<DVect>> *allVertices,bool *selected,uint64 *id) const=0;
491 virtual int findFaceNormal(const DVect &v) const=0;
492 virtual double getMultiplier() const=0;
493 virtual bool CMSupportsHysDamp()const {return false;} ;
494 };
495
496 inline size_t FaceID::hash(const FaceID& fid) {
497 size_t ret = std::hash<uint64>()(fid.id_[0]);
498 for (uint32 i = 1; i<size(); ++i)
499 ret ^= std::hash<uint64>()(fid.id_[i]);
500 return ret;
501 }
502
503 inline uint32 FaceID::replace(uint64 oldID, uint64 newID) {
504 uint32 count(0);
505 for (uint32 i = 0; i<size();++i) {
506 if (id_[i]==oldID) {
507 id_[i] = newID;
508 count++;
509 }
510 }
511 if (count)
512 sort();
513 return count;
514
515 }
516
517 void FaceID::sort() {
518 if (id_[1]>id_[0])
519 std::swap(id_[0], id_[1]);
520#ifdef THREED
521 if (id_[2]>id_[1]) {
522 std::swap(id_[2], id_[1]);
523 if (id_[1]>id_[0])
524 std::swap(id_[0], id_[1]);
525 }
526 if (id_[3]>id_[2]) {
527 std::swap(id_[3], id_[2]);
528 if (id_[2]>id_[1]) {
529 std::swap(id_[2], id_[1]);
530 if (id_[1]>id_[0])
531 std::swap(id_[0], id_[1]);
532 }
533 }
534#endif
535 }
536} // namespace zone
537namespace std {
538 template <> struct hash<zone::FaceID> {
539 size_t operator()(const zone::FaceID& fid) const { return zone::FaceID::hash(fid); }
540 };
541}
542// EoF
FArray
An array class that attempts to minimize unnecessary heap access.
Definition farray.h:25
StringList
Definition basestring.h:77
SymTensor
A symmetric 2nd order tensor.
Definition symtensor.h:22
base::Property
Definition property.h:20
fish::IParameter
Definition iparameter.h:13
itasca::IGroup
Interface to a group object.
Definition igroup.h:9
itasca::IGroupID
Definition igroup.h:82
itasca::ISlotID
Definition igroup.h:41
itasca::IThing
Base class for items that will be stored in containers.
Definition ithing.h:30
itascaxd::IRange
Interface to a filter, used as the main method for filtering objects.
Definition irange.h:32
models::ConstitutiveModel
The base class for constitutive model plug-ins.
Definition conmodel.h:33
models::IGenericZone
Generic base class for the zone interface made available to the constitutive model system.
Definition igenericzone.h:23
zone::FaceID
Definition izone.h:55
zone::IDynZone
Interface to access dynamic zone data.
Definition idynzone.h:12
zone::IFace
Interface to zone faces.
Definition iface.h:23
zone::IFluidZone
Interface to access fluid zone data.
Definition ifluidzone.h:12
zone::IGp
Interface to provide access to a gridpoint.
Definition igp.h:56
zone::IHysDamp
Interface to hysteretic damping.
Definition ihysdamp.h:13
zone::ITet
Interface to one of the tetrahedra used to implement mixed-discretization in a zone.
Definition itet.h:26
zone::IThermZone
Interface to access zone thermal data.
Definition ithermzone.h:14
zone::IZone
Interface to provide access to a zone.
Definition izone.h:80
zone::IZone::getNumTets
virtual int getNumTets() const =0
Returns the number of tetrahedrons in the zone.
zone::IZone::getFluidDensity
virtual double getFluidDensity() const =0
Returns the zone fluid density.
zone::IZone::getIDynZone
virtual const IDynZone * getIDynZone() const =0
Returns a const pointer to the interface to access dynamic zone data.
zone::IZone::getProperty
virtual base::Property getProperty(const string &sc) const =0
zone::IZone::getOverlay
virtual const ITet * getOverlay(uint32 ov) const =0
Returns a const pointer to the head of the list of tetrahedron, Itet, comprising the first overlay.
zone::IZone::getThermModel
virtual string getThermModel(bool exception=true) const =0
Returns the name of the zone thermal model.
zone::IZone::setFluidProp
virtual void setFluidProp(const string &name, const double &val)=0
Sets the values of a given a fluid property name.
zone::IZone::getTetGridPoints
virtual void getTetGridPoints(int iOverlay, int iTet, IGp *gplist[])=0
zone::IZone::fishIO
virtual bool fishIO(bool save, fish::File *pnt)=0
zone::IZone::getNumGp
virtual uint32 getNumGp() const =0
Returns the number of gridpoints used by the zone.
zone::IZone::getNext
virtual const IZone * getNext() const =0
zone::IZone::getEdgeGpIndex
virtual uint32 getEdgeGpIndex(uint32 edge, uint32 index) const =0
zone::IZone::getWPTotal
virtual double getWPTotal() const =0
Returns the total shear plastic work dissipated (sum of getWPVol() and getWPShear()),...
zone::IZone::getFlowVector
virtual DVect getFlowVector() const =0
Returns the flow vector.
zone::IZone::getFaceSelected
virtual bool getFaceSelected(uint32 side) const =0
Returns TRUE if that face of the zone is marked as selected.
zone::IZone::setFaceHidden
virtual bool setFaceHidden(uint32 side, bool b)=0
Sets the hidden condition of that face of the zone, returns true if the condition changed.
zone::IZone::getZoneCondition
virtual double getZoneCondition(int i=0) const =0
Returns the condition of zone geometry.
zone::IZone::getVolumeD
virtual double getVolumeD(bool deformed) const =0
zone::IZone::setProperty
virtual bool setProperty(const string &sc, const base::Property &v)=0
zone::IZone::getThermProperties
virtual StringList getThermProperties() const =0
Returns the list of properties for the thermal model.
zone::IZone::getModelName
virtual string getModelName() const =0
Returns the name of the mechanical constitutive model present in the zone.
zone::IZone::getPropertyNames
virtual StringList getPropertyNames() const =0
returns a list of all the valid properties of the current constitutive model assigned to this zone
zone::IZone::getAspectTetTest
virtual double getAspectTetTest() const =0
zone::IZone::getFaceGpIndex
virtual uint32 getFaceGpIndex(uint32 face, uint32 index) const =0
zone::IZone::initializeModels
virtual int initializeModels()=0
Initialize all active models (Fluid, Thermal and mechanical). Returns 0 upon completion.
zone::IZone::setBit
virtual void setBit(int bit, bool b) const =0
zone::IZone::setState
virtual void setState(uint32 state)=0
zone::IZone::isFaceInRange
virtual bool isFaceInRange(uint32 side, const IRange *range) const =0
Returns TRUE if the FACE is considered in the range. Creates a temp Face class.
zone::IZone::getNumFace
virtual uint32 getNumFace() const =0
Returns the number of faces used by the zone.
zone::IZone::getIFluidZone
virtual const IFluidZone * getIFluidZone() const =0
Returns a const pointer to the interface to access fluid zone data.
zone::IZone::getIFluidZone
virtual IFluidZone * getIFluidZone()=0
Returns a pointer to the interface to access fluid zone data.
zone::IZone::setThermProp
virtual void setThermProp(const string &name, const double &val)=0
Sets the values of a given a thermal property name.
zone::IZone::getHasALiveThermModel
virtual bool getHasALiveThermModel() const =0
Returns true if the zone contains a non-null thermal model.
zone::IZone::getHysDamp
virtual IHysDamp * getHysDamp()=0
Returns a const pointer to the Hysteretic Damping model, IHysDamp, or null if the zone does not suppo...
zone::IZone::getBit
virtual bool getBit(int bit) const =0
zone::IZone::getWEShear
virtual double getWEShear() const =0
Returns the total shear elastic work, see SET ENERGY command.
zone::IZone::getSupports2Overlays
virtual string getSupports2Overlays() const =0
Returns true if the Zone supports two overlays.
zone::IZone::isMechanicalNull
virtual bool isMechanicalNull() const =0
Returns true if the Mechanical model in the zone is null, returns \ b false otherwise.
zone::IZone::setValue
virtual void setValue(int index, const QVariant &v) const =0
zone::IZone::getAvgState
virtual uint32 getAvgState(int *piNum, bool bAvgKeyword, bool noPast=false) const =0
Returns a mask filled with a state indicator for the zone.
zone::IZone::getFlowModel
virtual string getFlowModel() const =0
Returns the name of the fluid flow model used by the Zone, or "undefined" if the zone has not been co...
zone::IZone::getIThing
IThing * getIThing() override=0
returns a IThing pointer
zone::IZone::Code
Code
Possible Zone types code.
Definition izone.h:86
zone::IZone::StrainMode
StrainMode
Definition izone.h:230
zone::IZone::removeFaceGroup
virtual bool removeFaceGroup(uint32 side, const IGroupID &group)=0
Removes the association of a given group with face side.
zone::IZone::setWEVol
virtual void setWEVol(const double &dwpv)=0
Sets the total volumetric elastic work, see SET ENERGY command.
zone::IZone::getDensity
virtual double getDensity() const =0
Returns the zone density.
zone::IZone::getIThing
const IThing * getIThing() const override=0
returns a const IThing pointer
zone::IZone::getHasALiveFluidModel
virtual bool getHasALiveFluidModel() const =0
Returns true if the zone contains a non-null fluid model.
zone::IZone::getGp
virtual const IGp * getGp(uint32 index) const =0
zone::IZone::getAvgTemp
virtual double getAvgTemp() const =0
Retrieves the average of the zone gridpoints temperatures.
zone::IZone::getFluidProp
virtual double getFluidProp(const string &name, bool exception=true) const =0
Given a fluid property name, returns its value;.
zone::IZone::getHysDamp
virtual const IHysDamp * getHysDamp() const =0
Returns a const pointer to the Hysteretic Damping model, IHysDamp, or null if the zone does not suppo...
zone::IZone::isFluidNull
virtual bool isFluidNull() const =0
Returns true if the Fluid model in the zone is null, returns \ b false otherwise.
zone::IZone::getFluidProperties
virtual StringList getFluidProperties() const =0
Returns the list of properties for the fluid model.
zone::IZone::addFaceGroup
virtual bool addFaceGroup(uint32 side, const IGroupID &group)=0
zone::IZone::getVolumeTest
virtual double getVolumeTest() const =0
Performs an volume test on the zone.
zone::IZone::getLinkZone
virtual const IZone * getLinkZone(uint32 index) const =0
zone::IZone::getFaceGroup
virtual const IGroup * getFaceGroup(uint32 side, const ISlotID &slot=ISlotID((uint32) 0)) const =0
Given a face side and a group slot, returns a const pointer to an IGroup.
zone::IZone::getAspectTest
virtual double getAspectTest() const =0
zone::IZone::isThermalNull
virtual bool isThermalNull() const =0
Returns true if the Thermal model in the zone is null, returns \ b false otherwise.
zone::IZone::setModelName
virtual void setModelName(const string &qs)=0
zone::IZone::getWPShear
virtual double getWPShear() const =0
Returns the total shear plastic work dissipated, see SET ENERGY command.
zone::IZone::type_
static const TType type_
The type identification number for this class, for use in convert_cast() and convert_getcast().
Definition izone.h:83
zone::IZone::getCentroid
virtual DVect getCentroid() const =0
Returns the location of the centroid of the zone.
zone::IZone::getFaceGroupList
virtual uint32 getFaceGroupList(uint32 side, FArray< IGroupID > *list) const =0
Return all groups and all slots assigned to the face in a list.
zone::IZone::getIThermZone
virtual IThermZone * getIThermZone()=0
returns a pointer to the zone thermal extension data
zone::IZone::getFaceCentroid
virtual DVect getFaceCentroid(uint32 face) const =0
zone::IZone::getFace
virtual int getFace(const FaceID &fid) const =0
zone::IZone::getFaceNormal
virtual DVect getFaceNormal(uint32 face, bool normalize) const =0
zone::IZone::getPropertyIndex
virtual uint32 getPropertyIndex(const string &sc) const =0
zone::IZone::copyFaceGroups
virtual void copyFaceGroups(uint32 side, const IThing *t)=0
Copy the groups in IThing object to face /side.
zone::IZone::setFaceSelected
virtual bool setFaceSelected(uint32 side, bool b)=0
sets the selected condition of that face of the zone, returns true if the condition chagned.
zone::IZone::getIThermZone
virtual const IThermZone * getIThermZone() const =0
returns a constant pointer to the zone thermal extension data
zone::IZone::copyState
virtual void copyState(const IZone *zone)=0
Copies the state information from zone zone to the current zone.
zone::IZone::getCode
virtual Code getCode() const =0
Returns the Code corresponding the the Zone type, see the Code enumeration.
zone::IZone::setWPShear
virtual void setWPShear(const double &dwps)=0
Sets the total shear plastic work dissipated, see SET ENERGY command.
zone::IZone::setThermModel
virtual void setThermModel(const string &name)=0
zone::IZone::isFaceInGroup
virtual uint32 isFaceInGroup(uint32 side, const FArray< IGroupID > &ids, TType type=0, bool only=false) const =0
zone::IZone::getThermProp
virtual double getThermProp(const string &name, bool exception=true) const =0
Given a thermal property name, returns its value;.
zone::IZone::getWPVol
virtual double getWPVol() const =0
Returns the total volumetric plastic work dissipated, see SET ENERGY command.
zone::IZone::setStress
virtual void setStress(const SymTensor &sym)=0
Assign the stress state in sym to the zone, overwriting every overlay tetrahedron.
zone::IZone::getHasALiveMechModel
virtual bool getHasALiveMechModel() const =0
Returns true if the zone contains a non-null mechanical constitutive model.
zone::IZone::getFluidModel
virtual string getFluidModel(bool exception=true) const =0
Returns the name of the zone fluid model.
zone::IZone::getFaceGp
virtual const IGp * getFaceGp(uint32 face, uint32 index) const =0
zone::IZone::getLinkZone
virtual IZone * getLinkZone(uint32 index)=0
zone::IZone::getFaceHidden
virtual bool getFaceHidden(uint32 side) const =0
Returns TRUE if that face of the zone is marked as hidden.
zone::IZone::getIsDegenerate
virtual string getIsDegenerate() const =0
Returns non-empty string if the zone is degenerate.
zone::IZone::invalidZone
virtual bool invalidZone(bool mech=true, bool therm=false, bool fluid=false, bool orVal=false) const =0
zone::IZone::setWEShear
virtual void setWEShear(const double &dwps)=0
Sets the total shear elastic work, see SET ENERGY command.
zone::IZone::getFaceGroupName
virtual QString getFaceGroupName(uint32 side, const ISlotID &slot=ISlotID()) const =0
zone::IZone::setStress
virtual void setStress(const double &val, uint32 pn)=0
zone::IZone::setWPVol
virtual void setWPVol(const double &dwpv)=0
Sets the total volumetric plastic work dissipated, see SET ENERGY command.
zone::IZone::getOrthoTest
virtual double getOrthoTest() const =0
Performs an orthogonality test on the zone.
zone::IZone::getIDynZone
virtual IDynZone * getIDynZone()=0
Returns a pointer to the interface to access dynamic zone data.
zone::IZone::getFaceExtraSize
virtual uint32 getFaceExtraSize(uint32 side) const =0
zone::IZone::setFaceExtra
virtual void setFaceExtra(uint32 side, uint32 index, const fish::IParameter &p)=0
zone::IZone::getAveStress
virtual SymTensor getAveStress(bool effective=false) const =0
Computes the average of the overlays tetrahedron stress tensors.
zone::IZone::getFaceExtra
virtual const fish::IParameter * getFaceExtra(uint32 side, uint32 index) const =0
Given an index, returns a const pointer to IFishParam associated with this face side.
zone::IZone::getStrengthStressRatio
virtual double getStrengthStressRatio(const SymTensor &s) const =0
zone::IZone::getFaceSize
virtual uint32 getFaceSize(uint32 face) const =0
zone::IZone::getWEVol
virtual double getWEVol() const =0
Returns the total volumetric elastic work, see SET ENERGY command.
zone::IZone::setFluidModel
virtual void setFluidModel(const string &name)=0
zone::IZone::getStateName
virtual string getStateName(uint32 bit) const =0
zone::IZone::getJoin
virtual const IZone * getJoin(uint32 face) const =0
zone::IZone::getSmallestNormalizedTetVolume
virtual double getSmallestNormalizedTetVolume(bool deformed=false) const =0
Return the volume of the smallest tetrahedron in the overlays, normalized to the zone volume.
zone::IZone::getValue
virtual QVariant getValue(int index) const =0
zone::IZone::getNext
virtual IZone * getNext()=0
zone::IZone::setDensity
virtual void setDensity(const double &d)=0
Sets the zone density.
zone::IZone::getOverlay
virtual ITet * getOverlay(uint32 ov)=0
Returns a pointer to the head of the list of tetrahedron, Itet, comprising the first overlay.
zone::IZone::getLinkIndex
virtual uint32 getLinkIndex(uint32 index) const =0
zone::IZone::getPropertyName
virtual string getPropertyName(uint32 index) const =0
zone::IZone::getThermalFlux
virtual DVect getThermalFlux() const =0
Returns the thermal flux vector in the Zone, or a null vector if the zone has not been configured for...
zone::IZone::getAvePP
virtual double getAvePP() const =0
Retrieves the average of the zone gridpoints pore pressures.
zone::IZone::isInZn
virtual bool isInZn(const DVect &dv, const double &relTol=1.0e-5, bool use2=false) const =0
zone::IZone::getWETotal
virtual double getWETotal() const =0
Returns the total elastic work (sum of getWEVol() and getWEShear()), see SET ENERGY command.
dim.h
DIM - Provides code portability between 2D and 3D codes.
farray.h
An array class that attempts to minimize unnecessary heap access.
TType
uint32 TType
class type indicator
Definition basedef.h:46
itascaxd
#define itascaxd
Expands to itasca2d in 2D, itasca3d in 3D, for use as a namespace name....
Definition dim.h:175
DVect
DVect3 DVect
Vector of doubles, either 2D or 3D.
Definition dim.h:150
dimval
constexpr const U & dimval(const T &, const U &val3)
Returns the first argument in a 2D compile, and the second in a 3D compile.
Definition dim.h:190
igenericzone.h
Generic base class for the zone interface made available to the constitutive model system.
itasca
namespace Itasca
Definition basememory.cpp:10
itascaxd
Itasca Library standard namespace, specific to 2D or 3D.
Definition icontactmodule.h:4
models
The Constitutive Model interface library.
Definition conmodel.cpp:7
zone::IZone::FaceCheckInput
Definition izone.h:473
zone::IZone::FaceCheckOutput
Definition izone.h:480
zone::IZone::IFacePair
Definition izone.h:98