mdsuite.calculators.green_kubo_thermal_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 thermal conductivity using the Green-Kubo relation.

class mdsuite.calculators.green_kubo_thermal_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_thermal_conductivity.GreenKuboThermalConductivity(**kwargs)[source]

Bases: TrajectoryCalculator, ABC

Class for the Green-Kubo Thermal 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

Examples

experiment.run_computation.GreenKuboThermalConductivity(data_range=500, plot=True, correlation_time=10)

check_input()[source]

Check the user input to ensure no conflicts are present.

ensemble_operation(ensemble: Tensor)[source]

Calculate and return the msd.

Parameters:

ensemble (tf.Tenor) – Ensemble to analyze.

Return type:

MSD of the tensor_values.

run_calculator()[source]

Run analysis.