Graph Framework
Loading...
Searching...
No Matches
pic::characteristics< T > Class Template Reference

Characteristic factors. More...

#include <particle_in_cell.hpp>

Public Member Functions

 characteristics (const std::vector< T > &ion_masses, const std::vector< uint8_t > &ion_zs, const T ne)
 Construct the characteristics.
 
T get_volume () const
 Get the characteristic volume.
 

Public Attributes

const T m
 Mass.
 
const T q
 Charge.
 
const T ne
 Electron density.
 
const T wpe
 Plasma Frequency.
 
const T t
 Time.
 
const T l
 Length.
 
const T v
 Velocity.
 
const T te
 Electron temperature;.
 
const T efield
 Electric field;.
 
const T bfield
 Magnetic field;.
 

Detailed Description

template<std::floating_point T>
class pic::characteristics< T >

Characteristic factors.

Template Parameters
TBase type of the calculation.

Constructor & Destructor Documentation

◆ characteristics()

template<std::floating_point T>
pic::characteristics< T >::characteristics ( const std::vector< T > &  ion_masses,
const std::vector< uint8_t > &  ion_zs,
const T  ne 
)
inline

Construct the characteristics.

Parameters
[in]ion_massesIon masses for all species.
[in]ion_zsIon Z effective all species.
[in]neCharacteristic density.

Member Function Documentation

◆ get_volume()

template<std::floating_point T>
T pic::characteristics< T >::get_volume ( ) const
inline

Get the characteristic volume.

Returns
l^3.

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