OpenBEM
Open-source framework for electromagnetic simulation with the boundary element method.
Loading...
Searching...
No Matches
bem::IterativeTrapzLineQuadrature< dim > Class Template Reference

Class for iterative trapezoidal integration over a line segment. More...

#include <iterative_trapz.hpp>

+ Inheritance diagram for bem::IterativeTrapzLineQuadrature< dim >:

Detailed Description

template<uint8_t dim>
class bem::IterativeTrapzLineQuadrature< dim >

Class for iterative trapezoidal integration over a line segment.

Template Parameters
dim- Dimension of the line segment (1, 2, or 3).

Definition at line 44 of file iterative_trapz.hpp.

Member Function Documentation

◆ set_starting_num_segments()

template<uint8_t dim>
void bem::IterativeTrapzLineQuadrature< dim >::set_starting_num_segments ( const uint16_t  starting_num_segments)
inline

Sets the initial number of sub-segments into which the given line segment is divided.

Parameters
[in]starting_num_segments- Number of sub-segments with which to start the iterations.

Definition at line 55 of file iterative_trapz.hpp.

◆ starting_num_segments()

template<uint8_t dim>
uint16_t bem::IterativeTrapzLineQuadrature< dim >::starting_num_segments ( ) const
inline

Returns the initial number of sub-segments into which the given line segment is divided.

Returns
Number of sub-segments with which to start the iterations.

Definition at line 74 of file iterative_trapz.hpp.

◆ set_tol()

template<uint8_t dim>
void bem::IterativeTrapzLineQuadrature< dim >::set_tol ( const Float  tol)
inline

Sets the relative convergence tolerance defining when iterations should stop.

Parameters
[in]tol- Tolerance.

Definition at line 81 of file iterative_trapz.hpp.

◆ tol()

template<uint8_t dim>
Float bem::IterativeTrapzLineQuadrature< dim >::tol ( ) const
inline

Returns the relative convergence tolerance defining when iterations should stop.

Returns
Tolerance.

Definition at line 94 of file iterative_trapz.hpp.

◆ set_max_iters()

template<uint8_t dim>
void bem::IterativeTrapzLineQuadrature< dim >::set_max_iters ( const uint16_t  max_iters)
inline

Sets the maximum number of iterations allowed even if not converged.

Parameters
[in]max_iters- Maximum allowed iterations.

Definition at line 101 of file iterative_trapz.hpp.

◆ max_iters()

template<uint8_t dim>
uint16_t bem::IterativeTrapzLineQuadrature< dim >::max_iters ( ) const
inline

Returns the maximum number of iterations allowed even if not converged.

Returns
Maximum allowed iterations.

Definition at line 114 of file iterative_trapz.hpp.

◆ compute_points_weights()

template<uint8_t dim>
void bem::IterativeTrapzLineQuadrature< dim >::compute_points_weights ( ConstEigRef< EigColVecN< Float, dim > >  p1,
ConstEigRef< EigColVecN< Float, dim > >  p2,
std::function< EigRowVec< Complex >(ConstEigRef< EigMatNX< Float, dim > >)>  eval = {} 
)
overridevirtual

Computes and stores the points on which to evaluate the integrand, and the corresponding weights.

Parameters
[in]p1- First point of the line segment.
[in]p2- Second point of the line segment.
[in]eval- Function or class with operator() that evaluates the integrand.

Implements bem::LineQuadratureBase< dim >.

Definition at line 33 of file iterative_trapz.cpp.

◆ converged()

template<uint8_t dim>
bool bem::IterativeTrapzLineQuadrature< dim >::converged ( ) const
inline

Checks whether the iterations converged.

Returns
true if the iterations converged, false otherwise.

Definition at line 134 of file iterative_trapz.hpp.

◆ converged_num_segments()

template<uint8_t dim>
uint16_t bem::IterativeTrapzLineQuadrature< dim >::converged_num_segments ( ) const
inline

Returns the number of sub-segments for which the iterations converged.

Returns
Number of sub-segments for which the iterations converged; 0 if not converged.

Definition at line 147 of file iterative_trapz.hpp.

◆ set_order()

template<uint8_t dim>
virtual void bem::LineQuadratureBase< dim >::set_order ( const uint8_t  order)
inlinevirtualinherited

Sets the quadrature order.

Parameters
[in]order- Quadrature order.

Reimplemented in bem::GaussLineQuadrature< dim >, and bem::GaussLineQuadrature< 1 >.

Definition at line 69 of file base.hpp.

◆ order()

template<uint8_t dim>
uint8_t bem::LineQuadratureBase< dim >::order ( ) const
inlineinherited

Returns the quadrature order.

Returns
Quadrature order.

Definition at line 76 of file base.hpp.

◆ points()

template<uint8_t dim>
const EigMatNX< Float, dim > & bem::LineQuadratureBase< dim >::points ( ) const
inlineinherited

Returns the points on which to evaluate the integrand.

Returns
Read-only reference to the evaluation points.

Definition at line 83 of file base.hpp.

◆ weights()

template<uint8_t dim>
const EigRowVec< Float > & bem::LineQuadratureBase< dim >::weights ( ) const
inlineinherited

Returns the weights associated with the points on which the integrand is evaluated.

Returns
Read-only reference to the weights.

Definition at line 96 of file base.hpp.

Member Data Documentation

◆ points_

template<uint8_t dim>
EigMatNX<Float, dim> bem::LineQuadratureBase< dim >::points_
protectedinherited

Definition at line 107 of file base.hpp.

◆ weights_

template<uint8_t dim>
EigRowVec<Float> bem::LineQuadratureBase< dim >::weights_
protectedinherited

Definition at line 108 of file base.hpp.

◆ order_

template<uint8_t dim>
uint8_t bem::LineQuadratureBase< dim >::order_ = LINE_DEFAULT_ORDER
protectedinherited

Definition at line 110 of file base.hpp.

◆ points_weights_computed_

template<uint8_t dim>
bool bem::LineQuadratureBase< dim >::points_weights_computed_ = false
protectedinherited

Definition at line 111 of file base.hpp.


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