NiHu::fmm::chebyshev_cluster< Dim, Scalar, FieldDim > Class Template Reference

Cluster class of the Black Box FMM. More...

#include <chebyshev_cluster.hpp>

Public Types
typedef cluster_base< chebyshev_cluster< Dim, Scalar, FieldDim > >	base_t
	the CRTP base class
typedef base_t::multipole_t	multipole_t
	the multipole type
typedef base_t::local_t	local_t
	the local type
typedef Eigen::Matrix< double, dimension, Eigen::Dynamic >	cheb_nodes_t
	type to store Chebyshev nodes

Public Member Functions
void	set_chebyshev_order (size_t order)
	set the Chebyshev order More...
size_t	get_data_size () const
	return the number of elements in the multipole coefficients More...
multipole_t	zero_multipole () const
	return zero multipole contribution More...
local_t	zero_local () const
	return zero local contribution More...
const cheb_nodes_t &	get_chebyshev_nodes () const
	return the Chebyshev nodes More...
size_t	get_chebyshev_order () const
	return the Chebyshev order More...

Static Public Attributes
static const size_t	dimension = base_t::dimension
	the space's dimension
static const size_t	field_dimension = FieldDim
	the field dimension

Detailed Description

template<size_t Dim, class Scalar, size_t FieldDim = 1>
class NiHu::fmm::chebyshev_cluster< Dim, Scalar, FieldDim >

Cluster class of the Black Box FMM.

Template Parameters

Dim	Dimension of the system (location)
Scalar	Kernel value's scalar type
FieldDim	Dimension of the field variable

Definition at line 28 of file chebyshev_cluster.hpp.

Member Function Documentation

get_chebyshev_nodes()

template<size_t Dim, class Scalar , size_t FieldDim = 1>

const cheb_nodes_t& NiHu::fmm::chebyshev_cluster< Dim, Scalar, FieldDim >::get_chebyshev_nodes ( ) const

inline

return the Chebyshev nodes

Returns

Chebyshev nodes

Definition at line 97 of file chebyshev_cluster.hpp.

get_chebyshev_order()

template<size_t Dim, class Scalar , size_t FieldDim = 1>

size_t NiHu::fmm::chebyshev_cluster< Dim, Scalar, FieldDim >::get_chebyshev_order ( ) const

inline

return the Chebyshev order

Returns

Chebyshev order

Definition at line 104 of file chebyshev_cluster.hpp.

get_data_size()

template<size_t Dim, class Scalar , size_t FieldDim = 1>

size_t NiHu::fmm::chebyshev_cluster< Dim, Scalar, FieldDim >::get_data_size ( ) const

inline

return the number of elements in the multipole coefficients

Returns

number of multipole coefficients

Definition at line 76 of file chebyshev_cluster.hpp.

set_chebyshev_order()

template<size_t Dim, class Scalar , size_t FieldDim = 1>

void NiHu::fmm::chebyshev_cluster< Dim, Scalar, FieldDim >::set_chebyshev_order ( size_t  order )

inline

set the Chebyshev order

Parameters

[in]

order

the Chebyshev order

Definition at line 68 of file chebyshev_cluster.hpp.

zero_local()

template<size_t Dim, class Scalar , size_t FieldDim = 1>

local_t NiHu::fmm::chebyshev_cluster< Dim, Scalar, FieldDim >::zero_local ( ) const

inline

return zero local contribution

Returns

zero local contribution

Definition at line 90 of file chebyshev_cluster.hpp.

zero_multipole()

template<size_t Dim, class Scalar , size_t FieldDim = 1>

multipole_t NiHu::fmm::chebyshev_cluster< Dim, Scalar, FieldDim >::zero_multipole ( ) const

inline

return zero multipole contribution

Returns

zero multipole contribution

Definition at line 83 of file chebyshev_cluster.hpp.

---

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

• src/fmm/chebyshev_cluster.hpp