read.rcp: Read an RCP Simulation

View source: R/rapt_rcp-sim.R

read.rcpR Documentation

Read an RCP Simulation

Description

Reads in a RCP Generator output file as a pp3 object.

Usage

read.rcp(fpath_config, fpath_sys = NULL, scaleUp = FALSE, newRadius = 0.5)

Arguments

fpath_config

The file path to the RCP FinalConfig file.

fpath_sys

The file path to the associated RCP system file. Must only be specified if scaleUp == TRUE.

newRadius

Numeric. If scaleUP = TRUE, this is the new radius that the RCP particles will be scaled to. Default is 0.5.

scaleUP

Boolean. If TRUE, scales RCP so particles have new radius. If FALSE (the default), RCP stays as generated.

Details

The RCP generation is described in Desmond & Weeks, "Random Close Packing of Disks and Spheres in Confined Geometries", Physical Review E, 80 (5), 051305 (2009): https://doi.org/10.1103/PhysRevE.80.051305; the algorithm can be downloaded at http://www.physics.emory.edu/faculty/weeks/ken/RCPAlgorithm.html.

Value

A pp3 object of the RCP pattern.

References

Desmond & Weeks, "Random Close Packing of Disks and Spheres in Confined Geometries", Physical Review E, 80 (5), 051305 (2009): https://doi.org/10.1103/PhysRevE.80.051305

See Also

RCP Generator Algorithm

Other simulation functions: clustersim(), lattice(), makecluster(), morph_lamellar(), morph_rods(), nmers(), scaleRCP(), stitch.size()


aproudian2/rapt documentation built on Dec. 15, 2022, 4:24 a.m.