species Namespace Reference

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

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_name

the 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]

ps

the 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]

ps

the 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]

ps

the PhysicalSpecies

Returns

the name associated to the PhysicalSpecies