gbLAB::PeriodicFunction< Scalar, dim > Class Template Reference

#include <PeriodicFunction.h>

Public Types
using	dcomplex = std::complex< double >

Public Member Functions
	PeriodicFunction (const Eigen::array< Eigen::Index, dim > &n, const Eigen::Matrix< double, Eigen::Dynamic, dim > &_unitCell)
template<typename T , typename = T, typename = T, int dm = dim, typename = std::enable_if_t<dm==1>>
	PeriodicFunction (const Eigen::array< Eigen::Index, dim > &n, const Eigen::Matrix< double, Eigen::Dynamic, dim > &_unitCell, const Function< T, Scalar > &fun)
template<typename T , typename = T, int dm = dim, typename = std::enable_if_t<dm==2>>
	PeriodicFunction (const Eigen::array< Eigen::Index, dim > &n, const Eigen::Matrix< double, Eigen::Dynamic, dim > &_unitCell, const Function< T, Scalar > &fun)
template<typename T , int dm = dim, typename = std::enable_if_t<dm==3>>
	PeriodicFunction (const Eigen::array< Eigen::Index, dim > &n, const Eigen::Matrix< double, Eigen::Dynamic, dim > &_unitCell, const Function< T, Scalar > &fun)
LatticeFunction< dcomplex, dim >	fft () const
double	dot (const PeriodicFunction< Scalar, dim > &other) const
template<typename T >
PeriodicFunction< Scalar, dim >	kernelConvolution (const Function< T, Scalar > &kernel)

Data Fields
const Eigen::Matrix< double, Eigen::Dynamic, dim >	unitCell
Eigen::Tensor< Scalar, dim >	values

Detailed Description

template<typename Scalar, int dim>
class gbLAB::PeriodicFunction< Scalar, dim >

Definition at line 21 of file PeriodicFunction.h.

Member Typedef Documentation

dcomplex

template<typename Scalar , int dim>

using gbLAB::PeriodicFunction< Scalar, dim >::dcomplex = std::complex<double>

Definition at line 23 of file PeriodicFunction.h.

Constructor & Destructor Documentation

PeriodicFunction() [1/4]

template<typename Scalar , int dim>

gbLAB::PeriodicFunction< Scalar, dim >::PeriodicFunction ( const Eigen::array< Eigen::Index, dim > &  n, const Eigen::Matrix< double, Eigen::Dynamic, dim > &  _unitCell  )

explicit

Definition at line 12 of file PeriodicFunctionImplementation.h.

PeriodicFunction() [2/4]

template<typename Scalar , int dim>

template<typename T , typename , typename , int dm, typename >

gbLAB::PeriodicFunction< Scalar, dim >::PeriodicFunction	(	const Eigen::array< Eigen::Index, dim > &	n,
		const Eigen::Matrix< double, Eigen::Dynamic, dim > &	_unitCell,
		const Function< T, Scalar > &	fun
	)

Definition at line 21 of file PeriodicFunctionImplementation.h.

PeriodicFunction() [3/4]

template<typename Scalar , int dim>

template<typename T , typename , int dm, typename >

gbLAB::PeriodicFunction< Scalar, dim >::PeriodicFunction	(	const Eigen::array< Eigen::Index, dim > &	n,
		const Eigen::Matrix< double, Eigen::Dynamic, dim > &	_unitCell,
		const Function< T, Scalar > &	fun
	)

Definition at line 38 of file PeriodicFunctionImplementation.h.

PeriodicFunction() [4/4]

template<typename Scalar , int dim>

template<typename T , int dm, typename >

gbLAB::PeriodicFunction< Scalar, dim >::PeriodicFunction	(	const Eigen::array< Eigen::Index, dim > &	n,
		const Eigen::Matrix< double, Eigen::Dynamic, dim > &	_unitCell,
		const Function< T, Scalar > &	fun
	)

Definition at line 57 of file PeriodicFunctionImplementation.h.

Member Function Documentation

dot()

template<typename Scalar , int dim>

double gbLAB::PeriodicFunction< Scalar, dim >::dot

(

const PeriodicFunction< Scalar, dim > &

other

)

const

Definition at line 100 of file PeriodicFunctionImplementation.h.

fft()

template<typename Scalar , int dim>

LatticeFunction< typename PeriodicFunction< Scalar, dim >::dcomplex, dim > gbLAB::PeriodicFunction< Scalar, dim >::fft

(

)

const

Definition at line 79 of file PeriodicFunctionImplementation.h.

kernelConvolution()

template<typename Scalar , int dim>

template<typename T >

PeriodicFunction< Scalar, dim > gbLAB::PeriodicFunction< Scalar, dim >::kernelConvolution

(

const Function< T, Scalar > &

kernel

)

Definition at line 117 of file PeriodicFunctionImplementation.h.

Field Documentation

unitCell

template<typename Scalar , int dim>

const Eigen::Matrix<double,Eigen::Dynamic,dim> gbLAB::PeriodicFunction< Scalar, dim >::unitCell

Definition at line 24 of file PeriodicFunction.h.

values

template<typename Scalar , int dim>

Eigen::Tensor<Scalar,dim> gbLAB::PeriodicFunction< Scalar, dim >::values

Definition at line 25 of file PeriodicFunction.h.

---

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

• include/Lattices/LatticeFunction.h
• include/Math/PeriodicFunction.h
• include/Math/PeriodicFunctionImplementation.h