panel_setup_tuning_profile_info.h

Go to the documentation of this file.

/*
* This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program 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 2
 * of the License, or (at your option) any later version.
 *
 * 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, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef PANEL_SETUP_TUNING_PROFILE_INFO_H
#define PANEL_SETUP_TUNING_PROFILE_INFO_H
 
#include <dialogs/panel_setup_tuning_profile_info_base.h>
#include <project/tuning_profiles.h>
#include <transline_calculations/coupled_microstrip.h>
#include <transline_calculations/coupled_stripline.h>
#include <transline_calculations/microstrip.h>
#include <transline_calculations/stripline.h>
#include <widgets/unit_binder.h>
#include <board_stackup_manager/board_stackup.h>
#include <layer_ids.h>
 
class PANEL_SETUP_TUNING_PROFILES;
 
class PANEL_SETUP_TUNING_PROFILE_INFO : public PANEL_SETUP_TUNING_PROFILE_INFO_BASE
{
public:
    PANEL_SETUP_TUNING_PROFILE_INFO( wxWindow* aParentWindow, PANEL_SETUP_TUNING_PROFILES* parentPanel );
 
    ~PANEL_SETUP_TUNING_PROFILE_INFO() override;

    void UpdateLayerNames();

    void LoadProfile( const TUNING_PROFILE& aProfile );

    TUNING_PROFILE GetProfile() const;

    void OnProfileNameChanged( wxCommandEvent& event ) override;

    void OnChangeProfileType( wxCommandEvent& event ) override;

    void OnAddTrackRow( wxCommandEvent& event ) override;

    void OnRemoveTrackRow( wxCommandEvent& event ) override;

    void OnAddViaOverride( wxCommandEvent& event ) override;

    void OnRemoveViaOverride( wxCommandEvent& event ) override;

    wxString GetProfileName() const;

    bool ValidateProfile( size_t aPageIndex );
 
private:
    enum TRACK_GRID_COLS
    {
        TRACK_GRID_SIGNAL_LAYER = 0,
        TRACK_GRID_TOP_REFERENCE,
        TRACK_GRID_BOTTOM_REFERENCE,
        TRACK_GRID_TRACK_WIDTH,
        TRACK_GRID_TRACK_GAP,
        TRACK_GRID_DELAY
    };
 
    enum VIA_GRID_COLS
    {
        VIA_GRID_SIGNAL_LAYER_FROM = 0,
        VIA_GRID_SIGNAL_LAYER_TO,
        VIA_GRID_VIA_LAYER_FROM,
        VIA_GRID_VIA_LAYER_TO,
        VIA_GRID_DELAY
    };
 
    enum class CalculationType
    {
        WIDTH,
        GAP,
        DELAY
    };
 
    struct CALCULATION_RESULT
    {
        CALCULATION_RESULT() = default;
        explicit CALCULATION_RESULT( const wxString& errorMsg ) :
                ErrorMsg{ errorMsg }
        {
        }
        explicit CALCULATION_RESULT( const int aWidth, const int aDelay ) :
                OK{ true },
                Width{ aWidth },
                Delay{ aDelay }
        {
        }
        explicit CALCULATION_RESULT( const int aWidth, const int aDiffPairGap, const int aDelay ) :
                OK{ true },
                Width{ aWidth },
                DiffPairGap{ aDiffPairGap },
                Delay{ aDelay }
        {
        }
 
        bool     OK{ false };
        int      Width{ 0 };
        int      DiffPairGap{ 0 };
        int      Delay{ 0 };
        wxString ErrorMsg;
    };
 
    struct CALCULATION_BOARD_PARAMETERS
    {
        PCB_LAYER_ID SignalLayer{ PCB_LAYER_ID::UNDEFINED_LAYER };
        double DielectricConstant{ 0 };
        double TopDielectricLayerThickness{ 0 };
        double BottomDielectricLayerThickness{ 0 };
        double SignalLayerThickness{ 0 };
        double LossTangent{ 0 };
 
        // Solder mask data
        double SolderMaskDielectricConstant{ 0 };
        double SolderMaskThickness{ 0 };
        double SolderMaskLossTangent{ 0 };
    };

    void initPanel();

    void setColumnWidths();

    std::pair<CALCULATION_BOARD_PARAMETERS, CALCULATION_RESULT>
    getMicrostripBoardParameters( int aRow, const EDA_IU_SCALE& aScale );

    std::pair<CALCULATION_BOARD_PARAMETERS, CALCULATION_RESULT>
    getStriplineBoardParameters( int aRow, const EDA_IU_SCALE& aScale );

    CALCULATION_RESULT calculateSingleMicrostrip( const int aRow, CalculationType aCalculationType );

    CALCULATION_RESULT calculateSingleStripline( const int aRow, CalculationType aCalculationType );

    CALCULATION_RESULT calculateDifferentialMicrostrip( int aRow, CalculationType aCalculationType );

    CALCULATION_RESULT calculateDifferentialStripline( int aRow, CalculationType aCalculationType );

    static double calculateSkinDepth( double aFreq, double aMurc, double aSigma );

    static int getStackupLayerId( const std::vector<BOARD_STACKUP_ITEM*>& aLayerList, PCB_LAYER_ID aPcbLayerId );
 
    struct DIELECTRIC_INFO
    {
        double Height{ 0.0 };
        double E_r{ 0.0 };
        double Loss_Tangent{ 0.0 };
    };

    DIELECTRIC_INFO
    calculateAverageDielectricConstants( const std::vector<BOARD_STACKUP_ITEM*>& aStackupLayerList,
                                         const std::vector<int>&                 dielectricLayerStackupIds,
                                         const EDA_IU_SCALE&                     aIuScale );

    void getDielectricLayers( const std::vector<BOARD_STACKUP_ITEM*>& aStackupLayerList, int aSignalLayerId,
                              int aReferenceLayerId, std::vector<int>& aDielectricLayerStackupIds );

    static DIELECTRIC_INFO getSolderMaskParameters( const std::vector<BOARD_STACKUP_ITEM*>& aStackupLayerList,
                                                    const EDA_IU_SCALE& aScale, PCB_LAYER_ID aSignalLayerId );

    double getTargetImpedance() const;

    void calculateTrackParametersForCell( int aRow, int aCol );

    void onChangeProfileType( TUNING_PROFILE::PROFILE_TYPE aType ) const;

    double getFrequency() const;

    PANEL_SETUP_TUNING_PROFILES* m_parentPanel;

    UNIT_BINDER m_viaPropagationUnits;

    MICROSTRIP m_microstripCalc;

    STRIPLINE m_striplineCalc;

    COUPLED_MICROSTRIP m_coupledMicrostripCalc;

    COUPLED_STRIPLINE m_coupledStriplineCalc;
 
    // Electrical resistivity or specific electrical resistance of copper (ohm*meter)
    static constexpr double RHO = 1.72e-8;
};
 
 
#endif //PANEL_SETUP_TUNING_PROFILE_INFO_H