communicator3d.h

open lattice boltzmann project www.openlb.org

/*  This file is part of the OpenLB library
 *
 *  Copyright (C) 2007 Mathias J. Krause
 *  Address: Wilhelm-Maybach-Str. 24, 68766 Hockenheim, Germany 
 *  E-mail: [e-mail]
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License
 *  as published by the Free Software Foundation; either version 2
 *  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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public 
 *  License along with this program; if not, write to the Free 
 *  Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 *  Boston, MA  02110-1301, USA.
*/

/** \file
 * A communincator provides a cuboids with cells of other 
 * cuboids -- header file.
 */


#ifndef COMMUNICATOR_3D_H
#define COMMUNICATOR_3D_H

#include <vector>
#include "cuboidNeighbourhood3D.h"
#include "superLattice3D.h"


/// All OpenLB code is contained in this namespace.
namespace olb {

/// A communincator provides a cuboids with data of other 
/// cuboids.
/** For each cuboid is a cuboid neighbourhood devined. A communicator
 * coordinates the communication of the single cuboids there the data
 * is stored locally.
 *
 * There are methods to add needed cells, send, receive and write
 * data of the cell.
 *
 * This class is not intended to be derived from.
 */


template<typename T, template<typename U> class Lattice> class SuperLattice3D;

template<typename T, template<typename U> class Lattice> class CuboidNeighbourhood3D;

template<typename T, template<typename U> class Lattice>
class Communicator3D {

    private:
        /// Stores the single cuboid neighbourhoods information
        std::vector<CuboidNeighbourhood3D<T,Lattice> > _nh;
        /// Reference to the super strucrture
        SuperLattice3D<T,Lattice>& _sLattice;
        /// Number of coboids in the structure
        int _nC;
        /// Indecates if there was an initialization done
        bool _initDone;
    public:
        /// Constructor
        Communicator3D(SuperLattice3D<T,Lattice>& sLattice);
        /// Initializes the cuboid neighbourhoods
        void init_nh();

        /// Adds a cell (globX/globY/globZ) to the cuboid neigbourhood iC 
        /// that is then able to get data of the cell
        void add_cell(int iC, T globX, T globY, T globZ);
        /// Adds all cells of the overlaps to its accociated cuboid
        /// neigbourhood 
        void add_cells(int overlap);
        /// Initializes the communicator
        void init();
        /// Resets all cuboids neighbourhoods
        void reset();

        /// Sends the needed data
        void send();
        /// Receives the needed data
        void receive();
        /// Writes all data to the block lattices of the super structure
        void write();
};

}  // namespace olb

#endif