znvis.particle package

Submodules

znvis.particle.particle module

ZnVis: 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 the particle parent class

class znvis.particle.particle.Particle(name: str, mesh: Optional[znvis.mesh.mesh.Mesh] = None, position: Optional[numpy.ndarray] = None, velocity: Optional[numpy.ndarray] = None, force: Optional[numpy.ndarray] = None, director: Optional[numpy.ndarray] = None, mesh_list: Optional[List[znvis.mesh.mesh.Mesh]] = None, smoothing: bool = False)

Bases: object

Parent class for a ZnVis particle.

Attributes

namestr

Name of the particle

meshMesh

Mesh to use e.g. sphere

positionnp.ndarray

Position tensor of the shape (n_confs, n_particles, n_dims)

velocitynp.ndarray

Velocity tensor of the shape (n_confs, n_particles, n_dims)

forcenp.ndarray

Force tensor of the shape (n_confs, n_particles, n_dims)

director: np.ndarray

Director tensor of the shape (n_confs, n_particles, n_dims)

mesh_listlist

A list of mesh objects, one for each time step.

smoothingbool (default=False)

If true, apply smoothing to each mesh object as it is rendered. This will slow down the initial construction of the mesh objects but not the deployment.

construct_mesh_list()

Constructor the mesh list for the class.

The mesh list is a list of mesh objects for each time step in the parsed trajectory.

Returns

Updates the class attributes mesh_list

director: numpy.ndarray = None

force: numpy.ndarray = None

mesh: znvis.mesh.mesh.Mesh = None

mesh_list: List[znvis.mesh.mesh.Mesh] = None

name: str

position: numpy.ndarray = None

smoothing: bool = False

velocity: numpy.ndarray = None

Module contents

ZnVis: 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 the ZnVis particles