PhysicalNode.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 FLUIDPOINT_HPP
#define FLUIDPOINT_HPP


#include <LbmLib/include/nodes/EulerianPoint.hpp>
#include <LbmLib/include/Direction.hpp>
#include <LbmLib/include/solver/FluidSolver/FluidSolver.hpp>
#include <array>
#include <vector>
#include <string>
#include <iostream>
#include <memory>

namespace LbmLib {
namespace solver {
class CDEAbstractSolver;
}
namespace nodes {
class BoundaryNode;

class PhysicalNode : public EulerianPoint {
 public:
    explicit PhysicalNode(
            int x,
            int y);
    ~PhysicalNode();
    void setPhysicalNeighbour(
            PhysicalNode* const node,
            const Direction& d);

    void setBoundaryNeighbour(
            BoundaryNode* const boundaryNode,
            const Direction& d);

    BoundaryNode* getBoundaryNeighbour(const Direction& d) const;

    PhysicalNode* getPhysicalNeighbour(const Direction& d) const;

    void resetBoundaryNodes();

    virtual std::string getType() const;

    void dumpNode(std::ostream* oStream) const;

    const solver::FluidSolver& getFluidSolver() const;

    solver::FluidSolver& getFluidSolver();

    solver::CDEAbstractSolver& getCDESolver(size_t id) const;

    solver::CDEAbstractSolver& getCDESolverSlow(const std::string& name) const;

    std::vector<solver::CDEAbstractSolver*>& getCDESolvers();

    void addCDESolver(const std::string& cdeSolverName);

    void updateDomainIdentifier();

    unsigned int getDomainIdentifier() const;

    void setDomainIdentifier(unsigned int domainIdentifier);

    unsigned int getCellType() const;

    void setCellType(unsigned int celltype);

 private:
    void reinitialiseCDESolvers();

    solver::FluidSolver fluidSolver_;
    std::vector<solver::CDEAbstractSolver*> cdeSolvers_;

    std::array<PhysicalNode*, 9> neighbourNodes_;

    std::array<BoundaryNode*, 5> boundaryNodes_;

    unsigned int domainIdentifier_;

    unsigned int cellType_;
};
}   // end namespace
}  // end namespace

#endif  // FLUIDPOINT_HPP