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/integral/superPlaneIntegralF3D.h | 279 +++++++++++++++++++++
1 file changed, 279 insertions(+)
create mode 100644 src/functors/lattice/integral/superPlaneIntegralF3D.h
(limited to 'src/functors/lattice/integral/superPlaneIntegralF3D.h')
diff --git a/src/functors/lattice/integral/superPlaneIntegralF3D.h b/src/functors/lattice/integral/superPlaneIntegralF3D.h
new file mode 100644
index 0000000..24d5b4c
--- /dev/null
+++ b/src/functors/lattice/integral/superPlaneIntegralF3D.h
@@ -0,0 +1,279 @@
+/* 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
+ *
+ *
+ * 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 SUPER_PLANE_INTEGRAL_F_3D_H
+#define SUPER_PLANE_INTEGRAL_F_3D_H
+
+#include "core/superLattice3D.h"
+#include "core/vector.h"
+#include "geometry/superGeometry3D.h"
+#include "functors/lattice/superBaseF3D.h"
+#include "functors/analytical/indicator/indicatorBaseF3D.h"
+#include "functors/lattice/indicator/superIndicatorF3D.h"
+#include "functors/lattice/indicator/superIndicatorBaseF3D.h"
+#include "functors/lattice/blockReduction3D2D.h"
+#include "functors/lattice/indicator/indicator2D.h"
+#include "utilities/functorPtr.h"
+#include "utilities/hyperplane3D.h"
+#include "utilities/hyperplaneLattice3D.h"
+
+namespace olb {
+
+
+/// Surface integral of a subset of a interpolated hyperplane
+template
+class SuperPlaneIntegralF3D : public SuperF3D {
+protected:
+ SuperGeometry3D& _geometry;
+
+ /// Functor to be integrated on the plane
+ FunctorPtr> _f;
+ /// Indicator describing relevant discrete integration points
+ FunctorPtr> _integrationIndicatorF;
+ /// Indicator describing the relevant subset of the interpolated hyperplane
+ FunctorPtr> _subplaneIndicatorF;
+ /// Functor describing plane to be interpolated and integrated
+ BlockReduction3D2D _reductionF;
+
+ /// Origin vector as given by hyperplane definition, (0,0) in respect to the
+ /// subplane indicator _subplaneIndicatorF
+ /**
+ * Note: The reduced plane _reductionF calculates its own origin based on _origin
+ * as its spans the maximum size possible given the span vectors, origin and geometry
+ * size.
+ **/
+ Vector _origin;
+ /// Span vector u as given by hyperplane definition, normalized to h
+ Vector _u;
+ /// Span vector v as given by hyperplane definition, normalized to h
+ Vector _v;
+ /// Orthogonal vector to _u and _v
+ Vector _normal;
+
+ /// Subset of the discrete plane points given by _reductionF as indicated
+ /// by _integrationIndicatorF. i.e. the points used to interpolate the hyperplane
+ std::vector> _rankLocalSubplane;
+
+ /// \returns true iff the given physical position is to be integrated
+ /**
+ * This is determined using the _integrationIndicatorF indicated subset of the 2d
+ * plane reduced by _reductionF.
+ **/
+ bool isToBeIntegrated(const Vector& physR, int iC);
+
+public:
+ /// Primary constructor
+ /**
+ * All other constructors defer the actual construction to this constructor.
+ *
+ * \param f
+ * (non-)owning pointer or reference to SuperF3D.
+ * \param hyperplaneLattice
+ * Parametrization of the hyperplane lattice to be interpolated.
+ * \param integrationIndicator
+ * (non-)owning pointer or reference to SuperIndicatorF3D.
+ * Describes the set of lattice points relevant for integration.
+ * \param subplaneIndicator
+ * (non-)owning pointer or reference to IndicatorF2D.
+ * Describes the relevant subplane of the interpolated hyperplane.
+ * \param mode
+ * Defines how the values of the discrete hyperplane are determined.
+ * i.e. if they are interpolated or read directly from lattice points.
+ * Note: BlockDataReductionMode::Analytical imposes restrictions on
+ * hyperplane definition and discretization. If you are not sure
+ * consider providing only a hyperplane defintion instead of both a
+ * definition and a discretization.
+ **/
+ SuperPlaneIntegralF3D(FunctorPtr>&& f,
+ SuperGeometry3D& geometry,
+ const HyperplaneLattice3D& hyperplaneLattice,
+ FunctorPtr>&& integrationIndicator,
+ FunctorPtr>&& subplaneIndicator,
+ BlockDataReductionMode mode=BlockDataReductionMode::Analytical);
+ /// Constructor providing automatic lattice generation
+ /**
+ * \param f
+ * (non-)owning pointer or reference to SuperF3D.
+ * \param hyperplane
+ * Parametrization of the hyperplane to be integrated.
+ * The lattice resolution is set to CuboidGeometry3D::getMinDeltaR.
+ * \param integrationIndicator
+ * (non-)owning pointer or reference to SuperIndicatorF3D.
+ * Describes the set of lattice points relevant for integration.
+ * \param subplaneIndicator
+ * (non-)owning pointer or reference to IndicatorF2D.
+ * Describes the relevant subplane of the interpolated hyperplane.
+ * \param mode
+ * Defines how the values of the discrete hyperplane are determined.
+ * i.e. if they are interpolated or read directly from lattice points.
+ **/
+ SuperPlaneIntegralF3D(FunctorPtr>&& f,
+ SuperGeometry3D& geometry,
+ const Hyperplane3D& hyperplane,
+ FunctorPtr>&& integrationIndicator,
+ FunctorPtr>&& subplaneIndicator,
+ BlockDataReductionMode mode=BlockDataReductionMode::Analytical);
+ /// Constructor providing automatic lattice generation and omitting subplane restriction
+ /**
+ * i.e. the intersection between geometry and hyperplane is integrated wherever _integrationIndicatorF allows.
+ *
+ * \param f
+ * (non-)owning pointer or reference to SuperF3D.
+ * \param hyperplane
+ * Parametrization of the hyperplane to be integrated.
+ * The lattice resolution is set to the cuboid geometry's minDeltaR.
+ * \param integrationIndicator
+ * (non-)owning pointer or reference to SuperIndicatorF3D.
+ * Describes the set of lattice points relevant for integration.
+ * \param mode
+ * Defines how the values of the discrete hyperplane are determined.
+ * i.e. if they are interpolated or read directly from lattice points.
+ **/
+ SuperPlaneIntegralF3D(FunctorPtr>&& f,
+ SuperGeometry3D& geometry,
+ const Hyperplane3D& hyperplane,
+ FunctorPtr>&& integrationIndicator,
+ BlockDataReductionMode mode=BlockDataReductionMode::Analytical);
+
+ /// Constructor providing automatic lattice and material indicator instantiation
+ /**
+ * \param f (non-)owning pointer or reference to SuperF3D.
+ * \param origin hyperplane origin
+ * \param u hyperplane span vector
+ * \param v hyperplane span vector
+ * \param materials material numbers relevant for hyperplane integration
+ * \param mode defines how the values of the discrete hyperplane are determined
+ **/
+ SuperPlaneIntegralF3D(FunctorPtr>&& f,
+ SuperGeometry3D& geometry,
+ const Vector& origin,
+ const Vector& u, const Vector& v,
+ std::vector materials,
+ BlockDataReductionMode mode=BlockDataReductionMode::Analytical);
+ /// Constructor providing automatic lattice parametrization, only interpolating material 1
+ /**
+ * \param f (non-)owning pointer or reference to SuperF3D.
+ * \param origin hyperplane origin
+ * \param u hyperplane span vector
+ * \param v hyperplane span vector
+ * \param mode Defines how the values of the discrete hyperplane are determined.
+ **/
+ SuperPlaneIntegralF3D(FunctorPtr>&& f,
+ SuperGeometry3D& geometry,
+ const Vector& origin,
+ const Vector& u, const Vector& v,
+ BlockDataReductionMode mode=BlockDataReductionMode::Analytical);
+
+ /// Constructor providing automatic lattice and material indicator instantiation
+ /**
+ * \param f (non-)owning pointer or reference to SuperF3D.
+ * \param origin hyperplane origin
+ * \param normal hyperplane normal
+ * \param materials material numbers relevant for hyperplane integration
+ * \param mode defines how the values of the discrete hyperplane are determined
+ **/
+ SuperPlaneIntegralF3D(FunctorPtr>&& f,
+ SuperGeometry3D& geometry,
+ const Vector& origin,
+ const Vector& normal,
+ std::vector materials,
+ BlockDataReductionMode mode=BlockDataReductionMode::Analytical);
+ /// Constructor providing automatic lattice parametrization, only interpolating material 1
+ /**
+ * \param f (non-)owning pointer or reference to SuperF3D.
+ * \param origin hyperplane origin
+ * \param normal hyperplane normal
+ * \param mode defines how the values of the discrete hyperplane are determined
+ **/
+ SuperPlaneIntegralF3D(FunctorPtr>&& f,
+ SuperGeometry3D& geometry,
+ const Vector& origin,
+ const Vector& normal,
+ BlockDataReductionMode mode=BlockDataReductionMode::Analytical);
+
+ /// Constructor providing automatic lattice and material indicator instantiation
+ /**
+ * \param f (non-)owning pointer or reference to SuperF3D.
+ * \param normal hyperplane normal (centered in mother cuboid)
+ * \param materials material numbers relevant for hyperplane integration
+ * \param mode defines how the values of the discrete hyperplane are determined
+ **/
+ SuperPlaneIntegralF3D(FunctorPtr>&& f,
+ SuperGeometry3D& geometry,
+ const Vector& normal,
+ std::vector materials,
+ BlockDataReductionMode mode=BlockDataReductionMode::Analytical);
+ /// Constructor providing automatic lattice parametrization, only interpolating material 1
+ /**
+ * \param f (non-)owning pointer or reference to SuperF3D.
+ * \param normal hyperplane normal (centered in mother cuboid)
+ * \param mode defines how the values of the discrete hyperplane are determined
+ **/
+ SuperPlaneIntegralF3D(FunctorPtr>&& f,
+ SuperGeometry3D& geometry,
+ const Vector& normal,
+ BlockDataReductionMode mode=BlockDataReductionMode::Analytical);
+
+ /// Constructor providing automatic lattice parametrization to fit a given circle
+ /**
+ * \param f (non-)owning pointer or reference to SuperF3D.
+ * \param circle circle indicator to be used for hyperplane subset parametrization
+ * \param materials material numbers relevant for hyperplane interpolation
+ * \param mode defines how the values of the discrete hyperplane are determined
+ **/
+ SuperPlaneIntegralF3D(FunctorPtr>&& f,
+ SuperGeometry3D& geometry,
+ const IndicatorCircle3D& circle,
+ std::vector materials,
+ BlockDataReductionMode mode=BlockDataReductionMode::Analytical);
+ /// Constructor providing automatic lattice parametrization to fit a given circle and only interpolating material 1
+ /**
+ * \param f (non-)owning pointer or reference to SuperF3D.
+ * \param circle circle indicator to be used for hyperplane subset parametrization
+ * \param mode defines how the values of the discrete hyperplane are determined
+ **/
+ SuperPlaneIntegralF3D(FunctorPtr>&& f,
+ SuperGeometry3D& geometry,
+ const IndicatorCircle3D& circle,
+ BlockDataReductionMode mode=BlockDataReductionMode::Analytical);
+
+ /**
+ * Returns the plane integral in the following structure:
+ *
+ * \code
+ * output[0] = integral, e.g. flow[0] * h^2 for 1-dimensional target sizes
+ * output[1] = #voxels * h^2 i.e. area
+ * output[2..2+f.getTargetSize()] = flow
+ * \endcode
+ *
+ * Note: output[0] contains the flux value if applicable
+ *
+ * \param input irrelevant
+ **/
+ bool operator() (T output[], const int input[]) override;
+};
+
+
+}
+
+#endif
--
cgit v1.2.3