Component for interpolating field maps stored in a regular mesh. More...

#include <ComponentVoxel.hh>

Inheritance diagram for Garfield::ComponentVoxel:

Classes
struct	Element

Public Member Functions
	ComponentVoxel ()
	Constructor.
	~ComponentVoxel ()
	Destructor.
void	EnableInterpolation (const bool on=true)
	Interpolate between field values at the element centres.
void	SetMesh (const unsigned int nx, const unsigned int ny, const unsigned int nz, const double xmin, const double xmax, const double ymin, const double ymax, const double zmin, const double zmax)
	Define the grid.
bool	LoadElectricField (const std::string &filename, const std::string &format, const bool withPotential, const bool withRegion, const double scaleX=1., const double scaleE=1., const double scaleP=1.)
	Import electric field and potential values from a file.
bool	LoadWeightingField (const std::string &filename, const std::string &format, const bool withPotential, const double scaleX=1., const double scaleE=1., const double scaleP=1.)
	Import (prompt) weighting field from file.
void	SetWeightingFieldOffset (const double x, const double y, const double z)
	Offset coordinates in the weighting field, such that the same numerical weighting field map can be used for electrodes at different positions.
bool	LoadWeightingField (const std::string &filename, const std::string &format, const double time, const bool withPotential, const double scaleX=1., const double scaleE=1., const double scaleP=1.)
	Import delayed weighting field from file.
bool	LoadMagneticField (const std::string &filename, const std::string &format, const double scaleX=1., const double scaleB=1.)
	Import magnetic field values from a file.
void	SetMedium (const unsigned int i, Medium *m)
	Set the medium in region i.
Medium *	GetMedium (const unsigned int i) const
	Get the medium in region i.
void	PrintRegions () const
	Print all regions.
bool	GetElement (const double xi, const double yi, const double zi, unsigned int &i, unsigned int &j, unsigned int &k, bool &xMirrored, bool &yMirrored, bool &zMirrored) const
	Return the indices of the element at a given point.
bool	GetElement (const unsigned int i, const unsigned int j, const unsigned int k, double &v, double &ex, double &ey, double &ez) const
	Return the field for an element with given index.
void	Clear () override
void	ElectricField (const double x, const double y, const double z, double &ex, double &ey, double &ez, double &v, Medium *&m, int &status) override
void	ElectricField (const double x, const double y, const double z, double &ex, double &ey, double &ez, Medium *&m, int &status) override
void	WeightingField (const double x, const double y, const double z, double &wx, double &wy, double &wz, const std::string &label) override
double	WeightingPotential (const double x, const double y, const double z, const std::string &label) override
void	DelayedWeightingField (const double x, const double y, const double z, const double t, double &wx, double &wy, double &wz, const std::string &label) override
double	DelayedWeightingPotential (const double x, const double y, const double z, const double t, const std::string &label) override
void	MagneticField (const double x, const double y, const double z, double &bx, double &by, double &bz, int &status) override
bool	HasMagneticField () const override
Medium *	GetMedium (const double x, const double y, const double z) override
bool	GetVoltageRange (double &vmin, double &vmax) override
bool	GetElectricFieldRange (double &exmin, double &exmax, double &eymin, double &eymax, double &ezmin, double &ezmax)
bool	GetBoundingBox (double &xmin, double &ymin, double &zmin, double &xmax, double &ymax, double &zmax) override
bool	GetElementaryCell (double &xmin, double &ymin, double &zmin, double &xmax, double &ymax, double &zmax) override

Private Member Functions
bool	LoadData (const std::string &filename, std::string format, const bool withPotential, const bool withRegion, const double scaleX, const double scaleF, const double scaleP, std::vector< std::vector< std::vector< Element > > > &field)
	Read data from file.
void	Reset () override
void	UpdatePeriodicity () override
bool	GetField (const double x, const double y, const double z, const std::vector< std::vector< std::vector< Element > > > &field, double &fx, double &fy, double &fz, double &p, int &region)
	Look up/interpolate the field at a given point.
double	Reduce (const double xin, const double xmin, const double xmax, const bool simplePeriodic, const bool mirrorPeriodic, bool &isMirrored) const
	Reduce a coordinate to the basic cell (in case of periodicity).
void	Initialise (std::vector< std::vector< std::vector< Element > > > &fields)
	Set the dimensions of a table according to the mesh.
