meld.system.restraints.CartesianRestraint
- class meld.system.restraints.CartesianRestraint(system, scaler, ramp, atom_index, x, y, z, delta, force_const)[source]
Bases:
NonSelectableRestraint
Cartesian restraint on xyz coordinates
- __init__(system, scaler, ramp, atom_index, x, y, z, delta, force_const)[source]
Initialize a CartesianRestraint
- Parameters
system (
ISystem
) – the system this restraint belongs toscaler (
Optional
[RestraintScaler
]) – scale the force with alpharamp (
Optional
[TimeRamp
]) – scale the force over timeatom_index (
AtomIndex
) – the atom to restrainx (
Quantity
) – equilibrium x-coordinatey (
Quantity
) – equilibrium y-coordinatez (
Quantity
) – equilibrium z-coordinatedelta (
Quantity
) – energy is zero within deltaforce_const (
Quantity
) – force constant
Methods
__init__
(system, scaler, ramp, atom_index, ...)Initialize a CartesianRestraint