Ctrl+K

class easyreflectometry.sample.elements.materials.material_solvated.MaterialSolvated[source]#

Bases: MaterialMixture

__init__(material=None, solvent=None, solvent_fraction=None, name=None, interface=None)[source]#

Constructor.

Parameters:

  • material (Optional[Material]) – The material being solvated.

  • solvent (Optional[Material]) – The solvent material.

  • solvent_fraction (Union[Parameter, float, None]) – Fraction of solvent in layer. E.g. solvation or surface coverage.

  • name – Name of the material, defaults to None that causes the name to be constructed.

  • interface – Calculator interface, defaults to None.

property material: Material#

Get material.

property solvent: Material#

Get solvent.

property solvent_fraction_parameter: Parameter#

Get the parameter for the fraction of layer described by the solvent.

property solvent_fraction: float#

Get the fraction of layer described by the solvent. This might be fraction of: Solvation where solvent is within the layer Patches of solvent in the layer where no material is present.

user_data: dict#
as_dict(skip=None)[source]#

Produces a cleaned dict using a custom as_dict method to skip necessary things. The resulting dict matches the parameters in __init__

Parameters:

skip (Optional[list]) – List of keys to skip, defaults to None.

Return type:

dict[str, str]

Contents