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

Interface to provide access to a gridpoint. More...

#include <igp.h>

Public Types

enum class  Change { Null , AddToList , RemoveFromList , Active }
 

Public Member Functions

virtual const IThinggetIThing () const =0
 Returns a const IThing pointer.
 
virtual IThinggetIThing ()=0
 Returns a IThing pointer.
 
virtual const INodegetINode () const =0
 Returns a pointer to itself.
 
virtual INodegetINode ()=0
 
virtual const IGpgetNext () const =0
 
virtual bool isNull () const =0
 Returns true to indicate that gridpoint is "nulled".
 
virtual DVect getVelocity (bool local=false) const =0
 Returns the gridpoint velocity, see setVelocity();.
 
virtual void setVelocity (const DVect &v, bool local=false)=0
 Sets the gridpoint velocity, see getVelocity();.
 
virtual DVect getDisplacement (bool local=false) const =0
 Returns the gridpoint displacement, seet setDisplacement();.
 
virtual void setDisplacement (DVect v, bool local=false)=0
 Sets the gridpoint displacement, seet getDisplacement();.
 
virtual DVect getSmallDisplacement (bool local=false) const =0
 Returns the gridpoint displacement accumulated for small strain, see setSmallDisplacement()
 
virtual void setSmallDisplacement (DVect v, bool local=false)=0
 Sets the gridpoint displacement for small strain, see getSmallDisplacement()
 
virtual DVect getFobLast (bool local=false) const =0
 Returns the gridpoint out of balance force.
 
virtual DVect getFap (bool local=false) const =0
 Returns the sum of the gridpoint static applied force and the dynamic applied force.
 
virtual DVect getTotalForceLast (bool reaction=false, bool local=false) const =0
 
virtual DVect getTotalForceCurrent (const DVect &gravity, bool reaction=false, bool local=false) const =0
 
virtual DVect getPosition () const =0
 Returns the gridpoint position, see setPosition()
 
virtual void setPosition (const DVect &v)=0
 Sets the gridpoint position, see getPosition()
 
virtual const IFluidGpgetIFluidGp () const =0
 Returns a const pointer to the gridpoint fluid-flow data.
 
virtual IFluidGpgetIFluidGp ()=0
 Returns a pointer to the gridpoint fluid-flow data.
 
virtual void copyState (const IGp *gp)=0
 Copies the state of this gridpoint to gp.
 
virtual bool getLocSmall () const =0
 Returns 1 if gridpoint behaves as in small-strain mode. See setLocSmall();.
 
virtual void setLocSmall (bool b)=0
 If parameter b is true, the gridpoint will behave as in small-strain mode. See getLocSmall();.
 
virtual double getInertialMass () const =0
 Returns the gridpoint inertial mass, see setInertialMass()
 
virtual double getGravitationalMass () const =0
 Returns the gridpoint gravitational mass, see setGravitationalMass()
 
virtual void setGravitationalMass (const double &d)=0
 Sets the gridpoint gravitational mass, see getGravitationalMass()
 
virtual double getPP () const =0
 Returns the gridpoint pore-pressure, see setPP()
 
virtual void setPP (double d)=0
 Sets the gridpoint pore-pressure, see getPP()
 
virtual double getHead (const DVect &datum) const =0
 
virtual bool getPPFix () const =0
 Returns 1 if the gridpoint has fixed pore-pressure, otherwise value 0 indicates non-fixed pore-pressure.
 
virtual void setPPFix (bool b)=0
 If parameter b is treu, sets the gridpoint pore-pressure to be kept fixed during calculation, see getPPFix().
 
virtual double getSaturation () const =0
 Returns the gridpoint fluid saturation, see setSat()
 
virtual void setSaturation (double d)=0
 Sets the gridpoint fluid saturation, see getSat()
 
virtual const IThermGpgetIThermGp () const =0
 Returns a const pointer to IThermGp.
 
virtual IThermGpgetIThermGp ()=0
 Returns a pointer to IThermGp.
 
virtual bool getTFix () const =0
 Returns 1 if the gridpoint thermal FIX flag is set, otherwise value 0 indicates that the thermal fix flag is not set.
 
virtual void setTFix (bool b)=0
 If parameter is true, sets the thermal FIX flag on.
 
virtual IVect getFix () const =0
 
virtual void setFix (IVect v)=0
 
virtual DVect getFApplyUser (bool local=false) const =0
 
virtual DVect getMassAdd (bool local=false) const =0
 
virtual void setMassAdd (const DVect &v, bool local=false)=0
 Sets the additional applied mass at a gridpoint.
 
virtual void setFApplyUser (const DVect &d, bool local=false)=0
 using the APPLY command. See getFApplyUser()
 
virtual bool getLocalSystem () const =0
 
virtual Axes getSystem () const =0
 Returns the user-defined local axes.
 
virtual void setSystem (const Axes &a)=0
 Sets the user-defined local axes.
 
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
 
virtual IZonegetLinkZone ()=0
 
virtual const IZonegetLinkZone () const =0
 
virtual uint32 getLinkIndex () const =0
 