void	InitialiseRegions ()

Private Attributes
std::vector< Medium * >	m_media
std::vector< std::vector< std::vector< int > > >	m_regions
	Region indices.
std::vector< std::vector< std::vector< Element > > >	m_efields
	Electric field values and potentials at each mesh element.
std::vector< std::vector< std::vector< Element > > >	m_bfields
	Magnetic field values at each mesh element.
std::vector< std::vector< std::vector< Element > > >	m_wfields
	Prompt weighting field values and potentials at each mesh element.
std::vector< std::vector< std::vector< std::vector< Element > > > >	m_wdfields
	Delayed weighting field values and potentials at each mesh element.
unsigned int	m_nX = 0
unsigned int	m_nY = 0
unsigned int	m_nZ = 0
double	m_xMin = 0.
double	m_yMin = 0.
double	m_zMin = 0.
double	m_xMax = 0.
double	m_yMax = 0.
double	m_zMax = 0.
double	m_dx = 0.
double	m_dy = 0.
double	m_dz = 0.
bool	m_interpolate = false
bool	m_hasMesh = false
bool	m_hasPotential = false
bool	m_hasEfield = false
bool	m_hasBfield = false
bool	m_hasWfield = false
double	m_wField_xOffset = 0.
double	m_wField_yOffset = 0.
double	m_wField_zOffset = 0.
double	m_pMin = 0.
double	m_pMax = 0.

Detailed Description

Component for interpolating field maps stored in a regular mesh.

Definition at line 10 of file ComponentVoxel.hh.

Constructor & Destructor Documentation

◆ ComponentVoxel()

Garfield::ComponentVoxel::ComponentVoxel ( )

Constructor.

◆ ~ComponentVoxel()

Garfield::ComponentVoxel::~ComponentVoxel ( )

inline

Destructor.

Definition at line 15 of file ComponentVoxel.hh.

15{}

Member Function Documentation

◆ Clear()

void Garfield::ComponentVoxel::Clear ( )

inlineoverride

Definition at line 85 of file ComponentVoxel.hh.

85{ Reset(); }

Garfield::ComponentVoxel::Reset

void Reset() override

◆ DelayedWeightingField()

void Garfield::ComponentVoxel::DelayedWeightingField	(	const double	x,
		const double	y,
		const double	z,
		const double	t,
		double &	wx,
		double &	wy,
		double &	wz,
		const std::string &	label )

override

◆ DelayedWeightingPotential()

double Garfield::ComponentVoxel::DelayedWeightingPotential	(	const double	x,
		const double	y,
		const double	z,
		const double	t,
		const std::string &	label )

override

◆ ElectricField() [1/2]

void Garfield::ComponentVoxel::ElectricField	(	const double	x,
		const double	y,
		const double	z,
		double &	ex,
		double &	ey,
		double &	ez,
		double &	v,
		Medium *&	m,
		int &	status )

override

◆ ElectricField() [2/2]

void Garfield::ComponentVoxel::ElectricField	(	const double	x,
		const double	y,
		const double	z,
		double &	ex,
		double &	ey,
		double &	ez,
		Medium *&	m,
		int &	status )

override

◆ EnableInterpolation()

void Garfield::ComponentVoxel::EnableInterpolation ( const bool on = true )

inline

Interpolate between field values at the element centres.

Definition at line 18 of file ComponentVoxel.hh.

18{ m_interpolate = on; }

Garfield::ComponentVoxel::m_interpolate

bool m_interpolate

Definition ComponentVoxel.hh:141

◆ GetBoundingBox()

bool Garfield::ComponentVoxel::GetBoundingBox	(	double &	xmin,
		double &	ymin,
		double &	zmin,
		double &	xmax,
		double &	ymax,
		double &	zmax )

override

◆ GetElectricFieldRange()

bool Garfield::ComponentVoxel::GetElectricFieldRange	(	double &	exmin,
		double &	exmax,
		double &	eymin,
		double &	eymax,
		double &	ezmin,
		double &	ezmax )

◆ GetElement() [1/2]

bool Garfield::ComponentVoxel::GetElement	(	const double	xi,
		const double	yi,
		const double	zi,
		unsigned int &	i,
		unsigned int &	j,
		unsigned int &	k,
		bool &	xMirrored,
		bool &	yMirrored,
		bool &	zMirrored ) const

