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

#include <LatticeFunction.h>

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

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

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

Detailed Description

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

Definition at line 21 of file LatticeFunction.h.

Member Typedef Documentation

dcomplex

template<typename Scalar , int dim>

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

private

Definition at line 22 of file LatticeFunction.h.

Constructor & Destructor Documentation

LatticeFunction() [1/4]

template<typename Scalar , int dim>

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

explicit

Definition at line 13 of file LatticeFunctionImplementation.h.

LatticeFunction() [2/4]

template<typename Scalar , int dim>

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

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

Definition at line 22 of file LatticeFunctionImplementation.h.

LatticeFunction() [3/4]

template<typename Scalar , int dim>

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

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

Definition at line 34 of file LatticeFunctionImplementation.h.

LatticeFunction() [4/4]

template<typename Scalar , int dim>

template<typename T , int dm, typename >

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

Definition at line 50 of file LatticeFunctionImplementation.h.

Member Function Documentation

dot()

template<typename Scalar , int dim>

std::complex< double > gbLAB::LatticeFunction< Scalar, dim >::dot

(

const LatticeFunction< std::complex< double >, dim > &

other

)

const

Definition at line 70 of file LatticeFunctionImplementation.h.

ifft()

template<typename Scalar , int dim>

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

(

)

const

Definition at line 82 of file LatticeFunctionImplementation.h.

Field Documentation

basisVectors

template<typename Scalar , int dim>

const Eigen::Matrix<double, Eigen::Dynamic, dim> gbLAB::LatticeFunction< Scalar, dim >::basisVectors

Definition at line 24 of file LatticeFunction.h.

values

template<typename Scalar , int dim>

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

Definition at line 25 of file LatticeFunction.h.

---

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

• include/Lattices/LatticeFunction.h
• include/Lattices/LatticeFunctionImplementation.h