summaryrefslogtreecommitdiff
path: root/src/boundary/superOffBoundaryCondition3D.h
blob: 0621a3e97144841a501ba3eb7452c6fa3344f325 (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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
/*  This file is part of the OpenLB library
 *
 *  Copyright (C) 2012 Jonas Kratzke, 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 helper for initialising 3D boundaries -- header file.
 */


#ifndef SUPER_OFF_BOUNDARY_CONDITION_3D_H
#define SUPER_OFF_BOUNDARY_CONDITION_3D_H

#include <vector>
#include <list>
#include "offBoundaryCondition3D.h"
#include "geometry/superGeometry3D.h"
#include "core/superLattice3D.h"
#include "io/ostreamManager.h"
#include "functors/analytical/analyticalF.h"
#include "utilities/functorPtr.h"


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

template<typename T> class SuperIndicatorF3D;

/// A helper for initialising 3D boundaries for super lattices.
/**
 * Here we have methods that initializes for a given global
 * point or global range the local postprocessors and the
 * communicator (_commBC in SuperLattice) for boundary conditions.
 *
 * This class is not intended to be derived from.
 */
template<typename T, typename DESCRIPTOR>
class sOffLatticeBoundaryCondition3D {
public:
  /// Constructor
  sOffLatticeBoundaryCondition3D(SuperLattice3D<T,DESCRIPTOR>& sLattice, T epsFraction_ = 0.0001);
  /// Copy construction
  sOffLatticeBoundaryCondition3D(sOffLatticeBoundaryCondition3D<T,DESCRIPTOR> const& rhs);
  /// Copy assignment
  sOffLatticeBoundaryCondition3D operator=(sOffLatticeBoundaryCondition3D<T,DESCRIPTOR> rhs);
  /// Destructor
  ~sOffLatticeBoundaryCondition3D();

  /// Set offDynamics with boundary links and post processors using indicators
  /**
   * Add offDynamics with initialisation of boundary links and the corresponding
   * post processors
   * Note: Uses information of the second neighbours of the cell (x,y,z)
   * Add post processors. Ensure that offDynamics are defined!
   *
   * \param boundaryIndicator Indicator describing boundary cells
   * \param bulkIndicator     Indicator describing bulk cells
   * \param geometryIndicator Indicator describing the geometry to be bounded
   **/
  void addVelocityBoundary(FunctorPtr<SuperIndicatorF3D<T>>&& boundaryIndicator,
                           FunctorPtr<SuperIndicatorF3D<T>>&& bulkIndicator,
                           IndicatorF3D<T>&                   geometryIndicator);
  void addVelocityBoundary(SuperGeometry3D<T>& superGeometry, int material,
                           IndicatorF3D<T>& indicator,
                           std::vector<int> bulkMaterials = std::vector<int>(1,1));

  void addZeroVelocityBoundary(FunctorPtr<SuperIndicatorF3D<T>>&& boundaryIndicator,
                               FunctorPtr<SuperIndicatorF3D<T>>&& bulkIndicator,
                               IndicatorF3D<T>&                   geometryIndicator);
  void addZeroVelocityBoundary(FunctorPtr<SuperIndicatorF3D<T>>&& boundaryIndicator,
                               IndicatorF3D<T>&                   geometryIndicator,
                               std::vector<int> bulkMaterials = std::vector<int>(1,1));
  void addZeroVelocityBoundary(SuperGeometry3D<T>& superGeometry, int material,
                               IndicatorF3D<T>& geometryIndicator,
                               std::vector<int> bulkMaterials = std::vector<int>(1,1));

  void defineU(FunctorPtr<SuperIndicatorF3D<T>>&& indicator,
               FunctorPtr<SuperIndicatorF3D<T>>&& bulkIndicator,
               AnalyticalF3D<T,T>& u);
  void defineU(FunctorPtr<SuperIndicatorF3D<T>>&& indicator,
               AnalyticalF3D<T,T>& u,
               std::vector<int> bulkMaterials = std::vector<int>(1,1) );
  void defineU(SuperGeometry3D<T>& superGeometry, int material,
               AnalyticalF3D<T,T>& u,
               std::vector<int> bulkMaterials = std::vector<int>(1,1) );

  /// Adds needed Cells to the Communicator _commBC in SuperLattice
  void addPoints2CommBC(FunctorPtr<SuperIndicatorF3D<T>>&& indicator);
  /// Adds needed Cells to the Communicator _commBC in SuperLattice
  void addPoints2CommBC(SuperGeometry3D<T>& superGeometry, int material);

  SuperLattice3D<T,DESCRIPTOR>& getSuperLattice();
  std::vector<OffLatticeBoundaryCondition3D<T,DESCRIPTOR>* >& getBlockBCs();
  int getOverlap();
  void setOverlap(int overlap);

  void outputOn();
  void outputOff();

private:
  mutable OstreamManager clout;
  SuperLattice3D<T,DESCRIPTOR>& _sLattice;
  std::vector<OffLatticeBoundaryCondition3D<T,DESCRIPTOR>* > _blockBCs;
  T _epsFraction;
  int _overlap;
  bool _output;
};

template<typename T, typename DESCRIPTOR, typename MixinDynamics=BGKdynamics<T,DESCRIPTOR> >
void createBouzidiBoundaryCondition3D(sOffLatticeBoundaryCondition3D<T,DESCRIPTOR>& sBC);


}  // namespace olb

#endif