loadbalancer.h

Go to the documentation of this file.

/*
 *
 *                 #####    #####   ######  ######  ###   ###
 *               ##   ##  ##   ##  ##      ##      ## ### ##
 *              ##   ##  ##   ##  ####    ####    ##  #  ##
 *             ##   ##  ##   ##  ##      ##      ##     ##
 *            ##   ##  ##   ##  ##      ##      ##     ##
 *            #####    #####   ##      ######  ##     ##
 *
 *
 *             OOFEM : Object Oriented Finite Element Code
 *
 *               Copyright (C) 1993 - 2013   Borek Patzak
 *
 *
 *
 *       Czech Technical University, Faculty of Civil Engineering,
 *   Department of Structural Mechanics, 166 29 Prague, Czech Republic
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef loadbalancer_h
#define loadbalancer_h

#include "oofemcfg.h"
#include "inputrecord.h"
#include "floatarray.h"

#include <vector>
#include <memory>


#define _IFT_LoadBalancer_wtp "wtp"
#define _IFT_LoadBalancerMonitor_nodeWeightMode "nodeweightmode"
#define _IFT_LoadBalancerMonitor_initialnodeweights "nw"


namespace oofem {
class Domain;
class EngngModel;
class ProcessCommunicator;
class TimeStep;
class IntArray;

 #define MIGRATE_LOAD_TAG       9998

class OOFEM_EXPORT LoadBalancerMonitor
{
protected:
    EngngModel *emodel;
    FloatArray nodeWeights;
    bool staticNodeWeightFlag;
public:
    enum LoadBalancerDecisionType { LBD_CONTINUE, LBD_RECOVER };

    LoadBalancerMonitor(EngngModel * em): emodel(em) { }
    virtual ~LoadBalancerMonitor() { }

    virtual IRResultType initializeFrom(InputRecord *ir);

    virtual LoadBalancerDecisionType decide(TimeStep *) = 0;
    const FloatArray & giveProcessorWeights() { return nodeWeights; }

    virtual const char *giveClassName() const = 0;
};


class OOFEM_EXPORT LoadBalancer
{
public:
    enum DofManMode {
        DM_NULL,   
        DM_Local,  
        DM_Shared, 
        DM_Remote, 
    };
protected:
    Domain *domain;

public:

    LoadBalancer(Domain * d);
    virtual ~LoadBalancer() { }



    virtual void calculateLoadTransfer() = 0;

    void migrateLoad(Domain *d);

    virtual void  printStatistics() const;

    virtual DofManMode giveDofManState(int idofman) = 0;

    virtual IntArray *giveDofManPartitions(int idofman) = 0;

    virtual int giveElementPartition(int ielem) = 0;

    virtual IRResultType initializeFrom(InputRecord *ir);

    Domain *giveDomain() { return domain; }
    virtual void setDomain(Domain *d) { this->domain = d; }
    virtual const char *giveClassName() const = 0;

protected:

    int packMigratingData(Domain *, ProcessCommunicator &pc);
    int unpackMigratingData(Domain *, ProcessCommunicator &pc);
    void deleteRemoteDofManagers(Domain *);
    void deleteRemoteElements(Domain *);
    void initializeWtp(IntArray &wtp);

public:

    class WorkTransferPlugin
    {
protected:
        LoadBalancer *lb;
public:
        WorkTransferPlugin(LoadBalancer * _lb);
        virtual ~WorkTransferPlugin();

        virtual void init(Domain *d) = 0;
        virtual void migrate() = 0;
        virtual void update() = 0;
    };

protected:
    std :: vector< std :: unique_ptr< WorkTransferPlugin > >wtpList;
};

/*
class OOFEM_EXPORT LoadBalancerElementInterface : public Interface
{
public:
    LoadBalancerElementInterface() { }

    virtual double predictRelativeComputationalCost();
};
*/
} // end namespace oofem

#endif // loadbalancer_h