# -*- coding: utf-8 -*-
"""
=================================================================================
Crystal structure generators (:mod:`sknano.generators.xtal_structure_generator`)
=================================================================================
.. currentmodule:: sknano.generators.xtal_structure_generator
.. todo::
Add methods to perform fractional translation and cartesian translation
before structure generation.
.. todo::
Handle different units in output coordinates.
"""
from __future__ import absolute_import, division, print_function, \
unicode_literals
__docformat__ = 'restructuredtext en'
# from sknano.core import pluralize
# from sknano.core.math import Point, Vector
from sknano.core.structures import AlphaQuartz, DiamondStructure, \
Iron, Gold, Copper, BCCStructure, FCCStructure, CaesiumChlorideStructure, \
RocksaltStructure, ZincblendeStructure, MoS2
from .base import CrystalStructureGenerator
__all__ = ['DiamondGenerator', 'DiamondStructureGenerator',
'BCCGenerator', 'BCCStructureGenerator',
'FCCGenerator', 'FCCStructureGenerator',
'CsClGenerator', 'CaesiumChlorideGenerator',
'CaesiumChlorideStructureGenerator', 'NaClGenerator',
'RocksaltGenerator', 'RocksaltStructureGenerator',
'ZincblendeGenerator', 'ZincblendeStructureGenerator',
'AlphaQuartzGenerator', 'IronGenerator',
'GoldGenerator', 'CopperGenerator', 'MoS2Generator']
[docs]class AlphaQuartzGenerator(CrystalStructureGenerator, AlphaQuartz):
""":class:`~sknano.core.structures.AlphaQuartz` generator class.
Parameters
----------
a, c : :class:`~python:float`
scaling_matrix : {None, :class:`~python:float`, :class:`~python:list`}
Examples
--------
>>> from sknano.generators import AlphaQuartzGenerator
>>> alpha_quartz = AlphaQuartzGenerator(scaling_matrix=5)
>>> alpha_quartz.save()
.. image:: /images/alpha_quartz_5x5x5-1.png
"""
pass
[docs]class DiamondGenerator(CrystalStructureGenerator, DiamondStructure):
""":class:`~sknano.core.structures.DiamondStructure` generator class.
Parameters
----------
a : class:`~python:float`
Examples
--------
>>> from sknano.generators import DiamondGenerator
>>> diamond = DiamondGenerator(scaling_matrix=5)
>>> diamond.save()
.. image:: /images/diamond_5x5x5-1.png
"""
pass
DiamondStructureGenerator = DiamondGenerator
[docs]class CaesiumChlorideGenerator(CrystalStructureGenerator,
CaesiumChlorideStructure):
""":class:`~sknano.core.structures.CaesiumChlorideStructure` generator \
class.
Examples
--------
>>> from sknano.generators import CaesiumChlorideGenerator
>>> caesium_chloride = CaesiumChlorideGenerator(scaling_matrix=10)
>>> caesium_chloride.save()
.. image:: /images/caesium_chloride_10x10x10-1.png
"""
pass
CaesiumChlorideStructureGenerator = CsClGenerator = CaesiumChlorideGenerator
[docs]class RocksaltGenerator(CrystalStructureGenerator, RocksaltStructure):
""":class:`~sknano.core.structures.RocksaltStructure` generator class.
Examples
--------
>>> from sknano.generators import RocksaltGenerator
>>> nacl = RocksaltGenerator(scaling_matrix=5)
>>> nacl.save()
.. image:: /images/rock_salt_5x5x5-1.png
"""
pass
RocksaltStructureGenerator = NaClGenerator = RocksaltGenerator
[docs]class ZincblendeGenerator(CrystalStructureGenerator, ZincblendeStructure):
""":class:`~sknano.core.structures.ZincblendeStructure` generator class.
Examples
--------
>>> from sknano.generators import ZincblendeGenerator
>>> zincblende = ZincblendeGenerator(scaling_matrix=5)
>>> zincblende.save()
.. image:: /images/zincblende_5x5x5-1.png
"""
pass
ZincblendeStructureGenerator = ZincblendeGenerator
[docs]class BCCGenerator(CrystalStructureGenerator, BCCStructure):
""":class:`~sknano.core.structures.BCCStructure` generator class.
Examples
--------
>>> from sknano.generators import BCCGenerator
>>> iron = BCCGenerator(basis='Fe', scaling_matrix=5)
>>> iron.save()
.. image:: /images/BCC_Fe_10x10x10-1.png
"""
pass
BCCStructureGenerator = BCCGenerator
[docs]class FCCGenerator(CrystalStructureGenerator, FCCStructure):
""":class:`~sknano.core.structures.FCCStructure` generator class.
Examples
--------
>>> from sknano.generators import FCCGenerator
>>> gold = FCCGenerator(basis='Au', scaling_matrix=10)
>>> gold.save()
.. image:: /images/FCC_Au_5x5x5-1.png
"""
pass
FCCStructureGenerator = FCCGenerator
[docs]class MoS2Generator(CrystalStructureGenerator, MoS2):
""":class:`~sknano.core.structures.MoS2` generator class.
Examples
--------
>>> from sknano.generators import MoS2Generator
>>> mos2 = MoS2Generator(scaling_matrix=5)
>>> mos2.save()
.. image:: /images/MoS2_5x5x5-1.png
"""
pass
[docs]class IronGenerator(CrystalStructureGenerator, Iron):
""":class:`~sknano.core.structures.Iron` generator class."""
pass
[docs]class GoldGenerator(CrystalStructureGenerator, Gold):
""":class:`~sknano.core.structures.Gold` generator class."""
pass
[docs]class CopperGenerator(CrystalStructureGenerator, Copper):
""":class:`~sknano.core.structures.Copper` generator class."""
pass
