Itasca C++ Interface
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
block::IZoneThing Class Referenceabstract

This is the interface for ZoneThing, a class that holds extra data not in the fortran arrays. This will be stored in a container and the ID will be stored in offset $KZCPP in the fortran zone linked list. This inherits from Thing so we can use CellSpace. More...

#include <izonething.h>

Inheritance diagram for block::IZoneThing:
models::IGenericZone

Public Member Functions

virtual const itasca::IThinggetIThing () const =0
 Returns a const IThing pointer.
 
virtual itasca::IThinggetIThing ()=0
 Returns a IThing pointer.
 
virtual FInt getFortranOffset () const =0
 Return fortran offset. Necessary for gui queries.
 
virtual uint64 getZoneID () const =0
 Return the zone ID.
 
virtual bool getBit (int bit) const =0
 
virtual void setBit (int bit, bool b) const =0
 
virtual QVariant getValue (int index) const =0
 
virtual void setValue (int index, const QVariant &v) const =0
 Note - this is const through some hack so that we can use const ZoneThings when getting data.
 
virtual uint32 getNumVertices () const =0
 Returns the number of vertices used by the zone.
 
virtual uint32 getNumFaces () const =0
 Returns the number of faces used by the zone.
 
virtual const IVertexThinggetVertexThing (qint32 index) const =0
 
virtual uint64 getVertexThingID (qint32 index) const =0
 
virtual FInt getVertex (qint32 index) const =0
 
virtual uint32 getFaceSize (uint32 face) const =0
 
virtual const IVertexThinggetFaceVertexThing (uint32 face, uint32 index) const =0
 
virtual uint32 getFaceVertexIndex (uint32 face, uint32 index) const =0
 
virtual DVect3 getFaceNormal (uint32 face) const =0
 
virtual DVect3 getFaceCentroid (uint32 face) const =0
 
virtual const IFaceThinggetFaceThing (uint32 face) const =0
 Return 0 if not a block face.
 
virtual uint64 getFaceThingID (uint32 face) const =0
 
virtual const IZoneThinggetJoin (uint32 face) const =0
 
virtual double getDensity () const =0
 returns the zone density
 
virtual void setDensity (double d)=0
 sets the density of the individual zone (not the material density)
 
virtual const models::ConstitutiveModelgetCModel () const =0
 
virtual string getModelName () const =0
 Returns the name of the mechanical constitutive model present in the zone.
 
virtual void setModelName (const string &mname)=0
 Set constitutive modoel name.
 
virtual StringList getModelStates () const =0
 
virtual int getState () const =0
 Returns the code for the plastic state.
 
virtual void setState (int s)=0
 Sets the code for the plastic state.
 
virtual string getStateString (bool omitpaststate=false) const =0
 Returns string associated with state.
 
virtual uint32 getPropertyIndex (const string &sc) const =0
 
virtual string getPropertyName (uint32 index) const =0
 
virtual StringList getPropertyNames () const =0
 returns a list of all the valid properties of the current constitutive model assigned to this zone
 
virtual base::Property getProperty (uint index) const =0
 
virtual base::Property getProperty (const string &propName) const =0
 
virtual void setProperty (const string &sprop, base::Property val)=0
 Set property sprop to value. Returns false if property not found.
 
virtual const QStringList getThermProperties () const =0
 Returns the list of properties for the thermal model.
 
virtual uint32 getThermPropertyIndex (const QString &sc) const =0
 
virtual QVariant getThermProperty (uint index) const =0
 
virtual QVariant getThermProperty (const QString &propName) const =0
 
virtual bool setThermProperty (const QString &sprop, QVariant value)=0
 Set thermal property sprop to value. Returns false if property not found.
 
virtual const QStringList getFluidProperties () const =0
 Returns the list of properties for the matrix flow model.
 
virtual uint32 getFluidPropertyIndex (const QString &sc) const =0
 
virtual QVariant getFluidProperty (uint index) const =0
 
virtual QVariant getFluidProperty (const QString &propName) const =0
 
