WarpX
Loading...
Searching...
No Matches
SpeciesPhysicalProperties.H
Go to the documentation of this file.
1/* Copyright 2020 Maxence Thevenet
2 *
3 * This file is part of WarpX.
4 *
5 * License: BSD-3-Clause-LBNL
6 */
7
8#ifndef WARPX_SPECIESPHYSICALPROPERTIES_H_
9#define WARPX_SPECIESPHYSICALPROPERTIES_H_
10
11#include <AMReX_REAL.H>
12
13#include <optional>
14#include <string>
15
21
22namespace species
23{
30 std::optional<PhysicalSpecies> from_string (const std::string& species_name);
31
38 amrex::Real get_charge (const PhysicalSpecies& ps);
39
46 amrex::Real get_mass (const PhysicalSpecies& ps);
47
54 std::string get_name (const PhysicalSpecies& ps);
55}
56
57#endif // WARPX_SPECIESPHYSICALPROPERTIES_H_
PhysicalSpecies
Definition SpeciesPhysicalProperties.H:16
@ lithium6
Definition SpeciesPhysicalProperties.H:18
@ carbon13
Definition SpeciesPhysicalProperties.H:19
@ oxygen17
Definition SpeciesPhysicalProperties.H:19
@ boron
Definition SpeciesPhysicalProperties.H:18
@ oxygen16
Definition SpeciesPhysicalProperties.H:19
@ hydrogen1
Definition SpeciesPhysicalProperties.H:17
@ lithium7
Definition SpeciesPhysicalProperties.H:18
@ electron
Definition SpeciesPhysicalProperties.H:17
@ neon22
Definition SpeciesPhysicalProperties.H:20
@ beryllium9
Definition SpeciesPhysicalProperties.H:18
@ nitrogen15
Definition SpeciesPhysicalProperties.H:19
@ alpha
Definition SpeciesPhysicalProperties.H:18
@ helium4
Definition SpeciesPhysicalProperties.H:18
@ lithium
Definition SpeciesPhysicalProperties.H:18
@ xenon
Definition SpeciesPhysicalProperties.H:20
@ hydrogen2
Definition SpeciesPhysicalProperties.H:17
@ hydrogen3
Definition SpeciesPhysicalProperties.H:17
@ oxygen
Definition SpeciesPhysicalProperties.H:19
@ nitrogen
Definition SpeciesPhysicalProperties.H:19
@ antimuon
Definition SpeciesPhysicalProperties.H:17
@ muon
Definition SpeciesPhysicalProperties.H:17
@ photon
Definition SpeciesPhysicalProperties.H:17
@ carbon14
Definition SpeciesPhysicalProperties.H:19
@ proton
Definition SpeciesPhysicalProperties.H:17
@ positron
Definition SpeciesPhysicalProperties.H:17
@ oxygen18
Definition SpeciesPhysicalProperties.H:19
@ neon
Definition SpeciesPhysicalProperties.H:20
@ fluorine19
Definition SpeciesPhysicalProperties.H:20
@ helium
Definition SpeciesPhysicalProperties.H:18
@ boron10
Definition SpeciesPhysicalProperties.H:18
@ neon21
Definition SpeciesPhysicalProperties.H:20
@ beryllium
Definition SpeciesPhysicalProperties.H:18
@ helium3
Definition SpeciesPhysicalProperties.H:18
@ unspecified
Definition SpeciesPhysicalProperties.H:17
@ carbon12
Definition SpeciesPhysicalProperties.H:19
@ hydrogen
Definition SpeciesPhysicalProperties.H:17
@ nitrogen14
Definition SpeciesPhysicalProperties.H:19
@ aluminium
Definition SpeciesPhysicalProperties.H:20
@ argon
Definition SpeciesPhysicalProperties.H:20
@ gold
Definition SpeciesPhysicalProperties.H:20
@ neon20
Definition SpeciesPhysicalProperties.H:20
@ carbon
Definition SpeciesPhysicalProperties.H:18
@ fluorine
Definition SpeciesPhysicalProperties.H:19
@ boron11
Definition SpeciesPhysicalProperties.H:18
@ copper
Definition SpeciesPhysicalProperties.H:20
@ neutron
Definition SpeciesPhysicalProperties.H:17
Definition SpeciesPhysicalProperties.cpp:277
std::optional< PhysicalSpecies > from_string(const std::string &species)
Returns the PhysicalSpecies associated to a given name.
Definition SpeciesPhysicalProperties.cpp:278
std::string get_name(const PhysicalSpecies &ps)
Returns the name associated to a PhysicalSpecies.
Definition SpeciesPhysicalProperties.cpp:295
amrex::Real get_charge(const PhysicalSpecies &ps)
Returns the charge associated to a PhysicalSpecies.
Definition SpeciesPhysicalProperties.cpp:285
amrex::Real get_mass(const PhysicalSpecies &ps)
Returns the mass associated to a PhysicalSpecies.
Definition SpeciesPhysicalProperties.cpp:290