DetectorBase.hpp

Go to the documentation of this file.

/*
 * DetectorBase.hpp
 *
 *  Created on: Dec 2, 2014
 *      Author: nano
 */

#ifndef DETECTORBASE_HPP_
#define DETECTORBASE_HPP_

#include "../config/SimulationConfig.hpp"
#include "../common/SimulationItemBase.hpp"
#include "../cells/CellsBase.hpp"
#include "../../../common/common.hpp"
#include "DetectorData.hpp"
#include <memory>
#include <vector>

namespace phoxonics {
namespace core {

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

    std::string component { "" };
    Vector3D location;
    Vector3D size;
    std::vector<DetectorData> data;
    std::string h5_data_file { "" };
    std::string h5_dataset_name { "" };

    // a configures object and initializes data from config
    virtual void configure(std::shared_ptr<ConfigBase> config_base) override;

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

    // initialize detector
    virtual void init_detector();

    // apply detector logic
    virtual void apply_detector(std::shared_ptr<CellsBase> cells_base, double time);

    // calculate phase and amplitude of detector
    virtual void calculate_amplitude_phase();

    // records detector data in hdf5 format
    virtual void record_hdf5_detector();

    std::string h5_coord_data_file();
};

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

#endif /* DETECTORBASE_HPP_ */