calculate_cell_volume.unit_cell: Volume of a unit cell (in angstroms^3)

View source: R/cell_S3.R

calculate_cell_volume.unit_cellR Documentation

Volume of a unit cell (in angstroms^3)

Description

Method of the S3 generic class "calculate_cell_volume", to calculate the volume, in cubic angstroms, of the unit cell corresponding to the input object of class "unit_cell".

Usage

## S3 method for class 'unit_cell'
calculate_cell_volume(x, ...)

Arguments

x

An object of class "unit_cell".

...

Additional arguments passed to the calculate_cell_volume methods

Value

A positive numeric, the volume in cubic angstroms of the unit cell corresponding to the input.

Examples

# Create a monoclinic cell
bt <- bravais("mP")
uc <- create_unit_cell(bt)
print(uc)

# Calculate cell volume
calculate_cell_volume(uc)


cry documentation built on Oct. 10, 2022, 9:06 a.m.