Garfield::ComponentFieldMap Class Reference

Base class for components based on finite-element field maps. More...

#include <ComponentFieldMap.hh>

Inheritance diagram for Garfield::ComponentFieldMap:

Classes
struct	Element
struct	Material
struct	Node
struct	WeightingFieldCopy

Public Member Functions
	ComponentFieldMap ()=delete
	Default constructor.
	ComponentFieldMap (const std::string &name)
	Constructor.
virtual	~ComponentFieldMap ()
	Destructor.
bool	Check ()
	Check element aspect ratio.
void	PrintRange ()
	Show x, y, z, V and angular ranges.
void	PrintMaterials ()
	List all currently defined materials.
void	DriftMedium (const size_t imat)
	Flag a field map material as a drift medium.
void	NotDriftMedium (const size_t imat)
	Flag a field map materials as a non-drift medium.
size_t	GetNumberOfMaterials () const
	Return the number of materials in the field map.
double	GetPermittivity (const size_t imat) const
	Return the relative permittivity of a field map material.
double	GetConductivity (const size_t imat) const
	Return the conductivity of a field map material.
void	SetMedium (const size_t imat, Medium *medium)
	Associate a field map material with a Medium object.
Medium *	GetMedium (const size_t imat) const
	Return the Medium associated to a field map material.
void	SetGas (Medium *medium)
	Associate all field map materials with a relative permittivity of unity to a given Medium class.
size_t	GetNumberOfElements () const override
bool	GetElementNodes (const size_t i, std::vector< size_t > &nodes) const override
bool	GetElementRegion (const size_t i, size_t &mat, bool &drift) const override
bool	GetElement (const size_t i, double &vol, double &dmin, double &dmax) const
	Return the volume and aspect ratio of a mesh element.
size_t	GetNumberOfNodes () const override
bool	GetNode (const size_t i, double &x, double &y, double &z) const override
double	GetPotential (const size_t i) const
	Return the potential at a given node.
void	EnableCheckMapIndices (const bool on=true)
void	EnableDeleteBackgroundElements (const bool on=true)
	Option to eliminate mesh elements in conductors (default: on).
void	EnableTetrahedralTreeForElementSearch (const bool on=true)
	Enable or disable the usage of the tetrahedral tree for searching the element in the mesh.
void	EnableConvergenceWarnings (const bool on=true)
	Enable or disable warnings that the calculation of the local coordinates did not achieve the requested precision.
Medium *	GetMedium (const double x, const double y, const double z) override
void	ElectricField (const double x, const double y, const double z, double &ex, double &ey, double &ez, Medium *&m, int &status) 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
__DEVICE__ 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
double	DelayedWeightingPotential (double x, double y, double z, const double t, const std::string &label) override
void	DelayedWeightingPotentials (const double x, const double y, const double z, const std::string &label, std::vector< double > &dwp) override
bool	IsInBoundingBox (const double x, const double y, const double z) const
bool	Is3d () override
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
std::map< std::string, std::vector< double > >	GetWeightingPotentials ()
bool	GetVoltageRange (double &vmin, double &vmax) override
void	CopyWeightingPotential (const std::string &label, const std::string &labelSource, const double x, const double y, const double z, const double alpha, const double beta, const double gamma)
	Makes a weighting potential copy of a imported map which can be translated and rotated.
double	CreateGPUTransferObject (ComponentGPU *&comp_gpu) override
	Create and initialise GPU Transfer class.

Protected Types
enum class	ElementType { Unknown = 0 , Serendipity = 5 , CurvedTetrahedron = 13 }

Protected Member Functions
void	Reset () override
void	Prepare ()
virtual void	SetRange ()
void	UpdatePeriodicity () override
void	UpdatePeriodicity2d ()
void	UpdatePeriodicityCommon ()
bool	SetDefaultDriftMedium ()
	Find lowest epsilon, check for eps = 0, set default drift media flags.
__DEVICE__ int	Field (const double x, const double y, const double z, double &fx, double &fy, double &fz, int &iel, const std::vector< double > &potentials) const
	Compute the electric/weighting field.
double	Potential (const double x, const double y, const double z, const std::vector< double > &potentials) const
	Compute the electrostatic/weighting potential.
int	FindElement5 (const double x, const double y, double &t1, double &t2, double &t3, double &t4, double jac[4][4], double &det) const
	Find the element for a point in curved quadratic quadrilaterals.
__DEVICE__ int	FindElement13 (const double x, const double y, const double z, double &t1, double &t2, double &t3, double &t4, double jac[4][4], double &det) const
	Find the element for a point in curved quadratic tetrahedra.
