doxygen/html/isubcontactthing_8h_source.html

#pragma once

// isubcontactthing.h


#include "iblockdef.h"

#include "base/src/property.h"


namespace itasca

{

  class IThing;

}


namespace block

{

  class IFaceThing;

  class IVertexThing;

  class IContactThing;

  class IBlockThing;

  class IFlowZoneThing;

  class IFlowPlaneVertexThing;


  class ISubcontactThing

  {

  public:

    enum SubcontactType {VertexFace=0, EdgeEdge};

    inline static const TType type_ = 0x4f54d345;

    virtual const itasca::IThing *      getIThing() const=0;

    virtual itasca::IThing *            getIThing()=0;

    virtual FInt getFortranOffset() const=0;

    virtual uint64 getSubcontactID() const=0;

    virtual const IContactThing * getHostContact() const=0;

    virtual uint64 getHostContactID() const=0;

    virtual DVect3              getLocation() const=0;

    virtual bool                getHidden() const=0;

    virtual IFaceThing * getFace() const=0;

    virtual uint64 getFaceID() const=0;

    virtual IVertexThing * getVertex() const=0;

    virtual uint64 getVertexID() const=0;

    virtual uint64 getFractureID() const=0;

    virtual uint64    getDFN_ID() const = 0;

    virtual string    getDFN_name() const = 0;

    virtual int getMaterial() const=0;

    virtual string getMaterialString() const = 0;

    virtual int getConstitutive() const=0;

    virtual DVect3 getShearForce() const=0;

    virtual void setShearForce(const DVect3 &dv)=0;

    virtual double getNormalForce() const=0;

    // Set the normal force magnitude

    virtual void setNormalForce(double nf)=0;

    virtual DVect3 getShearDisplacement() const=0;

    virtual void setShearDisplacement(const DVect3 &dv)=0;

    virtual double getNormalDisplacement() const=0;

    virtual void setNormalDisplacement(double nd)=0;

    virtual double getArea() const=0;

    virtual double getNormalStress() const=0;

    virtual double getShearStress() const=0;

    virtual string getModel() const=0;

    virtual void setModel(const string &s)=0;

    virtual string getStateString() const=0;

    virtual int    getState() const=0;

    virtual void   setState(int i)=0;

    virtual const IBlockThing * getBlock1() const=0;

    virtual const IBlockThing * getBlock2() const=0;

    virtual uint64 getBlock1_ID() const=0;

    virtual uint64 getBlock2_ID() const=0;

    virtual StringList getProperties() const=0;

    virtual uint32        getPropertyIndex(const string &prop) const=0;

    virtual base::Property getProperty(uint32 index) const=0;

    virtual void setProperty(const string &prop, base::Property val) = 0;

    virtual SubcontactType getSubcontactType() const=0;

    virtual double getPorePressure() const=0;

    virtual void setPorePressure(double d)=0;

    virtual IFlowZoneThing * getFlowZone() const=0;

    virtual IFlowPlaneVertexThing* getFlowVertex() const = 0;

    virtual bool isExcavated() const=0;

    virtual double getInitialAperture() const=0;

    virtual void setInitialAperture(double ap0)=0;

    virtual bool                getBit(int bit) const=0;

    virtual void                setBit(int bit,bool b) const=0;

    virtual DVect3 getShearVelocity() const=0;

    virtual double getMaxShear() const=0;

    virtual void setMaxShear(double d) = 0;

    virtual double getEnergy(uint32 i) const = 0;

    virtual double getEnergy(const string& e) const = 0;

    virtual double getTotalEnergy() const = 0;

    virtual IBlockThing*         getFaceBlock1() const = 0;

    virtual IBlockThing*         getFaceBlock2() const = 0;

    virtual bool isBonded() const = 0;

    virtual double getFOS() const = 0;


  };


} // end namespace block

// EOF

StringList
Definition basestring.h:71

base::Property
Definition property.h:36

block::IBlockThing
This is the interface for BlockThing, a class that holds extra data not in the fortran arrays....
Definition iblockthing.h:33

block::IContactThing
Definition icontactthing.h:31

block::IFaceThing
This is the interface for FaceThing, a class that holds extra data not in the fortran arrays....
Definition ifacething.h:33

