neBEM Namespace Reference

Functions
int	neBEMSetDefaults (void)
	Assign default values to some of the important global variables.
int	ReadInitFile (char filename[])
int	neBEMGetInputsFromFiles (void)
	Do-nothing function (no file inputs).
int	neBEMGetNbPrimitives ()
	Return the number of primitives.
int	neBEMGetPrimitive (int prim, int *nvertex, double xvert[], double yvert[], double zvert[], double *xnorm, double *ynorm, double *znorm, int *volref1, int *volref2)
	Return one primitive at a time.
int	neBEMGetPeriodicities (int, int *ix, int *jx, double *sx, int *iy, int *jy, double *sy, int *iz, int *jz, double *sz)
int	neBEMGetMirror (int, int *ix, int *jx, double *sx, int *iy, int *jy, double *sy, int *iz, int *jz, double *sz)
int	neBEMGetBoundingPlanes (int *ixmin, double *cxmin, double *vxmin, int *ixmax, double *cxmax, double *vxmax, int *iymin, double *cymin, double *vymin, int *iymax, double *cymax, double *vymax, int *izmin, double *czmin, double *vzmin, int *izmax, double *czmax, double *vzmax)
int	neBEMVolumeDescription (int vol, int *shape, int *material, double *epsilon, double *potential, double *charge, int *boundarytype)
	Return information about a volume.
int	neBEMVolumePoint (double x, double y, double z)
	Return the volume in which a point is located.
void	neBEMVolumePrimitives (int, int *, int[])

Function Documentation

neBEMGetBoundingPlanes()

int neBEM::neBEMGetBoundingPlanes	(	int *	ixmin,
		double *	cxmin,
		double *	vxmin,
		int *	ixmax,
		double *	cxmax,
		double *	vxmax,
		int *	iymin,
		double *	cymin,
		double *	vymin,
		int *	iymax,
		double *	cymax,
		double *	vymax,
		int *	izmin,
		double *	czmin,
		double *	vzmin,
		int *	izmax,
		double *	czmax,
		double *	vzmax )

Return infinite (bounding) conductors if any. ixmin=0: lower x-plane does not exist ixmin=1: lower x-plane does exist cxmin: coordinate of lower x-plane vxmin: potential of lower x-plane Similar for ixmax, iymin, iymax, izmin, izmax

Definition at line 308 of file NeBemInterface.cpp.

                                                         {
  if (!Garfield::gComponentNeBem3d) return -1;
  *ixmin = *ixmax = 0;
  *vxmin = *vxmax = 0.;
  *cxmin = *cxmax = 0.;
  const unsigned int nx = Garfield::gComponentNeBem3d->GetNumberOfPlanesX();
  for (unsigned int i = 0; i < nx; ++i) {
    double x = 0., v = 0.;
    Garfield::gComponentNeBem3d->GetPlaneX(i, x, v);
    if (i == 0) {
      *ixmin = 1;
      *vxmin = v;
      *cxmin = x;
    } else {
      *ixmax = 1;
      *vxmax = v;
      *cxmax = x;
    }
  }
  *iymin = *iymax = 0;
  *vymin = *vymax = 0.;
  *cymin = *cymax = 0.;
  const unsigned int ny = Garfield::gComponentNeBem3d->GetNumberOfPlanesY();
  for (unsigned int i = 0; i < ny; ++i) {
    double y = 0., v = 0.;
    Garfield::gComponentNeBem3d->GetPlaneY(i, y, v);
    if (i == 0) {
      *iymin = 1;
      *vymin = v;
      *cymin = y;
    } else {
      *iymax = 1;
      *vymax = v;
      *cymax = y;
    }
  }
  *izmin = *izmax = 0;
  *vzmin = *vzmax = 0.;
  *czmin = *czmax = 0.;
  const unsigned int nz = Garfield::gComponentNeBem3d->GetNumberOfPlanesZ();
  for (unsigned int i = 0; i < nz; ++i) {
    double z = 0., v = 0.;
    Garfield::gComponentNeBem3d->GetPlaneZ(i, z, v);
    if (i == 0) {
      *izmin = 1;
      *vzmin = v;
      *czmin = z;
    } else {
      *izmax = 1;
      *vzmax = v;
      *czmax = z;
    }
  }
  // Convert from cm to m.
  *cxmin *= 0.01;
  *cxmax *= 0.01;
  *cymin *= 0.01;
  *cymax *= 0.01;
  *czmin *= 0.01;
  *czmax *= 0.01;
 
  return 0;
}

