cl_Capacitor.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_CAPACITOR_HPP
#define BELFEM_CL_CAPACITOR_HPP
 
#include "cl_TwoTerminals.hpp"
#include "Component_Enums.hpp"
#include "cl_BDF.hpp"
 
namespace belfem
{
    namespace electronics
    {
//-----------------------------------------------------------------------------
 
        class Capacitor : public TwoTerminals
        {
            real mValue ;

            real mRC ;

            real miCh = 0.0 ;

            ode::BDF * mBDF  = nullptr;

            ShiftRegister< real > mH ;

            ShiftRegister< real > mV ;

            real mDeltaTime ;

            uint mOrder = 1 ;
 
//------------------------------------------------------------------------------

            void
            update_companions() ;
 
//------------------------------------------------------------------------------
        public:
//------------------------------------------------------------------------------
 
            Capacitor(const real aValue, const uint aOrder, Cell < ElectricNode* > & aTerminals, string aLabel = "") ;
 
            ~Capacitor() override ;
 
//------------------------------------------------------------------------------
 
            ComponentType
            component_type() const override ;
 
//-----------------------------------------------------------------------------
 
            void
            compute_current() override ;
 
//------------------------------------------------------------------------------
 
            void
            shift( const real aTime, const real aDeltaTime ) override ;
 
//------------------------------------------------------------------------------
 
            void
            shift_back() override ;
 
//------------------------------------------------------------------------------
 
            void
            set_timestep( const real aDeltaTime ) override ;
 
//------------------------------------------------------------------------------
 
            void
            save_state( hid_t aGroup, const string & aPrefix ) override ;
 
//------------------------------------------------------------------------------
 
            void
            load_state( hid_t aGroup, const string & aPrefix ) override ;
 
//------------------------------------------------------------------------------
 
            real
            get_value() const override ;
 
//------------------------------------------------------------------------------
 
            real
            get_discretized_resistance() const override ;
 
//------------------------------------------------------------------------------
 
            real
            get_discretized_source() const override ;
 
//------------------------------------------------------------------------------
 
        };
 
        inline ComponentType
        Capacitor::component_type() const
        {
            return ComponentType::CAPACITOR ;
        }
 
//-----------------------------------------------------------------------------
    }
}
 
#endif //BELFEM_CL_CAPACITOR_HPP