pybec.analysis.get_field_along_d

pybec.analysis.get_field_along_d(field_dict, sub_mean_field=False, e_field=0.25, e_field_direction=[0, 0, 1])[source]

Calculate the electric field along a specific direction from the FE results.

Parameters

  • field_dict (dict) – Electric field at atomic locations in a dictionary where the keys are the element symbols and the values are the numpy array of the electric field for all atoms of that element.

  • sub_mean_field (bool, optional) – If set, the external applied field is subtracted from the calculated fields, meaning that only the local field disturbance caused by the inclusion will be plotted. Defaults to False.

  • e_field (float) – The magnitude of the applied electric field in V/m.

  • e_field_direction (list) – The 3D vector direction of the efield. Ex: [0,0,1] is an electric field in the positive z-direction.

Returns

field – Electric field magnitude along the specified direction at atomic locations in a dictionary with same format as field_dict.

Return type

dict