XGC1
Public Member Functions | Public Attributes | List of all members
ThermalBath Struct Reference

#include <thermal_bath.hpp>

Public Member Functions

 ThermalBath ()
 
 ThermalBath (NLReader::NamelistReader &nlr, const MagneticField< DeviceType > &magnetic_field)
 Constructs a ThermalBath object. More...
 
void apply (const Simulation< DeviceType > &sml, const Grid< DeviceType > &grid, const MagneticField< DeviceType > &magnetic_field, Plasma &plasma, const VelocityGrid &vgrid, const DomainDecomposition< DeviceType > &pol_decomp)
 Applies thermal bath effects. More...
 

Public Attributes

double inpsi
 Thermal Bath overlap region inner boundary. More...
 
double outpsi
 Thermal Bath overlap region outer boundary. More...
 
double inpsi_priv1
 Boundary for weight sink in primary private region. More...
 
double inpsi_priv2
 Boundary for weight sink in secondary private region. More...
 
double gamma
 Thermal Bath gamma_k. More...
 
int n_energy_bins
 Thermal Bath energy bin number. More...
 
int n_diag_bins
 Thermal Bath energy bin diag number. More...
 
double gamma_coarse_graining
 Coarse-graining gamma_cg. More...
 
double vmax
 

Constructor & Destructor Documentation

◆ ThermalBath() [1/2]

ThermalBath::ThermalBath ( )
inline

◆ ThermalBath() [2/2]

ThermalBath::ThermalBath ( NLReader::NamelistReader nlr,
const MagneticField< DeviceType > &  magnetic_field 
)

Constructs a ThermalBath object.

Parameters
nlrNamelistReader object containing thermal bath parameters.

< Overlap region inner boundary

< Overlap region outer boundary

< Boundary for weight sink in the primary private region

< Boundary for weight sink in the secondary private region

< gamma_k

< Number of energy bins

< Number of bins for diagnostic

< Coarse-graining gamma_cg

< Maximum velocity for energy bins (normalized to thermal velocity)

Here is the call graph for this function:

Member Function Documentation

◆ apply()

void ThermalBath::apply ( const Simulation< DeviceType > &  sml,
const Grid< DeviceType > &  grid,
const MagneticField< DeviceType > &  magnetic_field,
Plasma plasma,
const VelocityGrid vgrid,
const DomainDecomposition< DeviceType > &  pol_decomp 
)

Applies thermal bath effects.

Parameters
smlSimulation object.
gridGrid object.
magnetic_fieldMagnetic field object.
plasmaPlasma object.
vgridVelocity grid object.
pol_decompDomain decomposition object.
Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ gamma

double ThermalBath::gamma

Thermal Bath gamma_k.

◆ gamma_coarse_graining

double ThermalBath::gamma_coarse_graining

Coarse-graining gamma_cg.

◆ inpsi

double ThermalBath::inpsi

Thermal Bath overlap region inner boundary.

◆ inpsi_priv1

double ThermalBath::inpsi_priv1

Boundary for weight sink in primary private region.

◆ inpsi_priv2

double ThermalBath::inpsi_priv2

Boundary for weight sink in secondary private region.

◆ n_diag_bins

int ThermalBath::n_diag_bins

Thermal Bath energy bin diag number.

◆ n_energy_bins

int ThermalBath::n_energy_bins

Thermal Bath energy bin number.

◆ outpsi

double ThermalBath::outpsi

Thermal Bath overlap region outer boundary.

◆ vmax

double ThermalBath::vmax

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