kicad/eeschema/sim/ngspice_helpers.h

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2016 CERN
 * Copyright (C) 2017-2021 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Maciej Suminski <maciej.suminski@cern.ch>
 *
 * 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 3
 * 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:
 * https://www.gnu.org/licenses/gpl-3.0.html
 * or you may search the http://www.gnu.org website for the version 3 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */

#ifndef NETLIST_EXPORTER_PSPICE_SIM_H
#define NETLIST_EXPORTER_PSPICE_SIM_H

#include <netlist_exporters/netlist_exporter_pspice.h>
#include <vector>

#include "sim_types.h"
#include "spice_simulator.h"
#include "spice_value.h"


struct SPICE_DC_PARAMS
{
    wxString m_source;
    SPICE_VALUE m_vstart;
    SPICE_VALUE m_vend;
    SPICE_VALUE m_vincrement;
};

/// Special netlist exporter flavor that allows one to override simulation commands
class NGSPICE_CIRCUIT_MODEL : public NETLIST_EXPORTER_PSPICE, public SIMULATION_MODEL
{
public:
    NGSPICE_CIRCUIT_MODEL( SCHEMATIC_IFACE* aSchematic ) :
            NETLIST_EXPORTER_PSPICE( aSchematic ),
            m_options( 0 )
    {
    }
    virtual ~NGSPICE_CIRCUIT_MODEL() {}

    /**
     * Return name of Spice dataset for a specific plot.
     *
     * @param aName is name of the measured net or device
     * @param aType describes the type of expected plot
     * @param aParam is an optional parameter for devices, if absent it will return current (only
     *               for passive devices).
     * @return Empty string if query is invalid, otherwise a plot name that
     *         can be requested from the simulator.
     */
    wxString ComponentToVector( const wxString& aName, SIM_PLOT_TYPE aType,
            const wxString& aParam = wxEmptyString ) const;

    /**
     * Return name of Spice dataset for a specific plot.
     *
     * @param aVector is name of the vector produced by ngspice
     * @param [out] aSignal is output in form: V(R1), Ib(Q2), I(L8)
     * @return [SPT_VOLTAGE, SPT_CURRENT]. Otherwise SPT_UNKNOWN if vector is
     *         of different, unsupported type.
     */
    SIM_PLOT_TYPE VectorToSignal( const std::string& aVector, wxString& aSignal ) const;

    /**
     * Return a list of currents that can be probed in a Spice primitive.
     */
    static const std::vector<wxString>& GetCurrents( SPICE_PRIMITIVE aPrimitive );

    void SetOptions( int aOptions )
    {
        m_options = aOptions;
    }

    bool GetNetlist( OUTPUTFORMATTER* aFormatter )
    {
        return NGSPICE_CIRCUIT_MODEL::Format( aFormatter, m_options );
    }

    /**
     * Override the simulation command directive.
     */
    void SetSimCommand( const wxString& aCmd )
    {
        m_simCommand = aCmd;
    }

    /**
     * Return the simulation command directive.
     */
    const wxString& GetSimCommand() const
    {
        return m_simCommand;
    }

    /**
     * Clear the simulation command directive.
     */
    void ClearSimCommand()
    {
        m_simCommand.Clear();
    }

    /**
     * Return the command directive that is in use (either from the sheet or from m_simCommand
     * @return
     */
    wxString GetUsedSimCommand();

    /**
     * Return simulation type basing on the simulation command directives.
     *
     * Simulation directives set using SetSimCommand() have priority over the ones placed in
     * schematic sheets.
     */
    SIM_TYPE GetSimType();

    /**
     * Return simulation command directives placed in schematic sheets (if any).
     */
    wxString GetSheetSimCommand();

    /**
     * Parse a two-source .dc command directive into its symbols.
     *
     * @param aCmd is the input command string
     * @return true if the command was parsed successfully
     */
    bool ParseDCCommand( const wxString& aCmd, SPICE_DC_PARAMS* aSource1,
                         SPICE_DC_PARAMS* aSource2 );

    /**
     * Determine if a directive is a simulation command.
     */
    static bool IsSimCommand( const wxString& aCmd )
    {
        return CommandToSimType( aCmd ) != ST_UNKNOWN;
    }

    /**
     * Return simulation type basing on a simulation command directive.
     */
    static SIM_TYPE CommandToSimType( const wxString& aCmd );

protected:
    void writeDirectives( OUTPUTFORMATTER* aFormatter, unsigned aCtl ) const override;

private:

    ///< Custom simulation command (has priority over the schematic sheet simulation commands)
    wxString m_simCommand;
    int m_options;
};

#endif /* NETLIST_EXPORTER_PSPICE_SIM_H */