PSTDKernel.h

// This file is part of openPSTD.                                       //
//                                                                      //
// openPSTD 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 3 of the License, or    //
// (at your option) any later version.                                  //
//                                                                      //
// openPSTD 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 openPSTD.  If not, see <http://www.gnu.org/licenses/>.    //
//                                                                      //

//
// Date:
//      18-7-2015
//
// Authors:
//      Michiel Fortuijn
//      Louis van Harten
//      Omar  Richardson
//
// Purpose:
//      The PSTDKernel is the interface between the front- and backend
//      of the program.
//

#ifndef OPENPSTD_KERNELFACADE_H
#define OPENPSTD_KERNELFACADE_H

#include <string>
#include "Solver.h"
#include "core/Scene.h"
#include "KernelInterface.h"

namespace OpenPSTD {
    namespace Kernel {

        class PSTDKernel : public KernelInterface {
        private:
            std::shared_ptr<PSTDConfiguration> config;
            std::shared_ptr<PSTDSettings> settings;
            std::shared_ptr<Kernel::Scene> scene;
            const float default_alpha = 1.f;

            void initialize_scene();

            std::shared_ptr<Kernel::WisdomCache> wnd;

            void add_domains();

            /*
             * Computes the location of the speakers and creates new objects for them.
             * Expects real world coordinates from the scene descriptor file
             * Note that speakers are not bound to grid coordinates.
             * We find the corresponding grid by flooring the location divided by the grid size.
             */
            void add_speakers();

            /*
             * Computes the location of the receivers and creates new objects for them.
             * Expects real world coordinates from the scene descriptor file
             * @see add_speakers();
             */
            void add_receivers();

            std::vector<float> scale_to_grid(QVector2D world_vector);

            std::vector<float> scale_to_grid(QVector3D world_vector);

            std::vector<int> round_off(std::vector<float>);

            std::map<Kernel::Direction, Kernel::EdgeParameters> translate_edge_parameters(DomainConf domain);


        public:

            void initialize_kernel(std::shared_ptr<PSTDConfiguration> config) override;

            void run(KernelCallback *callback) override;

            SimulationMetadata get_metadata() override;

            std::shared_ptr<Kernel::Scene> get_scene();
        };

    }
}

#endif //OPENPSTD_KERNELFACADE_H