Return the indices of the element at a given point.

◆ GetElement() [2/2]

bool Garfield::ComponentVoxel::GetElement	(	const unsigned int	i,
		const unsigned int	j,
		const unsigned int	k,
		double &	v,
		double &	ex,
		double &	ey,
		double &	ez ) const

Return the field for an element with given index.

◆ GetElementaryCell()

bool Garfield::ComponentVoxel::GetElementaryCell	(	double &	xmin,
		double &	ymin,
		double &	zmin,
		double &	xmax,
		double &	ymax,
		double &	zmax )

override

◆ GetField()

bool Garfield::ComponentVoxel::GetField	(	const double	x,
		const double	y,
		const double	z,
		const std::vector< std::vector< std::vector< Element > > > &	field,
		double &	fx,
		double &	fy,
		double &	fz,
		double &	p,
		int &	region )

private

Look up/interpolate the field at a given point.

◆ GetMedium() [1/2]

Medium * Garfield::ComponentVoxel::GetMedium	(	const double	x,
		const double	y,
		const double	z )

override

◆ GetMedium() [2/2]

Medium * Garfield::ComponentVoxel::GetMedium ( const unsigned int i ) const

Get the medium in region i.

◆ GetVoltageRange()

bool Garfield::ComponentVoxel::GetVoltageRange	(	double &	vmin,
		double &	vmax )

override

◆ HasMagneticField()

bool Garfield::ComponentVoxel::HasMagneticField ( ) const

override

◆ Initialise()

void Garfield::ComponentVoxel::Initialise ( std::vector< std::vector< std::vector< Element > > > & fields )

private

Set the dimensions of a table according to the mesh.

◆ InitialiseRegions()

void Garfield::ComponentVoxel::InitialiseRegions ( )

private

◆ LoadData()

bool Garfield::ComponentVoxel::LoadData	(	const std::string &	filename,
		std::string	format,
		const bool	withPotential,
		const bool	withRegion,
		const double	scaleX,
		const double	scaleF,
		const double	scaleP,
		std::vector< std::vector< std::vector< Element > > > &	field )

private

Read data from file.

◆ LoadElectricField()

bool Garfield::ComponentVoxel::LoadElectricField	(	const std::string &	filename,
		const std::string &	format,
		const bool	withPotential,
		const bool	withRegion,
		const double	scaleX = 1.,
		const double	scaleE = 1.,
		const double	scaleP = 1. )

Import electric field and potential values from a file.

The file is supposed to contain one line for each mesh point starting with

either two or three floating point numbers, specifying the coordinates (in cm) of the element centre or
two or three integers specifying the index of the element in the mesh,

followed by

two or three floating point numbers for the electric field (in V/cm), and (depending on the values of withPotential and withRegion),
a floating point number specifying the potential (in V), and
an integer specifying the "region" of the element.

Format types are:

"xy", "xyz": elements are specified by the coordinates of their centres
"ij", "ijk": elements are specified by their indices

◆ LoadMagneticField()

bool Garfield::ComponentVoxel::LoadMagneticField	(	const std::string &	filename,
		const std::string &	format,
		const double	scaleX = 1.,
		const double	scaleB = 1. )

Import magnetic field values from a file.

◆ LoadWeightingField() [1/2]

bool Garfield::ComponentVoxel::LoadWeightingField	(	const std::string &	filename,
		const std::string &	format,
		const bool	withPotential,
		const double	scaleX = 1.,
		const double	scaleE = 1.,
		const double	scaleP = 1. )

Import (prompt) weighting field from file.

◆ LoadWeightingField() [2/2]

bool Garfield::ComponentVoxel::LoadWeightingField	(	const std::string &	filename,
		const std::string &	format,
		const double	time,
		const bool	withPotential,
		const double	scaleX = 1.,
		const double	scaleE = 1.,
		const double	scaleP = 1. )

Import delayed weighting field from file.

◆ MagneticField()

void Garfield::ComponentVoxel::MagneticField	(	const double	x,
		const double	y,
		const double	z,
		double &	bx,
		double &	by,
		double &	bz,
		int &	status )

override

◆ PrintRegions()

void Garfield::ComponentVoxel::PrintRegions ( ) const

Print all regions.

◆ Reduce()