Referenced by neBEMReadGeometry().

neBEMGetInputsFromFiles()

int neBEM::neBEMGetInputsFromFiles

(

void

)

Do-nothing function (no file inputs).

Definition at line 189 of file NeBemInterface.cpp.

{ return 0; } 

Referenced by neBEMInitialize().

neBEMGetMirror()

int neBEM::neBEMGetMirror	(	int	,
		int *	ix,
		int *	jx,
		double *	sx,
		int *	iy,
		int *	jy,
		double *	sy,
		int *	iz,
		int *	jz,
		double *	sz )

Return information about mirror periodicity. ix: 0 = no mirror in x, 1 = producing charge density of opposite sign (infinite cond plane) 2 = producing charge density of same sign jx: not used at present sx: x distance of the mirror from origin

Definition at line 281 of file NeBemInterface.cpp.

                                                             {
 
  if (!Garfield::gComponentNeBem3d) return -1;
  *jx = *jy = *jz = 0;
  bool perx = false, pery = false, perz = false;
  Garfield::gComponentNeBem3d->IsMirrorPeriodic(perx, pery, perz);
  // Only one reflection is allowed at present.
  *ix = *iy = *iz = 0;
  if (perx) {
    *ix = 2;
  } else if (pery) {
    *iy = 2;
  } else if (perz) {
    *iz = 2;
  }
  // Mirror assumed to be passing through the origin.
  *sx = *sy = *sz = 0.;  
  return 0;
}

Referenced by neBEMReadGeometry().

neBEMGetNbPrimitives()

int neBEM::neBEMGetNbPrimitives

(

void

)

Return the number of primitives.

Definition at line 192 of file NeBemInterface.cpp.

                           {
  if (!Garfield::gComponentNeBem3d) return 0;
  return Garfield::gComponentNeBem3d->GetNumberOfPrimitives();
}

Referenced by neBEMReadGeometry().

neBEMGetPeriodicities()

int neBEM::neBEMGetPeriodicities	(	int	,
		int *	ix,
		int *	jx,
		double *	sx,
		int *	iy,
		int *	jy,
		double *	sy,
		int *	iz,
		int *	jz,
		double *	sz )

Return information about periodicities. ix: 0 = no periodicity in x, 1 = simple periodicity of length sx, 2 = mirror periodicity of length sx, 3 = axial periodicity around x with sector angle sx, 4 = rotational symmetry around x jx: number of periodic copies internally in neBEM

Definition at line 237 of file NeBemInterface.cpp.

                                                                             {
  if (!Garfield::gComponentNeBem3d) return -1;
  *ix = 0;
  *iy = 0;
  *iz = 0;
  bool perx = false, pery = false, perz = false;
  Garfield::gComponentNeBem3d->IsPeriodic(perx, pery, perz);
  if (perx) *ix = 1;
  if (pery) *iy = 1;
  if (perz) *iz = 1; 
  Garfield::gComponentNeBem3d->IsMirrorPeriodic(perx, pery, perz);
  if (perx) *ix = 2;
  if (pery) *iy = 2;
  if (perz) *iz = 2; 
  *sx = 0.;
  *sy = 0.;
  *sz = 0.;
  if (*ix > 0) Garfield::gComponentNeBem3d->GetPeriodicityX(*sx);
  if (*iy > 0) Garfield::gComponentNeBem3d->GetPeriodicityY(*sy);
  if (*iz > 0) Garfield::gComponentNeBem3d->GetPeriodicityZ(*sz);
  // Convert from cm to m.
  *sx *= 0.01;
  *sy *= 0.01;
  *sz *= 0.01;
  *jx = 0;
  *jy = 0;
  *jz = 0;
  if (*ix > 0 || *iy > 0 || *iz > 0) {
    unsigned int nx = 0, ny = 0, nz = 0;
    Garfield::gComponentNeBem3d->GetPeriodicCopies(nx, ny, nz);
    *jx = nx;
    *jy = ny;
    *jz = nz;
  }
  return 0;
}