virtual bool fishIO (bool save, fish::File *f)=0
 
virtual double getStiff () const =0
 Returns the gridpoint stiffness.
 
virtual double getTempChange () const =0
 Sets the gridpoint stiffness.
 
virtual void setTempChange (const double &d)=0
 Sets dDTemp.
 
virtual double getConvergence () const =0
 
virtual double getRatioTarget () const =0
 
virtual void setRatioTarget (const double &d)=0
 
virtual bool getAttached () const =0
 

Static Public Attributes

static const TType type_ = 0x4c815bed
 The type identification number for this class, for use in convert_cast() and convert_getcast().
 

Detailed Description

Interface to provide access to a gridpoint.

Member Function Documentation

◆ fishIO()

virtual bool zone::IGp::fishIO ( bool save,
fish::File * f )
pure virtual

If save is true, save the grip point state information to IFish.
If save is false, restore the grip point state information to IFish.
Returns 0 if function is successful, otherwise an error code correspondig to a IFishIO error.
See 'Saving State Information' in FISH in FLAC manual.

◆ getBit()

virtual bool zone::IGp::getBit ( int bit) const
pure virtual

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

◆ getFApplyUser()

virtual DVect zone::IGp::getFApplyUser ( bool local = false) const
pure virtual

Returns the static applied force. This load is in addition to forces applyed to the gridpoint using the APPLY command. See setFApplyUser()

◆ getFix()

virtual IVect zone::IGp::getFix ( ) const
pure virtual

Returns a vector indicating the fix condition for the gridpoint. The component x, y or z of the vector are set to 1 (fixed) or 0(not fixed). See setFix()

◆ getLinkIndex()

virtual uint32 zone::IGp::getLinkIndex ( ) const
pure virtual

Returns the index in the zone getLinkZone() that should be used to follow the list of all zones connected to this gp.

◆ getLinkZone() [1/2]

virtual const IZone * zone::IGp::getLinkZone ( ) const
pure virtual

Returns a pointer to a zone that is connected to this Gp. getLinkZone() and getLinkIndex() can be used to iterator though all zones connected to a Gp. See IZone::getLinkZone() and IZone::getLinkIndex().

uint32 index = gp->getLinkIndex();
const IZone *z = gp->getLinkZone();
while (z) {
/* Do something with the zone */
uint32 next = z->getLinkIndex(index);
z = z->getLinkZone(index);
index = next;
}
Interface to provide access to a zone.
Definition izone.h:80
virtual IZone * getLinkZone(uint32 index)=0
virtual uint32 getLinkIndex(uint32 index) const =0

◆ getLinkZone() [2/2]

virtual IZone * zone::IGp::getLinkZone ( )
pure virtual

Returns a pointer to a zone that is connected to this Gp. getLinkZone() and getLinkIndex() can be used to iterator though all zones connected to a Gp. See IZone::getLinkZone() and IZone::getLinkIndex().

uint32 index = gp->getLinkIndex();
const IZone *z = gp->getLinkZone();
while (z) {
/* Do something with the zone */
uint32 next = z->getLinkIndex(index);
z = z->getLinkZone(index);
index = next;
}

◆ getMassAdd()

virtual DVect zone::IGp::getMassAdd ( bool local = false) const
pure virtual

Returns the additional applied mass set through FISH function gp_massadd. This mass is added to the gridpoint inertial mass used in the EOMs in static or dynamic mode.

◆ getNext()

virtual const IGp * zone::IGp::getNext ( ) const
pure virtual

Returns a const pointer to the next gridpoint object, IGp, in the global gridpoint list, or 0 to indicate the end of the list. See IGpList::getFirst().

◆ getTempChange()

virtual double zone::IGp::getTempChange ( ) const
pure virtual

Sets the gridpoint stiffness.

Gets dDTemp

◆ getTotalForceLast()

virtual DVect zone::IGp::getTotalForceLast ( bool reaction = false,
bool local = false ) const
pure virtual

Returns gridpoint out of balance force (FOB) with static and dynamic applied force vectors included and also take into consideration the gravitational acceleration gravity. If gridpoint is attached, returns values interpolated (if necessary) from master. If gridpoint is FIXED, removes force associated with that DOF (Possibly in a local system).

◆ getValue()

virtual QVariant zone::IGp::getValue ( int index) const
pure virtual

Retrieves the value stored in the utility array at index.

◆ setBit()

virtual void zone::IGp::setBit ( int bit,
bool b ) const
pure virtual

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

◆ setFApplyUser()

virtual void zone::IGp::setFApplyUser ( const DVect & d,
bool local = false )
pure virtual

using the APPLY command. See getFApplyUser()

Sets the static applied force. This load is in addition to forces applyed to the gridpoint

◆ setFix()

virtual void zone::IGp::setFix ( IVect v)
pure virtual

Sets the fix condition for the gridpoint. The component x, y or z of the vector are set to 1 (fixed) or 0(not fixed). See getFix()

◆ setValue()

virtual void zone::IGp::setValue ( int index,
const QVariant & v ) const
pure virtual

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


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