Skip to main content

Script

Struct Script 

Source
pub struct Script {
    pub tolerance: f64,
    pub seed: Option<u64>,
    pub filetype: Option<String>,
    pub output: PathBuf,
    pub nloop: usize,
    pub avoid_overlap: bool,
    pub pbc: Option<PbcSpec>,
    pub structures: Vec<Structure>,
}
Expand description

A fully parsed packing script.

Fields§

§tolerance: f64

Minimum atom-atom distance tolerance (tolerance). Default 2.0 Å.

§seed: Option<u64>

Random seed (seed keyword).

§filetype: Option<String>

Global format hint (filetype keyword). When set, it overrides per-file extension inference; otherwise each input file’s format is inferred from its extension.

§output: PathBuf

Output file path (output keyword). Required.

§nloop: usize

Maximum outer-loop iterations (nloop keyword). When unset, Packmol’s default of 200 * ntype is used (getinp.f90:537-539).

§avoid_overlap: bool

Whether to reject initial random placements that overlap a fixed molecule (avoid_overlap, default on). Wired through Script::build to Molpack::with_avoid_overlap.

§pbc: Option<PbcSpec>

Periodic-boundary box (pbc keyword). When set, it seeds the packer’s cell grid so the initial ±sidemax random placement never drives ncells to anything astronomical.

§structures: Vec<Structure>

Implementations§

Source§

impl Script

Source

pub fn lower(&self, base_dir: &Path) -> Result<ScriptPlan, ScriptError>

Resolve paths and clone restraints into a ScriptPlan without touching the filesystem.

Use this from front-ends that supply their own frame loader. The native counterpart that does read files is [Script::build] (gated behind the io feature).

Trait Implementations§

Source§

impl Clone for Script

Source§

fn clone(&self) -> Script

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Script

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V