bin.class_files.nucleus_class.nucleus Class Reference

Public Member Functions

def __init__ (self, name='', Z=-1, N=-1, Y=0., quiet=False, init_prop=False)
 
def is_stable (self)
 
def get_not_a_isotope (self)
 
def get_A (self)
 
def get_elnames (self)
 
def get_Z (self)
 
def get_N (self)
 
def get_Y (self)
 
def get_X (self)
 
def get_elementname (self)
 
def get_name (self)
 
def get_input_name (self)
 
def get_seedline (self)
 
def set_X (self, X)
 
def set_Y (self, Y)
 
def set_sortcriteria (self, criteria)
 
def __gt__ (self, other)
 

Private Member Functions

def __init_properties (self)
 
def __initialize (self)
 

Private Attributes

 __input_name
 
 __name
 
 __A
 
 __Z
 
 __N
 
 __warn
 
 __quiet
 
 __ab
 
 __is_stable
 
 __sort_Z
 
 __elementname
 
 __elname
 
 __not_a_isotope
 
 __nrnname
 

Detailed Description

nucleus: contains basic information of a nuclei. For example the name, the name in the network, the amount of protons, neutrons and the mass number

Definition at line 9 of file nucleus_class.py.

Constructor & Destructor Documentation

◆ __init__()

def bin.class_files.nucleus_class.nucleus.__init__ (   self,
  name = '',
  Z = -1,
  N = -1,
  Y = 0.,
  quiet = False,
  init_prop = False 
)
Input:
  name       - name of the nuclei. All informations are extracted from this name.

Definition at line 15 of file nucleus_class.py.

Member Function Documentation

◆ __gt__()

def bin.class_files.nucleus_class.nucleus.__gt__ (   self,
  other 
)
A nucleus is greater if it has an higher proton number

Definition at line 235 of file nucleus_class.py.

◆ __init_properties()

def bin.class_files.nucleus_class.nucleus.__init_properties (   self)
private
  Initialize basic properties, like stableness etc.

Definition at line 71 of file nucleus_class.py.

◆ __initialize()

def bin.class_files.nucleus_class.nucleus.__initialize (   self)
private
Extract the information of protonnumber neutronnumber out of the name.

Definition at line 97 of file nucleus_class.py.

◆ get_A()

def bin.class_files.nucleus_class.nucleus.get_A (   self)
get_A : Get the mass number of the nucleus

Definition at line 139 of file nucleus_class.py.

◆ get_elementname()

def bin.class_files.nucleus_class.nucleus.get_elementname (   self)
get_elementname : Get the corresponding name of the element (as a string)

Definition at line 175 of file nucleus_class.py.

◆ get_elnames()

def bin.class_files.nucleus_class.nucleus.get_elnames (   self)
get_elnames : Get elementnames

Definition at line 145 of file nucleus_class.py.

◆ get_input_name()

def bin.class_files.nucleus_class.nucleus.get_input_name (   self)
get_input_name : Get the name as it was inputted

Definition at line 187 of file nucleus_class.py.

◆ get_N()

def bin.class_files.nucleus_class.nucleus.get_N (   self)
get_N : Get the neutron number of the nucleus

Definition at line 157 of file nucleus_class.py.

◆ get_name()

def bin.class_files.nucleus_class.nucleus.get_name (   self)
get_name : Get the full name of the nucleus. The name is the elementname plus the massnumber as a string

Definition at line 181 of file nucleus_class.py.

◆ get_not_a_isotope()

def bin.class_files.nucleus_class.nucleus.get_not_a_isotope (   self)
Check if the input was a valid isotope. True if not, False if it is valid

Definition at line 91 of file nucleus_class.py.

◆ get_seedline()

def bin.class_files.nucleus_class.nucleus.get_seedline (   self)
get_seedline : Get the line for the nucleus as it is necessary for the seed file

Definition at line 196 of file nucleus_class.py.

Here is the call graph for this function:

◆ get_X()

def bin.class_files.nucleus_class.nucleus.get_X (   self)
get_X : Get the mass fraction of the nucleus

Definition at line 169 of file nucleus_class.py.

◆ get_Y()

def bin.class_files.nucleus_class.nucleus.get_Y (   self)
get_Y : Get the abundance of the nucleus

Definition at line 163 of file nucleus_class.py.

◆ get_Z()

def bin.class_files.nucleus_class.nucleus.get_Z (   self)
get_Z : Get the proton number of the nucleus

Definition at line 151 of file nucleus_class.py.

◆ is_stable()

def bin.class_files.nucleus_class.nucleus.is_stable (   self)
  Is it a stable nucleus?

Definition at line 84 of file nucleus_class.py.

◆ set_sortcriteria()

def bin.class_files.nucleus_class.nucleus.set_sortcriteria (   self,
  criteria 
)
set_sortcriteria : Set the criteria for sorting (possible values are "A" and "Z")

Definition at line 226 of file nucleus_class.py.

◆ set_X()

def bin.class_files.nucleus_class.nucleus.set_X (   self,
  X 
)
set_X : set the massfraction of the nucleus

Definition at line 214 of file nucleus_class.py.

◆ set_Y()

def bin.class_files.nucleus_class.nucleus.set_Y (   self,
  Y 
)
set_X : set the massfraction of the nucleus

Definition at line 220 of file nucleus_class.py.

Member Data Documentation

◆ __A

bin.class_files.nucleus_class.nucleus.__A
private

Definition at line 22 of file nucleus_class.py.

◆ __ab

bin.class_files.nucleus_class.nucleus.__ab
private

Definition at line 27 of file nucleus_class.py.

◆ __elementname

bin.class_files.nucleus_class.nucleus.__elementname
private

Definition at line 46 of file nucleus_class.py.

◆ __elname

bin.class_files.nucleus_class.nucleus.__elname
private

Definition at line 47 of file nucleus_class.py.

◆ __input_name

bin.class_files.nucleus_class.nucleus.__input_name
private

Definition at line 20 of file nucleus_class.py.

◆ __is_stable

bin.class_files.nucleus_class.nucleus.__is_stable
private

Definition at line 28 of file nucleus_class.py.

◆ __N

bin.class_files.nucleus_class.nucleus.__N
private

Definition at line 24 of file nucleus_class.py.

◆ __name

bin.class_files.nucleus_class.nucleus.__name
private

Definition at line 21 of file nucleus_class.py.

◆ __not_a_isotope

bin.class_files.nucleus_class.nucleus.__not_a_isotope
private

Definition at line 67 of file nucleus_class.py.

◆ __nrnname

bin.class_files.nucleus_class.nucleus.__nrnname
private

Definition at line 119 of file nucleus_class.py.

◆ __quiet

bin.class_files.nucleus_class.nucleus.__quiet
private

Definition at line 26 of file nucleus_class.py.

◆ __sort_Z

bin.class_files.nucleus_class.nucleus.__sort_Z
private

Definition at line 30 of file nucleus_class.py.

◆ __warn

bin.class_files.nucleus_class.nucleus.__warn
private

Definition at line 25 of file nucleus_class.py.

◆ __Z

bin.class_files.nucleus_class.nucleus.__Z
private

Definition at line 23 of file nucleus_class.py.