WarpX
Functions
species Namespace Reference

Functions

std::optional< PhysicalSpeciesfrom_string (const std::string &species_name)
 Returns the PhysicalSpecies associated to a given name. More...
 
amrex::Real get_charge (const PhysicalSpecies &ps)
 Returns the charge associated to a PhysicalSpecies. More...
 
amrex::Real get_mass (const PhysicalSpecies &ps)
 Returns the mass associated to a PhysicalSpecies. More...
 
std::string get_name (const PhysicalSpecies &ps)
 Returns the name associated to a PhysicalSpecies. More...
 

Function Documentation

◆ from_string()

std::optional< PhysicalSpecies > species::from_string ( const std::string &  species_name)

Returns the PhysicalSpecies associated to a given name.

Parameters
[in]species_namethe name of a species
Returns
the PhysicalSpecies corresponding to species_name (if it exists)

◆ get_charge()

amrex::Real species::get_charge ( const PhysicalSpecies ps)

Returns the charge associated to a PhysicalSpecies.

Parameters
[in]psthe PhysicalSpecies
Returns
the charge associated to the PhysicalSpecies

◆ get_mass()

amrex::Real species::get_mass ( const PhysicalSpecies ps)

Returns the mass associated to a PhysicalSpecies.

Parameters
[in]psthe PhysicalSpecies
Returns
the mass associated to the PhysicalSpecies

◆ get_name()

std::string species::get_name ( const PhysicalSpecies ps)

Returns the name associated to a PhysicalSpecies.

Parameters
[in]psthe PhysicalSpecies
Returns
the name associated to the PhysicalSpecies