Garfield::ViewFEMesh Class Reference

Draw the mesh of a field-map component. More...

#include <ViewFEMesh.hh>

Inheritance diagram for Garfield::ViewFEMesh:

Public Member Functions
	ViewFEMesh ()
	Constructor.
	~ViewFEMesh ()=default
	Destructor.
void	SetComponent (ComponentFieldMap *comp)
	Set the component from which to retrieve the mesh and field.
void	SetArea ()
	Set area to be plotted to the default.
void	SetArea (const double xmin, const double ymin, const double zmin, const double xmax, const double ymax, const double zmax)
	Set area to be plotted explicitly.
void	SetDefaultProjection ()
	Reset the projection plane.
void	SetPlane (double fx, double fy, double fz, double x0, double y0, double z0)
	Set the projection plane.
void	SetPlane (double fx, double fy, double fz, double x0, double y0, double z0, double hx, double hy, double hz)
	Set the projection plane specifying hint for in-plane x axis.
void	SetXaxis (TGaxis *ax)
void	SetYaxis (TGaxis *ay)
void	SetXaxisTitle (const char *xtitle)
void	SetYaxisTitle (const char *ytitle)
void	EnableAxes ()
void	DisableAxes ()
bool	Plot ()
	Plot method to be called by user.
void	SetFillMesh (const bool f)
	Element fill switch; 2D only, set false for wireframe mesh.
void	SetDrawViewRegion (bool do_draw)
	Display intersection of projection plane with viewing area.
bool	GetDrawViewRegion (void) const
void	SetColor (int matID, int colorID)
void	SetFillColor (int matID, int colorID)
void	SetViewDrift (ViewDrift *vd)
	Set the optional associated ViewDrift.
void	SetFillMeshWithBorders ()
	Show filled mesh elements.
void	CreateDefaultAxes ()
	Create a default set of custom-made axes.
void	DisableMaterial (int materialID)
	Disable a material so that its mesh cells are not drawn.
Public Member Functions inherited from Garfield::ViewBase
	ViewBase ()=delete
	Default constructor.
	ViewBase (const std::string &name)
	Constructor.
virtual	~ViewBase ()
	Destructor.
void	SetCanvas (TCanvas *c)
	Set the canvas to be painted on.
TCanvas *	GetCanvas ()
	Retrieve the canvas.
void	EnableDebugging (const bool on=true)
	Switch on/off debugging output.

Additional Inherited Members
Protected Member Functions inherited from Garfield::ViewBase
std::string	FindUnusedFunctionName (const std::string &s) const
std::string	FindUnusedHistogramName (const std::string &s) const
Protected Attributes inherited from Garfield::ViewBase
std::string	m_className = "ViewBase"
bool	m_debug = false
TCanvas *	m_canvas = nullptr
bool	m_hasExternalCanvas = false
double	m_proj [3][3]

Detailed Description

Draw the mesh of a field-map component.

Definition at line 26 of file ViewFEMesh.hh.

Constructor & Destructor Documentation

ViewFEMesh()

Garfield::ViewFEMesh::ViewFEMesh

(

)

Constructor.

Definition at line 15 of file ViewFEMesh.cc.

                       : ViewBase("ViewFEMesh") {
  SetDefaultProjection();
 
  // Create a blank histogram for the axes.
  m_axes.reset(new TH2D());
  m_axes->SetStats(false);
  m_axes->GetXaxis()->SetTitle("x");
  m_axes->GetYaxis()->SetTitle("y");
}

~ViewFEMesh()

Garfield::ViewFEMesh::~ViewFEMesh ( )

default

Destructor.

Member Function Documentation

CreateDefaultAxes()

void Garfield::ViewFEMesh::CreateDefaultAxes

(

)

Create a default set of custom-made axes.

