Base class for generating excitation coefficients and coupling matrices for lumped ports. More...

#include <base.hpp>

Inheritance diagram for bem::rwg::LumpedElementBase< MatrixType >:

Detailed Description

template<typename MatrixType = EigenDenseMatrix<Complex>>
class bem::rwg::LumpedElementBase< MatrixType >

Base class for generating excitation coefficients and coupling matrices for lumped ports.

Template Parameters

MatrixType - Matrix type, must derive from MatrixBase<Complex>.

Definition at line 50 of file base.hpp.

Constructor & Destructor Documentation

◆ LumpedElementBase() [1/2]

template<typename MatrixType = EigenDenseMatrix<Complex>>

bem::rwg::LumpedElementBase< MatrixType >::LumpedElementBase	(	const Structure< TriangleMesh< 3 > > &	structure,
		const std::vector< MeshView< TriangleMesh< 3 > > > &	terminals,
		const std::vector< std::vector< Index > > &	terminal_components,
		const std::vector< std::array< Index, 2 > > &	ports,
		const std::vector< Complex > &	impedances
	)

inline

Constructs a LumpedElementBase object.

Parameters

[in]	structure	- Structure for which the coupling matrices are to be assembled.
[in]	terminals	- Mesh views defining all terminals on `mesh`.
[in]	terminal_components	- Lists of components associated with each `terminal`.
[in]	ports	- List of index pairs into `terminals` that define each lumped element port.
[in]	impedances	- Impedance of each lumped element.

Definition at line 62 of file base.hpp.

◆ LumpedElementBase() [2/2]

template<typename MatrixType = EigenDenseMatrix<Complex>>

bem::rwg::LumpedElementBase< MatrixType >::LumpedElementBase	(	const Structure< TriangleMesh< 3 > > &	structure,
		const std::vector< EigMatNX< Float, 3 > > &	terminal_polygons,
		const std::vector< std::array< Index, 2 > > &	ports,
		const std::vector< Complex > &	impedances,
		const bool	single_element = `false`
	)

inline

Constructs a LumpedElementBase object.

Parameters

[in]	structure	- Structure for which the coupling matrices are to be assembled.
[in]	terminal_polygons	- Vertices defining terminal polygons on the `mesh`.
[in]	ports	- List of index pairs into `terminals` that define each port.
[in]	impedances	- Impedance of each lumped element.
[in]	single_element	- If true, only the mesh element closest to the terminal polygon centroid is kept (optional).

Definition at line 88 of file base.hpp.

Member Function Documentation

◆ num_ports()

template<typename MatrixType = EigenDenseMatrix<Complex>>

Index bem::rwg::LumpedElementBase< MatrixType >::num_ports ( ) const

inline

Returns the number of excitations (right-hand sides), which equals the number of ports.

Returns: Number of excitations (right-hand sides).

Definition at line 110 of file base.hpp.

◆ num_port_elems() [1/2]

template<typename MatrixType = EigenDenseMatrix<Complex>>

Index bem::rwg::LumpedElementBase< MatrixType >::num_port_elems ( ) const

inline

Returns the number of mesh elements associated with ports.

Returns: Number of port mesh elements.

Definition at line 118 of file base.hpp.

◆ num_port_elems() [2/2]

template<typename MatrixType = EigenDenseMatrix<Complex>>

Index bem::rwg::LumpedElementBase< MatrixType >::num_port_elems ( Index idx ) const

inline

Returns the number of mesh elements associated with a given port.

Returns: Number of port mesh elements.

Definition at line 132 of file base.hpp.

◆ port_mesh_view() [1/2]

template<typename MatrixType = EigenDenseMatrix<Complex>>

MeshView< TriangleMesh< 3 > > bem::rwg::LumpedElementBase< MatrixType >::port_mesh_view ( ) const

inline

Returns a mesh view consisting of all elements associated with the ports.

Returns: Port mesh view.

Definition at line 145 of file base.hpp.

◆ port_mesh_view() [2/2]