virtual bool setFluidProperty (const QString &sprop, QVariant value)=0
 Set fluid property sprop to value. Returns false if property not found.
 
virtual double getSpare () const =0
 Returns value of spare offset.
 
virtual SymTensor getStress (bool bEffective) const =0
 Return zone stress.
 
virtual void setStress (const SymTensor &st)=0
 Set the zone stress.
 
virtual double getPP () const =0
 Return zone pore pressure (= average of gridpoint pore pressures)
 
virtual SymTensor getStrainRate () const =0
 Return strain rate.
 
virtual SymTensor getStrainIncrement () const =0
 Return strain increment.
 
virtual SymTensor getRotStrainRate () const =0
 Return rotational strain rate.
 
virtual SymTensor getRotStrainIncrement () const =0
 Return rotational strain increment.
 
virtual FInt getBlock () const =0
 return fortran offset of host block
 
virtual IBlockThinggetBlockThing () const =0
 Return host blockthing.
 
virtual uint64 getBlockThingID () const =0
 Return host blockthing id.
 
virtual double getMass () const =0
 return zone mass
 
virtual int getMaterialNumber () const =0
 return zone material number
 
virtual bool isExcavated () const =0
 Returns total volumetric strain.
 
virtual bool isRemoved () const =0
 Returns true if zone is in a block that is removed.
 
virtual bool getHidden () const =0
 Returns true if zone or host block is hidden.
 
virtual double getZoneVolume () const =0
 Returns zone volume.
 
virtual uint32 getOverlay () const =0
 Returns overlay number (0-3). Used in quad zoning.
 
virtual double getMinEdgeLength () const =0
 Get minimum edge length.
 
virtual bool checkGoodForFLAC3D () const =0
 Checks to ascertain if the tet volume will be adequate for FLAC3D.
 
virtual DVect3 getFluidDischarge () const =0
 Get the fluid discharge vector.
 
virtual DVect3 getThermalFlux () const =0
 Get thermal flow vector.
 
virtual double getSxx () const =0
 Get xx component of stress.
 
virtual double getSyy () const =0
 Get yy component of stress.
 
virtual double getSzz () const =0
 Get zz component of stress.
 
virtual double getSxy () const =0
 Get xy component of stress (=yx)
 
virtual double getSxz () const =0
 Get xz component of stress (=zx)
 
virtual double getSyz () const =0
 Get yz component of stress (=zy)
 
virtual void setSxx (double s)=0
 Set xx component of stress.
 
virtual void setSyy (double s)=0
 Set yy component of stress.
 
virtual void setSzz (double s)=0
 Set zz component of stress.
 
virtual void setSxy (double s)=0
 Set xy component of stress (=yx)
 
virtual void setSxz (double s)=0
 Set xz component of stress (=zx)
 
virtual void setSyz (double s)=0
 Set yz component of stress (=zy)
 
virtual double getStrengthStressRatio (const SymTensor &s) const =0
 
virtual double getZoneCondition (int i) const =0
 Returns the condition of zone geometry.
 
virtual DVect3 getDeformedPosition (bool active, double factor) const =0
 Return the position of the gridpoint with deformation exaggerated by factor if active is true.
 
virtual double getSSI () const =0
 Return Shear Strain increment.
 
virtual double getSSR () const =0
 Return Shear Strain rate increment.
 
virtual double getVSI () const =0
 Return Volumetric Strain increment.
 
virtual double getVSR () const =0
 Return Volumetric Strain rate increment.
 
virtual DVect3 getLocation () const =0
 Returns zone position.
 
- Public Member Functions inherited from models::IGenericZone
virtual TType getType () const =0
 Returns the actual type of the fully derived class represented by this object.
 

Static Public Attributes

static const FInt cpp = 23
 offset to obtain pointer to zonething ID
 
static const TType type_ = 0x4ede2fe7
 type used in IThing typing system
 
