pyPRISM.core.ValueTable module¶
-
class
pyPRISM.core.ValueTable.ValueTable(types, name)[source]¶ Bases:
pyPRISM.core.Table.TableContainer for data that is keyed by types
Description
The goal of this class is to provide a simple inteface for setting and storing parameters that are accessed and identified by types. This is typically site properties, e.g. density, site diameter. By default the value for all types is set to None and therefore can be checked to see if the table has been fully specified.
Setter/getter methods have been create to set groups of types simultaneously. This allows for the rapid construction of datasets where many of the parameters are repeTated.
Note that, unlike the
pyPRISM.core.MatrixArray, this container is not meant to be used for mathematics. The benefit of this is that, for each type, it can contain any arbitrary number, string, or Python object.See the example below and the pyPRISM Internals section of the Tutorial for more information.
Example
import pyPRISM VT = pyPRISM.ValueTable(['A','B','C','D','E'],name='density') # set the value for type A to be 0.25 VT['A'] = 0.25 # set the value for types B & C to be 0.35 VT[ ['B','C'] ] = 0.35 # set all other values to be 0.1 VT.setUnset(0.1) for i,t,v in VT: print('{}) {} for type {} is {}'.format(i,VT.name,t,v)) # The above loop prints the following: # 0) density for type A is 0.25 # 1) density for type B is 0.35 # 2) density for type C is 0.35 # 3) density for type D is 0.1 # 4) density for type E is 0.1
-
__init__(types, name)[source]¶ Constructor
Parameters: - types (list) – Lists of the types that will be used to key the ValueTable. The length of this list should be equal to the rank of the PRISM problem to be solved i.e. len(types) == number of sites in system.
- name (string) – The name of the ValueTable. Currently, this is simply used as a convencience for identifying the table internally.
-