template<typename MatrixType = EigenDenseMatrix<Complex>>

MeshView< TriangleMesh< 3 > > bem::rwg::LumpedElementBase< MatrixType >::port_mesh_view ( Index idx ) const

inline

Returns a mesh view consisting of all elements associated with a given port.

Returns: Port mesh view.

Definition at line 165 of file base.hpp.

◆ coupling_matrix()

template<typename MatrixType = EigenDenseMatrix<Complex>>

virtual MatrixType bem::rwg::LumpedElementBase< MatrixType >::coupling_matrix ( const Float f ) const

pure virtual

Returns the matrix the couples the port current to the integral equation.

Parameters

[in] f - Frequency in Hz.

Returns: Coupling matrix.

Implemented in bem::rwg::AefieLumpedElement< MatrixType >, bem::rwg::TefieLumpedElement< MatrixType >, and bem::rwg::NefieLumpedElement< MatrixType >.

◆ voltage_matrix()

template<typename MatrixType = EigenDenseMatrix<Complex>>

virtual MatrixType bem::rwg::LumpedElementBase< MatrixType >::voltage_matrix ( const Float f ) const

pure virtual

Returns the matrix associated with the potential differences between terminals.

Parameters

[in] f - Frequency in Hz.

Returns: Voltage matrix.

Implemented in bem::rwg::AefieLumpedElement< MatrixType >, bem::rwg::TefieLumpedElement< MatrixType >, and bem::rwg::NefieLumpedElement< MatrixType >.

◆ current_matrix()

template<typename MatrixType = EigenDenseMatrix<Complex>>

virtual MatrixType bem::rwg::LumpedElementBase< MatrixType >::current_matrix ( const Float f ) const

pure virtual

Returns the matrix associated with terminal currents.

Parameters

[in] f - Frequency in Hz.

Returns: Current matrix.

Implemented in bem::rwg::AefieLumpedElement< MatrixType >, bem::rwg::TefieLumpedElement< MatrixType >, and bem::rwg::NefieLumpedElement< MatrixType >.

◆ exc_matrix()

template<typename MatrixType = EigenDenseMatrix<Complex>>

virtual MatrixType bem::rwg::LumpedElementBase< MatrixType >::exc_matrix ( const Float f ) const

inlinevirtual

Returns the right-hand side excitation matrix to set a voltage source at each lumped element.

Parameters

[in] f - Frequency in Hz.

Returns: Excitation matrix.

Definition at line 207 of file base.hpp.

◆ current_mapping_matrix()

template<typename MatrixType = EigenDenseMatrix<Complex>>

virtual MatrixType bem::rwg::LumpedElementBase< MatrixType >::current_mapping_matrix ( ) const

inlinevirtual

Returns the matrix that maps the total port currents to the volume current densities on terminal triangles.

Returns: Mapping matrix.

Definition at line 219 of file base.hpp.

◆ voltage_mapping_matrix()

template<typename MatrixType = EigenDenseMatrix<Complex>>

virtual MatrixType bem::rwg::LumpedElementBase< MatrixType >::voltage_mapping_matrix ( ) const

inlinevirtual

Returns the matrix that maps the scalar potential on terminal triangles to the average voltage on the port.

Returns: Mapping matrix.

Definition at line 251 of file base.hpp.

◆ terminal_mapping_matrix()

template<typename MatrixType = EigenDenseMatrix<Complex>>

virtual MatrixType bem::rwg::LumpedElementBase< MatrixType >::terminal_mapping_matrix ( ) const

inlinevirtual

Returns the matrix that maps terminal triangles to their parent mesh triangles.

Returns: Mapping matrix.

Definition at line 281 of file base.hpp.

◆ terminal_area()

template<typename MatrixType = EigenDenseMatrix<Complex>>

Float bem::rwg::LumpedElementBase< MatrixType >::terminal_area ( const MeshView< TriangleMesh< 3 > > & terminal ) const

inline

Returns the total area spanned by the mesh triangles associated with a given terminal.

Parameters