Referenced by neBEMReadGeometry().

neBEMGetPrimitive()

int neBEM::neBEMGetPrimitive	(	int	prim,
		int *	nvertex,
		double	xvert[],
		double	yvert[],
		double	zvert[],
		double *	xnorm,
		double *	ynorm,
		double *	znorm,
		int *	volref1,
		int *	volref2 )

Return one primitive at a time.

Definition at line 198 of file NeBemInterface.cpp.

                                                                 {
 
  if (!Garfield::gComponentNeBem3d) return -1;
  if (prim < 1) return -1;
  double a = 0., b = 0., c = 0.;
  std::vector<double> xv;
  std::vector<double> yv;
  std::vector<double> zv;
  int vol1 = 0, vol2 = 0;
  if (!Garfield::gComponentNeBem3d->GetPrimitive(prim - 1, a, b, c, 
                                                 xv, yv, zv, vol1, vol2)) {
    return -1;
  }
  const size_t nv = xv.size();
  *nvertex = nv;
  for (size_t i = 0; i < nv; ++i) {
    // Convert from cm to m.
    xvert[i] = 0.01 * xv[i];
    yvert[i] = 0.01 * yv[i];
    zvert[i] = 0.01 * zv[i];
  }
  *xnorm = a;
  *ynorm = b;
  *znorm = c;
  if (nv == 2) *xnorm *= 0.01;
  *volref1 = vol1;
  *volref2 = vol2;
  return 0;
}

Referenced by neBEMReadGeometry().

neBEMSetDefaults()

int neBEM::neBEMSetDefaults

(

void

)

Assign default values to some of the important global variables.

Definition at line 13 of file NeBemInterface.cpp.

                           {
 
  neBEMState = 0;
 
  NbVolumes = 2;
  VolMax = 2;
 
  NbPrimitives = 1;
  MaxNbVertices = 4;
 
  NbSurfs = 1;
  NbWires = 0;
 
  MinNbElementsOnLength = 1;
  MaxNbElementsOnLength = 100;
  ElementLengthRqstd = 100.0e-6;
 
  NewModel = 1;
  NewMesh = 1;
  NewBC = 1;
  NewPP = 1;
  ModelCntr = 1;
  MeshCntr = 1;
  BCCntr = 1;
  PPCntr = 1;
 
  DebugLevel = 0;
 
  LengthScale = 1.0;
 
  TimeStep = 1;
 
  strcpy(DeviceOutDir, "neBEMOut");
 
  OptDeviceFile = 0;
  strcpy(DeviceInputFile, "");
 
  OptPrintPrimaryDetails = 0;
  OptPrintVolumeDetails = 0;
  OptPrintVertexAndNormal = 0;
 
  OptGnuplot = 1;
  OptGnuplotPrimitives = 1;
  OptGnuplotElements = 1;
  OptPrimitiveFiles = 1;
  OptElementFiles = 1;
 
  // Same directory can be used over and over again - BEWARE!
  OptReuseDir = 1;  
 
  // Matrix inversion procedure => 0: LU, 1: SVD, 2:GSL
  OptInvMatProc = 0;  
 
  OptValidateSolution = 0;
  OptForceValidation = 0;
  OptStorePrimitives = 1;
  OptStoreElements = 1;
  OptStoreInflMatrix = 0;
  OptStoreInvMatrix = 1;
  OptFormattedFile = 1;
  OptUnformattedFile = 0;
  OptRepeatLHMatrix = 0;
 
  OptSystemChargeZero = 1;
 
  return 0;
}  // neBEMSetDefaults ends

Referenced by neBEMInitialize().

neBEMVolumeDescription()