int	FindElementCube (const double x, const double y, const double z, double &t1, double &t2, double &t3, TMatrixD *&jac, std::vector< TMatrixD * > &dN) const
	Find the element for a point in a cube.
__DEVICE__ void	MapCoordinates (double &xpos, double &ypos, double &zpos, bool &xmirrored, bool &ymirrored, bool &zmirrored, double &rcoordinate, double &rotation) const
	Move (xpos, ypos, zpos) to field map coordinates.
__DEVICE__ void	UnmapFields (double &ex, double &ey, double &ez, const double xpos, const double ypos, const double zpos, const bool xmirrored, const bool ymirrored, const bool zmirrored, const double rcoordinate, const double rotation) const
	Move (ex, ey, ez) to global coordinates.
virtual double	GetElementVolume (const size_t i) const
virtual void	GetAspectRatio (const size_t i, double &dmin, double &dmax) const
void	PrintWarning (const std::string &header)
void	PrintNotReady (const std::string &header) const
void	PrintCouldNotOpen (const std::string &header, const std::string &filename) const
void	PrintElement (const std::string &header, const double x, const double y, const double z, const double t1, const double t2, const double t3, const double t4, const size_t i, const std::vector< double > &potential) const
void	TimeInterpolation (const double t, double &f0, double &f1, int &i0, int &i1)
	Interpolation of potential between two time slices.
int	Coordinates3 (const double x, const double y, double &t1, double &t2, double &t3, double &t4, double jac[4][4], double &det, const std::array< double, 8 > &xn, const std::array< double, 8 > &yn) const
	Calculate local coordinates for curved quadratic triangles.
int	Coordinates4 (const double x, const double y, double &t1, double &t2, double &t3, double &t4, double &det, const std::array< double, 8 > &xn, const std::array< double, 8 > &yn) const
	Calculate local coordinates for linear quadrilaterals.
int	Coordinates5 (const double x, const double y, double &t1, double &t2, double &t3, double &t4, double jac[4][4], double &det, const std::array< double, 8 > &xn, const std::array< double, 8 > &yn) const
	Calculate local coordinates for curved quadratic quadrilaterals.
__DEVICE__ void	Coordinates12 (const double x, const double y, const double z, double &t1, double &t2, double &t3, double &t4, const std::array< double, 10 > &xn, const std::array< double, 10 > &yn, const std::array< double, 10 > &zn, const std::array< std::array< double, 3 >, 4 > &w) const
	Calculate local coordinates in linear tetrahedra.
__DEVICE__ int	Coordinates13 (const double x, const double y, const double z, double &t1, double &t2, double &t3, double &t4, double jac[4][4], double &det, const std::array< double, 10 > &xn, const std::array< double, 10 > &yn, const std::array< double, 10 > &zn, const std::array< std::array< double, 3 >, 4 > &w) const
	Calculate local coordinates for curved quadratic tetrahedra.
int	CoordinatesCube (const double x, const double y, const double z, double &t1, double &t2, double &t3, TMatrixD *&jac, std::vector< TMatrixD * > &dN, const Element &element) const
	Calculate local coordinates for a cube.
void	JacobianCube (const Element &element, const double t1, const double t2, const double t3, TMatrixD *&jac, std::vector< TMatrixD * > &dN) const
	Calculate Jacobian for a cube.
void	CalculateElementBoundingBoxes ()
	Calculate the bounding boxes of all elements after initialization.
bool	InitializeTetrahedralTree ()
	Initialize the tetrahedral tree.

Static Protected Member Functions
static double	ScalingFactor (std::string unit)
static double	Potential3 (const std::array< double, 6 > &v, const std::array< double, 3 > &t)
	Interpolate the potential in a triangle.
static void	Field3 (const std::array< double, 6 > &v, const std::array< double, 3 > &t, double jac[4][4], const double det, double &ex, double &ey)
	Interpolate the field in a triangle.
static double	Potential5 (const std::array< double, 8 > &v, const std::array< double, 2 > &t)
	Interpolate the potential in a curved quadrilateral.
static void	Field5 (const std::array< double, 8 > &v, const std::array< double, 2 > &t, double jac[4][4], const double det, double &ex, double &ey)
	Interpolate the field in a curved quadrilateral.
static double	Potential13 (const std::array< double, 10 > &v, const std::array< double, 4 > &t)
	Interpolate the potential in a curved quadratic tetrahedron.
static __DEVICE__ void	Field13 (const std::array< double, 10 > &v, const std::array< double, 4 > &t, double jac[4][4], const double det, double &ex, double &ey, double &ez)
	Interpolate the field in a curved quadratic tetrahedron.
static int	ReadInteger (char *token, int def, bool &error)
static double	ReadDouble (char *token, double def, bool &error)
static void	Jacobian3 (const std::array< double, 8 > &xn, const std::array< double, 8 > &yn, const double u, const double v, const double w, double &det, double jac[4][4])
	Calculate Jacobian for curved quadratic triangles.
static void	Jacobian5 (const std::array< double, 8 > &xn, const std::array< double, 8 > &yn, const double u, const double v, double &det, double jac[4][4])
	Calculate Jacobian for curved quadratic quadrilaterals.
static __DEVICE__ void	Jacobian13 (const std::array< double, 10 > &xn, const std::array< double, 10 > &yn, const std::array< double, 10 > &zn, const double fourt0, const double fourt1, const double fourt2, const double fourt3, double &det, double jac[4][4])
	Calculate Jacobian for curved quadratic tetrahedra.
static std::array< std::array< double, 3 >, 4 >	Weights12 (const std::array< double, 10 > &xn, const std::array< double, 10 > &yn, const std::array< double, 10 > &zn)

Protected Attributes
bool	m_is3d = true
ElementType	m_elementType = ElementType::CurvedTetrahedron
std::vector< Element >	m_elements
std::vector< int >	m_elementIndices
std::vector< bool >	m_degenerate
std::vector< std::array< double, 3 > >	m_bbMin
std::vector< std::array< double, 3 > >	m_bbMax
std::vector< std::array< std::array< double, 3 >, 4 > >	m_w12
std::vector< Node >	m_nodes
std::vector< double >	m_pot
std::map< std::string, std::vector< double > >	m_wpot
std::map< std::string, std::vector< std::vector< double > > >	m_dwpot
std::vector< Material >	m_materials
std::map< std::string, WeightingFieldCopy >	m_wfieldCopies
bool	m_hasBoundingBox = false
std::array< double, 3 >	m_minBoundingBox = {{0., 0., 0.}}
std::array< double, 3 >	m_maxBoundingBox = {{0., 0., 0.}}
bool	m_cacheElemBoundingBoxes = false
	Flag to check if bounding boxes of elements are cached.
std::array< double, 3 >	m_mapmin = {{0., 0., 0.}}
std::array< double, 3 >	m_mapmax = {{0., 0., 0.}}
std::array< double, 3 >	m_mapamin = {{0., 0., 0.}}
std::array< double, 3 >	m_mapamax = {{0., 0., 0.}}
std::array< double, 3 >	m_mapna = {{0., 0., 0.}}
std::array< double, 3 >	m_cells = {{0., 0., 0.}}
double	m_mapvmin = 0.
double	m_mapvmax = 0.
std::array< bool, 3 >	m_setang
bool	m_deleteBackground = true
bool	m_warning = false
unsigned int	m_nWarnings = 0
bool	m_printConvergenceWarnings = true
bool	m_checkMultipleElement = false
	Scan for multiple elements that contain a point.
bool	m_useTetrahedralTree = true
std::unique_ptr< GARFIELD_CLASS_NAME(TetrahedralTree)>	m_octree

Detailed Description

Base class for components based on finite-element field maps.

Definition at line 29 of file ComponentFieldMap.hh.

Member Enumeration Documentation

ElementType

enum class Garfield::ComponentFieldMap::ElementType

strongprotected

Enumerator
Unknown
Serendipity
CurvedTetrahedron

Definition at line 163 of file ComponentFieldMap.hh.

                         {
    Unknown = 0,
    Serendipity = 5,
    CurvedTetrahedron = 13
  };

Constructor & Destructor Documentation

ComponentFieldMap() [1/2]

Garfield::ComponentFieldMap::ComponentFieldMap ( )

delete

Default constructor.

ComponentFieldMap() [2/2]

Garfield::ComponentFieldMap::ComponentFieldMap

(

const std::string &

name

)

Constructor.

~ComponentFieldMap()

virtual Garfield::ComponentFieldMap::~ComponentFieldMap ( )

virtual

Destructor.

Member Function Documentation

CalculateElementBoundingBoxes()

void Garfield::ComponentFieldMap::CalculateElementBoundingBoxes ( )

protected

Calculate the bounding boxes of all elements after initialization.

Check()

bool Garfield::ComponentFieldMap::Check

(

)

Check element aspect ratio.

Coordinates12()