[in] terminal - Terminal mesh view.

Returns: Terminal area.

Definition at line 300 of file base.hpp.

◆ terminals()

template<typename MatrixType = EigenDenseMatrix<Complex>>

const std::vector< MeshView< TriangleMesh< 3 > > > & bem::rwg::LumpedElementBase< MatrixType >::terminals ( ) const

inline

Returns a read-only reference to the terminal mesh views.

Definition at line 312 of file base.hpp.

◆ ports()

template<typename MatrixType = EigenDenseMatrix<Complex>>

const std::vector< std::array< Index, 2 > > & bem::rwg::LumpedElementBase< MatrixType >::ports ( ) const

inline

Returns a read-only reference to the port map.

Definition at line 318 of file base.hpp.

◆ impedances()

template<typename MatrixType = EigenDenseMatrix<Complex>>

const std::vector< Complex > & bem::rwg::LumpedElementBase< MatrixType >::impedances ( ) const

inline

Returns a read-only reference to the lumped impedances.

Definition at line 324 of file base.hpp.

◆ terminal_components()

template<typename MatrixType = EigenDenseMatrix<Complex>>

const std::vector< std::vector< Index > > & bem::rwg::LumpedElementBase< MatrixType >::terminal_components ( ) const

inline

Returns a read-only reference to the components associated with each terminal.

Definition at line 330 of file base.hpp.

◆ check_impedances()

template<typename MatrixType = EigenDenseMatrix<Complex>>

void bem::rwg::LumpedElementBase< MatrixType >::check_impedances ( )

inlineprotected

Ensures correct number of impedances are set.

Definition at line 338 of file base.hpp.

◆ set_terminals_from_polygons()

template<typename MatrixType = EigenDenseMatrix<Complex>>

void bem::rwg::LumpedElementBase< MatrixType >::set_terminals_from_polygons	(	const std::vector< EigMatNX< Float, 3 > > &	terminal_polygons,
		const bool	single_element = `false`
	)

inlineprotected

Populates terminals_ by finding mesh elements inside each terminal polygon.

Parameters

[in]	terminal_polygons	- Terminal polygons.
[in]	single_element	- If true, only the mesh element closest to the terminal polygon centroid is kept (optional).

A triangle is considered part of a terminal if it is coplanar with the terminal polygon, and any of its vertices lie on or within the terminal boundary.

Definition at line 359 of file base.hpp.

Member Data Documentation

◆ structure_

template<typename MatrixType = EigenDenseMatrix<Complex>>

const Structure<TriangleMesh<3> >& bem::rwg::LumpedElementBase< MatrixType >::structure_

protected

Definition at line 426 of file base.hpp.

◆ terminal_polygons_

template<typename MatrixType = EigenDenseMatrix<Complex>>

const std::vector<EigMatNX<Float, 3> > bem::rwg::LumpedElementBase< MatrixType >::terminal_polygons_

protected

Definition at line 427 of file base.hpp.

◆ ports_

template<typename MatrixType = EigenDenseMatrix<Complex>>

const std::vector<std::array<Index, 2> > bem::rwg::LumpedElementBase< MatrixType >::ports_

protected

Definition at line 428 of file base.hpp.

◆ terminals_

template<typename MatrixType = EigenDenseMatrix<Complex>>

std::vector<MeshView<TriangleMesh<3> > > bem::rwg::LumpedElementBase< MatrixType >::terminals_

protected

Definition at line 429 of file base.hpp.

◆ terminal_components_

template<typename MatrixType = EigenDenseMatrix<Complex>>

std::vector<std::vector<Index> > bem::rwg::LumpedElementBase< MatrixType >::terminal_components_

protected

Definition at line 430 of file base.hpp.

◆ impedances_

template<typename MatrixType = EigenDenseMatrix<Complex>>

std::vector<Complex> bem::rwg::LumpedElementBase< MatrixType >::impedances_

protected

Definition at line 431 of file base.hpp.

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

source/rwg/lumped_elements/base.hpp