Source code for meld.system.state

#
# Copyright 2015 by Justin MacCallum, Alberto Perez, Ken Dill
# All rights reserved
#

"""
A module to define the SystemState
"""

from meld.system import param_sampling
from typing import Optional
from meld import interfaces

import numpy as np  # type: ignore


[docs]class SystemState(interfaces.IState): """ Class to hold the state of a system. """
[docs] def __init__( self, positions: np.ndarray, velocities: np.ndarray, alpha: float, energy: float, group_energies: np.ndarray, box_vector: np.ndarray, parameters: Optional[param_sampling.ParameterState] = None, mappings: Optional[np.ndarray] = None, rdc_alignments: Optional[np.ndarray] = None, ) -> None: """ Initialize a SystemState Params: positions: coordinates of structure, shape(n_atoms, 3) velocities: velocities for structure, shape(n_atoms, 3) alpha: alpha value, within ``[0, 1]`` energy: total potential energy, including restraints, in kJ/mol box_vector: the box vectors, shape(3, 3) in nm parameters: current state of sampled parameters mappings: current state of peak mappings rdc_alignments: current rdc alignments """ self.positions = positions self.velocities = velocities self.box_vector = box_vector self.n_atoms = positions.shape[0] self.alpha = alpha self.energy = energy self.group_energies = group_energies if parameters is None: self.parameters = param_sampling.ParameterState( discrete=np.array([], dtype=np.int32), continuous=np.array([], dtype=np.float64), ) else: self.parameters = parameters if mappings is None: self.mappings = np.array([], dtype=int) else: self.mappings = mappings if rdc_alignments is None: self.rdc_alignments = np.array([], dtype=np.float64) else: self.rdc_alignments = rdc_alignments self._validate()
# # private methods # def _validate(self): # check positions if not len(self.positions.shape) == 2: raise RuntimeError("positions should be a 2D array") if not self.positions.shape[1] == 3: raise RuntimeError("positions should be (n_atoms, 3) array") # check velocities if not self.positions.shape == self.velocities.shape: raise RuntimeError("velocities must have the same shape as positions") # check box vectors if self.box_vector is not None: if not len(self.box_vector) == 3: raise RuntimeError("len(box_vectors) != 3") # check alpha if self.alpha < 0 or self.alpha > 1: raise RuntimeError("alpha must be in [0,1]")