doxygen/html/ifacething_8h_source.html

#pragma once

// ifacething.h


#include "fortconv/fortdefc.h"


#include "fortconv/fortdefc.h"

#include "base/src/farray.h"


namespace itasca

{

  class IThing;

}


namespace block

{


  class IBlockThing;

  class IZoneThing;

  class IVertexThing;

  class IFlowPlaneThing;


  class IFaceThing

  {

  public:


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


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

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

    inline static const TType type_ = 0x521615ab;

    virtual FInt getFortranOffset() const=0;

    virtual uint64 getFaceID() const=0;

    virtual IBlockThing*         getBlockThing() const=0;

    virtual IZoneThing*          getZoneThing() const=0;

    virtual uint64             getBlockThingID() const=0;

    virtual uint64             getZoneThingID() const=0;

    virtual FArray<const IVertexThing *> getVertices() const=0;

    virtual FArray<uint64> getVertexIDs() const = 0;

    virtual FArray<DVect>        getVertexLocations() const=0;

    virtual DVect                getVertexLocation(uint32 i) const=0;

    virtual uint32              getJointsetID() const=0;

    virtual uint32              getFractureID() const=0;

    virtual DVect3               getNormal() const=0;

    virtual bool                getHidden() const=0;

    virtual double              getArea() const=0;

    virtual FInt                getFEFaceOffset() const=0;

    virtual bool   isFaceFace(const IBlockThing *bt) const=0;

    virtual bool isZoneFace() const = 0;

    virtual bool isValid() const=0;

    virtual IFlowPlaneThing *    getFlowPlane() const=0;

    virtual uint32 getNumGP() const=0;

    virtual IVertexThing * getGP(uint32 n) const=0;

    virtual bool                 isExcavated() const=0;

    virtual bool                 isRemoved() const=0;

    virtual bool                 isPlanar() const = 0;

    virtual double               getMinEdgeLength() const = 0;

    virtual IBlockThing*         getFaceBlockThing() const = 0;

    virtual double               getFactorOfSafety() const = 0;

    virtual void                 setFactorOfSafety(double d) = 0;

    virtual bool                getBit() const=0;

    virtual void                setBit(bool b) 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::IFaceThing
This is the interface for FaceThing, a class that holds extra data not in the fortran arrays....
Definition ifacething.h:33

block::IFaceThing::getVertexLocation
virtual DVect getVertexLocation(uint32 i) const =0
get location for specified vertex (0 based)

block::IFaceThing::isFaceFace
virtual bool isFaceFace(const IBlockThing *bt) const =0
returns true if there is no f-f contact between the face and input block

block::IFaceThing::setBit
virtual void setBit(bool b) const =0
Sets the boolean bit of the face.

block::IFaceThing::getFaceID
virtual uint64 getFaceID() const =0
Return Thing ID.

block::IFaceThing::getGP
virtual IVertexThing * getGP(uint32 n) const =0
Return gridpoint n (0 < n < 2)

block::IFaceThing::isValid
virtual bool isValid() const =0
Return true if FaceThing and Fortran face are in sync.

block::IFaceThing::isExcavated
virtual bool isExcavated() const =0
Return true if face is on an excavated block.

block::IFaceThing::isPlanar
virtual bool isPlanar() const =0
Return true if face is planar.

block::IFaceThing::getBlockThingID
virtual uint64 getBlockThingID() const =0
Return host blockthing id.

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

block::IFaceThing::isRemoved
virtual bool isRemoved() const =0
Return true if face is on a removed block.

block::IFaceThing::getJointsetID
virtual uint32 getJointsetID() const =0
Return face joint set id number (this is joint id resulting from jset command)

block::IFaceThing::cpp
static const FInt cpp
offset for FaceThing ID
Definition ifacething.h:37

block::IFaceThing::getHidden
virtual bool getHidden() const =0
Returns true if face or host zone or host block is hidden.

block::IFaceThing::getVertices
virtual FArray< const IVertexThing * > getVertices() const =0
Get a list of vertexthings that make up this face.

block::IFaceThing::getFlowPlane
virtual IFlowPlaneThing * getFlowPlane() const =0
Return flow plane associated with the face. Return nullptr if none.

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

block::IFaceThing::getFaceBlockThing
virtual IBlockThing * getFaceBlockThing() const =0
Return host fblockthing (nullptr if not a faceblock)

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

block::IFaceThing::getArea
virtual double getArea() const =0
Return the area of the face.

block::IFaceThing::getVertexIDs
virtual FArray< uint64 > getVertexIDs() const =0
Get list of vertexids.

block::IFaceThing::getBit
virtual bool getBit() const =0
Returns the boolean bit of the face.

block::IFaceThing::getMinEdgeLength
virtual double getMinEdgeLength() const =0
Return the minumum edge length of the face.

block::IFaceThing::getFEFaceOffset
virtual FInt getFEFaceOffset() const =0
Return offset of corresponding Finite Element face. Required for ranges.

block::IFaceThing::getNumGP
virtual uint32 getNumGP() const =0
Return number of gridpoints.

block::IFaceThing::isZoneFace
virtual bool isZoneFace() const =0

block::IFaceThing::getFractureID
virtual uint32 getFractureID() const =0
Return face fracture id number (this is id of a single fracture)

block::IFaceThing::getVertexLocations
virtual FArray< DVect > getVertexLocations() const =0
Get a list of vertex locations that make up this face.

block::IFaceThing::getNormal
virtual DVect3 getNormal() const =0
Return normal vector to face.

block::IFaceThing::setFactorOfSafety
virtual void setFactorOfSafety(double d)=0
Set the safety factor of the face.

block::IFaceThing::getBlockThing
virtual IBlockThing * getBlockThing() const =0
Return host blockthing.

block::IFaceThing::getZoneThing
virtual IZoneThing * getZoneThing() const =0
Return host zonething. Returns NULL if unzoned (rigid).

block::IFaceThing::getFactorOfSafety
virtual double getFactorOfSafety() const =0
Return the safety factor of the face.

block::IFaceThing::type_
static const TType type_
type used in IThing typing system
Definition ifacething.h:44

block::IFaceThing::getZoneThingID
virtual uint64 getZoneThingID() const =0
Return host zonething id. Returns 0 if unzoned (rigid).

block::IFlowPlaneThing
Definition iflowplanething.h:29

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

block::IZoneThing
This is the interface for ZoneThing, a class that holds extra data not in the fortran arrays....
Definition izonething.h:36

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

DVect
DVect3 DVect
Vector of doubles, either 2D or 3D.
Definition dim.h:156

itasca
namespace Itasca
Definition basememory.cpp:14