Class for iterative Gaussian quadrature over a line segment. More...

#include <iterative_gauss.hpp>

Inheritance diagram for bem::IterativeGaussLineQuadrature< dim >:

Detailed Description

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

Class for iterative Gaussian quadrature over a line segment.

Template Parameters

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

Important: upon construction, this class loads tabulated quadrature data from a json file, and stores the tabulated quadrature data for all possible orders up to LINE_MAX_ORDER. Therefore, it is strongly recommended that objects of this class should be reused within loops, rather than creating a new object at each iteration of a long loop.

Definition at line 49 of file iterative_gauss.hpp.

Member Function Documentation

◆ set_starting_order()

template<uint8_t dim>

void bem::IterativeGaussLineQuadrature< dim >::set_starting_order ( const uint8_t starting_order )

inline

Sets the quadrature order at which iterations should start.

Parameters

[in] starting_order - Starting quadrature order.

Definition at line 60 of file iterative_gauss.hpp.

◆ starting_order()

template<uint8_t dim>

uint8_t bem::IterativeGaussLineQuadrature< dim >::starting_order ( ) const

inline

Returns the quadrature order at which iterations start.

Returns: Starting quadrature order.

Definition at line 73 of file iterative_gauss.hpp.

◆ set_tol()

template<uint8_t dim>

void bem::IterativeGaussLineQuadrature< dim >::set_tol ( const Float tol )

inline

Sets the relative convergence tolerance defining when iterations should stop.

Parameters

[in] tol - Tolerance.

Definition at line 80 of file iterative_gauss.hpp.

◆ tol()

template<uint8_t dim>

Float bem::IterativeGaussLineQuadrature< dim >::tol ( ) const

inline

Returns the relative convergence tolerance defining when iterations should stop.

Returns: Tolerance.

Definition at line 93 of file iterative_gauss.hpp.

◆ set_max_iters()

template<uint8_t dim>

void bem::IterativeGaussLineQuadrature< 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 100 of file iterative_gauss.hpp.

◆ max_iters()

template<uint8_t dim>

uint16_t bem::IterativeGaussLineQuadrature< dim >::max_iters ( ) const

inline

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

Returns: Maximum allowed iterations.

Definition at line 113 of file iterative_gauss.hpp.

◆ compute_points_weights()

template<uint8_t dim>

void bem::IterativeGaussLineQuadrature< 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 32 of file iterative_gauss.cpp.

◆ converged()

template<uint8_t dim>

bool bem::IterativeGaussLineQuadrature< dim >::converged ( ) const

inline

Checks whether the iterations converged.

Returns: true if the iterations converged, false otherwise.

Definition at line 133 of file iterative_gauss.hpp.

◆ converged_order()

template<uint8_t dim>

uint8_t bem::IterativeGaussLineQuadrature< dim >::converged_order ( ) const

inline

Returns the quadrature order at which the iterations converged.

Returns: Quadrature order at which the iterations converged; 0 if not converged.

Definition at line 146 of file iterative_gauss.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:

source/quadrature/line/iterative_gauss.hpp
source/quadrature/line/iterative_gauss.cpp