VeraGridEngine.Devices.Fluid package

Submodules

VeraGridEngine.Devices.Fluid.fluid_injection_template module

class VeraGridEngine.Devices.Fluid.fluid_injection_template.FluidInjectionTemplate(name: str = '', idtag: str | None = None, code: str = '', efficiency: float = 1.0, max_flow_rate: float = 0.0, plant: FluidNode = None, generator: Generator = None, device_type: DeviceType = Fluid Turbine, build_status: BuildStatus = Commissioned)[source]

Bases: PhysicalDevice

CLASS_NON_EDITABLE_PROPERTIES: Tuple[str, ...] = ('idtag', 'diff_changes', 'plant', 'generator')
CLASS_PROPERTIES_WITH_PROFILE: Dict[str, str] = {'active': 'active_prof'}
CLASS_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:modelling_authority, prop:commissioned_date, prop:decommissioned_date, prop:build_status, prop:owners, prop:active, prop:efficiency, prop:max_flow_rate, prop:plant, prop:generator, prop:facility)
CLASS_PROPERTY_LIST: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:modelling_authority, prop:commissioned_date, prop:decommissioned_date, prop:build_status, prop:owners, prop:active, prop:efficiency, prop:max_flow_rate, prop:plant, prop:generator, prop:facility)
CLASS_REGISTERED_PROPERTIES: Dict[str, GCProp] = {'action': prop:action, 'active': prop:active, 'build_status': prop:build_status, 'code': prop:code, 'comment': prop:comment, 'commissioned_date': prop:commissioned_date, 'decommissioned_date': prop:decommissioned_date, 'diff_changes': prop:diff_changes, 'efficiency': prop:efficiency, 'facility': prop:facility, 'generator': prop:generator, 'idtag': prop:idtag, 'max_flow_rate': prop:max_flow_rate, 'modelling_authority': prop:modelling_authority, 'name': prop:name, 'owners': prop:owners, 'plant': prop:plant, 'rdfid': prop:rdfid}
LOCAL_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:active, prop:efficiency, prop:max_flow_rate, prop:plant, prop:generator, prop:facility)
property active: bool

Get active.

Returns:

bool

property active_prof: ProfileBool

Cost profile :return: Profile

build_status
property efficiency: float

Get efficiency.

Returns:

float

facility: Facility | None
property generator: Generator

Generator getter :return: Generator

property max_flow_rate: float

Get max_flow_rate.

Returns:

float

property plant: FluidNode

Plant getter :return: FluidNode

VeraGridEngine.Devices.Fluid.fluid_node module

class VeraGridEngine.Devices.Fluid.fluid_node.FluidNode(name: str = '', idtag: str | None = None, code: str = '', min_level: float = 0.0, max_level: float = 0.0, min_soc: float = 0.0, max_soc: float = 1.0, current_level: float = 0.0, spillage_cost: float = 1000.0, inflow: float = 0.0, bus: None | Bus = None, build_status: BuildStatus = Commissioned, color: str | None = None)[source]

Bases: PhysicalDevice

CLASS_NON_EDITABLE_PROPERTIES: Tuple[str, ...] = ('idtag', 'diff_changes', 'bus')
CLASS_PROPERTIES_WITH_PROFILE: Dict[str, str] = {'inflow': 'inflow_prof', 'max_soc': 'max_soc_prof', 'min_soc': 'min_soc_prof', 'spillage_cost': 'spillage_cost_prof'}
CLASS_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:modelling_authority, prop:commissioned_date, prop:decommissioned_date, prop:build_status, prop:owners, prop:min_level, prop:max_level, prop:min_soc, prop:max_soc, prop:initial_level, prop:bus, prop:spillage_cost, prop:inflow, prop:color)
CLASS_PROPERTY_LIST: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:modelling_authority, prop:commissioned_date, prop:decommissioned_date, prop:build_status, prop:owners, prop:min_level, prop:max_level, prop:min_soc, prop:max_soc, prop:initial_level, prop:bus, prop:spillage_cost, prop:inflow, prop:color)
CLASS_REGISTERED_PROPERTIES: Dict[str, GCProp] = {'action': prop:action, 'build_status': prop:build_status, 'bus': prop:bus, 'code': prop:code, 'color': prop:color, 'comment': prop:comment, 'commissioned_date': prop:commissioned_date, 'decommissioned_date': prop:decommissioned_date, 'diff_changes': prop:diff_changes, 'idtag': prop:idtag, 'inflow': prop:inflow, 'initial_level': prop:initial_level, 'max_level': prop:max_level, 'max_soc': prop:max_soc, 'min_level': prop:min_level, 'min_soc': prop:min_soc, 'modelling_authority': prop:modelling_authority, 'name': prop:name, 'owners': prop:owners, 'rdfid': prop:rdfid, 'spillage_cost': prop:spillage_cost}
LOCAL_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:min_level, prop:max_level, prop:min_soc, prop:max_soc, prop:initial_level, prop:bus, prop:spillage_cost, prop:inflow, prop:color)
build_status
property bus: Bus | None

