genericF.h

Go to the documentation of this file.

/*  This file is part of the OpenLB library
 *
 *  Copyright (C) 2012-2013 Lukas Baron, Mathias J. Krause, Albert Mink
 *  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 GENERIC_F_H
#define GENERIC_F_H
 
#include<string>
#include<memory>
 
namespace olb {
 
template <typename T, typename S>
class GenericF {
protected:
  // constructor
  GenericF(int targetDim, int sourceDim):
    _n(targetDim), _m(sourceDim) { };
 
private:
  std::string _name;
  int _n;
  int _m;
  // private copy constructor
  GenericF(const GenericF&) = delete;
  // copy assignment operator
  GenericF& operator=(const GenericF&) = delete;
 
public:
  using targetType = T;
  using sourceType = S;
  // virtual destructor
  virtual ~GenericF() = default;
  std::shared_ptr< GenericF<T,S> > _ptrCalcC;
  int getSourceDim() const;
  int getTargetDim() const;
  std::string& getName();
  std::string const& getName() const;
  virtual bool operator() (T output[], const S input[])=0;
  // it is aimed that it even calls the implemented pure virtual operator() of derived classes
  // how to use: derived class handles the overloaded operators by including:
  // using GenericF<T,S>::operator();
  bool operator() (T output[]);
  bool operator() (T output[], S input0);
  bool operator() (T output[], S input0, S input1);
  bool operator() (T output[], S input0, S input1, S input2);
  bool operator() (T output[], S input0, S input1, S input2, S input3);
};
 
} // end namespace olb
 
#endif