izonelist.h

Go to the documentation of this file.

//izonelist.h
#pragma once
 
#include "base/src/farray.h"
#include "base/src/callback.h"
 
#include "module/interface/igenericmodellist.h"
#include "utility/interface/igroup.h"
 
#include <set>
 
namespace itasca {
    class IContainer;
    class IThing;
}
namespace itascaxd {
    class IFetchProperty;
}
 
namespace zone {
    using namespace itasca;
 
    class IFace;
    class IFetchFluidProperty;
    class IFetchThermalProperty;
    class IZone;
    class IZoneData;
 
    class IZoneList {
    public:
        using ModelQueryInfo = module::IGenericModelList::ModelQueryInfo;
        virtual const IThing *     getIThing() const=0;
        virtual IThing *           getIThing()=0;
        virtual const IContainer * getIContainer() const=0;
        virtual IContainer *       getIContainer() =0;
 
        virtual const IZone *      getFirstZone() const=0;
 
        virtual IZone *            getFirstZone()=0;
        virtual uint32             getZoneType() const=0;
        virtual uint32             getFaceType() const=0;
        virtual const IZone *      findZoneWithID(uint64 id) const=0;
        virtual IZone *            findZoneWithID(uint64 id)=0;
        virtual const IZone *      findZoneNearest(const DVect &vec,const double &radius=limits<double>::max()) const=0;
        virtual IZone *            findZoneNearest(const DVect &vec,const double &radius=limits<double>::max()) =0;
        virtual uint64           getNZone() const=0;
        virtual IZone *            findZoneContainingNull(const DVect &v,bool hideNull) const =0;
 
        virtual IZone *            findZoneNearestLive(const DVect &dv3) =0;
        virtual uint32             getZoneExtraNotice() const=0;
        virtual uint32             getModelNotice() const=0;
        virtual uint32             getPropertyNotice() const=0;
        virtual uint32             getStateNotice() const=0;
        virtual uint32             getDensityNotice() const=0;
        virtual uint32             getGroupNotice() const=0;
        virtual uint32             getStressNotice() const=0;
        virtual uint32             getThermalFluxNotice() const =0;
        virtual uint32             getFaceGroupNotice() const=0;
        virtual uint32             getFaceExtraNotice() const=0;
        virtual uint32             getHideNotice() const=0;
        virtual uint32             getSelectNotice() const=0;
        virtual uint32             getFaceHideNotice() const=0;
        virtual uint32             getFaceSelectNotice() const=0;
        virtual uint32             getMultiplierNotice() const=0;
        virtual uint32             getFluidPropNotice() const=0;
        virtual uint32             getThermPropNotice() const=0;
        virtual uint64             getNumberFacesHidden() const=0;
        virtual uint64             getNumberFacesSelected() 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 IZoneData *        createIZoneData() const=0;
        virtual StringList         getAllMechanicalModels() const=0;
        virtual StringList         getAllMechanicalProperties() const=0;
 
        // Returns a ModelQueryInfo filled with information based on currently selected zones.  Multithreaded!
        virtual ModelQueryInfo     getModelQueryOnSelected() const=0;
 
        virtual const IFace *      makeFace(const IZone *z,uint32 side) const=0;
        virtual IFace *            makeFace(IZone *z,uint32 side)=0;
        virtual itascaxd::IFetchProperty *makeFetchProperty(const string &prop) const=0;
        virtual IFetchThermalProperty *makeFetchThermalProperty(const string &prop) const=0;
        virtual string getZoneGroupsOnSides(std::set<IGroupID> *zf1GroupList,
                                            std::set<IGroupID> *zf2GroupList) const=0;
 
        virtual std::vector<base::PropDesc> getMechanicalPropertiesAvailable() const=0;
        virtual std::vector<base::PropDesc> getFluidPropertiesAvailable() const = 0;
        virtual std::vector<base::PropDesc> getThermalPropertiesAvailable() const = 0;
 
        virtual void threadedCallbackObject(Callback4<void,const IZone *,uint32,uint32,void *> &callback,void *v=nullptr,bool useThreads=true) const=0;
        virtual void threadedCallbackFunction(void (*function)(const IZone *,uint32,uint32,void *),void *v=nullptr,bool useThreads=true) const=0;
        template <class S,void (S::*MFP)(const IZone *,uint32,uint32,void *)>
            void threadedCallbackMethod(S *s,void *v=nullptr,bool useThreads=true) const;
 
        struct FaceGroupCallbackData {
            const IZone * zone_;
            uint32       side_;
            const IThing *entry_;
        };
        virtual void threadedCallbackObjectFaceGroups(Callback3<void,const FaceGroupCallbackData *,uint32,uint32> &callback,bool useThreads=true) const=0;
        template <class S,void (S::*MFP)(const FaceGroupCallbackData *,uint32,uint32)>
            void threadedCallbackMethodFaceGroups(S *s,bool useThreads=true) const;
 
        struct FaceSelectCallbackData {
            const IZone * zone_;
            uint32       side_;
        };
        virtual void threadedCallbackObjectFaceSelect(Callback3<void,const FaceSelectCallbackData *,uint32,uint32> &callback,bool useThreads=true) const=0;
        template <class S,void (S::*MFP)(const FaceSelectCallbackData *,uint32,uint32)>
            void threadedCallbackMethodFaceSelect(S *s,bool useThreads=true) const;
    };
 
    template <class S,void (S::*MFP)(const IZone *,uint32,uint32,void *)>
    void IZoneList::threadedCallbackMethod(S *s,void *v,bool useThreads) const {
        Callback4Method<void,const IZone *,uint32,uint32,void *,S,MFP> callback(s);
        threadedCallbackObject(callback,v,useThreads);
    }
 
    template <class S,void (S::*MFP)(const IZoneList::FaceGroupCallbackData *,uint32,uint32)>
    void IZoneList::threadedCallbackMethodFaceGroups(S *s,bool useThreads) const {
        Callback3Method<void,const IZoneList::FaceGroupCallbackData *,uint32,uint32,S,MFP> callback(s);
        threadedCallbackObjectFaceGroups(callback,useThreads);
    }
 
    template <class S,void (S::*MFP)(const IZoneList::FaceSelectCallbackData *,uint32,uint32)>
    void IZoneList::threadedCallbackMethodFaceSelect(S *s,bool useThreads) const {
        Callback3Method<void,const IZoneList::FaceSelectCallbackData *,uint32,uint32,S,MFP> callback(s);
        threadedCallbackObjectFaceSelect(callback,useThreads);
    }
} // namespace zone
// EoF