summaryrefslogtreecommitdiff
path: root/src/core/superExternal3D.h
blob: a23d777ec075cde091a7d63616087a69e78c9af2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
/*  This file is part of the OpenLB library
 *
 *  Copyright (C) 2015 Mathias J. Krause, Robin Trunk
 *  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
 * The description of a 3D super external field -- header file.
 */


#ifndef SUPER_EXTERNAL_3D_H
#define SUPER_EXTERNAL_3D_H


#include "superLattice3D.h"


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



template<typename T> class Communicator3D;
template<typename T, typename DESCRIPTOR> class SuperLatticeF3D;
template<typename T> class Communicator3D;
template<typename T> class SuperGeometry3D;

/// A super external field is needed to communicate values of the external field
template<typename T, typename DESCRIPTOR, typename FIELD>
class SuperExternal3D : public SuperStructure3D<T> {

private:
  int _overlap;
  SuperLattice3D<T, DESCRIPTOR>& _sLattice;

public:
  /// Construction of a super external field
  SuperExternal3D(SuperGeometry3D<T>& superGeometry, SuperLattice3D<T,DESCRIPTOR>& sLattice,
                  int overlap);
  void communicate(bool verbose=true);
  /// Write access to the memory of the data of the super structure
  bool* operator() (int iCloc, int iX, int iY, int iZ ,int iData) override
  {
    return (bool*) _sLattice.getExtendedBlockLattice(iCloc).get(iX+_overlap,
           iY+_overlap,
           iZ+_overlap).template getFieldPointer<FIELD>();
  };
  /// Read only access to the dim of the data of the super structure
  int getDataSize() const override
  {
    return DESCRIPTOR::template size<FIELD>();
  };
  /// Read only access to the data type dim of the data of the super structure
  int getDataTypeSize() const override
  {
    return sizeof(T);
  };

};

} // namespace olb

#endif