block::IFlowPlaneVertexThing
This is the interface for FlowPlaneVertexThing, a C++ wrapper for a flow plane vertex This will be st...
Definition iflowplanevertexthing.h:29

block::IFlowZoneThing
Definition iflowzonething.h:25

block::ISubcontactThing
This is the interface for SubcontactThing, a class that holds extra data not in the fortran arrays....
Definition isubcontactthing.h:33

block::ISubcontactThing::setState
virtual void setState(int i)=0
Set the subcontact failure state.

block::ISubcontactThing::getShearDisplacement
virtual DVect3 getShearDisplacement() const =0
Return the shear displacement vector.

block::ISubcontactThing::getHidden
virtual bool getHidden() const =0
Returns true if subcontact or host contact is hidden.

block::ISubcontactThing::getShearForce
virtual DVect3 getShearForce() const =0
Return the shear force vector.

block::ISubcontactThing::isExcavated
virtual bool isExcavated() const =0
Return true if subcontact is excavate. False otherwise.

block::ISubcontactThing::getNormalDisplacement
virtual double getNormalDisplacement() const =0
Return the normal displacement.

block::ISubcontactThing::getMaxShear
virtual double getMaxShear() const =0
Returns maximum shear displacement.

block::ISubcontactThing::setBit
virtual void setBit(int bit, bool b) const =0

block::ISubcontactThing::getIThing
virtual const itasca::IThing * getIThing() const =0
Returns a const IThing pointer.

block::ISubcontactThing::getBlock1_ID
virtual uint64 getBlock1_ID() const =0
Return id of block 1 of the subcontact.

block::ISubcontactThing::setInitialAperture
virtual void setInitialAperture(double ap0)=0
Set the initial mechanical aperture.

block::ISubcontactThing::getFortranOffset
virtual FInt getFortranOffset() const =0
Return contact fortran offset. Necessary for gui queries.

block::ISubcontactThing::getNormalStress
virtual double getNormalStress() const =0
Return the normal stress.

block::ISubcontactThing::getBlock2_ID
virtual uint64 getBlock2_ID() const =0
Return id of block 2 of the subcontact.

block::ISubcontactThing::getDFN_ID
virtual uint64 getDFN_ID() const =0
Returns ID of DFN used to create contact. 0 if DFN was not used.

block::ISubcontactThing::setMaxShear
virtual void setMaxShear(double d)=0
Set maximum shear displacement.

block::ISubcontactThing::getFlowVertex
virtual IFlowPlaneVertexThing * getFlowVertex() const =0
Return the flow plane vertex associated with the subcontact. Null if no flow.

block::ISubcontactThing::setProperty
virtual void setProperty(const string &prop, base::Property val)=0
Set property with name prop to value val.

block::ISubcontactThing::getArea
virtual double getArea() const =0

block::ISubcontactThing::setPorePressure
virtual void setPorePressure(double d)=0
Set the pore pressure on the subcontact.

block::ISubcontactThing::getPropertyIndex
virtual uint32 getPropertyIndex(const string &prop) const =0

block::ISubcontactThing::SubcontactType
SubcontactType
enumeration of possible subcontact types
Definition isubcontactthing.h:36

block::ISubcontactThing::getStateString
virtual string getStateString() const =0
Get the subcontact failure state as a string.

block::ISubcontactThing::getBlock2
virtual const IBlockThing * getBlock2() const =0
Return block 2 of the subcontact.

block::ISubcontactThing::getLocation
virtual DVect3 getLocation() const =0
Returns subcontact position.

block::ISubcontactThing::getDFN_name
virtual string getDFN_name() const =0
Returns name of DFN used to create contact. Empty string if DFN was not used.

block::ISubcontactThing::getInitialAperture
virtual double getInitialAperture() const =0
Get the initial mechanical aperture.

block::ISubcontactThing::getConstitutive
virtual int getConstitutive() const =0
Return constitutive model number.

block::ISubcontactThing::getBlock1
virtual const IBlockThing * getBlock1() const =0
Return block 1 of the subcontact.

block::ISubcontactThing::getModel
virtual string getModel() const =0
Get the joint constitutive model as a string.

