supersolids.helper.Box

Functions for Potential and initial wave function \(\psi_0\)

Module Contents

Classes

Box	Specifies the ranges in which the simulation is calculated (1D, 2D or 3D).

Functions

BoxResAssert(Res, Box)

class supersolids.helper.Box.Box(x0, x1, y0=None, y1=None, z0=None, z1=None)

Specifies the ranges in which the simulation is calculated (1D, 2D or 3D). Needs to be given in pairs (x0, x1), (y0, y1), (z0, z1).

Parameters

• x0 (float) –

• x1 (float) –

• y0 (Optional[float]) –

• y1 (Optional[float]) –

• z0 (Optional[float]) –

• z1 (Optional[float]) –

__str__(self)

Return str(self).

Return type

List[Optional[float]]

lengths(self)

Calculates the box lengths in the directions available in order [x, y, z]

Returns

List of the box length in the directions available in order [x, y, z]

Return type

List[float]

min_length(self)

supersolids.helper.Box.BoxResAssert(Res, Box)