dschick / udkm1DsimML

A MATLAB Simulation Toolkit for 1D Ultrafast Dynamics in Condensed Matter
Other
7 stars 4 forks source link

Python Version Available

Please consider using the newer Python version of the udkm1Dsim toolbox since the MATLAB version is no longer maintained.

Introduction

The udkm1Dsim toolbox is a collection of classes and routines to simulate the structural dynamics and the according X-ray diffraction response in one-dimensional sample structures after ultrafast excitation. The toolbox provides the capabilities to define arbitrary layered structures on the atomic level including a rich database of element-specific physical properties. The excitation of ultrafast dynamics is represented by an N-temperature-model which is commonly applied for ultrafast optical excitations. Structural dynamics due to thermal stresses are calculated by a linear-chain model of masses and springs. The resulting X-ray diffraction response is computed by dynamical X-ray theory. The udkm1Dsim toolbox is highly modular and allows to introduce user-defined results at any step in the simulation procedure.

The udkm1Dsim toolbox was developed in the Ultrafast Dynamics in Condensed Matter group of Prof. Matias Bargheer at the University of Potsdam, Germany. The toolbox is currently maintained by Daniel Schick.

Citation

Please cite the following article if you use the udkm1Dsim toolbox for your own publications:

D. Schick, A. Bojahr, M. Herzog, R. Shayduk, C. von Korff Schmising & M. Bargheer, udkm1Dsim - A Simulation Toolkit for 1D Ultrafast Dynamics in Condensed Matter, Comput. Phys. Commun. 185, 651 (2014) (preprint).

Compatibility

The udkm1Dsim toolbox was tested on MATLAB 2010a (7.10) - 2016a (9.0)

Installation

Add the udkm1Dsim toolbox folder and all of its subfolder to your MATLAB searchpath by excecuting the command:

   addpath(genpath('path2udkm1Dsim'));

In order to use the udkm1Dsim documentation before MATLAB 2013a (8.1)

since MATLAB 2013a (8.1)

Open the MATLAB Product Help and open the udkm1Dsim toolbox documentation from the content listing. Follow the Getting Started to get familar with the simulation workflow.

In order to run the example files change your current MATLAB directory to path2udkm1Dsim/examples/.