utopia.objects_generation

Contains all the functions to generate the model objects: model box, model compartments and the model particles (MP ans SPM)

Classes

`Box`	Class box generates one object box representing the unit world in the case of the UTOPIA parameterization that can contain 17 compartments and that can have conexions to other boxes (for example if conecting several UTOPIA boxes to give spatial resolution)
`Compartment`	Class Compartment (parent class) generates compartment objects that belong by default to an assigned model box (Cbox). Each compartment contains four different particle objects corresponding to the 4 described aggregation states of UTOPIA (freeMP, heterMP, biofMP, heterBiofMP) and the processes that can occur in the compartment are listed under the processess attribute. Each compartment has a set of connexions withing the UTOPIA box listed in the conexions attribute wich will be asigned by reading on the conexions input file of the model.
`compartment_water`	Class Compartment (parent class) generates compartment objects that belong by default to an assigned model box (Cbox). Each compartment contains four different particle objects corresponding to the 4 described aggregation states of UTOPIA (freeMP, heterMP, biofMP, heterBiofMP) and the processes that can occur in the compartment are listed under the processess attribute. Each compartment has a set of connexions withing the UTOPIA box listed in the conexions attribute wich will be asigned by reading on the conexions input file of the model.
`compartment_surfaceSea_water`	Class Compartment (parent class) generates compartment objects that belong by default to an assigned model box (Cbox). Each compartment contains four different particle objects corresponding to the 4 described aggregation states of UTOPIA (freeMP, heterMP, biofMP, heterBiofMP) and the processes that can occur in the compartment are listed under the processess attribute. Each compartment has a set of connexions withing the UTOPIA box listed in the conexions attribute wich will be asigned by reading on the conexions input file of the model.
`compartment_sediment`	Class Compartment (parent class) generates compartment objects that belong by default to an assigned model box (Cbox). Each compartment contains four different particle objects corresponding to the 4 described aggregation states of UTOPIA (freeMP, heterMP, biofMP, heterBiofMP) and the processes that can occur in the compartment are listed under the processess attribute. Each compartment has a set of connexions withing the UTOPIA box listed in the conexions attribute wich will be asigned by reading on the conexions input file of the model.
`compartment_soil_surface`	Class Compartment (parent class) generates compartment objects that belong by default to an assigned model box (Cbox). Each compartment contains four different particle objects corresponding to the 4 described aggregation states of UTOPIA (freeMP, heterMP, biofMP, heterBiofMP) and the processes that can occur in the compartment are listed under the processess attribute. Each compartment has a set of connexions withing the UTOPIA box listed in the conexions attribute wich will be asigned by reading on the conexions input file of the model.
`compartment_deep_soil`	Class Compartment (parent class) generates compartment objects that belong by default to an assigned model box (Cbox). Each compartment contains four different particle objects corresponding to the 4 described aggregation states of UTOPIA (freeMP, heterMP, biofMP, heterBiofMP) and the processes that can occur in the compartment are listed under the processess attribute. Each compartment has a set of connexions withing the UTOPIA box listed in the conexions attribute wich will be asigned by reading on the conexions input file of the model.
`compartment_air`	Class Compartment (parent class) generates compartment objects that belong by default to an assigned model box (Cbox). Each compartment contains four different particle objects corresponding to the 4 described aggregation states of UTOPIA (freeMP, heterMP, biofMP, heterBiofMP) and the processes that can occur in the compartment are listed under the processess attribute. Each compartment has a set of connexions withing the UTOPIA box listed in the conexions attribute wich will be asigned by reading on the conexions input file of the model.
`Particulates`	Class Particulates generates particulate objects, especifically microplastic particle objects. The class defines a particle object by its composition, shape and dimensions
`ParticulatesBF`	This is a class to create ParticulatesBIOFILM objects
`ParticulatesSPM`	This is a class to create ParticulatesSPM objects

Functions

generate_objects()

Function for generating the UTOPIA model objects: model box, model compartments and the model particles

Module Contents

class utopia.objects_generation.Box(Bname, Bdepth_m=None, Blength_m=None, Bwidth_m=None, Bvolume_m3=None, Bconexions=None)[source]

Class box generates one object box representing the unit world in the case of the UTOPIA parameterization that can contain 17 compartments and that can have conexions to other boxes (for example if conecting several UTOPIA boxes to give spatial resolution)