__DEVICE__ void Garfield::ComponentFieldMap::Coordinates12 ( const double x, const double y, const double z, double & t1, double & t2, double & t3, double & t4, const std::array< double, 10 > & xn, const std::array< double, 10 > & yn, const std::array< double, 10 > & zn, const std::array< std::array< double, 3 >, 4 > & w ) const

protected

Calculate local coordinates in linear tetrahedra.

Coordinates13()

__DEVICE__ int Garfield::ComponentFieldMap::Coordinates13 ( const double x, const double y, const double z, double & t1, double & t2, double & t3, double & t4, double jac[4][4], double & det, const std::array< double, 10 > & xn, const std::array< double, 10 > & yn, const std::array< double, 10 > & zn, const std::array< std::array< double, 3 >, 4 > & w ) const

protected

Calculate local coordinates for curved quadratic tetrahedra.

Coordinates3()

int Garfield::ComponentFieldMap::Coordinates3 ( const double x, const double y, double & t1, double & t2, double & t3, double & t4, double jac[4][4], double & det, const std::array< double, 8 > & xn, const std::array< double, 8 > & yn ) const

protected

Calculate local coordinates for curved quadratic triangles.

Coordinates4()

int Garfield::ComponentFieldMap::Coordinates4 ( const double x, const double y, double & t1, double & t2, double & t3, double & t4, double & det, const std::array< double, 8 > & xn, const std::array< double, 8 > & yn ) const

protected

Calculate local coordinates for linear quadrilaterals.

Coordinates5()

int Garfield::ComponentFieldMap::Coordinates5 ( const double x, const double y, double & t1, double & t2, double & t3, double & t4, double jac[4][4], double & det, const std::array< double, 8 > & xn, const std::array< double, 8 > & yn ) const

protected

Calculate local coordinates for curved quadratic quadrilaterals.

CoordinatesCube()

int Garfield::ComponentFieldMap::CoordinatesCube ( const double x, const double y, const double z, double & t1, double & t2, double & t3, TMatrixD *& jac, std::vector< TMatrixD * > & dN, const Element & element ) const

protected

Calculate local coordinates for a cube.

CopyWeightingPotential()

void Garfield::ComponentFieldMap::CopyWeightingPotential	(	const std::string &	label,
		const std::string &	labelSource,
		const double	x,
		const double	y,
		const double	z,
		const double	alpha,
		const double	beta,
		const double	gamma )

Makes a weighting potential copy of a imported map which can be translated and rotated.

Parameters

label	name of new electrode
labelSource	name of the source electrode that will be copied
x	translation in the x-direction.
y	translation in the y-direction.
z	translation in the z-direction.
alpha	rotation around the x-axis.
beta	rotation around the y-axis.
gamma	rotation around the z-axis.

CreateGPUTransferObject()

double Garfield::ComponentFieldMap::CreateGPUTransferObject ( ComponentGPU *& comp_gpu )

override

Create and initialise GPU Transfer class.

DelayedWeightingPotential()

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

override

DelayedWeightingPotentials()

void Garfield::ComponentFieldMap::DelayedWeightingPotentials ( const double x, const double y, const double z, const std::string & label, std::vector< double > & dwp )

override

DriftMedium()

void Garfield::ComponentFieldMap::DriftMedium

(

const size_t

imat

)

Flag a field map material as a drift medium.

ElectricField() [1/2]

void Garfield::ComponentFieldMap::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::ComponentFieldMap::ElectricField ( const double x, const double y, const double z, double & ex, double & ey, double & ez, Medium *& m, int & status )

override

EnableCheckMapIndices()

void Garfield::ComponentFieldMap::EnableCheckMapIndices ( const bool on = true )

inline

Definition at line 79 of file ComponentFieldMap.hh.

                                                   {
    m_checkMultipleElement = on;
  }

EnableConvergenceWarnings()

void Garfield::ComponentFieldMap::EnableConvergenceWarnings ( const bool on = true )

inline

Enable or disable warnings that the calculation of the local coordinates did not achieve the requested precision.

Definition at line 95 of file ComponentFieldMap.hh.

                                                       {
    m_printConvergenceWarnings = on;
  }

EnableDeleteBackgroundElements()

void Garfield::ComponentFieldMap::EnableDeleteBackgroundElements ( const bool on = true )

inline

Option to eliminate mesh elements in conductors (default: on).

Definition at line 83 of file ComponentFieldMap.hh.

                                                            {
    m_deleteBackground = on;
  }

EnableTetrahedralTreeForElementSearch()

void Garfield::ComponentFieldMap::EnableTetrahedralTreeForElementSearch ( const bool on = true )

inline

Enable or disable the usage of the tetrahedral tree for searching the element in the mesh.

