pygran_analysis.core

A submodule that provides the fundamental classes used in the analysis module

Created on July 10, 2016

Author: Andrew Abi-Mansour

This is the:

██████╗ ██╗   ██╗ ██████╗ ██████╗  █████╗ ███╗   ██╗
██╔══██╗╚██╗ ██╔╝██╔════╝ ██╔══██╗██╔══██╗████╗  ██║
██████╔╝ ╚████╔╝ ██║  ███╗██████╔╝███████║██╔██╗ ██║
██╔═══╝   ╚██╔╝  ██║   ██║██╔══██╗██╔══██║██║╚██╗██║
██║        ██║   ╚██████╔╝██║  ██║██║  ██║██║ ╚████║
╚═╝        ╚═╝    ╚═════╝ ╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═══╝

DEM simulation and analysis toolkit http://www.pygran.org, support@pygran.org

Core developer and main author: Andrew Abi-Mansour, andrew.abi.mansour@pygran.org

PyGran is open-source, distributed under the terms of the GNU Public License, version 2 or later. It is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. You should have received a copy of the GNU General Public License along with PyGran. If not, see http://www.gnu.org/licenses . See also top-level README and LICENSE files.

Functions

numericalSort(value)

A sorting function by numerical numbers for glob.glob

select(data, *region)

Create a selection of particles based on a region-defined subsystem.

Classes

Factory()

A factory for system class.

Mesh(**args)

The Mesh class stores a list of meshes and their associated attributes / methods.

Particles(**kwargs)

The Particle class stores all particle properties and the methods that operate on these properties.

SubSystem(**kwargs)

The SubSystem is an abstract class the implementation of which stores all DEM object properties and the methods that operate on these properties.

System(**args)

A System contains all the information describing a DEM system.