OPALX (Object Oriented Parallel Accelerator Library for Exascal): FieldContainer< T, Dim > Class Template Reference

OPALX (Object Oriented Parallel Accelerator Library for Exascal) MINIorX

OPALX

#include <FieldContainer.hpp>

Inheritance diagram for FieldContainer< T, Dim >:

Collaboration diagram for FieldContainer< T, Dim >:

Public Member Functions
	FieldContainer (Vector_t< T, Dim > &hr, Vector_t< T, Dim > &rmin, Vector_t< T, Dim > &rmax, std::array< bool, Dim > decomp, ippl::NDIndex< Dim > domain, Vector_t< T, Dim > origin, bool isAllPeriodic)
	~FieldContainer ()
VField_t< T, Dim > &	getE ()
void	setE (VField_t< T, Dim > &E)
Field_t< Dim > &	getRho ()
void	setRho (Field_t< Dim > &rho)
Field< T, Dim > &	getPhi ()
void	setPhi (Field< T, Dim > &phi)
Vector_t< double, Dim > &	getHr ()
void	setHr (const Vector_t< double, Dim > &hr)
Vector_t< double, Dim > &	getRMin ()
void	setRMin (const Vector_t< double, Dim > &rmin)
Vector_t< double, Dim > &	getRMax ()
void	setRMax (const Vector_t< double, Dim > &rmax)
std::array< bool, Dim >	getDecomp ()
void	setDecomp (std::array< bool, Dim > decomp)
Mesh_t< Dim > &	getMesh ()
void	setMesh (Mesh_t< Dim > &mesh)
FieldLayout_t< Dim > &	getFL ()
void	setFL (std::shared_ptr< FieldLayout_t< Dim > > &fl)
void	initializeFields (std::string stype_m="")

Private Attributes
Vector_t< double, Dim >	hr_m
Vector_t< double, Dim >	rmin_m
Vector_t< double, Dim >	rmax_m
std::array< bool, Dim >	decomp_m
VField_t< T, Dim >	E_m
Field_t< Dim >	rho_m
Field< T, Dim >	phi_m
Mesh_t< Dim >	mesh_m
FieldLayout_t< Dim >	fl_m

Detailed Description

template<typename T, unsigned Dim = 3>
class FieldContainer< T, Dim >

Definition at line 34 of file FieldContainer.hpp.

Constructor & Destructor Documentation

◆ FieldContainer()

template<typename T, unsigned Dim = 3>

FieldContainer< T, Dim >::FieldContainer	(	Vector_t< T, Dim > &	hr,
		Vector_t< T, Dim > &	rmin,
		Vector_t< T, Dim > &	rmax,
		std::array< bool, Dim >	decomp,
		ippl::NDIndex< Dim >	domain,
		Vector_t< T, Dim >	origin,
		bool	isAllPeriodic )

inline

Definition at line 36 of file FieldContainer.hpp.

◆ ~FieldContainer()

template<typename T, unsigned Dim = 3>

FieldContainer< T, Dim >::~FieldContainer ( )

inline

Definition at line 48 of file FieldContainer.hpp.

Member Function Documentation

◆ getDecomp()

template<typename T, unsigned Dim = 3>

std::array< bool, Dim > FieldContainer< T, Dim >::getDecomp ( )

inline

Definition at line 105 of file FieldContainer.hpp.

◆ getE()

template<typename T, unsigned Dim = 3>

VField_t< T, Dim > & FieldContainer< T, Dim >::getE ( )

inline

Definition at line 63 of file FieldContainer.hpp.

◆ getFL()

template<typename T, unsigned Dim = 3>

FieldLayout_t< Dim > & FieldContainer< T, Dim >::getFL ( )

inline

Definition at line 119 of file FieldContainer.hpp.

◆ getHr()

template<typename T, unsigned Dim = 3>

Vector_t< double, Dim > & FieldContainer< T, Dim >::getHr ( )

inline

Definition at line 84 of file FieldContainer.hpp.

◆ getMesh()

template<typename T, unsigned Dim = 3>

Mesh_t< Dim > & FieldContainer< T, Dim >::getMesh ( )

inline

Definition at line 112 of file FieldContainer.hpp.

◆ getPhi()

template<typename T, unsigned Dim = 3>

Field< T, Dim > & FieldContainer< T, Dim >::getPhi ( )

inline

Definition at line 77 of file FieldContainer.hpp.

◆ getRho()

template<typename T, unsigned Dim = 3>

Field_t< Dim > & FieldContainer< T, Dim >::getRho ( )

inline

Definition at line 70 of file FieldContainer.hpp.

