ImmersedBoundaryFftInterface< DIM > Class Template Reference

#include <ImmersedBoundaryFftInterface.hpp>

Collaboration diagram for ImmersedBoundaryFftInterface< DIM >:

Public Member Functions
	ImmersedBoundaryFftInterface (ImmersedBoundaryMesh< DIM, DIM > *pMesh, double *pIn, std::complex< double > *pComplex, double *pOut, bool activeSources)
	ImmersedBoundaryFftInterface ()=delete
virtual	~ImmersedBoundaryFftInterface ()
void	FftExecuteForward ()
void	FftExecuteInverse ()

Protected Attributes
ImmersedBoundaryMesh< DIM, DIM > *	mpMesh
double *	mpInputArray
std::complex< double > *	mpComplexArray
double *	mpOutputArray
pocketfft::shape_t	mRealDims
pocketfft::shape_t	mCompDims
unsigned	mHowManyForward
unsigned	mHowManyInverse
int	mRealSep
int	mCompSep
long int	mRealStride
long int	mCompStride

Friends
class	TestImmersedBoundaryFftInterface

Detailed Description

template<unsigned DIM>
class ImmersedBoundaryFftInterface< DIM >

A class to interface with discrete Fourier transform libraries and perform the necessary transforms for immersed boundary simulations.

Definition at line 49 of file ImmersedBoundaryFftInterface.hpp.

Constructor & Destructor Documentation

ImmersedBoundaryFftInterface() [1/2]

template<unsigned DIM>

ImmersedBoundaryFftInterface< DIM >::ImmersedBoundaryFftInterface	(	ImmersedBoundaryMesh< DIM, DIM > *	pMesh,
		double *	pIn,
		std::complex< double > *	pComplex,
		double *	pOut,
		bool	activeSources
	)

Default constructor.

Parameters

pMesh	the immersed boundary mesh
pIn	pointer to the input array
pComplex	pointer to the complex number array
pOut	pointer to the output array
activeSources	whether the population has active fluid sources

Definition at line 42 of file ImmersedBoundaryFftInterface.cpp.

References ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::GetNumGridPtsX(), ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::GetNumGridPtsY(), ImmersedBoundaryFftInterface< DIM >::mCompDims, ImmersedBoundaryFftInterface< DIM >::mCompSep, ImmersedBoundaryFftInterface< DIM >::mCompStride, ImmersedBoundaryFftInterface< DIM >::mHowManyForward, ImmersedBoundaryFftInterface< DIM >::mHowManyInverse, ImmersedBoundaryFftInterface< DIM >::mpMesh, ImmersedBoundaryFftInterface< DIM >::mRealDims, ImmersedBoundaryFftInterface< DIM >::mRealSep, and ImmersedBoundaryFftInterface< DIM >::mRealStride.

ImmersedBoundaryFftInterface() [2/2]

template<unsigned DIM>

ImmersedBoundaryFftInterface< DIM >::ImmersedBoundaryFftInterface ( )

delete

Empty constructor.

~ImmersedBoundaryFftInterface()

template<unsigned DIM>

ImmersedBoundaryFftInterface< DIM >::~ImmersedBoundaryFftInterface ( )

virtual

Destructor.

Definition at line 88 of file ImmersedBoundaryFftInterface.cpp.

Member Function Documentation

FftExecuteForward()

template<unsigned DIM>

void ImmersedBoundaryFftInterface< DIM >::FftExecuteForward

(

)

Performs forward fourier transforms

Definition at line 93 of file ImmersedBoundaryFftInterface.cpp.

FftExecuteInverse()

template<unsigned DIM>

void ImmersedBoundaryFftInterface< DIM >::FftExecuteInverse

(

)

Performs inverse fourier transforms

Definition at line 107 of file ImmersedBoundaryFftInterface.cpp.

Friends And Related Symbol Documentation

TestImmersedBoundaryFftInterface

template<unsigned DIM>

friend class TestImmersedBoundaryFftInterface

friend

Definition at line 122 of file ImmersedBoundaryFftInterface.hpp.

Member Data Documentation

mCompDims

template<unsigned DIM>

pocketfft::shape_t ImmersedBoundaryFftInterface< DIM >::mCompDims

protected

Dimensions of the complex arrays

Definition at line 69 of file ImmersedBoundaryFftInterface.hpp.

Referenced by ImmersedBoundaryFftInterface< DIM >::ImmersedBoundaryFftInterface().

mCompSep

template<unsigned DIM>

int ImmersedBoundaryFftInterface< DIM >::mCompSep

protected

Number of elements in each complex array

Definition at line 81 of file ImmersedBoundaryFftInterface.hpp.

Referenced by ImmersedBoundaryFftInterface< DIM >::ImmersedBoundaryFftInterface().

mCompStride

template<unsigned DIM>

long int ImmersedBoundaryFftInterface< DIM >::mCompStride

protected

Distance between each element in the complex arrays in bytes

Definition at line 87 of file ImmersedBoundaryFftInterface.hpp.

Referenced by ImmersedBoundaryFftInterface< DIM >::ImmersedBoundaryFftInterface().

mHowManyForward

template<unsigned DIM>

unsigned ImmersedBoundaryFftInterface< DIM >::mHowManyForward

protected

How many forward transforms to execute

Definition at line 72 of file ImmersedBoundaryFftInterface.hpp.

Referenced by ImmersedBoundaryFftInterface< DIM >::ImmersedBoundaryFftInterface().

mHowManyInverse

template<unsigned DIM>

unsigned ImmersedBoundaryFftInterface< DIM >::mHowManyInverse

protected

How many inverse transofrms to execute

Definition at line 75 of file ImmersedBoundaryFftInterface.hpp.

Referenced by ImmersedBoundaryFftInterface< DIM >::ImmersedBoundaryFftInterface().

mpComplexArray

template<unsigned DIM>

std::complex<double>* ImmersedBoundaryFftInterface< DIM >::mpComplexArray

protected

Pointer to the start of Fourier domain.

Definition at line 60 of file ImmersedBoundaryFftInterface.hpp.

mpInputArray

template<unsigned DIM>

double* ImmersedBoundaryFftInterface< DIM >::mpInputArray

protected

Pointer to the start of the input arrays.

Definition at line 57 of file ImmersedBoundaryFftInterface.hpp.

mpMesh

template<unsigned DIM>

ImmersedBoundaryMesh<DIM,DIM>* ImmersedBoundaryFftInterface< DIM >::mpMesh

protected

The immersed boundary mesh.

Definition at line 54 of file ImmersedBoundaryFftInterface.hpp.

Referenced by ImmersedBoundaryFftInterface< DIM >::ImmersedBoundaryFftInterface().

mpOutputArray

template<unsigned DIM>

double* ImmersedBoundaryFftInterface< DIM >::mpOutputArray

protected

Pointer to the start output array.

Definition at line 63 of file ImmersedBoundaryFftInterface.hpp.

mRealDims

template<unsigned DIM>

pocketfft::shape_t ImmersedBoundaryFftInterface< DIM >::mRealDims

protected

Dimensions of the real arrays

Definition at line 66 of file ImmersedBoundaryFftInterface.hpp.

Referenced by ImmersedBoundaryFftInterface< DIM >::ImmersedBoundaryFftInterface().

mRealSep

template<unsigned DIM>

int ImmersedBoundaryFftInterface< DIM >::mRealSep

protected

Number of elements in each real array

Definition at line 78 of file ImmersedBoundaryFftInterface.hpp.

Referenced by ImmersedBoundaryFftInterface< DIM >::ImmersedBoundaryFftInterface().

mRealStride

template<unsigned DIM>

long int ImmersedBoundaryFftInterface< DIM >::mRealStride

protected

Distance between each element in the real arrays in bytes

Definition at line 84 of file ImmersedBoundaryFftInterface.hpp.

Referenced by ImmersedBoundaryFftInterface< DIM >::ImmersedBoundaryFftInterface().

---

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

• mesh/src/immersed_boundary/ImmersedBoundaryFftInterface.hpp
• mesh/src/immersed_boundary/ImmersedBoundaryFftInterface.cpp