Definition at line 89 of file ComponentFieldMap.hh.

                                                                   {
    m_useTetrahedralTree = on;
  }

Field()

__DEVICE__ int Garfield::ComponentFieldMap::Field ( const double x, const double y, const double z, double & fx, double & fy, double & fz, int & iel, const std::vector< double > & potentials ) const

protected

Compute the electric/weighting field.

Field13()

__DEVICE__ void Garfield::ComponentFieldMap::Field13 ( const std::array< double, 10 > & v, const std::array< double, 4 > & t, double jac[4][4], const double det, double & ex, double & ey, double & ez )

staticprotected

Interpolate the field in a curved quadratic tetrahedron.

Field3()

void Garfield::ComponentFieldMap::Field3 ( const std::array< double, 6 > & v, const std::array< double, 3 > & t, double jac[4][4], const double det, double & ex, double & ey )

staticprotected

Interpolate the field in a triangle.

Field5()

void Garfield::ComponentFieldMap::Field5 ( const std::array< double, 8 > & v, const std::array< double, 2 > & t, double jac[4][4], const double det, double & ex, double & ey )

staticprotected

Interpolate the field in a curved quadrilateral.

FindElement13()

__DEVICE__ int Garfield::ComponentFieldMap::FindElement13 ( const double x, const double y, const double z, double & t1, double & t2, double & t3, double & t4, double jac[4][4], double & det ) const

protected

Find the element for a point in curved quadratic tetrahedra.

FindElement5()

int Garfield::ComponentFieldMap::FindElement5 ( const double x, const double y, double & t1, double & t2, double & t3, double & t4, double jac[4][4], double & det ) const

protected

Find the element for a point in curved quadratic quadrilaterals.

FindElementCube()

int Garfield::ComponentFieldMap::FindElementCube ( const double x, const double y, const double z, double & t1, double & t2, double & t3, TMatrixD *& jac, std::vector< TMatrixD * > & dN ) const

protected

Find the element for a point in a cube.

GetAspectRatio()

virtual void Garfield::ComponentFieldMap::GetAspectRatio ( const size_t i, double & dmin, double & dmax ) const

protectedvirtual

Reimplemented in Garfield::ComponentCST.

GetBoundingBox()

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

override

GetConductivity()

double Garfield::ComponentFieldMap::GetConductivity

(

const size_t

imat

)

const

Return the conductivity of a field map material.

GetElement()

bool Garfield::ComponentFieldMap::GetElement	(	const size_t	i,
		double &	vol,
		double &	dmin,
		double &	dmax ) const

Return the volume and aspect ratio of a mesh element.

GetElementaryCell()

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

override

GetElementNodes()

bool Garfield::ComponentFieldMap::GetElementNodes ( const size_t i, std::vector< size_t > & nodes ) const

override

GetElementRegion()

bool Garfield::ComponentFieldMap::GetElementRegion ( const size_t i, size_t & mat, bool & drift ) const

override

GetElementVolume()

virtual double Garfield::ComponentFieldMap::GetElementVolume ( const size_t i ) const

protectedvirtual

Reimplemented in Garfield::ComponentCST.

GetMedium() [1/2]

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

override

GetMedium() [2/2]

Medium * Garfield::ComponentFieldMap::GetMedium

(

const size_t

imat

)

const

Return the Medium associated to a field map material.

GetNode()

bool Garfield::ComponentFieldMap::GetNode ( const size_t i, double & x, double & y, double & z ) const

override

GetNumberOfElements()

size_t Garfield::ComponentFieldMap::GetNumberOfElements ( ) const

inlineoverride

Definition at line 65 of file ComponentFieldMap.hh.

{ return m_elements.size(); }

GetNumberOfMaterials()

size_t Garfield::ComponentFieldMap::GetNumberOfMaterials ( ) const

inline

Return the number of materials in the field map.

Definition at line 51 of file ComponentFieldMap.hh.

{ return m_materials.size(); }

GetNumberOfNodes()

size_t Garfield::ComponentFieldMap::GetNumberOfNodes ( ) const

inlineoverride

Definition at line 73 of file ComponentFieldMap.hh.

{ return m_nodes.size(); }

GetPermittivity()

double Garfield::ComponentFieldMap::GetPermittivity

(

const size_t

imat

)

const

Return the relative permittivity of a field map material.

GetPotential()

double Garfield::ComponentFieldMap::GetPotential

(

const size_t

i

)

const

Return the potential at a given node.

GetVoltageRange()

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

inlineoverride

Definition at line 139 of file ComponentFieldMap.hh.

                                                          {
  vmin = m_mapvmin;
  vmax = m_mapvmax;
  return true;
}