block::ISubcontactThing::getProperties
virtual StringList getProperties() const =0
returns a list of all the valid properties of the current constitutive model assigned to this subcont...

block::ISubcontactThing::getSubcontactID
virtual uint64 getSubcontactID() const =0
Return Thing ID.

block::ISubcontactThing::getNormalForce
virtual double getNormalForce() const =0
Return the normal force magnitude.

block::ISubcontactThing::getPorePressure
virtual double getPorePressure() const =0
Return the pore pressure on the subcontact.

block::ISubcontactThing::getProperty
virtual base::Property getProperty(uint32 index) const =0

block::ISubcontactThing::getFace
virtual IFaceThing * getFace() const =0
Returns the face associated with this subcontact. null for no face.

block::ISubcontactThing::getShearStress
virtual double getShearStress() const =0
Return the magnitude of shear stress.

block::ISubcontactThing::getState
virtual int getState() const =0
Get the subcontact failure state as an integer.

block::ISubcontactThing::getFractureID
virtual uint64 getFractureID() const =0

block::ISubcontactThing::type_
static const TType type_
type used in IThing typing system
Definition isubcontactthing.h:38

block::ISubcontactThing::getMaterial
virtual int getMaterial() const =0
Return material number.

block::ISubcontactThing::getBit
virtual bool getBit(int bit) const =0

block::ISubcontactThing::getVertexID
virtual uint64 getVertexID() const =0
Returns the Vertex ID associated with the subcontact. 0 for no vertex.

block::ISubcontactThing::getFOS
virtual double getFOS() const =0
Return ratio of shear strength to shear stress.

block::ISubcontactThing::setNormalDisplacement
virtual void setNormalDisplacement(double nd)=0
Set the normal displacement.

block::ISubcontactThing::getFaceID
virtual uint64 getFaceID() const =0
Returns the id of the face associated with this subcontact. 0 for no face.

block::ISubcontactThing::getHostContact
virtual const IContactThing * getHostContact() const =0
Return host ContactThing.

block::ISubcontactThing::getEnergy
virtual double getEnergy(uint32 i) const =0
Return energy.

block::ISubcontactThing::setShearDisplacement
virtual void setShearDisplacement(const DVect3 &dv)=0
Set the shear displacement vector.

block::ISubcontactThing::getMaterialString
virtual string getMaterialString() const =0
Return material as string.

block::ISubcontactThing::getHostContactID
virtual uint64 getHostContactID() const =0
Return host contact id.

block::ISubcontactThing::isBonded
virtual bool isBonded() const =0
Return true if subcontact has non-zero strength and has not failed.

block::ISubcontactThing::setModel
virtual void setModel(const string &s)=0
Set joint constitutive model.

block::ISubcontactThing::getFaceBlock1
virtual IBlockThing * getFaceBlock1() const =0
Return first fblockthing (nullptr if not a faceblock)

block::ISubcontactThing::getFaceBlock2
virtual IBlockThing * getFaceBlock2() const =0
Return second fblockthing (nullptr if not a faceblock)

block::ISubcontactThing::getIThing
virtual itasca::IThing * getIThing()=0
Returns a IThing pointer.

block::ISubcontactThing::getFlowZone
virtual IFlowZoneThing * getFlowZone() const =0
Return the flow zone associated with the subcontact. Null if no flow.

block::ISubcontactThing::getVertex
virtual IVertexThing * getVertex() const =0
Returns the vertex associated with this subcontact. null for no vertex.

block::ISubcontactThing::getShearVelocity
virtual DVect3 getShearVelocity() const =0
Return the shear velocity vector.

block::ISubcontactThing::getSubcontactType
virtual SubcontactType getSubcontactType() const =0
Return the subcontact type.

block::ISubcontactThing::setShearForce
virtual void setShearForce(const DVect3 &dv)=0
Set the shear force vector.

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:30

itasca::IThing
Base class for items that will be stored in containers.
Definition ithing.h:31

TType
uint32 TType
class type indicator
Definition basedef.h:47

FInt
int64 FInt
Interface to provide access to 3DEC modules, global data, list of 3DEC entities, etc.
Definition iblockdef.h:14

iblockdef.h
Fortran to C++ type declarations.

itasca
namespace Itasca
Definition basememory.cpp:14