name

Added in version 3.0.0.

Calling sequence

splitquantum{ region{ name = "..." } }

Properties

• usage: \(\mathrm{\textcolor{WildStrawberry}{required}}\)

• type: character string

Functionality

Provides a name for the quantum region. This name can be further used to link other models to this specific region.

---

x

Added in version 3.0.0.

Calling sequence

splitquantum{ region{ x = [..., ...] } }

Properties

• usage: \(\mathrm{\textcolor{WildStrawberry}{required}}\)

• type: vector of 2 real numbers: \((r_1, r_2)\)

• values: no constraints

• units: \([r_1]=\mathrm{nm}\), \([r_2]=\mathrm{nm}\)

Functionality

Defines the range of quantum region along the x-axis of the simulation domain with \(r_1\) and \(r_2\) defining the beginning and the end of the range, respectively.

---

y

Added in version 3.0.0.

Calling sequence

splitquantum{ region{ y = [..., ...] } }

Properties

• usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)

• type: vector of 2 real numbers: \((r_1, r_2)\)

• values: no constraints

• default: \(r_1=0.0\), \(r_2=0.0\)

• units: \([r_1]=\mathrm{nm}\), \([r_2]=\mathrm{nm}\)

Dependencies

— Can be used for 2D or 3D calculations only.

Functionality

Defines the range of quantum region along the y-axis of the simulation domain with \(r_1\) and \(r_2\) defining the beginning and the end of the range, respectively.

---

z

Added in version 3.0.0.

Calling sequence

splitquantum{ region{ z = [..., ...] } }

Properties

• usage: \(\mathrm{\textcolor{ForestGreen}{optional}}\)

• type: vector of 2 real numbers: \((r_1, r_2)\)

• values: no constraints

• default: \(r_1=0.0\), \(r_2=0.0\)

• units: \([r_1]=\mathrm{nm}\), \([r_2]=\mathrm{nm}\)

Dependencies

— Can be used for 3D calculation only.

Functionality

Defines the range of quantum region along the z-axis of the simulation domain with \(r_1\) and \(r_2\) defining the beginning and the end of the range, respectively.