- Static Public Attributes inherited from models::IGenericZone
static const TType type_ = 0x4e13414f
 The type of IGenericZone, used in the alternate dynamic typing system based on IThing.
 

Detailed Description

This is the interface for ZoneThing, a class that holds extra data not in the fortran arrays. This will be stored in a container and the ID will be stored in offset $KZCPP in the fortran zone linked list. This inherits from Thing so we can use CellSpace.

Member Function Documentation

◆ getBit()

virtual bool block::IZoneThing::getBit ( int bit) const
pure virtual

Returns the boolean stored in utility bit bit in the zone.

◆ getFaceCentroid()

virtual DVect3 block::IZoneThing::getFaceCentroid ( uint32 face) const
pure virtual

Returns the location of the centroid of face face in the global coordinate system.

Parameters
facestarts at 0, and must be lower than 4. This function is necessary because getFaceThing may return null if zone face is not a block face

◆ getFaceNormal()

virtual DVect3 block::IZoneThing::getFaceNormal ( uint32 face) const
pure virtual

Returns the unit normal vector to face face.

Parameters
facestarts at 0, and must be lower than 4. This function is necessary because getFaceThing may return null if zone face is not a block face

◆ getFaceSize()

virtual uint32 block::IZoneThing::getFaceSize ( uint32 face) const
pure virtual

Returns the number of gridpoints used by the face of index face.

Parameters
facestarts at 0, and must be lower than 4.

◆ getFaceThing()

virtual const IFaceThing * block::IZoneThing::getFaceThing ( uint32 face) const
pure virtual

Return 0 if not a block face.

Get FaceThing for face face

Parameters
facestarts at 0, and must be lower than 4.

◆ getFaceThingID()

virtual uint64 block::IZoneThing::getFaceThingID ( uint32 face) const
pure virtual

Get FaceThing ID for face face

Parameters
facestarts at 0, and must be lower than 4. Return 0 if not a block face

◆ getFaceVertexIndex()

virtual uint32 block::IZoneThing::getFaceVertexIndex ( uint32 face,
uint32 index ) const
pure virtual

Returns the index of the gridpoint on face face and vertex index.

Parameters
facestarts at 0, and must be lower than 4.
indexstarts at 0, and must be lower than 3.

◆ getFaceVertexThing()

virtual const IVertexThing * block::IZoneThing::getFaceVertexThing ( uint32 face,
uint32 index ) const
pure virtual

Returns a const pointer to the gridpoint on face face and vertex index.

Parameters
facestarts at 0, and must be lower than 4.
indexstarts at 0, and must be lower than 3 at the moment.

◆ getFluidProperty() [1/2]

virtual QVariant block::IZoneThing::getFluidProperty ( const QString & propName) const
pure virtual

Returns value of zone matrix flow property corresponding to propName
Returns 0 if propName is not recognized

◆ getFluidProperty() [2/2]

virtual QVariant block::IZoneThing::getFluidProperty ( uint index) const
pure virtual

Returns value of zone matrix flow property corresponding to index
Returns 0 if index is not valid

◆ getFluidPropertyIndex()

virtual uint32 block::IZoneThing::getFluidPropertyIndex ( const QString & sc) const
pure virtual

Given a matrix flow property name, returns the index of the property assigned to this zone.

Note
Base 1, returns 0 if name is not found.

◆ getIThing() [1/2]

virtual const itasca::IThing * block::IZoneThing::getIThing ( ) const
pure virtual

Returns a const IThing pointer.

Implements models::IGenericZone.

◆ getIThing() [2/2]

virtual itasca::IThing * block::IZoneThing::getIThing ( )
pure virtual

Returns a IThing pointer.

Implements models::IGenericZone.

◆ getJoin()

virtual const IZoneThing * block::IZoneThing::getJoin ( uint32 face) const
pure virtual

Returns a const pointer to the zone, IZoneThing, across face face.

Parameters
facestarts at 0, and must be lower than 4.

◆ getModelStates()

virtual StringList block::IZoneThing::getModelStates ( ) const
pure virtual

