modelHelper.h

Go to the documentation of this file.

 
// Copyright (c) 2013-2015 OpenM++
// This code is licensed under the MIT license (see LICENSE.txt for details)
 
#ifndef MODEL_HELPER_H
#define MODEL_HELPER_H
 
using namespace std;
 
namespace openm
{
    // atomic bool vector to store sub-value done status
    class DoneVector
    {
    public:
        DoneVector(size_t i_size) { init(i_size); };
 
        // create new vector of bool values
        void init(size_t i_size);
 
        // clear all values: set it to false
        void reset(void);
 
        // return true if all values are set to true
        bool isAll(void);
 
        // set to true value at specified position
        void setAt(size_t i_pos);
 
        // return count of contiguous true values staring from zero position
        int countFirst(void);
 
    private:
        recursive_mutex theMutex;   // mutex to lock access operations
        vector<bool> isDoneVec;     // if true then all sub-value accumulators saved in database
 
    private:
        DoneVector(const DoneVector & i_doneVec) = delete;
        DoneVector & operator=(const DoneVector & i_doneVec) = delete;
    };
 
    // helper struct to define modeling groups size and count: groups of processes for parallel run of modeling task
    struct ProcessGroupDef
    {
        int groupSize;          // size of modeling group
        int groupCount;         // number of modeling groups
        int activeRank;         // active rank in group: process index among other modeling processes in the group
        int groupOne;           // current process modeling group number, one based, not a zero based
        bool isRootActive;      // if true then root process used for modeling else dedicated for data exchange
        int subPerProcess;      // number of sub-values per modeling process, except of root process and last process
        int selfSubCount;       // number of sub-values for current process
        int rootSubCount;       // number of sub-values for root process
        int firstSubId;         // sub-value staring index for current modeling process
 
        static const int all = 0;   // worldwide group, all processes
 
        ProcessGroupDef(void) :
            groupSize(1), groupCount(0), activeRank(0), groupOne(0), isRootActive(true), subPerProcess(1), selfSubCount(1), rootSubCount(0), firstSubId(0)
        { }
 
        ProcessGroupDef(int i_subValueCount, int i_threadCount, bool i_isRootIdle, int i_worldSize, int i_worldRank);
    };
 
    // helper struct to hold modeling group run id and run state
    struct RunGroup
    {
        int groupOne;           // modeling group number, one based, not a zero based
        int runId;              // if > 0 then model run id
        int setId;              // if > 0 then set id of source input parametes
        int firstChildRank;     // world rank of first child process
        int childCount;         // number of child processes in group
        bool isUseRoot;         // if true then root process used for modeling else dedicated for data exchange
        int groupSize;          // size of modeling group
        int subPerProcess;      // number of sub-values per modeling process, except of root process and last process
        int rootSubCount;       // number of sub-values for root process
        ModelRunState state;                // group status and modeling progress
        DoneVector isSubDone;               // size of [subValue count], if true then all sub-value accumulators saved in database
        vector<ModelRunState> childState;   // size of [childCount] run state for all group child processes
 
        // set initial run group size, assign process ranks and initial state state
        RunGroup(int i_groupOne, int i_subValueCount, const ProcessGroupDef & i_rootGroupDef);
 
        // set group state for next run
        void nextRun(int i_runId, int i_setId, ModelStatus i_status);
 
        // clear group state after run
        void reset(void) { nextRun(0, 0, ModelStatus::init); }
 
        // return child world rank where sub-value is calculated
        int rankBySubValueId(int i_subId) const;
 
    private:
        RunGroup(const RunGroup & i_runGroup) = delete;
        RunGroup & operator=(const RunGroup & i_runGroup) = delete;
    };
 
    // helper struct to receive output table values for each accumulator
    struct AccReceive
    {
        int runId;              // run id to receive
        int subValueId;         // sub-value index to receive
        int tableId;            // output table id
        int accId;              // accumulator id
        size_t valueSize;       // size of accumulator data
        bool isReceived;        // if true then data received
        int senderRank;         // sender rank: process where accumulator calculated
        int msgTag;             // accumulator message tag
 
        AccReceive(
            int i_runId,
            int i_subId,
            int i_subValueCount,
            int i_senderRank,
            int i_tableId,
            int i_accId,
            int i_accIndex,
            size_t i_valueSize
        ) :
            runId(i_runId),
            subValueId(i_subId),
            tableId(i_tableId),
            accId(i_accId),
            valueSize(i_valueSize),
            isReceived(false),
            senderRank(i_senderRank),
            msgTag(accMsgTag(i_subId, i_subValueCount, i_accIndex))
        { }
 
        static int accMsgTag(int i_subId, int i_subValueCount, int i_accIndex)
        {
            return ((int)MsgTag::outSubValueBase + i_accIndex) * i_subValueCount + i_subId;
        }
    };
}
 
#endif  // MODEL_HELPER_H