FluidSolver.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 FLUIDSOLVER_HPP
#define FLUIDSOLVER_HPP

#include <LbmLib/include/Field.hpp>
#include <LbmLib/include/solver/AbstractSolver.hpp>
#include <LbmLib/include/solver/FluidSolver/BaseForceModel.hpp>
#include <LbmLib/include/solver/FluidSolver/GuoZhengShi2002ForceModel.hpp>
#include <LbmLib/include/solver/FluidSolver/Luo1993ForceModel.hpp>
#include <array>
#include <string>
namespace LbmLib {
namespace nodes {
class PhysicalNode;
}

namespace solver {
class FluidSolver : public AbstractSolver, private /*GuoZhengShi2002ForceModel*/ Luo1993ForceModel {
 public:
    explicit FluidSolver(const nodes::PhysicalNode& physicalNode);
    ~FluidSolver() {}

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

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

    virtual void collide();

    virtual void advect();

    virtual double& accessDistribution(const Direction& dir);

    virtual void rescaleDistributions(const double factor);

    double getRho() const;

    const Field<double>& getVelocity() const;

    void setVelocity(Field<double> velocity);

    virtual void initSolver();

    void addForce(Field<double> f);

    void resetForce();

    void addMass(double mass);

 private:
    void initWithVelocity();

    void localSwap();

    const nodes::PhysicalNode& physicalNode_;
    std::array<double, 9> distributions_;
    Field<double> velocity_;
    Field<double> force_;
    bool velocityInit_;
    static const DirectionIterator dirIter_;
    double rhoToAdd_;
};


}
}  // end namespace
#endif  // FLUIDSOLVER_HPP