int neBEM::neBEMVolumeDescription	(	int	vol,
		int *	shape,
		int *	material,
		double *	epsilon,
		double *	potential,
		double *	charge,
		int *	boundarytype )

Return information about a volume.

Definition at line 378 of file NeBemInterface.cpp.

                                              {
  
  if (!Garfield::gComponentNeBem3d) return -1;
  if (!Garfield::gComponentNeBem3d->GetVolume(vol, *shape, *material, 
                                              *epsilon, *potential, *charge,
                                              *boundarytype)) {
    return 0;
  }
  return 1;
}

Referenced by neBEMReadGeometry(), and ReadPrimitives().

neBEMVolumePoint()

int neBEM::neBEMVolumePoint	(	double	x,
		double	y,
		double	z )

Return the volume in which a point is located.

Definition at line 392 of file NeBemInterface.cpp.

                                                   {
  
  if (!Garfield::gComponentNeBem3d) return -1;
  return Garfield::gComponentNeBem3d->GetVolume(100. * x, 100. * y, 100. * z);
}

Referenced by MapFPR(), and VoxelFPR().

neBEMVolumePrimitives()

void neBEM::neBEMVolumePrimitives	(	int	,
		int *	,
		int	[] )

Return the primitives for a volume. TODO! Do we need this?

Definition at line 400 of file NeBemInterface.cpp.

                                                   {
 
}

ReadInitFile()

int neBEM::ReadInitFile

(

char

filename[]

)

