cl_Component.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_COMPONENT_HPP
#define BELFEM_CL_COMPONENT_HPP
 
#include "typedefs.hpp"
#include "cl_Cell.hpp"
#include "cl_Graph_Vertex.hpp"
#include "cl_ElectricNode.hpp"
#include "Component_Enums.hpp"
#include "hdf5_types.hpp"
 
namespace belfem
{
    namespace electronics
    {
//-----------------------------------------------------------------------------
        class Component : public graph::Vertex
        {
        protected:

            const uint mNumTerminals ;

            string mLabel ;

            ElectricNode ** mTerminals = nullptr ;
 
//------------------------------------------------------------------------------
        public:
//------------------------------------------------------------------------------
 
            Component( const uint aNumTerminals, Cell < ElectricNode* > & aTerminals, string aLabel = "") ;
 
            ~Component() override;
 
//------------------------------------------------------------------------------
 
            virtual ComponentType
            component_type() const ;
 
//-----------------------------------------------------------------------------
 
            uint
            number_of_terminals() const ;
 
//------------------------------------------------------------------------------
 
            ElectricNode *
            node( index_t tIndex ) const ;
 
//------------------------------------------------------------------------------
 
            virtual real
            get_value() const ;
 
//------------------------------------------------------------------------------
 
            virtual real
            dIdV() const ;
 
//------------------------------------------------------------------------------
 
            virtual real
            get_discretized_resistance() const ;
 
//------------------------------------------------------------------------------
 
            virtual real
            get_discretized_source() const ;
 
//------------------------------------------------------------------------------
 
            virtual real
            get_current() const ;
 
//------------------------------------------------------------------------------
 
            string
            get_label() const ;
 
//------------------------------------------------------------------------------
 
            virtual void
            set_current( const real aCurrent) ;
 
//------------------------------------------------------------------------------
 
            virtual void
            compute_current() ;
 
//------------------------------------------------------------------------------
 
            virtual void
            set_timestep( const real aDeltaTime ) ;
 
//------------------------------------------------------------------------------
 
            virtual void
            shift( const real aTime, const real aDeltaTime ) ;
 
//------------------------------------------------------------------------------
 
            virtual void
            shift_back() ;
 
//------------------------------------------------------------------------------

            virtual void
            save_state( hid_t aGroup, const string & aPrefix ) ;
 
//------------------------------------------------------------------------------

            virtual void
            load_state( hid_t aGroup, const string & aPrefix ) ;
 
//------------------------------------------------------------------------------
 
            virtual bool
            is_closed() const ;
 
//------------------------------------------------------------------------------
 
            virtual void
            switch_state() ;
 
//------------------------------------------------------------------------------
 
            virtual ElectricNode *
            get_node_plus() const ;
 
//------------------------------------------------------------------------------
 
            virtual ElectricNode *
            get_node_minus() const ;
 
//------------------------------------------------------------------------------
 
        };
    }
}
 
#endif //BELFEM_CL_COMPONENT_HPP