casinotools.file_format.casino2.simulation_options module

Description

class casinotools.file_format.casino2.simulation_options.SimulationOptions[source]

Bases: object

get_beam_angle_deg()[source]
get_bse_coefficient()[source]
get_direction_cosines()[source]
get_energy_loss_type()[source]
get_incident_energy_keV(index=None)[source]
get_ionization_cross_section_type()[source]
get_ionization_potential_type()[source]
get_line_scan_parameters()[source]
get_maximum_depth_nm()[source]
get_maximum_lateral_width()[source]
get_number_electrons()[source]
get_number_x_ray_layers()[source]
get_partial_electron_elastic_cross_section()[source]
get_random_number_generator_type()[source]
get_toa_deg()[source]
get_total_electron_elastic_cross_section()[source]
read(file, version)[source]
set_beam_angle_deg(beam_angle_deg)[source]
set_direction_cosines(direction_cosines_model)[source]
set_elastic_cross_section_type(cross_section_model)[source]
set_energy_loss_type(model_type)[source]
set_incident_energy_keV(energy_keV)[source]
set_ionization_cross_section_type(model_type)[source]
set_ionization_potential_type(model_type)[source]
set_linescan_parameters(start_nm, end_nm, step_nm)[source]

Sets the linescan parameters. If the beam is stationary, use set_position() instead.

Note

The CASINO v2 code is very bad with naming variables. The POS_NStep is actually the step length and the POS_Step is not used. The correct variable are used in the read and write methods.

Parameters:

  • start_nm – start position (in nm)

  • end_nm – end position (in nm)

  • step_nm – step length (in nm)

set_number_electrons(number_electrons)[source]
set_partial_electron_elastic_cross_section(cross_section_model)[source]
set_position(pos_nm)[source]

Sets the position of the beam.

Parameters:

pos_nm – position of the beam (in nm)

set_random_number_generator_type(model_type)[source]
set_toa_deg(toa_deg)[source]
set_total_electron_elastic_cross_section(cross_section_model)[source]
set_total_thickness_nm(total_thickness_nm)[source]
write(file)[source]
casinotools.file_format.casino2.simulation_options.get_direction_cosines_string(model_type)[source]
casinotools.file_format.casino2.simulation_options.get_elastic_cross_section_type_string(model_type)[source]
casinotools.file_format.casino2.simulation_options.get_energy_loss_string(model_type)[source]
casinotools.file_format.casino2.simulation_options.get_ionization_cross_section_type_string(model_type)[source]
casinotools.file_format.casino2.simulation_options.get_ionization_potential_type_string(model_type)[source]
casinotools.file_format.casino2.simulation_options.get_random_number_generator_string(model_type)[source]