Scene.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: 17-9-15
//
//
// Authors: Omar Richardson
//
//
// Purpose: Model a scene (a collections of rectangular domains).
//
//

#ifndef OPENPSTD_KERNELSCENE_H
#define OPENPSTD_KERNELSCENE_H

#include <Eigen/Dense>
#include <map>
#include <string>
#include <sstream>
#include "kernel_functions.h"
#include "Domain.h"
#include "Geometry.h"
#include "Speaker.h"
#include "Receiver.h"
#include "Boundary.h"
#include "../KernelInterface.h"

namespace OpenPSTD {
    namespace Kernel {
        class Scene {
        public:
            std::vector<std::shared_ptr<Domain>> domain_list;
            std::shared_ptr<PSTDSettings> settings;
            Point top_left;Initial sound pressure.
            Point bottom_right;
            Point size;

            std::vector<std::shared_ptr<Boundary>> boundary_list;
            std::vector<std::shared_ptr<Receiver>> receiver_list;
            std::vector<std::shared_ptr<Speaker>> speaker_list;
        private:
            std::map<Direction, EdgeParameters> default_edge_parameters; // Uninitialized
            int number_of_domains;
        public:

            Scene(std::shared_ptr<PSTDSettings> settings);

            void add_receiver(const float x, const float y, const float z);

            void add_speaker(const float x, const float y, const float z);

            void add_domain(std::shared_ptr<Domain> domain);

            void compute_pml_matrices();

            void add_pml_domains();

            void apply_pml_matrices();

            Eigen::ArrayXXf get_pressure_field();

            std::shared_ptr<Domain> get_domain(int id);

            int get_new_id();

        private:

            Eigen::ArrayXXf get_field(char field_type);

            std::vector<int> get_corner_points(std::shared_ptr<Domain> domain);

            bool should_merge_domains(std::shared_ptr<Domain> domain1, std::shared_ptr<Domain> domain2);

            std::shared_ptr<Domain> get_singular_parent_domain(std::shared_ptr<Domain> domain);
        };

        std::ostream &operator<<(std::ostream &str, Scene const &v);
    }
}

#endif //OPENPSTD_KERNELSCENE_H