Definition at line 194 of file ViewFEMesh.cc.

                                   {
  // Create a new x and y axis.
  const double dx = std::abs(m_xPlaneMax - m_xPlaneMin) * 0.1;
  const double dy = std::abs(m_yPlaneMax - m_yPlaneMin) * 0.1;
  const double x0 = m_xPlaneMin + dx;
  const double y0 = m_yPlaneMin + dy;
  const double x1 = m_xPlaneMax - dx;
  const double y1 = m_yPlaneMax - dy;
  m_xaxis = new TGaxis(x0, y0, x1, y0, x0, x1, 2405, "x");
  m_yaxis = new TGaxis(x0, y0, x0, y1, y0, y1, 2405, "y");
 
  // Label sizes
  m_xaxis->SetLabelSize(0.025);
  m_yaxis->SetLabelSize(0.025);
 
  // Titles
  m_xaxis->SetTitleSize(0.03);
  std::string name = CreateAxisTitle(m_proj[0]);
  m_xaxis->SetTitle(name.c_str());
  m_yaxis->SetTitleSize(0.03);
  name = CreateAxisTitle(m_proj[1]);
  m_yaxis->SetTitle(name.c_str());
}

DisableAxes()

void Garfield::ViewFEMesh::DisableAxes ( )

inline

Definition at line 56 of file ViewFEMesh.hh.

{ m_drawAxes = false; }

DisableMaterial()

void Garfield::ViewFEMesh::DisableMaterial ( int  materialID )

inline

Disable a material so that its mesh cells are not drawn.

Definition at line 88 of file ViewFEMesh.hh.

                                       {
    m_disabledMaterial[materialID] = true;
  }

EnableAxes()

void Garfield::ViewFEMesh::EnableAxes ( )

inline

Definition at line 55 of file ViewFEMesh.hh.

{ m_drawAxes = true; }

Referenced by main().

GetDrawViewRegion()

bool Garfield::ViewFEMesh::GetDrawViewRegion ( void  ) const

inline

Definition at line 66 of file ViewFEMesh.hh.

{ return m_drawViewRegion; }

Plot()

bool Garfield::ViewFEMesh::Plot

(

)

Plot method to be called by user.

Definition at line 71 of file ViewFEMesh.cc.

                      {
  if (!m_component) {
    std::cerr << m_className << "::Plot: Component is not defined.\n";
    return false;
  }
 
  double pmin = 0., pmax = 0.;
  if (!m_component->GetVoltageRange(pmin, pmax)) {
    std::cerr << m_className << "::Plot: Component is not ready.\n";
    return false;
  }
 
  // Get the bounding box.
  if (!m_hasUserArea) {
    std::cerr << m_className << "::Plot:\n"
              << "    Bounding box cannot be determined. Call SetArea first.\n";
    return false;
  }
 
  if (m_viewRegionLines.empty()) {
    std::cerr << m_className << "::Plot:\n"
              << "    Empty view. Make sure the viewing plane (SetPlane)\n"
              << "    intersects with the bounding box.\n";
    return false;
  }
 
  // Set up a canvas if one does not already exist.
  if (!m_canvas) {
    m_canvas = new TCanvas();
    m_canvas->SetTitle(m_label.c_str());
    if (m_hasExternalCanvas) m_hasExternalCanvas = false;
  }
  m_canvas->Range(m_xPlaneMin, m_yPlaneMin, m_xPlaneMax, m_yPlaneMax);
 
  // Plot the elements
  ComponentCST* componentCST = dynamic_cast<ComponentCST*>(m_component);
  if (componentCST) {
    std::cout << m_className << "::Plot: CST component. Calling DrawCST.\n";
    DrawCST(componentCST);
  } else {
    DrawElements();
  }
  m_canvas->Update();
 
  return true;
}

Referenced by main().

SetArea() [1/2]

void Garfield::ViewFEMesh::SetArea

(

)

Set area to be plotted to the default.

Definition at line 67 of file ViewFEMesh.cc.

