From 94d3e79a8617f88dc0219cfdeedfa3147833719d Mon Sep 17 00:00:00 2001
From: Adrian Kummerlaender
Date: Mon, 24 Jun 2019 14:43:36 +0200
Subject: Initialize at openlb-1-3

---
 .../lattice/indicator/blockIndicatorBaseF3D.h      | 107 +++++++++++++++++++++
 1 file changed, 107 insertions(+)
 create mode 100644 src/functors/lattice/indicator/blockIndicatorBaseF3D.h

(limited to 'src/functors/lattice/indicator/blockIndicatorBaseF3D.h')

diff --git a/src/functors/lattice/indicator/blockIndicatorBaseF3D.h b/src/functors/lattice/indicator/blockIndicatorBaseF3D.h
new file mode 100644
index 0000000..96dd05a
--- /dev/null
+++ b/src/functors/lattice/indicator/blockIndicatorBaseF3D.h
@@ -0,0 +1,107 @@
+/*  This file is part of the OpenLB library
+ *
+ *  Copyright (C) 2017 Adrian Kummerlaender
+ *  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.
+*/
+
+#ifndef BLOCK_INDICATOR_BASE_F_3D_H
+#define BLOCK_INDICATOR_BASE_F_3D_H
+
+#include "functors/lattice/superBaseF3D.h"
+#include "functors/lattice/blockBaseF3D.h"
+#include "core/blockData3D.h"
+#include "core/blockStructure3D.h"
+
+namespace olb {
+
+/// Base block indicator functor
+/**
+ * Derived functors implement a indicator function on the full domain given by
+ * BlockGeometryStructure3D. Note the distinction between normal and extended
+ * block geometries exposed by SuperGeometry3D.
+ *
+ * By convention SuperIndicatorF3D::_blockF functors are expected to operate on
+ * overlap-less domains i.e. BlockGeometryView3D instances.
+ *
+ * Block indicators to be queried on a full block including its overlap must be
+ * constructed on extended BlockGeometry3D  instances such as  those exposed by
+ * SuperGeometry3D::getExtendedBlockGeometry
+ **/
+template <typename T>
+class BlockIndicatorF3D : public BlockF3D<bool> {
+protected:
+  BlockGeometryStructure3D<T>& _blockGeometryStructure;
+  const BlockData3D<T,bool>*   _cachedData;
+public:
+  using BlockF3D<bool>::operator();
+
+  /// Constructor
+  /**
+   * \param geometry Any implementation of BlockGeometryStructure3D
+   *                 e.g. BlockGeometry3D or BlockGeometryView3D
+   **/
+  BlockIndicatorF3D(BlockGeometryStructure3D<T>& geometry);
+
+  /// Get underlying block geometry structure
+  /**
+   * \returns _blockGeometryStructure
+   **/
+  BlockGeometryStructure3D<T>& getBlockGeometryStructure();
+
+  /// Block indicator specific function operator overload
+  /**
+   * The boolean return value of `operator()(T output[], S input[])` describes
+   * the call's success and by convention must not describe the indicated domain.
+   *
+   * \return Domain indicator i.e. `true` iff the input lies within the described subset.
+   **/
+  bool operator() (const int input[]);
+  /// Block indicator specific function operator overload
+  /**
+   * The boolean return value of `operator()(T output[], S input[])` describes
+   * the call's success and by convention must not describe the indicated domain.
+   *
+   * \return Domain indicator i.e. `true` iff the input lies within the described subset.
+   **/
+  bool operator() (int iX, int iY, int iZ);
+
+  /// Set bool-mask cache to be used by indicator operator overloads
+  void setCache(const BlockData3D<T,bool>& cache);
+
+  /// Returns true only if the indicated domain subset is empty
+  /**
+   * May return false even if the indicated domain subset is in fact empty.
+   * Primarily implemented to minimize block accesses if an empty domain can
+   * be inferred by e.g. BlockGeometryStatistics3D data.
+   *
+   * i.e. only override this method if the domain can be checked for emptyness
+   *      in an efficient fashion.
+   **/
+  virtual bool isEmpty();
+  /// Returns min lattice position of the indicated subset's bounding box
+  virtual Vector<int,3> getMin() = 0;
+  /// Returns max lattice position of the indicated subset's bounding box
+  virtual Vector<int,3> getMax() = 0;
+
+};
+
+} // namespace olb
+
+#endif
-- 
cgit v1.2.3