Order parameters for specific membrane region

class gorder.geometry.Cuboid(xdim=Ellipsis, ydim=Ellipsis, zdim=Ellipsis, reference=Ellipsis)

Calculate order parameters inside a cuboid.

Returns an error if any of the dimensions are invalid.

xdim

Span of the cuboid along the x-axis. Defaults to infinite if not specified.

Type:

Optional[List[float]]

ydim

Span of the cuboid along the y-axis. Defaults to infinite if not specified.

Type:

Optional[List[float]]

zdim

Span of the cuboid along the z-axis. Defaults to infinite if not specified.

Type:

Optional[List[float]]

reference

Reference point relative to which the position of the cuboid is specified. Defaults to the origin of the simulation box ([0.0, 0.0, 0.0]) if not specified.

Type:

Optional[List[float]]

class gorder.geometry.Cylinder(radius, orientation, span=Ellipsis, reference=Ellipsis)

Calculate order parameters inside a cylinder.

Returns an error if the radius is negative or the span is invalid.

radius

Radius of the cylinder.

Type:

float

orientation

Orientation of the main axis of the cylinder.

Type:

str

span

Span of the cylinder along its main axis. Defaults to infinite if not specified.

Type:

Optional[List[float]]

reference

Reference point relative to which the position and size of the cylinder are specified. Defaults to the origin of the simulation box ([0.0, 0.0, 0.0]) if not specified.

Type:

Optional[List[float]]

class gorder.geometry.Sphere(radius, reference=Ellipsis)

Calculate order parameters inside a sphere.

Returns an error if the radius is negative.

radius

Radius of the sphere.

Type:

float

reference

Center of the sphere. Defaults to the origin of the simulation box ([0.0, 0.0, 0.0]) if not specified.

Type:

Optional[List[float]]