igp.h

Go to the documentation of this file.

#pragma once
// igp.h

// Gp Masks 
//static const uint    N_XFIX       = 0x00000001;      /* X Fix Flag */
//static const uint    N_YFIX       = 0x00000002;      /* Y Fix Flag */
//static const uint    N_ZFIX       = 0x00000004;      /* Z Fix Flag */
static const quint32 GF_RELAX     = 0x00000008;   // Relaxation condition flag
//static const quint32 GF_NULL     = 0x00000010;   // Defined as PRIVATE
static const quint32 GF_AVAIL     = 0x00000020;   // Available to user  
static const quint32 GF_AVAIL2    = 0x00000040;   // Available to user
static const quint32 GF_GEN1      = 0x00000080;   // Gen Iterator Mask
static const quint32 GF_GEN2      = 0x00000100;   // Gen Iterator Mask
static const quint32 GF_XQUIET    = 0x00000200;   // Quiet bound. flag
static const quint32 GF_YQUIET    = 0x00000400;   // Quiet bound. flag
static const quint32 GF_ZQUIET    = 0x00000800;   // Quiet bound. flag
//static const quint32 GF_TFIX      = 0x00001000;   // Thermal FIX flag 
//static const quint32 GF_THNULL    = 0x00002000;   // Thermal NULL flag PRIVATE
//static const quint32 GF_FFIX      = 0x00004000;   // Fluid   FIX flag 
//static const quint32 GF_FLNULL    = 0x00008000;   // Fluid   NULL flag PRIVATE
static const quint32 GF_NOEOM     = 0x00010000;   // Indiciates equations-of-motion are to be skipped
static const quint32 GF_TEMP      = 0x00020000;   // TEMPORARY FLAG  - used internally
static const quint32 GF_FF1       = 0x00040000;   // Gp in corner FF
static const quint32 GF_FF2       = 0x00080000;   // Gp in side FF 
static const quint32 GF_INTER     = 0x00100000;   // Indicates GP is a coincidentGp on a host interface node
static const quint32 GF_FDSCRG    = 0x00200000;   // Fluid discharge flag
static const quint32 GF_FLKG      = 0x00400000;   // Fluid leakage flag
static const quint32 GF_FPWELL    = 0x00800000;   // Fluid pwell flag
static const quint32 GF_LOCSMALL  = 0x01000000;   // Local small-strain Motion update
//static const quint32 GF_GHOST     = 0x02000000;   // DEFINED AS PRIVATE Used with MPI to deisgnate a slave gridpoint if in force/velocity mode
//static const quint32 GF_MECHLIVE  = 0x04000000;   // set if gp is connected to a live mech zone
//static const quint32 GF_FLUIDLIVE = 0x10000000;   // set if gp is connected to a live fluid zone
//static const quint32 GF_THERMLIVE = 0x20000000;   // set if gp is connected to a live therm zone
static const quint32 GF_WG        = 0x40000000;   // Westergaard condition flag


#include "module/interface/dim.h"

namespace fish {
    class File;
}

namespace itasca {
    class IThing;
    class IFishParam;
    class IFish;
    class IGroup;
}

namespace zone {
    class INode;
    class IFluidGp;
    class IThermGp;
    class IZone;
    using itasca::IThing;

    class IGp {
    public:
        inline static const TType type_ = 0x4c815bed;
        enum class Change { MechNull, FlNull, ThNull, AddToList, RemoveFromList };
        virtual const IThing *      getIThing() const=0;
        virtual IThing *            getIThing()=0;
        virtual const INode *       getINode() const=0;
        virtual INode *             getINode()=0;
        virtual const IGp *         getNext() const=0;
        virtual bool                isMechanicalNull() const=0;
        virtual bool                isThermalNull() const=0;
        virtual bool                isFluidNull() const=0;
        virtual DVect               getVelocity(bool local=false) const=0;
        virtual void                setVelocity(const DVect &v,bool local=false)=0;
        virtual DVect               getDisplacement(bool local=false) const=0;
        virtual void                setDisplacement(DVect v,bool local=false) =0;
        virtual DVect               getSmallDisplacement(bool local=false) const=0;
        virtual void                setSmallDisplacement(DVect v,bool local=false) =0;
        virtual DVect               getFobLast(bool local=false) const=0;
        virtual DVect               getFap(bool local=false) const=0;
        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;
        virtual void                setPosition(const DVect &v) =0;
#ifdef THREED        
        virtual const IFluidGp *    getIFluidGp() const=0;
        virtual IFluidGp *          getIFluidGp() =0;
#endif
        virtual void                copyState(const IGp *gp)=0;
        virtual bool                getLocSmall() const =0;
        virtual void                setLocSmall(bool b) =0;
        virtual double              getInertialMass() const=0;
        virtual void                setInertialMass(const double &d) =0;
        virtual double              getGravitationalMass() const=0;
        virtual void                setGravitationalMass(const double &d)=0;
        virtual double              getPP() const =0;
        virtual void                setPP(double d) =0;
        virtual bool                getPPFix() const = 0;
        virtual void                setPPFix(bool b) = 0;
#ifdef THREED
        virtual double              getSat() const=0;
        virtual void                setSat(const double &d) =0;
        virtual const IThermGp  *   getIThermGp() const =0;
        virtual IThermGp  *         getIThermGp()  =0;
#endif
        virtual bool                getTFix() const =0;
        virtual void                setTFix(bool b) =0;
        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;    
        virtual void                setFApplyUser(const DVect &d,bool local=false) =0;
        virtual bool                getLocalSystem() const=0;
        virtual Axes                getSystem() const=0;
        virtual void                setSystem(const Axes &a) = 0;
        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 IZone *             getLinkZone()=0; 
        virtual const IZone *       getLinkZone() const=0;
        virtual quint32             getLinkIndex() const=0;
        virtual bool                fishIO(bool save,fish::File *f)=0;
        virtual double              getStiff() const=0;
        //virtual void                setStiff(const double &d) =0;
#ifdef THREED
        virtual double           getTempChange() const=0;
        virtual void             setTempChange(const double &d)=0;
#endif
        virtual double getConvergence() const=0;
        virtual double getRatioTarget() const=0;
        virtual void   setRatioTarget(const double &d)=0;
        virtual bool   getAttached() const=0;
    };
} // namespace zone
// EoF