mdsuite.calculators.green_kubo_ionic_conductivity 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¶

MDSuite module for the computation of the ionic conductivity of a system using the Green-Kubo relation. Ionic conductivity describes how well a system can conduct an electrical charge due to the mobility of the ions contained within it. This differs from electronic conductivity which is transferred by electrons.

class mdsuite.calculators.green_kubo_ionic_conductivity.Args(data_range: int, correlation_time: int, tau_values: <numpy.lib.index_tricks.IndexExpression object at 0x7f811e5ba760>, atom_selection: <numpy.lib.index_tricks.IndexExpression object at 0x7f811e5ba760>, integration_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¶

integration_range: int¶

tau_values: <numpy.lib.index_tricks.IndexExpression object at 0x7f811e5ba760>¶

class mdsuite.calculators.green_kubo_ionic_conductivity.GreenKuboIonicConductivity(**kwargs)[source]¶

Bases: TrajectoryCalculator, ABC

Class for the Green-Kubo ionic conductivity implementation.

experiment¶

Experiment class to call from

Type:: object

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