XGC1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
ElectricField< Device > Struct Template Reference

#include <electric_field.hpp>

Collaboration diagram for ElectricField< Device >:
Collaboration graph
[legend]

Public Member Functions

 ElectricField ()
 
 ElectricField (NLReader::NamelistReader &nlr, int nnode_in, int nplanes_in, int nrho_in, double inv_drho_in)
 
template<typename T >
void copy_to_pack (T &device_grid_field, const T &host_grid_field) const
 
template<typename T1 , typename T2 >
void copy_to_pack (T1 &device_grid_field, const T2 &host_grid_field) const
 
template<PhiInterpType PIT>
GridFieldPack< Device, PIT > copy_push_fields_to_device (KinType kintype_in, const Simulation< DeviceType > &sml, const DomainDecomposition< DeviceType > &pol_decomp, const MagneticField< DeviceType > &magnetic_field, const Grid< DeviceType > &grid, bool near_field=false) const
 
template<PhiInterpType PIT>
GridFieldPack< Device, PIT > copy_Ah_cv_to_device_as_Ah (KinType kintype_in, const DomainDecomposition< DeviceType > &pol_decomp, const Grid< DeviceType > &grid) const
 
template<PhiInterpType PIT>
GridFieldPack< Device, PIT > copy_Ah_ff_to_device (KinType kintype_in, const DomainDecomposition< DeviceType > &pol_decomp, const Grid< DeviceType > &grid) const
 
template<PhiInterpType PIT>
GridFieldPack< Device, PIT > copy_dpot_to_device (KinType kintype_in) const
 
void get_potential_grad (const Simulation< DeviceType > &sml, const Grid< DeviceType > &grid, const DomainDecomposition< DeviceType > &pol_decomp, const MagneticField< DeviceType > &magnetic_field, const Species< DeviceType > &species)
 

Static Public Member Functions

static MemoryPrediction estimate_memory_usage (NLReader::NamelistReader &nlr, const Grid< DeviceType > &grid)
 

Public Attributes

int nnode
 
int nphi
 
int nrho
 
double inv_drho
 
bool calculate_phi_ff_on_device
 
bool turb_efield
 E-field calculated only with \(<\phi>\) if .false., psndpot will still contain all (n=0,|m|>0) and (|n|>0,m) modes. More...
 
bool E00_efield
 Flux-surface averaged potential not used for calculating the electric field if .false. More...
 
GridField< HostType,
VarType::Vector2D, PIT_GLOBAL,
TorType::OnePlane,
KinType::DriftKin > 		E00_ff_h
 Radial electric field from <phi> in field-following format. More...
 
GridField< HostType,
VarType::Scalar, PIT_GLOBAL,
TorType::OnePlane,
KinType::DriftKin > 		ddpotdt
 Time derivative of phi-<phi> - Not field-following? More...
 
GridField< HostType,
VarType::Scalar,
PhiInterpType::None,
TorType::MultiplePlanes,
KinType::DriftKin > 		Ah_h
 
GridField< HostType,
vec2d_if_axisym< PIT_GLOBAL >
), PIT_GLOBAL,
TorType::OnePlane,
KinType::GyroKin > 		dAh
 
GridField< HostType,
VarType::Scalar, PIT_GLOBAL,
TorType::OnePlane,
KinType::GyroKin > 		Ah
 
GridField< HostType,
VarType::Scalar,
PhiInterpType::None,
TorType::MultiplePlanes,
KinType::DriftKin > 		As_h
 
GridField< HostType,
vec2d_if_axisym< PIT_GLOBAL >
), PIT_GLOBAL,
TorType::OnePlane,
KinType::GyroKin > 		dAs
 
GridField< HostType,
VarType::Scalar, PIT_GLOBAL,
TorType::OnePlane,
KinType::GyroKin > 		As
 
GridField< HostType,
VarType::Scalar, PIT_GLOBAL,
TorType::OnePlane,
KinType::DriftKin > 		Ah_cv
 
GridField< HostType,
VarType::Scalar, PIT_GLOBAL,
TorType::OnePlane,
KinType::GyroKin > 		Epar_em
 
GridField< HostType,
VarType::Scalar, PIT_GLOBAL,
TorType::OnePlane,
KinType::GyroKin > 		pot
 
GridField< HostType,
vec2d_if_axisym< PIT_GLOBAL >
), PIT_GLOBAL,
TorType::OnePlane,
KinType::GyroKin > 		E
 
GridField< HostType,
VarType::Scalar, PIT_GLOBAL,
TorType::OnePlane,
KinType::DriftKin > 		dpot_ff_h
 
GridField< HostType,
VarType::Scalar,
PhiInterpType::None,
TorType::MultiplePlanes,
KinType::DriftKin > 		dpot_h
 
GridField< HostType,
VarType::Scalar,
PhiInterpType::None,
TorType::OnePlane,
KinType::DriftKin > 		pot0_h
 

Constructor & Destructor Documentation

template<class Device>
ElectricField< Device >::ElectricField ( )
inline
template<class Device>
ElectricField< Device >::ElectricField ( NLReader::NamelistReader &  nlr,
int  nnode_in,
int  nplanes_in,
int  nrho_in,
double  inv_drho_in 
)
inline

Here is the call graph for this function:

Member Function Documentation

template<class Device>
template<PhiInterpType PIT>
GridFieldPack<Device, PIT> ElectricField< Device >::copy_Ah_cv_to_device_as_Ah ( KinType  kintype_in,
const DomainDecomposition< DeviceType > &  pol_decomp,
const Grid< DeviceType > &  grid 
) const
inline

Here is the call graph for this function:

Here is the caller graph for this function:

template<class Device>
template<PhiInterpType PIT>
GridFieldPack<Device, PIT> ElectricField< Device >::copy_Ah_ff_to_device ( KinType  kintype_in,
const DomainDecomposition< DeviceType > &  pol_decomp,
const Grid< DeviceType > &  grid 
) const
inline

Here is the call graph for this function:

Here is the caller graph for this function:

template<class Device>
template<PhiInterpType PIT>
GridFieldPack<Device, PIT> ElectricField< Device >::copy_dpot_to_device ( KinType  kintype_in) const
inline

Here is the call graph for this function:

Here is the caller graph for this function:

template<class Device>
template<PhiInterpType PIT>
GridFieldPack<Device, PIT> ElectricField< Device >::copy_push_fields_to_device ( KinType  kintype_in,
const Simulation< DeviceType > &  sml,
const DomainDecomposition< DeviceType > &  pol_decomp,
const MagneticField< DeviceType > &  magnetic_field,
const Grid< DeviceType > &  grid,
bool  near_field = false 
) const
inline

Here is the call graph for this function:

Here is the caller graph for this function:

template<class Device>
template<typename T >
void ElectricField< Device >::copy_to_pack ( T &  device_grid_field,
const T &  host_grid_field 
) const
inline

Here is the caller graph for this function:

template<class Device>
template<typename T1 , typename T2 >
void ElectricField< Device >::copy_to_pack ( T1 &  device_grid_field,
const T2 &  host_grid_field 
) const
inline
template<class Device>
static MemoryPrediction ElectricField< Device >::estimate_memory_usage ( NLReader::NamelistReader &  nlr,
const Grid< DeviceType > &  grid 
)
inlinestatic

Here is the call graph for this function:

template<class Device>
void ElectricField< Device >::get_potential_grad ( const Simulation< DeviceType > &  sml,
const Grid< DeviceType > &  grid,
const DomainDecomposition< DeviceType > &  pol_decomp,
const MagneticField< DeviceType > &  magnetic_field,
const Species< DeviceType > &  species 
)
inline

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:

Member Data Documentation

template<class Device>
GridField<HostType,VarType::Scalar,PIT_GLOBAL,TorType::OnePlane,KinType::GyroKin> ElectricField< Device >::Ah
template<class Device>
GridField<HostType,VarType::Scalar,PIT_GLOBAL,TorType::OnePlane,KinType::DriftKin> ElectricField< Device >::Ah_cv
template<class Device>
GridField<HostType,VarType::Scalar,PhiInterpType::None,TorType::MultiplePlanes,KinType::DriftKin> ElectricField< Device >::Ah_h
template<class Device>
GridField<HostType,VarType::Scalar,PIT_GLOBAL,TorType::OnePlane,KinType::GyroKin> ElectricField< Device >::As
template<class Device>
GridField<HostType,VarType::Scalar,PhiInterpType::None,TorType::MultiplePlanes,KinType::DriftKin> ElectricField< Device >::As_h
template<class Device>
bool ElectricField< Device >::calculate_phi_ff_on_device
template<class Device>
GridField<HostType,vec2d_if_axisym<PIT_GLOBAL>),PIT_GLOBAL,TorType::OnePlane,KinType::GyroKin> ElectricField< Device >::dAh
template<class Device>
GridField<HostType,vec2d_if_axisym<PIT_GLOBAL>),PIT_GLOBAL,TorType::OnePlane,KinType::GyroKin> ElectricField< Device >::dAs
template<class Device>
GridField<HostType,VarType::Scalar,PIT_GLOBAL,TorType::OnePlane,KinType::DriftKin> ElectricField< Device >::ddpotdt

Time derivative of phi-<phi> - Not field-following?

template<class Device>
GridField<HostType,VarType::Scalar,PIT_GLOBAL,TorType::OnePlane,KinType::DriftKin> ElectricField< Device >::dpot_ff_h
template<class Device>
GridField<HostType,VarType::Scalar,PhiInterpType::None,TorType::MultiplePlanes,KinType::DriftKin> ElectricField< Device >::dpot_h
template<class Device>
GridField<HostType,vec2d_if_axisym<PIT_GLOBAL>),PIT_GLOBAL,TorType::OnePlane,KinType::GyroKin> ElectricField< Device >::E
template<class Device>
bool ElectricField< Device >::E00_efield

Flux-surface averaged potential not used for calculating the electric field if .false.

template<class Device>
GridField<HostType,VarType::Vector2D,PIT_GLOBAL,TorType::OnePlane,KinType::DriftKin> ElectricField< Device >::E00_ff_h

Radial electric field from <phi> in field-following format.

template<class Device>
GridField<HostType,VarType::Scalar,PIT_GLOBAL,TorType::OnePlane,KinType::GyroKin> ElectricField< Device >::Epar_em
template<class Device>
double ElectricField< Device >::inv_drho
template<class Device>
int ElectricField< Device >::nnode
template<class Device>
int ElectricField< Device >::nphi
template<class Device>
int ElectricField< Device >::nrho
template<class Device>
GridField<HostType,VarType::Scalar,PIT_GLOBAL,TorType::OnePlane,KinType::GyroKin> ElectricField< Device >::pot
template<class Device>
GridField<HostType,VarType::Scalar,PhiInterpType::None,TorType::OnePlane,KinType::DriftKin> ElectricField< Device >::pot0_h
template<class Device>
bool ElectricField< Device >::turb_efield

E-field calculated only with \(<\phi>\) if .false., psndpot will still contain all (n=0,|m|>0) and (|n|>0,m) modes.

The documentation for this struct was generated from the following file:
Generated by   doxygen 1.8.5