{ m_hasUserArea = false; }

Referenced by main().

SetArea() [2/2]

void Garfield::ViewFEMesh::SetArea	(	const double	xmin,
		const double	ymin,
		const double	zmin,
		const double	xmax,
		const double	ymax,
		const double	zmax
	)

Set area to be plotted explicitly.

Definition at line 49 of file ViewFEMesh.cc.

                                                   {
  // Check range, assign if non-null
  if (xmin == xmax || ymin == ymax || zmin == zmax) {
    std::cerr << m_className << "::SetArea: Null area range not permitted.\n";
    return;
  }
  m_xMin = std::min(xmin, xmax);
  m_yMin = std::min(ymin, ymax);
  m_zMin = std::min(zmin, zmax);
  m_xMax = std::max(xmin, xmax);
  m_yMax = std::max(ymin, ymax);
  m_zMax = std::max(zmin, zmax);
 
  m_hasUserArea = true;
  IntersectPlaneArea();
}

SetColor()

void Garfield::ViewFEMesh::SetColor ( int  matID, int  colorID  )

inline

Associate a color with each element material map ID; Uses ROOT color numberings

Definition at line 70 of file ViewFEMesh.hh.

{ m_colorMap[matID] = colorID; }

Referenced by main().

SetComponent()

void Garfield::ViewFEMesh::SetComponent

(

ComponentFieldMap *

comp

)

Set the component from which to retrieve the mesh and field.

Definition at line 40 of file ViewFEMesh.cc.

                                                     {
  if (!comp) {
    std::cerr << m_className << "::SetComponent: Null pointer.\n";
    return;
  }
 
  m_component = comp;
}

Referenced by main().

SetDefaultProjection()

void Garfield::ViewFEMesh::SetDefaultProjection

(

)

Reset the projection plane.

Definition at line 25 of file ViewFEMesh.cc.

                                      {
  // Default projection: x-y at z=0
  m_proj[0][0] = 1;
  m_proj[0][1] = 0;
  m_proj[0][2] = 0;
  m_proj[1][0] = 0;
  m_proj[1][1] = 1;
  m_proj[1][2] = 0;
  m_proj[2][0] = 0;
  m_proj[2][1] = 0;
  m_proj[2][2] = 1;
  // Plane distance to (0,0,0)
  m_dist = 0;
}

Referenced by ViewFEMesh().

SetDrawViewRegion()

void Garfield::ViewFEMesh::SetDrawViewRegion ( bool  do_draw )

inline

Display intersection of projection plane with viewing area.

Definition at line 65 of file ViewFEMesh.hh.

{ m_drawViewRegion = do_draw; }

SetFillColor()

void Garfield::ViewFEMesh::SetFillColor ( int  matID, int  colorID  )

inline

Definition at line 71 of file ViewFEMesh.hh.

                                            {
    m_colorMap_fill[matID] = colorID;
  }

SetFillMesh()

void Garfield::ViewFEMesh::SetFillMesh ( const bool  f )

inline

Element fill switch; 2D only, set false for wireframe mesh.

Definition at line 62 of file ViewFEMesh.hh.

{ m_fillMesh = f; }

Referenced by main().

SetFillMeshWithBorders()

void Garfield::ViewFEMesh::SetFillMeshWithBorders ( )

inline

Show filled mesh elements.

Definition at line 79 of file ViewFEMesh.hh.

                                {
    m_plotMeshBorders = true;
    m_fillMesh = true;
  }

SetPlane() [1/2]

void Garfield::ViewFEMesh::SetPlane	(	double	fx,
		double	fy,
		double	fz,
		double	x0,
		double	y0,
		double	z0
	)

Set the projection plane.

Definition at line 120 of file ViewFEMesh.cc.

                                                                             {
  if (fy * fy + fz * fz > 0) {
    SetPlane(fx, fy, fz, x0, y0, z0, 1, 0, 0);
  } else {
    SetPlane(fx, fy, fz, x0, y0, z0, 0, 1, 0);
  }
}

