Base class for every circuit component. More...

#include <cl_Component.hpp>

Inheritance diagram for belfem::electronics::Component:

Collaboration diagram for belfem::electronics::Component:

Public Member Functions
	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)
	write this component's time-stepping state into the restart group, dataset names prefixed with aPrefix.
virtual void	load_state (hid_t aGroup, const string &aPrefix)
	restore the state written by save_state().
virtual bool	is_closed () const
virtual void	switch_state ()
virtual ElectricNode *	get_node_plus () const
virtual ElectricNode *	get_node_minus () const
Public Member Functions inherited from belfem::graph::Vertex
	Vertex ()=default
virtual	~Vertex ()
void	set_id (const id_t aID)
id_t	id () const
virtual void	set_index (const index_t aIndex)
virtual index_t	index () const
virtual void	set_owner (const proc_t aOwner)
virtual proc_t	owner () const
index_t	level () const
void	set_level (const index_t aLevel)
virtual void	flag (const uint8_t aIndex=0)
virtual void	unflag (const uint8_t aIndex=0)
virtual bool	is_flagged (const uint8_t aIndex=0) const
void	increment_vertex_counter ()
void	init_vertex_container ()
void	init_vertex_container (const uint aSize)
void	reset_vertex_container ()
void	insert_vertex (Vertex *aVertex)
uint	number_of_vertices () const
virtual Vertex *	vertex (const uint aIndex)
virtual auto	vertex (const uint aIndex) const -> decltype(this)
virtual void	init_element_container ()
virtual void	reset_element_container ()
void	sort_vertices ()
	sorts the vertices according to their index
void	reverse_vertices ()

Protected Attributes
const uint	mNumTerminals
	Number of terminals.
string	mLabel
	Label.
ElectricNode **	mTerminals = nullptr
	Nodes at each terminal ( non-owning ).
Protected Attributes inherited from belfem::graph::Vertex
uint32_t	mVertexCounter = 0
Vertex **	mVertices = nullptr

Detailed Description

Base class for every circuit component.

See also: Circuit Module Usage Guide

Constructor & Destructor Documentation

◆ Component()

belfem::electronics::Component::Component	(	const uint	aNumTerminals,
		Cell< ElectricNode * > &	aTerminals,
		string	aLabel = "" )

◆ ~Component()

belfem::electronics::Component::~Component ( )

override

Member Function Documentation

◆ component_type()

ComponentType belfem::electronics::Component::component_type ( ) const

virtual

Reimplemented in belfem::electronics::Capacitor, belfem::electronics::CurrentSource, belfem::electronics::Diode, belfem::electronics::FEMTwoTerminals, belfem::electronics::Inductor, belfem::electronics::Resistor, belfem::electronics::Superconductor, belfem::electronics::Switch, belfem::electronics::TwoTerminals, and belfem::electronics::VoltageSource.

◆ compute_current()

void belfem::electronics::Component::compute_current ( )

virtual

Reimplemented in belfem::electronics::Capacitor, belfem::electronics::Diode, belfem::electronics::FEMTwoTerminals, belfem::electronics::Inductor, belfem::electronics::Resistor, and belfem::electronics::Superconductor.

◆ dIdV()

real belfem::electronics::Component::dIdV ( ) const

virtual

Reimplemented in belfem::electronics::Diode, and belfem::electronics::Superconductor.

◆ get_current()

real belfem::electronics::Component::get_current ( ) const

virtual

Reimplemented in belfem::electronics::TwoTerminals.

◆ get_discretized_resistance()

real belfem::electronics::Component::get_discretized_resistance ( ) const

virtual

Reimplemented in belfem::electronics::Capacitor, and belfem::electronics::Inductor.

◆ get_discretized_source()

real belfem::electronics::Component::get_discretized_source ( ) const

virtual

Reimplemented in belfem::electronics::Capacitor, and belfem::electronics::Inductor.

◆ get_label()

string belfem::electronics::Component::get_label ( ) const

◆ get_node_minus()

ElectricNode * belfem::electronics::Component::get_node_minus ( ) const

virtual

Reimplemented in belfem::electronics::TwoTerminals.