Definition at line 81 of file NeBemInterface.cpp.

                                  {
  FILE* finit = fopen(filename, "r");
  if (finit == NULL) {
    neBEMMessage("ReadInitFile - fail to open init file");
    return -1;
  }
 
  fscanf(finit, "MinNbElementsOnLength: %d\n", &MinNbElementsOnLength);
  fscanf(finit, "MaxNbElementsOnLength: %d\n", &MaxNbElementsOnLength);
  fscanf(finit, "ElementLengthRqstd: %le\n", &ElementLengthRqstd);
  fscanf(finit, "LengthScale: %le\n", &LengthScale);
 
  fscanf(finit, "DebugLevel: %d\n", &DebugLevel);
 
  fscanf(finit, "NewModel: %d\n", &NewModel);
  fscanf(finit, "NewMesh: %d\n", &NewMesh);
  fscanf(finit, "NewBC: %d\n", &NewBC);
  fscanf(finit, "NewPP: %d\n", &NewPP);
  fscanf(finit, "ModelCntr: %d\n", &ModelCntr);
  fscanf(finit, "MeshCntr: %d\n", &MeshCntr);
  fscanf(finit, "BCCntr: %d\n", &BCCntr);
  fscanf(finit, "PPCntr: %d\n", &PPCntr);
 
  fscanf(finit, "DeviceOutDir: %255s\n", DeviceOutDir);
 
  fscanf(finit, "OptDeviceFile: %d\n", &OptDeviceFile);
  fscanf(finit, "DeviceInputFile: %255s\n", DeviceInputFile);
 
  fscanf(finit, "OptPrintPrimaryDetails: %d\n", &OptPrintPrimaryDetails);
  fscanf(finit, "OptPrintVolumeDetails: %d\n", &OptPrintVolumeDetails);
  fscanf(finit, "OptPrintVertexAndNormal: %d\n", &OptPrintVertexAndNormal);
 
  fscanf(finit, "OptGnuplot: %d\n", &OptGnuplot);
  fscanf(finit, "OptGnuplotPrimitives: %d\n", &OptGnuplotPrimitives);
  fscanf(finit, "OptGnuplotElements: %d\n", &OptGnuplotElements);
 
  fscanf(finit, "OptPrimitiveFiles: %d\n", &OptPrimitiveFiles);
  fscanf(finit, "OptElementFiles: %d\n", &OptElementFiles);
 
  fscanf(finit, "OptReuseDir: %d\n", &OptReuseDir);
 
  fscanf(finit, "OptInvMatProc: %d\n", &OptInvMatProc);
 
  fscanf(finit, "OptValidateSolution: %d\n", &OptValidateSolution);
  fscanf(finit, "OptForceValidation: %d\n", &OptForceValidation);
  fscanf(finit, "OptStorePrimitives: %d\n", &OptStorePrimitives);
  fscanf(finit, "OptStoreElements: %d\n", &OptStoreElements);
  fscanf(finit, "OptStoreInflMatrix: %d\n", &OptStoreInflMatrix);
  fscanf(finit, "OptStoreInvMatrix: %d\n", &OptStoreInvMatrix);
  fscanf(finit, "OptFormattedFile: %d\n", &OptFormattedFile);
  fscanf(finit, "OptUnformattedFile: %d\n", &OptUnformattedFile);
  fscanf(finit, "OptRepeatLHMatrix: %d\n", &OptRepeatLHMatrix);
 
  fscanf(finit, "OptSystemChargeZero: %d\n", &OptSystemChargeZero);
 
  fscanf(finit, "PrimAfter: %d\n", &PrimAfter);
 
  fclose(finit);
 
  fprintf(stdout, "MinNbElementsOnLength: %d\n", MinNbElementsOnLength);
  fprintf(stdout, "MaxNbElementsOnLength: %d\n", MaxNbElementsOnLength);
  fprintf(stdout, "ElementLengthRqstd: %e\n", ElementLengthRqstd);
  fprintf(stdout, "LengthScale: %e\n", LengthScale);
 
  fprintf(stdout, "NewModel: %d\n", NewModel);
  fprintf(stdout, "NewMesh: %d\n", NewMesh);
  fprintf(stdout, "NewBC: %d\n", NewBC);
  fprintf(stdout, "NewPP: %d\n", NewPP);
  fprintf(stdout, "ModelCntr: %d\n", ModelCntr);
  fprintf(stdout, "MeshCntr: %d\n", MeshCntr);
  fprintf(stdout, "BCCntr: %d\n", BCCntr);
  fprintf(stdout, "PPCntr: %d\n", PPCntr);
 
  fprintf(stdout, "DeviceOutDir: %s\n", DeviceOutDir);
 
  fprintf(stdout, "OptDeviceFile: %d\n", OptDeviceFile);
  fprintf(stdout, "DeviceInputFile: %s\n", DeviceInputFile);
 
  fprintf(stdout, "OptPrintPrimaryDetails: %d\n", OptPrintPrimaryDetails);
  fprintf(stdout, "OptPrintVolumeDetails: %d\n", OptPrintVolumeDetails);
  fprintf(stdout, "OptPrintVertexAndNormal: %d\n", OptPrintVertexAndNormal);
 
  fprintf(stdout, "OptGnuplot: %d\n", OptGnuplot);
  fprintf(stdout, "OptGnuplotPrimitives: %d\n", OptGnuplotPrimitives);
  fprintf(stdout, "OptGnuplotElements: %d\n", OptGnuplotElements);
 
  fprintf(stdout, "OptPrimitiveFiles: %d\n", OptPrimitiveFiles);
  fprintf(stdout, "OptElementFiles: %d\n", OptElementFiles);
 
  fprintf(stdout, "OptReuseDir: %d\n", OptReuseDir);
 
  fprintf(stdout, "OptValidateSolution: %d\n", OptValidateSolution);
  fprintf(stdout, "OptStorePrimitives: %d\n", OptStorePrimitives);
  fprintf(stdout, "OptStoreElements: %d\n", OptStoreElements);
  fprintf(stdout, "OptStoreInflMatrix: %d\n", OptStoreInflMatrix);
  fprintf(stdout, "OptStoreInvMatrix: %d\n", OptStoreInvMatrix);
  fprintf(stdout, "OptFormattedFile: %d\n", OptFormattedFile);
  fprintf(stdout, "OptUnformattedFile: %d\n", OptUnformattedFile);
  fprintf(stdout, "OptRepeatLHMatrix: %d\n", OptRepeatLHMatrix);
 
  fprintf(stdout, "OptSystemChargeZero: %d\n", OptSystemChargeZero);
 
  fprintf(stdout, "PrimAfter: %d\n", PrimAfter);
 
  return 0;
}