AbstractSolver.hpp

/* Copyright (c) 2013       David Sichau <mail"at"sichau"dot"eu>
 *               2013-2015  Simon Tanaka <tanakas"at"gmx"dot"ch>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#ifndef ABSTRACTSOLVER_HPP
#define ABSTRACTSOLVER_HPP

#include <LbmLib/include/Direction.hpp>
#include <string>

namespace LbmLib {
namespace solver {
class AbstractSolver {
 public:
    virtual ~AbstractSolver() {}

    virtual void initSolver() = 0;

    virtual void collide() = 0;

    virtual void advect() = 0;

    virtual void loadSolver(std::stringstream* const stream) = 0;

    virtual void writeSolver(std::ostream* const stream) = 0;

    virtual double& accessDistribution(const Direction& dir) = 0;

    virtual void rescaleDistributions(const double factor) = 0;

    void setTau(double tau) {
        tau_ = tau;
    }

    double getTau() const {
        return tau_;
    }

 protected:
    AbstractSolver();

 private:
    double tau_;
};
}
}  // end namespace

#endif  // ABSTRACTSOLVER_HPP