# EV

> Electric vehicle model

---

## Description
The EV class models an electric vehicle with various properties related
to its charging/discharging, energy levels, and scheduling details.

## Creation

### Syntax
```matlab
ev = EV()
ev = EV(Name=Value)
```

### Name-Value Arguments
| Name | Type | Description |
|------|------|--------------|
| `Charger_ind` | *1 (default) \| positive integer* | Charger index |
| `Group_ind` | *1 (default) \| positive integer* | Group index |
| `Sigma` | *1 (default) \| nonnegative scalar* | Battery degradation coefficient (load flattening problem) |
| `W_cs` | *1 (default) \| nonnegative scalar* | Weight for cost saving (user friendly problem) |
| `W_pc` | *0 (default) \| nonnegative scalar* | Weight for priority charging (user friendly problem) |
| `W_bs` | *0 (default) \| nonnegative scalar* | Weight for battery saving (user friendly problem) |
| `Arr_time` | *1 (default) \| positive integer* | Arrival time slot index of the vehicle |
| `Dep_time` | *2 (default) \| positive integer* | Departure time slot index of the vehicle |
| `E_min` | *0 (default) \| nonnegative scalar* | Minimum energy of the vehicle [kWh] |
| `E_cap` | *100 (default) \| nonnegative scalar* | Energy capacity of the vehicle [kWh] |
| `E_ini` | *20 (default) \| nonnegative scalar* | Initial energy of the vehicle [kWh] |
| `E_ref` | *60 (default) \| nonnegative scalar* | Reference energy of the vehicle [kWh] |
| `U_max` | *10 (default) \| nonnegative scalar* | Maximum charging rate [kW] |
| `U_min` | *-10 (default) \| nonpositive scalar* | Maximum discharging rate [kW] |


### Output Arguments
| Name | Type | Description |
|------|------|--------------|
| `ev` | *EV object* | Electric vehicle model |


## Properties
| Name | Type | Description |
|------|------|--------------|
| `Charger_ind` | *1 (default) \| positive integer* | Charger index |
| `Group_ind` | *1 (default) \| positive integer* | Group index |
| `Sigma` | *1 (default) \| nonnegative scalar* | Battery degradation coefficient (load flattening problem) |
| `W_cs` | *1 (default) \| nonnegative scalar* | Weight for cost saving (user friendly problem) |
| `W_pc` | *0 (default) \| nonnegative scalar* | Weight for priority charging (user friendly problem) |
| `W_bs` | *0 (default) \| nonnegative scalar* | Weight for battery saving (user friendly problem) |
| `Arr_time` | *1 (default) \| positive integer* | Arrival time slot index of the vehicle |
| `Dep_time` | *2 (default) \| positive integer* | Departure time slot index of the vehicle |
| `E_min` | *0 (default) \| nonnegative scalar* | Minimum energy of the vehicle [kWh] |
| `E_cap` | *100 (default) \| nonnegative scalar* | Energy capacity of the vehicle [kWh] |
| `E_ini` | *20 (default) \| nonnegative scalar* | Initial energy of the vehicle [kWh] |
| `E_ref` | *60 (default) \| nonnegative scalar* | Reference energy of the vehicle [kWh] |
| `U_max` | *10 (default) \| nonnegative scalar* | Maximum charging rate [kW] |
| `U_min` | *-10 (default) \| nonpositive scalar* | Maximum discharging rate [kW] |
| `valid` | *false (default) \| logical* | Validity flag indicating if the object is valid |


## Object Functions
| Name | Description |
|------|--------------|
| [set](../../methods/EV/set.md) | Set properties; this results in `valid = false` |
| [validate](../../methods/EV/validate.md) | Check whether an EV object satisfies required conditions |


```{toctree}
:maxdepth: 2
:hidden:
:caption: EV Methods

../../methods/EV/set
../../methods/EV/validate
```