diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index 6cb5fcc..1e7b061 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-17T00:10:12","documenter_version":"1.8.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-17T00:49:58","documenter_version":"1.8.0"}} \ No newline at end of file diff --git a/dev/api/index.html b/dev/api/index.html index b8a8d58..9c7f572 100644 --- a/dev/api/index.html +++ b/dev/api/index.html @@ -1,5 +1,5 @@ -API Reference · ChargedParticles.jl
GitHub

API Reference

Types

ChargedParticles.ChargedParticleImpl — Type
ChargedParticleImpl <: AbstractParticle

Implementation type for charged particles.

Fields

  • symbol::Symbol: Chemical symbol or particle identifier (e.g., :Fe, :e, :μ)
  • charge_number::Int: Number of elementary charges (can be negative)
  • mass_number::Int: Total number of nucleons (protons + neutrons)

Notes

  • Mass number : For elementary particles like electrons and muons, mass_number is 0
  • Charge number : electrical charge in units of the elementary charge, usually denoted as z. https://en.wikipedia.org/wiki/Charge_number
source

Constructors

ChargedParticles.Particle — Function
Particle(str::AbstractString; mass_numb=nothing, z=nothing)

Create a particle from a string representation.

Arguments

  • str::AbstractString: String representation of the particle

String Format Support

  • Element symbols: "Fe", "He"
  • Isotopes: "Fe-56", "D"
  • Ions: "Fe2+", "H-"
  • Common aliases: "electron", "proton", "alpha", "mu-"

Examples

# Elementary particles
+API Reference · ChargedParticles.jl
GitHub
API Reference
Types
ChargedParticles.ChargedParticleImpl — Type
ChargedParticleImpl <: AbstractParticle
Implementation type for charged particles.
Fields
  • symbol::Symbol: Chemical symbol or particle identifier (e.g., :Fe, :e, :μ)
  • charge_number::Int: Number of elementary charges (can be negative)
  • mass_number::Int: Total number of nucleons (protons + neutrons)
Notes
  • Mass number : For elementary particles like electrons and muons, mass_number is 0
  • Charge number : electrical charge in units of the elementary charge, usually denoted as z. https://en.wikipedia.org/wiki/Charge_number
source
Constructors
ChargedParticles.Particle — Function
Particle(str::AbstractString; mass_numb=nothing, z=nothing)
Create a particle from a string representation.
Arguments
  • str::AbstractString: String representation of the particle
String Format Support
  • Element symbols: "Fe", "He"
  • Isotopes: "Fe-56", "D"
  • Ions: "Fe2+", "H-"
  • Common aliases: "electron", "proton", "alpha", "mu-"
Examples
# Elementary particles
 electron = Particle("e-")
 muon = Particle("mu-")
 positron = Particle("e+")
@@ -8,35 +8,35 @@
 proton = Particle("H+")
 alpha = Particle("He2+")
 deuteron = Particle("D+")
-iron56 = Particle("Fe-56")
source
Particle(sym::Symbol)
Create a particle from its symbol representation.
Examples
# Elementary particles
+iron56 = Particle("Fe-56")
source
Particle(sym::Symbol)
Create a particle from its symbol representation.
Examples
# Elementary particles
 electron = Particle(:e)
 muon = Particle(:muon)
-proton = Particle(:p)
source
Particle(p::AbstractParticle)
Create a particle from another particle implementation, optionally specifying mass number and charge to override.
Examples
p = Particle("Fe2+")
-p2 = Particle(p; mass_numb=54, z=3)  # Creates a new instance with same properties
source
Particle(atomic_number::Int; mass_numb=nothing, z=0)
Create a particle from its atomic number with optional mass number and charge state.
Arguments
  • atomic_number::Int: The atomic number (number of protons)
  • mass_numb=nothing: Optional mass number (total number of nucleons)
  • z=0: Optional charge number (in elementary charge units)
Examples
# Basic construction
+proton = Particle(:p)
source
Particle(p::AbstractParticle)
Create a particle from another particle implementation, optionally specifying mass number and charge to override.
Examples
p = Particle("Fe2+")
+p2 = Particle(p; mass_numb=54, z=3)  # Creates a new instance with same properties
source
Particle(atomic_number::Int; mass_numb=nothing, z=0)
Create a particle from its atomic number with optional mass number and charge state.
Arguments
  • atomic_number::Int: The atomic number (number of protons)
  • mass_numb=nothing: Optional mass number (total number of nucleons)
  • z=0: Optional charge number (in elementary charge units)
Examples
# Basic construction
 iron = Particle(26)        # Iron
 u = Particle(92)          # Uranium
 
 # With mass number and charge
 fe56_3plus = Particle(26, mass_numb=56, z=3)  # Fe-56³⁺
-he4_2plus = Particle(2, mass_numb=4, z=2)     # ⁴He²⁺ (alpha particle)
See also: Particle(::AbstractString)
source
Properties
ChargedParticles.atomic_number — Function
atomic_number(p::AbstractParticle)
Return the atomic number (number of protons) of the particle.
Examples
```julia fe = Particle("Fe") println(atomic_number(fe))  # 26
e = electron() println(atomic_number(e))  # 0
source
Properties
ChargedParticles.atomic_number — Function
atomic_number(p::AbstractParticle)
Return the atomic number (number of protons) of the particle.
Examples
```julia fe = Particle("Fe") println(atomic_number(fe))  # 26
e = electron() println(atomic_number(e))  # 0
source
ChargedParticles.mass_number — Function
mass_number(p::AbstractParticle)
Return the mass number (total number of nucleons) of the particle.
Examples
fe56 = Particle("Fe-56")
 println(mass_number(fe56))  # 56
 
 e = electron()
