diff options
Diffstat (limited to 'src/functors/lattice/superCalcF3D.h')
-rw-r--r-- | src/functors/lattice/superCalcF3D.h | 130 |
1 files changed, 130 insertions, 0 deletions
diff --git a/src/functors/lattice/superCalcF3D.h b/src/functors/lattice/superCalcF3D.h new file mode 100644 index 0000000..2afb02b --- /dev/null +++ b/src/functors/lattice/superCalcF3D.h @@ -0,0 +1,130 @@ +/* This file is part of the OpenLB library + * + * Copyright (C) 2012-2017 Lukas Baron, Tim Dornieden, Mathias J. Krause, + * Albert Mink, 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 SUPER_CALC_F_3D_H +#define SUPER_CALC_F_3D_H + +#include "utilities/arithmetic.h" +#include "superBaseF3D.h" +#include "utilities/functorPtr.h" + +#include <memory> + +/** Note: Throughout the whole source code directory genericFunctions, the + * template parameters for i/o dimensions are: + * F: S^m -> T^n (S=source, T=target) + */ + +namespace olb { + + +/// Arithmetic operations for SuperF3D functors +/** + * \tparam F Function object defining the arithmetic operation to be perfomed + * e.g. std::minus for substraction + * + * Block level functors are instantiated for operations if at least one input + * functor exposes block level functors. See BlockCalcF3D. + * + * All operations are performed componentwise if functor target dimensions are + * equal. If at least one of the target dimensions is equal to 1 it is applied + * to the other functor as a scalar (i.e. scalar multiplication, addition...). + * + * Warning: Allocation error possible in functors that have multiple functor + * evaluation like SuperSum3D + **/ +template <typename T, typename W, template<typename> class F> +class SuperCalcF3D : public SuperF3D<T,W> { +protected: + FunctorPtr<SuperF3D<T,W>> _f; + FunctorPtr<SuperF3D<T,W>> _g; +public: + SuperCalcF3D(FunctorPtr<SuperF3D<T,W>>&& f, + FunctorPtr<SuperF3D<T,W>>&& g); + + SuperCalcF3D(W scalar, FunctorPtr<SuperF3D<T,W>>&& g); + SuperCalcF3D(FunctorPtr<SuperF3D<T,W>>&& f, W scalar); + + bool operator() (W output[], const int input[]) override; +}; + +/// Addition functor (W==bool: Union) +template <typename T, typename W = T> +using SuperCalcPlus3D = SuperCalcF3D<T,W,util::plus>; + +/// Subtraction functor (W==bool: Without) +template <typename T, typename W = T> +using SuperCalcMinus3D = SuperCalcF3D<T,W,util::minus>; + +/// Multiplication functor (W==bool: Intersection) +template <typename T, typename W = T> +using SuperCalcMultiplication3D = SuperCalcF3D<T,W,util::multiplies>; + +/// Division functor +template <typename T, typename W = T> +using SuperCalcDivision3D = SuperCalcF3D<T,W,util::divides>; + +/// Power functor +template <typename T, typename W = T> +using SuperCalcPower3D = SuperCalcF3D<T,W,util::power>; + +/** + * \name Arithmetic for functors managed by std::shared_ptr + * \{ + **/ + +template <typename T, typename W> +std::shared_ptr<SuperF3D<T,W>> operator+(std::shared_ptr<SuperF3D<T,W>> lhs, std::shared_ptr<SuperF3D<T,W>> rhs); +template <typename T, typename W> +std::shared_ptr<SuperF3D<T,W>> operator+(std::shared_ptr<SuperF3D<T,W>> lhs, W rhs); +template <typename T, typename W> +std::shared_ptr<SuperF3D<T,W>> operator+(W lhs, std::shared_ptr<SuperF3D<T,W>> rhs); + +template <typename T, typename W> +std::shared_ptr<SuperF3D<T,W>> operator-(std::shared_ptr<SuperF3D<T,W>> lhs, std::shared_ptr<SuperF3D<T,W>> rhs); +template <typename T, typename W> +std::shared_ptr<SuperF3D<T,W>> operator-(std::shared_ptr<SuperF3D<T,W>> lhs, W rhs); +template <typename T, typename W> +std::shared_ptr<SuperF3D<T,W>> operator-(W lhs, std::shared_ptr<SuperF3D<T,W>> rhs); + +template <typename T, typename W> +std::shared_ptr<SuperF3D<T,W>> operator*(std::shared_ptr<SuperF3D<T,W>> lhs, std::shared_ptr<SuperF3D<T,W>> rhs); +template <typename T, typename W> +std::shared_ptr<SuperF3D<T,W>> operator*(std::shared_ptr<SuperF3D<T,W>> lhs, W rhs); +template <typename T, typename W> +std::shared_ptr<SuperF3D<T,W>> operator*(W lhs, std::shared_ptr<SuperF3D<T,W>> rhs); + +template <typename T, typename W> +std::shared_ptr<SuperF3D<T,W>> operator/(std::shared_ptr<SuperF3D<T,W>> lhs, std::shared_ptr<SuperF3D<T,W>> rhs); +template <typename T, typename W> +std::shared_ptr<SuperF3D<T,W>> operator/(std::shared_ptr<SuperF3D<T,W>> lhs, W rhs); +template <typename T, typename W> +std::shared_ptr<SuperF3D<T,W>> operator/(W lhs, std::shared_ptr<SuperF3D<T,W>> rhs); + +///\} + + +} // end namespace olb + +#endif |