doxygen/html/igplist_8h_source.html

//igplist.h

#pragma once


#include "utility/interface/igroup.h"


namespace itasca {

    class IContainer;

    class IThing;

}


namespace zone {

    using namespace itasca;


    class IGp;

    class IGpData;


    class IGpList {

    public:

        virtual const IThing *     getIThing() const=0;

        virtual IThing *           getIThing()=0;

        virtual const IContainer * getIContainer() const=0;

        virtual IContainer *       getIContainer() =0;

        virtual const IGp *        getFirstGp() const=0;

        virtual IGp *              getFirstGp()=0;

        virtual uint32            getGridPointType() const=0;

        virtual const IGp *        findGridPointWithID(uint64 id) const=0;

        virtual const IGp *        findGridPoint(const DVect &vec,uint32 excludeMask=0) const=0;

        virtual IGp *              findGridPoint(const DVect &vec,uint32 excludeMask=0) =0;

        virtual IGp *              findGridPoint(const DVect &vec,const IGroupID &group) =0;

        virtual uint64           getNGp() const=0;

        virtual IGp *              findGpLive(const DVect &dv3)=0;

        virtual uint32               getFapNotice() const=0;

        virtual uint32               getFobNotice() const=0;

        virtual uint32               getGpExtraNotice() const=0;

        virtual uint32               getPorePressureNotice() const=0;

        virtual uint32               getTemperatureNotice() const=0;

        virtual uint32               getGeometryNotice() const=0;

        virtual uint32               getFixityNotice() const =0;

        virtual uint32               getVelocityNotice() const=0;

        virtual uint32               getDisplacementNotice() const=0;

        virtual uint32               getSaturationNotice() const=0;

        virtual uint32               getNullChangeNotice() const=0;

        virtual uint32               getMultiplierNotice() const=0;

        virtual int                claimBit() const=0;

        virtual void               releaseBit(int bit) const=0;

        virtual int                claimValue() const=0;

        virtual void               releaseValue(int bit) const=0;

        virtual IGpData *          createIGpData() const=0;

    };


} // namespace zone

// EoF

itasca::IContainer
Interface for containers of IThings.
Definition icontainer.h:21

itasca::IGroupID
Definition igroup.h:82

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

zone::IGpData
Interface that allows access to gridpoint scalar data in a generic way.
Definition igpdata.h:27

zone::IGp
Interface to provide access to a gridpoint.
Definition igp.h:56

zone::IGpList
Interface to the global list of all grid points.
Definition igplist.h:24

zone::IGpList::getGpExtraNotice
virtual uint32 getGpExtraNotice() const =0
Returns the tag for the gridpoint extra variable change notice.

zone::IGpList::findGridPoint
virtual const IGp * findGridPoint(const DVect &vec, uint32 excludeMask=0) const =0

zone::IGpList::getIContainer
virtual IContainer * getIContainer()=0
Returns a pointer to the IContainer interface representing the global list of grid points.

zone::IGpList::getFapNotice
virtual uint32 getFapNotice() const =0
Returns the tag for the gridpoint applied force change notice.

zone::IGpList::getIContainer
virtual const IContainer * getIContainer() const =0
Returns a const pointer to the IContainer interface representing the global list of grid points.

zone::IGpList::getFobNotice
virtual uint32 getFobNotice() const =0
Returns the tag for the gridpoint out of balance change force notice.

zone::IGpList::findGridPointWithID
virtual const IGp * findGridPointWithID(uint64 id) const =0
Given a gridpoint id, returns a const pointer to the gridpoint.

zone::IGpList::claimBit
virtual int claimBit() const =0
Claims a bit from the gridpoints utility bit field.

zone::IGpList::getDisplacementNotice
virtual uint32 getDisplacementNotice() const =0
Returns the tag for the gridpoint displacement change notice.

zone::IGpList::findGridPoint
virtual IGp * findGridPoint(const DVect &vec, uint32 excludeMask=0)=0

zone::IGpList::getFirstGp
virtual IGp * getFirstGp()=0

zone::IGpList::findGridPoint
virtual IGp * findGridPoint(const DVect &vec, const IGroupID &group)=0

zone::IGpList::createIGpData
virtual IGpData * createIGpData() const =0
Returns a pointer to a new IGpData object. This pointer must be destroyed by the caller.

zone::IGpList::getFixityNotice
virtual uint32 getFixityNotice() const =0
Returns the tag for the gridpoint fix condition change notice.

zone::IGpList::getGridPointType
virtual uint32 getGridPointType() const =0
Returns the gridpoint general type.

zone::IGpList::releaseValue
virtual void releaseValue(int bit) const =0
Releases a value index back to the gridpoints utility value array. Thread-safe.

zone::IGpList::claimValue
virtual int claimValue() const =0
Claims a value index from the gridpoints utility value array.

zone::IGpList::getNGp
virtual uint64 getNGp() const =0
Returns the number of grid points in the list.

zone::IGpList::getIThing
virtual const IThing * getIThing() const =0
Returns a const pointer to an IThing interface representing the IGpList.

zone::IGpList::getSaturationNotice
virtual uint32 getSaturationNotice() const =0
Returns the tag for the gridpoint saturation change notice.

zone::IGpList::getIThing
virtual IThing * getIThing()=0
Returns a pointer to an IThing interface representing the IGpList.

zone::IGpList::getTemperatureNotice
virtual uint32 getTemperatureNotice() const =0
Returns the tag for the gridpoint temperature change notice.

zone::IGpList::getFirstGp
virtual const IGp * getFirstGp() const =0

zone::IGpList::getGeometryNotice
virtual uint32 getGeometryNotice() const =0
Returns the tag for the gridpoint geometry change notice.

zone::IGpList::getVelocityNotice
virtual uint32 getVelocityNotice() const =0
Returns the tag for the gridpoint velocity change notice.

zone::IGpList::findGpLive
virtual IGp * findGpLive(const DVect &dv3)=0

zone::IGpList::getPorePressureNotice
virtual uint32 getPorePressureNotice() const =0
Returns the tag for the gridpoint pore-pressure change notice.

zone::IGpList::getNullChangeNotice
virtual uint32 getNullChangeNotice() const =0
Returns the tag for the zone null change notice.

zone::IGpList::releaseBit
virtual void releaseBit(int bit) const =0
Releases a bit index previously obtained with claimBit(). Thread-safe.

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

itasca
namespace Itasca
Definition basememory.cpp:14