mdsuite.calculators.einstein_distinct_diffusion_coefficients module

MDSuite: A Zincwarecode package.

License

This program and the accompanying materials are made available under the terms of the Eclipse Public License v2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-v20.html

SPDX-License-Identifier: EPL-2.0

Copyright Contributors to the Zincwarecode Project.

Contact Information

email: zincwarecode@gmail.com github: https://github.com/zincware web: https://zincwarecode.com/

Citation

If you use this module please cite us with:

Summary

Module for computing distinct diffusion coefficients using the Einstein method.

class mdsuite.calculators.einstein_distinct_diffusion_coefficients.Args(data_range: int, correlation_time: int, atom_selection: <numpy.lib.index_tricks.IndexExpression object at 0x7f811e5ba760>, tau_values: <numpy.lib.index_tricks.IndexExpression object at 0x7f811e5ba760>, molecules: bool, species: list, fit_range: int)[source]

Bases: object

Data class for the saved properties.

atom_selection: <numpy.lib.index_tricks.IndexExpression object at 0x7f811e5ba760>
correlation_time: int
data_range: int
fit_range: int
molecules: bool
species: list
tau_values: <numpy.lib.index_tricks.IndexExpression object at 0x7f811e5ba760>
class mdsuite.calculators.einstein_distinct_diffusion_coefficients.EinsteinDistinctDiffusionCoefficients(**kwargs)[source]

Bases: TrajectoryCalculator

Class for the Green-Kubo diffusion coefficient implementation.

experiment

Experiment class to call from

Type:

object

species

Which species to perform the analysis on

Type:

list

x_label

X label of the tensor_values when plotted

Type:

str

y_label

Y label of the tensor_values when plotted

Type:

str

analysis_name

Name of the analysis

Type:

str

loaded_property

Property loaded from the database_path for the analysis

Type:

str

Examples

experiment.run_computation.EinsteinDistinctDiffusionCoefficients(data_range=500,

plot=True, correlation_time=10)

check_input()[source]

Check the user input to ensure no conflicts are present.

run_calculator()[source]

Perform the distinct coefficient analysis analysis.