double Garfield::ComponentVoxel::Reduce	(	const double	xin,
		const double	xmin,
		const double	xmax,
		const bool	simplePeriodic,
		const bool	mirrorPeriodic,
		bool &	isMirrored ) const

private

Reduce a coordinate to the basic cell (in case of periodicity).

◆ Reset()

void Garfield::ComponentVoxel::Reset ( )

overrideprivate

◆ SetMedium()

void Garfield::ComponentVoxel::SetMedium	(	const unsigned int	i,
		Medium *	m )

Set the medium in region i.

◆ SetMesh()

void Garfield::ComponentVoxel::SetMesh	(	const unsigned int	nx,
		const unsigned int	ny,
		const unsigned int	nz,
		const double	xmin,
		const double	xmax,
		const double	ymin,
		const double	ymax,
		const double	zmin,
		const double	zmax )

Define the grid.

Parameters

nx,ny,nz	number of bins along x, y, z.
xmin,xmax	range along .
ymin,ymax	range along .
zmin,zmax	range along .

◆ SetWeightingFieldOffset()

void Garfield::ComponentVoxel::SetWeightingFieldOffset	(	const double	x,
		const double	y,
		const double	z )

Offset coordinates in the weighting field, such that the same numerical weighting field map can be used for electrodes at different positions.

◆ UpdatePeriodicity()

void Garfield::ComponentVoxel::UpdatePeriodicity ( )

overrideprivate

◆ WeightingField()

void Garfield::ComponentVoxel::WeightingField	(	const double	x,
		const double	y,
		const double	z,
		double &	wx,
		double &	wy,
		double &	wz,
		const std::string &	label )

override

◆ WeightingPotential()

double Garfield::ComponentVoxel::WeightingPotential	(	const double	x,
		const double	y,
		const double	z,
		const std::string &	label )

override

Member Data Documentation

◆ m_bfields

std::vector<std::vector<std::vector<Element> > > Garfield::ComponentVoxel::m_bfields

private

Magnetic field values at each mesh element.

Definition at line 129 of file ComponentVoxel.hh.

◆ m_dx

double Garfield::ComponentVoxel::m_dx = 0.

private

Definition at line 139 of file ComponentVoxel.hh.

◆ m_dy

double Garfield::ComponentVoxel::m_dy = 0.

private

Definition at line 139 of file ComponentVoxel.hh.

◆ m_dz

double Garfield::ComponentVoxel::m_dz = 0.

private

Definition at line 139 of file ComponentVoxel.hh.

◆ m_efields

std::vector<std::vector<std::vector<Element> > > Garfield::ComponentVoxel::m_efields

private

Electric field values and potentials at each mesh element.

Definition at line 127 of file ComponentVoxel.hh.

◆ m_hasBfield

bool Garfield::ComponentVoxel::m_hasBfield = false

private

Definition at line 146 of file ComponentVoxel.hh.

◆ m_hasEfield

bool Garfield::ComponentVoxel::m_hasEfield = false

private

Definition at line 145 of file ComponentVoxel.hh.

◆ m_hasMesh

bool Garfield::ComponentVoxel::m_hasMesh = false

private

Definition at line 143 of file ComponentVoxel.hh.

◆ m_hasPotential

bool Garfield::ComponentVoxel::m_hasPotential = false

private

Definition at line 144 of file ComponentVoxel.hh.

◆ m_hasWfield

bool Garfield::ComponentVoxel::m_hasWfield = false

private

Definition at line 147 of file ComponentVoxel.hh.

◆ m_interpolate

bool Garfield::ComponentVoxel::m_interpolate = false

private

Definition at line 141 of file ComponentVoxel.hh.

◆ m_media

std::vector<Medium*> Garfield::ComponentVoxel::m_media

private

Definition at line 118 of file ComponentVoxel.hh.

◆ m_nX

unsigned int Garfield::ComponentVoxel::m_nX = 0

private

Definition at line 136 of file ComponentVoxel.hh.

◆ m_nY

unsigned int Garfield::ComponentVoxel::m_nY = 0

private

Definition at line 136 of file ComponentVoxel.hh.

◆ m_nZ

unsigned int Garfield::ComponentVoxel::m_nZ = 0

private

Definition at line 136 of file ComponentVoxel.hh.

◆ m_pMax

