SIM/qucs_s
1
0
Fork 0
mirror of https://github.com/ra3xdh/qucs_s synced 2025-03-28 21:13:26 +00:00
Code Issues Packages Projects Releases Wiki Activity
qucs_s/qucs/extsimkernels/xyce.cpp
ThomasZecha b79d94ef2a Introduce optional netlisting to console 
-Introduced cli parameter --cdl for netlisting CDL
-Implemented netlisting to console for ngspice and xyce
-Increased readability and introduced smart-pointer semantics for some
 qucs-s main.cpp functions
-Increased readability and introduced c++ cast's for casting to
 Schematic* for affected QucsApp::slotSimulateWithSpice and QucsApp::slotSaveNetlist

Signed-off-by: ThomasZecha <zecha@ihp-microelectronics.com>
2025-01-19 14:19:21 +01:00

481 lines
17 KiB
C++
Raw Blame History

/***************************************************************************
xyce.cpp
----------------
begin : Fri Jan 16 2015
copyright : (C) 2015 by Vadim Kuznetsov
email : ra3xdh@gmail.com
***************************************************************************/
/***************************************************************************
* *
* 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. *
* *
***************************************************************************/
#include "xyce.h"
#include "components/equation.h"
#include "main.h"
#include "misc.h"
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include <QScopedPointer>
#include <iostream>
/*!
\file xyce.cpp
\brief Implementation of the Xyce class
*/
/*!
* \brief Xyce::Xyce Class constructor
* \param schematic Schematic that need to be simulated with Ngspice.
* \param parent Parent object
*/
Xyce::Xyce(Schematic* schematic, QObject *parent) :
AbstractSpiceKernel(schematic, parent),
a_Noisesim(false),
a_simulationsQueue(),
a_netlistQueue()
{
a_simulator_cmd = QucsSettings.XyceExecutable;
}
/*!
* \brief Xyce::determineUsedSimulations Determine simulation used
* in schematic and add them into a_simulationsQueue list
*/
void Xyce::determineUsedSimulations(QStringList *sim_lst)
{
for(Component *pc = a_schematic->a_DocComps.first(); pc != 0; pc = a_schematic->a_DocComps.next()) {
if(pc->isSimulation && pc->isActive == COMP_IS_ACTIVE) {
QString sim_typ = pc->Model;
if (sim_typ==".AC") a_simulationsQueue.append("ac");
if (sim_typ==".NOISE") a_simulationsQueue.append("noise");
if (sim_typ==".TR") a_simulationsQueue.append("tran");
if (sim_typ==".HB") a_simulationsQueue.append("hb");
if (sim_typ==".SP") a_simulationsQueue.append("sp");
if (sim_typ==".SENS_XYCE") a_simulationsQueue.append("sens");
if (sim_typ==".SENS_TR_XYCE") a_simulationsQueue.append("sens_tr");
if (sim_typ==".XYCESCR") a_simulationsQueue.append(pc->Name); // May be >= XYCE scripts
if ((sim_typ==".SW")&&
(pc->Props.at(0)->Value.startsWith("DC"))) a_simulationsQueue.append("dc");
}
}
if (sim_lst != NULL) {
*sim_lst = a_simulationsQueue;
}
}
/*!
* \brief Xyce::createNetlist
* \param[out] stream QTextStream that associated with spice netlist file
* \param[in] simulations The list of simulations that need to included in netlist.
* \param[out] vars The list of output variables and node names.
* \param[out] outputs The list of spice output raw text files.
*/
void Xyce::createNetlist(
QTextStream& stream,
QStringList& simulations,
QStringList& vars,
QStringList& outputs)
{
QString s;
bool hasParSweep = false;
stream << "* Qucs " << PACKAGE_VERSION << " " << a_schematic->getDocName() << "\n";
stream<<collectSpiceLibs(a_schematic); // collect libraries on the top of netlist
if(!prepareSpiceNetlist(stream)) return; // Unable to perform spice simulation
startNetlist(stream, spicecompat::SPICEXyce);
// set variable names for named nodes and wires
vars.clear();
for(Node *pn = a_schematic->a_DocNodes.first(); pn != 0; pn = a_schematic->a_DocNodes.next()) {
if(pn->Label != 0) {
if (!vars.contains(pn->Label->Name)) {
vars.append(pn->Label->Name);
}
}
}
for(Wire *pw = a_schematic->a_DocWires.first(); pw != 0; pw = a_schematic->a_DocWires.next()) {
if(pw->Label != 0) {
if (!vars.contains(pw->Label->Name)) {
vars.append(pw->Label->Name);
}
}
}
for(Component *pc = a_schematic->a_DocComps.first(); pc != 0; pc = a_schematic->a_DocComps.next()) {
if (pc->isProbe) {
QString var_pr = pc->getProbeVariable(true);
if (!vars.contains(var_pr)) {
vars.append(var_pr);
}
}
/*if (pc->isEquation) {
Equation *eq = (Equation *)pc;
QStringList vars_eq;
eq->getDepVars(vars_eq);
vars.append(vars_eq);
}*/
}
if (a_DC_OP_only) {
// Add all remaining nodes, because XYCE has no equivalent for PRINT ALL
for(Node* pn = a_schematic->a_Nodes->first(); pn != 0; pn = a_schematic->a_Nodes->next()) {
if ((!vars.contains(pn->Name))&&(pn->Name!="gnd")) {
vars.append(pn->Name);
}
}
// Add DC sources
for(Component *pc = a_schematic->a_DocComps.first(); pc != 0; pc = a_schematic->a_DocComps.next()) {
if ((pc->Model == "S4Q_V")||(pc->Model == "Vdc")) {
vars.append("I("+pc->Name+")");
}
}
}
vars.sort();
//execute simulations
//QFileInfo inf(a_schematic->getDocName());
//QString basenam = inf.baseName();
QString basenam = "spice4qucs";
QString nods;
nods.clear();
for (auto& nod :vars) {
if (!nod.startsWith("I(")) {
nods += QStringLiteral("v(%1) ").arg(nod);
} else {
nods += nod + " ";
}
}
if (a_DC_OP_only) {
stream<<".OP\n";
stream<<QStringLiteral(".PRINT dc format=noindex file=spice4qucs.cir.dc_op_xyce %1\n").arg(nods);
outputs.append("spice4qucs.cir.dc_op_xyce");
return;
}
QString sim = simulations.first();
QStringList spar_vars;
for(Component *pc = a_schematic->a_DocComps.first(); pc != 0; pc = a_schematic->a_DocComps.next()) { // Xyce can run
if(pc->isSimulation && pc->isActive == COMP_IS_ACTIVE) { // only one simulations per time.
QString sim_typ = pc->Model; // Multiple simulations are forbidden.
QString s = pc->getSpiceNetlist(spicecompat::SPICEXyce);
if ((sim_typ==".AC")&&(sim=="ac")) stream<<s;
if ((sim_typ==".NOISE")&&(sim=="noise")) stream<<s;
if ((sim_typ==".SENS_XYCE")&&(sim=="sens")) stream<<s;
if ((sim_typ==".SENS_TR_XYCE")&&(sim=="sens_tr")) stream<<s;
if ((sim_typ==".SP")&&(sim=="sp")) {
spar_vars = pc->getExtraVariables();
stream<<s;
}
if (sim==pc->Name) stream<<s; // Xyce scripts
if ((sim_typ==".TR")&&(sim=="tran")){
stream<<s;
Q3PtrList<Component> comps(a_schematic->a_DocComps); // find Fourier tran
for(Component *pc1 = comps.first(); pc1 != 0; pc1 = comps.next()) {
if (pc1->Model==".FOURIER") {
if (pc1->Props.at(0)->Value==pc->Name) {
QString s1 = pc1->getSpiceNetlist(spicecompat::SPICEXyce);
outputs.append("spice4qucs.tran.cir.four0");
stream<<s1;
}
}
}
}
if ((sim_typ==".HB")&&(sim=="hb")) stream<<s;
if (sim_typ==".SW") {
QString SwpSim = pc->Props.at(0)->Value;
if (SwpSim.startsWith("DC")&&(sim=="dc")) stream<<s;
else if (SwpSim.startsWith("AC")&&(sim=="ac")) {
stream<<s;
hasParSweep = true;
} else if (SwpSim.startsWith("SP")&&(sim=="sp")) {
stream<<s;
hasParSweep = true;
} else if (SwpSim.startsWith("TR")&&(sim=="tran")) {
stream<<s;
hasParSweep = true;
} else if (SwpSim.startsWith("HB")&&(sim=="hb")) {
stream<<s;
hasParSweep = true;
} else if (SwpSim.startsWith("SENS")&&(sim=="sens")) {
stream<<s;
hasParSweep = true;
} else if (SwpSim.startsWith("TSENS")&&(sim=="sens_tr")) {
stream<<s;
hasParSweep = true;
} else if (SwpSim.startsWith("SW")&&(sim=="dc")) {
for(Component *pc1 = a_schematic->a_DocComps.first(); pc1 != 0; pc1 = a_schematic->a_DocComps.next()) {
if ((pc1->Name==SwpSim)&&(pc1->Props.at(0)->Value.startsWith("DC"))) {
stream<<s;
hasParSweep = true;
}
}
}
}
if ((sim_typ==".DC")) stream<<s;
}
}
if (sim.startsWith("XYCESCR")) {
for(Component *pc = a_schematic->a_DocComps.first(); pc != 0; pc = a_schematic->a_DocComps.next()) {
if (pc->isSimulation)
if (sim == pc->Name)
outputs.append(pc->Props.at(2)->Value.split(';'));
}
stream<<".END\n";
return;
}
QString filename;
if (hasParSweep) filename = QStringLiteral("%1.%2._swp.plot").arg(basenam).arg(sim);
else filename = QStringLiteral("%1.%2.plot").arg(basenam).arg(sim);
filename.remove(QRegularExpression("\\s")); // XYCE don't support spaces and quotes
QString write_str;
if (sim=="hb") {
// write_str = QStringLiteral(".PRINT %1 file=%2 %3\n").arg(sim).arg(filename).arg(nods);
write_str = QStringLiteral(".PRINT %1 %2\n").arg(sim).arg(nods);
outputs.append("spice4qucs.hb.cir.HB.FD.prn");
} else if (sim=="noise") {
filename += "_std";
write_str = QStringLiteral(".PRINT noise file=%1 inoise onoise\n").arg(filename);
outputs.append(filename);
} else if (sim=="sens") {
write_str.clear();
outputs.append("spice4qucs.sens.cir.SENS.prn");
} else if (sim=="sens_tr") {
write_str.clear();
outputs.append("spice4qucs.sens_tr.cir.SENS.prn");
outputs.append("spice4qucs.sens_tr.cir.TRADJ.prn");
} else if (sim=="sp") {
write_str = ".PRINT ac format=std file=spice4qucs_sparam.prn ";
if (hasParSweep) {
for (const auto &v: spar_vars) { // Bug in Xyce; cannot print Z-par if
// .STEP is activated; otherwise simulation error
if ( !v.startsWith("z(")) write_str += QStringLiteral("%1 ").arg(v);
}
} else {
write_str += spar_vars.join(" ");
}
write_str += "\n";
outputs.append("spice4qucs_sparam.prn");
} else {
write_str = QStringLiteral(".PRINT %1 format=raw file=%2 %3\n").arg(sim).arg(filename).arg(nods);
outputs.append(filename);
}
stream<<write_str;
stream<<".END\n";
}
/*!
* \brief Xyce::slotSimulate Execute Xyce simulator and perform all
* simulations from the simulationQueue list
*/
void Xyce::slotSimulate()
{
QStringList incompat;
bool checker_error = false;
if (!checkSchematic(incompat)) {
QString s = incompat.join("; ");
a_output.append("There were SPICE-incompatible components. Simulator cannot proceed.");
a_output.append("Incompatible components are: " + s + "\n");
checker_error = true;
}
if (!checkGround()) {
a_output.append("No Ground found. Please add at least one ground!\n");
checker_error = true;
}
if (!checkDCSimulation()) {
a_output.append("Only DC simulation found in the schematic. It has no effect!"
" Add TRAN, AC, or Sweep simulation to proceed.\n");
checker_error = true;
}
if (checker_error) {
if (a_console != nullptr)
a_console->insertPlainText(a_output);
//emit finished();
emit errors(QProcess::FailedToStart);
return;
}
a_netlistQueue.clear();
a_output_files.clear();
if (a_DC_OP_only) {
a_simulationsQueue.append("dc");
} else determineUsedSimulations();
QFile::remove(a_workdir+"spice4qucs.sens_tr.cir.SENS.prn");
QFile::remove(a_workdir+"spice4qucs.sens_tr.cir.TRADJ.prn");
for (const QString& sim : a_simulationsQueue) {
QStringList sim_lst;
sim_lst.clear();
sim_lst.append(sim);
QString tmp_path = QDir::toNativeSeparators(a_workdir+"/spice4qucs."+sim+".cir");
a_netlistQueue.append(tmp_path);
QFile spice_file(tmp_path);
if (spice_file.open(QFile::WriteOnly)) {
QTextStream stream(&spice_file);
createNetlist(stream,sim_lst,a_vars,a_output_files);
spice_file.close();
}
}
a_output.clear();
emit started();
nextSimulation();
}
/*!
* \brief Xyce::SaveNetlist Save netlist into specified file without
* execution of simulator.
* \param[in] filename The name of file in which netlist is saved
* \param[in] netlist2Console Whether netlist to console instead to file
*/
void Xyce::SaveNetlist(QString filename, bool netlist2Console)
{
determineUsedSimulations();
QScopedPointer<QString> netlistString;
QScopedPointer<QTextStream> netlistStream;
QScopedPointer<QFile> netlistFile;
if (netlist2Console)
{
netlistString.reset(new QString);
netlistStream.reset(new QTextStream(netlistString.get()));
}
else
{
netlistFile.reset(new QFile(filename));
if (netlistFile->open(QFile::WriteOnly))
{
netlistStream.reset(new QTextStream(netlistFile.get()));
}
}
createNetlist(*netlistStream, a_simulationsQueue, a_vars, a_output_files);
if (netlist2Console)
{
std::cout << netlistString->toUtf8().constData() << std::endl;
}
}
/*!
* \brief Xyce::slotFinished Simulator finished handler. End simulation or
* execute the next simulation from queue.
*/
void Xyce::slotFinished()
{
a_output += a_simProcess->readAllStandardOutput();;
if (a_Noisesim) {
QFile logfile(a_workdir + QDir::separator() + "spice4qucs.noise_log");
if (logfile.open(QIODevice::WriteOnly)) {
QTextStream ts(&logfile);
ts<<a_output;
logfile.close();
}
a_Noisesim = false;
a_output_files.append("spice4qucs.noise_log");
}
if (a_netlistQueue.isEmpty()) {
emit finished();
emit progress(100);
return;
} else {
nextSimulation();
}
}
bool Xyce::waitEndOfSimulation()
{
bool ok = false;
while (!a_netlistQueue.isEmpty()) {
ok = a_simProcess->waitForFinished(10000);
}
ok = a_simProcess->waitForFinished(10000);
return ok;
}
/*!
* \brief Xyce::slotProcessOutput Process Xyce output and report progress.
*/
void Xyce::slotProcessOutput()
{
//***** Percent complete: 85.4987 %
QString s = a_simProcess->readAllStandardOutput();
if (s.contains("Percent complete:")) {
int percent = round(s.section(' ',3,3,QString::SectionSkipEmpty).toFloat());
emit progress(percent);
}
a_output += s;
if (a_console != nullptr) {
a_console->insertPlainText(s);
a_console->moveCursor(QTextCursor::End);
}
}
/*!
* \brief Xyce::nextSimulation Execute the next simulation from queue.
*/
void Xyce::nextSimulation()
{
if (!a_netlistQueue.isEmpty()) {
QString file = a_netlistQueue.takeFirst();
if (file.endsWith(".noise.cir")) a_Noisesim = true;
a_simProcess->setWorkingDirectory(a_workdir);
QString cmd = QStringLiteral("%1 %2 \"%3\"").arg(a_simulator_cmd,a_simulator_parameters,file);
QStringList cmd_args = misc::parseCmdArgs(cmd);
QString xyce_cmd = cmd_args.at(0);
cmd_args.removeAt(0);
a_simProcess->start(xyce_cmd,cmd_args);
} else {
a_output += "No simulation found. Please add at least one simulation!\n"
"Navigate to the \"simulations\" group in the components panel (left)"
" and drag simulation to the schematic sheet. Then define its parameters.\n"
"Exiting...\n";
emit progress(100);
emit finished(); // nothing to simulate
}
}
void Xyce::setParallel(bool par)
{
if (par) {
QString xyce_par = QucsSettings.XyceParExecutable;
xyce_par.replace("%p",QString::number(QucsSettings.NProcs));
a_simulator_cmd = xyce_par;
a_simulator_parameters = a_simulator_parameters + QStringLiteral(" -a ");
} else {
a_simulator_cmd = "\"" + QucsSettings.XyceExecutable + "\"";
a_simulator_parameters = a_simulator_parameters + " -a ";
}
}
Reference in New Issue View Git Blame Copy Permalink