XGCa
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
efield_module Module Reference

Provides routines to evaluate the electric field -grad(phi), the vector potentials (Hamiltonian and symplectic) and their gradients, as well as the RMP field. More...

Public Member Functions

subroutine efield_init (grid, psn)
 Initialization of the electric field. Simply calls the gradient operation on the potential. More...
 
subroutine ptb_bfield_gk (grid, psn, sp, i, fld, itr, p)
 Low level routine to evaluate the perturbed magnetic field, at a particle's position. This routine performs the actual interpolation. More...
 

Detailed Description

Provides routines to evaluate the electric field -grad(phi), the vector potentials (Hamiltonian and symplectic) and their gradients, as well as the RMP field.

Member Function/Subroutine Documentation

subroutine efield_module::efield_init ( type(grid_type), intent(in)  grid,
type(psn_type), intent(inout)  psn 
)

Initialization of the electric field. Simply calls the gradient operation on the potential.

Parameters
[in]gridGrid data, type(grid_type)
[in,out]psnField data on the grid, type(psn_type)

Here is the call graph for this function:

subroutine efield_module::ptb_bfield_gk ( type(grid_type), intent(in)  grid,
type(psn_type), intent(in)  psn,
type(species_type), intent(in)  sp,
integer, intent(in)  i,
type(fld_type), intent(inout)  fld,
integer, intent(in)  itr,
real (kind=8), dimension(3), intent(in)  p 
)

Low level routine to evaluate the perturbed magnetic field, at a particle's position. This routine performs the actual interpolation.

Parameters
[in]gridGrid data, type(grid_type)
[in]psnField data on grid, type(psn_type)
[in]spParticle data, type(species_type)
[in]iParticle index in particle data, (integer)
[in,out]fldField data at particle position, type(fld_type)
[in]itrTriangle in which the particle is located (known >0, search -1 or 0, out of mesh <-1), integer
[in]pBarycentric coordinates in trianble itr, real(8)

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