double Garfield::ComponentVoxel::m_pMax = 0.

private

Definition at line 155 of file ComponentVoxel.hh.

◆ m_pMin

double Garfield::ComponentVoxel::m_pMin = 0.

private

Definition at line 155 of file ComponentVoxel.hh.

◆ m_regions

std::vector<std::vector<std::vector<int> > > Garfield::ComponentVoxel::m_regions

private

Region indices.

Definition at line 125 of file ComponentVoxel.hh.

◆ m_wdfields

std::vector<std::vector<std::vector<std::vector<Element> > > > Garfield::ComponentVoxel::m_wdfields

private

Delayed weighting field values and potentials at each mesh element.

Definition at line 133 of file ComponentVoxel.hh.

◆ m_wField_xOffset

double Garfield::ComponentVoxel::m_wField_xOffset = 0.

private

Definition at line 150 of file ComponentVoxel.hh.

◆ m_wField_yOffset

double Garfield::ComponentVoxel::m_wField_yOffset = 0.

private

Definition at line 151 of file ComponentVoxel.hh.

◆ m_wField_zOffset

double Garfield::ComponentVoxel::m_wField_zOffset = 0.

private

Definition at line 152 of file ComponentVoxel.hh.

◆ m_wfields

std::vector<std::vector<std::vector<Element> > > Garfield::ComponentVoxel::m_wfields

private

Prompt weighting field values and potentials at each mesh element.

Definition at line 131 of file ComponentVoxel.hh.

◆ m_xMax

double Garfield::ComponentVoxel::m_xMax = 0.

private

Definition at line 138 of file ComponentVoxel.hh.

◆ m_xMin

double Garfield::ComponentVoxel::m_xMin = 0.

private

Definition at line 137 of file ComponentVoxel.hh.

◆ m_yMax

double Garfield::ComponentVoxel::m_yMax = 0.

private

Definition at line 138 of file ComponentVoxel.hh.

◆ m_yMin

double Garfield::ComponentVoxel::m_yMin = 0.

private

Definition at line 137 of file ComponentVoxel.hh.

◆ m_zMax

double Garfield::ComponentVoxel::m_zMax = 0.

private

Definition at line 138 of file ComponentVoxel.hh.

◆ m_zMin

double Garfield::ComponentVoxel::m_zMin = 0.

private

Definition at line 137 of file ComponentVoxel.hh.

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

/builds/garfield/docs/source/Include/Garfield/ComponentVoxel.hh

Classes

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ComponentVoxel()

◆ ~ComponentVoxel()

Member Function Documentation

◆ Clear()

◆ DelayedWeightingField()

◆ DelayedWeightingPotential()

◆ ElectricField() [1/2]

◆ ElectricField() [2/2]

◆ EnableInterpolation()

◆ GetBoundingBox()

◆ GetElectricFieldRange()

◆ GetElement() [1/2]

◆ GetElement() [2/2]

◆ GetElementaryCell()

◆ GetField()

◆ GetMedium() [1/2]

◆ GetMedium() [2/2]

◆ GetVoltageRange()

◆ HasMagneticField()

◆ Initialise()

◆ InitialiseRegions()

◆ LoadData()

◆ LoadElectricField()

◆ LoadMagneticField()

◆ LoadWeightingField() [1/2]

◆ LoadWeightingField() [2/2]

◆ MagneticField()

◆ PrintRegions()

◆ Reduce()

◆ Reset()

◆ SetMedium()

◆ SetMesh()

◆ SetWeightingFieldOffset()

◆ UpdatePeriodicity()

◆ WeightingField()

◆ WeightingPotential()

Member Data Documentation

◆ m_bfields

◆ m_dx

◆ m_dy

◆ m_dz

◆ m_efields

◆ m_hasBfield

◆ m_hasEfield

◆ m_hasMesh

◆ m_hasPotential

◆ m_hasWfield

◆ m_interpolate

◆ m_media

◆ m_nX

◆ m_nY

◆ m_nZ

◆ m_pMax

◆ m_pMin

◆ m_regions

◆ m_wdfields

◆ m_wField_xOffset

◆ m_wField_yOffset

◆ m_wField_zOffset

◆ m_wfields

◆ m_xMax

◆ m_xMin

◆ m_yMax

◆ m_yMin

◆ m_zMax

◆ m_zMin