GetWeightingPotentials()

std::map< std::string, std::vector< double > > Garfield::ComponentFieldMap::GetWeightingPotentials ( )

inline

Definition at line 135 of file ComponentFieldMap.hh.

                                                               {
  return m_wpot;
}

InitializeTetrahedralTree()

bool Garfield::ComponentFieldMap::InitializeTetrahedralTree ( )

protected

Initialize the tetrahedral tree.

Is3d()

bool Garfield::ComponentFieldMap::Is3d ( )

inlineoverride

Definition at line 129 of file ComponentFieldMap.hh.

{ return m_is3d; }

IsInBoundingBox()

bool Garfield::ComponentFieldMap::IsInBoundingBox ( const double x, const double y, const double z ) const

inline

Definition at line 123 of file ComponentFieldMap.hh.

                                                                           {
  return x >= m_minBoundingBox[0] && x <= m_maxBoundingBox[0] &&
         y >= m_minBoundingBox[1] && y <= m_maxBoundingBox[1] &&
         z >= m_minBoundingBox[2] && y <= m_maxBoundingBox[2];
}

Jacobian13()

__DEVICE__ void Garfield::ComponentFieldMap::Jacobian13 ( const std::array< double, 10 > & xn, const std::array< double, 10 > & yn, const std::array< double, 10 > & zn, const double fourt0, const double fourt1, const double fourt2, const double fourt3, double & det, double jac[4][4] )

staticprotected

Calculate Jacobian for curved quadratic tetrahedra.

Jacobian3()

void Garfield::ComponentFieldMap::Jacobian3 ( const std::array< double, 8 > & xn, const std::array< double, 8 > & yn, const double u, const double v, const double w, double & det, double jac[4][4] )

staticprotected

Calculate Jacobian for curved quadratic triangles.

Jacobian5()

void Garfield::ComponentFieldMap::Jacobian5 ( const std::array< double, 8 > & xn, const std::array< double, 8 > & yn, const double u, const double v, double & det, double jac[4][4] )

staticprotected

Calculate Jacobian for curved quadratic quadrilaterals.

JacobianCube()

void Garfield::ComponentFieldMap::JacobianCube ( const Element & element, const double t1, const double t2, const double t3, TMatrixD *& jac, std::vector< TMatrixD * > & dN ) const

protected

Calculate Jacobian for a cube.

MapCoordinates()

__DEVICE__ void Garfield::ComponentFieldMap::MapCoordinates ( double & xpos, double & ypos, double & zpos, bool & xmirrored, bool & ymirrored, bool & zmirrored, double & rcoordinate, double & rotation ) const

protected

Move (xpos, ypos, zpos) to field map coordinates.

NotDriftMedium()

void Garfield::ComponentFieldMap::NotDriftMedium

(

const size_t

imat

)

Flag a field map materials as a non-drift medium.

Potential()

double Garfield::ComponentFieldMap::Potential ( const double x, const double y, const double z, const std::vector< double > & potentials ) const

protected

Compute the electrostatic/weighting potential.

Potential13()

double Garfield::ComponentFieldMap::Potential13 ( const std::array< double, 10 > & v, const std::array< double, 4 > & t )

staticprotected

Interpolate the potential in a curved quadratic tetrahedron.

Potential3()

double Garfield::ComponentFieldMap::Potential3 ( const std::array< double, 6 > & v, const std::array< double, 3 > & t )

staticprotected

Interpolate the potential in a triangle.

Potential5()

double Garfield::ComponentFieldMap::Potential5 ( const std::array< double, 8 > & v, const std::array< double, 2 > & t )

staticprotected

Interpolate the potential in a curved quadrilateral.

Prepare()

void Garfield::ComponentFieldMap::Prepare ( )

protected

PrintCouldNotOpen()

void Garfield::ComponentFieldMap::PrintCouldNotOpen ( const std::string & header, const std::string & filename ) const

protected

PrintElement()

void Garfield::ComponentFieldMap::PrintElement ( const std::string & header, const double x, const double y, const double z, const double t1, const double t2, const double t3, const double t4, const size_t i, const std::vector< double > & potential ) const

protected

PrintMaterials()

void Garfield::ComponentFieldMap::PrintMaterials

(

)

List all currently defined materials.

PrintNotReady()

void Garfield::ComponentFieldMap::PrintNotReady ( const std::string & header ) const

protected

PrintRange()

void Garfield::ComponentFieldMap::PrintRange

(

)

Show x, y, z, V and angular ranges.

PrintWarning()