Bus getter function :return: Bus

color
copy()[source]

Make a deep copy of this object :return: Copy of this object

get_inflow_at(t: int | None) → float[source]
Parameters:

t

Returns:

get_max_soc_at(t: int | None) → float[source]
Parameters:

t

Returns:

get_min_soc_at(t: int | None) → float[source]
Parameters:

t

Returns:

get_spillage_cost_at(t: int | None) → float[source]
Parameters:

t

Returns:

property inflow: float

Get inflow.

Returns:

float

property inflow_prof: ProfileFloat

Cost profile :return: Profile

property initial_level: float

Get initial_level.

Returns:

float

property max_level: float

Get max_level.

Returns:

float

property max_soc: float

Get max_soc.

Returns:

float

property max_soc_prof: ProfileFloat

Max soc profile :return: Profile

property min_level: float

Get min_level.

Returns:

float

property min_soc: float

Get min_soc.

Returns:

float

property min_soc_prof: ProfileFloat

Min soc profile :return: Profile

property spillage_cost: float

Get spillage_cost.

Returns:

float

property spillage_cost_prof: ProfileFloat

Cost profile :return: Profile

VeraGridEngine.Devices.Fluid.fluid_p2x module

class VeraGridEngine.Devices.Fluid.fluid_p2x.FluidP2x(name: str = '', idtag: str | None = None, code: str = '', efficiency: float = 1.0, max_flow_rate: float = 0.0, plant: FluidNode = None, generator: Generator = None)[source]

Bases: FluidInjectionTemplate

CLASS_NON_EDITABLE_PROPERTIES: Tuple[str, ...] = ('idtag', 'diff_changes', 'plant', 'generator')
CLASS_PROPERTIES_WITH_PROFILE: Dict[str, str] = {'active': 'active_prof'}
CLASS_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:modelling_authority, prop:commissioned_date, prop:decommissioned_date, prop:build_status, prop:owners, prop:active, prop:efficiency, prop:max_flow_rate, prop:plant, prop:generator, prop:facility)
CLASS_PROPERTY_LIST: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:modelling_authority, prop:commissioned_date, prop:decommissioned_date, prop:build_status, prop:owners, prop:active, prop:efficiency, prop:max_flow_rate, prop:plant, prop:generator, prop:facility)
CLASS_REGISTERED_PROPERTIES: Dict[str, GCProp] = {'action': prop:action, 'active': prop:active, 'build_status': prop:build_status, 'code': prop:code, 'comment': prop:comment, 'commissioned_date': prop:commissioned_date, 'decommissioned_date': prop:decommissioned_date, 'diff_changes': prop:diff_changes, 'efficiency': prop:efficiency, 'facility': prop:facility, 'generator': prop:generator, 'idtag': prop:idtag, 'max_flow_rate': prop:max_flow_rate, 'modelling_authority': prop:modelling_authority, 'name': prop:name, 'owners': prop:owners, 'plant': prop:plant, 'rdfid': prop:rdfid}
build_status
facility: Facility | None

VeraGridEngine.Devices.Fluid.fluid_path module

class VeraGridEngine.Devices.Fluid.fluid_path.FluidPath(name: str = '', idtag: str | None = None, code: str = '', source: FluidNode = None, target: FluidNode = None, min_flow: float = 0.0, max_flow: float = 0.0, color: str | None = None, build_status: BuildStatus = Commissioned)[source]

Bases: PhysicalDevice

CLASS_NON_EDITABLE_PROPERTIES: Tuple[str, ...] = ('idtag', 'diff_changes', 'locations')
CLASS_PROPERTIES_WITH_PROFILE: Dict[str, str] = {}
CLASS_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:modelling_authority, prop:commissioned_date, prop:decommissioned_date, prop:build_status, prop:owners, prop:source, prop:target, prop:min_flow, prop:max_flow, prop:locations, prop:color)
CLASS_PROPERTY_LIST: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:modelling_authority, prop:commissioned_date, prop:decommissioned_date, prop:build_status, prop:owners, prop:source, prop:target, prop:min_flow, prop:max_flow, prop:locations, prop:color)
CLASS_REGISTERED_PROPERTIES: Dict[str, GCProp] = {'action': prop:action, 'build_status': prop:build_status, 'code': prop:code, 'color': prop:color, 'comment': prop:comment, 'commissioned_date': prop:commissioned_date, 'decommissioned_date': prop:decommissioned_date, 'diff_changes': prop:diff_changes, 'idtag': prop:idtag, 'locations': prop:locations, 'max_flow': prop:max_flow, 'min_flow': prop:min_flow, 'modelling_authority': prop:modelling_authority, 'name': prop:name, 'owners': prop:owners, 'rdfid': prop:rdfid, 'source': prop:source, 'target': prop:target}
LOCAL_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:source, prop:target, prop:min_flow, prop:max_flow, prop:locations, prop:color)
color
copy()[source]

