Itasca C++ Interface
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
isubcontactthing.h
Go to the documentation of this file.
1 #pragma once
2 // isubcontactthing.h
3 
4 #include "iblockdef.h"
5 
11 namespace itasca
12 {
13  class IThing;
14 }
15 
16 namespace block
17 {
18  class IFaceThing;
19  class IVertexThing;
20  class IContactThing;
21  class IBlockThing;
22  class IFlowZoneThing;
23  class IFlowPlaneVertexThing;
24 
31  class ISubcontactThing
32  {
33  public:
35  enum SubcontactType {VertexFace=0, EdgeEdge};
37  inline static const TType type_ = 0x4f54d345;
39  virtual const itasca::IThing * getIThing() const=0;
41  virtual itasca::IThing * getIThing()=0;
43  virtual FInt getFortranOffset() const=0;
45  virtual quint64 getSubcontactID() const=0;
47  virtual const IContactThing * getHostContact() const=0;
49  virtual quint64 getHostContactID() const=0;
51  virtual DVect3 getLocation() const=0;
53  virtual bool getHidden() const=0;
55  virtual IFaceThing * getFace() const=0;
57  virtual quint64 getFaceID() const=0;
59  virtual IVertexThing * getVertex() const=0;
61  virtual quint64 getVertexID() const=0;
64  virtual quint64 getFractureID() const=0;
66  virtual quint64 getDFN_ID() const = 0;
68  virtual QString getDFN_name() const = 0;
70  virtual int getMaterial() const=0;
72  virtual QString getMaterialString() const = 0;
74  virtual int getConstitutive() const=0;
76  virtual DVect3 getShearForce() const=0;
78  virtual void setShearForce(const DVect3 &dv)=0;
80  virtual double getNormalForce() const=0;
81  // Set the normal force magnitude
82  virtual void setNormalForce(double nf)=0;
84  virtual DVect3 getShearDisplacement() const=0;
86  virtual void setShearDisplacement(const DVect3 &dv)=0;
88  virtual double getNormalDisplacement() const=0;
90  virtual void setNormalDisplacement(double nd)=0;
93  virtual double getArea() const=0;
95  virtual double getNormalStress() const=0;
97  virtual double getShearStress() const=0;
99  virtual QString getModel() const=0;
101  virtual void setModel(const QString &s)=0;
103  virtual QString getStateString() const=0;
105  virtual int getState() const=0;
107  virtual void setState(int i)=0;
109  virtual const IBlockThing * getBlock1() const=0;
111  virtual const IBlockThing * getBlock2() const=0;
113  virtual quint64 getBlock1_ID() const=0;
115  virtual quint64 getBlock2_ID() const=0;
117  virtual QStringList getProperties() const=0;
120  virtual UInt getPropertyIndex(const QString &prop) const=0;
123  virtual QVariant getProperty(UInt index) const=0;
125  virtual void setProperty(const QString &prop, QVariant val) = 0;
127  virtual SubcontactType getSubcontactType() const=0;
129  virtual double getPorePressure() const=0;
131  virtual void setPorePressure(double d)=0;
133  virtual IFlowZoneThing * getFlowZone() const=0;
135  virtual IFlowPlaneVertexThing* getFlowVertex() const = 0;
137  virtual bool isExcavated() const=0;
139  virtual double getInitialAperture() const=0;
141  virtual void setInitialAperture(double ap0)=0;
144  virtual bool getBit(int bit) const=0;
150  virtual void setBit(int bit,bool b) const=0;
152  virtual DVect3 getShearVelocity() const=0;
154  virtual double getMaxShear() const=0;
156  virtual void setMaxShear(double d) = 0;
158  virtual double getEnergy(UInt i) const = 0;
159  virtual double getEnergy(const QString& e) const = 0;
160  virtual double getTotalEnergy() const = 0;
162  virtual IBlockThing* getFaceBlock1() const = 0;
164  virtual IBlockThing* getFaceBlock2() const = 0;
166  virtual bool isBonded() const = 0;
168  virtual double getFOS() const = 0;
169 
170 
171 
172 
173 
174  };
175 
176 } // end namespace block
177 // EOF
block::ISubcontactThing::isBonded
virtual bool isBonded() const =0
Return true if subcontact has non-zero strength and has not failed.
block::IContactThing
Definition: icontactthing.h:30
block::ISubcontactThing::getSubcontactID
virtual quint64 getSubcontactID() const =0
Return Thing ID.
block::ISubcontactThing::setNormalDisplacement
virtual void setNormalDisplacement(double nd)=0
Set the normal displacement.
block::ISubcontactThing::getVertex
virtual IVertexThing * getVertex() const =0
Returns the vertex associated with this subcontact. null for no vertex.
block::ISubcontactThing::getConstitutive
virtual int getConstitutive() const =0
Return constitutive model number.
itasca
namespace Itasca
Definition: basememory.cpp:9
block::ISubcontactThing::getEnergy
virtual double getEnergy(UInt i) const =0
Return energy.
FInt
Int FInt
Interface to provide access to 3DEC modules, global data, list of 3DEC entities, etc.
Definition: iblockdef.h:19
block::ISubcontactThing::getVertexID
virtual quint64 getVertexID() const =0
Returns the Vertex ID associated with the subcontact. 0 for no vertex.
itasca::IThing
Base class for items that will be stored in containers.
Definition: ithing.h:31
block::ISubcontactThing
This is the interface for SubcontactThing, a class that holds extra data not in the fortran arrays....
Definition: isubcontactthing.h:31
block::ISubcontactThing::getFractureID
virtual quint64 getFractureID() const =0
block::ISubcontactThing::getBlock1
virtual const IBlockThing * getBlock1() const =0
Return block 1 of the subcontact.
block::ISubcontactThing::getFaceBlock2
virtual IBlockThing * getFaceBlock2() const =0
Return second fblockthing (nullptr if not a faceblock)
block::ISubcontactThing::setBit
virtual void setBit(int bit, bool b) const =0
iblockdef.h
Fortran to C++ type declarations.
block::ISubcontactThing::getShearForce
virtual DVect3 getShearForce() const =0
Return the shear force vector.
block::ISubcontactThing::getStateString
virtual QString getStateString() const =0
Get the subcontact failure state as a string.
block::ISubcontactThing::getBlock2_ID
virtual quint64 getBlock2_ID() const =0
Return id of block 2 of the subcontact.
block::ISubcontactThing::getPorePressure
virtual double getPorePressure() const =0
Return the pore pressure on the subcontact.
block::ISubcontactThing::getMaxShear
virtual double getMaxShear() const =0
Returns maximum shear displacement.
block::ISubcontactThing::isExcavated
virtual bool isExcavated() const =0
Return true if subcontact is excavate. False otherwise.
block::ISubcontactThing::getSubcontactType
virtual SubcontactType getSubcontactType() const =0
Return the subcontact type.
block::ISubcontactThing::SubcontactType
SubcontactType
enumeration of possible subcontact types
Definition: isubcontactthing.h:35
block::ISubcontactThing::getLocation
virtual DVect3 getLocation() const =0
Returns subcontact position.
block::IFlowPlaneVertexThing
This is the interface for FlowPlaneVertexThing, a C++ wrapper for a flow plane vertex This will be st...
Definition: iflowplanevertexthing.h:27
block::ISubcontactThing::getHostContactID
virtual quint64 getHostContactID() const =0
Return host contact id.
block::ISubcontactThing::getShearStress
virtual double getShearStress() const =0
Return the magnitude of shear stress.
block::ISubcontactThing::getNormalStress
virtual double getNormalStress() const =0
Return the normal stress.
block::ISubcontactThing::setModel
virtual void setModel(const QString &s)=0
Set joint constitutive model.
block::ISubcontactThing::getMaterialString
virtual QString getMaterialString() const =0
Return material as string.
UInt
unsigned int UInt
unsigned 32 bit
Definition: basedef.h:31
block::ISubcontactThing::getFlowVertex
virtual IFlowPlaneVertexThing * getFlowVertex() const =0
Return the flow plane vertex associated with the subcontact. Null if no flow.
block::IBlockThing
This is the interface for BlockThing, a class that holds extra data not in the fortran arrays....
Definition: iblockthing.h:31
block::ISubcontactThing::getBlock2
virtual const IBlockThing * getBlock2() const =0
Return block 2 of the subcontact.
TType
unsigned int TType
class type indicator
Definition: basedef.h:41
block::ISubcontactThing::setProperty
virtual void setProperty(const QString &prop, QVariant val)=0
Set property with name prop to value val.
block::ISubcontactThing::getProperty
virtual QVariant getProperty(UInt index) const =0
block::ISubcontactThing::type_
static const TType type_
type used in IThing typing system
Definition: isubcontactthing.h:37
block::ISubcontactThing::getDFN_ID
virtual quint64 getDFN_ID() const =0
Returns ID of DFN used to create contact. 0 if DFN was not used.
block::ISubcontactThing::setInitialAperture
virtual void setInitialAperture(double ap0)=0
Set the initial mechanical aperture.
block::ISubcontactThing::getMaterial
virtual int getMaterial() const =0
Return material number.
block::ISubcontactThing::getFortranOffset
virtual FInt getFortranOffset() const =0
Return contact fortran offset. Necessary for gui queries.
block::ISubcontactThing::getShearDisplacement
virtual DVect3 getShearDisplacement() const =0
Return the shear displacement vector.
block::ISubcontactThing::getDFN_name
virtual QString getDFN_name() const =0
Returns name of DFN used to create contact. Empty string if DFN was not used.
block::ISubcontactThing::getPropertyIndex
virtual UInt getPropertyIndex(const QString &prop) const =0
block::ISubcontactThing::getInitialAperture
virtual double getInitialAperture() const =0
Get the initial mechanical aperture.
block::ISubcontactThing::getBit
virtual bool getBit(int bit) const =0
block::ISubcontactThing::getModel
virtual QString getModel() const =0
Get the joint constitutive model as a string.
block::ISubcontactThing::getNormalForce
virtual double getNormalForce() const =0
Return the normal force magnitude.
block::ISubcontactThing::getHostContact
virtual const IContactThing * getHostContact() const =0
Return host ContactThing.
block::IVertexThing
This is the interface for VertexThing. This will be stored in a container and the ID will be stored i...
Definition: ivertexthing.h:28
block::ISubcontactThing::getNormalDisplacement
virtual double getNormalDisplacement() const =0
Return the normal displacement.
block::ISubcontactThing::getBlock1_ID
virtual quint64 getBlock1_ID() const =0
Return id of block 1 of the subcontact.
block::ISubcontactThing::getState
virtual int getState() const =0
Get the subcontact failure state as an integer.
block::ISubcontactThing::getFace
virtual IFaceThing * getFace() const =0
Returns the face associated with this subcontact. null for no face.
block::ISubcontactThing::setPorePressure
virtual void setPorePressure(double d)=0
Set the pore pressure on the subcontact.
block::ISubcontactThing::getProperties
virtual QStringList getProperties() const =0
returns a list of all the valid properties of the current constitutive model assigned to this subcont...
block::ISubcontactThing::setShearForce
virtual void setShearForce(const DVect3 &dv)=0
Set the shear force vector.
block::ISubcontactThing::getShearVelocity
virtual DVect3 getShearVelocity() const =0
Return the shear velocity vector.
block::ISubcontactThing::getHidden
virtual bool getHidden() const =0
Returns true if subcontact or host contact is hidden.
block::ISubcontactThing::getIThing
virtual const itasca::IThing * getIThing() const =0
Returns a const IThing pointer.
block::IFlowZoneThing
Definition: iflowzonething.h:24
block::ISubcontactThing::getFOS
virtual double getFOS() const =0
Return ratio of shear strength to shear stress.
block::ISubcontactThing::getFaceBlock1
virtual IBlockThing * getFaceBlock1() const =0
Return first fblockthing (nullptr if not a faceblock)
block::ISubcontactThing::getFlowZone
virtual IFlowZoneThing * getFlowZone() const =0
Return the flow zone associated with the subcontact. Null if no flow.
block::ISubcontactThing::getFaceID
virtual quint64 getFaceID() const =0
Returns the id of the face associated with this subcontact. 0 for no face.
block::ISubcontactThing::setMaxShear
virtual void setMaxShear(double d)=0
Set maximum shear displacement.
block::IFaceThing
This is the interface for FaceThing, a class that holds extra data not in the fortran arrays....
Definition: ifacething.h:32
block::ISubcontactThing::getArea
virtual double getArea() const =0
block::ISubcontactThing::setShearDisplacement
virtual void setShearDisplacement(const DVect3 &dv)=0
Set the shear displacement vector.
block::ISubcontactThing::setState
virtual void setState(int i)=0
Set the subcontact failure state.
Generated by   doxygen 1.8.15