__author__ = 'github.com/arm61'
from typing import Optional
from typing import Union
import numpy as np
from easyscience import global_object
from easyscience.Objects.new_variable import Parameter
from easyreflectometry.utils import get_as_parameter
from ...base_core import BaseCore
from ..materials.material import Material
DEFAULTS = {
'thickness': {
'description': 'The thickness of the layer in angstroms',
'url': 'https://github.com/reflectivity/edu_outreach/blob/master/refl_maths/paper.tex',
'value': 10.0,
'unit': 'angstrom',
'min': 0.0,
'max': np.Inf,
'fixed': True,
},
'roughness': {
'description': 'The interfacial roughness, Nevot-Croce, for the layer in angstroms.',
'url': 'https://doi.org/10.1051/rphysap:01980001503076100',
'value': 3.3,
'unit': 'angstrom',
'min': 0.0,
'max': np.Inf,
'fixed': True,
},
}
[docs]
class Layer(BaseCore):
# Added in super().__init__
#: Material that makes up the layer.
material: Material
#: Thickness of the layer in Angstrom.
thickness: Parameter
#: Roughness of the layer in Angstrom.
roughness: Parameter
[docs]
def __init__(
self,
material: Union[Material, None] = None,
thickness: Union[Parameter, float, None] = None,
roughness: Union[Parameter, float, None] = None,
name: str = 'EasyLayer',
unique_name: Optional[str] = None,
interface=None,
):
"""Constructor.
:param material: The material for the layer.
:param thickness: Layer thickness in Angstrom.
:param roughness: Upper roughness on the layer in Angstrom.
:param name: Name of the layer, defaults to 'EasyLayer'
:param interface: Interface object, defaults to `None`
"""
if material is None:
material = Material(interface=interface)
if unique_name is None:
unique_name = global_object.generate_unique_name(self.__class__.__name__)
thickness = get_as_parameter(
name='thickness',
value=thickness,
default_dict=DEFAULTS,
unique_name_prefix=f'{unique_name}_Thickness',
)
roughness = get_as_parameter(
name='roughness',
value=roughness,
default_dict=DEFAULTS,
unique_name_prefix=f'{unique_name}_Roughness',
)
super().__init__(
name=name,
interface=interface,
material=material,
thickness=thickness,
roughness=roughness,
unique_name=unique_name,
)
[docs]
def assign_material(self, material: Material) -> None:
"""Assign a material to the layer interface.
:param material: The material to assign to the layer.
"""
self.material = material
if self.interface is not None:
self.interface().assign_material_to_layer(self.material.unique_name, self.unique_name)
# Representation
@property
def _dict_repr(self) -> dict[str, str]:
"""A simplified dict representation."""
return {
self.name: {
'material': self.material._dict_repr,
'thickness': f'{self.thickness.value:.3f} {self.thickness.unit}',
'roughness': f'{self.roughness.value:.3f} {self.roughness.unit}',
}
}
