cluster_helix: cluster_helix

View source: R/clusters.R

cluster_helixR Documentation

cluster_helix

Description

Particles arranged along a helix

Usage

cluster_helix(
  N = 5,
  a = 10,
  b = 10,
  c = 20,
  R0 = 100,
  pitch = 200,
  delta = pi/5,
  delta0 = 0,
  right = TRUE,
  angles = c("helix", "random", "fixed"),
  seed = 123,
  ...
)

Arguments

N

number of particles

a

semi-axis along x

b

semi-axis along y

c

semi-axis along z

R0

radius of helix

pitch

pitch of helix

delta

angle between particles

delta0

initial angle

right

logical, helicity

angles

type of angular orientation

seed

random seed for reproducibility

...

extra arguments (ignored)

Details

Cluster describing a helical assembly of particles

Value

list of class cluster with fields: positions, sizes, angles

Author(s)

baptiste Auguie

See Also

Other user_level cluster: cluster_array(), cluster_ball(), cluster_chain(), cluster_dimer(), cluster_pumpkin(), cluster_shell(), cluster_single()


baptiste/cda documentation built on May 6, 2022, 5:52 a.m.