-println(mass_number(e))  # 0
source
Type Checking
ChargedParticles.is_ion — Function
is_ion(p::AbstractParticle)
Check if the particle is an ion (has non-zero charge and is not an elementary particle).
Examples
julia> is_ion(Particle("Fe3+"))
+println(mass_number(e))  # 0
source
Type Checking
ChargedParticles.is_ion — Function
is_ion(p::AbstractParticle)
Check if the particle is an ion (has non-zero charge and is not an elementary particle).
Examples
julia> is_ion(Particle("Fe3+"))
 true
 julia> is_ion(Particle("Fe"))
 false
 julia> is_ion(electron())
-false
source
ChargedParticles.is_chemical_element — Function
is_chemical_element(p::AbstractParticle)
Check if the particle is a chemical element.
Examples
julia> is_chemical_element(Particle("Fe"))
 true
 julia> is_chemical_element(electron())
-false
source
ChargedParticles.is_default_isotope — Function
is_default_isotope(p::AbstractParticle)
Check if the particle is the default isotope of its element.
Examples
julia> is_default_isotope(Particle("Fe-56"))
+false
source
ChargedParticles.is_default_isotope — Function
is_default_isotope(p::AbstractParticle)
Check if the particle is the default isotope of its element.
Examples
julia> is_default_isotope(Particle("Fe-56"))
 true
 julia> is_default_isotope(Particle("Fe-57"))
-false
source
ChargedParticles.is_proton — Function
is_proton(p::AbstractParticle)
Check if the particle is a proton (has symbol 'H', charge +1, and mass number 1).
Examples
julia> ChargedParticles.is_proton(proton())
+false
source
ChargedParticles.is_proton — Function
is_proton(p::AbstractParticle)
Check if the particle is a proton (has symbol 'H', charge +1, and mass number 1).
Examples
julia> ChargedParticles.is_proton(proton())
 true
 julia> ChargedParticles.is_proton(electron())
-false
source
ChargedParticles.is_electron — Function
is_electron(p::AbstractParticle)
Check if the particle is an electron (has symbol 'e', charge -1, and electron mass).
Examples
julia> ChargedParticles.is_electron(electron())
+false
source
ChargedParticles.is_electron — Function
is_electron(p::AbstractParticle)
Check if the particle is an electron (has symbol 'e', charge -1, and electron mass).
Examples
julia> ChargedParticles.is_electron(electron())
 true
 julia> ChargedParticles.is_electron(proton())
-false
source
Constants
ChargedParticles.PARTICLE_ALIASES — Constant
PARTICLE_ALIASES
Dictionary of common particle aliases and their corresponding (symbol, charge, mass_number) tuples.
Each entry maps a string alias to a tuple of (symbol, charge, mass_number)
source

+false
source

Constants

ChargedParticles.PARTICLE_ALIASES — Constant
PARTICLE_ALIASES

Dictionary of common particle aliases and their corresponding (symbol, charge, mass_number) tuples.

Each entry maps a string alias to a tuple of (symbol, charge, mass_number)

source
diff --git a/dev/index.html b/dev/index.html index dfb6666..b5cc41f 100644 --- a/dev/index.html +++ b/dev/index.html @@ -21,4 +21,4 @@ Alpha particle charge: 3.204353268e-19 C Iron charge: 4.806529901999999e-19 C Iron-56 mass number: 56 -Deuteron mass: 3.343583748273425e-27 kg

Manual Outline

+Deuteron mass: 3.343583748273425e-27 kg

Manual Outline

diff --git a/dev/manual/construction/index.html b/dev/manual/construction/index.html index 54ea480..4ec41d2 100644 --- a/dev/manual/construction/index.html +++ b/dev/manual/construction/index.html @@ -67,4 +67,4 @@ catch e println("Error: ", e) end
Error: KeyError(:XX)
-Error: KeyError(-1)
+Error: KeyError(-1) diff --git a/dev/manual/getting-started/index.html b/dev/manual/getting-started/index.html index c5602a6..67a7fd1 100644 --- a/dev/manual/getting-started/index.html +++ b/dev/manual/getting-started/index.html @@ -55,4 +55,4 @@ println("Deuteron mass number: ", mass_number(deuteron)) println("Tritium mass number: ", mass_number(tritium))
Fe-56 mass number: 56
 Deuteron mass number: 2
-Tritium mass number: 3
+Tritium mass number: 3 diff --git a/dev/manual/particle-types/index.html b/dev/manual/particle-types/index.html index d59b3eb..8c1da21 100644 --- a/dev/manual/particle-types/index.html +++ b/dev/manual/particle-types/index.html @@ -92,4 +92,4 @@

Alpha: Z = 2, A = 4 Deuteron: A = 2 -Triton: A = 3 +Triton: A = 3