model/plc-cable.h

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2012 University of British Columbia, Vancouver
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Alexander Schloegl <alexander.schloegl@gmx.de>
 */

#ifndef PLC_CABLE_H_
#define PLC_CABLE_H_

#include <cmath>
#include <iostream>
#include <complex>

#include <ns3/object.h>
#include <ns3/type-id.h>
#include <ns3/spectrum-model.h>

#include "plc-defs.h"
#include "plc-value.h"

// Cable model parameters
#define EPS_0   8.854188e-12    // F/m
#define MU_0    12.566371e-7    // H/m
#define MU_R    1
#define RHO             2.82e-8                 // for aluminium (multiple references; to fit Dostert's curves)
#define TAND    0.01                    // depends on insulation
#define MU              (MU_0 * MU_R)
#define EPS_R   4
#define EPS_P   (EPS_0 * EPS_R)

#define NAYY150SE_D             1.8e-3          // insulation, m
#define NAYY150SE_A             6e-4            // conductor area, 4*150e-6m^2
#define NAYY150SE_THETA 3.6e-3          // 2*NAYY150SE_D
#define NAYY150SE_R             13.82e-3        // radius, m, r = sqrt(A/pi)

#define NAYY50SE_D              1.4e-3          // insulation, m
#define NAYY50SE_A              2e-4            // conductor area, 4*50e-6m^2
#define NAYY50SE_THETA  2.8e-3          // 2*NAYY50SE_D
#define NAYY50SE_R              7.98e-3         // radius, m, r = sqrt(A/pi)

#define AL3X95XLPE_EPS_R        0.9
#define AL3X95XLPE_KAPPA        0.285714286
#define AL3X95XLPE_R_A          10e-3
#define AL3X95XLPE_R_I          9.52e-3
#define AL3X95XLPE_TAND         0.004

#define COPPER_CONDUCTIVITY     5.96e7 // (S/m) at 20 degree celcius
#define NYCY70SM35_R_O 8.448e-3 // radius to outer conductor
#define NYCY70SM35_R_I 7.048e-3 // inner conductor radius

namespace ns3 {

class PLC_Cable : public Object
{
public:
        static TypeId GetTypeId(void);

        PLC_Cable () {}

        PLC_Cable(Ptr<const SpectrumModel> sm);

        virtual void Calculate() = 0;

        PLC_Cable(const PLC_FreqSelectiveResistance& R, const PLC_FreqSelectiveConductance& G, const PLC_FreqSelectiveInductance& L, const PLC_FreqSelectiveCapacitance& C, Ptr<const SpectrumModel> sm);

        void SetSpectrumModel(Ptr<const SpectrumModel> sm);
        Ptr<const SpectrumModel> GetSpectrumModel(void) { return m_spectrum_model; }

        Ptr<const PLC_FreqSelectiveImpedance> GetCharImp(void) const;

        Ptr<const PLC_FreqSelectiveImpedance> GetTransConst(void) const;

        double GetPropSpeedApprox(void) { return v; }

        Ptr<const SpectrumModel> GetSpectrumModel(void) const { return m_spectrum_model; }

        void Lock()             { m_cable_mutex.Lock(); }
        void Unlock()   { m_cable_mutex.Unlock(); }

        PLC_FreqSelectiveResistance *GetDistResRef(void) { return &R; }

        PLC_FreqSelectiveResistance *GetDistConRef(void) { return &G; }

private:
        mutable PLC_Mutex                       m_cable_mutex;

protected:
        virtual void DoDispose();

        Ptr<const SpectrumModel>        m_spectrum_model;

        PLC_FreqSelectiveResistance R;
        PLC_FreqSelectiveConductance G;
        PLC_FreqSelectiveInductance L;
        PLC_FreqSelectiveCapacitance C;
        Ptr<PLC_FreqSelectiveImpedance> z_c;
        Ptr<PLC_FreqSelectiveImpedance> gamma;

        double v;

        void CalcCharImp(void);

        void CalcTransConst(void);
};

class PLC_ThreeCoreConcentricCable : public PLC_Cable
{
public:
        static TypeId GetTypeId(void);

        PLC_ThreeCoreConcentricCable() : PLC_Cable() {}

        virtual void Calculate() = 0;

        PLC_ThreeCoreConcentricCable(double eps_r, double kappa, double r_a, double r_i, double tand, Ptr<const SpectrumModel> sm);

        PLC_ThreeCoreConcentricCable(PLC_FreqSelectiveRealValue eps_r, double kappa, double r_a, double r_i, PLC_FreqSelectiveRealValue tand, Ptr<const SpectrumModel> sm);

        void Calculate(double eps_r, double kappa, double r_a, double r_i, double tand, Ptr<const SpectrumModel> sm);
        void Calculate(PLC_FreqSelectiveRealValue eps_r, double kappa, double r_a, double r_i, PLC_FreqSelectiveRealValue tand, Ptr<const SpectrumModel> sm);
};

class PLC_FourSectorPowerSupplyCable : public PLC_Cable
{
public:
        static TypeId GetTypeId(void);

        PLC_FourSectorPowerSupplyCable() : PLC_Cable() {}

        virtual void Calculate() = 0;

        PLC_FourSectorPowerSupplyCable(double radius, double conductor_distance, double tan_loss_angle, double epsilon_r, double rho, Ptr<const SpectrumModel> sm);
        PLC_FourSectorPowerSupplyCable(double radius, double conductor_distance, PLC_FreqSelectiveRealValue tan_loss_angle, PLC_FreqSelectiveRealValue epsilon_r, double rho, Ptr<const SpectrumModel> sm);

        void Calculate(double radius, double conductor_distance, double tan_loss_angle, double epsilon_r, double rho, Ptr<const SpectrumModel> sm);
        void Calculate(double radius, double conductor_distance, PLC_FreqSelectiveRealValue tan_loss_angle, PLC_FreqSelectiveRealValue epsilon_r, double rho, Ptr<const SpectrumModel> sm);
};

class PLC_NAYY150SE_Cable : public PLC_FourSectorPowerSupplyCable
{
public:
        static TypeId GetTypeId(void);

        PLC_NAYY150SE_Cable() : PLC_FourSectorPowerSupplyCable() {}
        PLC_NAYY150SE_Cable(Ptr<const SpectrumModel> sm);
        void Calculate();
};

class PLC_NAYY50SE_Cable : public PLC_FourSectorPowerSupplyCable
{
public:
        static TypeId GetTypeId(void);

        PLC_NAYY50SE_Cable() : PLC_FourSectorPowerSupplyCable() {}
        PLC_NAYY50SE_Cable(Ptr<const SpectrumModel> sm);
        void Calculate();
};

class PLC_AL3x95XLPE_Cable : public PLC_ThreeCoreConcentricCable
{
public:
        static TypeId GetTypeId(void);

        PLC_AL3x95XLPE_Cable() : PLC_ThreeCoreConcentricCable() {}
        PLC_AL3x95XLPE_Cable(Ptr<const SpectrumModel> sm);
        void Calculate();
};

class PLC_NYCY70SM35_Cable : public PLC_ThreeCoreConcentricCable
{
public:
        static TypeId GetTypeId(void);

        PLC_NYCY70SM35_Cable() : PLC_ThreeCoreConcentricCable() {}
        PLC_NYCY70SM35_Cable(Ptr<const SpectrumModel> sm);
        void Calculate();
};

}

#endif /* PLC_CABLE_H_ */