◆ getRMax()

template<typename T, unsigned Dim = 3>

Vector_t< double, Dim > & FieldContainer< T, Dim >::getRMax ( )

inline

Definition at line 98 of file FieldContainer.hpp.

◆ getRMin()

template<typename T, unsigned Dim = 3>

Vector_t< double, Dim > & FieldContainer< T, Dim >::getRMin ( )

inline

Definition at line 91 of file FieldContainer.hpp.

◆ initializeFields()

template<typename T, unsigned Dim = 3>

void FieldContainer< T, Dim >::initializeFields ( std::string stype_m = "" )

inline

Definition at line 126 of file FieldContainer.hpp.

◆ setDecomp()

template<typename T, unsigned Dim = 3>

void FieldContainer< T, Dim >::setDecomp ( std::array< bool, Dim > decomp )

inline

Definition at line 108 of file FieldContainer.hpp.

◆ setE()

template<typename T, unsigned Dim = 3>

void FieldContainer< T, Dim >::setE ( VField_t< T, Dim > & E )

inline

Definition at line 66 of file FieldContainer.hpp.

◆ setFL()

template<typename T, unsigned Dim = 3>

void FieldContainer< T, Dim >::setFL ( std::shared_ptr< FieldLayout_t< Dim > > & fl )

inline

Definition at line 122 of file FieldContainer.hpp.

◆ setHr()

template<typename T, unsigned Dim = 3>

void FieldContainer< T, Dim >::setHr ( const Vector_t< double, Dim > & hr )

inline

Definition at line 87 of file FieldContainer.hpp.

◆ setMesh()

template<typename T, unsigned Dim = 3>

void FieldContainer< T, Dim >::setMesh ( Mesh_t< Dim > & mesh )

inline

Definition at line 115 of file FieldContainer.hpp.

◆ setPhi()

template<typename T, unsigned Dim = 3>

void FieldContainer< T, Dim >::setPhi ( Field< T, Dim > & phi )

inline

Definition at line 80 of file FieldContainer.hpp.

◆ setRho()

template<typename T, unsigned Dim = 3>

void FieldContainer< T, Dim >::setRho ( Field_t< Dim > & rho )

inline

Definition at line 73 of file FieldContainer.hpp.

◆ setRMax()

template<typename T, unsigned Dim = 3>

void FieldContainer< T, Dim >::setRMax ( const Vector_t< double, Dim > & rmax )

inline

Definition at line 101 of file FieldContainer.hpp.

◆ setRMin()

template<typename T, unsigned Dim = 3>

void FieldContainer< T, Dim >::setRMin ( const Vector_t< double, Dim > & rmin )

inline

Definition at line 94 of file FieldContainer.hpp.

Member Data Documentation

◆ decomp_m

template<typename T, unsigned Dim = 3>

std::array<bool, Dim> FieldContainer< T, Dim >::decomp_m

private

Definition at line 55 of file FieldContainer.hpp.

◆ E_m

template<typename T, unsigned Dim = 3>

VField_t<T, Dim> FieldContainer< T, Dim >::E_m

private

Definition at line 56 of file FieldContainer.hpp.

◆ fl_m

template<typename T, unsigned Dim = 3>

FieldLayout_t<Dim> FieldContainer< T, Dim >::fl_m

private

Definition at line 60 of file FieldContainer.hpp.

◆ hr_m

template<typename T, unsigned Dim = 3>

Vector_t<double, Dim> FieldContainer< T, Dim >::hr_m

private

Definition at line 52 of file FieldContainer.hpp.

◆ mesh_m

template<typename T, unsigned Dim = 3>

Mesh_t<Dim> FieldContainer< T, Dim >::mesh_m

private

Definition at line 59 of file FieldContainer.hpp.

◆ phi_m

template<typename T, unsigned Dim = 3>

Field<T, Dim> FieldContainer< T, Dim >::phi_m

private

Definition at line 58 of file FieldContainer.hpp.

◆ rho_m

template<typename T, unsigned Dim = 3>

Field_t<Dim> FieldContainer< T, Dim >::rho_m

private

Definition at line 57 of file FieldContainer.hpp.

◆ rmax_m

template<typename T, unsigned Dim = 3>

Vector_t<double, Dim> FieldContainer< T, Dim >::rmax_m

private

Definition at line 54 of file FieldContainer.hpp.

◆ rmin_m

template<typename T, unsigned Dim = 3>

Vector_t<double, Dim> FieldContainer< T, Dim >::rmin_m

private

Definition at line 53 of file FieldContainer.hpp.

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

FieldContainer.hpp