EngineBase.hpp

Go to the documentation of this file.

/*
 * EngineBase.hpp
 *
 *  Created on: Oct 20, 2014
 *      Author: nano
 */

#ifndef ENGINEBASE_HPP_
#define ENGINEBASE_HPP_

#include "../config/SimulationConfig.hpp"
#include "../common/SimulationItemBase.hpp"
#include "../grid/GridBase.hpp"
#include "../source/SourceBase.hpp"
#include "../detector/DetectorBase.hpp"
#include "../pml/PmlBase.hpp"
#include "../data/EmConstants.hpp"
#include "../../../common/common.hpp"
#include "../../../visual/visual.hpp"
#include <memory>
#include <string>

namespace phoxonics {
namespace core {

class EngineBase : public SimulationItemBase {
public:
    explicit EngineBase();
    virtual ~EngineBase();

    bool mpi_enabled { false };
    bool cuda_enabled { false };
    std::string h5_geometry_file { "" };
    std::string h5_data_file { "" };
    std::string h5_geom_dataset_name { "" };
    std::string h5_data_dataset_name { "" };
    bool real_time_visualization { false };
    std::string visualization_commands { "" };
    bool generate_animation { false };

    // configures object and initializes data from config
    virtual void configure() override;

    // prints object data
    virtual void print_me() override;

    // starts engine process
    virtual void start(std::shared_ptr<GridBase> grid_base,
            std::vector<std::shared_ptr<SourceBase>> sources_base,
            std::vector<std::shared_ptr<DetectorBase>> detectors_base,
            std::shared_ptr<PmlBase> pml_base);

protected:
    std::shared_ptr<GridBase> grid_base_;
    std::vector<std::shared_ptr<SourceBase>> sources_base_;
    std::vector<std::shared_ptr<DetectorBase>> detectors_base_;
    std::shared_ptr<PmlBase> pml_base_;

    virtual void process();
    virtual void update_field(std::string component);
    virtual void apply_sources(double time);
    virtual void apply_pml();
    virtual void apply_detectors(double time);
    virtual void init_hdf5_files();
    virtual void record_hdf5_slice();
    virtual void visualize_real_time();
    virtual void calculate_detectors_amp_phase();
    virtual void record_hdf5_detectors();
    virtual void generate_hdf5_shell(bool execute_shell);
    std::string h5_component_data_file(std::string component);
};

} /* namespace core */
} /* namespace phoxonics */

#endif /* ENGINEBASE_HPP_ */