Documentation for Box
Box class which represents each individual box in the carbon model.
__init__(name, reservoir, production_coefficient=0.0, hemisphere='None')
init method to initialise object.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name |
str
|
name of the Box. |
required |
reservoir |
float
|
reservoir content of the Box. |
required |
production_coefficient |
float
|
production coefficient of the Box. Defaults to 0. |
0.0
|
hemisphere |
str
|
hemisphere that this box is in. Defaults to None (i.e. this box is not part of an inter-hemispheric system). |
'None'
|
get_hemisphere()
Getter method for the hemisphere of the Box Class.
Returns:
| Type | Description |
|---|---|
str
|
hemisphere the box is in. |
get_name()
Getter method for the name of the Box Class.
Returns:
| Type | Description |
|---|---|
str
|
name of the Box. |
get_reservoir_content()
Getter method for the reservoir content of the Box Class.
Returns:
| Type | Description |
|---|---|
float
|
reservoir content of the box. |
get_production()
Getter method for the production coefficient of the Box Class.
Returns:
| Type | Description |
|---|---|
float
|
production coefficient of the box. |
__str__()
Overrides the default string behaviour to display a user-friendly output.
Returns:
| Type | Description |
|---|---|
str
|
string representation of the Box Object returned in the following form - name:reservoir size:production coefficient |