blockStatistics.h

Go to the documentation of this file.

/* This file is part of the Palabos library.
 *
 * Copyright (C) 2011 FlowKit Sarl
 * Avenue de Chailly 23
 * 1012 Lausanne, Switzerland
 * E-mail contact: contact@flowkit.com
 *
 * The most recent release of Palabos can be downloaded at 
 * <http://www.palabos.org/>
 *
 * The library Palabos is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * The library 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef BLOCK_STATISTICS_H
#define BLOCK_STATISTICS_H

#include "core/globalDefs.h"
#include <vector>
#include <algorithm>

namespace plb {

// Forward declaration

class BlockStatistics;

class TimeCounter {
public:
    TimeCounter() : latticeTime(0) { }
    TimeCounter(plint iniTime) : latticeTime(iniTime) { }
    void incrementTime() { ++latticeTime; };
    void resetTime(pluint value=0) { latticeTime=value; } ;
    pluint getTime() const { return latticeTime; };
private:
    plint latticeTime;
};

class StatSubscriber {
public:
    virtual ~StatSubscriber() { }
    virtual plint subscribeAverage() =0;
    virtual plint subscribeSum() =0;
    virtual plint subscribeMax() =0;
    virtual plint subscribeIntSum() =0;
};


class BlockStatistics {
public:
    BlockStatistics();
    BlockStatistics(BlockStatistics const& rhs);
    
    void swap(BlockStatistics& rhs);
    void evaluate();
    void evaluate(std::vector<double> const& average, std::vector<double> const& sum,
                  std::vector<double> const& max, std::vector<plint> const& intSum, pluint numCells_);
    void gatherAverage(plint whichAverage, double value);
    void gatherSum(plint whichSum, double value);
    void gatherMax(plint whichMax, double value);
    void gatherIntSum(plint whichSum, plint value);
    void incrementStats();
    pluint const& getNumCells() const { return numCells; }

    double getAverage(plint whichAverage) const;
    double getSum(plint whichSum) const;
    double getMax(plint whichMax) const;
    plint getIntSum(plint whichSum) const;

    std::vector<double>& getAverageVect() { return averageVect; }
    std::vector<double>& getSumVect() { return sumVect; }
    std::vector<double>& getMaxVect() { return maxVect; }
    std::vector<plint>& getIntSumVect() { return intSumVect; }
    std::vector<double> getDoubleVect() const;

    plint subscribeAverage();
    plint subscribeSum();
    plint subscribeMax();
    plint subscribeIntSum();
    void rescale(std::vector<double> const& scales);
private:
    enum DoubleReductions {averageRed, sumRed, maxRed};
    std::vector<double> tmpAv, tmpSum, tmpMax;
    std::vector<plint> tmpIntSum;
    pluint tmpNumCells;
    std::vector<DoubleReductions> doubleReductions;
    std::vector<double> averageVect, sumVect, maxVect;
    std::vector<plint> intSumVect;
    pluint numCells;
};

void combine(std::vector<BlockStatistics*>& components, BlockStatistics& result);

}  // namespace plb

#endif