diff options
Diffstat (limited to 'src/communication/communicator2D.h')
-rw-r--r-- | src/communication/communicator2D.h | 99 |
1 files changed, 99 insertions, 0 deletions
diff --git a/src/communication/communicator2D.h b/src/communication/communicator2D.h new file mode 100644 index 0000000..8be8c2a --- /dev/null +++ b/src/communication/communicator2D.h @@ -0,0 +1,99 @@ +/* This file is part of the OpenLB library + * + * Copyright (C) 2007, 2014 Mathias J. Krause + * E-mail contact: info@openlb.net + * The most recent release of OpenLB can be downloaded at + * <http://www.openlb.net/> + * + * 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_2D_H +#define COMMUNICATOR_2D_H + +#include <vector> +#include "communication/cuboidNeighbourhood2D.h" +#include "communication/superStructure2D.h" + + +/// All OpenLB code is contained in this namespace. +namespace olb { + +/// A communicator provides a cuboid with data of other +/// cuboids. +/** For each cuboid a cuboid neighbourhood is defined. A communicator + * coordinates the communication of the single cuboids, in which 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> class CuboidNeighbourhood2D; +template<typename T> class SuperStructure2D; + +template<typename T> +class Communicator2D { + +private: + /// Stores neighbourhoods information for a single cuboid + std::vector<CuboidNeighbourhood2D<T> > _nh; + /// Reference to the super structure + SuperStructure2D<T>& _superStructure; + /// Number of cuboids in the structure + int _nC; + /// Indicates if there was an initialization done + bool _initDone; +public: + /// Constructor + Communicator2D(SuperStructure2D<T>& superStructure); + /// Initializes the cuboid neighbourhoods + void init_nh(); + + /// Adds a cell to the cuboid neigbourhood iCloc + /// that is then able to get data of the cell + void add_cell(int iCloc, int iX, int iY); + /// Adds all cells of the overlap to its associated 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(); + + /// Access to internal data for the tests + std::vector<CuboidNeighbourhood2D<T>>& get_nh(); +}; + +} // namespace olb + +#endif |