aboutsummaryrefslogtreecommitdiff
path: root/src/devices/octane_segment.h
blob: ea28f032509c840645a809fd5eda42f59aebc10a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
#pragma once

#include <systemc.h>
#include <waveguide.h>
#include <directional_coupler.h>
#include <octane_cell.h>
#include <optical_output_port.h>
#include <optical_signal.h>

// TODO: remove these (are in spx_module.h)
typedef sc_signal_in_if<OpticalSignal > if_in_type;
typedef sc_signal_out_if<OpticalSignal > if_out_type;
typedef sc_port<if_in_type> port_in_type;
typedef sc_port<if_out_type> port_out_type;


/** Building block for the OCTANE circuit
 * The current implementation includes all
 * intermediate components allowing modelling of imperfections,
 * but at the cost of increased module count.
 *
 * A simpler way would be to disregard all intermediate waveguides
 * and model their effects on `octane_cell`
 *
 * Maybe I could add an argument to init(bool isCompact), defining
 * if the model will be compact or not.
*/

//TODO: pass element's characteristics as argument, for instance, pass an example of waveguide,
// or an example of DC, PCM such that it copies. Requires: constructors in each element to build
// by copying.

class OctaneSegment : public sc_module {
public:
    // Ports
    /** The optical input ports. */
    vector<unique_ptr<port_in_type>> p_in;

    /** The optical output ports. */
    vector<unique_ptr<port_out_type>> p_out;

    /** The electric output port*/
    unique_ptr<sc_out<double>> p_readout;

    // Member variables
    // Defines the number of ports and elements
    bool m_term_row;
    bool m_term_col;
    bool m_isCompact;

    // Defines the coupling in the DCs (should change as more elements are added)
    double m_coupling_through_row;
    double m_coupling_through_col;

    // For internal octane_cell
    double m_meltEnergy;
    int m_nStates;


    // Wires
    vector<unique_ptr<sc_signal<OpticalSignal>>> m_optical_connect;

    // Member submodules
    vector<unique_ptr<Waveguide>> m_wg;
    vector<unique_ptr<DirectionalCoupler>> m_dc;
    unique_ptr<OctaneCell> m_oct;

    // init() should be called after declaration
    void init();
    void init_compact();
    void init_full();
    void init_ports();
    void connect_submodules_full();
    void connect_submodules_compact();

    /** Constructor for Octane Segment
     *
     * @param name name of the module
     * @param meltEnergy energy needed to amorphize by one step
     * @param nStates number of internal states supported by the PCM
     * */
    OctaneSegment(sc_module_name name, bool term_row, bool term_col,
                    double coupling_through_row, double coupling_through_col,
                    double meltEnergy, int nStates, bool isCompact = false)
        : sc_module(name)
        , m_term_row(term_row)
        , m_term_col(term_col)
        , m_isCompact(isCompact)
        , m_coupling_through_row(coupling_through_row)
        , m_coupling_through_col(coupling_through_col)
        , m_meltEnergy(meltEnergy)
        , m_nStates(nStates)
    {
        init_ports(); // At least the ports should always be
        // in the constructor
    }

};