XGCa
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Functions
get_potential_grad.hpp File Reference
#include "sml.hpp"
#include "grid.hpp"
#include "domain_decomposition.hpp"
#include "magnetic_field.hpp"
#include "electric_field.hpp"
Include dependency graph for get_potential_grad.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

void get_potential_grad (const Simulation< DeviceType > &sml, const Grid< DeviceType > &grid, const DomainDecomposition< DeviceType > &pol_decomp, const MagneticField< DeviceType > &magnetic_field, ElectricField< DeviceType > &electric_field)
 

Function Documentation

void get_potential_grad ( const Simulation< DeviceType > &  sml,
const Grid< DeviceType > &  grid,
const DomainDecomposition< DeviceType > &  pol_decomp,
const MagneticField< DeviceType > &  magnetic_field,
ElectricField< DeviceType > &  electric_field 
)

Calculates gyro-averaged electric field, electric potential in field-following coordinates (if XGC1) If EM, also calculates analogous magnetic potential and gradients

Parameters
[in]smlis the simulation object
[in]gridis the grid object
[in]magnetic_fieldis the magnetic field object
Returns
void

Here is the call graph for this function:

Here is the caller graph for this function: