morph_gb: Simulate morphology of guest molecules on a grain boundary

View source: R/rapt_cluster-sim.R

morph_gbR Documentation

Simulate morphology of guest molecules on a grain boundary

Description

Simulate morphology of guest molecules on a grain boundary

Usage

morph_gb(
  lambda,
  frac,
  point.den = 1,
  rcp.rad,
  rcp.path = NULL,
  rcp.number = 1,
  toplot = FALSE,
  win = box3(c(0, 1), c(0, 1), c(0, 1))
)

Arguments

lambda

Intensity for the background Poisson process.

frac

Fraction of points to select as guest points. Between zero and one.

point.den

Point density within the volume of the guest volume.

rcp.rad

Radius to scale the RCP pattern to.

rcp.path

File path to folder containing the 3D RCP patterns which contain both the 'FinalConfigx' and 'systemx' files.

rcp.number

Which RCP file to use.

toplot

TRUE or FALSE; Plot results or not.

win

The simulation window.

Value

A list of: [1] a pp3 object contining the guest points. [2] A pp3 object containing the entire background underlying point pattern.


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