void Garfield::ComponentFieldMap::PrintWarning ( const std::string & header )

protected

ReadDouble()

double Garfield::ComponentFieldMap::ReadDouble ( char * token, double def, bool & error )

staticprotected

ReadInteger()

int Garfield::ComponentFieldMap::ReadInteger ( char * token, int def, bool & error )

staticprotected

Reset()

void Garfield::ComponentFieldMap::Reset ( )

overrideprotected

ScalingFactor()

double Garfield::ComponentFieldMap::ScalingFactor ( std::string unit )

staticprotected

SetDefaultDriftMedium()

bool Garfield::ComponentFieldMap::SetDefaultDriftMedium ( )

protected

Find lowest epsilon, check for eps = 0, set default drift media flags.

SetGas()

void Garfield::ComponentFieldMap::SetGas

(

Medium *

medium

)

Associate all field map materials with a relative permittivity of unity to a given Medium class.

SetMedium()

void Garfield::ComponentFieldMap::SetMedium	(	const size_t	imat,
		Medium *	medium )

Associate a field map material with a Medium object.

SetRange()

virtual void Garfield::ComponentFieldMap::SetRange ( )

protectedvirtual

Reimplemented in Garfield::ComponentCST.

TimeInterpolation()

void Garfield::ComponentFieldMap::TimeInterpolation ( const double t, double & f0, double & f1, int & i0, int & i1 )

protected

Interpolation of potential between two time slices.

UnmapFields()

__DEVICE__ void Garfield::ComponentFieldMap::UnmapFields ( double & ex, double & ey, double & ez, const double xpos, const double ypos, const double zpos, const bool xmirrored, const bool ymirrored, const bool zmirrored, const double rcoordinate, const double rotation ) const

protected

Move (ex, ey, ez) to global coordinates.

UpdatePeriodicity()

void Garfield::ComponentFieldMap::UpdatePeriodicity ( )

inlineoverrideprotected

Definition at line 327 of file ComponentFieldMap.hh.

                                    {
    if (!m_is3d) UpdatePeriodicity2d();
    UpdatePeriodicityCommon();
  }

UpdatePeriodicity2d()

void Garfield::ComponentFieldMap::UpdatePeriodicity2d ( )

protected

UpdatePeriodicityCommon()

void Garfield::ComponentFieldMap::UpdatePeriodicityCommon ( )

protected

WeightingField()

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

override

WeightingPotential()

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

override

Weights12()

std::array< std::array< double, 3 >, 4 > Garfield::ComponentFieldMap::Weights12 ( const std::array< double, 10 > & xn, const std::array< double, 10 > & yn, const std::array< double, 10 > & zn )

staticprotected

Member Data Documentation

m_bbMax

std::vector<std::array<double, 3> > Garfield::ComponentFieldMap::m_bbMax

protected

Definition at line 199 of file ComponentFieldMap.hh.

m_bbMin

std::vector<std::array<double, 3> > Garfield::ComponentFieldMap::m_bbMin

protected

Definition at line 198 of file ComponentFieldMap.hh.

m_cacheElemBoundingBoxes

bool Garfield::ComponentFieldMap::m_cacheElemBoundingBoxes = false

protected

Flag to check if bounding boxes of elements are cached.

Definition at line 279 of file ComponentFieldMap.hh.

m_cells

std::array<double, 3> Garfield::ComponentFieldMap::m_cells = {{0., 0., 0.}}

protected

Definition at line 297 of file ComponentFieldMap.hh.

{{0., 0., 0.}};

m_checkMultipleElement

bool Garfield::ComponentFieldMap::m_checkMultipleElement = false

protected

Scan for multiple elements that contain a point.

Definition at line 429 of file ComponentFieldMap.hh.

m_degenerate

std::vector<bool> Garfield::ComponentFieldMap::m_degenerate

protected

Definition at line 190 of file ComponentFieldMap.hh.

m_deleteBackground

bool Garfield::ComponentFieldMap::m_deleteBackground = true

protected

Definition at line 305 of file ComponentFieldMap.hh.

m_dwpot

std::map<std::string, std::vector<std::vector<double> > > Garfield::ComponentFieldMap::m_dwpot

protected

Definition at line 227 of file ComponentFieldMap.hh.

m_elementIndices

std::vector<int> Garfield::ComponentFieldMap::m_elementIndices

protected

Definition at line 183 of file ComponentFieldMap.hh.

m_elements

std::vector<Element> Garfield::ComponentFieldMap::m_elements

protected

Definition at line 182 of file ComponentFieldMap.hh.

m_elementType