Returns all possible states of the mechanical constitutive model present in the zone. Space delimited string

◆ getProperty() [1/2]

virtual base::Property block::IZoneThing::getProperty ( const string & propName) const
pure virtual

Returns value of zone property corresponding to propName
Returns 0 if propName is not recognized

◆ getProperty() [2/2]

virtual base::Property block::IZoneThing::getProperty ( uint index) const
pure virtual

Returns value of zone property corresponding to index
Returns 0 if index is not valid

◆ getPropertyIndex()

virtual uint32 block::IZoneThing::getPropertyIndex ( const string & sc) const
pure virtual

Given a property name, returns the index of the property of the constitutive model assigned to this zone.

Note
Base 1, returns 0 if name is not found.

◆ getPropertyName()

virtual string block::IZoneThing::getPropertyName ( uint32 index) const
pure virtual

Given an index, returns the name of the property of the constitutive model assigned to this zone.

Note
Base 1, returns QString() if index is less then 1 or greater than the number of properties.

◆ getStrengthStressRatio()

virtual double block::IZoneThing::getStrengthStressRatio ( const SymTensor & s) const
pure virtual

Returns the Stress to Strength ratio based on the current constitutive model properties and stress state s.
The Stress to Strength ratio is greater than or equal to 1.0. A value of 1.0 means that the zone is failing If the zone does not currently have any assigned constitutive model, or if the loaded constitutive model does not support this operation, then a default value of 10 is returned.

◆ getThermProperty() [1/2]

virtual QVariant block::IZoneThing::getThermProperty ( const QString & propName) const
pure virtual

Returns value of zone thermal property corresponding to propName
Returns 0 if propName is not recognized

◆ getThermProperty() [2/2]

virtual QVariant block::IZoneThing::getThermProperty ( uint index) const
pure virtual

Returns value of zone thermal property corresponding to index
Returns 0 if index is not valid

◆ getThermPropertyIndex()

virtual uint32 block::IZoneThing::getThermPropertyIndex ( const QString & sc) const
pure virtual

Given a thermal property name, returns the index of the property assigned to this zone.

Note
Base 1, returns 0 if name is not found.

◆ getValue()

virtual QVariant block::IZoneThing::getValue ( int index) const
pure virtual

Retrieves the value stored in the utility array at index.

◆ getVertex()

virtual FInt block::IZoneThing::getVertex ( qint32 index) const
pure virtual

Returns the fortran offset of the vertex with index index.

Parameters
indexstarts at 0, and must be lower than the number of gridpoint used by the zone, see getNumVertices()

◆ getVertexThing()

virtual const IVertexThing * block::IZoneThing::getVertexThing ( qint32 index) const
pure virtual

Returns a const pointer to the vertex with index index.

Parameters
indexstarts at 0, and must be lower than the number of gridpoint used by the zone, see getNumVertices()

◆ getVertexThingID()

virtual uint64 block::IZoneThing::getVertexThingID ( qint32 index) const
pure virtual

Returns the ID of the vertex with index index.

Parameters
indexstarts at 0, and must be lower than the number of gridpoint used by the zone, see getNumVertices()

◆ isExcavated()

virtual bool block::IZoneThing::isExcavated ( ) const
pure virtual

Returns total volumetric strain.

Returns true if zone is in a block marked as excavated

◆ setBit()

virtual void block::IZoneThing::setBit ( int bit,
bool b ) const
pure virtual

Sets the boolean stored in utility bit bit in the zone. This function is const, to indicate that setting bit values does not impact the calculation logic in any way.

  • bit must be a bit index previouly returned from IZoneArray::claimBit(). Note - this is const through some hack so that we can use const ZoneThings when getting data

◆ setValue()

virtual void block::IZoneThing::setValue ( int index,
const QVariant & v ) const
pure virtual

Note - this is const through some hack so that we can use const ZoneThings when getting data.

Sets the value stored in the utility array at index. This is const to indicate that these bit values do not modify the model in any way.


The documentation for this class was generated from the following file: