haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
kicad/eeschema/dialogs/dialog_sim_model.h

141 lines
5.0 KiB
C
Raw Normal View History

Spice model editor dialog
2016-08-11 12:41:40 +00:00
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
Begin development of a new Sim Model Editor dialog With that also begin reworking the internal structure of the simulation model storage. Some models have parameter information extracted from Ngspice, which was specially patched to faciliate that. The model is stored and managed by the SPICE_MODEL class (later will be renamed to SIM_MODEL).
2022-02-09 00:45:04 +00:00
* Copyright (C) 2022 Mikolaj Wielgus
* Copyright (C) 2022 KiCad Developers, see AUTHORS.txt for contributors.
Spice model editor dialog
2016-08-11 12:41:40 +00:00
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
Changed the simulator code license to GPLv3+
2016-08-11 12:41:43 +00:00
* as published by the Free Software Foundation; either version 3
Spice model editor dialog
2016-08-11 12:41:40 +00:00
* 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, you may find one here:
Changed the simulator code license to GPLv3+
2016-08-11 12:41:43 +00:00
* https://www.gnu.org/licenses/gpl-3.0.html
* or you may search the http://www.gnu.org website for the version 3 license,
Spice model editor dialog
2016-08-11 12:41:40 +00:00
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
Sim: Bugfixes, mostly for MS Windows compilation errors Unfortunately, Windows headers define a lot of macros for common words, so we had to rename some enums to not collide. We also fix some of the many bugs related to the new simulation architecture and the Spice Model Editor dialog.
2022-06-21 02:22:52 +00:00
#ifndef DIALOG_SIM_MODEL_H
#define DIALOG_SIM_MODEL_H
Sim: Ibis improvements and fixes Follow-up after the KIBIS and KIBIS GUI merge requests. - Move KIBIS from Pcbnew to Eeschema space, - Make KIBIS obtain the Ku/Kd coefficients via the `SPICE_SIMULATOR` class instead of calling the `ngspice` executable via `system()`, - Allow to toggle between differential and single-ended model in the GUI, - Various GUI fixes and improvements.
2022-10-25 09:45:40 +00:00
#include <sim/kibis/kibis.h>
Spice model editor dialog
2016-08-11 12:41:40 +00:00
Sim: Spice netlist exporter rewrite Rewrite the spice exporter to work with the new simulation model architecture and data model, with many bugfixes related to the latter two along the way.
2022-04-12 14:37:06 +00:00
#include <dialog_sim_model_base.h>
#include <netlist_exporter_spice.h>
Dark theme support for SPICE model editor
2021-12-03 02:41:02 +00:00
#include <scintilla_tricks.h>
Validators for Spice model dialog
2016-08-11 12:41:56 +00:00
Sim Model Editor: Display model parameters This commit adds parameter display functionality, via a wxPropertyGrid widget, to the Sim Model Editor. To faciliate that, a SIM_VALUE class is created to serialize, deserialize, and validate numeric values in the new parameter grid. SPICE_MODEL is renamed to SIM_MODEL and split into several subclasses that correspond to different model kinds.
2022-02-21 03:58:31 +00:00
#include <sim/sim_model.h>
Sim: Implement loading Spice library files Implement parsing and loading Spice libraries into KiCad. This is done without any involvement of Ngspice -- we create our own in-tree parser using PEGTL -- because Ngspice doesn't offer any intermediate output we could plug ourselves into. We don't parse everything -- just the library content, so this won't be that much effort. We implement some basic Spice code preview to give the user a hint what Spice code eir model will correspond to.
2022-04-01 04:30:50 +00:00
#include <sim/sim_library.h>
Sim: Remove some superfluous class members
2022-10-10 11:49:43 +00:00
#include <sim/sim_library_kibis.h>
Eeschema: use symbol nomenclature for object file naming.
2021-02-24 13:48:02 +00:00
#include <sch_symbol.h>
Validators for Spice model dialog
2016-08-11 12:41:56 +00:00
Sim: Bugfixes, mostly for MS Windows compilation errors Unfortunately, Windows headers define a lot of macros for common words, so we had to rename some enums to not collide. We also fix some of the many bugs related to the new simulation architecture and the Spice Model Editor dialog.
2022-06-21 02:22:52 +00:00
Sim Model Editor: Display model parameters This commit adds parameter display functionality, via a wxPropertyGrid widget, to the Sim Model Editor. To faciliate that, a SIM_VALUE class is created to serialize, deserialize, and validate numeric values in the new parameter grid. SPICE_MODEL is renamed to SIM_MODEL and split into several subclasses that correspond to different model kinds.
2022-02-21 03:58:31 +00:00
// Some probable wxWidgets bugs encountered when writing this class:
// 1. There are rendering problems with wxPropertyGrid on Linux, GTK, Xorg when
// wxPG_NATIVE_DOUBLE_BUFFERING flag is not set.
// 2. wxPropertyGridManager->ShowHeader() segfaults when called from this dialog's constructor.
Remove ugly hack of passing SCH_SYMBOL as parent of LIB_FIELD array. Also adds simulation model inference to Symbol Editor's Simulation Model Editor, and adds write-back from both Simulation Model Editors to their parent Symbol Fields Editor dialogs. Fixes https://gitlab.com/kicad/code/kicad/issues/12505
2022-12-09 20:02:47 +00:00
template <typename T_symbol, typename T_field>
Sim: Spice netlist exporter rewrite Rewrite the spice exporter to work with the new simulation model architecture and data model, with many bugfixes related to the latter two along the way.
2022-04-12 14:37:06 +00:00
class DIALOG_SIM_MODEL : public DIALOG_SIM_MODEL_BASE
Spice model editor dialog
2016-08-11 12:41:40 +00:00
{
public:
Move model pin editor to GRID_CELL_ICON_TEXT_POPUP. wxChoice is hopeless on Mac (it still doesn't highlight on rollover), and using a char for the "assigned" graphic isn't great.
2022-10-28 11:43:00 +00:00
enum PARAM_COLUMN
{
DESCRIPTION = 0,
VALUE,
UNIT,
DEFAULT,
TYPE,
END_
};
enum PIN_COLUMN
{
SYMBOL = 0,
MODEL
};
Begin development of a new Sim Model Editor dialog With that also begin reworking the internal structure of the simulation model storage. Some models have parameter information extracted from Ngspice, which was specially patched to faciliate that. The model is stored and managed by the SPICE_MODEL class (later will be renamed to SIM_MODEL).
2022-02-09 00:45:04 +00:00
Fix crash when grid tries to access deleted field.
2022-12-11 22:59:27 +00:00
DIALOG_SIM_MODEL( wxWindow* aParent, T_symbol& aSymbol, std::vector<T_field>& aFields );
Spice model editor dialog
2016-08-11 12:41:40 +00:00
Usability improvements to Pin Assignments in Sim Model dialog. Fixes https://gitlab.com/kicad/code/kicad/issues/12720 Fixes https://gitlab.com/kicad/code/kicad/issues/12721
2022-10-27 23:33:31 +00:00
~DIALOG_SIM_MODEL();
Spice model editor dialog
2016-08-11 12:41:40 +00:00
private:
Begin development of a new Sim Model Editor dialog With that also begin reworking the internal structure of the simulation model storage. Some models have parameter information extracted from Ngspice, which was specially patched to faciliate that. The model is stored and managed by the SPICE_MODEL class (later will be renamed to SIM_MODEL).
2022-02-09 00:45:04 +00:00
bool TransferDataToWindow() override;
Sim: Implement loading Spice library files Implement parsing and loading Spice libraries into KiCad. This is done without any involvement of Ngspice -- we create our own in-tree parser using PEGTL -- because Ngspice doesn't offer any intermediate output we could plug ourselves into. We don't parse everything -- just the library content, so this won't be that much effort. We implement some basic Spice code preview to give the user a hint what Spice code eir model will correspond to.
2022-04-01 04:30:50 +00:00
bool TransferDataFromWindow() override;
Spice model editor dialog
2016-08-11 12:41:40 +00:00
Begin development of a new Sim Model Editor dialog With that also begin reworking the internal structure of the simulation model storage. Some models have parameter information extracted from Ngspice, which was specially patched to faciliate that. The model is stored and managed by the SPICE_MODEL class (later will be renamed to SIM_MODEL).
2022-02-09 00:45:04 +00:00
void updateWidgets();
Sim Model Editor: Fix Model panel sizing
2022-10-04 21:47:52 +00:00
void updateIbisWidgets();
Don't conflate instance and ibis widgets.
2022-10-31 10:33:45 +00:00
void updateInstanceWidgets();
Sim Model Editor: Serialize models in fields Implemented serialization and deserialization of models in symbol fields through the SIM_VALUE class. We don't carry the Spice legacy of case-insensitive suffixes, instead we conform to the SI standard (i.e. M is Mega, not milli, P is peta, p is pico). Parameter grid value validation is implemented by simply not allowing any characters that will make the value invalid (instead of highlighting the field in a red color). This will likely be changed at some point in the future.
2022-03-09 01:40:59 +00:00
void updateModelParamsTab();
void updateModelCodeTab();
Create class for voltage and current -controlled switches Unfortunately, along the way it turned out that Ngspice's .probe alli breaks current-controlled switches. So they won't work in that case for now.
2022-08-28 12:51:03 +00:00
void updatePinAssignments();
void removeOrphanedPinAssignments();
Sim: Implement loading Spice library files Implement parsing and loading Spice libraries into KiCad. This is done without any involvement of Ngspice -- we create our own in-tree parser using PEGTL -- because Ngspice doesn't offer any intermediate output we could plug ourselves into. We don't parse everything -- just the library content, so this won't be that much effort. We implement some basic Spice code preview to give the user a hint what Spice code eir model will correspond to.
2022-04-01 04:30:50 +00:00
Sim: Make library path textbox editable Load the library from the path if enter is pressed or focus is lost if the library exists. If a library under the same path as previously is to be loaded this way, don't do anything. Fixes https://gitlab.com/kicad/code/kicad/issues/12970
2022-11-26 02:47:41 +00:00
void loadLibrary( const wxString& aLibraryPath, bool aForceReload = false );
More about fix compil issues and warnings, especially in ibis code. A few are msys2 specific and due to include files order.
2022-09-28 09:09:35 +00:00
Sim: Implement loading Spice library files Implement parsing and loading Spice libraries into KiCad. This is done without any involvement of Ngspice -- we create our own in-tree parser using PEGTL -- because Ngspice doesn't offer any intermediate output we could plug ourselves into. We don't parse everything -- just the library content, so this won't be that much effort. We implement some basic Spice code preview to give the user a hint what Spice code eir model will correspond to.
2022-04-01 04:30:50 +00:00
void addParamPropertyIfRelevant( int aParamIndex );
wxPGProperty* newParamProperty( int aParamIndex ) const;
Allow mapping sim model pins to arbitrary string symbol pin numbers This change removes the incorrect assumption that symbol pin numbers are integers and are the same as indexes in the vector storing the symbol pins. "~" is now used to denote a floating sim model pin.
2022-08-22 05:40:23 +00:00
int findSymbolPinRow( const wxString& aSymbolPinNumber ) const;
Sim: Implement loading Spice library files Implement parsing and loading Spice libraries into KiCad. This is done without any involvement of Ngspice -- we create our own in-tree parser using PEGTL -- because Ngspice doesn't offer any intermediate output we could plug ourselves into. We don't parse everything -- just the library content, so this won't be that much effort. We implement some basic Spice code preview to give the user a hint what Spice code eir model will correspond to.
2022-04-01 04:30:50 +00:00
SIM_MODEL& curModel() const;
Sim Model Editor: Use SIM_LIB_MGR class to manage library models
2022-11-19 00:45:28 +00:00
const SIM_LIBRARY* library() const;
Spice model editor dialog
2016-08-11 12:41:40 +00:00
Sim Model Editor: Serialize models in fields Implemented serialization and deserialization of models in symbol fields through the SIM_VALUE class. We don't carry the Spice legacy of case-insensitive suffixes, instead we conform to the SI standard (i.e. M is Mega, not milli, P is peta, p is pico). Parameter grid value validation is implemented by simply not allowing any characters that will make the value invalid (instead of highlighting the field in a red color). This will likely be changed at some point in the future.
2022-03-09 01:40:59 +00:00
wxString getSymbolPinString( int aSymbolPinNumber ) const;
Allow mapping sim model pins to arbitrary string symbol pin numbers This change removes the incorrect assumption that symbol pin numbers are integers and are the same as indexes in the vector storing the symbol pins. "~" is now used to denote a floating sim model pin.
2022-08-22 05:40:23 +00:00
wxString getModelPinString( int aModelPinIndex ) const;
int getModelPinIndex( const wxString& aModelPinString ) const;
Sim Model Editor: Serialize models in fields Implemented serialization and deserialization of models in symbol fields through the SIM_VALUE class. We don't carry the Spice legacy of case-insensitive suffixes, instead we conform to the SI standard (i.e. M is Mega, not milli, P is peta, p is pico). Parameter grid value validation is implemented by simply not allowing any characters that will make the value invalid (instead of highlighting the field in a red color). This will likely be changed at some point in the future.
2022-03-09 01:40:59 +00:00
Sim: Implement loading Spice library files Implement parsing and loading Spice libraries into KiCad. This is done without any involvement of Ngspice -- we create our own in-tree parser using PEGTL -- because Ngspice doesn't offer any intermediate output we could plug ourselves into. We don't parse everything -- just the library content, so this won't be that much effort. We implement some basic Spice code preview to give the user a hint what Spice code eir model will correspond to.
2022-04-01 04:30:50 +00:00
void onRadioButton( wxCommandEvent& aEvent ) override;
Sim: Make library path textbox editable Load the library from the path if enter is pressed or focus is lost if the library exists. If a library under the same path as previously is to be loaded this way, don't do anything. Fixes https://gitlab.com/kicad/code/kicad/issues/12970
2022-11-26 02:47:41 +00:00
void onLibraryPathTextEnter( wxCommandEvent& aEvent ) override;
void onLibraryPathTextKillFocus( wxFocusEvent& aEvent ) override;
Sim: Implement loading Spice library files Implement parsing and loading Spice libraries into KiCad. This is done without any involvement of Ngspice -- we create our own in-tree parser using PEGTL -- because Ngspice doesn't offer any intermediate output we could plug ourselves into. We don't parse everything -- just the library content, so this won't be that much effort. We implement some basic Spice code preview to give the user a hint what Spice code eir model will correspond to.
2022-04-01 04:30:50 +00:00
void onBrowseButtonClick( wxCommandEvent& aEvent ) override;
Simplify library model name from combobox to choice. Fixes https://gitlab.com/kicad/code/kicad/issues/13168
2022-12-15 12:12:36 +00:00
void onModelNameChoice( wxCommandEvent& aEvent ) override;
Add Ibis to spice model editor ADDED: IBIS models are now supported in Sim Model Editor
2022-09-27 20:47:00 +00:00
void onIbisPinCombobox( wxCommandEvent& event ) override;
void onIbisPinComboboxTextEnter( wxCommandEvent& event ) override;
void onIbisModelCombobox( wxCommandEvent& event ) override;
void onIbisModelComboboxTextEnter( wxCommandEvent& event ) override;
Sim Model Editor: Serialize models in fields Implemented serialization and deserialization of models in symbol fields through the SIM_VALUE class. We don't carry the Spice legacy of case-insensitive suffixes, instead we conform to the SI standard (i.e. M is Mega, not milli, P is peta, p is pico). Parameter grid value validation is implemented by simply not allowing any characters that will make the value invalid (instead of highlighting the field in a red color). This will likely be changed at some point in the future.
2022-03-09 01:40:59 +00:00
void onDeviceTypeChoice( wxCommandEvent& aEvent ) override;
void onTypeChoice( wxCommandEvent& aEvent ) override;
Fix event order bugs in Sim Model Editor dialog. onParamGridChanged was firing before CommitPendingChanges which meant the edited value didn't get saved if the editor was still open when OK was clicked.
2022-12-17 22:33:00 +00:00
void onPageChanging( wxNotebookEvent& event ) override;
Sim Model Editor: Serialize models in fields Implemented serialization and deserialization of models in symbol fields through the SIM_VALUE class. We don't carry the Spice legacy of case-insensitive suffixes, instead we conform to the SI standard (i.e. M is Mega, not milli, P is peta, p is pico). Parameter grid value validation is implemented by simply not allowing any characters that will make the value invalid (instead of highlighting the field in a red color). This will likely be changed at some point in the future.
2022-03-09 01:40:59 +00:00
void onPinAssignmentsGridCellChange( wxGridEvent& aEvent ) override;
void onPinAssignmentsGridSize( wxSizeEvent& aEvent ) override;
Sim: Ibis improvements and fixes Follow-up after the KIBIS and KIBIS GUI merge requests. - Move KIBIS from Pcbnew to Eeschema space, - Make KIBIS obtain the Ku/Kd coefficients via the `SPICE_SIMULATOR` class instead of calling the `ngspice` executable via `system()`, - Allow to toggle between differential and single-ended model in the GUI, - Various GUI fixes and improvements.
2022-10-25 09:45:40 +00:00
void onDifferentialCheckbox( wxCommandEvent& event ) override;
Better column width handling for sim params grid.
2022-12-08 14:40:01 +00:00
void onSizeParamGrid( wxSizeEvent& event ) override;
Sim: Implement loading Spice library files Implement parsing and loading Spice libraries into KiCad. This is done without any involvement of Ngspice -- we create our own in-tree parser using PEGTL -- because Ngspice doesn't offer any intermediate output we could plug ourselves into. We don't parse everything -- just the library content, so this won't be that much effort. We implement some basic Spice code preview to give the user a hint what Spice code eir model will correspond to.
2022-04-01 04:30:50 +00:00
Sim Model Editor improvements - Tab-switching, - Automatic expansion of categories on tab-switch, - Various minor simulation improvements, - Various new simulation-related bugfixes.
2022-06-12 03:39:13 +00:00
void onParamGridSetFocus( wxFocusEvent& aEvent );
void onParamGridSelectionChange( wxPropertyGridEvent& aEvent );
Sim Model Editor: Serialize models in fields Implemented serialization and deserialization of models in symbol fields through the SIM_VALUE class. We don't carry the Spice legacy of case-insensitive suffixes, instead we conform to the SI standard (i.e. M is Mega, not milli, P is peta, p is pico). Parameter grid value validation is implemented by simply not allowing any characters that will make the value invalid (instead of highlighting the field in a red color). This will likely be changed at some point in the future.
2022-03-09 01:40:59 +00:00
Better column width handling for sim params grid.
2022-12-08 14:40:01 +00:00
void adjustParamGridColumns( int aWidth, bool aForce );
Sim Model Editor: Use SIM_LIB_MGR class to manage library models
2022-11-19 00:45:28 +00:00
bool isIbisLoaded() { return dynamic_cast<const SIM_LIBRARY_KIBIS*>( library() ); }
Sim: Implement loading Spice library files Implement parsing and loading Spice libraries into KiCad. This is done without any involvement of Ngspice -- we create our own in-tree parser using PEGTL -- because Ngspice doesn't offer any intermediate output we could plug ourselves into. We don't parse everything -- just the library content, so this won't be that much effort. We implement some basic Spice code preview to give the user a hint what Spice code eir model will correspond to.
2022-04-01 04:30:50 +00:00
Move model pin editor to GRID_CELL_ICON_TEXT_POPUP. wxChoice is hopeless on Mac (it still doesn't highlight on rollover), and using a char for the "assigned" graphic isn't great.
2022-10-28 11:43:00 +00:00
private:
Remove ugly hack of passing SCH_SYMBOL as parent of LIB_FIELD array. Also adds simulation model inference to Symbol Editor's Simulation Model Editor, and adds write-back from both Simulation Model Editors to their parent Symbol Fields Editor dialogs. Fixes https://gitlab.com/kicad/code/kicad/issues/12505
2022-12-09 20:02:47 +00:00
T_symbol& m_symbol;
Fix crash when grid tries to access deleted field.
2022-12-11 22:59:27 +00:00
std::vector<T_field>& m_fields;
Spice model editor dialog
2016-08-11 12:41:40 +00:00
Remove ugly hack of passing SCH_SYMBOL as parent of LIB_FIELD array. Also adds simulation model inference to Symbol Editor's Simulation Model Editor, and adds write-back from both Simulation Model Editors to their parent Symbol Fields Editor dialogs. Fixes https://gitlab.com/kicad/code/kicad/issues/12505
2022-12-09 20:02:47 +00:00
SIM_LIB_MGR m_libraryModelsMgr;
SIM_LIB_MGR m_builtinModelsMgr;
const SIM_MODEL* m_prevModel;
Sim Model Editor: Use SIM_LIB_MGR class to manage library models
2022-11-19 00:45:28 +00:00
Formatting and Kicad naming conventions.
2022-12-06 14:59:49 +00:00
std::vector<LIB_PIN*> m_sortedPartPins; //< Pins of the current part.
std::map<SIM_MODEL::DEVICE_T, SIM_MODEL::TYPE> m_curModelTypeOfDeviceType;
SIM_MODEL::TYPE m_curModelType;
Dark theme support for SPICE model editor
2021-12-03 02:41:02 +00:00
Move model pin editor to GRID_CELL_ICON_TEXT_POPUP. wxChoice is hopeless on Mac (it still doesn't highlight on rollover), and using a char for the "assigned" graphic isn't great.
2022-10-28 11:43:00 +00:00
SCINTILLA_TRICKS* m_scintillaTricks;
Sim Model Editor improvements - Tab-switching, - Automatic expansion of categories on tab-switch, - Various minor simulation improvements, - Various new simulation-related bugfixes.
2022-06-12 03:39:13 +00:00
Move model pin editor to GRID_CELL_ICON_TEXT_POPUP. wxChoice is hopeless on Mac (it still doesn't highlight on rollover), and using a char for the "assigned" graphic isn't great.
2022-10-28 11:43:00 +00:00
wxPGProperty* m_firstCategory; // Used to add principal parameters to root.
wxPGProperty* m_prevParamGridSelection;
Support env variables in spice library paths. Also removes a bunch of std::string stuff from the file handling in the simulator. All our file handling, env variable expansion, project path, etc. stuff is wxString based, and jumping through std::string in between just makes it more complex and increases the potential bug surface. Also fixes a bug where you'd get two error messages when a spice model library wasn't found. Also fixes a bug where you'd get a spice model library not found error when the text field was empty. Also fixes a bug where we'd try to absolutize a path starting with an unresolved text or environment variable. If the path starts with a variable it's probably absolute, and tacking on the project path in the error message just obfuscates things. Fixes https://gitlab.com/kicad/code/kicad/issues/13082
2022-12-07 15:02:35 +00:00
Better column width handling for sim params grid.
2022-12-08 14:40:01 +00:00
int m_lastParamGridWidth;
Support env variables in spice library paths. Also removes a bunch of std::string stuff from the file handling in the simulator. All our file handling, env variable expansion, project path, etc. stuff is wxString based, and jumping through std::string in between just makes it more complex and increases the potential bug surface. Also fixes a bug where you'd get two error messages when a spice model library wasn't found. Also fixes a bug where you'd get a spice model library not found error when the text field was empty. Also fixes a bug where we'd try to absolutize a path starting with an unresolved text or environment variable. If the path starts with a variable it's probably absolute, and tacking on the project path in the error message just obfuscates things. Fixes https://gitlab.com/kicad/code/kicad/issues/13082
2022-12-07 15:02:35 +00:00
bool m_inKillFocus;
Spice model editor dialog
2016-08-11 12:41:40 +00:00
};
Sim: Bugfixes, mostly for MS Windows compilation errors Unfortunately, Windows headers define a lot of macros for common words, so we had to rename some enums to not collide. We also fix some of the many bugs related to the new simulation architecture and the Spice Model Editor dialog.
2022-06-21 02:22:52 +00:00
#endif /* DIALOG_SIM_MODEL_H */