ElementType Garfield::ComponentFieldMap::m_elementType = ElementType::CurvedTetrahedron

protected

Definition at line 168 of file ComponentFieldMap.hh.

m_hasBoundingBox

bool Garfield::ComponentFieldMap::m_hasBoundingBox = false

protected

Definition at line 274 of file ComponentFieldMap.hh.

m_is3d

bool Garfield::ComponentFieldMap::m_is3d = true

protected

Definition at line 161 of file ComponentFieldMap.hh.

m_mapamax

std::array<double, 3> Garfield::ComponentFieldMap::m_mapamax = {{0., 0., 0.}}

protected

Definition at line 292 of file ComponentFieldMap.hh.

{{0., 0., 0.}};

m_mapamin

std::array<double, 3> Garfield::ComponentFieldMap::m_mapamin = {{0., 0., 0.}}

protected

Definition at line 291 of file ComponentFieldMap.hh.

{{0., 0., 0.}};

m_mapmax

std::array<double, 3> Garfield::ComponentFieldMap::m_mapmax = {{0., 0., 0.}}

protected

Definition at line 290 of file ComponentFieldMap.hh.

{{0., 0., 0.}};

m_mapmin

std::array<double, 3> Garfield::ComponentFieldMap::m_mapmin = {{0., 0., 0.}}

protected

Definition at line 289 of file ComponentFieldMap.hh.

{{0., 0., 0.}};

m_mapna

std::array<double, 3> Garfield::ComponentFieldMap::m_mapna = {{0., 0., 0.}}

protected

Definition at line 296 of file ComponentFieldMap.hh.

{{0., 0., 0.}};

m_mapvmax

double Garfield::ComponentFieldMap::m_mapvmax = 0.

protected

Definition at line 300 of file ComponentFieldMap.hh.

m_mapvmin

double Garfield::ComponentFieldMap::m_mapvmin = 0.

protected

Definition at line 299 of file ComponentFieldMap.hh.

m_materials

std::vector<Material> Garfield::ComponentFieldMap::m_materials

protected

Definition at line 258 of file ComponentFieldMap.hh.

m_maxBoundingBox

std::array<double, 3> Garfield::ComponentFieldMap::m_maxBoundingBox = {{0., 0., 0.}}

protected

Definition at line 276 of file ComponentFieldMap.hh.

{{0., 0., 0.}};

m_minBoundingBox

std::array<double, 3> Garfield::ComponentFieldMap::m_minBoundingBox = {{0., 0., 0.}}

protected

Definition at line 275 of file ComponentFieldMap.hh.

{{0., 0., 0.}};

m_nodes

std::vector<Node> Garfield::ComponentFieldMap::m_nodes

protected

Definition at line 217 of file ComponentFieldMap.hh.

m_nWarnings

unsigned int Garfield::ComponentFieldMap::m_nWarnings = 0

protected

Definition at line 309 of file ComponentFieldMap.hh.

m_octree

std::unique_ptr<GARFIELD_CLASS_NAME(TetrahedralTree)> Garfield::ComponentFieldMap::m_octree

protected

Definition at line 436 of file ComponentFieldMap.hh.

m_pot

std::vector<double> Garfield::ComponentFieldMap::m_pot

protected

Definition at line 223 of file ComponentFieldMap.hh.

m_printConvergenceWarnings

bool Garfield::ComponentFieldMap::m_printConvergenceWarnings = true

protected

Definition at line 313 of file ComponentFieldMap.hh.

m_setang

std::array<bool, 3> Garfield::ComponentFieldMap::m_setang

protected

Definition at line 302 of file ComponentFieldMap.hh.

m_useTetrahedralTree

bool Garfield::ComponentFieldMap::m_useTetrahedralTree = true

protected

Definition at line 432 of file ComponentFieldMap.hh.

m_w12

std::vector<std::array<std::array<double, 3>, 4> > Garfield::ComponentFieldMap::m_w12

protected

Definition at line 205 of file ComponentFieldMap.hh.

m_warning

bool Garfield::ComponentFieldMap::m_warning = false

protected

Definition at line 308 of file ComponentFieldMap.hh.

m_wfieldCopies

std::map<std::string, WeightingFieldCopy> Garfield::ComponentFieldMap::m_wfieldCopies

protected

Definition at line 271 of file ComponentFieldMap.hh.

m_wpot

std::map<std::string, std::vector<double> > Garfield::ComponentFieldMap::m_wpot

protected

Definition at line 225 of file ComponentFieldMap.hh.

---

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

• /builds/garfield/docs/source/Include/Garfield/ComponentFieldMap.hh