Referenced by main(), and SetPlane().

SetPlane() [2/2]

void Garfield::ViewFEMesh::SetPlane	(	double	fx,
		double	fy,
		double	fz,
		double	x0,
		double	y0,
		double	z0,
		double	hx,
		double	hy,
		double	hz
	)

Set the projection plane specifying hint for in-plane x axis.

Definition at line 130 of file ViewFEMesh.cc.

                                                                             {
  // Calculate 2 in-plane vectors for the normal vector
  double fnorm = sqrt(fx * fx + fy * fy + fz * fz);
  if (fnorm < Small) {
    std::cout << m_className << "::SetPlane:\n"
              << "    Normal vector has zero norm. No new projection set.\n";
    return;
  }
  double dist = (fx * x0 + fy * y0 + fz * z0) / fnorm;
  // Store the plane description
  m_proj[2][0] = fx / fnorm;
  m_proj[2][1] = fy / fnorm;
  m_proj[2][2] = fz / fnorm;
  m_dist = dist;
 
  double xx = hx, xy = hy, xz = hz;
  PlaneVector(xx, xy, xz);
  double vecx_norm = std::sqrt(xx * xx + xy * xy + xz * xz);
  if (vecx_norm < 1.0e-10) {  
    // Wrong in-plane x hint (close to norm).
    if (fy * fy + fz * fz > 0) {
      // Taking global x as in-plane x hint.
      xx = 1;
      xy = 0;
      xz = 0;  
    } else {
      // Taking global y as in-plane x hint.
      xx = 0;
      xy = 1;
      xz = 0;  
    }
    PlaneVector(xx, xy, xz);
    vecx_norm = std::sqrt(xx * xx + xy * xy + xz * xz);
  }
  m_proj[0][0] = xx / vecx_norm;
  m_proj[0][1] = xy / vecx_norm;
  m_proj[0][2] = xz / vecx_norm;
  // in-plane y === m_proj[1] = cross product [z,x];
  m_proj[1][0] = m_proj[2][1] * m_proj[0][2] - m_proj[2][2] * m_proj[0][1];
  m_proj[1][1] = m_proj[2][2] * m_proj[0][0] - m_proj[2][0] * m_proj[0][2];
  m_proj[1][2] = m_proj[2][0] * m_proj[0][1] - m_proj[2][1] * m_proj[0][0];
 
  IntersectPlaneArea();
}

SetViewDrift()

void Garfield::ViewFEMesh::SetViewDrift ( ViewDrift *  vd )

inline

Set the optional associated ViewDrift.

Definition at line 76 of file ViewFEMesh.hh.

{ m_viewDrift = vd; }

Referenced by main().

SetXaxis()

void Garfield::ViewFEMesh::SetXaxis

(

TGaxis *

ax

)

Definition at line 178 of file ViewFEMesh.cc.

{ m_xaxis = ax; }

SetXaxisTitle()

void Garfield::ViewFEMesh::SetXaxisTitle

(

const char *

xtitle

)

Definition at line 184 of file ViewFEMesh.cc.

                                                 {
  if (m_axes) m_axes->GetXaxis()->SetTitle(xtitle);
}

Referenced by main().

SetYaxis()

void Garfield::ViewFEMesh::SetYaxis

(

TGaxis *

ay

)

Definition at line 181 of file ViewFEMesh.cc.

{ m_yaxis = ay; }

SetYaxisTitle()

void Garfield::ViewFEMesh::SetYaxisTitle

(

const char *

ytitle

)

Definition at line 189 of file ViewFEMesh.cc.

                                                 {
  if (m_axes) m_axes->GetYaxis()->SetTitle(ytitle);
}

Referenced by main().

---

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

• ViewFEMesh.hh
• ViewFEMesh.cc