sarkas.plasma.Species#

class sarkas.plasma.Species(input_dict=None)[source]#

Class used to store all the information of a single species.

Variables

  • name (str) – Species’ name.

  • number_density (float) – Species number density in appropriate units.

  • num (int) – Number of particles of Species.

  • mass (float) – Species’ mass.

  • charge (float) – Species’ charge.

  • Z (float) – Species charge number or ionization degree.

  • ai (float) – Species Wigner - Seitz radius calculate from electron density. Used in the calculation of the effective coupling constant.

  • ai_dens (float) – Species Wigner - Seitz radius calculate from the species density.

  • coupling (float) – Species coupling constant

  • plasma_frequency (float) – Species’ plasma frequency.

  • debye_length (float) – Species’ Debye Length.

  • cyclotron_frequency (float) – Species’ cyclotron frequency.

  • initial_velocity (numpy.ndarray) – Initial velocity in x,y,z directions.

  • temperature (float) – Initial temperature of the species.

  • temperature_eV (float) – Initial temperature of the species in eV.

  • initial_velocity_distribution (str) – Type of distribution. Default = ‘boltzmann’.

  • initial_spatial_distribution (str) – Type of distribution. Default = ‘uniform’.

  • atomic_weight (float) – (Optional) Species mass in atomic units.

  • concentration (float) – Species’ concentration.

  • mass_density (float) – (Optional) Species’ mass density.

Methods

Species.__init__([input_dict])

Parameters

input_dict (dict, optional) -- Dictionary with species information.

Species.calc_coupling(a_ws, z_avg, const)

Calculate the coupling constant between particles.

Species.calc_cyclotron_frequency(...)

Calculate the cyclotron frequency.

Species.calc_debroglie_wavelength()

Calculate the de Broglie wavelength.

Species.calc_debye_length()

Calculate the Debye Length.

Species.calc_landau_length()

Calculate the Landau Length.

Species.calc_plasma_frequency()

Calculate the plasma frequency.

Species.calc_quantum_attributes([...])

Calculate the following quantum parameters: Dimensionless chemical potential, Fermi wavenumber, Fermi energy, Thomas-Fermi wavenumber.

Species.calc_ws_radius()

Species.copy_params(params)

Copy physical constants from parameters class.

Species.from_dict(input_dict)

Update attributes from input dictionary using the __dict__.update() method.

Species.pretty_print([potential_type, units])

Print Species information in a user-friendly way.