doxygen/html/icontactthing_8h_source.html

#pragma once

// icontactthing.h


#include "iblockdef.h"

#include "base/src/farray.h"


namespace itasca

{

  class IThing;

}


namespace block

{


  class IBlockThing;

  class ISubcontactThing;

  class IFlowPlaneThing;


  class IContactThing

  {

  public:


    enum ContactType {Null=0, FaceFace, FaceEdge, FaceVertex, EdgeEdge, EdgeVertex, VertexVertex, Joined};

    enum StrainEnergyType {ESTotal=1, ESTensile, ESCompressive, ESShear};


    static const FInt cpp   = 38; // C++ extension from Fortran array


    inline static const TType type_ = 0x4f54d324;

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

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

    virtual uint64 getContactID() const=0;

    virtual FInt getFortranOffset() const=0;

    virtual DVect3              getLocation() const=0;

    virtual double              getSpare1() const=0;

    virtual uint64              getDFN_ID() const=0;

    virtual string    getDFN_name() const = 0;

    virtual bool                getHidden() const=0;

    virtual ContactType getContactType() const=0;

    virtual ContactType getOriginalContactType() const = 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 FArray<const ISubcontactThing *> getSubcontacts() const=0;

    virtual int getJointSet() const=0;

    virtual uint64 getFractureID() const=0;

    virtual int getMaterial() const=0;

    virtual int getConstitutive() const=0;

    virtual DVect3 getNormal() const=0;

    virtual double getArea() const=0;

    virtual bool      isExcavated() const=0;

    virtual bool      isRemoved() const=0;

    virtual const IFlowPlaneThing * getFlowPlane() const=0;

    virtual string getTypeString() const = 0;

    virtual double getStrainEnergy(StrainEnergyType t) const = 0;

    virtual double getFrictionEnergy() const = 0;

    virtual IBlockThing*         getFaceBlock1() const = 0;

    virtual IBlockThing*         getFaceBlock2() const = 0;

    virtual void triangulate() const=0;

    virtual void triangulateJoined() const= 0;

    virtual void findContactFace() = 0;

    virtual bool hasSubcontacts() const = 0;

  };


} // end namespace block

// EOF

FArray
An array class that attempts to minimize unnecessary heap access.
Definition farray.h:25

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::IContactThing::getFlowPlane
virtual const IFlowPlaneThing * getFlowPlane() const =0
Get Flow plane associated with this contact.

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

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

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

block::IContactThing::type_
static const TType type_
type used in IThing typing system
Definition icontactthing.h:43

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

block::IContactThing::isExcavated
virtual bool isExcavated() const =0
Returns true if either host block is marked as excavated.

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

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

block::IContactThing::getStrainEnergy
virtual double getStrainEnergy(StrainEnergyType t) const =0
Return strain energy for input type.

block::IContactThing::cpp
static const FInt cpp
offset for ContactThing ID
Definition icontactthing.h:40

block::IContactThing::getSpare1
virtual double getSpare1() const =0
Returns contents of contact first spare offset.

block::IContactThing::getContactID
virtual uint64 getContactID() const =0
Get ID of contact in C++ container (not Fortran offset)

block::IContactThing::triangulate
virtual void triangulate() const =0
Triangulate subcontacts for plotting.

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

block::IContactThing::getContactType
virtual ContactType getContactType() const =0
Return contact type.

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

block::IContactThing::StrainEnergyType
StrainEnergyType
enumeration of possible energy types
Definition icontactthing.h:37

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

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

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

block::IContactThing::getNormal
virtual DVect3 getNormal() const =0
Return the normal vector.

block::IContactThing::getLocation
virtual DVect3 getLocation() const =0
Returns contact position.

block::IContactThing::isRemoved
virtual bool isRemoved() const =0
Returns true if either host block is removed.

block::IContactThing::getTypeString
virtual string getTypeString() const =0
Return type of contact as a string.

block::IContactThing::hasSubcontacts
virtual bool hasSubcontacts() const =0
Return true if this contact has subcontacts.

block::IContactThing::getArea
virtual double getArea() const =0
Return area.

block::IContactThing::getFrictionEnergy
virtual double getFrictionEnergy() const =0
Return the frictional energy.

block::IContactThing::triangulateJoined
virtual void triangulateJoined() const =0
Triangulate subcontacts for plotting.

block::IContactThing::ContactType
ContactType
enumeration of possible contact types
Definition icontactthing.h:35

block::IContactThing::getOriginalContactType
virtual ContactType getOriginalContactType() const =0
Return original contact type.

block::IContactThing::findContactFace
virtual void findContactFace()=0
Find contact face for plotting.

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

block::IContactThing::getSubcontacts
virtual FArray< const ISubcontactThing * > getSubcontacts() const =0
Get array of SubcontactThings that make up this contact.

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

block::IContactThing::getJointSet
virtual int getJointSet() const =0
Return joint set or dfn number used to create contact.

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

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

block::IFlowPlaneThing
Definition iflowplanething.h:29

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

farray.h
An array class that attempts to minimize unnecessary heap access.

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