Skip to content

global_variables

Module containing variables necessary for running PROCESS

CREATE_DICTS_FROM_DATACLASS = GlobalData module-attribute

GlobalData dataclass

Dataclass holding global variables

Source code in process/data_structure/global_variables.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
@dataclass(slots=True)
class GlobalData:
    """Dataclass holding global variables"""

    icase: str = "Steady-state tokamak model"
    """Power plant type"""

    runtitle: str = "Run Title (change this line using input variable 'runtitle')"
    """A short descriptive title for the run"""

    maxcal: int = 200
    """Maximum number of solver iterations"""

    fileprefix: str = ""
    """Path to input file"""

    output_prefix: str = ""
    """Output file path prefix"""

    xlabel: str = ""
    """Scan parameter description label"""

    vlabel: str = ""
    """Scan value name label"""

    xlabel_2: str = ""
    """Scan parameter description label (2nd dimension)"""

    vlabel_2: str = ""
    """Scan value name label (2nd dimension)"""

    iscan_global: int = 0

    convergence_parameter: float = 0.0
    """VMCON convergence parameter 'sum'"""

icase = 'Steady-state tokamak model' class-attribute instance-attribute

Power plant type

runtitle = "Run Title (change this line using input variable 'runtitle')" class-attribute instance-attribute

A short descriptive title for the run

maxcal = 200 class-attribute instance-attribute

Maximum number of solver iterations

fileprefix = '' class-attribute instance-attribute

Path to input file

output_prefix = '' class-attribute instance-attribute

Output file path prefix

xlabel = '' class-attribute instance-attribute

Scan parameter description label

vlabel = '' class-attribute instance-attribute

Scan value name label

xlabel_2 = '' class-attribute instance-attribute

Scan parameter description label (2nd dimension)

vlabel_2 = '' class-attribute instance-attribute

Scan value name label (2nd dimension)

iscan_global = 0 class-attribute instance-attribute

convergence_parameter = 0.0 class-attribute instance-attribute

VMCON convergence parameter 'sum'