Make a deep copy of this object :return: Copy of this object

get_from_and_to_objects() → Tuple[CONNECTION_TYPE, CONNECTION_TYPE, bool][source]

Get the from and to connection objects of the branch :return: Object from, Object to, is it ok?

property locations: LineLocations

Cost profile :return: Profile

property max_flow: float

Get max_flow.

Returns:

float

property min_flow: float

Get min_flow.

Returns:

float

source
target

VeraGridEngine.Devices.Fluid.fluid_pump module

class VeraGridEngine.Devices.Fluid.fluid_pump.FluidPump(name: str = '', idtag: str | None = None, code: str = '', efficiency: float = 1.0, max_flow_rate: float = 0.0, reservoir: FluidNode = None, generator: Generator = None)[source]

Bases: FluidInjectionTemplate

CLASS_NON_EDITABLE_PROPERTIES: Tuple[str, ...] = ('idtag', 'diff_changes', 'plant', 'generator')
CLASS_PROPERTIES_WITH_PROFILE: Dict[str, str] = {'active': 'active_prof'}
CLASS_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:modelling_authority, prop:commissioned_date, prop:decommissioned_date, prop:build_status, prop:owners, prop:active, prop:efficiency, prop:max_flow_rate, prop:plant, prop:generator, prop:facility)
CLASS_PROPERTY_LIST: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:modelling_authority, prop:commissioned_date, prop:decommissioned_date, prop:build_status, prop:owners, prop:active, prop:efficiency, prop:max_flow_rate, prop:plant, prop:generator, prop:facility)
CLASS_REGISTERED_PROPERTIES: Dict[str, GCProp] = {'action': prop:action, 'active': prop:active, 'build_status': prop:build_status, 'code': prop:code, 'comment': prop:comment, 'commissioned_date': prop:commissioned_date, 'decommissioned_date': prop:decommissioned_date, 'diff_changes': prop:diff_changes, 'efficiency': prop:efficiency, 'facility': prop:facility, 'generator': prop:generator, 'idtag': prop:idtag, 'max_flow_rate': prop:max_flow_rate, 'modelling_authority': prop:modelling_authority, 'name': prop:name, 'owners': prop:owners, 'plant': prop:plant, 'rdfid': prop:rdfid}
build_status
facility: Facility | None

VeraGridEngine.Devices.Fluid.fluid_turbine module

class VeraGridEngine.Devices.Fluid.fluid_turbine.FluidTurbine(name: str = '', idtag: str | None = None, code: str = '', efficiency: float = 1.0, max_flow_rate: float = 0.0, plant: FluidNode = None, generator: Generator = None)[source]

Bases: FluidInjectionTemplate

CLASS_NON_EDITABLE_PROPERTIES: Tuple[str, ...] = ('idtag', 'diff_changes', 'plant', 'generator')
CLASS_PROPERTIES_WITH_PROFILE: Dict[str, str] = {'active': 'active_prof'}
CLASS_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:modelling_authority, prop:commissioned_date, prop:decommissioned_date, prop:build_status, prop:owners, prop:active, prop:efficiency, prop:max_flow_rate, prop:plant, prop:generator, prop:facility)
CLASS_PROPERTY_LIST: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:modelling_authority, prop:commissioned_date, prop:decommissioned_date, prop:build_status, prop:owners, prop:active, prop:efficiency, prop:max_flow_rate, prop:plant, prop:generator, prop:facility)
CLASS_REGISTERED_PROPERTIES: Dict[str, GCProp] = {'action': prop:action, 'active': prop:active, 'build_status': prop:build_status, 'code': prop:code, 'comment': prop:comment, 'commissioned_date': prop:commissioned_date, 'decommissioned_date': prop:decommissioned_date, 'diff_changes': prop:diff_changes, 'efficiency': prop:efficiency, 'facility': prop:facility, 'generator': prop:generator, 'idtag': prop:idtag, 'max_flow_rate': prop:max_flow_rate, 'modelling_authority': prop:modelling_authority, 'name': prop:name, 'owners': prop:owners, 'plant': prop:plant, 'rdfid': prop:rdfid}
build_status
facility: Facility | None

Module contents