cl_NgspiceCircuitFactory.hpp

Go to the documentation of this file.

/*
 * BELFEM -- The Berkeley Lab Finite Element Framework
 * Copyright (c) 2026, The Regents of the University of California,
 * through Lawrence Berkeley National Laboratory (subject to receipt of any required
 * approvals from the U.S. Dept. of Energy).  All rights reserved.
 *
 * Developers: Christian Messe, Gregory Giard
 *
 * See the top-level LICENSE file for the complete license and disclaimer.
 */
 
#ifndef BELFEM_CL_NGSPICECIRCUITFACTORY_HPP
#define BELFEM_CL_NGSPICECIRCUITFACTORY_HPP
 
#include <memory>
 
#include "typedefs.hpp"
#include "cl_Cell.hpp"
#include "cl_Map.hpp"
#include "cl_NetlistParser.hpp"
 
namespace belfem
{
    class SourceFunction;
 
    namespace electronics
    {
//-----------------------------------------------------------------------------
 
        class ElectricalCircuit;
 
//-----------------------------------------------------------------------------

        class NgspiceCircuitFactory
        {
            const string            mSource;      // for error messages

            std::unique_ptr< ElectricalCircuit > mCircuit;

            Map< string, index_t >  mNodeMap;
            uint                    mNumberOfNodes = 0;
 
//-----------------------------------------------------------------------------
        public:
//-----------------------------------------------------------------------------

            NgspiceCircuitFactory( const NetlistParser & aNetlist );

            NgspiceCircuitFactory( const string & aPath );
 
            ~NgspiceCircuitFactory();
 
//-----------------------------------------------------------------------------

            ElectricalCircuit *
            circuit();

            index_t
            node_index( const string & aName ) const;
 
            uint
            number_of_nodes() const
            {
                return mNumberOfNodes;
            }
 
//-----------------------------------------------------------------------------
        private:
//-----------------------------------------------------------------------------
 
            void
            build( const NetlistParser & aNetlist );
 
            void
            build_node_map( const NetlistParser & aNetlist );

            void
            collect_orders( const NetlistParser & aNetlist,
                            Map< string, uint > & aOrders ) const;
 
            void
            create_element( const NetlistElement & aElement,
                            const NetlistParser & aNetlist,
                            const Map< string, uint > & aOrders );
 
            void
            create_from_directive( const NetlistDirective & aDirective );

            real
            rcl_value( const NetlistElement & aElement,
                       const char * aKeyword ) const;

            SourceFunction *
            source_function( const NetlistElement & aElement ) const;
 
            index_t
            node_index_checked( const string & aName,
                                const string & aCard,
                                const index_t aLine ) const;

            static bool
            is_ground( const string & aName );
 
//-----------------------------------------------------------------------------
        };
 
//-----------------------------------------------------------------------------
    }
}
 
#endif //BELFEM_CL_NGSPICECIRCUITFACTORY_HPP