description = 'Generic Box class'

Bname

Bdepth_m = None

Blength_m = None

Bwidth_m = None

Bvolume_m3 = None

compartments = []

Bconexions = None

__repr__()[source]

add_compartment(comp)[source]

calc_Bvolume_m3()[source]

class utopia.objects_generation.Compartment(Cname, Cdepth_m=None, Clength_m=None, Cwidth_m=None, Cvolume_m3=None, CsurfaceArea_m2=None)[source]

Class Compartment (parent class) generates compartment objects that belong by default to an assigned model box (Cbox). Each compartment contains four different particle objects corresponding to the 4 described aggregation states of UTOPIA (freeMP, heterMP, biofMP, heterBiofMP) and the processes that can occur in the compartment are listed under the processess attribute. Each compartment has a set of connexions withing the UTOPIA box listed in the conexions attribute wich will be asigned by reading on the conexions input file of the model.

Cname

Cdepth_m = None

Clength_m = None

Cwidth_m = None

Cvolume_m3 = None

CsurfaceArea_m2 = None

particles

processess = ['degradation', 'fragmentation', 'heteroaggregation', 'heteroaggregate_breackup', 'biofouling',...

connexions = []

assign_box(Box)[source]

add_particles(particle)[source]

calc_volume()[source]

calc_vol_fromBox()[source]

calc_particleConcentration_Nm3_initial()[source]

class utopia.objects_generation.compartment_water(Cname, SPM_mgL, waterFlow_m3_s, T_K, G, Cdepth_m=None, Clength_m=None, Cwidth_m=None, Cvolume_m3=None, CsurfaceArea_m2=None, flowVelocity_m_s=None)[source]

Bases: Compartment

Class Compartment (parent class) generates compartment objects that belong by default to an assigned model box (Cbox). Each compartment contains four different particle objects corresponding to the 4 described aggregation states of UTOPIA (freeMP, heterMP, biofMP, heterBiofMP) and the processes that can occur in the compartment are listed under the processess attribute. Each compartment has a set of connexions withing the UTOPIA box listed in the conexions attribute wich will be asigned by reading on the conexions input file of the model.

SPM_mgL

flowVelocity_m_s = None

waterFlow_m3_s

T_K

G

processess = ['discorporation', 'fragmentation', 'heteroaggregation', 'heteroaggregate_breackup',...

class utopia.objects_generation.compartment_surfaceSea_water(Cname, SPM_mgL, waterFlow_m3_s, T_K, G, Cdepth_m=None, Clength_m=None, Cwidth_m=None, Cvolume_m3=None, CsurfaceArea_m2=None, flowVelocity_m_s=None)[source]

Bases: Compartment

Class Compartment (parent class) generates compartment objects that belong by default to an assigned model box (Cbox). Each compartment contains four different particle objects corresponding to the 4 described aggregation states of UTOPIA (freeMP, heterMP, biofMP, heterBiofMP) and the processes that can occur in the compartment are listed under the processess attribute. Each compartment has a set of connexions withing the UTOPIA box listed in the conexions attribute wich will be asigned by reading on the conexions input file of the model.

SPM_mgL

flowVelocity_m_s = None

waterFlow_m3_s

T_K

G

processess = ['discorporation', 'fragmentation', 'heteroaggregation', 'heteroaggregate_breackup',...

class utopia.objects_generation.compartment_sediment(Cname, Cdepth_m=None, Clength_m=None, Cwidth_m=None, Cvolume_m3=None, CsurfaceArea_m2=None)[source]

Bases: Compartment

Class Compartment (parent class) generates compartment objects that belong by default to an assigned model box (Cbox). Each compartment contains four different particle objects corresponding to the 4 described aggregation states of UTOPIA (freeMP, heterMP, biofMP, heterBiofMP) and the processes that can occur in the compartment are listed under the processess attribute. Each compartment has a set of connexions withing the UTOPIA box listed in the conexions attribute wich will be asigned by reading on the conexions input file of the model.

processess = ['discorporation', 'fragmentation', 'sediment_resuspension', 'burial']

class utopia.objects_generation.compartment_soil_surface(Cname, Cdepth_m=None, Clength_m=None, Cwidth_m=None, Cvolume_m3=None, CsurfaceArea_m2=None)[source]

Bases: Compartment

Class Compartment (parent class) generates compartment objects that belong by default to an assigned model box (Cbox). Each compartment contains four different particle objects corresponding to the 4 described aggregation states of UTOPIA (freeMP, heterMP, biofMP, heterBiofMP) and the processes that can occur in the compartment are listed under the processess attribute. Each compartment has a set of connexions withing the UTOPIA box listed in the conexions attribute wich will be asigned by reading on the conexions input file of the model.

processess = ['discorporation', 'fragmentation', 'runoff_transport', 'percolation', 'soil_air_resuspension',...

class utopia.objects_generation.compartment_deep_soil(Cname, Cdepth_m=None, Clength_m=None, Cwidth_m=None, Cvolume_m3=None, CsurfaceArea_m2=None)[source]

Bases: Compartment

Class Compartment (parent class) generates compartment objects that belong by default to an assigned model box (Cbox). Each compartment contains four different particle objects corresponding to the 4 described aggregation states of UTOPIA (freeMP, heterMP, biofMP, heterBiofMP) and the processes that can occur in the compartment are listed under the processess attribute. Each compartment has a set of connexions withing the UTOPIA box listed in the conexions attribute wich will be asigned by reading on the conexions input file of the model.

processess = ['discorporation', 'fragmentation', 'sequestration_deep_soils', 'soil_convection']

class utopia.objects_generation.compartment_air(Cname, T_K=None, wind_speed_m_s=None, I_rainfall_mm=None, Cdepth_m=None, Clength_m=None, Cwidth_m=None, Cvolume_m3=None, CsurfaceArea_m2=None, flowVelocity_m_s=None)[source]

Bases: Compartment

Class Compartment (parent class) generates compartment objects that belong by default to an assigned model box (Cbox). Each compartment contains four different particle objects corresponding to the 4 described aggregation states of UTOPIA (freeMP, heterMP, biofMP, heterBiofMP) and the processes that can occur in the compartment are listed under the processess attribute. Each compartment has a set of connexions withing the UTOPIA box listed in the conexions attribute wich will be asigned by reading on the conexions input file of the model.

T_K = None

wind_speed_m_s = None

I_rainfall_mm = None

flowVelocity_m_s = None

processess = ['discorporation', 'fragmentation', 'wind_trasport', 'dry_deposition', 'wet_deposition']

class utopia.objects_generation.Particulates(Pname, Pform, Pcomposition, Pdensity_kg_m3, Pshape, PdimensionX_um, PdimensionY_um, PdimensionZ_um, t_half_d=5000, Pnumber_t0=None)[source]

Class Particulates generates particulate objects, especifically microplastic particle objects. The class defines a particle object by its composition, shape and dimensions

Pname

Pform

Pcomposition

Pdensity_kg_m3

Pshape

PdimensionX_um

PdimensionY_um

PdimensionZ_um

PdimensionX_m

PdimensionY_m

PdimensionZ_m

Pnumber_t0 = None

radius_m

diameter_m

diameter_um

Pemiss_t_y = 0

t_half_d = 5000

__repr__()[source]

calc_volume()[source]: Particle volume calculation. Different formulas for different particle shapes, currently defined for spheres, fibres, cylinders, pellets and irregular fragments

calc_numConc(concMass_mg_L, concNum_part_L)[source]

assign_compartment(comp)[source]

class utopia.objects_generation.ParticulatesBF(parentMP, spm)[source]

Bases: Particulates

This is a class to create ParticulatesBIOFILM objects

species = 'particulate'

Pname

Pcomposition

Pform = 'biofMP'

parentMP

BF_density_kg_m3

BF_thickness_um

radius_m

diameter_m

diameter_um

t_half_d = 25000

Pshape

Pdensity_kg_m3

PdimensionX_m = 0.0

PdimensionY_m = 0.0

PdimensionZ_m = 0.0

class utopia.objects_generation.ParticulatesSPM(parentSPM, parentMP)[source]

Bases: Particulates

This is a class to create ParticulatesSPM objects

species = 'particulate'

Pname

Pcomposition

parentMP

parentSPM

Pdensity_kg_m3

radius_m

diameter_m

diameter_um

Pshape

calc_volume_heter(parentMP, parentSPM)[source]

utopia.objects_generation.generate_objects()[source]: Function for generating the UTOPIA model objects: model box, model compartments and the model particles