◆ get_node_plus()

ElectricNode * belfem::electronics::Component::get_node_plus ( ) const

virtual

Reimplemented in belfem::electronics::TwoTerminals.

◆ get_value()

real belfem::electronics::Component::get_value ( ) const

virtual

Reimplemented in belfem::electronics::Capacitor, belfem::electronics::CurrentSource, belfem::electronics::Inductor, belfem::electronics::Resistor, and belfem::electronics::VoltageSource.

◆ is_closed()

bool belfem::electronics::Component::is_closed ( ) const

virtual

Reimplemented in belfem::electronics::Switch.

◆ load_state()

void belfem::electronics::Component::load_state	(	hid_t	aGroup,
		const string &	aPrefix )

virtual

restore the state written by save_state().

The loaded object is coherent for both legal continuations: the controller triad ( set_timestep - shift - stamp ) and a stamp without shift. Calling shift_back() before the first post-restore shift() is forbidden

Reimplemented in belfem::electronics::Capacitor, belfem::electronics::CurrentSource, belfem::electronics::FEMTwoTerminals, belfem::electronics::Inductor, belfem::electronics::Switch, and belfem::electronics::VoltageSource.

◆ node()

ElectricNode * belfem::electronics::Component::node ( index_t tIndex ) const

◆ number_of_terminals()

uint belfem::electronics::Component::number_of_terminals ( ) const

◆ save_state()

void belfem::electronics::Component::save_state	(	hid_t	aGroup,
		const string &	aPrefix )

virtual

write this component's time-stepping state into the restart group, dataset names prefixed with aPrefix.

Default: no state ( resistors, diodes and superconductors recompute from voltages )

Reimplemented in belfem::electronics::Capacitor, belfem::electronics::CurrentSource, belfem::electronics::FEMTwoTerminals, belfem::electronics::Inductor, belfem::electronics::Switch, and belfem::electronics::VoltageSource.

◆ set_current()

void belfem::electronics::Component::set_current ( const real aCurrent )

virtual

Reimplemented in belfem::electronics::TwoTerminals.

◆ set_timestep()

void belfem::electronics::Component::set_timestep ( const real aDeltaTime )

virtual

Reimplemented in belfem::electronics::Capacitor, and belfem::electronics::Inductor.

◆ shift()

void belfem::electronics::Component::shift	(	const real	aTime,
		const real	aDeltaTime )

virtual

Reimplemented in belfem::electronics::Capacitor, belfem::electronics::CurrentSource, belfem::electronics::FEMTwoTerminals, belfem::electronics::Inductor, belfem::electronics::Switch, and belfem::electronics::VoltageSource.

◆ shift_back()

void belfem::electronics::Component::shift_back ( )

virtual

Reimplemented in belfem::electronics::Capacitor, belfem::electronics::FEMTwoTerminals, belfem::electronics::Inductor, and belfem::electronics::Switch.

◆ switch_state()

void belfem::electronics::Component::switch_state ( )

virtual

Reimplemented in belfem::electronics::Switch.

Member Data Documentation

◆ mLabel

string belfem::electronics::Component::mLabel

protected

Label.

◆ mNumTerminals

const uint belfem::electronics::Component::mNumTerminals

protected

Number of terminals.

◆ mTerminals

ElectricNode** belfem::electronics::Component::mTerminals = nullptr

protected

Nodes at each terminal ( non-owning ).

The documentation for this class was generated from the following files:

src/circuit/cl_Component.hpp
src/circuit/cl_Component.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Component()

◆ ~Component()

Member Function Documentation

◆ component_type()

◆ compute_current()

◆ dIdV()

◆ get_current()

◆ get_discretized_resistance()

◆ get_discretized_source()

◆ get_label()

◆ get_node_minus()

◆ get_node_plus()

◆ get_value()

◆ is_closed()

◆ load_state()

◆ node()

◆ number_of_terminals()

◆ save_state()

◆ set_current()

◆ set_timestep()

◆ shift()

◆ shift_back()

◆ switch_state()

Member Data Documentation

◆ mLabel

◆ mNumTerminals

◆ mTerminals